plaid 13.0.0 → 14.0.0.beta.4

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
+)
+```
+

data/docs/IncomeVerificationSummaryGetRequest.md

@@ -0,0 +1,22 @@
+# Plaid::IncomeVerificationSummaryGetRequest
+
+## 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::IncomeVerificationSummaryGetRequest.new(
+  client_id: null,
+  secret: null,
+  income_verification_id: null
+)
+```
+

data/docs/IncomeVerificationSummaryGetResponse.md

@@ -0,0 +1,20 @@
+# Plaid::IncomeVerificationSummaryGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **income_summaries** | [**Array<IncomeSummary>**](IncomeSummary.md) | A list of income summaries. |  |
+| **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::IncomeVerificationSummaryGetResponse.new(
+  income_summaries: null,
+  request_id: null
+)
+```
+

data/docs/IncomeVerificationWebhookStatus.md

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

data/docs/InflowModel.md

@@ -0,0 +1,26 @@
+# Plaid::InflowModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Inflow model. One of the following:  `none`: No income `monthly-income`: Income occurs once per month `monthly-balance-payment`: Pays off the balance on a liability account at the given statement day of month `monthly-interest-only-payment`: Makes an interest-only payment on a liability account at the given statement day of month. Note that account types supported by Liabilities will accrue interest in the Sandbox. The types are account type `credit` with subtype `credit` or `paypal`, and account type `loan` with subtype `student` or `mortgage`. |  |
+| **income_amount** | **Float** | Amount of income per month. This value is required if `type` is `monthly-income`. |  |
+| **payment_day_of_month** | **Float** | Number between 1 and 28, or `last` meaning the last day of the month. The day of the month on which the income transaction will appear. The name of the income transaction. This field is required if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`. |  |
+| **transaction_name** | **String** | The name of the income transaction. This field is required if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`. |  |
+| **statement_day_of_month** | **String** | Number between 1 and 28, or `last` meaning the last day of the month. The day of the month on which the balance is calculated for the next payment. The name of the income transaction. This field is required if `type` is `monthly-balance-payment` or `monthly-interest-only-payment`. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InflowModel.new(
+  type: null,
+  income_amount: null,
+  payment_day_of_month: null,
+  transaction_name: null,
+  statement_day_of_month: null
+)
+```
+

data/docs/InitialUpdateWebhook.md

@@ -0,0 +1,26 @@
+# Plaid::InitialUpdateWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_type** | **String** | `TRANSACTIONS` |  |
+| **webhook_code** | **String** | `INITIAL_UPDATE` |  |
+| **error** | **String** | The error code associated with the webhook. | [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::InitialUpdateWebhook.new(
+  webhook_type: null,
+  webhook_code: null,
+  error: null,
+  new_transactions: null,
+  item_id: null
+)
+```
+

data/docs/Institution.md

@@ -0,0 +1,36 @@
+# Plaid::Institution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **institution_id** | **String** | Unique identifier for the institution |  |
+| **name** | **String** | The official name of the institution |  |
+| **products** | [**Array<Products>**](Products.md) | A list of the Plaid products supported by the institution |  |
+| **country_codes** | [**Array<CountryCode>**](CountryCode.md) | A list of the country codes supported by the institution. |  |
+| **url** | **String** | The URL for the institution's website | [optional] |
+| **primary_color** | **String** | Hexadecimal representation of the primary color used by the institution | [optional] |
+| **logo** | **String** | Base64 encoded representation of the institution's logo | [optional] |
+| **routing_numbers** | **Array<String>** | A partial list of routing numbers associated with the institution. This list is provided for the purpose of looking up institutions by routing number. It is not comprehensive and should never be used as a complete list of routing numbers for an institution. | [optional] |
+| **oauth** | **Boolean** | Indicates that the institution has an OAuth login flow. This is primarily relevant to institutions with European country codes. |  |
+| **status** | [**InstitutionStatus**](InstitutionStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::Institution.new(
+  institution_id: null,
+  name: null,
+  products: null,
+  country_codes: null,
+  url: null,
+  primary_color: null,
+  logo: null,
+  routing_numbers: null,
+  oauth: null,
+  status: null
+)
+```
+

data/docs/InstitutionStatus.md

@@ -0,0 +1,30 @@
+# Plaid::InstitutionStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_logins** | [**ProductStatus**](ProductStatus.md) |  |  |
+| **transactions_updates** | [**ProductStatus**](ProductStatus.md) |  |  |
+| **auth** | [**ProductStatus**](ProductStatus.md) |  |  |
+| **balance** | [**ProductStatus**](ProductStatus.md) |  |  |
+| **identity** | [**ProductStatus**](ProductStatus.md) |  |  |
+| **investments_updates** | [**ProductStatus**](ProductStatus.md) |  |  |
+| **health_incidents** | [**Array<HealthIncident>**](HealthIncident.md) | Details of recent health incidents associated with the institution. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InstitutionStatus.new(
+  item_logins: null,
+  transactions_updates: null,
+  auth: null,
+  balance: null,
+  identity: null,
+  investments_updates: null,
+  health_incidents: null
+)
+```
+

data/docs/InstitutionsGetByIdRequest.md

@@ -0,0 +1,26 @@
+# Plaid::InstitutionsGetByIdRequest
+
+## 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] |
+| **institution_id** | **String** | The ID of the institution to get details about |  |
+| **country_codes** | [**Array<CountryCode>**](CountryCode.md) | Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.  |  |
+| **options** | [**InstitutionsGetByIdRequestOptions**](InstitutionsGetByIdRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InstitutionsGetByIdRequest.new(
+  client_id: null,
+  secret: null,
+  institution_id: null,
+  country_codes: null,
+  options: null
+)
+```
+

data/docs/InstitutionsGetByIdRequestOptions.md

@@ -0,0 +1,20 @@
+# Plaid::InstitutionsGetByIdRequestOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include_optional_metadata** | **Boolean** | When `true`, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is `false`.  Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos. | [optional][default to false] |
+| **include_status** | **Boolean** | If `true`, the response will include status information about the institution. Default value is `false`. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InstitutionsGetByIdRequestOptions.new(
+  include_optional_metadata: null,
+  include_status: null
+)
+```
+

data/docs/InstitutionsGetByIdResponse.md

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

data/docs/InstitutionsGetRequest.md

@@ -0,0 +1,28 @@
+# Plaid::InstitutionsGetRequest
+
+## 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] |
+| **count** | **Integer** | The total number of Institutions to return. |  |
+| **offset** | **Integer** | The number of Institutions to skip. |  |
+| **country_codes** | [**Array<CountryCode>**](CountryCode.md) | Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.  |  |
+| **options** | [**InstitutionsGetRequestOptions**](InstitutionsGetRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InstitutionsGetRequest.new(
+  client_id: null,
+  secret: null,
+  count: null,
+  offset: null,
+  country_codes: null,
+  options: null
+)
+```
+

data/docs/InstitutionsGetRequestOptions.md

@@ -0,0 +1,24 @@
+# Plaid::InstitutionsGetRequestOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **products** | [**Array<Products>**](Products.md) | Filter the Institutions based on which products they support.  | [optional] |
+| **routing_numbers** | **Array<String>** | Specify an array of routing numbers to filter institutions. The response will only return institutions that match all of the routing numbers in the array. | [optional] |
+| **oauth** | **Boolean** | Limit results to institutions with or without OAuth login flows. This is primarily relevant to institutions with European country codes. | [optional] |
+| **include_optional_metadata** | **Boolean** | When `true`, return the institution's homepage URL, logo and primary brand color.  Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InstitutionsGetRequestOptions.new(
+  products: null,
+  routing_numbers: null,
+  oauth: null,
+  include_optional_metadata: null
+)
+```
+

data/docs/InstitutionsGetResponse.md

@@ -0,0 +1,22 @@
+# Plaid::InstitutionsGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **institutions** | [**Array<Institution>**](Institution.md) | A list of Plaid Institution |  |
+| **total** | **Integer** | The total number of institutions available via this endpoint |  |
+| **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::InstitutionsGetResponse.new(
+  institutions: null,
+  total: null,
+  request_id: null
+)
+```
+

data/docs/InstitutionsSearchAccountFilter.md

@@ -0,0 +1,24 @@
+# Plaid::InstitutionsSearchAccountFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **loan** | [**Array<AccountSubtype>**](AccountSubtype.md) |  | [optional] |
+| **depository** | [**Array<AccountSubtype>**](AccountSubtype.md) |  | [optional] |
+| **credit** | [**Array<AccountSubtype>**](AccountSubtype.md) |  | [optional] |
+| **investment** | [**Array<AccountSubtype>**](AccountSubtype.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InstitutionsSearchAccountFilter.new(
+  loan: null,
+  depository: null,
+  credit: null,
+  investment: null
+)
+```
+

data/docs/InstitutionsSearchRequest.md

@@ -0,0 +1,28 @@
+# Plaid::InstitutionsSearchRequest
+
+## 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] |
+| **query** | **String** | The search query. Institutions with names matching the query are returned |  |
+| **products** | [**Array<Products>**](Products.md) | Filter the Institutions based on whether they support all products listed in products. Provide `null` to get institutions regardless of supported products |  |
+| **country_codes** | [**Array<CountryCode>**](CountryCode.md) | Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.  |  |
+| **options** | [**InstitutionsSearchRequestOptions**](InstitutionsSearchRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::InstitutionsSearchRequest.new(
+  client_id: null,
+  secret: null,
+  query: null,
+  products: null,
+  country_codes: null,
+  options: null
+)
+```
+