Class: PostFinanceCheckout::PaymentLinkUpdate

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/payment_link_update.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 = {}) ⇒ PaymentLinkUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
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
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 102

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

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

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

  if attributes.has_key?(:'shippingAddressHandlingMode')
    self.shipping_address_handling_mode = attributes[:'shippingAddressHandlingMode']
  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.



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

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.



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

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.



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

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.



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

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.



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

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’.



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

def currency
  @currency
end

#id ⇒ Object

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



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

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/postfinancecheckout-ruby-sdk/models/payment_link_update.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. If no amount for the payment link is defined, the additional checkout page to enter the amount is shown to the consumer.



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

def line_items
  @line_items
end

#maximal_number_of_transactions ⇒ Object

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



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

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.



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

def name
  @name
end

#shipping_address_handling_mode ⇒ Object

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



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

def shipping_address_handling_mode
  @shipping_address_handling_mode
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 63

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

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 82

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'allowed_payment_method_configurations' => :'Array<PaymentMethodConfiguration>',
    :'applied_space_view' => :'Integer',
    :'available_from' => :'DateTime',
    :'available_until' => :'DateTime',
    :'billing_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
    :'currency' => :'String',
    :'language' => :'String',
    :'line_items' => :'Array<LineItemCreate>',
    :'maximal_number_of_transactions' => :'Integer',
    :'name' => :'String',
    :'shipping_address_handling_mode' => :'PaymentLinkAddressHandlingMode'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      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 &&
      language == o.language &&
      line_items == o.line_items &&
      maximal_number_of_transactions == o.maximal_number_of_transactions &&
      name == o.name &&
      shipping_address_handling_mode == o.shipping_address_handling_mode
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



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
294
295
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 259

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 325

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 238

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


225
226
227
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 231

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 167

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  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



305
306
307
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 305

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



311
312
313
314
315
316
317
318
319
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 311

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



299
300
301
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 299

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



186
187
188
189
190
191
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_link_update.rb', line 186

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