Class: Plaid::TransactionsGetRequestOptions

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

Overview

An optional object to be used with the request. If specified, ‘options` must not be `null`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionsGetRequestOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 85

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

  if attributes.key?(:'count')
    self.count = attributes[:'count']
  else
    self.count = 100
  end

  if attributes.key?(:'offset')
    self.offset = attributes[:'offset']
  else
    self.offset = 0
  end

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

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

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

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

  if attributes.key?(:'days_requested')
    self.days_requested = attributes[:'days_requested']
  else
    self.days_requested = 90
  end
end

Instance Attribute Details

#account_ids ⇒ Object

A list of ‘account_ids` to retrieve for the Item Note: An error will be returned if a provided `account_id` is not associated with the Item.



20
21
22
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 20

def 
  @account_ids
end

#count ⇒ Object

The number of transactions to fetch.



23
24
25
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 23

def count
  @count
end

#days_requested ⇒ Object

This field only applies to calls for Items where the Transactions product has not already been initialized (i.e. by specifying ‘transactions` in the `products`, `optional_products`, or `required_if_consented_products` array when calling `/link/token/create` or by making a previous call to `/transactions/sync` or `/transactions/get`). In those cases, the field controls the maximum number of days of transaction history that Plaid will request from the financial institution. The more transaction history is requested, the longer the historical update poll will take. If no value is specified, 90 days of history will be requested by default. If a value under 30 is provided, a minimum of 30 days of history will be requested. If you are initializing your Items with transactions during the `/link/token/create` call (e.g. by including `transactions` in the `/link/token/create` `products` array), you must use the [`transactions.days_requested`](plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) field in the `/link/token/create` request instead of in the `/transactions/get` request. If the Item has already been initialized with the Transactions product, this field will have no effect. The maximum amount of transaction history to request on an Item cannot be updated if Transactions has already been added to the Item. To request older transaction history on an Item where Transactions has already been added, you must delete the Item via `/item/remove` and send the user through Link to create a new Item. Customers using [Recurring Transactions](plaid.com/docs/api/products/transactions/#transactionsrecurringget) should request at least 180 days of history for optimal results.



41
42
43
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 41

def days_requested
  @days_requested
end

#include_logo_and_counterparty_beta ⇒ Object

Counterparties and extra merchant fields are now returned by default.



38
39
40
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 38

def include_logo_and_counterparty_beta
  @include_logo_and_counterparty_beta
end

#include_original_description ⇒ Object

Include the raw unparsed transaction description from the financial institution.



29
30
31
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 29

def include_original_description
  @include_original_description
end

#include_personal_finance_category ⇒ Object

Personal finance categories are now returned by default.



35
36
37
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 35

def include_personal_finance_category
  @include_personal_finance_category
end

#include_personal_finance_category_beta ⇒ Object

Personal finance categories are now returned by default.



32
33
34
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 32

def include_personal_finance_category_beta
  @include_personal_finance_category_beta
end

#offset ⇒ Object

The number of transactions to skip. The default value is 0.



26
27
28
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 26

def offset
  @offset
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 44

def self.attribute_map
  {
    :'account_ids' => :'account_ids',
    :'count' => :'count',
    :'offset' => :'offset',
    :'include_original_description' => :'include_original_description',
    :'include_personal_finance_category_beta' => :'include_personal_finance_category_beta',
    :'include_personal_finance_category' => :'include_personal_finance_category',
    :'include_logo_and_counterparty_beta' => :'include_logo_and_counterparty_beta',
    :'days_requested' => :'days_requested'
  }
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



259
260
261
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 259

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
81
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 77

def self.openapi_nullable
  Set.new([
    :'include_original_description',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 63

def self.openapi_types
  {
    :'account_ids' => :'Array<String>',
    :'count' => :'Integer',
    :'offset' => :'Integer',
    :'include_original_description' => :'Boolean',
    :'include_personal_finance_category_beta' => :'Boolean',
    :'include_personal_finance_category' => :'Boolean',
    :'include_logo_and_counterparty_beta' => :'Boolean',
    :'days_requested' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      count == o.count &&
      offset == o.offset &&
      include_original_description == o.include_original_description &&
      include_personal_finance_category_beta == o.include_personal_finance_category_beta &&
      include_personal_finance_category == o.include_personal_finance_category &&
      include_logo_and_counterparty_beta == o.include_logo_and_counterparty_beta &&
      days_requested == o.days_requested
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



290
291
292
293
294
295
296
297
298
299
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
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 290

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 361

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 266

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


246
247
248
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 246

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



252
253
254
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 252

def hash
  [, count, offset, include_original_description, include_personal_finance_category_beta, include_personal_finance_category, include_logo_and_counterparty_beta, days_requested].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@count.nil? && @count > 500
    invalid_properties.push('invalid value for "count", must be smaller than or equal to 500.')
  end

  if !@count.nil? && @count < 1
    invalid_properties.push('invalid value for "count", must be greater than or equal to 1.')
  end


  if !@offset.nil? && @offset < 0
    invalid_properties.push('invalid value for "offset", must be greater than or equal to 0.')
  end


  if !@days_requested.nil? && @days_requested > 730
    invalid_properties.push('invalid value for "days_requested", must be smaller than or equal to 730.')
  end

  if !@days_requested.nil? && @days_requested < 1
    invalid_properties.push('invalid value for "days_requested", must be greater than or equal to 1.')
  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



337
338
339
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 337

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



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

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



331
332
333
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 331

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



179
180
181
182
183
184
185
186
 
# File 'lib/plaid/models/transactions_get_request_options.rb', line 179

def valid?
  return false if !@count.nil? && @count > 500
  return false if !@count.nil? && @count < 1
  return false if !@offset.nil? && @offset < 0
  return false if !@days_requested.nil? && @days_requested > 730
  return false if !@days_requested.nil? && @days_requested < 1
  true
end