Class: Yapstone::InstrumentVerificationResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/yapstone-payments/models/instrument_verification_response.rb

Overview

An instrument is what a customer is paying with. For example a payment instrument can be a credit card. Instrument verification is about determining whether the cardholder (instrument owner) legitimately is the owner of the card (instrument).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstrumentVerificationResponse

Initializes the object



64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 64

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::InstrumentVerificationResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Yapstone::InstrumentVerificationResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'client_correlation_id')
    self.client_correlation_id = attributes[:'client_correlation_id']
  end

  if attributes.key?(:'client_unique_transaction_id')
    self.client_unique_transaction_id = attributes[:'client_unique_transaction_id']
  end

  if attributes.key?(:'verification_id')
    self.verification_id = attributes[:'verification_id']
  end

  if attributes.key?(:'instrument_id')
    self.instrument_id = attributes[:'instrument_id']
  end

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

  if attributes.key?(:'result')
    self.result = attributes[:'result']
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.key?(:'auth_response')
    self.auth_response = attributes[:'auth_response']
  end
end

Instance Attribute Details

#auth_response ⇒ Object

Returns the value of attribute auth_response.



32
33
34
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 32

def auth_response
  @auth_response
end

#client_correlation_id ⇒ Object

Returns the value of attribute client_correlation_id.



18
19
20
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 18

def client_correlation_id
  @client_correlation_id
end

#client_unique_transaction_id ⇒ Object

Returns the value of attribute client_unique_transaction_id.



20
21
22
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 20

def client_unique_transaction_id
  @client_unique_transaction_id
end

#instrument_id ⇒ Object

Returns the value of attribute instrument_id.



24
25
26
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 24

def instrument_id
  @instrument_id
end

#result ⇒ Object

Returns the value of attribute result.



28
29
30
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 28

def result
  @result
end

#status ⇒ Object

Returns the value of attribute status.



26
27
28
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 26

def status
  @status
end

#token ⇒ Object

Returns the value of attribute token.



30
31
32
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 30

def token
  @token
end

#verification_id ⇒ Object

Returns the value of attribute verification_id.



22
23
24
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 22

def verification_id
  @verification_id
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 35

def self.attribute_map
  {
    :'client_correlation_id' => :'clientCorrelationId',
    :'client_unique_transaction_id' => :'clientUniqueTransactionId',
    :'verification_id' => :'verificationId',
    :'instrument_id' => :'instrumentId',
    :'status' => :'status',
    :'result' => :'result',
    :'token' => :'token',
    :'auth_response' => :'authResponse'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



153
154
155
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 153

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 49

def self.openapi_types
  {
    :'client_correlation_id' => :'String',
    :'client_unique_transaction_id' => :'String',
    :'verification_id' => :'String',
    :'instrument_id' => :'String',
    :'status' => :'String',
    :'result' => :'String',
    :'token' => :'Token',
    :'auth_response' => :'CreditCardAuthResponse'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_correlation_id == o.client_correlation_id &&
      client_unique_transaction_id == o.client_unique_transaction_id &&
      verification_id == o.verification_id &&
      instrument_id == o.instrument_id &&
      status == o.status &&
      result == o.result &&
      token == o.token &&
      auth_response == o.auth_response
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 181

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
    Yapstone.const_get(type).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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 246

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 160

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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

See Also:

  • `==` method


140
141
142
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



146
147
148
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 146

def hash
  [client_correlation_id, client_unique_transaction_id, verification_id, instrument_id, status, result, token, auth_response].hash
end

#list_invalid_properties ⇒ Object

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



112
113
114
115
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



226
227
228
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 226

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 232

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



220
221
222
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 220

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



119
120
121
 
# File 'lib/yapstone-payments/models/instrument_verification_response.rb', line 119

def valid?
  true
end