Class: PostfinancecheckoutRubySdk::TransactionPending

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
240
241
242
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 183

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::TransactionPending` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::TransactionPending`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  else
    self.version = nil
  end
end

Instance Attribute Details

#allowed_payment_method_brands ⇒ Object

The payment method brands that can be used to authorize the transaction.



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

def allowed_payment_method_brands
  @allowed_payment_method_brands
end

#allowed_payment_method_configurations ⇒ Object

The payment method configurations that can be used to authorize the transaction.



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

def allowed_payment_method_configurations
  @allowed_payment_method_configurations
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#completion_behavior ⇒ Object

Returns the value of attribute completion_behavior.



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

def completion_behavior
  @completion_behavior
end

#currency ⇒ Object

The three-letter code (ISO 4217 format) of the transaction’s currency.



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

def currency
  @currency
end

#customer_email_address ⇒ Object

The customer’s email address.



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

def customer_email_address
  @customer_email_address
end

#customer_id ⇒ Object

The unique identifier of the customer in the external system.



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

def customer_id
  @customer_id
end

#failed_url ⇒ Object

The URL to redirect the customer back to after they canceled or failed to authenticated their payment.



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

def failed_url
  @failed_url
end

#invoice_merchant_reference ⇒ Object

The merchant’s reference used to identify the invoice.



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

def invoice_merchant_reference
  @invoice_merchant_reference
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#line_items ⇒ Object

The line items purchased by the customer.



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

def line_items
  @line_items
end

#merchant_reference ⇒ Object

The merchant’s reference used to identify the transaction.



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

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.



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

def shipping_address
  @shipping_address
end

#shipping_method ⇒ Object

The name of the shipping method used to ship the products.



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

def shipping_method
  @shipping_method
end

#success_url ⇒ Object

The URL to redirect the customer back to after they successfully authenticated their payment.



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

def success_url
  @success_url
end

#time_zone ⇒ Object

The customer’s time zone, which affects how dates and times are formatted when communicating with the customer.



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

def time_zone
  @time_zone
end

#token ⇒ Object

The payment token that should be used to charge the customer.



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

def token
  @token
end

#tokenization_mode ⇒ Object

Returns the value of attribute tokenization_mode.



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

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.



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

def version
  @version
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



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 538

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 = PostfinancecheckoutRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



133
134
135
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 133

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



138
139
140
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 138

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 107

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



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 514

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



175
176
177
178
179
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 175

def self.openapi_all_of
  [
  :'AbstractTransactionPending'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



169
170
171
172
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 169

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

.openapi_types ⇒ Object

Attribute type mapping.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 143

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 474

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



609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 609

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


501
502
503
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 501

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



507
508
509
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 507

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 290

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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 !@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 !@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

  pattern = Regexp.new(/[	\x20-\x7e]*/)
  if !@invoice_merchant_reference.nil? && @invoice_merchant_reference !~ pattern
    invalid_properties.push("invalid value for \"invoice_merchant_reference\", must conform to the pattern #{pattern}.")
  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 !@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

  pattern = Regexp.new(/[	\x20-\x7e]*/)
  if !@merchant_reference.nil? && @merchant_reference !~ pattern
    invalid_properties.push("invalid value for \"merchant_reference\", must conform to the pattern #{pattern}.")
  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 @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



585
586
587
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 585

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



591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 591

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



579
580
581
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 579

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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/postfinancecheckout-ruby-sdk/models/transaction_pending.rb', line 344

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@customer_email_address.nil? && @customer_email_address.to_s.length > 254
  return false if !@shipping_method.nil? && @shipping_method.to_s.length > 200
  return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
  return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference !~ Regexp.new(/[	\x20-\x7e]*/)
  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 !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
  return false if !@merchant_reference.nil? && @merchant_reference !~ Regexp.new(/[	\x20-\x7e]*/)
  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 @version.nil?
  true
end