Class: WalleeRubySdk::PaymentLinkActive

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentLinkActive

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::PaymentLinkActive` 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|
    unless self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `WalleeRubySdk::PaymentLinkActive`. 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?(:'shipping_address_handling_mode')
    self.shipping_address_handling_mode = attributes[:'shipping_address_handling_mode']
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'maximal_number_of_transactions')
    self.maximal_number_of_transactions = attributes[:'maximal_number_of_transactions']
  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?(:'applied_space_view')
    self.applied_space_view = attributes[:'applied_space_view']
  end

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

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

Instance Attribute Details

#allowed_payment_method_configurations ⇒ Object

The payment method configurations that customers can use for making payments.



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

def allowed_payment_method_configurations
  @allowed_payment_method_configurations
end

#allowed_redirection_domains ⇒ Object

The domains to which the user is allowed to be redirected after the payment is completed. The following options can be configured: Exact domain: enter a full domain, e.g. (example.com). Wildcard domain: use to allow subdomains, e.g. (*.example.com). All domains: use (ALL) to allow redirection to any domain (not recommended for security reasons). No domains : use (NONE) to disallow any redirection. Only one option per line is allowed. Invalid entries will be rejected.



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

def allowed_redirection_domains
  @allowed_redirection_domains
end

#applied_space_view ⇒ Object

The payment link can be used within a specific space view, which may apply a customized design to the payment page.



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

def applied_space_view
  @applied_space_view
end

#available_from ⇒ Object

The earliest date the payment link can be used to initiate a transaction. If no date is provided, the link will be available immediately.



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

def available_from
  @available_from
end

#available_until ⇒ Object

The latest date the payment link can be used to initiate a transaction. If no date is provided, the link will remain available indefinitely.



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

def available_until
  @available_until
end

#billing_address_handling_mode ⇒ Object

Returns the value of attribute billing_address_handling_mode.



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

def billing_address_handling_mode
  @billing_address_handling_mode
end

#currency ⇒ Object

The three-letter currency code (ISO 4217). If not specified, it must be provided in the ‘currency’ request parameter.



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

def currency
  @currency
end

#language ⇒ Object

The language for displaying the payment page. If not specified, it can be supplied via the ‘language’ request parameter.



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

def language
  @language
end

#line_items ⇒ Object

The line items representing what is being sold. If not specified, they can be supplied via request parameters.



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

def line_items
  @line_items
end

#maximal_number_of_transactions ⇒ Object

The maximum number of transactions that can be initiated using the payment link.



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

def maximal_number_of_transactions
  @maximal_number_of_transactions
end

#name ⇒ Object

The name used to identify the payment link.



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

def name
  @name
end

#shipping_address_handling_mode ⇒ Object

Returns the value of attribute shipping_address_handling_mode.



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

def shipping_address_handling_mode
  @shipping_address_handling_mode
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#version ⇒ Object

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



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

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



351
352
353
354
355
356
357
358
359
360
361
362
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
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 351

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



108
109
110
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 108

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 88

def self.attribute_map
  {
    :'shipping_address_handling_mode' => :'shippingAddressHandlingMode',
    :'allowed_redirection_domains' => :'allowedRedirectionDomains',
    :'language' => :'language',
    :'version' => :'version',
    :'available_from' => :'availableFrom',
    :'line_items' => :'lineItems',
    :'available_until' => :'availableUntil',
    :'name' => :'name',
    :'currency' => :'currency',
    :'maximal_number_of_transactions' => :'maximalNumberOfTransactions',
    :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
    :'applied_space_view' => :'appliedSpaceView',
    :'billing_address_handling_mode' => :'billingAddressHandlingMode',
    :'state' => :'state'
  }
end

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 327

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)



139
140
141
142
143
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 139

def self.openapi_all_of
  [
  :'PaymentLinkUpdate'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



133
134
135
136
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 133

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

.openapi_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 113

def self.openapi_types
  {
    :'shipping_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
    :'allowed_redirection_domains' => :'Array<String>',
    :'language' => :'String',
    :'version' => :'Integer',
    :'available_from' => :'Time',
    :'line_items' => :'Array<LineItemCreate>',
    :'available_until' => :'Time',
    :'name' => :'String',
    :'currency' => :'String',
    :'maximal_number_of_transactions' => :'Integer',
    :'allowed_payment_method_configurations' => :'Array<PaymentMethodConfiguration>',
    :'applied_space_view' => :'Integer',
    :'billing_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
    :'state' => :'CreationEntityState'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      shipping_address_handling_mode == o.shipping_address_handling_mode &&
      allowed_redirection_domains == o.allowed_redirection_domains &&
      language == o.language &&
      version == o.version &&
      available_from == o.available_from &&
      line_items == o.line_items &&
      available_until == o.available_until &&
      name == o.name &&
      currency == o.currency &&
      maximal_number_of_transactions == o.maximal_number_of_transactions &&
      allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
      applied_space_view == o.applied_space_view &&
      billing_address_handling_mode == o.billing_address_handling_mode &&
      state == o.state
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



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 422

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


316
317
318
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 316

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



322
323
324
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 322

def hash
  [shipping_address_handling_mode, allowed_redirection_domains, language, version, available_from, line_items, available_until, name, currency, maximal_number_of_transactions, allowed_payment_method_configurations, applied_space_view, billing_address_handling_mode, state].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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 227

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@allowed_redirection_domains.nil? && @allowed_redirection_domains.length < 1
    invalid_properties.push('invalid value for "allowed_redirection_domains", number of items must be greater than or equal to 1.')
  end

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

  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  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



398
399
400
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 398

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



404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 404

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



392
393
394
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 392

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



247
248
249
250
251
252
253
 
# File 'lib/wallee-ruby-sdk/models/payment_link_active.rb', line 247

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@allowed_redirection_domains.nil? && @allowed_redirection_domains.length < 1
  return false if @version.nil?
  return false if !@name.nil? && @name.to_s.length > 100
  true
end