Class: Plaid::Item

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

Overview

Metadata about the Item.

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/plaid/models/item.rb', line 119

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'update_type')
    self.update_type = attributes[:'update_type']
  end
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`.



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

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.



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

def billed_products
  @billed_products
end

#consent_expiration_time ⇒ Object

The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the ‘ITEM_LOGIN_REQUIRED` error state. To circumvent the `ITEM_LOGIN_REQUIRED` error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time. Note - This is only relevant for certain OAuth-based institutions. For all other institutions, this field will be null.



43
44
45
 
# File 'lib/plaid/models/item.rb', line 43

def consent_expiration_time
  @consent_expiration_time
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.



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

def consented_products
  @consented_products
end

#error ⇒ Object

Returns the value of attribute error.



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

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.



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

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.



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

def item_id
  @item_id
end

#products ⇒ Object

A list of authorized products for the Item.



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

def products
  @products
end

#update_type ⇒ Object

Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication. ‘background` - Item can be updated in the background `user_present_required` - Item requires user interaction to be updated



46
47
48
 
# File 'lib/plaid/models/item.rb', line 46

def update_type
  @update_type
end

#webhook ⇒ Object

The URL registered to receive webhooks for the Item.



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

def webhook
  @webhook
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/plaid/models/item.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/plaid/models/item.rb', line 71

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



258
259
260
 
# File 'lib/plaid/models/item.rb', line 258

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
112
113
114
115
 
# File 'lib/plaid/models/item.rb', line 108

def self.openapi_nullable
  Set.new([
    :'institution_id',
    :'webhook',
    :'error',
    :'consent_expiration_time',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/plaid/models/item.rb', line 92

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>',
    :'consent_expiration_time' => :'Time',
    :'update_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/plaid/models/item.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_id == o.item_id &&
      institution_id == o.institution_id &&
      webhook == o.webhook &&
      error == o.error &&
      available_products == o.available_products &&
      billed_products == o.billed_products &&
      products == o.products &&
      consented_products == o.consented_products &&
      consent_expiration_time == o.consent_expiration_time &&
      update_type == o.update_type
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



288
289
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
 
# File 'lib/plaid/models/item.rb', line 288

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/plaid/models/item.rb', line 359

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



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

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


245
246
247
 
# File 'lib/plaid/models/item.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/plaid/models/item.rb', line 251

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/plaid/models/item.rb', line 183

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

  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

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



335
336
337
 
# File 'lib/plaid/models/item.rb', line 335

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/plaid/models/item.rb', line 341

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



329
330
331
 
# File 'lib/plaid/models/item.rb', line 329

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



206
207
208
209
210
211
212
213
214
 
# File 'lib/plaid/models/item.rb', line 206

def valid?
  return false if @item_id.nil?
  return false if @available_products.nil?
  return false if @billed_products.nil?
  return false if @update_type.nil?
  update_type_validator = EnumAttributeValidator.new('String', ["background", "user_present_required"])
  return false unless update_type_validator.valid?(@update_type)
  true
end