Class: SyncteraRubySdk::TemplateFieldsGenericResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateFieldsGenericResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
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
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 169

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

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

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

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

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

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

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

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

  if attributes.key?(:'fee_product_ids')
    if (value = attributes[:'fee_product_ids']).is_a?(Array)
      self.fee_product_ids = value
    end
  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?(:'is_ach_enabled')
    self.is_ach_enabled = attributes[:'is_ach_enabled']
  else
    self.is_ach_enabled = false
  end

  if attributes.key?(:'is_card_enabled')
    self.is_card_enabled = attributes[:'is_card_enabled']
  else
    self.is_card_enabled = false
  end

  if attributes.key?(:'is_external_card_enabled')
    self.is_external_card_enabled = attributes[:'is_external_card_enabled']
  else
    self.is_external_card_enabled = false
  end

  if attributes.key?(:'is_p2p_enabled')
    self.is_p2p_enabled = attributes[:'is_p2p_enabled']
  else
    self.is_p2p_enabled = false
  end

  if attributes.key?(:'is_sar_enabled')
    self.is_sar_enabled = attributes[:'is_sar_enabled']
  else
    self.is_sar_enabled = false
  end

  if attributes.key?(:'is_wire_enabled')
    self.is_wire_enabled = attributes[:'is_wire_enabled']
  else
    self.is_wire_enabled = false
  end

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

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

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

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

Instance Attribute Details

#account_typeObject

Returns the value of attribute account_type.



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

def 
  @account_type
end

#auto_payment_periodObject

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.



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

def auto_payment_period
  @auto_payment_period
end

#balance_ceilingObject

Returns the value of attribute balance_ceiling.



23
24
25
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 23

def balance_ceiling
  @balance_ceiling
end

#balance_floorObject

Returns the value of attribute balance_floor.



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

def balance_floor
  @balance_floor
end

#bank_countryObject

Bank country of the account



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

def bank_country
  @bank_country
end

#billing_periodObject

Returns the value of attribute billing_period.



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

def billing_period
  @billing_period
end

#chargeoff_periodObject

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



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

def chargeoff_period
  @chargeoff_period
end

#currencyObject

Account currency. ISO 4217 alphabetic currency code



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

def currency
  @currency
end

#delinquency_periodObject

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



39
40
41
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 39

def delinquency_period
  @delinquency_period
end

#fee_product_idsObject

A list of fee account products that the current account associates with.



42
43
44
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 42

def fee_product_ids
  @fee_product_ids
end

#grace_periodObject

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.



45
46
47
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 45

def grace_period
  @grace_period
end

#interest_product_idObject

An interest account product that the current account associates with.



48
49
50
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 48

def interest_product_id
  @interest_product_id
end

#is_ach_enabledObject

Enable ACH transaction on ledger.



51
52
53
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 51

def is_ach_enabled
  @is_ach_enabled
end

#is_card_enabledObject

Enable card transaction on ledger.



54
55
56
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 54

def is_card_enabled
  @is_card_enabled
end

#is_external_card_enabledObject

Enable external card transaction on ledger.



57
58
59
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 57

def is_external_card_enabled
  @is_external_card_enabled
end

#is_p2p_enabledObject

Enable P2P transaction on ledger.



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

def is_p2p_enabled
  @is_p2p_enabled
end

#is_sar_enabledObject

Enable SAR report.



63
64
65
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 63

def is_sar_enabled
  @is_sar_enabled
end

#is_wire_enabledObject

Enable wire transaction on ledger.



66
67
68
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 66

def is_wire_enabled
  @is_wire_enabled
end

#minimum_paymentObject

Returns the value of attribute minimum_payment.



68
69
70
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 68

def minimum_payment
  @minimum_payment
end

#overdraft_limitObject

This field is unused and will be removed in a future API version.



71
72
73
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 71

def overdraft_limit
  @overdraft_limit
end

#spend_control_idsObject

List of spend control IDs to control spending for the account



74
75
76
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 74

def spend_control_ids
  @spend_control_ids
end

#spending_limitsObject

Returns the value of attribute spending_limits.



76
77
78
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 76

def spending_limits
  @spending_limits
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



129
130
131
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 129

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'account_type' => :'account_type',
    :'auto_payment_period' => :'auto_payment_period',
    :'balance_ceiling' => :'balance_ceiling',
    :'balance_floor' => :'balance_floor',
    :'bank_country' => :'bank_country',
    :'billing_period' => :'billing_period',
    :'chargeoff_period' => :'chargeoff_period',
    :'currency' => :'currency',
    :'delinquency_period' => :'delinquency_period',
    :'fee_product_ids' => :'fee_product_ids',
    :'grace_period' => :'grace_period',
    :'interest_product_id' => :'interest_product_id',
    :'is_ach_enabled' => :'is_ach_enabled',
    :'is_card_enabled' => :'is_card_enabled',
    :'is_external_card_enabled' => :'is_external_card_enabled',
    :'is_p2p_enabled' => :'is_p2p_enabled',
    :'is_sar_enabled' => :'is_sar_enabled',
    :'is_wire_enabled' => :'is_wire_enabled',
    :'minimum_payment' => :'minimum_payment',
    :'overdraft_limit' => :'overdraft_limit',
    :'spend_control_ids' => :'spend_control_ids',
    :'spending_limits' => :'spending_limits'
  }
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



515
516
517
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 515

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

.openapi_nullableObject

List of attributes with nullable: true



162
163
164
165
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 162

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'account_type' => :'AccountType',
    :'auto_payment_period' => :'Integer',
    :'balance_ceiling' => :'BalanceCeiling',
    :'balance_floor' => :'BalanceFloor',
    :'bank_country' => :'String',
    :'billing_period' => :'BillingPeriod',
    :'chargeoff_period' => :'Integer',
    :'currency' => :'String',
    :'delinquency_period' => :'Integer',
    :'fee_product_ids' => :'Array<String>',
    :'grace_period' => :'Integer',
    :'interest_product_id' => :'String',
    :'is_ach_enabled' => :'Boolean',
    :'is_card_enabled' => :'Boolean',
    :'is_external_card_enabled' => :'Boolean',
    :'is_p2p_enabled' => :'Boolean',
    :'is_sar_enabled' => :'Boolean',
    :'is_wire_enabled' => :'Boolean',
    :'minimum_payment' => :'MinimumPayment',
    :'overdraft_limit' => :'Integer',
    :'spend_control_ids' => :'Array<String>',
    :'spending_limits' => :'SpendingLimits'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 473

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      auto_payment_period == o.auto_payment_period &&
      balance_ceiling == o.balance_ceiling &&
      balance_floor == o.balance_floor &&
      bank_country == o.bank_country &&
      billing_period == o.billing_period &&
      chargeoff_period == o.chargeoff_period &&
      currency == o.currency &&
      delinquency_period == o.delinquency_period &&
      fee_product_ids == o.fee_product_ids &&
      grace_period == o.grace_period &&
      interest_product_id == o.interest_product_id &&
      is_ach_enabled == o.is_ach_enabled &&
      is_card_enabled == o.is_card_enabled &&
      is_external_card_enabled == o.is_external_card_enabled &&
      is_p2p_enabled == o.is_p2p_enabled &&
      is_sar_enabled == o.is_sar_enabled &&
      is_wire_enabled == o.is_wire_enabled &&
      minimum_payment == o.minimum_payment &&
      overdraft_limit == o.overdraft_limit &&
      spend_control_ids == o.spend_control_ids &&
      spending_limits == o.spending_limits
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



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 546

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



617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 617

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



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 522

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


502
503
504
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 502

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



508
509
510
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 508

def hash
  [, auto_payment_period, balance_ceiling, balance_floor, bank_country, billing_period, chargeoff_period, currency, delinquency_period, fee_product_ids, grace_period, interest_product_id, is_ach_enabled, is_card_enabled, is_external_card_enabled, is_p2p_enabled, is_sar_enabled, is_wire_enabled, minimum_payment, overdraft_limit, spend_control_ids, spending_limits].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 295

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

  if !@spend_control_ids.nil? && @spend_control_ids.length > 10
    invalid_properties.push('invalid value for "spend_control_ids", number of items must be less than or equal to 10.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



593
594
595
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 593

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



599
600
601
602
603
604
605
606
607
608
609
610
611
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 599

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



587
588
589
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 587

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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
# File 'lib/synctera_ruby_sdk/models/template_fields_generic_response.rb', line 356

def valid?
  return false if @account_type.nil?
  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 @bank_country.nil?
  return false if @bank_country !~ Regexp.new(/^[A-Z]{2,3}$/)
  return false if !@chargeoff_period.nil? && @chargeoff_period < 0
  return false if @currency.nil?
  return false if @currency !~ Regexp.new(/^[A-Z]{3}$/)
  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 !@overdraft_limit.nil? && @overdraft_limit < 0
  return false if !@spend_control_ids.nil? && @spend_control_ids.length > 10
  true
end