Class: CyberSource::UnifiedRiskPost201ResponseResultsRISKINSIGHTS

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

Overview

Response from the Visa Protect Risk Insights (VPRI) service, containing the risk score, insight codes, behavioral signals, and supplementary card BIN data for the evaluated transaction.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnifiedRiskPost201ResponseResultsRISKINSIGHTS

Initializes the object



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
122
123
124
125
126
127
128
129
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 88

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#client ⇒ Object

Returns the value of attribute client.



35
36
37
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 35

def client
  @client
end

#error ⇒ Object

Returns the value of attribute error.



39
40
41
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 39

def error
  @error
end

#message ⇒ Object

Human-readable message describing the response outcome. Populated only when status is not COMPLETED. Absent on fully successful responses.



33
34
35
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 33

def message
  @message
end

#packages ⇒ Object

Returns the value of attribute packages.



37
38
39
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 37

def packages
  @packages
end

#processing_time_ms ⇒ Object

Server-side processing time in milliseconds from request receipt to response dispatch. Useful for latency monitoring and SLA tracking. May be null if processing time was not recorded.



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

def processing_time_ms
  @processing_time_ms
end

#reason ⇒ Object

Machine-readable reason code providing context for the response outcome. Populated only when status is not COMPLETED (e.g., INVALID_CLIENT, MISSING_REQUIRED_FIELD, AIP_UNAVAILABLE). Absent on fully successful responses.



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

def reason
  @reason
end

#request_id ⇒ Object

Echoes the unique request identifier submitted in the original VPRI request, enabling clients to correlate responses with their outbound calls.



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

def request_id
  @request_id
end

#response_timestamp ⇒ Object

ISO 8601 timestamp indicating when the VPRI response was generated by the service.



21
22
23
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 21

def response_timestamp
  @response_timestamp
end

#status ⇒ Object

Overall processing status of the VPRI response. Possible values: - COMPLETED - PARTIALLY_COMPLETED - INVALID_REQUEST - SERVER_ERROR



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

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'request_id' => :'requestId',
    :'response_timestamp' => :'responseTimestamp',
    :'processing_time_ms' => :'processingTimeMs',
    :'status' => :'status',
    :'reason' => :'reason',
    :'message' => :'message',
    :'client' => :'client',
    :'packages' => :'packages',
    :'error' => :'error'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'request_id' => :'request_id',
    :'response_timestamp' => :'response_timestamp',
    :'processing_time_ms' => :'processing_time_ms',
    :'status' => :'status',
    :'reason' => :'reason',
    :'message' => :'message',
    :'client' => :'client',
    :'packages' => :'packages',
    :'error' => :'error'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 72

def self.swagger_types
  {
    :'request_id' => :'String',
    :'response_timestamp' => :'DateTime',
    :'processing_time_ms' => :'Integer',
    :'status' => :'String',
    :'reason' => :'String',
    :'message' => :'String',
    :'client' => :'UnifiedRiskPost201ResponseResultsRISKINSIGHTSClient',
    :'packages' => :'UnifiedRiskPost201ResponseResultsRISKINSIGHTSPackages',
    :'error' => :'UnifiedRiskPost201ResponseResultsRISKINSIGHTSError'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 161

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      request_id == o.request_id &&
      response_timestamp == o.response_timestamp &&
      processing_time_ms == o.processing_time_ms &&
      status == o.status &&
      reason == o.reason &&
      message == o.message &&
      client == o.client &&
      packages == o.packages &&
      error == o.error
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 211

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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 277

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 190

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


177
178
179
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



183
184
185
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 183

def hash
  [request_id, response_timestamp, processing_time_ms, status, reason, message, client, packages, error].hash
end

#list_invalid_properties ⇒ Object

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 133

def list_invalid_properties
  invalid_properties = Array.new
  if @request_id.nil?
    invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
  end

  if @response_timestamp.nil?
    invalid_properties.push('invalid value for "response_timestamp", response_timestamp cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



257
258
259
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 257

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



263
264
265
266
267
268
269
270
271
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 263

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



251
252
253
 
# File 'lib/cybersource_rest_client/models/unified_risk_post201_response_results_risk_insights.rb', line 251

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



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

def valid?
  return false if @request_id.nil?
  return false if @response_timestamp.nil?
  return false if @status.nil?
  true
end