Plaid::Item
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
Metadata about the Item.
Constants
Constructors
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance methods
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
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.
Custom attribute writer method checking allowed values (enum). @param [Object] available_products Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] billed_products Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] consent_expiration_time Object to be assigned
A list of products that have gone through consent collection for the Item. Only present for those enabled in the Data Transparency beta. If you are not enrolled in Data Transparency, this field is not used.
Custom attribute writer method checking allowed values (enum). @param [Object] consented_products Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] error Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
The Plaid Institution ID associated with the Item. Field is null for Items created via Same Day Micro-deposits.
Custom attribute writer method checking allowed values (enum). @param [Object] institution_id Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] item_id Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
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.
Custom attribute writer method checking allowed values (enum). @param [Object] products Object to be assigned
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
Custom attribute writer method checking allowed values (enum). @param [Object] update_type Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid