Class: PostFinanceCheckout::TransactionPending

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionPending

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 142

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'allowedPaymentMethodBrands')
    if (value = attributes[:'allowedPaymentMethodBrands']).is_a?(Array)
      self.allowed_payment_method_brands = value
    end
  end

  if attributes.has_key?(:'allowedPaymentMethodConfigurations')
    if (value = attributes[:'allowedPaymentMethodConfigurations']).is_a?(Array)
      self.allowed_payment_method_configurations = value
    end
  end

  if attributes.has_key?(:'billingAddress')
    self.billing_address = attributes[:'billingAddress']
  end

  if attributes.has_key?(:'completionBehavior')
    self.completion_behavior = attributes[:'completionBehavior']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'customerEmailAddress')
    self.customer_email_address = attributes[:'customerEmailAddress']
  end

  if attributes.has_key?(:'customerId')
    self.customer_id = attributes[:'customerId']
  end

  if attributes.has_key?(:'failedUrl')
    self.failed_url = attributes[:'failedUrl']
  end

  if attributes.has_key?(:'invoiceMerchantReference')
    self.invoice_merchant_reference = attributes[:'invoiceMerchantReference']
  end

  if attributes.has_key?(:'language')
    self.language = attributes[:'language']
  end

  if attributes.has_key?(:'lineItems')
    if (value = attributes[:'lineItems']).is_a?(Array)
      self.line_items = value
    end
  end

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

  if attributes.has_key?(:'metaData')
    if (value = attributes[:'metaData']).is_a?(Hash)
      self.meta_data = value
    end
  end

  if attributes.has_key?(:'shippingAddress')
    self.shipping_address = attributes[:'shippingAddress']
  end

  if attributes.has_key?(:'shippingMethod')
    self.shipping_method = attributes[:'shippingMethod']
  end

  if attributes.has_key?(:'successUrl')
    self.success_url = attributes[:'successUrl']
  end

  if attributes.has_key?(:'timeZone')
    self.time_zone = attributes[:'timeZone']
  end

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

  if attributes.has_key?(:'tokenizationMode')
    self.tokenization_mode = attributes[:'tokenizationMode']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end
end

Instance Attribute Details

#allowed_payment_method_brands ⇒ Object

Returns the value of attribute allowed_payment_method_brands.



24
25
26
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 24

def allowed_payment_method_brands
  @allowed_payment_method_brands
end

#allowed_payment_method_configurations ⇒ Object

Returns the value of attribute allowed_payment_method_configurations.



27
28
29
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 27

def allowed_payment_method_configurations
  @allowed_payment_method_configurations
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



30
31
32
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 30

def billing_address
  @billing_address
end

#completion_behavior ⇒ Object

The completion behavior controls when the transaction is completed.



33
34
35
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 33

def completion_behavior
  @completion_behavior
end

#currency ⇒ Object

Returns the value of attribute currency.



36
37
38
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 36

def currency
  @currency
end

#customer_email_address ⇒ Object

The customer email address is the email address of the customer. If no email address is provided on the shipping or billing address this address is used.



39
40
41
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 39

def customer_email_address
  @customer_email_address
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



42
43
44
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 42

def customer_id
  @customer_id
end

#failed_url ⇒ Object

The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.



45
46
47
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 45

def failed_url
  @failed_url
end

#id ⇒ Object

The ID is the primary key of the entity. The ID identifies the entity uniquely.



81
82
83
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 81

def id
  @id
end

#invoice_merchant_reference ⇒ Object

Returns the value of attribute invoice_merchant_reference.



48
49
50
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 48

def invoice_merchant_reference
  @invoice_merchant_reference
end

#language ⇒ Object

The language that is linked to the object.



51
52
53
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 51

def language
  @language
end

#line_items ⇒ Object

Returns the value of attribute line_items.



54
55
56
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 54

def line_items
  @line_items
end

#merchant_reference ⇒ Object

Returns the value of attribute merchant_reference.



57
58
59
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 57

def merchant_reference
  @merchant_reference
end

#meta_data ⇒ Object

Allow to store additional information about the object.



60
61
62
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 60

def meta_data
  @meta_data
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



63
64
65
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 63

def shipping_address
  @shipping_address
end

#shipping_method ⇒ Object

Returns the value of attribute shipping_method.



66
67
68
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 66

def shipping_method
  @shipping_method
end

#success_url ⇒ Object

The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.



69
70
71
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 69

def success_url
  @success_url
end

#time_zone ⇒ Object

The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.



72
73
74
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 72

def time_zone
  @time_zone
end

#token ⇒ Object

Returns the value of attribute token.



75
76
77
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 75

def token
  @token
end

#tokenization_mode ⇒ Object

The tokenization mode controls if and how the tokenization of payment information is applied to the transaction.



78
79
80
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 78

def tokenization_mode
  @tokenization_mode
end

#version ⇒ Object

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.



84
85
86
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 84

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 87

def self.attribute_map
  {
    :'allowed_payment_method_brands' => :'allowedPaymentMethodBrands',
    :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
    :'billing_address' => :'billingAddress',
    :'completion_behavior' => :'completionBehavior',
    :'currency' => :'currency',
    :'customer_email_address' => :'customerEmailAddress',
    :'customer_id' => :'customerId',
    :'failed_url' => :'failedUrl',
    :'invoice_merchant_reference' => :'invoiceMerchantReference',
    :'language' => :'language',
    :'line_items' => :'lineItems',
    :'merchant_reference' => :'merchantReference',
    :'meta_data' => :'metaData',
    :'shipping_address' => :'shippingAddress',
    :'shipping_method' => :'shippingMethod',
    :'success_url' => :'successUrl',
    :'time_zone' => :'timeZone',
    :'token' => :'token',
    :'tokenization_mode' => :'tokenizationMode',
    :'id' => :'id',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 114

def self.swagger_types
  {
    :'allowed_payment_method_brands' => :'Array<Integer>',
    :'allowed_payment_method_configurations' => :'Array<Integer>',
    :'billing_address' => :'AddressCreate',
    :'completion_behavior' => :'TransactionCompletionBehavior',
    :'currency' => :'String',
    :'customer_email_address' => :'String',
    :'customer_id' => :'String',
    :'failed_url' => :'String',
    :'invoice_merchant_reference' => :'String',
    :'language' => :'String',
    :'line_items' => :'Array<LineItemCreate>',
    :'merchant_reference' => :'String',
    :'meta_data' => :'Hash<String, String>',
    :'shipping_address' => :'AddressCreate',
    :'shipping_method' => :'String',
    :'success_url' => :'String',
    :'time_zone' => :'String',
    :'token' => :'Integer',
    :'tokenization_mode' => :'TokenizationMode',
    :'id' => :'Integer',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 374

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allowed_payment_method_brands == o.allowed_payment_method_brands &&
      allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
      billing_address == o.billing_address &&
      completion_behavior == o.completion_behavior &&
      currency == o.currency &&
      customer_email_address == o.customer_email_address &&
      customer_id == o.customer_id &&
      failed_url == o.failed_url &&
      invoice_merchant_reference == o.invoice_merchant_reference &&
      language == o.language &&
      line_items == o.line_items &&
      merchant_reference == o.merchant_reference &&
      meta_data == o.meta_data &&
      shipping_address == o.shipping_address &&
      shipping_method == o.shipping_method &&
      success_url == o.success_url &&
      time_zone == o.time_zone &&
      token == o.token &&
      tokenization_mode == o.tokenization_mode &&
      id == o.id &&
      version == o.version
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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 436

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
    temp_model = PostFinanceCheckout.const_get(type).new
    temp_model.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



502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 502

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 415

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


402
403
404
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 402

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



408
409
410
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 408

def hash
  [allowed_payment_method_brands, allowed_payment_method_configurations, billing_address, completion_behavior, currency, customer_email_address, customer_id, failed_url, invoice_merchant_reference, language, line_items, merchant_reference, meta_data, shipping_address, shipping_method, success_url, time_zone, token, tokenization_mode, id, version].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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 243

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

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

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

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

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

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

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

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

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @version.nil?
    invalid_properties.push('invalid value for "version", version cannot be nil.')
  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



482
483
484
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 482

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



488
489
490
491
492
493
494
495
496
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 488

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

Returns:

  • (String) —

    String presentation of the object



476
477
478
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 476

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 290

def valid?
  return false if !@customer_email_address.nil? && @customer_email_address.to_s.length > 254
  return false if !@failed_url.nil? && @failed_url.to_s.length > 2000
  return false if !@failed_url.nil? && @failed_url.to_s.length < 9
  return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
  return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
  return false if !@shipping_method.nil? && @shipping_method.to_s.length > 200
  return false if !@success_url.nil? && @success_url.to_s.length > 2000
  return false if !@success_url.nil? && @success_url.to_s.length < 9
  return false if @id.nil?
  return false if @version.nil?
  true
end