Class: SyncteraRubySdk::AccountChargeSecured

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

Overview

(alpha) Account representing a secured charge account, e.g. for use in a Smart Charge Card offering.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountChargeSecured

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 194

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_status ⇒ Object

Returns the value of attribute access_status.



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

def access_status
  @access_status
end

#account_number ⇒ Object

Account number



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

def 
  @account_number
end

#account_number_masked ⇒ Object

The response will contain the bank fintech ID (3 or 6 digits) plus the last 4 digits, with the digits in between replaced with * characters. Shadow mode account numbers will not be masked.



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

def 
  @account_number_masked
end

#account_purpose ⇒ Object

Purpose of the account



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

def 
  @account_purpose
end

#account_type ⇒ Object

Returns the value of attribute account_type.



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

def 
  @account_type
end

#application_id ⇒ Object

The application ID for this account.



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

def application_id
  @application_id
end

#balances ⇒ Object

A list of balances for account based on different type



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

def balances
  @balances
end

#bank_routing ⇒ Object

Bank routing number



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

def bank_routing
  @bank_routing
end

#creation_time ⇒ Object

Account creation timestamp in RFC3339 format



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

def creation_time
  @creation_time
end

#currency ⇒ Object

Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD



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

def currency
  @currency
end

#customer_ids ⇒ Object

A list of the customer IDs of the account holders.



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

def customer_ids
  @customer_ids
end

#customer_type ⇒ Object

Returns the value of attribute customer_type.



50
51
52
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 50

def customer_type
  @customer_type
end

#exchange_rate_type ⇒ Object

Exchange rate type



53
54
55
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 53

def exchange_rate_type
  @exchange_rate_type
end

#iban ⇒ Object

International bank account number



56
57
58
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 56

def iban
  @iban
end

#id ⇒ Object

Account ID



59
60
61
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 59

def id
  @id
end

#is_account_pool ⇒ Object

Account is investment (variable balance) account or a multi-balance account pool. Default false



62
63
64
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 62

def 
  @is_account_pool
end

#is_sar_enabled ⇒ Object

A flag to indicate whether SAR generation is enabled.



65
66
67
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 65

def is_sar_enabled
  @is_sar_enabled
end

#last_updated_time ⇒ Object

Timestamp of the last account modification in RFC3339 format



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

def last_updated_time
  @last_updated_time
end

#metadata ⇒ Object

User provided account metadata



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

def metadata
  @metadata
end

#nickname ⇒ Object

User provided account nickname



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

def nickname
  @nickname
end

#note ⇒ Object

Add an optional note when creating or updating a charged secured account. A note is required when updating the status to or from SUSPENDED



85
86
87
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 85

def note
  @note
end

#security ⇒ Object

Returns the value of attribute security.



87
88
89
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 87

def security
  @security
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#swift_code ⇒ Object

SWIFT code



79
80
81
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 79

def swift_code
  @swift_code
end

#tenant ⇒ Object

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.



82
83
84
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 82

def tenant
  @tenant
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



143
144
145
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 143

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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/account_charge_secured.rb', line 112

def self.attribute_map
  {
    :'access_status' => :'access_status',
    :'account_number' => :'account_number',
    :'account_number_masked' => :'account_number_masked',
    :'account_purpose' => :'account_purpose',
    :'account_type' => :'account_type',
    :'application_id' => :'application_id',
    :'balances' => :'balances',
    :'bank_routing' => :'bank_routing',
    :'creation_time' => :'creation_time',
    :'currency' => :'currency',
    :'customer_ids' => :'customer_ids',
    :'customer_type' => :'customer_type',
    :'exchange_rate_type' => :'exchange_rate_type',
    :'iban' => :'iban',
    :'id' => :'id',
    :'is_account_pool' => :'is_account_pool',
    :'is_sar_enabled' => :'is_sar_enabled',
    :'last_updated_time' => :'last_updated_time',
    :'metadata' => :'metadata',
    :'nickname' => :'nickname',
    :'status' => :'status',
    :'swift_code' => :'swift_code',
    :'tenant' => :'tenant',
    :'note' => :'note',
    :'security' => :'security'
  }
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



488
489
490
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 488

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



185
186
187
188
189
190
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 185

def self.openapi_all_of
  [
  :'AccountBase',
  :'AccountChargeSecuredAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



179
180
181
182
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 179

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'access_status' => :'AccountAccessStatus',
    :'account_number' => :'String',
    :'account_number_masked' => :'String',
    :'account_purpose' => :'String',
    :'account_type' => :'AccountType',
    :'application_id' => :'String',
    :'balances' => :'Array<Balance>',
    :'bank_routing' => :'String',
    :'creation_time' => :'Time',
    :'currency' => :'String',
    :'customer_ids' => :'Array<String>',
    :'customer_type' => :'CustomerType',
    :'exchange_rate_type' => :'String',
    :'iban' => :'String',
    :'id' => :'String',
    :'is_account_pool' => :'Boolean',
    :'is_sar_enabled' => :'Boolean',
    :'last_updated_time' => :'Time',
    :'metadata' => :'Object',
    :'nickname' => :'String',
    :'status' => :'Status',
    :'swift_code' => :'String',
    :'tenant' => :'String',
    :'note' => :'String',
    :'security' => :'Security'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 443

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_status == o.access_status &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      application_id == o.application_id &&
      balances == o.balances &&
      bank_routing == o.bank_routing &&
      creation_time == o.creation_time &&
      currency == o.currency &&
      customer_ids == o.customer_ids &&
      customer_type == o.customer_type &&
      exchange_rate_type == o.exchange_rate_type &&
      iban == o.iban &&
      id == o.id &&
       == o. &&
      is_sar_enabled == o.is_sar_enabled &&
      last_updated_time == o.last_updated_time &&
      metadata == o.metadata &&
      nickname == o.nickname &&
      status == o.status &&
      swift_code == o.swift_code &&
      tenant == o.tenant &&
      note == o.note &&
      security == o.security
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



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 519

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



590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 590

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



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 495

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


475
476
477
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 475

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



481
482
483
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 481

def hash
  [access_status, , , , , application_id, balances, bank_routing, creation_time, currency, customer_ids, customer_type, exchange_rate_type, iban, id, , is_sar_enabled, last_updated_time, metadata, nickname, status, swift_code, tenant, note, security].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@account_number.nil? && @account_number.to_s.length > 50
    invalid_properties.push('invalid value for "account_number", the character length must be smaller than or equal to 50.')
  end

  if !@account_number_masked.nil? && @account_number_masked.to_s.length > 50
    invalid_properties.push('invalid value for "account_number_masked", the character length must be smaller than or equal to 50.')
  end

  if !@bank_routing.nil? && @bank_routing.to_s.length > 9
    invalid_properties.push('invalid value for "bank_routing", the character length must be smaller than or equal to 9.')
  end

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

  if !@exchange_rate_type.nil? && @exchange_rate_type.to_s.length > 10
    invalid_properties.push('invalid value for "exchange_rate_type", the character length must be smaller than or equal to 10.')
  end

  if !@iban.nil? && @iban.to_s.length > 34
    invalid_properties.push('invalid value for "iban", the character length must be smaller than or equal to 34.')
  end

  if !@swift_code.nil? && @swift_code.to_s.length > 11
    invalid_properties.push('invalid value for "swift_code", the character length must be smaller than or equal to 11.')
  end

  if !@swift_code.nil? && @swift_code.to_s.length < 8
    invalid_properties.push('invalid value for "swift_code", the character length must be great than or equal to 8.')
  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



566
567
568
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 566

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



572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 572

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



560
561
562
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 560

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



354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/synctera_ruby_sdk/models/account_charge_secured.rb', line 354

def valid?
  return false if !@account_number.nil? && @account_number.to_s.length > 50
  return false if !@account_number_masked.nil? && @account_number_masked.to_s.length > 50
  return false if !@bank_routing.nil? && @bank_routing.to_s.length > 9
  return false if !@currency.nil? && @currency !~ Regexp.new(/^[A-Z]{3}$/)
  return false if !@exchange_rate_type.nil? && @exchange_rate_type.to_s.length > 10
  return false if !@iban.nil? && @iban.to_s.length > 34
  return false if !@swift_code.nil? && @swift_code.to_s.length > 11
  return false if !@swift_code.nil? && @swift_code.to_s.length < 8
  true
end