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

data/docs/LiabilityOverride.md

@@ -1,66 +0,0 @@
-# Plaid::LiabilityOverride
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | The type of the liability object, either `credit` or `student`. Mortgages are not currently supported in the custom Sandbox. |  |
-| **purchase_apr** | **Float** | The purchase APR percentage value. For simplicity, this is the only interest rate used to calculate interest charges. Can only be set if `type` is `credit`. |  |
-| **cash_apr** | **Float** | The cash APR percentage value. Can only be set if `type` is `credit`. |  |
-| **balance_transfer_apr** | **Float** | The balance transfer APR percentage value. Can only be set if `type` is `credit`. Can only be set if `type` is `credit`. |  |
-| **special_apr** | **Float** | The special APR percentage value. Can only be set if `type` is `credit`. |  |
-| **last_payment_amount** | **Float** | Override the `last_payment_amount` field. Can only be set if `type` is `credit`. |  |
-| **last_statement_balance** | **Float** | Override the `last_statement_balance` field. Can only be set if `type` is `credit`. |  |
-| **minimum_payment_amount** | **Float** | Override the `minimum_payment_amount` field. Can only be set if `type` is `credit`. |  |
-| **is_overdue** | **Boolean** | Override the `is_overdue` field |  |
-| **origination_date** | **String** | The date on which the loan was initially lent, in ISO 8601 (YYYY-MM-DD) format. Can only be set if `type` is `student`. |  |
-| **principal** | **Float** | The original loan principal. Can only be set if `type` is `student`. |  |
-| **nominal_apr** | **Float** | The interest rate on the loan as a percentage. Can only be set if `type` is `student`. |  |
-| **interest_capitalization_grace_period_months** | **Float** | If set, interest capitalization begins at the given number of months after loan origination. By default interest is never capitalized. Can only be set if `type` is `student`. |  |
-| **repayment_model** | [**StudentLoanRepaymentModel**](StudentLoanRepaymentModel.md) |  |  |
-| **expected_payoff_date** | **String** | Override the `expected_payoff_date` field. Can only be set if `type` is `student`. |  |
-| **guarantor** | **String** | Override the `guarantor` field. Can only be set if `type` is `student`. |  |
-| **is_federal** | **Boolean** | Override the `is_federal` field. Can only be set if `type` is `student`. |  |
-| **loan_name** | **String** | Override the `loan_name` field. Can only be set if `type` is `student`. |  |
-| **loan_status** | [**StudentLoanStatus**](StudentLoanStatus.md) |  |  |
-| **payment_reference_number** | **String** | Override the `payment_reference_number` field. Can only be set if `type` is `student`. |  |
-| **pslf_status** | [**PSLFStatus**](PSLFStatus.md) |  |  |
-| **repayment_plan_description** | **String** | Override the `repayment_plan.description` field. Can only be set if `type` is `student`. |  |
-| **repayment_plan_type** | **String** | Override the `repayment_plan.type` field. Can only be set if `type` is `student`. Possible values are: `\"extended graduated\"`, `\"extended standard\"`, `\"graduated\"`, `\"income-contingent repayment\"`, `\"income-based repayment\"`, `\"interest only\"`, `\"other\"`, `\"pay as you earn\"`, `\"revised pay as you earn\"`, or `\"standard\"`. |  |
-| **sequence_number** | **String** | Override the `sequence_number` field. Can only be set if `type` is `student`. |  |
-| **servicer_address** | [**Address**](Address.md) |  |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LiabilityOverride.new(
-  type: null,
-  purchase_apr: null,
-  cash_apr: null,
-  balance_transfer_apr: null,
-  special_apr: null,
-  last_payment_amount: null,
-  last_statement_balance: null,
-  minimum_payment_amount: null,
-  is_overdue: null,
-  origination_date: null,
-  principal: null,
-  nominal_apr: null,
-  interest_capitalization_grace_period_months: null,
-  repayment_model: null,
-  expected_payoff_date: null,
-  guarantor: null,
-  is_federal: null,
-  loan_name: null,
-  loan_status: null,
-  payment_reference_number: null,
-  pslf_status: null,
-  repayment_plan_description: null,
-  repayment_plan_type: null,
-  sequence_number: null,
-  servicer_address: null
-)
-```
-

data/docs/LinkTokenAccountFilters.md

@@ -1,24 +0,0 @@
-# Plaid::LinkTokenAccountFilters
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **depository** | [**DepositoryFilter**](DepositoryFilter.md) |  | [optional] |
-| **credit** | [**CreditFilter**](CreditFilter.md) |  | [optional] |
-| **loan** | [**LoanFilter**](LoanFilter.md) |  | [optional] |
-| **investment** | [**InvestmentFilter**](InvestmentFilter.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenAccountFilters.new(
-  depository: null,
-  credit: null,
-  loan: null,
-  investment: null
-)
-```
-

data/docs/LinkTokenCreateRequest.md

@@ -1,52 +0,0 @@
-# Plaid::LinkTokenCreateRequest
-
-## 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] |
-| **client_name** | **String** | The name of your application, as it should be displayed in Link. |  |
-| **language** | **String** | The language that Link should be displayed in.  Supported languages are: - English (`'en'`) - French (`'fr'`) - Spanish (`'es'`) - Dutch (`'nl'`)  When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied. |  |
-| **country_codes** | [**Array<CountryCode>**](CountryCode.md) | Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown.  Supported country codes are: `US`, `CA`, `ES`, `FR`, `GB`, `IE`, `NL`. Example value: `['US', 'CA']`.  If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. To gain access to European institutions in the Production environment, [file a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow.  If using a Link customization, make sure the country codes in the customization match those specified in `country_codes`. If both `country_codes` and a Link customization are used, the value in `country_codes` may override the value in the customization.  If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `['US']`. |  |
-| **user** | [**LinkTokenCreateRequestUser**](LinkTokenCreateRequestUser.md) |  |  |
-| **products** | [**Array<Products>**](Products.md) | List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted; required otherwise. Valid products are:  `transactions`, `auth`, `identity`, `assets`, `investments`, `liabilities`, `payment_initiation`, `deposit_switch`  Example: `['auth', 'transactions']`  `balance` is *not* a valid value, the Balance product does not require explicit initalization and will automatically be initialized when any other product is initialized.  Only institutions that support *all* requested products will be shown in Link; to maximize the number of institutions listed, it is recommended to initialize Link with the minimal product set required for your use case. Additional products can be added after Link initialization by calling the relevant endpoints. For details and exceptions, see [Choosing when to initialize products](/docs/link/best-practices/#choosing-when-to-initialize-products).  In Production, you will be billed for each product that you specify when initializing Link. Note that a product cannot be removed from an Item once the Item has been initialized with that product. To stop billing on an Item for subscription-based products, such as Liabilities, Investments, and Transactions, remove the Item via `/item/remove`. | [optional] |
-| **webhook** | **String** | The destination URL to which any webhooks should be sent. | [optional] |
-| **access_token** | **String** | The `access_token` associated with the Item to update, used when updating or modifying an existing `access_token`. Used when launching Link in update mode, when completing the Same-day (manual) Micro-deposit flow, or (optionally) when initializing Link as part of the Payment Initiation (UK and Europe) flow. | [optional] |
-| **link_customization_name** | **String** | The name of the Link customization from the Plaid Dashboard to be applied to Link. If not specified, the `default` customization will be used. When using a Link customization, the language in the customization must match the language selected via the `language` parameter, and the countries in the customization should match the country codes selected via `country_codes`. | [optional] |
-| **redirect_uri** | **String** | A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. The `redirect_uri` should not contain any query parameters. If `android_package_name` is specified, this field should be left blank. Any redirect URI specified here must also be added under the \"Allowed redirect URIs\" configuration on the [developer dashboard](https://dashboard.plaid.com/team/api). In non-Sandbox (Production and Development) environments, the `redirect_uri` must begin with https. | [optional] |
-| **android_package_name** | **String** | The name of your app's Android package. Required if using the `link_token` to initialize Link on Android. When creating a `link_token` for initializing Link on other platforms, this field must be left blank. Any package name specified here must also be added to the Allowed Android package names setting on the [developer dashboard](https://dashboard.plaid.com/team/api).  | [optional] |
-| **account_filters** | [**LinkTokenAccountFilters**](LinkTokenAccountFilters.md) |  | [optional] |
-| **institution_id** | **String** | Used for certain legacy use cases | [optional] |
-| **payment_initiation** | [**LinkTokenCreateRequestPaymentInitiation**](LinkTokenCreateRequestPaymentInitiation.md) |  | [optional] |
-| **deposit_switch** | [**LinkTokenCreateRequestDepositSwitch**](LinkTokenCreateRequestDepositSwitch.md) |  | [optional] |
-| **income_verification** | [**LinkTokenCreateRequestIncomeVerification**](LinkTokenCreateRequestIncomeVerification.md) |  | [optional] |
-| **auth** | [**LinkTokenCreateRequestAuth**](LinkTokenCreateRequestAuth.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenCreateRequest.new(
-  client_id: null,
-  secret: null,
-  client_name: null,
-  language: null,
-  country_codes: null,
-  user: null,
-  products: null,
-  webhook: null,
-  access_token: null,
-  link_customization_name: null,
-  redirect_uri: null,
-  android_package_name: null,
-  account_filters: null,
-  institution_id: null,
-  payment_initiation: null,
-  deposit_switch: null,
-  income_verification: null,
-  auth: null
-)
-```
-

data/docs/LinkTokenCreateRequestAccountSubtypes.md

@@ -1,24 +0,0 @@
-# Plaid::LinkTokenCreateRequestAccountSubtypes
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **depository** | **Hash<String, Object>** | A filter to apply to `depository`-type accounts | [optional] |
-| **credit** | **Hash<String, Object>** | A filter to apply to `credit`-type accounts | [optional] |
-| **loan** | **Hash<String, Object>** | A filter to apply to `loan`-type accounts | [optional] |
-| **investment** | **Hash<String, Object>** | A filter to apply to `investment`-type accounts | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenCreateRequestAccountSubtypes.new(
-  depository: null,
-  credit: null,
-  loan: null,
-  investment: null
-)
-```
-

data/docs/LinkTokenCreateRequestAuth.md

@@ -1,18 +0,0 @@
-# Plaid::LinkTokenCreateRequestAuth
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **auth_flow** | **String** | The optional Auth flow to use. Currently only used to enable Flexible Auth. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenCreateRequestAuth.new(
-  auth_flow: null
-)
-```
-

data/docs/LinkTokenCreateRequestDepositSwitch.md

@@ -1,18 +0,0 @@
-# Plaid::LinkTokenCreateRequestDepositSwitch
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **deposit_switch_id** | **String** | The `deposit_switch_id` provided by the `/deposit_switch/create` endpoint. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenCreateRequestDepositSwitch.new(
-  deposit_switch_id: null
-)
-```
-

data/docs/LinkTokenCreateRequestIncomeVerification.md

@@ -1,20 +0,0 @@
-# Plaid::LinkTokenCreateRequestIncomeVerification
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **income_verification_id** | **String** | The `income_verification_id` of the verification instance, as provided by `/income/verification/create`. |  |
-| **asset_report_id** | **String** | The `asset_report_id` of an asset report associated with the user, as provided by `/asset_report/create`. Providing an `asset_report_id` is optional and can be used to verify the user through a streamlined flow. If provided, the bank linking flow will be skipped. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenCreateRequestIncomeVerification.new(
-  income_verification_id: null,
-  asset_report_id: null
-)
-```
-

data/docs/LinkTokenCreateRequestPaymentInitiation.md

@@ -1,18 +0,0 @@
-# Plaid::LinkTokenCreateRequestPaymentInitiation
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **payment_id** | **String** | The `payment_id` provided by the `/payment_initiation/payment/create` endpoint. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenCreateRequestPaymentInitiation.new(
-  payment_id: null
-)
-```
-

data/docs/LinkTokenCreateRequestUser.md

@@ -1,32 +0,0 @@
-# Plaid::LinkTokenCreateRequestUser
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **client_user_id** | **String** | A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`. It is currently used as a means of searching logs for the given user in the Plaid Dashboard. |  |
-| **legal_name** | **String** | The user's full legal name. This is an optional field used in the [returning user experience](/docs/link/returning-user) to associate Items to the user. | [optional] |
-| **phone_number** | **String** | The user's phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. This field is optional, but required to enable the [returning user experience](/docs/link/returning-user). | [optional] |
-| **phone_number_verified_time** | **String** | The date and time the phone number was verified in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`). This field is optional, but required to enable any [returning user experience](/docs/link/returning-user).   Only pass a verification time for a phone number that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch.   Example: `2020-01-01T00:00:00Z`  | [optional] |
-| **email_address** | **String** | The user's email address. This field is optional, but required to enable the [pre-authenticated returning user flow](/docs/link/returning-user/#enabling-the-returning-user-experience). | [optional] |
-| **email_address_verified_time** | **String** | The date and time the email address was verified in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`). This is an optional field used in the [returning user experience](/docs/link/returning-user).   Only pass a verification time for an email address that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch.   Example: `2020-01-01T00:00:00Z` | [optional] |
-| **ssn** | **String** | To be provided in the format \"ddd-dd-dddd\". This field is optional and will support not-yet-implemented functionality for new products. | [optional] |
-| **date_of_birth** | **String** | To be provided in the format \"yyyy-mm-dd\". This field is optional and will support not-yet-implemented functionality for new products. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenCreateRequestUser.new(
-  client_user_id: null,
-  legal_name: null,
-  phone_number: null,
-  phone_number_verified_time: null,
-  email_address: null,
-  email_address_verified_time: null,
-  ssn: null,
-  date_of_birth: null
-)
-```
-

data/docs/LinkTokenCreateResponse.md

@@ -1,22 +0,0 @@
-# Plaid::LinkTokenCreateResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **link_token** | **String** | A `link_token`, which can be supplied to Link in order to initialize it and receive a `public_token`, which can be exchanged for an `access_token`. |  |
-| **expiration** | **Time** | The expiration date for the `link_token`, in ISO 8601 format. A `link_token` created to generate a `public_token` that will be exchanged for a new `access_token` expires after 4 hours. A `link_token` created for an existing Item (such as when updating an existing `access_token` by launching Link in update mode) expires after 30 minutes. |  |
-| **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::LinkTokenCreateResponse.new(
-  link_token: null,
-  expiration: null,
-  request_id: null
-)
-```
-

data/docs/LinkTokenGetMetadataResponse.md

@@ -1,30 +0,0 @@
-# Plaid::LinkTokenGetMetadataResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **initial_products** | [**Array<Products>**](Products.md) | The `products` specified in the `/link/token/create` call. | [optional] |
-| **webhook** | **String** | The `webhook` specified in the `/link/token/create` call. | [optional] |
-| **country_codes** | [**Array<CountryCode>**](CountryCode.md) | The `country_codes` specified in the `/link/token/create` call. | [optional] |
-| **language** | **String** | The `language` specified in the `/link/token/create` call. | [optional] |
-| **account_filters** | [**AccountFiltersResponse**](AccountFiltersResponse.md) |  | [optional] |
-| **redirect_uri** | **String** | The `redirect_uri` specified in the `/link/token/create` call. | [optional] |
-| **client_name** | **String** | The `client_name` specified in the `/link/token/create` call. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenGetMetadataResponse.new(
-  initial_products: null,
-  webhook: null,
-  country_codes: null,
-  language: null,
-  account_filters: null,
-  redirect_uri: null,
-  client_name: null
-)
-```
-

data/docs/LinkTokenGetRequest.md

@@ -1,22 +0,0 @@
-# Plaid::LinkTokenGetRequest
-
-## 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] |
-| **link_token** | **String** | A `link_token` from a previous invocation of `/link/token/create` |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenGetRequest.new(
-  client_id: null,
-  secret: null,
-  link_token: null
-)
-```
-

data/docs/LinkTokenGetResponse.md

@@ -1,26 +0,0 @@
-# Plaid::LinkTokenGetResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **link_token** | **String** | A `link_token`, which can be supplied to Link in order to initialize it and receive a `public_token`, which can be exchanged for an `access_token`. | [optional] |
-| **created_at** | **Time** | The creation timestamp for the `link_token`, in ISO 8601 format. | [optional] |
-| **expiration** | **Time** | The expiration timestamp for the `link_token`, in ISO 8601 format. | [optional] |
-| **metadata** | [**LinkTokenGetMetadataResponse**](LinkTokenGetMetadataResponse.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. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::LinkTokenGetResponse.new(
-  link_token: null,
-  created_at: null,
-  expiration: null,
-  metadata: null,
-  request_id: null
-)
-```
-

data/docs/LoanFilter.md

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

data/docs/Location.md

@@ -1,32 +0,0 @@
-# Plaid::Location
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **address** | **String** | The street address where the transaction occurred. | [optional] |
-| **city** | **String** | The city where the transaction occurred. | [optional] |
-| **region** | **String** | The region or state where the transaction occurred. | [optional] |
-| **postal_code** | **String** | The postal code where the transaction occurred. | [optional] |
-| **country** | **String** | The ISO 3166-1 alpha-2 country code where the transaction occurred. | [optional] |
-| **lat** | **Float** | The latitude where the transaction occurred. | [optional] |
-| **lon** | **Float** | The longitude where the transaction occurred. | [optional] |
-| **store_number** | **String** | The merchant defined store number where the transaction occurred. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::Location.new(
-  address: null,
-  city: null,
-  region: null,
-  postal_code: null,
-  country: null,
-  lat: null,
-  lon: null,
-  store_number: null
-)
-```
-