Class: MoneyKit::PlaidCompatible::TransactionsGetRequestOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid_compatible/money_kit_plaid_compatible/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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 74

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

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

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

  if attributes.key?(:'include_personal_finance_category')
    self.include_personal_finance_category = attributes[:'include_personal_finance_category']
  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_compatible/money_kit_plaid_compatible/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_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 23

def count
  @count
end

#include_original_description ⇒ Object

Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager, or submit a [Support request](dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/product-functionality) .



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

def include_original_description
  @include_original_description
end

#include_personal_finance_category ⇒ Object

Include the [personal_finance_category](plaid.com/docs/api/products/transactions/#transactions-get-response-transactions-personal-finance-category) object in the response. See the [‘taxonomy csv file`](plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories. We’re introducing Category Rules - a new beta endpoint that will enable you to change the personal_finance_category for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to [email protected].



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

def include_personal_finance_category
  @include_personal_finance_category
end

#offset ⇒ Object

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



26
27
28
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/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



46
47
48
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 46

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 35

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



150
151
152
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 150

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
67
68
69
70
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 62

def self.openapi_nullable
  Set.new([
    :'account_ids',
    :'count',
    :'offset',
    :'include_original_description',
    :'include_personal_finance_category'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 51

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
131
132
133
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 125

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 == o.include_personal_finance_category
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



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
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 180

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 = MoneyKit::PlaidCompatible.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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 251

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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 157

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


137
138
139
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 137

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



143
144
145
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 143

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



112
113
114
115
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 112

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



227
228
229
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 227

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 233

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



221
222
223
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 221

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



119
120
121
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transactions_get_request_options.rb', line 119

def valid?
  true
end