Class: CyberSource::PtsV2PaymentsPost201ResponseRiskInformation

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

Overview

Contains the result of risk assessment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsPost201ResponseRiskInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 74

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?(:'profile')
    self.profile = attributes[:'profile']
  end

  if attributes.has_key?(:'rules')
    if (value = attributes[:'rules']).is_a?(Array)
      self.rules = value
    end
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#case_priority ⇒ Object

You receive this field only if you subscribe to the Enhanced Case Management service. The priority level ranges from 1 (highest) to 5 (lowest); the default value is 3. If you do not assign a priority to your rules or to your profiles, the default value is given to the order. For all possible values, see the ‘decision_case_priority` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



27
28
29
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 27

def case_priority
  @case_priority
end

#info_codes ⇒ Object

Returns the value of attribute info_codes.



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

def info_codes
  @info_codes
end

#ip_address ⇒ Object

Returns the value of attribute ip_address.



34
35
36
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 34

def ip_address
  @ip_address
end

#local_time ⇒ Object

The customer’s local time (‘hh:mm:ss`), which is calculated from the transaction request time and the customer’s billing address. For details, see the ‘score_time_local` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/)



30
31
32
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 30

def local_time
  @local_time
end

#profile ⇒ Object

Returns the value of attribute profile.



18
19
20
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 18

def profile
  @profile
end

#providers ⇒ Object

Returns the value of attribute providers.



36
37
38
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 36

def providers
  @providers
end

#rules ⇒ Object

Returns the value of attribute rules.



20
21
22
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 20

def rules
  @rules
end

#score ⇒ Object

Returns the value of attribute score.



32
33
34
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 32

def score
  @score
end

#travel ⇒ Object

Returns the value of attribute travel.



38
39
40
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 38

def travel
  @travel
end

#velocity ⇒ Object

Returns the value of attribute velocity.



24
25
26
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 24

def velocity
  @velocity
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 41

def self.attribute_map
  {
    :'profile' => :'profile',
    :'rules' => :'rules',
    :'info_codes' => :'infoCodes',
    :'velocity' => :'velocity',
    :'case_priority' => :'casePriority',
    :'local_time' => :'localTime',
    :'score' => :'score',
    :'ip_address' => :'ipAddress',
    :'providers' => :'providers',
    :'travel' => :'travel'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 57

def self.swagger_types
  {
    :'profile' => :'PtsV2PaymentsPost201ResponseRiskInformationProfile',
    :'rules' => :'Array<PtsV2PaymentsPost201ResponseRiskInformationRules>',
    :'info_codes' => :'PtsV2PaymentsPost201ResponseRiskInformationInfoCodes',
    :'velocity' => :'PtsV2PaymentsPost201ResponseRiskInformationVelocity',
    :'case_priority' => :'Integer',
    :'local_time' => :'String',
    :'score' => :'PtsV2PaymentsPost201ResponseRiskInformationScore',
    :'ip_address' => :'PtsV2PaymentsPost201ResponseRiskInformationIpAddress',
    :'providers' => :'PtsV2PaymentsPost201ResponseRiskInformationProviders',
    :'travel' => :'PtsV2PaymentsPost201ResponseRiskInformationTravel'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      profile == o.profile &&
      rules == o.rules &&
      info_codes == o.info_codes &&
      velocity == o.velocity &&
      case_priority == o.case_priority &&
      local_time == o.local_time &&
      score == o.score &&
      ip_address == o.ip_address &&
      providers == o.providers &&
      travel == o.travel
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/pts_v2_payments_post201_response_risk_information.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/pts_v2_payments_post201_response_risk_information.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/pts_v2_payments_post201_response_risk_information.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/pts_v2_payments_post201_response_risk_information.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/pts_v2_payments_post201_response_risk_information.rb', line 167

def hash
  [profile, rules, info_codes, velocity, case_priority, local_time, score, ip_address, providers, travel].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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/pts_v2_payments_post201_response_risk_information.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/pts_v2_payments_post201_response_risk_information.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/pts_v2_payments_post201_response_risk_information.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



132
133
134
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information.rb', line 132

def valid?
  true
end