Class: Plaid::TransactionsSyncResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/transactions_sync_response.rb

Overview

TransactionsSyncResponse defines the response schema for ‘/transactions/sync`

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionsSyncResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 105

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

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

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

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

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

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

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

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

Instance Attribute Details

#accounts ⇒ Object

An array of accounts at a financial institution associated with the transactions in this response. Only accounts that have associated transactions will be shown. For example, ‘investment`-type accounts will be omitted.



22
23
24
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 22

def accounts
  @accounts
end

#added ⇒ Object

Transactions that have been added to the Item since ‘cursor` ordered by ascending last modified time.



25
26
27
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 25

def added
  @added
end

#has_more ⇒ Object

Represents if more than requested count of transaction updates exist. If true, the additional updates can be fetched by making an additional request with ‘cursor` set to `next_cursor`. If `has_more` is true, it’s important to pull all available pages, to make it less likely for underlying data changes to conflict with pagination.



37
38
39
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 37

def has_more
  @has_more
end

#modified ⇒ Object

Transactions that have been modified on the Item since ‘cursor` ordered by ascending last modified time.



28
29
30
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 28

def modified
  @modified
end

#next_cursor ⇒ Object

Cursor used for fetching any future updates after the latest update provided in this response. The cursor obtained after all pages have been pulled (indicated by ‘has_more` being `false`) will be valid for at least 1 year. This cursor should be persisted for later calls. If transactions are not yet available, this will be an empty string. If `account_id` is included in the request, the returned cursor will reflect updates for that specific account.



34
35
36
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 34

def next_cursor
  @next_cursor
end

#removed ⇒ Object

Transactions that have been removed from the Item since ‘cursor` ordered by ascending last modified time.



31
32
33
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 31

def removed
  @removed
end

#request_id ⇒ Object

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.



40
41
42
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 40

def request_id
  @request_id
end

#transactions_update_status ⇒ Object

Returns the value of attribute transactions_update_status.



19
20
21
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 19

def transactions_update_status
  @transactions_update_status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 65

def self.attribute_map
  {
    :'transactions_update_status' => :'transactions_update_status',
    :'accounts' => :'accounts',
    :'added' => :'added',
    :'modified' => :'modified',
    :'removed' => :'removed',
    :'next_cursor' => :'next_cursor',
    :'has_more' => :'has_more',
    :'request_id' => :'request_id'
  }
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



242
243
244
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 242

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 84

def self.openapi_types
  {
    :'transactions_update_status' => :'TransactionsUpdateStatus',
    :'accounts' => :'Array<AccountBase>',
    :'added' => :'Array<Transaction>',
    :'modified' => :'Array<Transaction>',
    :'removed' => :'Array<RemovedTransaction>',
    :'next_cursor' => :'String',
    :'has_more' => :'Boolean',
    :'request_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      transactions_update_status == o.transactions_update_status &&
      accounts == o.accounts &&
      added == o.added &&
      modified == o.modified &&
      removed == o.removed &&
      next_cursor == o.next_cursor &&
      has_more == o.has_more &&
      request_id == o.request_id
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



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/plaid/models/transactions_sync_response.rb', line 273

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 = Plaid.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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 344

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 249

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


229
230
231
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 235

def hash
  [transactions_update_status, accounts, added, modified, removed, next_cursor, has_more, request_id].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



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
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 161

def list_invalid_properties
  invalid_properties = Array.new
  if @transactions_update_status.nil?
    invalid_properties.push('invalid value for "transactions_update_status", transactions_update_status cannot be nil.')
  end

  if @accounts.nil?
    invalid_properties.push('invalid value for "accounts", accounts cannot be nil.')
  end

  if @added.nil?
    invalid_properties.push('invalid value for "added", added cannot be nil.')
  end

  if @modified.nil?
    invalid_properties.push('invalid value for "modified", modified cannot be nil.')
  end

  if @removed.nil?
    invalid_properties.push('invalid value for "removed", removed cannot be nil.')
  end

  if @next_cursor.nil?
    invalid_properties.push('invalid value for "next_cursor", next_cursor cannot be nil.')
  end

  if @has_more.nil?
    invalid_properties.push('invalid value for "has_more", has_more cannot be nil.')
  end

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



320
321
322
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 320

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 326

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



314
315
316
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 314

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



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/plaid/models/transactions_sync_response.rb', line 200

def valid?
  return false if @transactions_update_status.nil?
  return false if @accounts.nil?
  return false if @added.nil?
  return false if @modified.nil?
  return false if @removed.nil?
  return false if @next_cursor.nil?
  return false if @has_more.nil?
  return false if @request_id.nil?
  true
end