plaid 13.2.0 → 14.0.0.beta.1

data/docs/Numbers.md

@@ -0,0 +1,32 @@
+# Plaid::Numbers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **String** | Will be used for the account number. |  |
+| **ach_routing** | **String** | Must be a valid ACH routing number. |  |
+| **ach_wire_routing** | **String** | Must be a valid wire transfer routing number. |  |
+| **eft_institution** | **String** | EFT institution number. Must be specified alongside `eft_branch`. |  |
+| **eft_branch** | **String** | EFT branch number. Must be specified alongside `eft_institution`. |  |
+| **international_bic** | **String** | Bank identifier code (BIC). Must be specified alongside `international_iban`. |  |
+| **international_iban** | **String** | International bank account number (IBAN). If no account number is specified via `account`, will also be used as the account number by default. Must be specified alongside `international_bic`. |  |
+| **bacs_sort_code** | **String** | BACS sort code |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::Numbers.new(
+  account: null,
+  ach_routing: null,
+  ach_wire_routing: null,
+  eft_institution: null,
+  eft_branch: null,
+  international_bic: null,
+  international_iban: null,
+  bacs_sort_code: null
+)
+```
+

data/docs/NumbersACH.md

@@ -0,0 +1,24 @@
+# Plaid::NumbersACH
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The Plaid account ID associated with the account numbers |  |
+| **account** | **String** | The ACH account number for the account |  |
+| **routing** | **String** | The ACH routing number for the account |  |
+| **wire_routing** | **String** | The wire transfer routing number for the account, if available | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::NumbersACH.new(
+  account_id: null,
+  account: null,
+  routing: null,
+  wire_routing: null
+)
+```
+

data/docs/NumbersBACS.md

@@ -0,0 +1,22 @@
+# Plaid::NumbersBACS
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The Plaid account ID associated with the account numbers |  |
+| **account** | **String** | The BACS account number for the account |  |
+| **sort_code** | **String** | The BACS sort code for the account |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::NumbersBACS.new(
+  account_id: null,
+  account: null,
+  sort_code: null
+)
+```
+

data/docs/NumbersEFT.md

@@ -0,0 +1,24 @@
+# Plaid::NumbersEFT
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The Plaid account ID associated with the account numbers |  |
+| **account** | **String** | The EFT account number for the account |  |
+| **institution** | **String** | The EFT institution number for the account |  |
+| **branch** | **String** | The EFT branch number for the account |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::NumbersEFT.new(
+  account_id: null,
+  account: null,
+  institution: null,
+  branch: null
+)
+```
+

data/docs/NumbersInternational.md

@@ -0,0 +1,22 @@
+# Plaid::NumbersInternational
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The Plaid account ID associated with the account numbers |  |
+| **iban** | **String** | The International Bank Account Number (IBAN) for the account |  |
+| **bic** | **String** | The Bank Identifier Code (BIC) for the account |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::NumbersInternational.new(
+  account_id: null,
+  iban: null,
+  bic: null
+)
+```
+

data/docs/OverrideAccounts.md

@@ -0,0 +1,38 @@
+# Plaid::OverrideAccounts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**AccountType**](AccountType.md) |  |  |
+| **subtype** | [**AccountSubtype**](AccountSubtype.md) |  |  |
+| **starting_balance** | **Float** | If provided, the account will start with this amount as the current balance.  |  |
+| **force_available_balance** | **Float** | If provided, the account will always have this amount as its  available balance, regardless of current balance or changes in transactions over time. |  |
+| **currency** | **String** | ISO-4217 currency code. If provided, the account will be denominated in the given currency. Transactions will also be in this currency by default. |  |
+| **meta** | [**Meta**](Meta.md) |  |  |
+| **numbers** | [**Numbers**](Numbers.md) |  |  |
+| **transactions** | [**Array<TransactionOverride>**](TransactionOverride.md) | Specify the list of transactions on the account. |  |
+| **identity** | [**OwnerOverride**](OwnerOverride.md) |  |  |
+| **liability** | [**LiabilityOverride**](LiabilityOverride.md) |  |  |
+| **inflow_model** | [**InflowModel**](InflowModel.md) |  |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::OverrideAccounts.new(
+  type: null,
+  subtype: null,
+  starting_balance: null,
+  force_available_balance: null,
+  currency: null,
+  meta: null,
+  numbers: null,
+  transactions: null,
+  identity: null,
+  liability: null,
+  inflow_model: null
+)
+```
+

data/docs/Owner.md

@@ -0,0 +1,24 @@
+# Plaid::Owner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **names** | **Array<String>** | A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. If the name of a business is reported, please contact Plaid Support.  In the case of a joint account, the names of all account holders will be reported.  If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's `names` array. |  |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) | A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution. |  |
+| **emails** | [**Array<Email>**](Email.md) | A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution. |  |
+| **addresses** | [**Array<Address>**](Address.md) | Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::Owner.new(
+  names: null,
+  phone_numbers: null,
+  emails: null,
+  addresses: null
+)
+```
+

data/docs/OwnerOverride.md

@@ -0,0 +1,24 @@
+# Plaid::OwnerOverride
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **names** | **Array<String>** | A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. Note that the same name data will be used for all accounts associated with an Item. |  |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) | A list of phone numbers associated with the account. |  |
+| **emails** | [**Array<Email>**](Email.md) | A list of email addresses associated with the account. |  |
+| **addresses** | [**Array<Address>**](Address.md) | Data about the various addresses associated with the account. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::OwnerOverride.new(
+  names: null,
+  phone_numbers: null,
+  emails: null,
+  addresses: null
+)
+```
+

data/docs/PSLFStatus.md

@@ -0,0 +1,22 @@
+# Plaid::PSLFStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **estimated_eligibility_date** | **String** | The estimated date borrower will have completed 120 qualifying monthly payments. Returned in ISO 8601 format (YYYY-MM-DD). | [optional] |
+| **payments_made** | **Float** | The number of qualifying payments that have been made. | [optional] |
+| **payments_remaining** | **Float** | The number of qualifying payments remaining. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PSLFStatus.new(
+  estimated_eligibility_date: null,
+  payments_made: null,
+  payments_remaining: null
+)
+```
+

data/docs/PayFrequency.md

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

data/docs/PayPeriodDetails.md

@@ -0,0 +1,26 @@
+# Plaid::PayPeriodDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **String** | The pay period start date, in ISO 8601 format: \"yyyy-mm-dd\". | [optional] |
+| **end_date** | **String** | The pay period end date, in ISO 8601 format: \"yyyy-mm-dd\". | [optional] |
+| **pay_day** | **String** | The date on which the paystub was issued, in ISO 8601 format (\"yyyy-mm-dd\"). | [optional] |
+| **gross_earnings** | **Float** | Total earnings before tax. | [optional] |
+| **check_amount** | **Float** | The net amount of the paycheck. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PayPeriodDetails.new(
+  start_date: null,
+  end_date: null,
+  pay_day: null,
+  gross_earnings: null,
+  check_amount: null
+)
+```
+

data/docs/PaymentAmount.md

@@ -0,0 +1,20 @@
+# Plaid::PaymentAmount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | The ISO-4217 currency code of the payment amount |  |
+| **value** | **Float** | The payment amount |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentAmount.new(
+  currency: null,
+  value: null
+)
+```
+

data/docs/PaymentInitiationAddress.md

@@ -0,0 +1,24 @@
+# Plaid::PaymentInitiationAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street** | **Array<String>** | An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters. | [optional] |
+| **city** | **String** | The city where the recipient is located. Maximum of 35 characters. | [optional] |
+| **postal_code** | **String** | The postal code where the recipient is located. Maximum of 16 characters. | [optional] |
+| **country** | **String** | The ISO 3166-1 alpha-2 country code where the recipient is located. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationAddress.new(
+  street: null,
+  city: null,
+  postal_code: null,
+  country: null
+)
+```
+

data/docs/PaymentInitiationPaymentCreateRequest.md

@@ -0,0 +1,28 @@
+# Plaid::PaymentInitiationPaymentCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **recipient_id** | **String** | The ID of the recipient the payment is for. |  |
+| **reference** | **String** | A reference for the payment. This must be an alphanumeric string with at most 18 characters and must not contain any special characters (since not all institutions support them). |  |
+| **amount** | [**Amount**](Amount.md) |  |  |
+| **schedule** | [**ExternalPaymentSchedule**](ExternalPaymentSchedule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationPaymentCreateRequest.new(
+  client_id: null,
+  secret: null,
+  recipient_id: null,
+  reference: null,
+  amount: null,
+  schedule: null
+)
+```
+

data/docs/PaymentInitiationPaymentCreateResponse.md

@@ -0,0 +1,22 @@
+# Plaid::PaymentInitiationPaymentCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_id** | **String** | A unique ID identifying the payment |  |
+| **status** | **String** | For a payment returned by this endpoint, there is only one possible value:  `PAYMENT_STATUS_INPUT_NEEDED`: The initial phase of the payment |  |
+| **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::PaymentInitiationPaymentCreateResponse.new(
+  payment_id: null,
+  status: null,
+  request_id: null
+)
+```
+

data/docs/PaymentInitiationPaymentGetRequest.md

@@ -0,0 +1,22 @@
+# Plaid::PaymentInitiationPaymentGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **payment_id** | **String** | The `payment_id` returned from `/payment_initiation/payment/create`. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationPaymentGetRequest.new(
+  client_id: null,
+  secret: null,
+  payment_id: null
+)
+```
+

data/docs/PaymentInitiationPaymentGetResponse.md

@@ -0,0 +1,32 @@
+# Plaid::PaymentInitiationPaymentGetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_id** | **String** | The ID of the payment. Like all Plaid identifiers, the `payment_id` is case sensitive. |  |
+| **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] |
+| **amount** | [**PaymentAmount**](PaymentAmount.md) |  |  |
+| **status** | **String** | The status of the payment.  `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.  `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete.  `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete.  `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.  `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds.  `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved.  `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error.  `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown. |  |
+| **recipient_id** | **String** | The ID of the recipient |  |
+| **reference** | **String** | A reference for the payment. |  |
+| **last_status_update** | **String** | The date and time of the last time the `status` was updated, in IS0 8601 format |  |
+| **schedule** | [**ExternalPaymentSchedule**](ExternalPaymentSchedule.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::PaymentInitiationPaymentGetResponse.new(
+  payment_id: null,
+  request_id: null,
+  amount: null,
+  status: null,
+  recipient_id: null,
+  reference: null,
+  last_status_update: null,
+  schedule: null
+)
+```
+