Class: PostfinancecheckoutRubySdk::PaymentLinkCreate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentLinkCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
240
241
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 158

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::PaymentLinkCreate` 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::PaymentLinkCreate`. 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?(:'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?(:'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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

  if attributes.key?(:'available_from')
    self.available_from = attributes[:'available_from']
  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?(:'protection_mode')
    self.protection_mode = attributes[:'protection_mode']
  else
    self.protection_mode = nil
  end

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  else
    self.external_id = nil
  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.



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

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.



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

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.



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

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.



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

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.



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

def available_until
  @available_until
end

#billing_address_handling_mode ⇒ Object

Returns the value of attribute billing_address_handling_mode.



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

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.



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

def currency
  @currency
end

#external_id ⇒ Object

A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.



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

def external_id
  @external_id
end

#language ⇒ Object

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



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

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.



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

def line_items
  @line_items
end

#maximal_number_of_transactions ⇒ Object

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



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

def maximal_number_of_transactions
  @maximal_number_of_transactions
end

#name ⇒ Object

The name used to identify the payment link.



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

def name
  @name
end

#protection_mode ⇒ Object

Returns the value of attribute protection_mode.



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

def protection_mode
  @protection_mode
end

#shipping_address_handling_mode ⇒ Object

Returns the value of attribute shipping_address_handling_mode.



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

def shipping_address_handling_mode
  @shipping_address_handling_mode
end

#state ⇒ Object

Returns the value of attribute state.



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

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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 397

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



113
114
115
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 113

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



118
119
120
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 118

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'line_items' => :'lineItems',
    :'available_until' => :'availableUntil',
    :'shipping_address_handling_mode' => :'shippingAddressHandlingMode',
    :'allowed_redirection_domains' => :'allowedRedirectionDomains',
    :'name' => :'name',
    :'currency' => :'currency',
    :'language' => :'language',
    :'maximal_number_of_transactions' => :'maximalNumberOfTransactions',
    :'available_from' => :'availableFrom',
    :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
    :'applied_space_view' => :'appliedSpaceView',
    :'billing_address_handling_mode' => :'billingAddressHandlingMode',
    :'protection_mode' => :'protectionMode',
    :'external_id' => :'externalId',
    :'state' => :'state'
  }
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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 373

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)



150
151
152
153
154
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 150

def self.openapi_all_of
  [
  :'AbstractPaymentLinkUpdate'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



144
145
146
147
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 144

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

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 123

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 338

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



468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 468

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


360
361
362
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 360

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



366
367
368
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 366

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 245

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 !@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

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

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



444
445
446
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 444

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



450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 450

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



438
439
440
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 438

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



269
270
271
272
273
274
275
276
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_create.rb', line 269

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