plaid 13.0.0 → 14.0.0.beta.1

data/docs/ProcessorApexProcessorTokenCreateRequest.md

@@ -0,0 +1,24 @@
+# Plaid::ProcessorApexProcessorTokenCreateRequest
+
+## 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. |  |
+| **account_id** | **String** | The `account_id` value obtained from the `onSuccess` callback in Link |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProcessorApexProcessorTokenCreateRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null,
+  account_id: null
+)
+```
+

data/docs/ProcessorAuthGetRequest.md

@@ -0,0 +1,22 @@
+# Plaid::ProcessorAuthGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **processor_token** | **String** | The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>` |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProcessorAuthGetRequest.new(
+  client_id: null,
+  secret: null,
+  processor_token: null
+)
+```
+

data/docs/ProcessorAuthGetResponse.md

@@ -0,0 +1,22 @@
+# Plaid::ProcessorAuthGetResponse
+
+## 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. |  |
+| **numbers** | [**ProcessorNumber**](ProcessorNumber.md) |  |  |
+| **account** | [**AccountBase**](AccountBase.md) |  |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProcessorAuthGetResponse.new(
+  request_id: null,
+  numbers: null,
+  account: null
+)
+```
+

data/docs/ProcessorBalanceGetRequest.md

@@ -0,0 +1,22 @@
+# Plaid::ProcessorBalanceGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **processor_token** | **String** | The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>` |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProcessorBalanceGetRequest.new(
+  client_id: null,
+  secret: null,
+  processor_token: null
+)
+```
+

data/docs/ProcessorBalanceGetResponse.md

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

data/docs/ProcessorIdentityGetRequest.md

@@ -0,0 +1,22 @@
+# Plaid::ProcessorIdentityGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **processor_token** | **String** | The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>` |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProcessorIdentityGetRequest.new(
+  client_id: null,
+  secret: null,
+  processor_token: null
+)
+```
+

data/docs/ProcessorIdentityGetResponse.md

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

data/docs/ProcessorNumber.md

@@ -0,0 +1,24 @@
+# Plaid::ProcessorNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ach** | [**NullableNumbersACH**](NullableNumbersACH.md) |  | [optional] |
+| **eft** | [**NullableNumbersEFT**](NullableNumbersEFT.md) |  | [optional] |
+| **international** | [**NullableNumbersInternational**](NullableNumbersInternational.md) |  | [optional] |
+| **bacs** | [**NullableNumbersBACS**](NullableNumbersBACS.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProcessorNumber.new(
+  ach: null,
+  eft: null,
+  international: null,
+  bacs: null
+)
+```
+

data/docs/ProcessorStripeBankAccountTokenCreateRequest.md

@@ -0,0 +1,24 @@
+# Plaid::ProcessorStripeBankAccountTokenCreateRequest
+
+## 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. |  |
+| **account_id** | **String** | The `account_id` value obtained from the `onSuccess` callback in Link |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProcessorStripeBankAccountTokenCreateRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null,
+  account_id: null
+)
+```
+

data/docs/ProcessorStripeBankAccountTokenCreateResponse.md

@@ -0,0 +1,20 @@
+# Plaid::ProcessorStripeBankAccountTokenCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **stripe_bank_account_token** | **String** | A token that can be sent to Stripe for use in making API calls to 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::ProcessorStripeBankAccountTokenCreateResponse.new(
+  stripe_bank_account_token: null,
+  request_id: null
+)
+```
+

data/docs/ProcessorTokenCreateRequest.md

@@ -0,0 +1,26 @@
+# Plaid::ProcessorTokenCreateRequest
+
+## 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. |  |
+| **account_id** | **String** | The `account_id` value obtained from the `onSuccess` callback in Link |  |
+| **processor** | **String** | The processor you are integrating with. Valid values are `\"achq\"`, `\"checkbook\"`, `\"circle\"`, `\"drivewealth\"`, `\"dwolla\"`, `\"galileo\"`, \"`interactive_brokers`\", `\"modern_treasury\"`, `\"ocrolus\"`, `\"prime_trust\"`, `\"velox\"`, `\"vesta\"`, `\"vopay\"` |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProcessorTokenCreateRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null,
+  account_id: null,
+  processor: null
+)
+```
+

data/docs/ProcessorTokenCreateResponse.md

@@ -0,0 +1,20 @@
+# Plaid::ProcessorTokenCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **processor_token** | **String** | The `processor_token` that can then be used by the Plaid partner to make API requests |  |
+| **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::ProcessorTokenCreateResponse.new(
+  processor_token: null,
+  request_id: null
+)
+```
+

data/docs/ProductStatus.md

@@ -0,0 +1,22 @@
+# Plaid::ProductStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | `HEALTHY`: the majority of requests are successful `DEGRADED`: only some requests are successful `DOWN`: all requests are failing |  |
+| **last_status_change** | **String** | ISO 8601 formatted timestamp of the last status change for the institution. |  |
+| **breakdown** | [**ProductStatusBreakdown**](ProductStatusBreakdown.md) |  |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProductStatus.new(
+  status: null,
+  last_status_change: null,
+  breakdown: null
+)
+```
+

data/docs/ProductStatusBreakdown.md

@@ -0,0 +1,24 @@
+# Plaid::ProductStatusBreakdown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Float** | The percentage of login attempts that are successful, expressed as a decimal. |  |
+| **error_plaid** | **Float** | The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.  |  |
+| **error_institution** | **Float** | The percentage of logins that are failing due to an issue in the institution's system, expressed as a decimal. |  |
+| **refresh_interval** | **String** | The `refresh_interval` may be `DELAYED` or `STOPPED` even when the success rate is high. This value is only returned for Transactions status breakdowns. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProductStatusBreakdown.new(
+  success: null,
+  error_plaid: null,
+  error_institution: null,
+  refresh_interval: null
+)
+```
+

data/docs/Products.md

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

data/docs/ProjectedIncomeSummaryFieldNumber.md

@@ -0,0 +1,20 @@
+# Plaid::ProjectedIncomeSummaryFieldNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Float** | The value of the field. |  |
+| **verification_status** | [**VerificationStatus**](VerificationStatus.md) |  |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ProjectedIncomeSummaryFieldNumber.new(
+  value: null,
+  verification_status: null
+)
+```
+

data/docs/RecaptchaRequiredError.md

@@ -0,0 +1,30 @@
+# Plaid::RecaptchaRequiredError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_type** | **String** | RECAPTCHA_ERROR |  |
+| **error_code** | **String** | RECAPTCHA_REQUIRED |  |
+| **display_message** | **String** |  |  |
+| **http_code** | **String** | 400 |  |
+| **link_user_experience** | **String** | Your user will be prompted to solve a Google reCAPTCHA challenge in the Link Recaptcha pane. If they solve the challenge successfully, the user's request is resubmitted and they are directed to the next Item creation step. |  |
+| **common_causes** | **String** | Plaid's fraud system detects abusive traffic and considers a variety of parameters throughout Item creation requests. When a request is considered risky or possibly fraudulent, Link presents a reCAPTCHA for the user to solve. |  |
+| **troubleshooting_steps** | **String** | Link will automatically guide your user through reCAPTCHA verification. As a general rule, we recommend instrumenting basic fraud monitoring to detect and protect your website from spam and abuse.  If your user cannot verify their session, please submit a Support ticket with the following identifiers: `link_session_id` or `request_id` |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::RecaptchaRequiredError.new(
+  error_type: null,
+  error_code: null,
+  display_message: null,
+  http_code: null,
+  link_user_experience: null,
+  common_causes: null,
+  troubleshooting_steps: null
+)
+```
+

data/docs/RecipientBACS.md

@@ -0,0 +1,20 @@
+# Plaid::RecipientBACS
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **String** | The account number of the account. Maximum of 10 characters. | [optional] |
+| **sort_code** | **String** | The 6-character sort code of the account. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::RecipientBACS.new(
+  account: null,
+  sort_code: null
+)
+```
+

data/docs/SandboxBankTransferSimulateRequest.md

@@ -0,0 +1,26 @@
+# Plaid::SandboxBankTransferSimulateRequest
+
+## 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. |  |
+| **event_type** | **String** | The asynchronous event to be simulated. May be: `posted`, `failed`, or `reversed`.  An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include:  `pending` --> `failed`  `pending` --> `posted`  `posted` --> `reversed`  |  |
+| **failure_reason** | [**BankTransferFailure**](BankTransferFailure.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::SandboxBankTransferSimulateRequest.new(
+  client_id: null,
+  secret: null,
+  bank_transfer_id: null,
+  event_type: null,
+  failure_reason: null
+)
+```
+