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

data/docs/BankTransferEventListRequest.md

@@ -1,40 +0,0 @@
-# Plaid::BankTransferEventListRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **start_date** | **Time** | The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`) | [optional] |
-| **end_date** | **Time** | The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`) | [optional] |
-| **bank_transfer_id** | **String** | Plaid’s unique identifier for a bank transfer. | [optional] |
-| **account_id** | **String** | The account ID to get events for all transactions to/from an account. | [optional] |
-| **bank_transfer_type** | **String** | The type of bank transfer. This will be either `debit` or `credit`.  A `debit` indicates a transfer of money into your origination account; a `credit` indicates a transfer of money out of your origination account. | [optional] |
-| **event_types** | [**Array<BankTransferEventType>**](BankTransferEventType.md) | Filter events by event type. | [optional] |
-| **count** | **Integer** | The maximum number of bank transfer events to return. If the number of events matching the above parameters is greater than `count`, the most recent events will be returned. | [optional][default to 25] |
-| **offset** | **Integer** | The offset into the list of bank transfer events. When `count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 bank transfer events will be returned. | [optional][default to 0] |
-| **origination_account_id** | **String** | The origination account ID to get events for transfers from a specific origination account. | [optional] |
-| **direction** | **String** | Indicates the direction of the transfer: `outbound` for API-initiated transfers, or `inbound` for payments received by the FBO account. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferEventListRequest.new(
-  client_id: null,
-  secret: null,
-  start_date: null,
-  end_date: null,
-  bank_transfer_id: null,
-  account_id: null,
-  bank_transfer_type: null,
-  event_types: null,
-  count: null,
-  offset: null,
-  origination_account_id: null,
-  direction: null
-)
-```
-

data/docs/BankTransferEventListResponse.md

@@ -1,20 +0,0 @@
-# Plaid::BankTransferEventListResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **bank_transfer_events** | [**Array<BankTransferEvent>**](BankTransferEvent.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::BankTransferEventListResponse.new(
-  bank_transfer_events: null,
-  request_id: null
-)
-```
-

data/docs/BankTransferEventSyncRequest.md

@@ -1,24 +0,0 @@
-# Plaid::BankTransferEventSyncRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **after_id** | **Integer** | The latest (largest) `event_id` fetched via the sync endpoint, or 0 initially. |  |
-| **count** | **Integer** | The maximum number of bank transfer events to return. | [optional][default to 25] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferEventSyncRequest.new(
-  client_id: null,
-  secret: null,
-  after_id: null,
-  count: null
-)
-```
-

data/docs/BankTransferEventSyncResponse.md

@@ -1,20 +0,0 @@
-# Plaid::BankTransferEventSyncResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **bank_transfer_events** | [**Array<BankTransferEvent>**](BankTransferEvent.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::BankTransferEventSyncResponse.new(
-  bank_transfer_events: null,
-  request_id: null
-)
-```
-

data/docs/BankTransferEventType.md

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

data/docs/BankTransferFailure.md

@@ -1,20 +0,0 @@
-# Plaid::BankTransferFailure
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ach_return_code** | **String** | The ACH return code, e.g. `R01`.  A return code will be provided if and only if the transfer status is `reversed`. For a full listing of ACH return codes, see [Bank Transfers errors](/docs/errors/bank-transfers/#ach-return-codes). | [optional] |
-| **description** | **String** | A human-readable description of the reason for the failure or reversal. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferFailure.new(
-  ach_return_code: null,
-  description: null
-)
-```
-

data/docs/BankTransferGetRequest.md

@@ -1,22 +0,0 @@
-# Plaid::BankTransferGetRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **bank_transfer_id** | **String** | Plaid’s unique identifier for a bank transfer. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferGetRequest.new(
-  client_id: null,
-  secret: null,
-  bank_transfer_id: null
-)
-```
-

data/docs/BankTransferGetResponse.md

@@ -1,20 +0,0 @@
-# Plaid::BankTransferGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **bank_transfer** | [**BankTransfer**](BankTransfer.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::BankTransferGetResponse.new(
-  bank_transfer: null,
-  request_id: null
-)
-```
-

data/docs/BankTransferListRequest.md

@@ -1,32 +0,0 @@
-# Plaid::BankTransferListRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **start_date** | **Time** | The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`) | [optional] |
-| **end_date** | **Time** | The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`) | [optional] |
-| **count** | **Integer** | The maximum number of bank transfers to return. | [optional][default to 25] |
-| **offset** | **Integer** | The number of bank transfers to skip before returning results. | [optional][default to 0] |
-| **origination_account_id** | **String** | Filter bank transfers to only those originated through the specified origination account. | [optional] |
-| **direction** | [**BankTransferDirection**](BankTransferDirection.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferListRequest.new(
-  client_id: null,
-  secret: null,
-  start_date: null,
-  end_date: null,
-  count: null,
-  offset: null,
-  origination_account_id: null,
-  direction: null
-)
-```
-

data/docs/BankTransferListResponse.md

@@ -1,20 +0,0 @@
-# Plaid::BankTransferListResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **bank_transfers** | [**Array<BankTransfer>**](BankTransfer.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::BankTransferListResponse.new(
-  bank_transfers: null,
-  request_id: null
-)
-```
-

data/docs/BankTransferMigrateAccountRequest.md

@@ -1,26 +0,0 @@
-# Plaid::BankTransferMigrateAccountRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **account_number** | **String** | The user's account number. |  |
-| **routing_number** | **String** | The user's routing number. |  |
-| **account_type** | **String** | The type of the bank account (`checking` or `savings`). |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferMigrateAccountRequest.new(
-  client_id: null,
-  secret: null,
-  account_number: null,
-  routing_number: null,
-  account_type: null
-)
-```
-

data/docs/BankTransferMigrateAccountResponse.md

@@ -1,22 +0,0 @@
-# Plaid::BankTransferMigrateAccountResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **access_token** | **String** | The Plaid `access_token` for the newly created Item. |  |
-| **account_id** | **String** | The Plaid `account_id` for the newly created Item. |  |
-| **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::BankTransferMigrateAccountResponse.new(
-  access_token: null,
-  account_id: null,
-  request_id: null
-)
-```
-

data/docs/BankTransferNetwork.md

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

data/docs/BankTransferReceiverDetails.md

@@ -1,18 +0,0 @@
-# Plaid::BankTransferReceiverDetails
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **available_balance** | **String** | The sign of the available balance for the receiver bank account associated with the receiver event at the time the matching transaction was found. Can be `positive`, `negative`, or null if the balance was not available at the time. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferReceiverDetails.new(
-  available_balance: null
-)
-```
-

data/docs/BankTransferStatus.md

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

data/docs/BankTransferType.md

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

data/docs/BankTransferUser.md

@@ -1,22 +0,0 @@
-# Plaid::BankTransferUser
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **legal_name** | **String** | The account holder’s full legal name. |  |
-| **email_address** | **String** | The account holder’s email. | [optional] |
-| **routing_number** | **String** | The account holder's routing number. This field is only used for response data. Do not provide this field when making requests. | [optional][readonly] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::BankTransferUser.new(
-  legal_name: null,
-  email_address: null,
-  routing_number: null
-)
-```
-

data/docs/CategoriesGetResponse.md

@@ -1,20 +0,0 @@
-# Plaid::CategoriesGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **categories** | [**Array<Category>**](Category.md) | An array of all of the transaction categories used by Plaid. |  |
-| **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::CategoriesGetResponse.new(
-  categories: null,
-  request_id: null
-)
-```
-

data/docs/Category.md

@@ -1,22 +0,0 @@
-# Plaid::Category
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **category_id** | **String** | An identifying number for the category. `category_id` is a Plaid-specific identifier and does not necessarily correspond to merchant category codes. |  |
-| **group** | **String** | `place` for physical transactions or `special` for other transactions such as bank charges. |  |
-| **hierarchy** | **Array<String>** | A hierarchical array of the categories to which this `category_id` belongs. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::Category.new(
-  category_id: null,
-  group: null,
-  hierarchy: null
-)
-```
-

data/docs/Cause.md

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

data/docs/CountryCode.md

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

data/docs/CreditCardLiability.md

@@ -1,34 +0,0 @@
-# Plaid::CreditCardLiability
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | The ID of the account that this liability belongs to. | [optional] |
-| **aprs** | [**Array<APR>**](APR.md) | The various interest rates that apply to the account. |  |
-| **is_overdue** | **Boolean** | true if a payment is currently overdue. Availability for this field is limited. | [optional] |
-| **last_payment_amount** | **Float** | The amount of the last payment. |  |
-| **last_payment_date** | **String** | The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). Availability for this field is limited. |  |
-| **last_statement_balance** | **Float** | The outstanding balance on the last statement. Availability for this field is limited. |  |
-| **last_statement_issue_date** | **String** | The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |  |
-| **minimum_payment_amount** | **Float** | The minimum payment due for the next billing cycle. |  |
-| **next_payment_due_date** | **String** | The due date for the next payment. The due date is `null` if a payment is not expected. Dates are returned in an ISO 8601 format (YYYY-MM-DD). |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::CreditCardLiability.new(
-  account_id: null,
-  aprs: null,
-  is_overdue: null,
-  last_payment_amount: null,
-  last_payment_date: null,
-  last_statement_balance: null,
-  last_statement_issue_date: null,
-  minimum_payment_amount: null,
-  next_payment_due_date: null
-)
-```
-

data/docs/CreditFilter.md

@@ -1,18 +0,0 @@
-# Plaid::CreditFilter
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_subtypes** | [**Array<AccountSubtype>**](AccountSubtype.md) | An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](/docs/api/accounts#accounts-schema).  |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::CreditFilter.new(
-  account_subtypes: null
-)
-```
-

data/docs/DefaultUpdateWebhook.md

@@ -1,26 +0,0 @@
-# Plaid::DefaultUpdateWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `TRANSACTIONS` |  |
-| **webhook_code** | **String** | `DEFAULT_UPDATE` |  |
-| **error** | [**Error**](Error.md) |  | [optional] |
-| **new_transactions** | **Float** | The number of new transactions detected since the last time this webhook was fired. |  |
-| **item_id** | **String** | The `item_id` of the Item the webhook relates to. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::DefaultUpdateWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  error: null,
-  new_transactions: null,
-  item_id: null
-)
-```
-

data/docs/DepositSwitchAddressData.md

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

data/docs/DepositSwitchAltCreateRequest.md

@@ -1,24 +0,0 @@
-# Plaid::DepositSwitchAltCreateRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **target_account** | [**DepositSwitchTargetAccount**](DepositSwitchTargetAccount.md) |  |  |
-| **target_user** | [**DepositSwitchTargetUser**](DepositSwitchTargetUser.md) |  |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::DepositSwitchAltCreateRequest.new(
-  client_id: null,
-  secret: null,
-  target_account: null,
-  target_user: null
-)
-```
-

data/docs/DepositSwitchAltCreateResponse.md

@@ -1,20 +0,0 @@
-# Plaid::DepositSwitchAltCreateResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **deposit_switch_id** | **String** | ID of the deposit switch. This ID is persisted throughout the lifetime of the deposit switch. |  |
-| **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::DepositSwitchAltCreateResponse.new(
-  deposit_switch_id: null,
-  request_id: null
-)
-```
-

data/docs/DepositSwitchCreateRequest.md

@@ -1,24 +0,0 @@
-# Plaid::DepositSwitchCreateRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. | [optional] |
-| **target_access_token** | **String** | Access token for the target Item, typically provided in the Import Item response.  |  |
-| **target_account_id** | **String** | Plaid Account ID that specifies the target bank account. This account will become the recipient for a user's direct deposit. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::DepositSwitchCreateRequest.new(
-  client_id: null,
-  secret: null,
-  target_access_token: null,
-  target_account_id: null
-)
-```
-

data/docs/DepositSwitchCreateResponse.md

@@ -1,20 +0,0 @@
-# Plaid::DepositSwitchCreateResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **deposit_switch_id** | **String** | ID of the deposit switch. This ID is persisted throughout the lifetime of the deposit switch. |  |
-| **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::DepositSwitchCreateResponse.new(
-  deposit_switch_id: null,
-  request_id: null
-)
-```
-