Class used to call the Item product.

Sections
Namespace
Methods
G
I
R
Attributes
[R] access_token

The Plaid::AccessToken product accessor.
[R] public_token

The Plaid::PublicToken product accessor.
[R] webhook

The Plaid::Webhook product accessor.
Public
Instance Public methods
get(access_token)

Get information about an item.

Does a POST /item/get call which returns information about an item or ItemStatus.

#access_token

#access_token who's item to fetch status for

Returns

Returns a GetResponse object with item information.

Source: show 

# File lib/plaid/products/item.rb, line 144
def get(access_token)
  post_with_auth 'item/get',
                 GetResponse,
                 access_token: access_token
end
import(products, user_auth, options)

Import an item.

Does a POST /item/import call which imports an item.

products

array of products to enable

user_auth

hash map of user authentication information

options

optional hash map of options

Returns

Returns an access token for the item.

Source: show 

# File lib/plaid/products/item.rb, line 193
def import(products, user_auth, options)
  post_with_auth 'item/import',
                 ImportResponse,
                 products: products,
                 user_auth: user_auth,
                 options: options
end
remove(access_token)

Removes an item

Does a POST /item/remove call which is used to remove an item

#access_token

#access_token who's item to remove

Returns

Returns a RemoveResponse object with remove result.

Source: show 

# File lib/plaid/products/item.rb, line 170
def remove(access_token)
  post_with_auth 'item/remove',
                 RemoveResponse,
                 access_token: access_token
end