Class: CyberSource::Riskv1decisionsRiskInformationMarkingDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb

Overview

Details for marking the transaction as either positive or negative.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1decisionsRiskInformationMarkingDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 52

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'notes')
    self.notes = attributes[:'notes']
  end

  if attributes.has_key?(:'reason')
    self.reason = attributes[:'reason']
  end

  if attributes.has_key?(:'fieldsIncluded')
    self.fields_included = attributes[:'fieldsIncluded']
  end

  if attributes.has_key?(:'reportCode')
    self.report_code = attributes[:'reportCode']
  end
end

Instance Attribute Details

#fields_included ⇒ Object

Adds specified transaction information to the negative list. This field can contain one or more of the following values. When you specify more than one value, separate them with commas (,). - account_key_hash - customer_account_id - customer_email - customer_ipaddress - customer_phone - device_fingerprint - ship_address If no value is specified, account_key_hash, customer_email, and ship_address are used by default. Note account_key_hash adds the field that contains the card number (customer_cc_number).



25
26
27
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 25

def fields_included
  @fields_included
end

#notes ⇒ Object

Notes or details that explain the reasons for adding the transaction to either the positive or negative list.



19
20
21
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 19

def notes
  @notes
end

#reason ⇒ Object

Reason for adding the transaction to the negative list. This field can contain one of the following values: - fraud_chargeback: You have received a fraud-related chargeback for the transaction. - non_fraud_chargeback: You have received a non-fraudulent chargeback for the transaction. - suspected: You believe that you will probably receive a chargeback for the transaction. - creditback: You issued a refund to the customer to avoid a chargeback for the transaction.



22
23
24
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 22

def reason
  @reason
end

#report_code ⇒ Object

Indicates whether to add, clear, or remove order data from the fraud history. This field can contain one of the following values: - ST: Marking reason for suspected fraud transaction; same action as Mark as Suspect link in the Business Center - CB: Marking reason for chargeback; same action as Mark as Suspect link - CM: Clear suspected fraud marking reason; same action as Clear Mark as Suspect link - VT: Remove from history



28
29
30
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 28

def report_code
  @report_code
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



31
32
33
34
35
36
37
38
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 31

def self.attribute_map
  {
    :'notes' => :'notes',
    :'reason' => :'reason',
    :'fields_included' => :'fieldsIncluded',
    :'report_code' => :'reportCode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 41

def self.swagger_types
  {
    :'notes' => :'String',
    :'reason' => :'String',
    :'fields_included' => :'String',
    :'report_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
155
156
157
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      notes == o.notes &&
      reason == o.reason &&
      fields_included == o.fields_included &&
      report_code == o.report_code
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 195

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 261

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 174

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


161
162
163
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 167

def hash
  [notes, reason, fields_included, report_code].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 77

def list_invalid_properties
  invalid_properties = Array.new
  if !@notes.nil? && @notes.to_s.length > 255
    invalid_properties.push('invalid value for "notes", the character length must be smaller than or equal to 255.')
  end

  if !@reason.nil? && @reason.to_s.length > 25
    invalid_properties.push('invalid value for "reason", the character length must be smaller than or equal to 25.')
  end

  if !@fields_included.nil? && @fields_included.to_s.length > 255
    invalid_properties.push('invalid value for "fields_included", the character length must be smaller than or equal to 255.')
  end

  if !@report_code.nil? && @report_code.to_s.length > 2
    invalid_properties.push('invalid value for "report_code", the character length must be smaller than or equal to 2.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 241

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



247
248
249
250
251
252
253
254
255
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 247

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



235
236
237
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 235

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



100
101
102
103
104
105
106
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_risk_information_marking_details.rb', line 100

def valid?
  return false if !@notes.nil? && @notes.to_s.length > 255
  return false if !@reason.nil? && @reason.to_s.length > 25
  return false if !@fields_included.nil? && @fields_included.to_s.length > 255
  return false if !@report_code.nil? && @report_code.to_s.length > 2
  true
end