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

data/docs/StandaloneAccountType.md

@@ -1,26 +0,0 @@
-# Plaid::StandaloneAccountType
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **depository** | **String** | An account type holding cash, in which funds are deposited. Supported products for `depository` accounts are: Auth, Balance, Transactions, Identity, Payment Initiation, and Assets. |  |
-| **credit** | **String** | A credit card type account. Supported products for `credit` accounts are: Balance, Transactions, Identity, and Liabilities. |  |
-| **loan** | **String** | A loan type account. Supported products for `loan` accounts are: Balance, Liabilities, and Transactions. |  |
-| **investment** | **String** | An investment account. Supported products for `investment` accounts are: Balance and Investments. |  |
-| **other** | **String** | Other or unknown account type. Supported products for `other` accounts are: Balance, Transactions, Identity, and Assets. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::StandaloneAccountType.new(
-  depository: null,
-  credit: null,
-  loan: null,
-  investment: null,
-  other: null
-)
-```
-

data/docs/StandaloneCurrencyCodeList.md

@@ -1,20 +0,0 @@
-# Plaid::StandaloneCurrencyCodeList
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **iso_currency_code** | **String** | Plaid supports all ISO 4217 currency codes. |  |
-| **unofficial_currency_code** | **String** | List of unofficial currency codes |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::StandaloneCurrencyCodeList.new(
-  iso_currency_code: null,
-  unofficial_currency_code: null
-)
-```
-

data/docs/StandaloneInvestmentTransactionSubtype.md

@@ -1,104 +0,0 @@
-# Plaid::StandaloneInvestmentTransactionSubtype
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_fee** | **String** | Fees paid for account maintenance | [optional] |
-| **assignment** | **String** | Assignment of short option holding | [optional] |
-| **buy** | **String** | Purchase to open or increase a position | [optional] |
-| **buy_to_cover** | **String** | Purchase to close a short position | [optional] |
-| **contribution** | **String** | Inflow of assets into a tax-advantaged account | [optional] |
-| **deposit** | **String** | Inflow of cash into an account | [optional] |
-| **distribution** | **String** | Outflow of assets from a tax-advantaged account | [optional] |
-| **dividend** | **String** | Inflow of cash from a dividend | [optional] |
-| **dividend_reinvestment** | **String** | Purchase using proceeds from a cash dividend | [optional] |
-| **exercise** | **String** | Exercise of an option or warrant contract | [optional] |
-| **expire** | **String** | Expiration of an option or warrant contract  | [optional] |
-| **fund_fee** | **String** | Fees paid for administration of a mutual fund or other pooled investment vehicle | [optional] |
-| **interest** | **String** | Inflow of cash from interest | [optional] |
-| **interest_receivable** | **String** | Inflow of cash from interest receivable | [optional] |
-| **interest_reinvestment** | **String** | Purchase using proceeds from a cash interest payment | [optional] |
-| **legal_fee** | **String** | Fees paid for legal charges or services | [optional] |
-| **loan_payment** | **String** | Inflow of cash related to payment on a loan | [optional] |
-| **long_term_capital_gain** | **String** | Long-term capital gain received as cash | [optional] |
-| **long_term_capital_gain_reinvestment** | **String** | Purchase using long-term capital gain cash proceeds | [optional] |
-| **management_fee** | **String** | Fees paid for investment management of a mutual fund or other pooled investment vehicle | [optional] |
-| **margin_expense** | **String** | Fees paid for maintaining margin debt | [optional] |
-| **merger** | **String** | Stock exchanged at a pre-defined ratio as part of a merger between companies | [optional] |
-| **miscellaneous_fee** | **String** | Fee associated with various account or holding actions | [optional] |
-| **non_qualified_dividend** | **String** | Inflow of cash from a non-qualified dividend | [optional] |
-| **non_resident_tax** | **String** | Taxes paid on behalf of the investor for non-residency in investment jurisdiction | [optional] |
-| **pending_credit** | **String** | Pending inflow of cash | [optional] |
-| **pending_debit** | **String** | Pending outflow of cash | [optional] |
-| **qualified_dividend** | **String** | Inflow of cash from a qualified dividend | [optional] |
-| **rebalance** | **String** | Rebalancing transaction (buy or sell) with no net impact to value in the account | [optional] |
-| **return_of_principal** | **String** | Repayment of loan principal | [optional] |
-| **sell** | **String** | Sell to close or decrease an existing holding | [optional] |
-| **sell_short** | **String** | Sell to open a short position | [optional] |
-| **short_term_capital_gain** | **String** | Short-term capital gain received as cash | [optional] |
-| **short_term_capital_gain_reinvestment** | **String** | Purchase using short-term capital gain cash proceeds | [optional] |
-| **spin_off** | **String** | Inflow of stock from spin-off transaction of an existing holding | [optional] |
-| **split** | **String** | Inflow of stock from a forward split of an existing holding | [optional] |
-| **stock_distribution** | **String** | Inflow of stock from a distribution | [optional] |
-| **tax** | **String** | Taxes paid on behalf of the investor | [optional] |
-| **tax_withheld** | **String** | Taxes withheld on behalf of the customer | [optional] |
-| **transfer** | **String** | Movement of assets into or out of an account | [optional] |
-| **transfer_fee** | **String** | Fees incurred for transfer of a holding or account | [optional] |
-| **trust_fee** | **String** | Fees related to adminstration of a trust account | [optional] |
-| **unqualified_gain** | **String** | Unqualified capital gain received as cash | [optional] |
-| **withdrawal** | **String** | Outflow of cash from an account | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::StandaloneInvestmentTransactionSubtype.new(
-  account_fee: null,
-  assignment: null,
-  buy: null,
-  buy_to_cover: null,
-  contribution: null,
-  deposit: null,
-  distribution: null,
-  dividend: null,
-  dividend_reinvestment: null,
-  exercise: null,
-  expire: null,
-  fund_fee: null,
-  interest: null,
-  interest_receivable: null,
-  interest_reinvestment: null,
-  legal_fee: null,
-  loan_payment: null,
-  long_term_capital_gain: null,
-  long_term_capital_gain_reinvestment: null,
-  management_fee: null,
-  margin_expense: null,
-  merger: null,
-  miscellaneous_fee: null,
-  non_qualified_dividend: null,
-  non_resident_tax: null,
-  pending_credit: null,
-  pending_debit: null,
-  qualified_dividend: null,
-  rebalance: null,
-  return_of_principal: null,
-  sell: null,
-  sell_short: null,
-  short_term_capital_gain: null,
-  short_term_capital_gain_reinvestment: null,
-  spin_off: null,
-  split: null,
-  stock_distribution: null,
-  tax: null,
-  tax_withheld: null,
-  transfer: null,
-  transfer_fee: null,
-  trust_fee: null,
-  unqualified_gain: null,
-  withdrawal: null
-)
-```
-

data/docs/StandaloneInvestmentTransactionType.md

@@ -1,28 +0,0 @@
-# Plaid::StandaloneInvestmentTransactionType
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **buy** | **String** | Buying an investment |  |
-| **sell** | **String** | Selling an investment |  |
-| **cancel** | **String** | A cancellation of a pending transaction |  |
-| **cash** | **String** | Activity that modifies a cash position |  |
-| **fee** | **String** | Fees on the account, e.g. commission, bookkeeping, options-related. |  |
-| **transfer** | **String** | Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::StandaloneInvestmentTransactionType.new(
-  buy: null,
-  sell: null,
-  cancel: null,
-  cash: null,
-  fee: null,
-  transfer: null
-)
-```
-

data/docs/StudentLoan.md

@@ -1,66 +0,0 @@
-# Plaid::StudentLoan
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | The ID of the account that this liability belongs to. | [optional] |
-| **account_number** | **String** | The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number). | [optional] |
-| **disbursement_dates** | **Array<String>** | The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
-| **expected_payoff_date** | **String** | The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
-| **guarantor** | **String** | The guarantor of the student loan. | [optional] |
-| **interest_rate_percentage** | **Float** | The interest rate on the loan as a percentage. |  |
-| **is_overdue** | **Boolean** | `true` if a payment is currently overdue. Availability for this field is limited. | [optional] |
-| **last_payment_amount** | **Float** | The amount of the last payment. | [optional] |
-| **last_payment_date** | **String** | The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
-| **last_statement_balance** | **Float** | The outstanding balance on the last statement. This field could also be interpreted as the next payment due. Availability for this field is limited.  | [optional] |
-| **last_statement_issue_date** | **String** | The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
-| **loan_name** | **String** | The type of loan, e.g., \"Consolidation Loans\". | [optional] |
-| **loan_status** | [**StudentLoanStatus**](StudentLoanStatus.md) |  | [optional] |
-| **minimum_payment_amount** | **Float** | The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( `ins_116861`), Firstmark (`ins_116295`), Commonbond Firstmark Services (`ins_116950`), Nelnet (`ins_116528`), EdFinancial Services (`ins_116304`), Granite State (`ins_116308`), and Oklahoma Student Loan Authority (`ins_116945`). Firstmark (`ins_116295` ) will display as $0 if there is an autopay program in effect. | [optional] |
-| **next_payment_due_date** | **String** | The due date for the next payment. The due date is `null` if a payment is not expected. A payment is not expected if `loan_status.type` is `deferment`, `in_school`, `consolidated`, `paid in full`, or `transferred`. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
-| **origination_date** | **String** | The date on which the loan was initially lent. Dates are returned in an ISO 8601 format (YYYY-MM-DD).  | [optional] |
-| **origination_principal_amount** | **Float** | The original principal balance of the loan. | [optional] |
-| **outstanding_interest_amount** | **Float** | The total dollar amount of the accrued interest balance. For Sallie Mae ( `ins_116944`), this amount is included in the current balance of the loan, so this field will return as `null`. | [optional] |
-| **payment_reference_number** | **String** | The relevant account number that should be used to reference this loan for payments. In the majority of cases, `payment_reference_number` will match a`ccount_number,` but in some institutions, such as Great Lakes (`ins_116861`), it will be different. | [optional] |
-| **pslf_status** | [**PSLFStatus**](PSLFStatus.md) |  | [optional] |
-| **repayment_plan** | [**StudentRepaymentPlan**](StudentRepaymentPlan.md) |  | [optional] |
-| **sequence_number** | **String** | The sequence number of the student loan. Heartland ECSI (`ins_116948`) does not make this field available. | [optional] |
-| **servicer_address** | [**ServicerAddressData**](ServicerAddressData.md) |  | [optional] |
-| **ytd_interest_paid** | **Float** | The year to date (YTD) interest paid. Availability for this field is limited. | [optional] |
-| **ytd_principal_paid** | **Float** | The year to date (YTD) principal paid. Availability for this field is limited. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::StudentLoan.new(
-  account_id: null,
-  account_number: null,
-  disbursement_dates: null,
-  expected_payoff_date: null,
-  guarantor: null,
-  interest_rate_percentage: null,
-  is_overdue: null,
-  last_payment_amount: null,
-  last_payment_date: null,
-  last_statement_balance: null,
-  last_statement_issue_date: null,
-  loan_name: null,
-  loan_status: null,
-  minimum_payment_amount: null,
-  next_payment_due_date: null,
-  origination_date: null,
-  origination_principal_amount: null,
-  outstanding_interest_amount: null,
-  payment_reference_number: null,
-  pslf_status: null,
-  repayment_plan: null,
-  sequence_number: null,
-  servicer_address: null,
-  ytd_interest_paid: null,
-  ytd_principal_paid: null
-)
-```
-

data/docs/StudentLoanRepaymentModel.md

@@ -1,22 +0,0 @@
-# Plaid::StudentLoanRepaymentModel
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | The only currently supported value for this field is `standard`. |  |
-| **non_repayment_months** | **Float** | Configures the number of months before repayment starts. |  |
-| **repayment_months** | **Float** | Configures the number of months of repayments before the loan is paid off. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::StudentLoanRepaymentModel.new(
-  type: null,
-  non_repayment_months: null,
-  repayment_months: null
-)
-```
-

data/docs/StudentLoanStatus.md

@@ -1,20 +0,0 @@
-# Plaid::StudentLoanStatus
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **end_date** | **String** | The date until which the loan will be in its current status. Dates are returned in an ISO 8601 format (YYYY-MM-DD).  | [optional] |
-| **type** | **String** | The status type of the student loan | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::StudentLoanStatus.new(
-  end_date: null,
-  type: null
-)
-```
-

data/docs/StudentRepaymentPlan.md

@@ -1,20 +0,0 @@
-# Plaid::StudentRepaymentPlan
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **description** | **String** | The description of the repayment plan as provided by the servicer. | [optional] |
-| **type** | **String** | The type of the repayment plan. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::StudentRepaymentPlan.new(
-  description: null,
-  type: null
-)
-```
-

data/docs/Transaction.md

@@ -1,58 +0,0 @@
-# Plaid::Transaction
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **transaction_type** | **String** | Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.  `digital:` transactions that took place online.  `place:` transactions that were made at a physical location.  `special:` transactions that relate to banks, e.g. fees or deposits.  `unresolved:` transactions that do not fit into the other three types.  | [optional] |
-| **transaction_id** | **String** | The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive. |  |
-| **account_owner** | **String** | The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts. | [optional] |
-| **pending_transaction_id** | **String** | The ID of a posted transaction's associated pending transaction, where applicable. | [optional] |
-| **pending** | **Boolean** | When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled. |  |
-| **payment_channel** | **String** | The channel used to make a payment. `online:` transactions that took place online.  `in store:` transactions that were made at a physical location.  `other:` transactions that relate to banks, e.g. fees or deposits.  This field replaces the `transaction_type` field.  | [optional] |
-| **payment_meta** | [**PaymentMeta**](PaymentMeta.md) |  | [optional] |
-| **name** | **String** | The merchant name or transaction description.  If the `transaction` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
-| **merchant_name** | **String** | The merchant name, as extracted by Plaid from the `name` field. | [optional] |
-| **location** | [**Location**](Location.md) |  | [optional] |
-| **authorized_date** | **String** | The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | [optional] |
-| **authorized_datetime** | **String** | Date and time when a transaction was authorized in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`. | [optional] |
-| **date** | **String** | For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). |  |
-| **datetime** | **String** | Date and time when a transaction was posted in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`. | [optional] |
-| **category_id** | **String** | The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).  If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
-| **category** | **Array<String>** | A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).  If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
-| **unofficial_currency_code** | **String** | The unofficial currency code associated with the transaction. 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] |
-| **iso_currency_code** | **String** | The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null. | [optional] |
-| **amount** | **Float** | The settled value of the transaction, denominated in the account's currency, as stated in `iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative. |  |
-| **account_id** | **String** | The ID of the account in which this transaction occurred. |  |
-| **transaction_code** | [**TransactionCode**](TransactionCode.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::Transaction.new(
-  transaction_type: null,
-  transaction_id: null,
-  account_owner: null,
-  pending_transaction_id: null,
-  pending: null,
-  payment_channel: null,
-  payment_meta: null,
-  name: null,
-  merchant_name: null,
-  location: null,
-  authorized_date: null,
-  authorized_datetime: null,
-  date: null,
-  datetime: null,
-  category_id: null,
-  category: null,
-  unofficial_currency_code: null,
-  iso_currency_code: null,
-  amount: null,
-  account_id: null,
-  transaction_code: null
-)
-```
-

data/docs/TransactionCode.md

@@ -1,15 +0,0 @@
-# Plaid::TransactionCode
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::TransactionCode.new()
-```
-

data/docs/TransactionData.md

@@ -1,26 +0,0 @@
-# Plaid::TransactionData
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **description** | **String** | The description of the transaction. |  |
-| **amount** | **Float** | The amount of the transaction. |  |
-| **date** | **String** | The date of the transaction, in ISO 8601 format (\"yyyy-mm-dd\"). |  |
-| **account_id** | **String** | A unique identifier for the end user's account. |  |
-| **transaction_id** | **String** | A unique identifier for the transaction. |  |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::TransactionData.new(
-  description: null,
-  amount: null,
-  date: null,
-  account_id: null,
-  transaction_id: null
-)
-```
-

data/docs/TransactionOverride.md

@@ -1,26 +0,0 @@
-# Plaid::TransactionOverride
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **date_transacted** | **String** | The date of the transaction, in ISO8601 (YYYY-MM-DD) format. Transaction dates in the past or present will result in posted transactions; transaction dates in the future will result in pending transactions. Transactions in Sandbox will move from pending to posted once their transaction date has been reached. |  |
-| **date_posted** | **String** | The date the transaction posted, in ISO8601 (YYYY-MM-DD) format |  |
-| **amount** | **Float** | The transaction amount. Can be negative. |  |
-| **description** | **String** | The transaction description. |  |
-| **currency** | **String** | The ISO-4217 format currency code for the transaction. | [optional] |
-
-## Example
-
-```ruby
-require 'plaid'
-
-instance = Plaid::TransactionOverride.new(
-  date_transacted: null,
-  date_posted: null,
-  amount: null,
-  description: null,
-  currency: null
-)
-```
-