Class: SyncteraRubySdk::Statement

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

Overview

A statement for a depository account

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Statement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
216
217
218
219
220
221
222
223
224
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 134

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

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

Instance Attribute Details

#account_id ⇒ Object

The unique identifier of the account the statement belongs to



20
21
22
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 20

def 
  @account_id
end

#account_summary ⇒ Object

Returns the value of attribute account_summary.



37
38
39
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 37

def 
  @account_summary
end

#authorized_signer ⇒ Object

Returns the value of attribute authorized_signer.



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

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.



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

def closing_balance
  @closing_balance
end

#customer_service_details ⇒ Object

Returns the value of attribute customer_service_details.



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

def customer_service_details
  @customer_service_details
end

#disclosure ⇒ Object

Returns the value of attribute disclosure.



46
47
48
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 46

def disclosure
  @disclosure
end

#due_date ⇒ Object

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



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

def due_date
  @due_date
end

#end_date ⇒ Object

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



26
27
28
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 26

def end_date
  @end_date
end

#id ⇒ Object

statement ID



29
30
31
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 29

def id
  @id
end

#issue_date ⇒ Object

The date when the statement has been issued



32
33
34
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 32

def issue_date
  @issue_date
end

#joint_account_holders ⇒ Object

Returns the value of attribute joint_account_holders.



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

def 
  @joint_account_holders
end

#opening_balance ⇒ Object

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



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

def opening_balance
  @opening_balance
end

#primary_account_holder_business ⇒ Object

Returns the value of attribute primary_account_holder_business.



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

def 
  @primary_account_holder_business
end

#primary_account_holder_personal ⇒ Object

Returns the value of attribute primary_account_holder_personal.



55
56
57
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 55

def 
  @primary_account_holder_personal
end

#savings_summary ⇒ Object

Returns the value of attribute savings_summary.



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

def savings_summary
  @savings_summary
end

#start_date ⇒ Object

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



35
36
37
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 35

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.



58
59
60
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 58

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.



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

def transactions_omitted
  @transactions_omitted
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 66

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',
    :'savings_summary' => :'savings_summary'
  }
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



279
280
281
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 279

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



125
126
127
128
129
130
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 125

def self.openapi_all_of
  [
  :'BaseStatement',
  :'StatementAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 95

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',
    :'savings_summary' => :'SavingsSummary'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 241

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 &&
      savings_summary == o.savings_summary
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



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

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 381

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 286

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


266
267
268
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 272

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



228
229
230
231
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 228

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



357
358
359
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 357

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 363

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



351
352
353
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 351

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



235
236
237
 
# File 'lib/synctera_ruby_sdk/models/statement.rb', line 235

def valid?
  true
end