Class: SyncteraRubySdk::TemplateFieldsLineOfCredit

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateFieldsLineOfCredit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 111

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

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

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

  if attributes.key?(:'chargeoff_period')
    self.chargeoff_period = attributes[:'chargeoff_period']
  else
    self.chargeoff_period = 90
  end

  if attributes.key?(:'delinquency_period')
    self.delinquency_period = attributes[:'delinquency_period']
  else
    self.delinquency_period = 30
  end

  if attributes.key?(:'grace_period')
    self.grace_period = attributes[:'grace_period']
  else
    self.grace_period = 21
  end

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

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

Instance Attribute Details

#account_type ⇒ Object

Returns the value of attribute account_type.



18
19
20
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 18

def 
  @account_type
end

#bank_country ⇒ Object

Bank country of the account. ISO 3166-1 Alpha-2 or Alpha-3 country code.



21
22
23
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 21

def bank_country
  @bank_country
end

#chargeoff_period ⇒ Object

The number of days an account can stay delinquent before marking an account as charged-off.



27
28
29
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 27

def chargeoff_period
  @chargeoff_period
end

#currency ⇒ Object

Account currency. ISO 4217 alphabetic currency code



24
25
26
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 24

def currency
  @currency
end

#delinquency_period ⇒ Object

The number of days past the due date to wait for a minimum payment before marking an account as delinquent.



30
31
32
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 30

def delinquency_period
  @delinquency_period
end

#grace_period ⇒ Object

The number of days past the billing period to allow for payment before it is considered due. This directly infers the due date for a payment. The default will be set to 21 days.



33
34
35
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 33

def grace_period
  @grace_period
end

#interest_product_id ⇒ Object

An interest account product that the current account associates with. The account product must have its calculation_method set to COMPOUNDED_DAILY.



36
37
38
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 36

def interest_product_id
  @interest_product_id
end

#minimum_payment ⇒ Object

Returns the value of attribute minimum_payment.



38
39
40
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 38

def minimum_payment
  @minimum_payment
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 77

def self.acceptable_attributes
  attribute_map.values
end

.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
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 63

def self.attribute_map
  {
    :'account_type' => :'account_type',
    :'bank_country' => :'bank_country',
    :'currency' => :'currency',
    :'chargeoff_period' => :'chargeoff_period',
    :'delinquency_period' => :'delinquency_period',
    :'grace_period' => :'grace_period',
    :'interest_product_id' => :'interest_product_id',
    :'minimum_payment' => :'minimum_payment'
  }
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



322
323
324
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 322

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



102
103
104
105
106
107
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 102

def self.openapi_all_of
  [
  :'BaseTemplateFields',
  :'TemplateFieldsLineOfCreditAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 82

def self.openapi_types
  {
    :'account_type' => :'AccountType',
    :'bank_country' => :'String',
    :'currency' => :'String',
    :'chargeoff_period' => :'Integer',
    :'delinquency_period' => :'Integer',
    :'grace_period' => :'Integer',
    :'interest_product_id' => :'String',
    :'minimum_payment' => :'MinimumPaymentPartial'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      bank_country == o.bank_country &&
      currency == o.currency &&
      chargeoff_period == o.chargeoff_period &&
      delinquency_period == o.delinquency_period &&
      grace_period == o.grace_period &&
      interest_product_id == o.interest_product_id &&
      minimum_payment == o.minimum_payment
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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 353

def _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 = SyncteraRubySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 424

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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 329

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


309
310
311
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 309

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



315
316
317
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 315

def hash
  [, bank_country, currency, chargeoff_period, delinquency_period, grace_period, interest_product_id, minimum_payment].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



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
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 165

def list_invalid_properties
  invalid_properties = Array.new
  if @account_type.nil?
    invalid_properties.push('invalid value for "account_type", account_type cannot be nil.')
  end

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

  pattern = Regexp.new(/^[A-Z]{2,3}$/)
  if @bank_country !~ pattern
    invalid_properties.push("invalid value for \"bank_country\", must conform to the pattern #{pattern}.")
  end

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

  pattern = Regexp.new(/^[A-Z]{3}$/)
  if @currency !~ pattern
    invalid_properties.push("invalid value for \"currency\", must conform to the pattern #{pattern}.")
  end

  if !@chargeoff_period.nil? && @chargeoff_period < 0
    invalid_properties.push('invalid value for "chargeoff_period", must be greater than or equal to 0.')
  end

  if !@delinquency_period.nil? && @delinquency_period < 0
    invalid_properties.push('invalid value for "delinquency_period", must be greater than or equal to 0.')
  end

  if !@grace_period.nil? && @grace_period > 28
    invalid_properties.push('invalid value for "grace_period", must be smaller than or equal to 28.')
  end

  if !@grace_period.nil? && @grace_period < 21
    invalid_properties.push('invalid value for "grace_period", must be greater than or equal to 21.')
  end

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



400
401
402
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 400

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



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 406

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



394
395
396
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 394

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



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/synctera_ruby_sdk/models/template_fields_line_of_credit.rb', line 214

def valid?
  return false if @account_type.nil?
  return false if @bank_country.nil?
  return false if @bank_country !~ Regexp.new(/^[A-Z]{2,3}$/)
  return false if @currency.nil?
  return false if @currency !~ Regexp.new(/^[A-Z]{3}$/)
  return false if !@chargeoff_period.nil? && @chargeoff_period < 0
  return false if !@delinquency_period.nil? && @delinquency_period < 0
  return false if !@grace_period.nil? && @grace_period > 28
  return false if !@grace_period.nil? && @grace_period < 21
  return false if @minimum_payment.nil?
  true
end