Class: CyberSource::Riskv1decisionsidmarkingRiskInformationMarkingDetails

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

Overview

Details for marking the transaction.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1decisionsidmarkingRiskInformationMarkingDetails

Initializes the object



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 62

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')
    if (value = attributes[:'fieldsIncluded']).is_a?(Array)
      self.fields_included = value
    end
  end

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

Instance Attribute Details

#action ⇒ Object

This field can contain one of the following values: - add: Mark as Suspect. - clear: Clear Mark as Suspect. - hide: Remove from history.



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

def action
  @action
end

#fields_included ⇒ Object

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/riskv1decisionsidmarking_risk_information_marking_details.rb', line 25

def fields_included
  @fields_included
end

#notes ⇒ Object

Notes or details that explain the reasons for marking the transaction as suspect or otherwise.



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

def notes
  @notes
end

#reason ⇒ Object

Reason for marking the transaction as suspect or otherwise. 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/riskv1decisionsidmarking_risk_information_marking_details.rb', line 22

def reason
  @reason
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/riskv1decisionsidmarking_risk_information_marking_details.rb', line 31

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

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'notes' => :'notes',
    :'reason' => :'reason',
    :'fields_included' => :'fields_included',
    :'action' => :'action'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 51

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



114
115
116
117
118
119
120
121
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 114

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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 159

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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 225

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 138

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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

See Also:

  • `==` method


125
126
127
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 125

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



131
132
133
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 131

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

#list_invalid_properties ⇒ Object

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



89
90
91
92
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 89

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



205
206
207
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 205

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 211

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



199
200
201
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 199

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



96
97
98
 
# File 'lib/cybersource_rest_client/models/riskv1decisionsidmarking_risk_information_marking_details.rb', line 96

def valid?
  true
end