Class: MoneyKit::PlaidCompatible::Item

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb

Overview

Metadata about the Item.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Item

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `MoneyKit::PlaidCompatible::Item` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `MoneyKit::PlaidCompatible::Item`. 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
  end

  self.item_id = attributes[:item_id] if attributes.key?(:item_id)

  self.institution_id = attributes[:institution_id] if attributes.key?(:institution_id)

  self.webhook = attributes[:webhook] if attributes.key?(:webhook)

  self.error = attributes[:error] if attributes.key?(:error)

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

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

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

  return unless attributes.key?(:consented_products)
  return unless (value = attributes[:consented_products]).is_a?(Array)

  self.consented_products = value
end

Instance Attribute Details

#available_products ⇒ Object

A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with ‘billed_products`.



30
31
32
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 30

def available_products
  @available_products
end

#billed_products ⇒ Object

A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with ‘available_products`. Note - `billed_products` is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as `balance`, will not appear here.



33
34
35
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 33

def billed_products
  @billed_products
end

#consented_products ⇒ Object

Beta: A list of products that have gone through consent collection for the Item. Only present for those enabled in the beta.



39
40
41
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 39

def consented_products
  @consented_products
end

#error ⇒ Object

Returns the value of attribute error.



27
28
29
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 27

def error
  @error
end

#institution_id ⇒ Object

The Plaid Institution ID associated with the Item. Field is ‘null` for Items created via Same Day Micro-deposits.



22
23
24
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 22

def institution_id
  @institution_id
end

#item_id ⇒ Object

The Plaid Item ID. The ‘item_id` is always unique; linking the same account at the same institution twice will result in two Items with different `item_id` values. Like all Plaid identifiers, the `item_id` is case-sensitive.



19
20
21
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 19

def item_id
  @item_id
end

#products ⇒ Object

A list of authorized products for the Item.



36
37
38
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 36

def products
  @products
end

#webhook ⇒ Object

The URL registered to receive webhooks for the Item.



25
26
27
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 25

def webhook
  @webhook
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



56
57
58
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 42

def self.attribute_map
  {
    'item_id': :item_id,
    'institution_id': :institution_id,
    'webhook': :webhook,
    'error': :error,
    'available_products': :available_products,
    'billed_products': :billed_products,
    'products': :products,
    'consented_products': :consented_products
  }
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



188
189
190
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 188

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
79
80
81
82
83
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 75

def self.openapi_nullable
  Set.new(i[
            institution_id
            webhook
            error
            products
            consented_products
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    'item_id': :String,
    'institution_id': :String,
    'webhook': :String,
    'error': :PlaidError,
    'available_products': :'Array<Products>',
    'billed_products': :'Array<Products>',
    'products': :'Array<Products>',
    'consented_products': :'Array<Products>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 158

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    item_id == other.item_id &&
    institution_id == other.institution_id &&
    webhook == other.webhook &&
    error == other.error &&
    available_products == other.available_products &&
    billed_products == other.billed_products &&
    products == other.products &&
    consented_products == other.consented_products
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 221

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 292

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 195

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)
      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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(::Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 174

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
183
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 180

def hash
  [item_id, institution_id, webhook, error, available_products, billed_products, products,
   consented_products].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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 131

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "item_id", item_id cannot be nil.') if @item_id.nil?

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

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



268
269
270
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 268

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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 274

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



262
263
264
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 262

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



148
149
150
151
152
153
154
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/item.rb', line 148

def valid?
  return false if @item_id.nil?
  return false if @available_products.nil?
  return false if @billed_products.nil?

  true
end