plaid 13.2.0 → 14.0.0.beta.1

data/Rakefile

@@ -1,83 +1,12 @@
-require 'bundler/gem_tasks'
-require 'sdoc'
-require 'rdoc/task'
-require 'rake/testtask'
-require 'dotenv/load'
-require 'fileutils'
-require 'tmpdir'
-
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'doc/rdoc'
-  rdoc.generator = 'sdoc'
-  rdoc.main = 'README.md'
-
-  rdoc.rdoc_files.include('README.md', 'LICENSE.txt', 'lib/**/*.rb')
-  rdoc.markup = 'tomdoc'
-end
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "dotenv/load"
+require "fileutils"
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/test*.rb']
+  t.libs << "test"
+  t.test_files = FileList['test/*.rb']
   t.verbose = true
-  t.ruby_opts << '-rminitest/pride'
-end
-
-desc 'Update the gh-pages branch with doc/rdoc contents'
-task :update_gh_pages do
-  tmpdir = Dir::Tmpname.create('plaid_docs') {}
-
-  desc = `git describe`.chomp
-
-  sh "git clone --shared . #{tmpdir}"
-
-  Dir.chdir(tmpdir) do
-    sh 'git checkout gh-pages'
-    FileUtils.rm_rf Dir.glob("#{tmpdir}/*")
-  end
-
-  FileUtils.cp_r Dir.glob('doc/rdoc/*'), tmpdir
-
-  Dir.chdir(tmpdir) do
-    sh 'git add .'
-    sh 'git add --update .'
-    sh "git commit --allow-empty -m 'Regenerate docs for #{desc}'"
-    sh 'git push'
-  end
-
-  FileUtils.rm_rf tmpdir
+  t.ruby_opts << "-rminitest/pride"
+  t.warning = false
 end
-
-desc 'Generate rdoc and update gh-pages on GitHub'
-task update_github_docs: %i[rdoc update_gh_pages] do
-  sh 'git push origin gh-pages'
-end
-
-desc 'Hide real credentials in VCR cassettes'
-task :vcr_hide_credentials do
-  all_creds = %w[PLAID_RUBY_CLIENT_ID PLAID_RUBY_SECRET]
-
-  all_creds.each do |cred|
-    raise "#{cred} is not set" unless ENV[cred]
-  end
-
-  Dir['test/vcr_cassettes/*'].each do |fn|
-    data = File.read(fn)
-    data0 = data.clone
-
-    all_creds.each do |cred|
-      data.gsub! ENV[cred], cred
-    end
-
-    next unless data != data0
-    File.open(fn, 'w') { |f| f.write data }
-
-    puts ">> Updated #{fn}"
-  end
-end
-
-task :test_stubbed do
-  ENV['STUB_API'] ||= '1'
-  Rake::Task['test'].invoke
-end
-
-task default: :test_stubbed

data/UPGRADING.md

@@ -1,3 +1,7 @@
+## Upgrading from 13.0.0 to 14.0.0
+
+See the [CHANGELOG](CHANGELOG.md) for what needs to be updated.
+
 ## Upgrading from 3.x.x to 4.0.0
 
 Version 4.0.0 supports [Plaid's new API](https://blog.plaid.com/improving-our-api/).  Use the [transition guide](https://plaid.com/docs/link/transition-guide) to update your integration.

data/docs/ACHClass.md

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

data/docs/APR.md

@@ -0,0 +1,24 @@
+# Plaid::APR
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **apr_percentage** | **Float** | Annual Percentage Rate applied.  |  |
+| **apr_type** | **String** | The type of balance to which the APR applies. |  |
+| **balance_subject_to_apr** | **Float** | Amount of money that is subjected to the APR if a balance was carried beyond payment due date. How it is calculated can vary by card issuer. It is often calculated as an average daily balance. | [optional] |
+| **interest_charge_amount** | **Float** | Amount of money charged due to interest from last statement. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::APR.new(
+  apr_percentage: null,
+  apr_type: null,
+  balance_subject_to_apr: null,
+  interest_charge_amount: null
+)
+```
+

data/docs/AccountAssets.md

@@ -0,0 +1,40 @@
+# Plaid::AccountAssets
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new `account_id` will be assigned to the account.  The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`.  Like all Plaid identifiers, the `account_id` is case sensitive. |  |
+| **balances** | [**AccountBalance**](AccountBalance.md) |  |  |
+| **mask** | **String** | The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user. | [optional] |
+| **name** | **String** | The name of the account, either assigned by the user or by the financial institution itself |  |
+| **official_name** | **String** | The official name of the account as given by the financial institution | [optional] |
+| **type** | [**AccountType**](AccountType.md) |  |  |
+| **subtype** | [**AccountSubtype**](AccountSubtype.md) |  |  |
+| **verification_status** | **String** | The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.  Returned for Auth Items only.  `pending_automatic_verification`: The Item is pending automatic verification  `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the two amounts.  `automatically_verified`: The Item has successfully been automatically verified   `manually_verified`: The Item has successfully been manually verified  `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.  `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.    | [optional] |
+| **days_available** | **Float** | The duration of transaction history available for this Item, typically defined as the time since the date of the earliest transaction in that account. Only returned by Assets endpoints. | [optional] |
+| **transactions** | [**Array<AssetReportTransaction>**](AssetReportTransaction.md) | Transaction history associated with the account. Only returned by Assets endpoints. Transaction history returned by endpoints such as `/transactions/get` or `/investments/transactions/get` will be returned in the top-level `transactions` field instead. | [optional] |
+| **owners** | [**Array<Owner>**](Owner.md) | Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array. |  |
+| **historical_balances** | [**Array<HistoricalBalance>**](HistoricalBalance.md) | Calculated data about the historical balances on the account. Only returned by Assets endpoints. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::AccountAssets.new(
+  account_id: null,
+  balances: null,
+  mask: null,
+  name: null,
+  official_name: null,
+  type: null,
+  subtype: null,
+  verification_status: null,
+  days_available: null,
+  transactions: null,
+  owners: null,
+  historical_balances: null
+)
+```
+

data/docs/AccountAssetsAllOf.md

@@ -0,0 +1,24 @@
+# Plaid::AccountAssetsAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **days_available** | **Float** | The duration of transaction history available for this Item, typically defined as the time since the date of the earliest transaction in that account. Only returned by Assets endpoints. | [optional] |
+| **transactions** | [**Array<AssetReportTransaction>**](AssetReportTransaction.md) | Transaction history associated with the account. Only returned by Assets endpoints. Transaction history returned by endpoints such as `/transactions/get` or `/investments/transactions/get` will be returned in the top-level `transactions` field instead. | [optional] |
+| **owners** | [**Array<Owner>**](Owner.md) | Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array. |  |
+| **historical_balances** | [**Array<HistoricalBalance>**](HistoricalBalance.md) | Calculated data about the historical balances on the account. Only returned by Assets endpoints. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::AccountAssetsAllOf.new(
+  days_available: null,
+  transactions: null,
+  owners: null,
+  historical_balances: null
+)
+```
+

data/docs/AccountBalance.md

@@ -0,0 +1,26 @@
+# Plaid::AccountBalance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available** | **Float** | The amount of funds available to be withdrawn from the account, as determined by the financial institution.  For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows.  For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit.  For `investment`-type accounts, the `available` balance is the total cash available to withdraw as presented by the institution.  Note that not all institutions calculate the `available`  balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`.  Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`. | [optional] |
+| **current** | **Float** | The total amount of funds in or owed by the account.  For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.  For `loan`-type accounts, the current balance is the principal remaining on the loan.  For `investment`-type accounts, the current balance is the total value of assets as presented by the institution.  Note that balance information may be cached unless the value was returned by `/accounts/balance/get`, and current balance information is typically not updated intra-day. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`. |  |
+| **limit** | **Float** | For `credit`-type accounts, this represents the credit limit.  For `depository`-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.  In North America, this field is typically only available for `credit`-type accounts. | [optional] |
+| **iso_currency_code** | **String** | The ISO-4217 currency code of the balance. Always null if `unofficial_currency_code` is non-null. | [optional] |
+| **unofficial_currency_code** | **String** | The unofficial currency code associated with the balance. 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 `unofficial_currency_code`s. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::AccountBalance.new(
+  available: null,
+  current: null,
+  limit: null,
+  iso_currency_code: null,
+  unofficial_currency_code: null
+)
+```
+

data/docs/AccountBase.md

@@ -0,0 +1,32 @@
+# Plaid::AccountBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new `account_id` will be assigned to the account.  The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`.  Like all Plaid identifiers, the `account_id` is case sensitive. |  |
+| **balances** | [**AccountBalance**](AccountBalance.md) |  |  |
+| **mask** | **String** | The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user. | [optional] |
+| **name** | **String** | The name of the account, either assigned by the user or by the financial institution itself |  |
+| **official_name** | **String** | The official name of the account as given by the financial institution | [optional] |
+| **type** | [**AccountType**](AccountType.md) |  |  |
+| **subtype** | [**AccountSubtype**](AccountSubtype.md) |  |  |
+| **verification_status** | **String** | The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.  Returned for Auth Items only.  `pending_automatic_verification`: The Item is pending automatic verification  `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the two amounts.  `automatically_verified`: The Item has successfully been automatically verified   `manually_verified`: The Item has successfully been manually verified  `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.  `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.    | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::AccountBase.new(
+  account_id: null,
+  balances: null,
+  mask: null,
+  name: null,
+  official_name: null,
+  type: null,
+  subtype: null,
+  verification_status: null
+)
+```
+

data/docs/AccountFiltersResponse.md

@@ -0,0 +1,24 @@
+# Plaid::AccountFiltersResponse
+
+## 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::AccountFiltersResponse.new(
+  depository: null,
+  credit: null,
+  loan: null,
+  investment: null
+)
+```
+

data/docs/AccountIdentity.md

@@ -0,0 +1,34 @@
+# Plaid::AccountIdentity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new `account_id` will be assigned to the account.  The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`.  Like all Plaid identifiers, the `account_id` is case sensitive. |  |
+| **balances** | [**AccountBalance**](AccountBalance.md) |  |  |
+| **mask** | **String** | The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user. | [optional] |
+| **name** | **String** | The name of the account, either assigned by the user or by the financial institution itself |  |
+| **official_name** | **String** | The official name of the account as given by the financial institution | [optional] |
+| **type** | [**AccountType**](AccountType.md) |  |  |
+| **subtype** | [**AccountSubtype**](AccountSubtype.md) |  |  |
+| **verification_status** | **String** | The current verification status of an Auth Item initiated through Automated or Manual micro-deposits.  Returned for Auth Items only.  `pending_automatic_verification`: The Item is pending automatic verification  `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the two amounts.  `automatically_verified`: The Item has successfully been automatically verified   `manually_verified`: The Item has successfully been manually verified  `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.  `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.    | [optional] |
+| **owners** | [**Array<Owner>**](Owner.md) | Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::AccountIdentity.new(
+  account_id: null,
+  balances: null,
+  mask: null,
+  name: null,
+  official_name: null,
+  type: null,
+  subtype: null,
+  verification_status: null,
+  owners: null
+)
+```
+

data/docs/AccountIdentityAllOf.md

@@ -0,0 +1,18 @@
+# Plaid::AccountIdentityAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **owners** | [**Array<Owner>**](Owner.md) | Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array. |  |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::AccountIdentityAllOf.new(
+  owners: null
+)
+```
+

data/docs/AccountSubtype.md

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

data/docs/AccountType.md

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

data/docs/AccountsBalanceGetRequest.md

@@ -0,0 +1,24 @@
+# Plaid::AccountsBalanceGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** | The access token associated with the Item data is being requested for. |  |
+| **secret** | **String** | Your Plaid API `secret`. | [optional] |
+| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
+| **options** | [**AccountsBalanceGetRequestOptions**](AccountsBalanceGetRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::AccountsBalanceGetRequest.new(
+  access_token: null,
+  secret: null,
+  client_id: null,
+  options: null
+)
+```
+

data/docs/AccountsBalanceGetRequestOptions.md

@@ -0,0 +1,18 @@
+# Plaid::AccountsBalanceGetRequestOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_ids** | **Array<String>** | A list of `account_ids` to retrieve for the Item. The default value is `null`.  Note: An error will be returned if a provided `account_id` is not associated with the Item. | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::AccountsBalanceGetRequestOptions.new(
+  account_ids: null
+)
+```
+

data/docs/AccountsGetRequest.md

@@ -0,0 +1,24 @@
+# Plaid::AccountsGetRequest
+
+## 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** | [**AccountsGetRequestOptions**](AccountsGetRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'plaid'
+
+instance = Plaid::AccountsGetRequest.new(
+  client_id: null,
+  secret: null,
+  access_token: null,
+  options: null
+)
+```
+