plaid 10.1.0 → 14.0.0.beta.1

data/docs/DepositSwitchGetRequest.md

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

data/docs/DepositSwitchGetResponse.md

@@ -0,0 +1,38 @@
+# Plaid::DepositSwitchGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deposit_switch_id** | **String** | The ID of the deposit switch |  |
+| **target_account_id** | **String** | The ID of the bank account the direct deposit was switched to |  |
+| **target_item_id** | **String** | The ID of the Item the direct deposit was switched to. |  |
+| **state** | **String** | The state of the deposit switch. |  |
+| **account_has_multiple_allocations** | **Boolean** | When `true`, user’s direct deposit goes to multiple banks. When false, user’s direct deposit only goes to the target account. Always `null` if the deposit switch has not been completed. |  |
+| **is_allocated_remainder** | **Boolean** | When `true`, the target account is allocated the remainder of direct deposit after all other allocations have been deducted. When `false`, user’s direct deposit is allocated as a percent or amount. Always `null` if the deposit switch has not been completed. |  |
+| **percent_allocated** | **Float** | The percentage of direct deposit allocated to the target account. Always `null` if the target account is not allocated a percentage or if the deposit switch has not been completed or if `is_allocated_remainder` is true. |  |
+| **amount_allocated** | **Float** | The dollar amount of direct deposit allocated to the target account. Always `null` if the target account is not allocated an amount or if the deposit switch has not been completed. |  |
+| **date_created** | **Date** | ISO8601 date the deposit switch was created. |  |
+| **date_completed** | **Date** | ISO8601 date the deposit switch was completed. Always `null` if the deposit switch has not been completed. |  |
+| **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::DepositSwitchGetResponse.new(
+  deposit_switch_id: null,
+  target_account_id: null,
+  target_item_id: null,
+  state: null,
+  account_has_multiple_allocations: null,
+  is_allocated_remainder: null,
+  percent_allocated: null,
+  amount_allocated: null,
+  date_created: null,
+  date_completed: null,
+  request_id: null
+)
+```
+

data/docs/DepositSwitchTargetAccount.md

@@ -0,0 +1,24 @@
+# Plaid::DepositSwitchTargetAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_number** | **String** | Account number for deposit switch destination |  |
+| **routing_number** | **String** | Routing number for deposit switch destination |  |
+| **account_name** | **String** | The name of the deposit switch destination account, as it will be displayed to the end user in the Deposit Switch interface. It is not required to match the name used in online banking. |  |
+| **account_subtype** | **String** | The account subtype of the account, either `checking` or `savings`. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::DepositSwitchTargetAccount.new(
+  account_number: null,
+  routing_number: null,
+  account_name: null,
+  account_subtype: null
+)
+```
+

data/docs/DepositSwitchTargetUser.md

@@ -0,0 +1,28 @@
+# Plaid::DepositSwitchTargetUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **given_name** | **String** | The given name (first name) of the user. |  |
+| **family_name** | **String** | The family name (last name) of the user. |  |
+| **phone** | **String** | The phone number of the user. The endpoint can accept a variety of phone number formats, including E.164. |  |
+| **email** | **String** | The email address of the user. |  |
+| **address** | [**DepositSwitchAddressData**](DepositSwitchAddressData.md) |  | [optional] |
+| **tax_payer_id** | **String** | The taxpayer ID of the user, generally their SSN, EIN, or TIN. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::DepositSwitchTargetUser.new(
+  given_name: null,
+  family_name: null,
+  phone: null,
+  email: null,
+  address: null,
+  tax_payer_id: null
+)
+```
+

data/docs/DepositSwitchTokenCreateRequest.md

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

data/docs/DepositSwitchTokenCreateResponse.md

@@ -0,0 +1,22 @@
+# Plaid::DepositSwitchTokenCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deposit_switch_token** | **String** | Deposit switch token, used to initialize Link for the Deposit Switch product |  |
+| **deposit_switch_token_expiration_time** | **String** | Expiration time of the token, in ISO8601 format |  |
+| **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::DepositSwitchTokenCreateResponse.new(
+  deposit_switch_token: null,
+  deposit_switch_token_expiration_time: null,
+  request_id: null
+)
+```
+

data/docs/DepositoryFilter.md

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

data/docs/Email.md

@@ -0,0 +1,22 @@
+# Plaid::Email
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **String** | The email address. |  |
+| **primary** | **Boolean** | When `true`, identifies the email address as the primary email on an account. |  |
+| **type** | **String** | The type of email account as described by the financial institution. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::Email.new(
+  data: null,
+  primary: null,
+  type: null
+)
+```
+

data/docs/Employee.md

@@ -0,0 +1,22 @@
+# Plaid::Employee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the employee. | [optional] |
+| **address** | [**NullableAddressData**](NullableAddressData.md) |  | [optional] |
+| **ssn_masked** | **String** | The SSN of the employee, with all but the last 4 digits masked out. For example: \"XXX-XX-1111\". | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::Employee.new(
+  name: null,
+  address: null,
+  ssn_masked: null
+)
+```
+

data/docs/EmployeeIncomeSummaryFieldString.md

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

data/docs/Employer.md

@@ -0,0 +1,24 @@
+# Plaid::Employer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **employer_id** | **String** | Plaid's unique identifier for the employer. |  |
+| **name** | **String** | The name of the employer |  |
+| **address** | [**NullableAddressData**](NullableAddressData.md) |  | [optional] |
+| **confidence_score** | **Float** | A number from 0 to 1 indicating Plaid's level of confidence in the pairing between the employer and the institution (not yet implemented). | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::Employer.new(
+  employer_id: null,
+  name: null,
+  address: null,
+  confidence_score: null
+)
+```
+

data/docs/EmployerIncomeSummaryFieldString.md

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

data/docs/EmployersSearchRequest.md

@@ -0,0 +1,24 @@
+# Plaid::EmployersSearchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **query** | **String** | The employer name to be searched for. |  |
+| **products** | **Array<String>** | The Plaid products the returned employers should support. Currently, this field must be set to `\"deposit_switch\"`. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::EmployersSearchRequest.new(
+  client_id: null,
+  secret: null,
+  query: null,
+  products: null
+)
+```
+

data/docs/EmployersSearchResponse.md

@@ -0,0 +1,20 @@
+# Plaid::EmployersSearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **employers** | [**Array<Employer>**](Employer.md) | A list of employers matching the search criteria. |  |
+| **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::EmployersSearchResponse.new(
+  employers: null,
+  request_id: null
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,34 @@
+# Plaid::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_type** | **String** | A broad categorization of the error. Safe for programatic use. |  |
+| **error_code** | **String** | The particular error code. Safe for programmatic use. |  |
+| **error_message** | **String** | A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use. |  |
+| **display_message** | **String** | A user-friendly representation of the error code. `null` if the error is not related to user action.  This may change over time and is not safe for programmatic use. | [optional] |
+| **request_id** | **String** | A unique identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks. |  |
+| **causes** | [**Array<AnyType>**](AnyType.md) | In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.  `causes` will only be provided for the `error_type` `ASSET_REPORT_ERROR`. | [optional] |
+| **status** | **Float** | The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook. | [optional] |
+| **documentation_url** | **String** | The URL of a Plaid documentation page with more information about the error | [optional] |
+| **suggested_action** | **String** | Suggested steps for resolving the error | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::Error.new(
+  error_type: null,
+  error_code: null,
+  error_message: null,
+  display_message: null,
+  request_id: null,
+  causes: null,
+  status: null,
+  documentation_url: null,
+  suggested_action: null
+)
+```
+

data/docs/ExternalPaymentSchedule.md

@@ -0,0 +1,24 @@
+# Plaid::ExternalPaymentSchedule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval** | **String** | The frequency interval of the payment. Valid values are `\"WEEKLY\"` or `\"MONTHLY\"`. |  |
+| **interval_execution_day** | **Float** | The day of the interval on which to schedule the payment.  If the payment interval is weekly, `interval_execution_day` should be an integer from 1 (Monday) to 7 (Sunday).  If the payment interval is monthly, `interval_execution_day` should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on. |  |
+| **start_date** | **String** | A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`.  If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so. |  |
+| **end_date** | **String** | A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`.  If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::ExternalPaymentSchedule.new(
+  interval: null,
+  interval_execution_day: null,
+  start_date: null,
+  end_date: null
+)
+```
+

data/docs/HealthIncident.md

@@ -0,0 +1,24 @@
+# Plaid::HealthIncident
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **String** | The start date of the incident, in ISO 8601 format, e.g. `\"2020-10-30T15:26:48Z\"`. | [optional] |
+| **end_date** | **String** | The end date of the incident, in ISO 8601 format, e.g. `\"2020-10-30T15:26:48Z\"`. | [optional] |
+| **title** | **String** | The title of the incident | [optional] |
+| **incident_updates** | [**Array<IncidentUpdate>**](IncidentUpdate.md) | Updates on the health incident. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::HealthIncident.new(
+  start_date: null,
+  end_date: null,
+  title: null,
+  incident_updates: null
+)
+```
+

data/docs/HistoricalBalance.md

@@ -0,0 +1,24 @@
+# Plaid::HistoricalBalance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **String** | The date of the calculated historical balance, in an ISO 8601 format (YYYY-MM-DD) |  |
+| **current** | **Float** | The total amount of funds in the account, calculated from the `current` balance in the `balance` object by subtracting inflows and adding back outflows according to the posted date of each transaction.  If the account has any pending transactions, historical balance amounts on or after the date of the earliest pending transaction may differ if retrieved in subsequent Asset Reports as a result of those pending transactions posting. |  |
+| **iso_currency_code** | **String** | The ISO-4217 currency code of the balance. Always `null` if `unofficial_currency_code` is non-`null`. | [optional] |
+| **unofficial_currency_code** | **String** | The unofficial currency code associated with the balance. Always `null` if `iso_currency_code` is non-`null`.  See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::HistoricalBalance.new(
+  date: null,
+  current: null,
+  iso_currency_code: null,
+  unofficial_currency_code: null
+)
+```
+