Class: SyncteraRubySdk::InternalAccount

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InternalAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'account_type')
    self. = attributes[:'account_type']
  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?(:'description')
    self.description = attributes[:'description']
  end

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

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

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

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

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

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

Instance Attribute Details

#account_number ⇒ Object

Generated internal account number



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

def 
  @account_number
end

#account_type ⇒ Object

Returns the value of attribute account_type.



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

def 
  @account_type
end

#balances ⇒ Object

A list of balances for internal account based on different type



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

def balances
  @balances
end

#bank_routing ⇒ Object

Bank routing number



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

def bank_routing
  @bank_routing
end

#creation_time ⇒ Object

The date and time the resource was created.



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

def creation_time
  @creation_time
end

#currency ⇒ Object

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



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

def currency
  @currency
end

#description ⇒ Object

A user provided description for the current account



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

def description
  @description
end

#gl_type ⇒ Object

What type of general ledger account this internal account represents.



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

def gl_type
  @gl_type
end

#id ⇒ Object

Generated ID for internal account



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

def id
  @id
end

#is_system_acc ⇒ Object

Is a system-controlled internal account. When this field is true, this internal account will be reserved exclusively for internal use by the Synctera platform and any internal transfers to or from this internal account will be declined.



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

def is_system_acc
  @is_system_acc
end

#last_updated_time ⇒ Object

The date and time the resource was last updated.



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

def last_updated_time
  @last_updated_time
end

#purpose ⇒ Object

Returns the value of attribute purpose.



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

def purpose
  @purpose
end

#status ⇒ Object

Returns the value of attribute status.



52
53
54
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 52

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 77

def self.attribute_map
  {
    :'account_number' => :'account_number',
    :'account_type' => :'account_type',
    :'balances' => :'balances',
    :'bank_routing' => :'bank_routing',
    :'creation_time' => :'creation_time',
    :'currency' => :'currency',
    :'description' => :'description',
    :'gl_type' => :'gl_type',
    :'id' => :'id',
    :'is_system_acc' => :'is_system_acc',
    :'last_updated_time' => :'last_updated_time',
    :'purpose' => :'purpose',
    :'status' => :'status'
  }
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



339
340
341
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 339

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



120
121
122
123
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 120

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 101

def self.openapi_types
  {
    :'account_number' => :'String',
    :'account_type' => :'InternalAccountType',
    :'balances' => :'Array<Balance>',
    :'bank_routing' => :'String',
    :'creation_time' => :'Time',
    :'currency' => :'String',
    :'description' => :'String',
    :'gl_type' => :'String',
    :'id' => :'String',
    :'is_system_acc' => :'Boolean',
    :'last_updated_time' => :'Time',
    :'purpose' => :'InternalAccountPurpose',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 306

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      balances == o.balances &&
      bank_routing == o.bank_routing &&
      creation_time == o.creation_time &&
      currency == o.currency &&
      description == o.description &&
      gl_type == o.gl_type &&
      id == o.id &&
      is_system_acc == o.is_system_acc &&
      last_updated_time == o.last_updated_time &&
      purpose == o.purpose &&
      status == o.status
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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 370

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 441

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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 346

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


326
327
328
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 326

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



332
333
334
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 332

def hash
  [, , balances, bank_routing, creation_time, currency, description, gl_type, id, is_system_acc, last_updated_time, purpose, status].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



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

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

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

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



417
418
419
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 417

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



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

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



411
412
413
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 411

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



231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/synctera_ruby_sdk/models/internal_account.rb', line 231

def valid?
  return false if !@account_number.nil? && @account_number.to_s.length > 17
  return false if !@account_number.nil? && @account_number.to_s.length < 14
  return false if !@bank_routing.nil? && @bank_routing.to_s.length > 9
  return false if @currency.nil?
  return false if @currency !~ Regexp.new(/^[A-Z]{3}$/)
  gl_type_validator = EnumAttributeValidator.new('String', ["ASSET", "LIABILITY", "EXPENSE", "REVENUE"])
  return false unless gl_type_validator.valid?(@gl_type)
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE"])
  return false unless status_validator.valid?(@status)
  true
end