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



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
186
187
188
189
190
191
192
193
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 125

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

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

Instance Attribute Details

#additional_response_data ⇒ Object

Returns the value of attribute additional_response_data.



52
53
54
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 52

def additional_response_data
  @additional_response_data
end

#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

Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM).



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.



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

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',
    :'additional_response_data' => :'additionalResponseData'
  }
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



286
287
288
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 286

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



117
118
119
120
121
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 117

def self.openapi_all_of
  [
  :'BasicResponse'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 97

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',
    :'additional_response_data' => :'AdditionalResponseData'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 252

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 &&
      additional_response_data == o.additional_response_data
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



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
346
347
348
349
350
351
352
353
354
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 314

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 388

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 293

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


273
274
275
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



279
280
281
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 279

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, additional_response_data].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



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 197

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



364
365
366
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 364

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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 370

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



358
359
360
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 358

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



212
213
214
215
216
217
218
 
# File 'lib/openapi_client/models/payment_tokenization_response.rb', line 212

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