Class: PCPServerSDK::Models::PaymentInformationResponse

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

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



109
110
111
112
113
114
115
116
117
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
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 109

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `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 `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.



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

def card_acceptor_id
  @card_acceptor_id
end

#card_payment_details ⇒ Object

Returns the value of attribute card_payment_details.



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

def card_payment_details
  @card_payment_details
end

#checkout_id ⇒ Object

Unique ID of the Commerce Case.



13
14
15
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 13

def checkout_id
  @checkout_id
end

#commerce_case_id ⇒ Object

Unique ID of the Commerce Case.



10
11
12
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 10

def commerce_case_id
  @commerce_case_id
end

#events ⇒ Object

Returns the value of attribute events.



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

def events
  @events
end

#merchant_customer_id ⇒ Object

Unique identifier of the customer.



16
17
18
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 16

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



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

def merchant_reference
  @merchant_reference
end

#payment_channel ⇒ Object

Returns the value of attribute payment_channel.



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

def payment_channel
  @payment_channel
end

#payment_information_id ⇒ Object

Unique ID of the Payment Information.



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

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.



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

def payment_product_id
  @payment_product_id
end

#terminal_id ⇒ Object

Unique identifier of the POS terminal of the payment transaction.



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

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 226

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::Models.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



80
81
82
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 63

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 202

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



102
103
104
105
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 85

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 171

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 297

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


189
190
191
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 195

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



273
274
275
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 273

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 279

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



267
268
269
 
# File 'lib/PCP-server-Ruby-SDK/models/payment_information_response.rb', line 267

def to_s
  to_hash.to_s
end