plaid 14.0.0.beta.4 → 14.0.0.beta.5

data/docs/HistoricalBalance.md

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

data/docs/HistoricalUpdateWebhook.md

@@ -1,26 +0,0 @@
-# Plaid::HistoricalUpdateWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `TRANSACTIONS` |  |
-| **webhook_code** | **String** | `HISTORICAL_UPDATE` |  |
-| **error** | [**Error**](Error.md) |  | [optional] |
-| **new_transactions** | **Float** | The number of new, unfetched transactions available |  |
-| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::HistoricalUpdateWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  error: null,
-  new_transactions: null,
-  item_id: null
-)
-```
-

data/docs/Holding.md

@@ -1,34 +0,0 @@
-# Plaid::Holding
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | The Plaid `account_id` associated with the holding. |  |
-| **security_id** | **String** | The Plaid `security_id` associated with the holding. |  |
-| **institution_price** | **Float** | The last price given by the institution for this security. |  |
-| **institution_price_as_of** | **String** | The date at which `institution_price` was current. | [optional] |
-| **institution_value** | **Float** | The value of the holding, as reported by the institution. |  |
-| **cost_basis** | **Float** | The cost basis of the holding. | [optional] |
-| **quantity** | **Float** | The total quantity of the asset held, as reported by the financial institution. |  |
-| **iso_currency_code** | **String** | The ISO-4217 currency code of the holding. Always `null` if `unofficial_currency_code` is non-`null`. | [optional] |
-| **unofficial_currency_code** | **String** | The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.  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::Holding.new(
-  account_id: null,
-  security_id: null,
-  institution_price: null,
-  institution_price_as_of: null,
-  institution_value: null,
-  cost_basis: null,
-  quantity: null,
-  iso_currency_code: null,
-  unofficial_currency_code: null
-)
-```
-

data/docs/HoldingsDefaultUpdateWebhook.md

@@ -1,28 +0,0 @@
-# Plaid::HoldingsDefaultUpdateWebhook
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **webhook_type** | **String** | `HOLDINGS` |  |
-| **webhook_code** | **String** | `DEFAULT_UPDATE` |  |
-| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error |  |
-| **error** | [**Error**](Error.md) |  | [optional] |
-| **new_holdings** | **Float** | The number of new holdings reported since the last time this webhook was fired. |  |
-| **updated_holdings** | **Float** | The number of updated holdings reported since the last time this webhook was fired. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::HoldingsDefaultUpdateWebhook.new(
-  webhook_type: null,
-  webhook_code: null,
-  item_id: null,
-  error: null,
-  new_holdings: null,
-  updated_holdings: null
-)
-```
-

data/docs/IdentityGetRequest.md

@@ -1,24 +0,0 @@
-# Plaid::IdentityGetRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. | [optional] |
-| **access_token** | **String** | The access token associated with the Item data is being requested for. |  |
-| **options** | [**IdentityGetRequestOptions**](IdentityGetRequestOptions.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::IdentityGetRequest.new(
-  client_id: null,
-  secret: null,
-  access_token: null,
-  options: null
-)
-```
-

data/docs/IdentityGetRequestOptions.md

@@ -1,18 +0,0 @@
-# Plaid::IdentityGetRequestOptions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_ids** | **Array<String>** | A list of `account_ids` to retrieve for the Item. Note: An error will be returned if a provided `account_id` is not associated with the Item. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::IdentityGetRequestOptions.new(
-  account_ids: null
-)
-```
-

data/docs/IdentityGetResponse.md

@@ -1,22 +0,0 @@
-# Plaid::IdentityGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **accounts** | [**Array<AccountIdentity>**](AccountIdentity.md) | The accounts for which Identity data has been requested |  |
-| **item** | [**Item**](Item.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::IdentityGetResponse.new(
-  accounts: null,
-  item: null,
-  request_id: null
-)
-```
-

data/docs/IncidentUpdate.md

@@ -1,22 +0,0 @@
-# Plaid::IncidentUpdate
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **description** | **String** | The content of the update. | [optional] |
-| **status** | **String** | The status of the incident. | [optional] |
-| **updated_date** | **String** | The date when the update was published, in ISO 8601 format, e.g. `\"2020-10-30T15:26:48Z\"`. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::IncidentUpdate.new(
-  description: null,
-  status: null,
-  updated_date: null
-)
-```
-

data/docs/IncomeBreakdown.md

@@ -1,24 +0,0 @@
-# Plaid::IncomeBreakdown
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | The type of income. Possible values include `\"regular\"`, `\"overtime\"`, and `\"bonus\"`. | [optional] |
-| **rate** | **Float** | The hourly rate at which the income is paid. | [optional] |
-| **hours** | **Float** | The number of hours logged for this income for this pay period. | [optional] |
-| **total** | **Float** | The total pay for this pay period. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::IncomeBreakdown.new(
-  type: null,
-  rate: null,
-  hours: null,
-  total: null
-)
-```
-

data/docs/IncomeSummary.md

@@ -1,30 +0,0 @@
-# Plaid::IncomeSummary
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **employer_name** | [**EmployerIncomeSummaryFieldString**](EmployerIncomeSummaryFieldString.md) |  | [optional] |
-| **employee_name** | [**EmployeeIncomeSummaryFieldString**](EmployeeIncomeSummaryFieldString.md) |  | [optional] |
-| **ytd_gross_income** | [**YTDGrossIncomeSummaryFieldNumber**](YTDGrossIncomeSummaryFieldNumber.md) |  | [optional] |
-| **ytd_net_income** | [**YTDNetIncomeSummaryFieldNumber**](YTDNetIncomeSummaryFieldNumber.md) |  | [optional] |
-| **pay_frequency** | [**PayFrequency**](PayFrequency.md) |  | [optional] |
-| **projected_wage** | [**ProjectedIncomeSummaryFieldNumber**](ProjectedIncomeSummaryFieldNumber.md) |  | [optional] |
-| **verified_transaction** | [**TransactionData**](TransactionData.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::IncomeSummary.new(
-  employer_name: null,
-  employee_name: null,
-  ytd_gross_income: null,
-  ytd_net_income: null,
-  pay_frequency: null,
-  projected_wage: null,
-  verified_transaction: null
-)
-```
-

data/docs/IncomeSummaryFieldNumber.md

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

data/docs/IncomeSummaryFieldString.md

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

data/docs/IncomeVerificationCreateRequest.md

@@ -1,22 +0,0 @@
-# Plaid::IncomeVerificationCreateRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. | [optional] |
-| **webhook** | **String** | The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::IncomeVerificationCreateRequest.new(
-  client_id: null,
-  secret: null,
-  webhook: null
-)
-```
-

data/docs/IncomeVerificationCreateResponse.md

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

data/docs/IncomeVerificationDocumentsDownloadRequest.md

@@ -1,22 +0,0 @@
-# Plaid::IncomeVerificationDocumentsDownloadRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. | [optional] |
-| **income_verification_id** | **String** | The ID of the verification. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::IncomeVerificationDocumentsDownloadRequest.new(
-  client_id: null,
-  secret: null,
-  income_verification_id: null
-)
-```
-

data/docs/IncomeVerificationDocumentsDownloadResponse.md

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

data/docs/IncomeVerificationPaystubGetRequest.md

@@ -1,22 +0,0 @@
-# Plaid::IncomeVerificationPaystubGetRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_id** | **String** | Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. | [optional] |
-| **secret** | **String** | Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. | [optional] |
-| **income_verification_id** | **String** | The ID of the verification for which to get paystub information. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::IncomeVerificationPaystubGetRequest.new(
-  client_id: null,
-  secret: null,
-  income_verification_id: null
-)
-```
-

data/docs/IncomeVerificationPaystubGetResponse.md

@@ -1,20 +0,0 @@
-# Plaid::IncomeVerificationPaystubGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **paystub** | [**Paystub**](Paystub.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. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::IncomeVerificationPaystubGetResponse.new(
-  paystub: null,
-  request_id: null
-)
-```
-