plaid 13.2.0 → 14.0.0.beta.1

data/docs/InvestmentHoldingsGetRequestOptions.md

@@ -0,0 +1,18 @@
+# Plaid::InvestmentHoldingsGetRequestOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_ids** | **Array<String>** | An array of `account_id`s to retrieve for the Item. An error will be returned if a provided `account_id` is not associated with the Item. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InvestmentHoldingsGetRequestOptions.new(
+  account_ids: null
+)
+```
+

data/docs/InvestmentTransaction.md

@@ -0,0 +1,44 @@
+# Plaid::InvestmentTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **investment_transaction_id** | **String** | The ID of the Investment transaction, unique across all Plaid transactions. Like all Plaid identifiers, the `investment_transaction_id` is case sensitive. |  |
+| **cancel_transaction_id** | **String** |  | [optional] |
+| **account_id** | **String** | The `account_id` of the account against which this transaction posted. |  |
+| **security_id** | **String** | The `security_id` to which this transaction is related. | [optional] |
+| **date** | **String** | The ISO-8601 posting date for the transaction, or transacted date for pending transactions. |  |
+| **name** | **String** | The institution’s description of the transaction. |  |
+| **quantity** | **Float** | The number of units of the security involved in this transactions |  |
+| **amount** | **Float** | The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities. |  |
+| **price** | **Float** | The price of the security at which this transaction occurred. |  |
+| **fees** | **Float** | The combined value of all fees applied to this transaction | [optional] |
+| **type** | **String** | Value is one of the following: `buy`: Buying an investment `sell`: Selling an investment `cancel`: A cancellation of a pending transaction  `cash`: Activity that modifies a cash position `fee`: A fee on the account `transfer`: Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer |  |
+| **subtype** | **String** | For descriptions of possible transaction subtypes, see [Investment transaction subtypes schema](/docs/api/accounts/#investment-transaction-subtypes-schema). |  |
+| **iso_currency_code** | **String** | The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-`null`. | [optional] |
+| **unofficial_currency_code** | **String** | The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.  See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InvestmentTransaction.new(
+  investment_transaction_id: null,
+  cancel_transaction_id: null,
+  account_id: null,
+  security_id: null,
+  date: null,
+  name: null,
+  quantity: null,
+  amount: null,
+  price: null,
+  fees: null,
+  type: null,
+  subtype: null,
+  iso_currency_code: null,
+  unofficial_currency_code: null
+)
+```
+

data/docs/InvestmentsDefaultUpdateWebhook.md

@@ -0,0 +1,28 @@
+# Plaid::InvestmentsDefaultUpdateWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_type** | **String** | `INVESTMENTS_TRANSACTIONS` |  |
+| **webhook_code** | **String** | `DEFAULT_UPDATE` |  |
+| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **new_investments_transactions** | **Float** | The number of new transactions reported since the last time this webhook was fired. |  |
+| **canceled_investments_transactions** | **Float** | The number of canceled transactions reported since the last time this webhook was fired. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InvestmentsDefaultUpdateWebhook.new(
+  webhook_type: null,
+  webhook_code: null,
+  item_id: null,
+  error: null,
+  new_investments_transactions: null,
+  canceled_investments_transactions: null
+)
+```
+

data/docs/InvestmentsHoldingsGetRequest.md

@@ -0,0 +1,24 @@
+# Plaid::InvestmentsHoldingsGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **access_token** | **String** | The access token associated with the Item data is being requested for. |  |
+| **options** | [**InvestmentHoldingsGetRequestOptions**](InvestmentHoldingsGetRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InvestmentsHoldingsGetRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null,
+  options: null
+)
+```
+

data/docs/InvestmentsHoldingsGetResponse.md

@@ -0,0 +1,26 @@
+# Plaid::InvestmentsHoldingsGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accounts** | [**Array<AccountBase>**](AccountBase.md) | The accounts associated with the Item |  |
+| **holdings** | [**Array<Holding>**](Holding.md) | The holdings belonging to investment accounts associated with the Item. Details of the securities in the holdings are provided in the `securities` field.  |  |
+| **securities** | [**Array<Security>**](Security.md) | Objects describing the securities held in the accounts associated with the Item.  |  |
+| **item** | [**Item**](Item.md) |  |  |
+| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InvestmentsHoldingsGetResponse.new(
+  accounts: null,
+  holdings: null,
+  securities: null,
+  item: null,
+  request_id: null
+)
+```
+

data/docs/InvestmentsTransactionsGetRequest.md

@@ -0,0 +1,28 @@
+# Plaid::InvestmentsTransactionsGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **access_token** | **String** | The access token associated with the Item data is being requested for. |  |
+| **start_date** | **Date** | The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD. |  |
+| **end_date** | **Date** | The most recent date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD. |  |
+| **options** | [**InvestmentsTransactionsGetRequestOptions**](InvestmentsTransactionsGetRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InvestmentsTransactionsGetRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null,
+  start_date: null,
+  end_date: null,
+  options: null
+)
+```
+

data/docs/InvestmentsTransactionsGetRequestOptions.md

@@ -0,0 +1,22 @@
+# Plaid::InvestmentsTransactionsGetRequestOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_ids** | **Array<String>** | An array of `account_ids` to retrieve for the Item. | [optional] |
+| **count** | **Integer** | The number of transactions to fetch.  | [optional][default to 100] |
+| **offset** | **Integer** | The number of transactions to skip when fetching transaction history | [optional][default to 0] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InvestmentsTransactionsGetRequestOptions.new(
+  account_ids: null,
+  count: null,
+  offset: null
+)
+```
+

data/docs/InvestmentsTransactionsGetResponse.md

@@ -0,0 +1,28 @@
+# Plaid::InvestmentsTransactionsGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item** | [**Item**](Item.md) |  |  |
+| **accounts** | [**Array<AccountBase>**](AccountBase.md) | The accounts for which transaction history is being fetched. |  |
+| **securities** | [**Array<Security>**](Security.md) | All securities for which there is a corresponding transaction being fetched. |  |
+| **investment_transactions** | [**Array<InvestmentTransaction>**](InvestmentTransaction.md) | The transactions being fetched |  |
+| **total_investment_transactions** | **Integer** | The total number of transactions available within the date range specified. If `total_investment_transactions` is larger than the size of the `transactions` array, more transactions are available and can be fetched via manipulating the `offset` parameter.' |  |
+| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InvestmentsTransactionsGetResponse.new(
+  item: null,
+  accounts: null,
+  securities: null,
+  investment_transactions: null,
+  total_investment_transactions: null,
+  request_id: null
+)
+```
+

data/docs/Item.md

@@ -0,0 +1,32 @@
+# Plaid::Item
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_id** | **String** | 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. |  |
+| **institution_id** | **String** | The Plaid Institution ID associated with the Item. Field is `null` for Items created via Same Day Micro-deposits. | [optional] |
+| **webhook** | **String** | The URL registered to receive webhooks for the Item. | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **available_products** | [**Array<Products>**](Products.md) | A list of products available for the Item that have not yet been accessed. |  |
+| **billed_products** | [**Array<Products>**](Products.md) | 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.  |  |
+| **consent_expiration_time** | **String** | 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 European institutions subject to PSD2 regulations mandating a 90-day consent window. For all other institutions, this field will be null.  | [optional] |
+| **update_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::Item.new(
+  item_id: null,
+  institution_id: null,
+  webhook: null,
+  error: null,
+  available_products: null,
+  billed_products: null,
+  consent_expiration_time: null,
+  update_type: null
+)
+```
+

data/docs/ItemAccessTokenInvalidateRequest.md

@@ -0,0 +1,22 @@
+# Plaid::ItemAccessTokenInvalidateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **access_token** | **String** | The access token associated with the Item data is being requested for. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ItemAccessTokenInvalidateRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null
+)
+```
+

data/docs/ItemAccessTokenInvalidateResponse.md

@@ -0,0 +1,20 @@
+# Plaid::ItemAccessTokenInvalidateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **new_access_token** | **String** | The access token associated with the Item data is being requested for. |  |
+| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ItemAccessTokenInvalidateResponse.new(
+  new_access_token: null,
+  request_id: null
+)
+```
+

data/docs/ItemErrorWebhook.md

@@ -0,0 +1,24 @@
+# Plaid::ItemErrorWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_type** | **String** | `ITEM` |  |
+| **webhook_code** | **String** | `ERROR` |  |
+| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
+| **error** | [**Error**](Error.md) |  |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ItemErrorWebhook.new(
+  webhook_type: null,
+  webhook_code: null,
+  item_id: null,
+  error: null
+)
+```
+

data/docs/ItemGetRequest.md

@@ -0,0 +1,22 @@
+# Plaid::ItemGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **access_token** | **String** | The access token associated with the Item data is being requested for. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ItemGetRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null
+)
+```
+

data/docs/ItemGetResponse.md

@@ -0,0 +1,24 @@
+# Plaid::ItemGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item** | [**Item**](Item.md) |  |  |
+| **status** | [**NullableItemStatus**](NullableItemStatus.md) |  | [optional] |
+| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |  |
+| **access_token** | [**NullableAccessToken**](NullableAccessToken.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ItemGetResponse.new(
+  item: null,
+  status: null,
+  request_id: null,
+  access_token: null
+)
+```
+

data/docs/ItemImportRequest.md

@@ -0,0 +1,26 @@
+# Plaid::ItemImportRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **products** | [**Array<Products>**](Products.md) | Array of product strings |  |
+| **user_auth** | [**ItemImportRequestUserAuth**](ItemImportRequestUserAuth.md) |  |  |
+| **options** | [**ItemImportRequestOptions**](ItemImportRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ItemImportRequest.new(
+  client_id: null,
+  secret: null,
+  products: null,
+  user_auth: null,
+  options: null
+)
+```
+

data/docs/ItemImportRequestOptions.md

@@ -0,0 +1,18 @@
+# Plaid::ItemImportRequestOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook** | **String** | Specifies a webhook URL to associate with an Item. Plaid fires a webhook if credentials fail.  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ItemImportRequestOptions.new(
+  webhook: null
+)
+```
+

data/docs/ItemImportRequestUserAuth.md

@@ -0,0 +1,20 @@
+# Plaid::ItemImportRequestUserAuth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | Opaque user identifier |  |
+| **auth_token** | **String** | Authorization token Plaid will use to aggregate this user’s accounts |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ItemImportRequestUserAuth.new(
+  user_id: null,
+  auth_token: null
+)
+```
+