Class: PCPServerSDK::InstallmentOption

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/installment_option.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstallmentOption

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
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
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 88

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#credit_information ⇒ Object

Link with credit information.



43
44
45
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 43

def credit_information
  @credit_information
end

#effective_interest_rate ⇒ Object

Effective interest amount in percent with two decimals.



31
32
33
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 31

def effective_interest_rate
  @effective_interest_rate
end

#first_rate_date ⇒ Object

Due date of first rate. Format: YYYYMMDD



40
41
42
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 40

def first_rate_date
  @first_rate_date
end

#installment_option_id ⇒ Object

Installment option Identifier. Use this in the Complete Payment for the selected installment option.



19
20
21
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 19

def installment_option_id
  @installment_option_id
end

#last_rate_amount ⇒ Object

Last rate amount.



28
29
30
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 28

def last_rate_amount
  @last_rate_amount
end

#monthly_amount ⇒ Object

Monthly rate amount.



25
26
27
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 25

def monthly_amount
  @monthly_amount
end

#nominal_interest_rate ⇒ Object

Nominal interest amount in percent with two decimals.



34
35
36
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 34

def nominal_interest_rate
  @nominal_interest_rate
end

#number_of_payments ⇒ Object

The number of monthly payments for this installment.



22
23
24
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 22

def number_of_payments
  @number_of_payments
end

#total_amount ⇒ Object

Total rate amount.



37
38
39
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 37

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



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
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 301

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



61
62
63
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 46

def self.attribute_map
  {
    :'installment_option_id' => :'installmentOptionId',
    :'number_of_payments' => :'numberOfPayments',
    :'monthly_amount' => :'monthlyAmount',
    :'last_rate_amount' => :'lastRateAmount',
    :'effective_interest_rate' => :'effectiveInterestRate',
    :'nominal_interest_rate' => :'nominalInterestRate',
    :'total_amount' => :'totalAmount',
    :'first_rate_date' => :'firstRateDate',
    :'credit_information' => :'creditInformation'
  }
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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 277

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_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 66

def self.openapi_types
  {
    :'installment_option_id' => :'String',
    :'number_of_payments' => :'Integer',
    :'monthly_amount' => :'AmountOfMoney',
    :'last_rate_amount' => :'AmountOfMoney',
    :'effective_interest_rate' => :'Integer',
    :'nominal_interest_rate' => :'Integer',
    :'total_amount' => :'AmountOfMoney',
    :'first_rate_date' => :'String',
    :'credit_information' => :'LinkInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      installment_option_id == o.installment_option_id &&
      number_of_payments == o.number_of_payments &&
      monthly_amount == o.monthly_amount &&
      last_rate_amount == o.last_rate_amount &&
      effective_interest_rate == o.effective_interest_rate &&
      nominal_interest_rate == o.nominal_interest_rate &&
      total_amount == o.total_amount &&
      first_rate_date == o.first_rate_date &&
      credit_information == o.credit_information
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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 372

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


264
265
266
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 270

def hash
  [installment_option_id, number_of_payments, monthly_amount, last_rate_amount, effective_interest_rate, nominal_interest_rate, total_amount, first_rate_date, credit_information].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



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
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 158

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @installment_option_id.nil?
    invalid_properties.push('invalid value for "installment_option_id", installment_option_id cannot be nil.')
  end

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

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

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

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

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

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

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

  if @first_rate_date.to_s.length > 8
    invalid_properties.push('invalid value for "first_rate_date", the character length must be smaller than or equal to 8.')
  end

  pattern = Regexp.new(/^((19|20|21)\d{6})?$/)
  if @first_rate_date !~ pattern
    invalid_properties.push("invalid value for \"first_rate_date\", must conform to the pattern #{pattern}.")
  end

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



348
349
350
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 348

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 354

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



342
343
344
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 342

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/PCP-server-Ruby-SDK/models/installment_option.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @installment_option_id.nil?
  return false if @number_of_payments.nil?
  return false if @monthly_amount.nil?
  return false if @last_rate_amount.nil?
  return false if @effective_interest_rate.nil?
  return false if @nominal_interest_rate.nil?
  return false if @total_amount.nil?
  return false if @first_rate_date.nil?
  return false if @first_rate_date.to_s.length > 8
  return false if @first_rate_date !~ Regexp.new(/^((19|20|21)\d{6})?$/)
  return false if @credit_information.nil?
  true
end