plaid 13.2.0 → 14.0.0.beta.1

data/docs/PaymentInitiationPaymentListRequest.md

@@ -0,0 +1,24 @@
+# Plaid::PaymentInitiationPaymentListRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **count** | **Integer** | The maximum number of payments to return. If `count` is not specified, a maximum of 10 payments will be returned, beginning with the most recent payment before the cursor (if specified). | [optional][default to 10] |
+| **cursor** | **String** | A string in RFC 3339 format (i.e. \"2019-12-06T22:35:49Z\"). Only payments created before the cursor will be returned. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationPaymentListRequest.new(
+  client_id: null,
+  secret: null,
+  count: null,
+  cursor: null
+)
+```
+

data/docs/PaymentInitiationPaymentListResponse.md

@@ -0,0 +1,22 @@
+# Plaid::PaymentInitiationPaymentListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payments** | [**Array<PaymentInitiationPaymentGetResponse>**](PaymentInitiationPaymentGetResponse.md) | An array of payments that have been created, associated with the given `client_id`. |  |
+| **next_cursor** | **String** | The value that, when used as the optional `cursor` parameter to `/payment_initiation/payment/list`, will return the next unreturned payment as its first payment. |  |
+| **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::PaymentInitiationPaymentListResponse.new(
+  payments: null,
+  next_cursor: null,
+  request_id: null
+)
+```
+

data/docs/PaymentInitiationPaymentTokenCreateRequest.md

@@ -0,0 +1,22 @@
+# Plaid::PaymentInitiationPaymentTokenCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **payment_id** | **String** | The `payment_id` returned from `/payment_initiation/payment/create`. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationPaymentTokenCreateRequest.new(
+  client_id: null,
+  secret: null,
+  payment_id: null
+)
+```
+

data/docs/PaymentInitiationPaymentTokenCreateResponse.md

@@ -0,0 +1,22 @@
+# Plaid::PaymentInitiationPaymentTokenCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_token** | **String** | A `payment_token` that can be provided to Link initialization to enter the payment initiation flow |  |
+| **payment_token_expiration_time** | **String** | The date and time at which the token will expire, in ISO 8601 format. A `payment_token` expires after 15 minutes. |  |
+| **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::PaymentInitiationPaymentTokenCreateResponse.new(
+  payment_token: null,
+  payment_token_expiration_time: null,
+  request_id: null
+)
+```
+

data/docs/PaymentInitiationRecipient.md

@@ -0,0 +1,26 @@
+# Plaid::PaymentInitiationRecipient
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipient_id** | **String** | The ID of the recipient. Like all Plaid identifiers, the `recipient_id` is case sensitive. |  |
+| **name** | **String** | The name of the recipient |  |
+| **address** | [**PaymentInitiationAddress**](PaymentInitiationAddress.md) |  |  |
+| **iban** | **String** | The International Bank Account Number (IBAN) for the recipient. | [optional] |
+| **bacs** | [**PaymentInitiationRecipientBacs**](PaymentInitiationRecipientBacs.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationRecipient.new(
+  recipient_id: null,
+  name: null,
+  address: null,
+  iban: null,
+  bacs: null
+)
+```
+

data/docs/PaymentInitiationRecipientBacs.md

@@ -0,0 +1,20 @@
+# Plaid::PaymentInitiationRecipientBacs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **String** |  |  |
+| **sort_code** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationRecipientBacs.new(
+  account: null,
+  sort_code: null
+)
+```
+

data/docs/PaymentInitiationRecipientCreateRequest.md

@@ -0,0 +1,28 @@
+# Plaid::PaymentInitiationRecipientCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **name** | **String** | The name of the recipient |  |
+| **iban** | **String** | The International Bank Account Number (IBAN) for the recipient. If BACS data is not provided, an IBAN is required. | [optional] |
+| **bacs** | [**NullableRecipientBACS**](NullableRecipientBACS.md) |  | [optional] |
+| **address** | [**PaymentInitiationAddress**](PaymentInitiationAddress.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationRecipientCreateRequest.new(
+  client_id: null,
+  secret: null,
+  name: null,
+  iban: null,
+  bacs: null,
+  address: null
+)
+```
+

data/docs/PaymentInitiationRecipientCreateResponse.md

@@ -0,0 +1,20 @@
+# Plaid::PaymentInitiationRecipientCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipient_id** | **String** | A unique ID identifying the recipient |  |
+| **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::PaymentInitiationRecipientCreateResponse.new(
+  recipient_id: null,
+  request_id: null
+)
+```
+

data/docs/PaymentInitiationRecipientGetRequest.md

@@ -0,0 +1,22 @@
+# Plaid::PaymentInitiationRecipientGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **recipient_id** | **String** | The ID of the recipient |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationRecipientGetRequest.new(
+  client_id: null,
+  secret: null,
+  recipient_id: null
+)
+```
+

data/docs/PaymentInitiationRecipientGetResponse.md

@@ -0,0 +1,28 @@
+# Plaid::PaymentInitiationRecipientGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipient_id** | **String** | The ID of the recipient. |  |
+| **name** | **String** | The name of the recipient. |  |
+| **address** | [**PaymentInitiationAddress**](PaymentInitiationAddress.md) |  | [optional] |
+| **iban** | **String** | The International Bank Account Number (IBAN) for the recipient. |  |
+| **bacs** | [**NullableRecipientBACS**](NullableRecipientBACS.md) |  | [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::PaymentInitiationRecipientGetResponse.new(
+  recipient_id: null,
+  name: null,
+  address: null,
+  iban: null,
+  bacs: null,
+  request_id: null
+)
+```
+

data/docs/PaymentInitiationRecipientListRequest.md

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

data/docs/PaymentInitiationRecipientListResponse.md

@@ -0,0 +1,20 @@
+# Plaid::PaymentInitiationRecipientListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipients** | [**Array<PaymentInitiationRecipient>**](PaymentInitiationRecipient.md) | An array of payment recipients created for Payment Initiation |  |
+| **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::PaymentInitiationRecipientListResponse.new(
+  recipients: null,
+  request_id: null
+)
+```
+

data/docs/PaymentMeta.md

@@ -0,0 +1,32 @@
+# Plaid::PaymentMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reference_number** | **String** | The transaction reference number supplied by the financial institution. | [optional] |
+| **ppd_id** | **String** | The ACH PPD ID for the payer. | [optional] |
+| **payee** | **String** | For transfers, the party that is receiving the transaction. | [optional] |
+| **by_order_of** | **String** | The party initiating a wire transfer. Will be `null` if the transaction is not a wire transfer. | [optional] |
+| **payer** | **String** | For transfers, the party that is paying the transaction. | [optional] |
+| **payment_method** | **String** | The type of transfer, e.g. 'ACH' | [optional] |
+| **payment_processor** | **String** | The name of the payment processor | [optional] |
+| **reason** | **String** | The payer-supplied description of the transfer. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentMeta.new(
+  reference_number: null,
+  ppd_id: null,
+  payee: null,
+  by_order_of: null,
+  payer: null,
+  payment_method: null,
+  payment_processor: null,
+  reason: null
+)
+```
+

data/docs/PaymentStatusUpdateWebhook.md

@@ -0,0 +1,30 @@
+# Plaid::PaymentStatusUpdateWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_type** | **String** | `PAYMENT_INITIATION` |  |
+| **webhook_code** | **String** | `PAYMENT_STATUS_UPDATE` |  |
+| **payment_id** | **String** | The `payment_id` for the payment being updated |  |
+| **new_payment_status** | **String** | The new status of the payment.  `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.  `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete.  `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete.  `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.  `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds.  `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved.  `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error.  `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown. |  |
+| **old_payment_status** | **String** | The previous status of the payment.  `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.  `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete.  `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete.  `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.  `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds.  `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved.  `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error.  `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown. |  |
+| **timestamp** | **String** | The timestamp of the update, in ISO 8601 format, e.g. `\"2017-09-14T14:42:19.350Z\"` |  |
+| **error** | [**Error**](Error.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentStatusUpdateWebhook.new(
+  webhook_type: null,
+  webhook_code: null,
+  payment_id: null,
+  new_payment_status: null,
+  old_payment_status: null,
+  timestamp: null,
+  error: null
+)
+```
+

data/docs/Paystub.md

@@ -0,0 +1,30 @@
+# Plaid::Paystub
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **paystub_id** | **String** | The unique identifier for this paystub. |  |
+| **account_id** | **String** | The account identifier for the account associated with this paystub. | [optional] |
+| **employer** | [**Employer**](Employer.md) |  |  |
+| **employee** | [**Employee**](Employee.md) |  |  |
+| **pay_period_details** | [**PayPeriodDetails**](PayPeriodDetails.md) |  |  |
+| **income_breakdown** | [**IncomeBreakdown**](IncomeBreakdown.md) |  |  |
+| **ytd_earnings** | [**PaystubYTDDetails**](PaystubYTDDetails.md) |  |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::Paystub.new(
+  paystub_id: null,
+  account_id: null,
+  employer: null,
+  employee: null,
+  pay_period_details: null,
+  income_breakdown: null,
+  ytd_earnings: null
+)
+```
+

data/docs/PaystubDeduction.md

@@ -0,0 +1,22 @@
+# Plaid::PaystubDeduction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The description of the deduction, as provided on the paystub. For example: `\"401(k)\"`, `\"FICA MED TAX\"`. | [optional] |
+| **is_pretax** | **Boolean** | `true` if the deduction is pre-tax; `false` otherwise. | [optional] |
+| **total** | **Float** | The amount of the deduction. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaystubDeduction.new(
+  type: null,
+  is_pretax: null,
+  total: null
+)
+```
+

data/docs/PaystubYTDDetails.md

@@ -0,0 +1,20 @@
+# Plaid::PaystubYTDDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gross_earnings** | **Float** | Year-to-date gross earnings. |  |
+| **net_earnings** | **Float** | Year-to-date net (take home) earnings. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaystubYTDDetails.new(
+  gross_earnings: null,
+  net_earnings: null
+)
+```
+

data/docs/PendingExpirationWebhook.md

@@ -0,0 +1,24 @@
+# Plaid::PendingExpirationWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_type** | **String** | `ITEM` |  |
+| **webhook_code** | **String** | `PENDING_EXPIRATION` |  |
+| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
+| **consent_expiration_time** | **String** | The date and time at which the Item's access consent will expire, in ISO 8601 format |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PendingExpirationWebhook.new(
+  webhook_type: null,
+  webhook_code: null,
+  item_id: null,
+  consent_expiration_time: null
+)
+```
+