Class: SyncteraRubySdk::TemplateFieldsChargeSecuredAllOf

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateFieldsChargeSecuredAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 67

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

Instance Attribute Details

#auto_payment_period ⇒ Object

The number of days past the billing period to initiate an auto payment. Only applicable for accounts with type ‘CHARGE_SECURED`, where the account holder has opted in for auto payment functionality. This value must be lower than or equal the `grace_period` setting on the account. If this value is 0, the auto payment will happen on the same day as the statement is generated. Auto payment only occurs if regular payments are not received on time.



19
20
21
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 19

def auto_payment_period
  @auto_payment_period
end

#chargeoff_period ⇒ Object

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



22
23
24
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 22

def chargeoff_period
  @chargeoff_period
end

#delinquency_period ⇒ Object

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



25
26
27
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 25

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.



28
29
30
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 28

def grace_period
  @grace_period
end

#minimum_payment ⇒ Object

Returns the value of attribute minimum_payment.



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

def minimum_payment
  @minimum_payment
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



44
45
46
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 44

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 33

def self.attribute_map
  {
    :'auto_payment_period' => :'auto_payment_period',
    :'chargeoff_period' => :'chargeoff_period',
    :'delinquency_period' => :'delinquency_period',
    :'grace_period' => :'grace_period',
    :'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



230
231
232
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 230

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



60
61
62
63
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 60

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 49

def self.openapi_types
  {
    :'auto_payment_period' => :'Integer',
    :'chargeoff_period' => :'Integer',
    :'delinquency_period' => :'Integer',
    :'grace_period' => :'Integer',
    :'minimum_payment' => :'MinimumPaymentFull'
  }
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
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 205

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



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
296
297
298
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 261

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 332

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 237

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


217
218
219
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 223

def hash
  [auto_payment_period, chargeoff_period, delinquency_period, grace_period, 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



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@auto_payment_period.nil? && @auto_payment_period > 28
    invalid_properties.push('invalid value for "auto_payment_period", must be smaller than or equal to 28.')
  end

  if !@auto_payment_period.nil? && @auto_payment_period < 0
    invalid_properties.push('invalid value for "auto_payment_period", must be greater than or equal to 0.')
  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



308
309
310
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 308

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 314

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



302
303
304
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 302

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



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/synctera_ruby_sdk/models/template_fields_charge_secured_all_of.rb', line 144

def valid?
  return false if !@auto_payment_period.nil? && @auto_payment_period > 28
  return false if !@auto_payment_period.nil? && @auto_payment_period < 0
  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