plaid 13.2.0 → 14.0.0.beta.1

data/docs/HistoricalUpdateWebhook.md

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

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

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

@@ -0,0 +1,24 @@
+# Plaid::IdentityGetRequest
+
+## 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. |  |
+| **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

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

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

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

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

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

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

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

@@ -0,0 +1,22 @@
+# Plaid::IncomeVerificationCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [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

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

@@ -0,0 +1,22 @@
+# Plaid::IncomeVerificationDocumentsDownloadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [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

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

data/docs/IncomeVerificationPaystubGetRequest.md

@@ -0,0 +1,22 @@
+# Plaid::IncomeVerificationPaystubGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [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

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

data/docs/IncomeVerificationStatusWebhook.md

@@ -0,0 +1,24 @@
+# Plaid::IncomeVerificationStatusWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_type** | **String** | `\"INCOME\"` |  |
+| **webhook_code** | **String** | `income_verification` |  |
+| **income_verification_id** | **String** | The `income_verification_id` of the verification instance whose status is being reported. |  |
+| **verification_status** | **String** | `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed.  `VERIFICATION_STATUS_UPLOAD_ERROR`: An upload error occurred when the end user attempted to upload their verification documentation.  `VERIFICATION_STATUS_INVALID_TYPE`: The end user attempted to upload verification documentation in an unsupported file format.  `VERIFICATION_STATUS_DOCUMENT_REJECTED`: The documentation uploaded by the end user was recognized as a supported file format, but not recognized as a valid paystub.  `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::IncomeVerificationStatusWebhook.new(
+  webhook_type: null,
+  webhook_code: null,
+  income_verification_id: null,
+  verification_status: null
+)
+```
+