Class: OpenapiClient::PaymentTokenizationResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/payment_tokenization_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentTokenizationResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
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
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 121

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PaymentTokenizationResponse` 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 `OpenapiClient::PaymentTokenizationResponse`. 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_request_id')
    self.client_request_id = attributes[:'client_request_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_trace_id ⇒ Object

Request identifier in API, can be used to request logs from the support team.



21
22
23
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 21

def api_trace_id
  @api_trace_id
end

#brand ⇒ Object

Card brand.



32
33
34
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 32

def brand
  @brand
end

#client_request_id ⇒ Object

Echoes back the value in the request header for tracking.



18
19
20
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 18

def client_request_id
  @client_request_id
end

#country ⇒ Object

Country of the card issued.



35
36
37
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 35

def country
  @country
end

#ipg_transaction_id ⇒ Object

The response transaction ID.



47
48
49
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 47

def ipg_transaction_id
  @ipg_transaction_id
end

#merchant_transaction_id ⇒ Object

The unique merchant transaction ID from the request header, if supplied.



50
51
52
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 50

def merchant_transaction_id
  @merchant_transaction_id
end

#order_id ⇒ Object

Client order ID if supplied by client, otherwise the order ID.



44
45
46
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 44

def order_id
  @order_id
end

#payment_card ⇒ Object

Returns the value of attribute payment_card.



39
40
41
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 39

def payment_card
  @payment_card
end

#payment_token ⇒ Object

Returns the value of attribute payment_token.



37
38
39
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 37

def payment_token
  @payment_token
end

#processor ⇒ Object

Returns the value of attribute processor.



41
42
43
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 41

def processor
  @processor
end

#request_status ⇒ Object

The status of the request.



26
27
28
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 26

def request_status
  @request_status
end

#request_time ⇒ Object

Time of the request.



29
30
31
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 29

def request_time
  @request_time
end

#response_type ⇒ Object

Returns the value of attribute response_type.



23
24
25
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 23

def response_type
  @response_type
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 75

def self.attribute_map
  {
    :'client_request_id' => :'clientRequestId',
    :'api_trace_id' => :'apiTraceId',
    :'response_type' => :'responseType',
    :'request_status' => :'requestStatus',
    :'request_time' => :'requestTime',
    :'brand' => :'brand',
    :'country' => :'country',
    :'payment_token' => :'paymentToken',
    :'payment_card' => :'paymentCard',
    :'processor' => :'processor',
    :'order_id' => :'orderId',
    :'ipg_transaction_id' => :'ipgTransactionId',
    :'merchant_transaction_id' => :'merchantTransactionId'
  }
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



277
278
279
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 277

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



113
114
115
116
117
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 113

def self.openapi_all_of
  [
  :'BasicResponse'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 94

def self.openapi_types
  {
    :'client_request_id' => :'String',
    :'api_trace_id' => :'String',
    :'response_type' => :'ResponseType',
    :'request_status' => :'String',
    :'request_time' => :'Integer',
    :'brand' => :'String',
    :'country' => :'String',
    :'payment_token' => :'PaymentTokenDetails',
    :'payment_card' => :'PaymentCard',
    :'processor' => :'ProcessorData',
    :'order_id' => :'String',
    :'ipg_transaction_id' => :'String',
    :'merchant_transaction_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_request_id == o.client_request_id &&
      api_trace_id == o.api_trace_id &&
      response_type == o.response_type &&
      request_status == o.request_status &&
      request_time == o.request_time &&
      brand == o.brand &&
      country == o.country &&
      payment_token == o.payment_token &&
      payment_card == o.payment_card &&
      processor == o.processor &&
      order_id == o.order_id &&
      ipg_transaction_id == o.ipg_transaction_id &&
      merchant_transaction_id == o.merchant_transaction_id
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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 305

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 379

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 284

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


264
265
266
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 270

def hash
  [client_request_id, api_trace_id, response_type, request_status, request_time, brand, country, payment_token, payment_card, processor, order_id, ipg_transaction_id, merchant_transaction_id].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



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 189

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

  if !@merchant_transaction_id.nil? && @merchant_transaction_id.to_s.length > 40
    invalid_properties.push('invalid value for "merchant_transaction_id", the character length must be smaller than or equal to 40.')
  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



355
356
357
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 355

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 361

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



349
350
351
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 349

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



204
205
206
207
208
209
210
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 204

def valid?
  request_status_validator = EnumAttributeValidator.new('String', ["DELETED", "FAILED", "SUCCESS", "APPROVED", "WAITING", "VALIDATION_FAILED", "DECLINED"])
  return false unless request_status_validator.valid?(@request_status)
  return false if !@ipg_transaction_id.nil? && @ipg_transaction_id.to_s.length > 14
  return false if !@merchant_transaction_id.nil? && @merchant_transaction_id.to_s.length > 40
  true
end