plaid 13.2.0 → 14.0.0.beta.1

data/docs/BankTransferBalance.md

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,22 @@
+# 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
+)
+```
+

data/docs/BankTransferBalanceGetResponse.md

@@ -0,0 +1,22 @@
+# Plaid::BankTransferBalanceGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balance** | [**BankTransferBalance**](BankTransferBalance.md) |  |  |
+| **origination_account_id** | **String** | The ID of the origination account that this balance belongs to. | [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. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::BankTransferBalanceGetResponse.new(
+  balance: null,
+  origination_account_id: null,
+  request_id: null
+)
+```
+

data/docs/BankTransferCancelRequest.md

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

data/docs/BankTransferCancelResponse.md

@@ -0,0 +1,18 @@
+# Plaid::BankTransferCancelResponse
+
+## 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::BankTransferCancelResponse.new(
+  request_id: null
+)
+```
+

data/docs/BankTransferCreateRequest.md

@@ -0,0 +1,46 @@
+# Plaid::BankTransferCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **idempotency_key** | **String** | A random key provided by the client, per unique bank transfer. Maximum of 50 characters.  The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created. |  |
+| **access_token** | **String** | The Plaid `access_token` for the account that will be debited or credited. |  |
+| **account_id** | **String** | The Plaid `account_id` for the account that will be debited or credited. |  |
+| **type** | [**BankTransferType**](BankTransferType.md) |  |  |
+| **network** | [**BankTransferNetwork**](BankTransferNetwork.md) |  |  |
+| **amount** | **String** | The transfer amount (decimal string with two digits of precision e.g. \"10.00\"). |  |
+| **iso_currency_code** | **String** | The currency of the transfer amount – should be set to \"USD\". |  |
+| **description** | **String** | The transfer description. Maximum of 10 characters. |  |
+| **ach_class** | [**ACHClass**](ACHClass.md) |  | [optional] |
+| **user** | [**BankTransferUser**](BankTransferUser.md) |  |  |
+| **custom_tag** | **String** | An arbitrary string provided by the client for storage with the bank transfer. Will be returned in all `BankTransfer` objects. May be up to 100 characters. | [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  | [optional] |
+| **origination_account_id** | **String** | Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::BankTransferCreateRequest.new(
+  client_id: null,
+  secret: null,
+  idempotency_key: null,
+  access_token: null,
+  account_id: null,
+  type: null,
+  network: null,
+  amount: null,
+  iso_currency_code: null,
+  description: null,
+  ach_class: null,
+  user: null,
+  custom_tag: null,
+  metadata: null,
+  origination_account_id: null
+)
+```
+

data/docs/BankTransferCreateResponse.md

@@ -0,0 +1,20 @@
+# Plaid::BankTransferCreateResponse
+
+## 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::BankTransferCreateResponse.new(
+  bank_transfer: null,
+  request_id: null
+)
+```
+

data/docs/BankTransferDirection.md

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

data/docs/BankTransferEvent.md

@@ -0,0 +1,40 @@
+# Plaid::BankTransferEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **Integer** | Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers. |  |
+| **timestamp** | **String** | The datetime when this event occurred. This will be of the form `2006-01-02T15:04:05Z`. |  |
+| **event_type** | [**BankTransferEventType**](BankTransferEventType.md) |  |  |
+| **account_id** | **String** | The account ID associated with the bank transfer. |  |
+| **bank_transfer_id** | **String** | Plaid’s unique identifier for a bank transfer. |  |
+| **origination_account_id** | **String** | The ID of the origination account that this balance belongs to. | [optional] |
+| **bank_transfer_type** | [**BankTransferType**](BankTransferType.md) |  |  |
+| **bank_transfer_amount** | **String** | The bank transfer amount. |  |
+| **bank_transfer_iso_currency_code** | **String** | The currency of the bank transfer amount. |  |
+| **failure_reason** | [**BankTransferFailure**](BankTransferFailure.md) |  |  |
+| **direction** | [**BankTransferDirection**](BankTransferDirection.md) |  |  |
+| **receiver_details** | [**BankTransferReceiverDetails**](BankTransferReceiverDetails.md) |  |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::BankTransferEvent.new(
+  event_id: null,
+  timestamp: null,
+  event_type: null,
+  account_id: null,
+  bank_transfer_id: null,
+  origination_account_id: null,
+  bank_transfer_type: null,
+  bank_transfer_amount: null,
+  bank_transfer_iso_currency_code: null,
+  failure_reason: null,
+  direction: null,
+  receiver_details: null
+)
+```
+

data/docs/BankTransferEventListRequest.md

@@ -0,0 +1,40 @@
+# 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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,24 @@
+# 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

@@ -0,0 +1,20 @@
+# 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

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

data/docs/BankTransferFailure.md

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,32 @@
+# 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
+)
+```
+