Class: PCPServerSDK::PaymentInformationResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/payment_information_response.rb

Overview

Object containing the related data of the created Payment Information.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentInformationResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



118
119
120
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
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#card_acceptor_id ⇒ Object

Unique ID that identifies a store location or transaction point and which refers to the contract number of the merchant accepting the card.



40
41
42
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 40

def card_acceptor_id
  @card_acceptor_id
end

#card_payment_details ⇒ Object

Returns the value of attribute card_payment_details.



45
46
47
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 45

def card_payment_details
  @card_payment_details
end

#checkout_id ⇒ Object

Unique ID of the Commerce Case.



23
24
25
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 23

def checkout_id
  @checkout_id
end

#commerce_case_id ⇒ Object

Unique ID of the Commerce Case.



20
21
22
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 20

def commerce_case_id
  @commerce_case_id
end

#events ⇒ Object

Returns the value of attribute events.



47
48
49
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 47

def events
  @events
end

#merchant_customer_id ⇒ Object

Unique identifier of the customer.



26
27
28
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 26

def merchant_customer_id
  @merchant_customer_id
end

#merchant_reference ⇒ Object

Unique reference of the PaymentInformation. In case of card present transactions, the reference from the ECR or terminal will be used. It is always the reference for external transactions. (e.g. card present payments, cash payments or payments processed by other payment providers).



43
44
45
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 43

def merchant_reference
  @merchant_reference
end

#payment_channel ⇒ Object

Returns the value of attribute payment_channel.



31
32
33
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 31

def payment_channel
  @payment_channel
end

#payment_information_id ⇒ Object

Unique ID of the Payment Information.



29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 29

def payment_information_id
  @payment_information_id
end

#payment_product_id ⇒ Object

Payment product identifier - please check see product documentation for a full overview of possible values.



34
35
36
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 34

def payment_product_id
  @payment_product_id
end

#terminal_id ⇒ Object

Unique identifier of the POS terminal of the payment transaction.



37
38
39
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 37

def terminal_id
  @terminal_id
end

Class Method Details

._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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 363

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = PCPServerSDK.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 72

def self.attribute_map
  {
    :'commerce_case_id' => :'commerceCaseId',
    :'checkout_id' => :'checkoutId',
    :'merchant_customer_id' => :'merchantCustomerId',
    :'payment_information_id' => :'paymentInformationId',
    :'payment_channel' => :'paymentChannel',
    :'payment_product_id' => :'paymentProductId',
    :'terminal_id' => :'terminalId',
    :'card_acceptor_id' => :'cardAcceptorId',
    :'merchant_reference' => :'merchantReference',
    :'card_payment_details' => :'cardPaymentDetails',
    :'events' => :'events'
  }
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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 339

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 111

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 94

def self.openapi_types
  {
    :'commerce_case_id' => :'String',
    :'checkout_id' => :'String',
    :'merchant_customer_id' => :'String',
    :'payment_information_id' => :'String',
    :'payment_channel' => :'PaymentChannel',
    :'payment_product_id' => :'Integer',
    :'terminal_id' => :'String',
    :'card_acceptor_id' => :'String',
    :'merchant_reference' => :'String',
    :'card_payment_details' => :'CardPaymentDetails',
    :'events' => :'Array<PaymentEvent>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 308

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commerce_case_id == o.commerce_case_id &&
      checkout_id == o.checkout_id &&
      merchant_customer_id == o.merchant_customer_id &&
      payment_information_id == o.payment_information_id &&
      payment_channel == o.payment_channel &&
      payment_product_id == o.payment_product_id &&
      terminal_id == o.terminal_id &&
      card_acceptor_id == o.card_acceptor_id &&
      merchant_reference == o.merchant_reference &&
      card_payment_details == o.card_payment_details &&
      events == o.events
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



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 434

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


326
327
328
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 326

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



332
333
334
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 332

def hash
  [commerce_case_id, checkout_id, merchant_customer_id, payment_information_id, payment_channel, payment_product_id, terminal_id, card_acceptor_id, merchant_reference, card_payment_details, events].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



180
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
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 180

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@merchant_customer_id.nil? && @merchant_customer_id.to_s.length > 20
    invalid_properties.push('invalid value for "merchant_customer_id", the character length must be smaller than or equal to 20.')
  end

  if !@payment_product_id.nil? && @payment_product_id > 99999
    invalid_properties.push('invalid value for "payment_product_id", must be smaller than or equal to 99999.')
  end

  if !@payment_product_id.nil? && @payment_product_id < 0
    invalid_properties.push('invalid value for "payment_product_id", must be greater than or equal to 0.')
  end

  if !@terminal_id.nil? && @terminal_id.to_s.length > 8
    invalid_properties.push('invalid value for "terminal_id", the character length must be smaller than or equal to 8.')
  end

  if !@terminal_id.nil? && @terminal_id.to_s.length < 8
    invalid_properties.push('invalid value for "terminal_id", the character length must be great than or equal to 8.')
  end

  if !@card_acceptor_id.nil? && @card_acceptor_id.to_s.length > 15
    invalid_properties.push('invalid value for "card_acceptor_id", the character length must be smaller than or equal to 15.')
  end

  if !@merchant_reference.nil? && @merchant_reference.to_s.length > 40
    invalid_properties.push('invalid value for "merchant_reference", 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



410
411
412
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 410

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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 416

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.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



404
405
406
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 404

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



216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 216

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@merchant_customer_id.nil? && @merchant_customer_id.to_s.length > 20
  return false if !@payment_product_id.nil? && @payment_product_id > 99999
  return false if !@payment_product_id.nil? && @payment_product_id < 0
  return false if !@terminal_id.nil? && @terminal_id.to_s.length > 8
  return false if !@terminal_id.nil? && @terminal_id.to_s.length < 8
  return false if !@card_acceptor_id.nil? && @card_acceptor_id.to_s.length > 15
  return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 40
  true
end