Class: Wallee::InstallmentPlanConfiguration

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

Overview

The installment plan allows to setup a template for an installment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstallmentPlanConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'paymentMethodConfigurations')
    if (value = attributes[:'paymentMethodConfigurations']).is_a?(Array)
      self.payment_method_configurations = value
    end
  end

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

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

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

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

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

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

  if attributes.has_key?(:'title')
    if (value = attributes[:'title']).is_a?(Hash)
      self.title = value
    end
  end

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

Instance Attribute Details

#base_currency ⇒ Object

The base currency in which the installment fee and minimal amount are defined.



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

def base_currency
  @base_currency
end

#conditions ⇒ Object

If a transaction meets all selected conditions the installment plan will be available to the customer to be selected.



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

def conditions
  @conditions
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#installment_fee ⇒ Object

The installment fee is a fixed amount that is charged additionally when applying this installment plan.



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

def installment_fee
  @installment_fee
end

#interest_rate ⇒ Object

The interest rate is a percentage of the total amount that is charged additionally when applying this installment plan.



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

def interest_rate
  @interest_rate
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#minimal_amount ⇒ Object

The installment plan can only be applied if the orders total is at least the defined minimal amount.



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

def minimal_amount
  @minimal_amount
end

#name ⇒ Object

The installment plan name is used internally to identify the plan in administrative interfaces.For example it is used within search fields and hence it should be distinct and descriptive.



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

def name
  @name
end

#payment_method_configurations ⇒ Object

A installment plan can be enabled only for specific payment method configurations. Other payment methods will not be selectable by the buyer.



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

def payment_method_configurations
  @payment_method_configurations
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



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

def planned_purge_date
  @planned_purge_date
end

#sort_order ⇒ Object

The sort order controls in which order the installation plans are listed. The sort order is used to order the plans in ascending order.



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

def sort_order
  @sort_order
end

#space_reference ⇒ Object

Returns the value of attribute space_reference.



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

def space_reference
  @space_reference
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#tax_class ⇒ Object

The tax class determines the taxes which are applicable on all fees linked to the installment plan.



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

def tax_class
  @tax_class
end

#terms_and_conditions ⇒ Object

The terms and conditions will be displayed to the customer when he or she selects this installment plan.



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

def terms_and_conditions
  @terms_and_conditions
end

#title ⇒ Object

The title of the installment plan is used within the payment process. The title is visible to the buyer.



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

def title
  @title
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 75

def self.attribute_map
  {
    :'base_currency' => :'baseCurrency',
    :'conditions' => :'conditions',
    :'id' => :'id',
    :'installment_fee' => :'installmentFee',
    :'interest_rate' => :'interestRate',
    :'linked_space_id' => :'linkedSpaceId',
    :'minimal_amount' => :'minimalAmount',
    :'name' => :'name',
    :'payment_method_configurations' => :'paymentMethodConfigurations',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'sort_order' => :'sortOrder',
    :'space_reference' => :'spaceReference',
    :'state' => :'state',
    :'tax_class' => :'taxClass',
    :'terms_and_conditions' => :'termsAndConditions',
    :'title' => :'title',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 98

def self.swagger_types
  {
    :'base_currency' => :'String',
    :'conditions' => :'Array<Integer>',
    :'id' => :'Integer',
    :'installment_fee' => :'Float',
    :'interest_rate' => :'Float',
    :'linked_space_id' => :'Integer',
    :'minimal_amount' => :'Float',
    :'name' => :'String',
    :'payment_method_configurations' => :'Array<Integer>',
    :'planned_purge_date' => :'DateTime',
    :'sort_order' => :'Integer',
    :'space_reference' => :'SpaceReference',
    :'state' => :'CreationEntityState',
    :'tax_class' => :'TaxClass',
    :'terms_and_conditions' => :'ResourcePath',
    :'title' => :'Hash<String, String>',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      base_currency == o.base_currency &&
      conditions == o.conditions &&
      id == o.id &&
      installment_fee == o.installment_fee &&
      interest_rate == o.interest_rate &&
      linked_space_id == o.linked_space_id &&
      minimal_amount == o.minimal_amount &&
      name == o.name &&
      payment_method_configurations == o.payment_method_configurations &&
      planned_purge_date == o.planned_purge_date &&
      sort_order == o.sort_order &&
      space_reference == o.space_reference &&
      state == o.state &&
      tax_class == o.tax_class &&
      terms_and_conditions == o.terms_and_conditions &&
      title == o.title &&
      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



291
292
293
294
295
296
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
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 291

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 357

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 270

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


257
258
259
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 263

def hash
  [base_currency, conditions, id, installment_fee, interest_rate, linked_space_id, minimal_amount, name, payment_method_configurations, planned_purge_date, sort_order, space_reference, state, tax_class, terms_and_conditions, title, 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



205
206
207
208
209
210
211
212
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 205

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



337
338
339
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 337

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



343
344
345
346
347
348
349
350
351
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 343

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



331
332
333
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 331

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



216
217
218
219
 
# File 'lib/wallee-ruby-sdk/models/installment_plan_configuration.rb', line 216

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