plaid 14.0.0.beta.3 → 14.1.0

data/docs/AssetReportRefreshResponse.md

@@ -1,22 +0,0 @@
-# Plaid::AssetReportRefreshResponse
-
-## 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. |  |
-| **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. |  |
-| **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::AssetReportRefreshResponse.new(
-  asset_report_id: null,
-  asset_report_token: null,
-  request_id: null
-)
-```
-

data/docs/AssetReportRemoveRequest.md

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

data/docs/AssetReportRemoveResponse.md

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

data/docs/AssetReportTransaction.md

@@ -1,62 +0,0 @@
-# Plaid::AssetReportTransaction
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **transaction_type** | **String** | Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.  `digital:` transactions that took place online.  `place:` transactions that were made at a physical location.  `special:` transactions that relate to banks, e.g. fees or deposits.  `unresolved:` transactions that do not fit into the other three types.  | [optional] |
-| **transaction_id** | **String** | The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive. |  |
-| **account_owner** | **String** | The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts. | [optional] |
-| **pending_transaction_id** | **String** | The ID of a posted transaction's associated pending transaction, where applicable. | [optional] |
-| **pending** | **Boolean** | When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled. |  |
-| **payment_channel** | **String** | The channel used to make a payment. `online:` transactions that took place online.  `in store:` transactions that were made at a physical location.  `other:` transactions that relate to banks, e.g. fees or deposits.  This field replaces the `transaction_type` field.  | [optional] |
-| **payment_meta** | [**PaymentMeta**](PaymentMeta.md) |  | [optional] |
-| **name** | **String** | The merchant name or transaction description.  If the `transaction` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
-| **merchant_name** | **String** | The merchant name, as extracted by Plaid from the `name` field. | [optional] |
-| **location** | [**Location**](Location.md) |  | [optional] |
-| **authorized_date** | **String** | The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | [optional] |
-| **authorized_datetime** | **String** | Date and time when a transaction was authorized in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`. | [optional] |
-| **date** | **String** | For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). |  |
-| **datetime** | **String** | Date and time when a transaction was posted in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`. | [optional] |
-| **category_id** | **String** | The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).  If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
-| **category** | **Array<String>** | A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).  If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
-| **unofficial_currency_code** | **String** | The unofficial currency code associated with the transaction. 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] |
-| **iso_currency_code** | **String** | The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null. | [optional] |
-| **amount** | **Float** | The settled value of the transaction, denominated in the account's currency, as stated in `iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative. |  |
-| **account_id** | **String** | The ID of the account in which this transaction occurred. |  |
-| **transaction_code** | [**TransactionCode**](TransactionCode.md) |  | [optional] |
-| **date_transacted** | **String** | The date on which the transaction took place, in IS0 8601 format. | [optional] |
-| **original_description** | **String** | The string returned by the financial institution to describe the transaction |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportTransaction.new(
-  transaction_type: null,
-  transaction_id: null,
-  account_owner: null,
-  pending_transaction_id: null,
-  pending: null,
-  payment_channel: null,
-  payment_meta: null,
-  name: null,
-  merchant_name: null,
-  location: null,
-  authorized_date: null,
-  authorized_datetime: null,
-  date: null,
-  datetime: null,
-  category_id: null,
-  category: null,
-  unofficial_currency_code: null,
-  iso_currency_code: null,
-  amount: null,
-  account_id: null,
-  transaction_code: null,
-  date_transacted: null,
-  original_description: null
-)
-```
-

data/docs/AssetReportTransactionAllOf.md

@@ -1,20 +0,0 @@
-# Plaid::AssetReportTransactionAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **date_transacted** | **String** | The date on which the transaction took place, in IS0 8601 format. | [optional] |
-| **original_description** | **String** | The string returned by the financial institution to describe the transaction |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportTransactionAllOf.new(
-  date_transacted: null,
-  original_description: null
-)
-```
-

data/docs/AssetReportUser.md

@@ -1,30 +0,0 @@
-# Plaid::AssetReportUser
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_user_id** | **String** | An identifier you determine and submit for the user. | [optional] |
-| **first_name** | **String** | The user's first name. Required for the Fannie Mae Day 1 Certainty™ program. | [optional] |
-| **middle_name** | **String** | The user's middle name | [optional] |
-| **last_name** | **String** | The user's last name.  Required for the Fannie Mae Day 1 Certainty™ program. | [optional] |
-| **ssn** | **String** | The user's Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program.  Format: \"ddd-dd-dddd\" | [optional] |
-| **phone_number** | **String** | The user's phone number, in E.164 format: +{countrycode}{number}. For example: \"+14151234567\" | [optional] |
-| **email** | **String** | The user's email address. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetReportUser.new(
-  client_user_id: null,
-  first_name: null,
-  middle_name: null,
-  last_name: null,
-  ssn: null,
-  phone_number: null,
-  email: null
-)
-```
-

data/docs/AssetsErrorWebhook.md

@@ -1,24 +0,0 @@
-# Plaid::AssetsErrorWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `ASSETS` |  |
-| **webhook_code** | **String** | `ERROR` |  |
-| **error** | [**Error**](Error.md) |  |  |
-| **asset_report_id** | **String** | The ID associated with the Asset Report. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetsErrorWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  error: null,
-  asset_report_id: null
-)
-```
-

data/docs/AssetsProductReadyWebhook.md

@@ -1,22 +0,0 @@
-# Plaid::AssetsProductReadyWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `ASSETS` |  |
-| **webhook_code** | **String** | `PRODUCT_READY` |  |
-| **asset_report_id** | **String** | The `asset_report_id` that can be provided to `/asset_report/get` to retrieve the Asset Report. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AssetsProductReadyWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  asset_report_id: null
-)
-```
-

data/docs/AuthGetNumbers.md

@@ -1,24 +0,0 @@
-# Plaid::AuthGetNumbers
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ach** | [**Array<NumbersACH>**](NumbersACH.md) | An array of ACH numbers identifying accounts. | [optional] |
-| **eft** | [**Array<NumbersEFT>**](NumbersEFT.md) | An array of EFT numbers identifying accounts. | [optional] |
-| **international** | [**Array<NumbersInternational>**](NumbersInternational.md) | An array of IBAN numbers identifying accounts. | [optional] |
-| **bacs** | [**Array<NumbersBACS>**](NumbersBACS.md) | An array of BACS numbers identifying accounts. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AuthGetNumbers.new(
-  ach: null,
-  eft: null,
-  international: null,
-  bacs: null
-)
-```
-

data/docs/AuthGetRequest.md

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

data/docs/AuthGetRequestOptions.md

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

data/docs/AuthGetResponse.md

@@ -1,24 +0,0 @@
-# Plaid::AuthGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **accounts** | [**Array<AccountBase>**](AccountBase.md) | The `accounts` for which numbers are being retrieved. |  |
-| **numbers** | [**AuthGetNumbers**](AuthGetNumbers.md) |  |  |
-| **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::AuthGetResponse.new(
-  accounts: null,
-  numbers: null,
-  item: null,
-  request_id: null
-)
-```
-

data/docs/AutomaticallyVerifiedWebhook.md

@@ -1,24 +0,0 @@
-# Plaid::AutomaticallyVerifiedWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `AUTH` |  |
-| **webhook_code** | **String** | `AUTOMATICALLY_VERIFIED` |  |
-| **account_id** | **String** | The `account_id` of the account associated with the webhook |  |
-| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::AutomaticallyVerifiedWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  account_id: null,
-  item_id: null
-)
-```
-

data/docs/BankTransfer.md

@@ -1,50 +0,0 @@
-# Plaid::BankTransfer
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | Plaid’s unique identifier for a bank transfer. |  |
-| **ach_class** | [**ACHClass**](ACHClass.md) |  |  |
-| **account_id** | **String** | The account ID that should be credited/debited for this bank transfer. |  |
-| **type** | [**BankTransferType**](BankTransferType.md) |  |  |
-| **user** | [**BankTransferUser**](BankTransferUser.md) |  |  |
-| **amount** | **String** | The amount of the transfer (decimal string with two digits of precision e.g. “10.00”). |  |
-| **iso_currency_code** | **String** | The currency of the transfer amount, e.g. \"USD\" |  |
-| **description** | **String** | The description of the transfer. |  |
-| **created** | **String** | The datetime when this bank transfer was created. This will be of the form `2006-01-02T15:04:05Z` |  |
-| **status** | [**BankTransferStatus**](BankTransferStatus.md) |  |  |
-| **network** | [**BankTransferNetwork**](BankTransferNetwork.md) |  |  |
-| **cancellable** | **Boolean** | When `true`, you can still cancel this bank transfer. |  |
-| **failure_reason** | [**BankTransferFailure**](BankTransferFailure.md) |  | [optional] |
-| **custom_tag** | **String** | A string containing the custom tag provided by the client in the create request. Will be null if not provided. | [optional] |
-| **metadata** | **Hash<String, String>** | The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters  |  |
-| **origination_account_id** | **String** | Plaid’s unique identifier for the origination account that was used for this transfer. |  |
-| **direction** | [**BankTransferDirection**](BankTransferDirection.md) |  |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransfer.new(
-  id: null,
-  ach_class: null,
-  account_id: null,
-  type: null,
-  user: null,
-  amount: null,
-  iso_currency_code: null,
-  description: null,
-  created: null,
-  status: null,
-  network: null,
-  cancellable: null,
-  failure_reason: null,
-  custom_tag: null,
-  metadata: null,
-  origination_account_id: null,
-  direction: null
-)
-```
-

data/docs/BankTransferBalance.md

@@ -1,20 +0,0 @@
-# Plaid::BankTransferBalance
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **available** | **String** | The total available balance - the sum of all successful debit transfer amounts minus all credit transfer amounts. |  |
-| **transactable** | **String** | The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferBalance.new(
-  available: null,
-  transactable: null
-)
-```
-

data/docs/BankTransferBalanceGetRequest.md

@@ -1,22 +0,0 @@
-# Plaid::BankTransferBalanceGetRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **origination_account_id** | **String** | If multiple origination accounts are available, `origination_account_id` must be used to specify the account for which balance will be returned. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferBalanceGetRequest.new(
-  client_id: null,
-  secret: null,
-  origination_account_id: null
-)
-```
-