Class: Plaid::ItemWithConsentFields

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/item_with_consent_fields.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 = {}) ⇒ ItemWithConsentFields

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 153

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

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

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

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

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

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

Instance Attribute Details

#auth_method ⇒ Object

Returns the value of attribute auth_method.



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

def auth_method
  @auth_method
end

#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`.



36
37
38
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 36

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.



39
40
41
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 39

def billed_products
  @billed_products
end

#consent_expiration_time ⇒ Object

The date and time at which the Item’s access consent will expire, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format. If the Item does not have consent expiration scheduled, this field will be ‘null`. Currently, only institutions in Europe and a small number of institutions in the US have expiring consent. Closer to the 1033 compliance deadline of April 1, 2026, expiration times will be populated more widely. For more details, see [Data Transparency Messaging consent expiration](plaid.com/docs/link/data-transparency-messaging-migration-guide/#consent-expiration-and-reauthorization).



48
49
50
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 48

def consent_expiration_time
  @consent_expiration_time
end

#consented_data_scopes ⇒ Object

A list of data scopes that the user has consented to for the Item via [Data Transparency Messaging](/docs/link/data-transparency-messaging-migration-guide). These are based on the ‘consented_products`; see the [full mapping](/docs/link/data-transparency-messaging-migration-guide/#data-scopes-by-product) of data scopes and products.



60
61
62
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 60

def consented_data_scopes
  @consented_data_scopes
end

#consented_products ⇒ Object

A list of products that the user has consented to for the Item via [Data Transparency Messaging](/docs/link/data-transparency-messaging-migration-guide). This will consist of all products where both of the following are true: the user has consented to the required data scopes for that product and you have Production access for that product.



45
46
47
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 45

def consented_products
  @consented_products
end

#consented_use_cases ⇒ Object

A list of use cases that the user has consented to for the Item via [Data Transparency Messaging](/docs/link/data-transparency-messaging-migration-guide). You can see the full list of use cases or update the list of use cases to request at any time via the Link Customization section of the [Plaid Dashboard](dashboard.plaid.com/link/data-transparency-v5).



57
58
59
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 57

def consented_use_cases
  @consented_use_cases
end

#created_at ⇒ Object

The date and time when the Item was created, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format.



54
55
56
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 54

def created_at
  @created_at
end

#error ⇒ Object

Returns the value of attribute error.



33
34
35
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 33

def error
  @error
end

#institution_id ⇒ Object

The Plaid Institution ID associated with the Item. Field is ‘null` for Items created without an institution connection, such as Items created via Same Day Micro-deposits.



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

def institution_id
  @institution_id
end

#institution_name ⇒ Object

The name of the institution associated with the Item. Field is ‘null` for Items created without an institution connection, such as Items created via Same Day Micro-deposits.



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

def institution_name
  @institution_name
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_with_consent_fields.rb', line 20

def item_id
  @item_id
end

#products ⇒ Object

A list of products added to the Item. In almost all cases, this will be the same as the ‘billed_products` field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before `/asset_report/create` has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in `products` but not in `billed_products`.



42
43
44
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 42

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



51
52
53
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 51

def update_type
  @update_type
end

#webhook ⇒ Object

The URL registered to receive webhooks for the Item.



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

def webhook
  @webhook
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



106
107
108
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 106

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 85

def self.attribute_map
  {
    :'item_id' => :'item_id',
    :'institution_id' => :'institution_id',
    :'institution_name' => :'institution_name',
    :'webhook' => :'webhook',
    :'auth_method' => :'auth_method',
    :'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',
    :'created_at' => :'created_at',
    :'consented_use_cases' => :'consented_use_cases',
    :'consented_data_scopes' => :'consented_data_scopes'
  }
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



321
322
323
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 321

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



144
145
146
147
148
149
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 144

def self.openapi_all_of
  [
  :'Item',
  :'ItemWithConsentFieldsAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 132

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

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 111

def self.openapi_types
  {
    :'item_id' => :'String',
    :'institution_id' => :'String',
    :'institution_name' => :'String',
    :'webhook' => :'String',
    :'auth_method' => :'ItemAuthMethod',
    :'error' => :'PlaidError',
    :'available_products' => :'Array<Products>',
    :'billed_products' => :'Array<Products>',
    :'products' => :'Array<Products>',
    :'consented_products' => :'Array<Products>',
    :'consent_expiration_time' => :'Time',
    :'update_type' => :'String',
    :'created_at' => :'Time',
    :'consented_use_cases' => :'Array<String>',
    :'consented_data_scopes' => :'Array<ItemConsentedDataScope>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_id == o.item_id &&
      institution_id == o.institution_id &&
      institution_name == o.institution_name &&
      webhook == o.webhook &&
      auth_method == o.auth_method &&
      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 &&
      created_at == o.created_at &&
      consented_use_cases == o.consented_use_cases &&
      consented_data_scopes == o.consented_data_scopes
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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 352

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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 423

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 328

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


308
309
310
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 241

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



399
400
401
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 399

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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 405

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



393
394
395
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 393

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



264
265
266
267
268
269
270
271
272
 
# File 'lib/plaid/models/item_with_consent_fields.rb', line 264

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