plaid 14.0.0.beta.2 → 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown

data/docs/AccountIdentity.md

@@ -1,34 +0,0 @@
-# Plaid::AccountIdentity
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new `account_id` will be assigned to the account.  The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`.  Like all Plaid identifiers, the `account_id` is case sensitive. |  |
-| **balances** | [**AccountBalance**](AccountBalance.md) |  |  |
-| **mask** | **String** | The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user. | [optional] |
-| **name** | **String** | The name of the account, either assigned by the user or by the financial institution itself |  |
-| **official_name** | **String** | The official name of the account as given by the financial institution | [optional] |
-| **type** | [**AccountType**](AccountType.md) |  |  |
-| **subtype** | [**AccountSubtype**](AccountSubtype.md) |  |  |
-| **verification_status** | **String** | The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.  Returned for Auth Items only.  `pending_automatic_verification`: The Item is pending automatic verification  `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the two amounts.  `automatically_verified`: The Item has successfully been automatically verified   `manually_verified`: The Item has successfully been manually verified  `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.  `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.    | [optional] |
-| **owners** | [**Array<Owner>**](Owner.md) | Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AccountIdentity.new(
-  account_id: null,
-  balances: null,
-  mask: null,
-  name: null,
-  official_name: null,
-  type: null,
-  subtype: null,
-  verification_status: null,
-  owners: null
-)
-```
-

data/docs/AccountIdentityAllOf.md

@@ -1,18 +0,0 @@
-# Plaid::AccountIdentityAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **owners** | [**Array<Owner>**](Owner.md) | Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AccountIdentityAllOf.new(
-  owners: null
-)
-```
-

data/docs/AccountSubtype.md

@@ -1,15 +0,0 @@
-# Plaid::AccountSubtype
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AccountSubtype.new()
-```
-

data/docs/AccountType.md

@@ -1,15 +0,0 @@
-# Plaid::AccountType
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AccountType.new()
-```
-

data/docs/AccountsBalanceGetRequest.md

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

data/docs/AccountsBalanceGetRequestOptions.md

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

data/docs/AccountsGetRequest.md

@@ -1,24 +0,0 @@
-# Plaid::AccountsGetRequest
-
-## 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** | [**AccountsGetRequestOptions**](AccountsGetRequestOptions.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AccountsGetRequest.new(
-  client_id: null,
-  secret: null,
-  access_token: null,
-  options: null
-)
-```
-

data/docs/AccountsGetRequestOptions.md

@@ -1,18 +0,0 @@
-# Plaid::AccountsGetRequestOptions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_ids** | **Array<String>** | An array of `account_ids` to retrieve for the Account. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AccountsGetRequestOptions.new(
-  account_ids: null
-)
-```
-

data/docs/AccountsGetResponse.md

@@ -1,22 +0,0 @@
-# Plaid::AccountsGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **accounts** | [**Array<AccountBase>**](AccountBase.md) | An array of financial institution accounts associated with the Item. If `/accounts/balance/get` was called, each account will include real-time balance information. |  |
-| **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::AccountsGetResponse.new(
-  accounts: null,
-  item: null,
-  request_id: null
-)
-```
-

data/docs/Address.md

@@ -1,20 +0,0 @@
-# Plaid::Address
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **data** | [**AddressData**](AddressData.md) |  |  |
-| **primary** | **Boolean** | When `true`, identifies the address as the primary address on an account. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::Address.new(
-  data: null,
-  primary: null
-)
-```
-

data/docs/AddressData.md

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

data/docs/Amount.md

@@ -1,20 +0,0 @@
-# Plaid::Amount
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **currency** | **String** | The ISO-4217 currency code of the payment. For standing orders, `\"GBP\"` must be used. |  |
-| **value** | **Float** | The amount of the payment. Must contain at most two digits of precision e.g. `1.23`. Minimum accepted value is `1`. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::Amount.new(
-  currency: null,
-  value: null
-)
-```
-

data/docs/AssetReport.md

@@ -1,28 +0,0 @@
-# Plaid::AssetReport
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **asset_report_id** | **String** | A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive. |  |
-| **client_report_id** | **String** | An identifier you determine and submit for the Asset Report. |  |
-| **date_generated** | **String** | The date and time when the Asset Report was created, in ISO 8601 format (e.g. \"2018-04-12T03:32:11Z\"). |  |
-| **days_requested** | **Float** | The duration of transaction history you requested |  |
-| **user** | [**AssetReportUser**](AssetReportUser.md) |  |  |
-| **items** | [**Array<AssetReportItem>**](AssetReportItem.md) | Data returned by Plaid about each of the Items included in the Asset Report. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReport.new(
-  asset_report_id: null,
-  client_report_id: null,
-  date_generated: null,
-  days_requested: null,
-  user: null,
-  items: null
-)
-```
-

data/docs/AssetReportAuditCopyCreateRequest.md

@@ -1,24 +0,0 @@
-# Plaid::AssetReportAuditCopyCreateRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **asset_report_token** | **String** | A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report. |  |
-| **auditor_id** | **String** | The `auditor_id` of the third party with whom you would like to share the Asset Report. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportAuditCopyCreateRequest.new(
-  client_id: null,
-  secret: null,
-  asset_report_token: null,
-  auditor_id: null
-)
-```
-

data/docs/AssetReportAuditCopyCreateResponse.md

@@ -1,20 +0,0 @@
-# Plaid::AssetReportAuditCopyCreateResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **audit_copy_token** | **String** | A token that can be shared with a third party auditor to allow them to obtain access to the Asset Report. This token should be stored securely. |  |
-| **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::AssetReportAuditCopyCreateResponse.new(
-  audit_copy_token: null,
-  request_id: null
-)
-```
-

data/docs/AssetReportAuditCopyGetRequest.md

@@ -1,22 +0,0 @@
-# Plaid::AssetReportAuditCopyGetRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **audit_copy_token** | **String** | The `audit_copy_token` granting access to the Audit Copy you would like to get. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportAuditCopyGetRequest.new(
-  client_id: null,
-  secret: null,
-  audit_copy_token: null
-)
-```
-

data/docs/AssetReportAuditCopyRemoveRequest.md

@@ -1,22 +0,0 @@
-# Plaid::AssetReportAuditCopyRemoveRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **audit_copy_token** | **String** | The `audit_copy_token` granting access to the Audit Copy you would like to revoke. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportAuditCopyRemoveRequest.new(
-  client_id: null,
-  secret: null,
-  audit_copy_token: null
-)
-```
-

data/docs/AssetReportAuditCopyRemoveResponse.md

@@ -1,20 +0,0 @@
-# Plaid::AssetReportAuditCopyRemoveResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **removed** | **Boolean** | `true` if the Audit Copy was successfully removed. |  |
-| **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::AssetReportAuditCopyRemoveResponse.new(
-  removed: null,
-  request_id: null
-)
-```
-

data/docs/AssetReportCreateRequest.md

@@ -1,26 +0,0 @@
-# Plaid::AssetReportCreateRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **access_tokens** | **Array<String>** | An array of access tokens corresponding to the Items that will be included in the report. The `assets` product must have been initialized for the Items during link; the Assets product cannot be added after initialization. |  |
-| **days_requested** | **Integer** | The maximum integer number of days of history to include in the Asset Report. If using Fannie Mae Day 1 Certainty, `days_requested` must be at least 61 for new originations or at least 31 for refinancings. |  |
-| **options** | [**AssetReportCreateRequestOptions**](AssetReportCreateRequestOptions.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportCreateRequest.new(
-  client_id: null,
-  secret: null,
-  access_tokens: null,
-  days_requested: null,
-  options: null
-)
-```
-

data/docs/AssetReportCreateRequestOptions.md

@@ -1,22 +0,0 @@
-# Plaid::AssetReportCreateRequestOptions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_report_id** | **String** | Client-generated identifier, which can be used by lenders to track loan applications. | [optional] |
-| **webhook** | **String** | URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready. | [optional] |
-| **user** | [**AssetReportUser**](AssetReportUser.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportCreateRequestOptions.new(
-  client_report_id: null,
-  webhook: null,
-  user: null
-)
-```
-

data/docs/AssetReportCreateResponse.md

@@ -1,22 +0,0 @@
-# Plaid::AssetReportCreateResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **asset_report_token** | **String** | A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report. |  |
-| **asset_report_id** | **String** | A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive. |  |
-| **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::AssetReportCreateResponse.new(
-  asset_report_token: null,
-  asset_report_id: null,
-  request_id: null
-)
-```
-

data/docs/AssetReportFilterRequest.md

@@ -1,24 +0,0 @@
-# Plaid::AssetReportFilterRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **asset_report_token** | **String** | A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report. |  |
-| **account_ids_to_exclude** | **Array<String>** | The accounts to exclude from the Asset Report, identified by `account_id`. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportFilterRequest.new(
-  client_id: null,
-  secret: null,
-  asset_report_token: null,
-  account_ids_to_exclude: null
-)
-```
-

data/docs/AssetReportFilterResponse.md

@@ -1,22 +0,0 @@
-# Plaid::AssetReportFilterResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **asset_report_token** | **String** | A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report. |  |
-| **asset_report_id** | **String** | A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive. |  |
-| **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::AssetReportFilterResponse.new(
-  asset_report_token: null,
-  asset_report_id: null,
-  request_id: null
-)
-```
-

data/docs/AssetReportGetRequest.md

@@ -1,24 +0,0 @@
-# Plaid::AssetReportGetRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **asset_report_token** | **String** | A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report. |  |
-| **include_insights** | **Boolean** | `true` if you would like to retrieve the Asset Report with Insights, `false` otherwise. This field defaults to `false` if omitted. [Contact Plaid Support](https://dashboard.plaid.com/support) to get access to this feature. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportGetRequest.new(
-  client_id: null,
-  secret: null,
-  asset_report_token: null,
-  include_insights: null
-)
-```
-

data/docs/AssetReportGetResponse.md

@@ -1,22 +0,0 @@
-# Plaid::AssetReportGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **report** | [**AssetReport**](AssetReport.md) |  |  |
-| **warnings** | [**Array<Warning>**](Warning.md) | If the Asset Report generation was successful but identity information cannot be returned, this array will contain information about the errors causing identity information to be missing |  |
-| **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::AssetReportGetResponse.new(
-  report: null,
-  warnings: null,
-  request_id: null
-)
-```
-

data/docs/AssetReportItem.md

@@ -1,26 +0,0 @@
-# Plaid::AssetReportItem
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
-| **institution_name** | **String** | The full financial institution name associated with the Item. |  |
-| **institution_id** | **String** | The id of the financial institution associated with the Item. |  |
-| **date_last_updated** | **String** | The date and time when this Item’s data was last retrieved from the financial institution, in ISO 8601 format. |  |
-| **accounts** | [**Array<AccountAssets>**](AccountAssets.md) | Data about each of the accounts open on the Item. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportItem.new(
-  item_id: null,
-  institution_name: null,
-  institution_id: null,
-  date_last_updated: null,
-  accounts: null
-)
-```
-

data/docs/AssetReportPDFGetRequest.md

@@ -1,22 +0,0 @@
-# Plaid::AssetReportPDFGetRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **asset_report_token** | **String** | A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportPDFGetRequest.new(
-  client_id: null,
-  secret: null,
-  asset_report_token: null
-)
-```
-

data/docs/AssetReportRefreshRequest.md

@@ -1,26 +0,0 @@
-# Plaid::AssetReportRefreshRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **asset_report_token** | **String** | The `asset_report_token` returned by the original call to `/asset_report/create` |  |
-| **days_requested** | **Integer** | The maximum number of days of history to include in the Asset Report. Must be an integer. If not specified, the value from the original call to `/asset_report/create` will be used. | [optional] |
-| **options** | [**AssetReportRefreshRequestOptions**](AssetReportRefreshRequestOptions.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportRefreshRequest.new(
-  client_id: null,
-  secret: null,
-  asset_report_token: null,
-  days_requested: null,
-  options: null
-)
-```
-