Class: Wallee::TransactionCreate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
287
288
289
290
291
292
293
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 172

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. = 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?(:'autoConfirmationEnabled')
    self.auto_confirmation_enabled = attributes[:'autoConfirmationEnabled']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#allowed_payment_method_brandsObject

Returns the value of attribute allowed_payment_method_brands.



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

def allowed_payment_method_brands
  @allowed_payment_method_brands
end

#allowed_payment_method_configurationsObject

Returns the value of attribute allowed_payment_method_configurations.



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

def allowed_payment_method_configurations
  @allowed_payment_method_configurations
end

#auto_confirmation_enabledObject

When auto confirmation is enabled the transaction can be confirmed by the user and does not require an explicit confirmation through the web service API.



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

def auto_confirmation_enabled
  @auto_confirmation_enabled
end

#billing_addressObject

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#charge_retry_enabledObject

When the charging of the customer fails we can retry the charging. This implies that we redirect the user back to the payment page which allows the customer to retry. By default we will retry.



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

def charge_retry_enabled
  @charge_retry_enabled
end

#completion_behaviorObject

The completion behavior controls when the transaction is completed.



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

def completion_behavior
  @completion_behavior
end

#currencyObject

Returns the value of attribute currency.



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

def currency
  @currency
end

#customer_email_addressObject

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/wallee-ruby-sdk/models/transaction_create.rb', line 39

def customer_email_address
  @customer_email_address
end

#customer_idObject

Returns the value of attribute customer_id.



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

def customer_id
  @customer_id
end

#customers_presenceObject

The customer’s presence indicates what kind of authentication methods can be used during the authorization of the transaction. If no value is provided, ‘Virtually Present’ is used by default.



87
88
89
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 87

def customers_presence
  @customers_presence
end

#device_session_identifierObject

The device session identifier links the transaction with the session identifier provided in the URL of the device data JavaScript. This allows to link the transaction with the collected device data of the buyer.



90
91
92
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 90

def device_session_identifier
  @device_session_identifier
end

#emails_disabledObject

Flag indicating whether email sending is disabled for this particular transaction. Defaults to false.



93
94
95
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 93

def emails_disabled
  @emails_disabled
end

#environmentObject

Returns the value of attribute environment.



96
97
98
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 96

def environment
  @environment
end

#environment_selection_strategyObject

The environment selection strategy determines how the environment (test or production) for processing the transaction is selected.



99
100
101
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 99

def environment_selection_strategy
  @environment_selection_strategy
end

#failed_urlObject

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/wallee-ruby-sdk/models/transaction_create.rb', line 45

def failed_url
  @failed_url
end

#invoice_merchant_referenceObject

Returns the value of attribute invoice_merchant_reference.



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

def invoice_merchant_reference
  @invoice_merchant_reference
end

#languageObject

Returns the value of attribute language.



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

def language
  @language
end

#line_itemsObject

Returns the value of attribute line_items.



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

def line_items
  @line_items
end

#merchant_referenceObject

Returns the value of attribute merchant_reference.



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

def merchant_reference
  @merchant_reference
end

#meta_dataObject

Meta data allow to store additional data along the object.



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

def 
  @meta_data
end

#shipping_addressObject

Returns the value of attribute shipping_address.



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

def shipping_address
  @shipping_address
end

#shipping_methodObject

Returns the value of attribute shipping_method.



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

def shipping_method
  @shipping_method
end

#space_view_idObject

Returns the value of attribute space_view_id.



102
103
104
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 102

def space_view_id
  @space_view_id
end

#success_urlObject

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/wallee-ruby-sdk/models/transaction_create.rb', line 69

def success_url
  @success_url
end

#time_zoneObject

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/wallee-ruby-sdk/models/transaction_create.rb', line 72

def time_zone
  @time_zone
end

#tokenObject

Returns the value of attribute token.



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

def token
  @token
end

#tokenization_modeObject

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



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

def tokenization_mode
  @tokenization_mode
end

Class Method Details

.attribute_mapObject

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



105
106
107
108
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
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 105

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',
    :'auto_confirmation_enabled' => :'autoConfirmationEnabled',
    :'charge_retry_enabled' => :'chargeRetryEnabled',
    :'customers_presence' => :'customersPresence',
    :'device_session_identifier' => :'deviceSessionIdentifier',
    :'emails_disabled' => :'emailsDisabled',
    :'environment' => :'environment',
    :'environment_selection_strategy' => :'environmentSelectionStrategy',
    :'space_view_id' => :'spaceViewId'
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 138

def self.swagger_types
  {
    :'allowed_payment_method_brands' => :'Array<PaymentMethodBrand>',
    :'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',
    :'auto_confirmation_enabled' => :'BOOLEAN',
    :'charge_retry_enabled' => :'BOOLEAN',
    :'customers_presence' => :'CustomersPresence',
    :'device_session_identifier' => :'String',
    :'emails_disabled' => :'BOOLEAN',
    :'environment' => :'Environment',
    :'environment_selection_strategy' => :'TransactionEnvironmentSelectionStrategy',
    :'space_view_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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
473
474
475
476
477
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 447

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 &&
       == o. &&
      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 &&
      auto_confirmation_enabled == o.auto_confirmation_enabled &&
      charge_retry_enabled == o.charge_retry_enabled &&
      customers_presence == o.customers_presence &&
      device_session_identifier == o.device_session_identifier &&
      emails_disabled == o.emails_disabled &&
      environment == o.environment &&
      environment_selection_strategy == o.environment_selection_strategy &&
      space_view_id == o.space_view_id
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



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 515

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 = Wallee.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



581
582
583
584
585
586
587
588
589
590
591
592
593
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 581

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



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 494

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


481
482
483
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 481

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



487
488
489
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 487

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, , shipping_address, shipping_method, success_url, time_zone, token, tokenization_mode, auto_confirmation_enabled, charge_retry_enabled, customers_presence, device_session_identifier, emails_disabled, environment, environment_selection_strategy, space_view_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
341
342
343
344
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 297

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 > 1000
    invalid_properties.push('invalid value for "failed_url", the character length must be smaller than or equal to 1000.')
  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 @line_items.nil?
    invalid_properties.push('invalid value for "line_items", line_items cannot be nil.')
  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 > 1000
    invalid_properties.push('invalid value for "success_url", the character length must be smaller than or equal to 1000.')
  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 !@device_session_identifier.nil? && @device_session_identifier.to_s.length > 40
    invalid_properties.push('invalid value for "device_session_identifier", the character length must be smaller than or equal to 40.')
  end

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



561
562
563
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 561

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



567
568
569
570
571
572
573
574
575
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 567

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



555
556
557
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 555

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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
# File 'lib/wallee-ruby-sdk/models/transaction_create.rb', line 348

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 > 1000
  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 @line_items.nil?
  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 > 1000
  return false if !@success_url.nil? && @success_url.to_s.length < 9
  return false if !@device_session_identifier.nil? && @device_session_identifier.to_s.length > 40
  return false if !@device_session_identifier.nil? && @device_session_identifier.to_s.length < 10
  true
end