Package com.plaid.client.model

Class Item

java.lang.Object
com.plaid.client.model.Item
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class Item
extends java.lang.Object
Metadata about the Item.

  • Field Details

  • Constructor Details

    • Item

      public Item()

  • Method Details

    • itemId

      public Item itemId​(java.lang.String itemId)

    • getItemId

      public java.lang.String getItemId()
      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.
      Returns:
      itemId

    • setItemId

      public void setItemId​(java.lang.String itemId)

    • institutionId

      public Item institutionId​(java.lang.String institutionId)

    • getInstitutionId

      @Nullable public java.lang.String getInstitutionId()
      The Plaid Institution ID associated with the Item. Field is `null` for Items created via Same Day Micro-deposits.
      Returns:
      institutionId

    • setInstitutionId

      public void setInstitutionId​(java.lang.String institutionId)

    • webhook

      public Item webhook​(java.lang.String webhook)

    • getWebhook

      @Nullable public java.lang.String getWebhook()
      The URL registered to receive webhooks for the Item.
      Returns:
      webhook

    • setWebhook

      public void setWebhook​(java.lang.String webhook)

    • error

      public Item error​(Error error)

    • getError

      @Nullable public Error getError()
      Get error
      Returns:
      error

    • setError

      public void setError​(Error error)

    • availableProducts

      public Item availableProducts​(java.util.List<Products> availableProducts)

    • addAvailableProductsItem

      public Item addAvailableProductsItem​(Products availableProductsItem)

    • getAvailableProducts

      public java.util.List<Products> getAvailableProducts()
      A list of products available for the Item that have not yet been accessed.
      Returns:
      availableProducts

    • setAvailableProducts

      public void setAvailableProducts​(java.util.List<Products> availableProducts)

    • billedProducts

      public Item billedProducts​(java.util.List<Products> billedProducts)

    • addBilledProductsItem

      public Item addBilledProductsItem​(Products billedProductsItem)

    • getBilledProducts

      public java.util.List<Products> getBilledProducts()
      A list of products that have been billed for the Item. Note - `billed_products` is populated in all environments but only requests in Production are billed.
      Returns:
      billedProducts

    • setBilledProducts

      public void setBilledProducts​(java.util.List<Products> billedProducts)

    • consentExpirationTime

      public Item consentExpirationTime​(java.time.OffsetDateTime consentExpirationTime)

    • getConsentExpirationTime

      @Nullable public java.time.OffsetDateTime getConsentExpirationTime()
      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.
      Returns:
      consentExpirationTime

    • setConsentExpirationTime

      public void setConsentExpirationTime​(java.time.OffsetDateTime consentExpirationTime)

    • updateType

      public Item updateType​(Item.UpdateTypeEnum updateType)

    • getUpdateType

      public Item.UpdateTypeEnum getUpdateType()
      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
      Returns:
      updateType

    • setUpdateType

      public void setUpdateType​(Item.UpdateTypeEnum updateType)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object