Class: WhiteLabelMachineName::PaymentLink

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

Overview

The payment link defines an URL to automatically create transactions.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentLink

Initializes the object

Parameters:

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

    Model attributes in the form of hash



132
133
134
135
136
137
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
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 132

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?(:'allowedPaymentMethodConfigurations')
    if (value = attributes[:'allowedPaymentMethodConfigurations']).is_a?(Array)
      self.allowed_payment_method_configurations = value
    end
  end

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

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

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

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

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

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

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  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?(:'linkedSpaceId')
    self.linked_space_id = attributes[:'linkedSpaceId']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#allowed_payment_method_configurations ⇒ Object

The allowed payment method configurations restrict the payment methods which can be used with this payment link.



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

def allowed_payment_method_configurations
  @allowed_payment_method_configurations
end

#applied_space_view ⇒ Object

The payment link can be conducted in a specific space view. The space view may apply a specific design to the payment page.



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

def applied_space_view
  @applied_space_view
end

#available_from ⇒ Object

The available from date defines the earliest date on which the payment link can be used. When no date is specified there will be no restriction.



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

def available_from
  @available_from
end

#available_until ⇒ Object

The available from date defines the latest date on which the payment link can be used to initialize a transaction. When no date is specified there will be no restriction.



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

def available_until
  @available_until
end

#billing_address_handling_mode ⇒ Object

The billing address handling mode controls if the address is collected or not and how it is collected.



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

def billing_address_handling_mode
  @billing_address_handling_mode
end

#currency ⇒ Object

The currency defines in which currency the payment is executed in. If no currency is defined it has to be specified within the request parameter ‘currency’.



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

def currency
  @currency
end

#external_id ⇒ Object

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.



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

def external_id
  @external_id
end

#id ⇒ Object

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



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

def id
  @id
end

#language ⇒ Object

The language defines the language of the payment page. If no language is provided it can be provided through the request parameter.



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

def language
  @language
end

#line_items ⇒ Object

The line items allows to define the line items for this payment link. When the line items are defined they cannot be overridden through the request parameters.



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

def line_items
  @line_items
end

#linked_space_id ⇒ Object

The linked space id holds the ID of the space to which the entity belongs to.



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

def linked_space_id
  @linked_space_id
end

#maximal_number_of_transactions ⇒ Object

The maximal number of transactions limits the number of transactions which can be created with this payment link.



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

def maximal_number_of_transactions
  @maximal_number_of_transactions
end

#name ⇒ Object

The payment link name is used internally to identify the payment link. For example the name is used within search fields and hence it should be distinct and descriptive.



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

def name
  @name
end

#planned_purge_date ⇒ Object

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.



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

def planned_purge_date
  @planned_purge_date
end

#protection_mode ⇒ Object

The protection mode determines if the payment link is protected against tampering and in what way.



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

def protection_mode
  @protection_mode
end

#shipping_address_handling_mode ⇒ Object

The shipping address handling mode controls if the address is collected or not and how it is collected.



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

def shipping_address_handling_mode
  @shipping_address_handling_mode
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#url ⇒ Object

The URL defines the URL to which the user has to be forwarded to initialize the payment.



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

def url
  @url
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 81

def self.attribute_map
  {
    :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
    :'applied_space_view' => :'appliedSpaceView',
    :'available_from' => :'availableFrom',
    :'available_until' => :'availableUntil',
    :'billing_address_handling_mode' => :'billingAddressHandlingMode',
    :'currency' => :'currency',
    :'external_id' => :'externalId',
    :'id' => :'id',
    :'language' => :'language',
    :'line_items' => :'lineItems',
    :'linked_space_id' => :'linkedSpaceId',
    :'maximal_number_of_transactions' => :'maximalNumberOfTransactions',
    :'name' => :'name',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'protection_mode' => :'protectionMode',
    :'shipping_address_handling_mode' => :'shippingAddressHandlingMode',
    :'state' => :'state',
    :'url' => :'url',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'allowed_payment_method_configurations' => :'Array<PaymentMethodConfiguration>',
    :'applied_space_view' => :'Integer',
    :'available_from' => :'DateTime',
    :'available_until' => :'DateTime',
    :'billing_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
    :'currency' => :'String',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'language' => :'String',
    :'line_items' => :'Array<LineItem>',
    :'linked_space_id' => :'Integer',
    :'maximal_number_of_transactions' => :'Integer',
    :'name' => :'String',
    :'planned_purge_date' => :'DateTime',
    :'protection_mode' => :'PaymentLinkProtectionMode',
    :'shipping_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
    :'state' => :'CreationEntityState',
    :'url' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 249

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



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
345
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 309

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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 375

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 288

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


275
276
277
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 275

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



281
282
283
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 281

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



221
222
223
224
225
226
227
228
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 221

def list_invalid_properties
  invalid_properties = Array.new
  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



355
356
357
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 355

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



361
362
363
364
365
366
367
368
369
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 361

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



349
350
351
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 349

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



232
233
234
235
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/payment_link.rb', line 232

def valid?
  return false if !@name.nil? && @name.to_s.length > 100
  true
end