Class: SyncteraRubySdk::BaseStatement

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseStatement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 129

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The unique identifier of the account the statement belongs to



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

def 
  @account_id
end

#account_summary ⇒ Object

Returns the value of attribute account_summary.



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

def 
  @account_summary
end

#authorized_signer ⇒ Object

Returns the value of attribute authorized_signer.



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

def authorized_signer
  @authorized_signer
end

#closing_balance ⇒ Object

The account balance at the end of the statement period, in ISO 4217 minor currency units.



41
42
43
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 41

def closing_balance
  @closing_balance
end

#customer_service_details ⇒ Object

Returns the value of attribute customer_service_details.



43
44
45
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 43

def customer_service_details
  @customer_service_details
end

#disclosure ⇒ Object

Returns the value of attribute disclosure.



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

def disclosure
  @disclosure
end

#due_date ⇒ Object

The limit date when the due amount indicated on the statement should be paid



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

def due_date
  @due_date
end

#end_date ⇒ Object

The date indicating the ending of the time interval covered by the statement



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

def end_date
  @end_date
end

#id ⇒ Object

statement ID



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

def id
  @id
end

#issue_date ⇒ Object

The date when the statement has been issued



31
32
33
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 31

def issue_date
  @issue_date
end

#joint_account_holders ⇒ Object

Returns the value of attribute joint_account_holders.



47
48
49
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 47

def 
  @joint_account_holders
end

#opening_balance ⇒ Object

The account balance at the start of the statement period, in ISO 4217 minor currency units.



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

def opening_balance
  @opening_balance
end

#primary_account_holder_business ⇒ Object

Returns the value of attribute primary_account_holder_business.



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

def 
  @primary_account_holder_business
end

#primary_account_holder_personal ⇒ Object

Returns the value of attribute primary_account_holder_personal.



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

def 
  @primary_account_holder_personal
end

#start_date ⇒ Object

The date indicating the beginning of the time interval covered by the statement



34
35
36
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 34

def start_date
  @start_date
end

#transactions ⇒ Object

This attribute is deprecated and will be removed in a future API version. Use ‘GET /v0/statements/statement_id/transactions` instead.



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

def transactions
  @transactions
end

#transactions_omitted ⇒ Object

Only appears in ‘statement.created` webhook payloads. Indicates that the `transactions` attribute was emptied due to webhook size constraints. If this attribute returns `true`, you may use `GET /v0/statements/statement_id/transactions` to retrieve the full list.



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

def transactions_omitted
  @transactions_omitted
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 86

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
75
76
77
78
79
80
81
82
83
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 63

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'due_date' => :'due_date',
    :'end_date' => :'end_date',
    :'id' => :'id',
    :'issue_date' => :'issue_date',
    :'start_date' => :'start_date',
    :'account_summary' => :'account_summary',
    :'authorized_signer' => :'authorized_signer',
    :'closing_balance' => :'closing_balance',
    :'customer_service_details' => :'customer_service_details',
    :'disclosure' => :'disclosure',
    :'joint_account_holders' => :'joint_account_holders',
    :'opening_balance' => :'opening_balance',
    :'primary_account_holder_business' => :'primary_account_holder_business',
    :'primary_account_holder_personal' => :'primary_account_holder_personal',
    :'transactions' => :'transactions',
    :'transactions_omitted' => :'transactions_omitted'
  }
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



269
270
271
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 269

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



120
121
122
123
124
125
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 120

def self.openapi_all_of
  [
  :'BaseStatementAllOf',
  :'StatementSummary'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 91

def self.openapi_types
  {
    :'account_id' => :'String',
    :'due_date' => :'Date',
    :'end_date' => :'Date',
    :'id' => :'String',
    :'issue_date' => :'Date',
    :'start_date' => :'Date',
    :'account_summary' => :'AccountSummary',
    :'authorized_signer' => :'Array<Person>',
    :'closing_balance' => :'Integer',
    :'customer_service_details' => :'CustomerServiceDetails',
    :'disclosure' => :'String',
    :'joint_account_holders' => :'Array<Person>',
    :'opening_balance' => :'Integer',
    :'primary_account_holder_business' => :'Business1',
    :'primary_account_holder_personal' => :'Person',
    :'transactions' => :'Array<Transaction>',
    :'transactions_omitted' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      due_date == o.due_date &&
      end_date == o.end_date &&
      id == o.id &&
      issue_date == o.issue_date &&
      start_date == o.start_date &&
       == o. &&
      authorized_signer == o.authorized_signer &&
      closing_balance == o.closing_balance &&
      customer_service_details == o.customer_service_details &&
      disclosure == o.disclosure &&
       == o. &&
      opening_balance == o.opening_balance &&
       == o. &&
       == o. &&
      transactions == o.transactions &&
      transactions_omitted == o.transactions_omitted
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



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

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 371

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 276

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


256
257
258
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 256

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



262
263
264
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 262

def hash
  [, due_date, end_date, id, issue_date, start_date, , authorized_signer, closing_balance, customer_service_details, disclosure, , opening_balance, , , transactions, transactions_omitted].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



219
220
221
222
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 219

def list_invalid_properties
  invalid_properties = Array.new
  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



347
348
349
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 347

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



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

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



341
342
343
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 341

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



226
227
228
 
# File 'lib/synctera_ruby_sdk/models/base_statement.rb', line 226

def valid?
  true
end