plaid 13.2.0 → 14.0.0.beta.1

data/docs/SandboxBankTransferSimulateResponse.md

@@ -0,0 +1,18 @@
+# Plaid::SandboxBankTransferSimulateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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::SandboxBankTransferSimulateResponse.new(
+  request_id: null
+)
+```
+

data/docs/SandboxItemFireWebhookRequest.md

@@ -0,0 +1,24 @@
+# Plaid::SandboxItemFireWebhookRequest
+
+## 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. |  |
+| **webhook_code** | **String** | The following values for `webhook_code` are supported:  * `DEFAULT_UPDATE` | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::SandboxItemFireWebhookRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null,
+  webhook_code: null
+)
+```
+

data/docs/SandboxItemFireWebhookResponse.md

@@ -0,0 +1,20 @@
+# Plaid::SandboxItemFireWebhookResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_fired** | **Boolean** | Value is `true`  if the test` webhook_code`  was successfully fired. |  |
+| **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::SandboxItemFireWebhookResponse.new(
+  webhook_fired: null,
+  request_id: null
+)
+```
+

data/docs/SandboxItemResetLoginRequest.md

@@ -0,0 +1,22 @@
+# Plaid::SandboxItemResetLoginRequest
+
+## 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::SandboxItemResetLoginRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null
+)
+```
+

data/docs/SandboxItemResetLoginResponse.md

@@ -0,0 +1,20 @@
+# Plaid::SandboxItemResetLoginResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reset_login** | **Boolean** | `true` if the call succeeded |  |
+| **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::SandboxItemResetLoginResponse.new(
+  reset_login: null,
+  request_id: null
+)
+```
+

data/docs/SandboxItemSetVerificationStatusRequest.md

@@ -0,0 +1,26 @@
+# Plaid::SandboxItemSetVerificationStatusRequest
+
+## 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. |  |
+| **account_id** | **String** | The `account_id` of the account whose verification status is to be modified |  |
+| **verification_status** | **String** | The verification status to set the account to. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::SandboxItemSetVerificationStatusRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null,
+  account_id: null,
+  verification_status: null
+)
+```
+

data/docs/SandboxItemSetVerificationStatusResponse.md

@@ -0,0 +1,18 @@
+# Plaid::SandboxItemSetVerificationStatusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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::SandboxItemSetVerificationStatusResponse.new(
+  request_id: null
+)
+```
+

data/docs/SandboxProcessorTokenCreateRequest.md

@@ -0,0 +1,24 @@
+# Plaid::SandboxProcessorTokenCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **institution_id** | **String** | The ID of the institution the Item will be associated with |  |
+| **options** | [**SandboxProcessorTokenCreateRequestOptions**](SandboxProcessorTokenCreateRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::SandboxProcessorTokenCreateRequest.new(
+  client_id: null,
+  secret: null,
+  institution_id: null,
+  options: null
+)
+```
+

data/docs/SandboxProcessorTokenCreateRequestOptions.md

@@ -0,0 +1,20 @@
+# Plaid::SandboxProcessorTokenCreateRequestOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **override_username** | **String** | Test username to use for the creation of the Sandbox Item. Default value is `user_good`. | [optional][default to 'user_good'] |
+| **override_password** | **String** | Test password to use for the creation of the Sandbox Item. Default value is `pass_good`. | [optional][default to 'pass_good'] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::SandboxProcessorTokenCreateRequestOptions.new(
+  override_username: null,
+  override_password: null
+)
+```
+

data/docs/SandboxProcessorTokenCreateResponse.md

@@ -0,0 +1,20 @@
+# Plaid::SandboxProcessorTokenCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **processor_token** | **String** | A processor token that can be used to call the `/processor/` endpoints. |  |
+| **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::SandboxProcessorTokenCreateResponse.new(
+  processor_token: null,
+  request_id: null
+)
+```
+

data/docs/SandboxPublicTokenCreateRequest.md

@@ -0,0 +1,26 @@
+# Plaid::SandboxPublicTokenCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **institution_id** | **String** | The ID of the institution the Item will be associated with |  |
+| **initial_products** | [**Array<Products>**](Products.md) | The products to initially pull for the Item. May be any products that the specified `institution_id`  supports. This array may not be empty. |  |
+| **options** | [**SandboxPublicTokenCreateRequestOptions**](SandboxPublicTokenCreateRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::SandboxPublicTokenCreateRequest.new(
+  client_id: null,
+  secret: null,
+  institution_id: null,
+  initial_products: null,
+  options: null
+)
+```
+

data/docs/SandboxPublicTokenCreateRequestOptions.md

@@ -0,0 +1,24 @@
+# Plaid::SandboxPublicTokenCreateRequestOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook** | **String** | Specify a webhook to associate with the new Item. | [optional] |
+| **override_username** | **String** | Test username to use for the creation of the Sandbox Item. Default value is `user_good`. | [optional][default to 'user_good'] |
+| **override_password** | **String** | Test password to use for the creation of the Sandbox Item. Default value is `pass_good`. | [optional][default to 'pass_good'] |
+| **transactions** | [**SandboxPublicTokenCreateRequestOptionsTransactions**](SandboxPublicTokenCreateRequestOptionsTransactions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::SandboxPublicTokenCreateRequestOptions.new(
+  webhook: null,
+  override_username: null,
+  override_password: null,
+  transactions: null
+)
+```
+

data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md

@@ -0,0 +1,20 @@
+# Plaid::SandboxPublicTokenCreateRequestOptionsTransactions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **String** | The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD. | [optional] |
+| **end_date** | **String** | The most recent date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::SandboxPublicTokenCreateRequestOptionsTransactions.new(
+  start_date: null,
+  end_date: null
+)
+```
+

data/docs/SandboxPublicTokenCreateResponse.md

@@ -0,0 +1,20 @@
+# Plaid::SandboxPublicTokenCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_token** | **String** | A public token that can be exchanged for an access token using `/item/public_token/exchange` |  |
+| **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::SandboxPublicTokenCreateResponse.new(
+  public_token: null,
+  request_id: null
+)
+```
+

data/docs/Security.md

@@ -0,0 +1,46 @@
+# Plaid::Security
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **security_id** | **String** | A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the `security_id` is case sensitive. |  |
+| **isin** | **String** | 12-character ISIN, a globally unique securities identifier. | [optional] |
+| **cusip** | **String** | 9-character CUSIP, an identifier assigned to North American securities. | [optional] |
+| **sedol** | **String** | 7-character SEDOL, an identifier assigned to securities in the UK. | [optional] |
+| **institution_security_id** | **String** | An identifier given to the security by the institution | [optional] |
+| **institution_id** | **String** | If `institution_security_id` is present, this field indicates the Plaid `institution_id` of the institution to whom the identifier belongs. | [optional] |
+| **proxy_security_id** | **String** | In certain cases, Plaid will provide the ID of another security whose performance resembles this security, typically when the original security has low volume, or when a private security can be modeled with a publicly traded security. | [optional] |
+| **name** | **String** | A descriptive name for the security, suitable for display. | [optional] |
+| **ticker_symbol** | **String** | The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available. | [optional] |
+| **is_cash_equivalent** | **Boolean** | Indicates that a security is a highly liquid asset and can be treated like cash. | [optional] |
+| **type** | **String** | The security type of the holding. Valid security types are:  `cash`: Cash, currency, and money market funds  `derivative`: Options, warrants, and other derivative instruments  `equity`: Domestic and foreign equities  `etf`: Multi-asset exchange-traded investment funds  `fixed income`: Bonds and certificates of deposit (CDs)  `loan`: Loans and loan receivables.  `mutual fund`: Open- and closed-end vehicles pooling funds of multiple investors.  `other`: Unknown or other investment types |  |
+| **close_price** | **Float** | Price of the security at the close of the previous trading session. `null` for non-public securities. | [optional] |
+| **close_price_as_of** | **String** | Date for which `close_price` is accurate. Always `null` if `close_price` is `null`. | [optional] |
+| **iso_currency_code** | **String** | The ISO-4217 currency code of the price given. Always `null` if `unofficial_currency_code` is non-`null`. | [optional] |
+| **unofficial_currency_code** | **String** | The unofficial currency code associated with the security. 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::Security.new(
+  security_id: null,
+  isin: null,
+  cusip: null,
+  sedol: null,
+  institution_security_id: null,
+  institution_id: null,
+  proxy_security_id: null,
+  name: null,
+  ticker_symbol: null,
+  is_cash_equivalent: null,
+  type: null,
+  close_price: null,
+  close_price_as_of: null,
+  iso_currency_code: null,
+  unofficial_currency_code: null
+)
+```
+

data/docs/ServicerAddressData.md

@@ -0,0 +1,26 @@
+# Plaid::ServicerAddressData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **city** | **String** | The full city name | [optional] |
+| **region** | **String** | The region or state Example: `\"NC\"` | [optional] |
+| **street** | **String** | The full street address Example: `\"564 Main Street, APT 15\"` | [optional] |
+| **postal_code** | **String** | The postal code | [optional] |
+| **country** | **String** | The ISO 3166-1 alpha-2 country code | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ServicerAddressData.new(
+  city: null,
+  region: null,
+  street: null,
+  postal_code: null,
+  country: null
+)
+```
+

data/docs/StandaloneAccountType.md

@@ -0,0 +1,26 @@
+# Plaid::StandaloneAccountType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **depository** | **String** | An account type holding cash, in which funds are deposited. Supported products for `depository` accounts are: Auth, Balance, Transactions, Identity, Payment Initiation, and Assets. |  |
+| **credit** | **String** | A credit card type account. Supported products for `credit` accounts are: Balance, Transactions, Identity, and Liabilities. |  |
+| **loan** | **String** | A loan type account. Supported products for `loan` accounts are: Balance, Liabilities, and Transactions. |  |
+| **investment** | **String** | An investment account. Supported products for `investment` accounts are: Balance and Investments. |  |
+| **other** | **String** | Other or unknown account type. Supported products for `other` accounts are: Balance, Transactions, Identity, and Assets. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::StandaloneAccountType.new(
+  depository: null,
+  credit: null,
+  loan: null,
+  investment: null,
+  other: null
+)
+```
+

data/docs/StandaloneCurrencyCodeList.md

@@ -0,0 +1,20 @@
+# Plaid::StandaloneCurrencyCodeList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iso_currency_code** | **String** | Plaid supports all ISO 4217 currency codes. |  |
+| **unofficial_currency_code** | **String** | List of unofficial currency codes |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::StandaloneCurrencyCodeList.new(
+  iso_currency_code: null,
+  unofficial_currency_code: null
+)
+```
+