plaid 14.0.0.beta.1 → 14.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86640bde7bfc5e81b5f6f9e4b1403d76378a3ee0db181ad7befec94c8983da51
-  data.tar.gz: 44e9c845451768a1b41fc42c9af012db268830e4a706f45aa9cfbd86eca9d766
+  metadata.gz: e8c05e8bb5cbfacc0902d2ba1e55caa9e598903400664b6e3af05194f9030f48
+  data.tar.gz: d91005c3e51594ffd83a0a018eeed137c4617cf34e19b6d213de72576f351925
 SHA512:
-  metadata.gz: 5da27655620030af181fb044d7ff8ae471de723d8942879d92b19baeffb5de874d76f68e5724227c5bc56d3107d6e1ee15ae3a4c6ff3a2200d735c5e7485889f
-  data.tar.gz: 3b7bea3cfd6715acd13fd2a614c936ff72b24986360306e38ac756328fdb21a23e4955d0894ddc06430cb1e69a2711966f1f9030edad047593d9c5300d1204f2
+  metadata.gz: 59a640409c54e4c585dff9597c99ee9cee2283d5b48299cc800e0e5572380e468d138553eb072523e209c21963850954f74d6310e77d58e153b2f50c8d2080f6
+  data.tar.gz: 7e951849c7ddc3da52f234959c7d598fe027445d1f7931e40f170937313993449b1247abef2abc27acbb1efbdfac246dc67e62b5cc68dbf6c5af4230da30f315

data/CONTRIBUTING.md

@@ -1,37 +1,23 @@
-TODO: UPDATE THIS!
+# Contributing
 
-## Development
+Instructions for contributing to [plaid-ruby][1]. A ruby client library for the [Plaid API][2]. This library is fully generated from the [Plaid OpenAPI spec](3).
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Setup
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+1. Run `make pull-openapi`.
+2. Install [Docker](https://docs.docker.com/desktop/) if you do not have it on your machine, this helps to isolate any dependency issues.
+3. Run `make build-openapi` after you have finished your Docker setup. This generates all the code necessary to run the library.
 
-## Running tests
+If you find an issue, please investigate whether it is a type problem with [OpenAPI](3) or a problem with the [ruby faraday](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/ruby.md) generator. Then open an issue and Plaid will investigate further.
 
-The gem test suite can be run in two modes. By default, it runs against the
-live sandbox environment, creating items on the fly and calling various API
-endpoints for them. For this to work you'll need real `client_id` and `secret`
-from your Plaid dashboard. Create a file named `.env` based on `.env.sample`
-which is provided:
+## Running Tests
 
-```text
-PLAID_RUBY_CLIENT_ID=the_real_client_id
-PLAID_RUBY_SECRET=the_real_secret
-```
-This file will be loaded during the tests.
+1. To build the docker image for the client tests, run `docker build -t plaid-ruby .`.
+2. Go to the [Plaid Dashboard](https://dashboard.plaid.com/) and copy and paste your `client_id` and sandbox `secret` into the following command.
+3. Run `docker run --rm -e PLAID_RUBY_CLIENT_ID=$CLIENT_ID -e PLAID_RUBY_SECRET=$SECRET plaid-ruby`.
 
-## Contributing
+If you wish to run a single test, edit the `Rakefile` and rebuild the docker image using the command from step 1.
 
-1.  Make one or more atomic commits, and ensure that each commit has a
-    descriptive commit message. Commit messages should be line wrapped
-    at 72 characters.
-
-2.  Make sure that there are tests for the code you wrote.
-
-3.  Make sure that you've documented all public methods using [TomDoc](http://tomdoc.org/).
-
-4.  Run tests (in both modes, see above) and address any errors. Preferably,
-    fix commits in place using `git rebase` or `git commit --amend` to make the
-    changes easier to review.
-
-5.  Open a pull request.
+[1]: https://github.com/plaid/plaid-ruby
+[2]: https://plaid.com
+[3]: https://github.com/plaid/plaid-openapi

data/Dockerfile

@@ -6,6 +6,7 @@ WORKDIR /usr/src/app
 # Copy app to directory
 COPY . /usr/src/app
 
+RUN gem install bundler:2.2.9
 RUN bundle install
 
 CMD ["bundle", "exec", "rake", "test"]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (14.0.0.beta.1)
+    plaid (14.0.0.beta.2)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM

data/Makefile

@@ -0,0 +1,21 @@
+CURRENT_DIR:=$(shell pwd)
+OPENAPI_FILE:=2020-09-14.yml
+# Theres a bug in 5.0.1 for ruby generation. https://github.com/OpenAPITools/openapi-generator/issues/8677
+OPENAPI_GENERATOR_5:=docker run --rm -v $(CURRENT_DIR):/local openapitools/openapi-generator-cli:v5.0.0 generate
+OPENAPI_VERSION:=1.5.0-beta
+# Ruby embeds the version in the generator where as others dont os its not possible to cat for it.
+RUBY_PACKAGE_VERSION="14.0.0.beta.2"
+
+.PHONY: pull-openapi
+pull-openapi:
+	curl https://raw.githubusercontent.com/plaid/plaid-openapi/$(OPENAPI_VERSION)/$(OPENAPI_FILE) --output $(CURRENT_DIR)/$(OPENAPI_FILE)
+
+.PHONY: build-openapi
+build-openapi:
+	$(OPENAPI_GENERATOR_5) -g ruby  \
+	-i local/$(OPENAPI_FILE) \
+	-o local/ \
+	--global-property=apiTests=false,modelTests=false  \
+	--library=faraday \
+	-p gemName=plaid,gemRequiredRubyVersion=">= 2.7.1",gemVersion=$(RUBY_PACKAGE_VERSION) \
+	-t local/templates/ruby

data/PUBLISH.md

@@ -4,16 +4,17 @@ The module is published to [RubyGems][1] under the gem name [plaid][2].
 
 Prepare release:
 
-1. update `lib/plaid/version.rb`, and `CHANGELOG.md` files.
-2. run `bundle` to bump the version in `Gemfile.lock`
-3. create and merge a PR with the changes from 1 and 2.
-4. authenticate with rubygems with `gem signin` or manually set up your `~/.gem/credentials`
+1. Update `Makefile -> RUBY_PACKAGE_VERSION`, and `CHANGELOG.md` files.
+2. Run `bundle` to bump the version in `Gemfile.lock`.
+3. Create and merge a PR with the changes from 1 and 2.
+4. Authenticate with rubygems with `gem signin` or manually set up your `~/.gem/credentials`.
 
 Publish:
 
 1. `git checkout master` and `git pull` (makes sure your `HEAD` is up-to-date).
-2. Check that tests are passing on latest `master` build and (optional) `bundle exec rake test` to run tests locally
-3. `bundle exec rake release` (builds the gem, creates a tag, pushes the gem to RubyGems and tag to GitHub). **NOTE:** if this step hangs indefinitely, you need to set your MFA settings to "UI Only" [here](https://rubygems.org/profile/edit)
+2. Run `make pull-openapi` and `make build-openapi`.
+3. Check that tests are passing on latest `master` build and (optional) `docker build -t plaid-ruby . && docker run -e PLAID_RUBY_CLIENT_ID=$(CLIENT_ID) -e PLAID_RUBY_SECRET=$(SECRET) plaid-ruby)` run tests locally.
+4. `bundle exec rake release` (builds the gem, creates a tag, pushes the gem to RubyGems and tag to GitHub). **NOTE:** if this step hangs indefinitely, you need to set your MFA settings to "UI Only" [here](https://rubygems.org/profile/edit).
 
 [1]: https://rubygems.org/
 [2]: https://rubygems.org/gems/plaid

data/docs/AccountBalance.md

@@ -5,7 +5,7 @@
 | 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`. |  |
+| **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, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.  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] |

data/docs/LinkTokenCreateRequest.md

@@ -8,11 +8,11 @@
 | **secret** | **String** | Your Plaid API `secret`. | [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. Note that if you initialize with a European country code, your users will see the European consent panel during the Link flow. 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.  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 optional Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `['US']`. |  |
+| **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 initialization and will automatically be initialized when any other product is initialized. Only institutions that support *all* requested products will be shown in Link.  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] |
+| **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 or (optionally) when initializing Link as part of the Payment Initiation (Europe) flow. | [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] |

data/docs/MortgageLiability.md

@@ -13,7 +13,7 @@
 | **interest_rate** | [**MortgageInterestRate**](MortgageInterestRate.md) |  | [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] |
-| **loan_type_description** | **String** | Type of mortgage (i.e. `conventional`, `fixed`, `variable`). | [optional] |
+| **loan_type_description** | **String** | Description of the type of loan, for example `conventional`, `fixed`, or `variable`. This field is provided directly from the loan servicer and does not have an enumerated set of possible values. | [optional] |
 | **loan_term** | **String** | Full duration of mortgage as at origination (e.g. `10 year`). | [optional] |
 | **maturity_date** | **String** | Original date on which mortgage is due in full. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
 | **next_monthly_payment** | **Float** | The amount of the next payment. | [optional] |

data/docs/PaymentInitiationPaymentGetResponse.md

@@ -12,6 +12,7 @@
 | **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] |
+| **adjusted_reference** | **String** |  | [optional] |
 
 ## Example
 
@@ -26,7 +27,8 @@ instance = Plaid::PaymentInitiationPaymentGetResponse.new(
   recipient_id: null,
   reference: null,
   last_status_update: null,
-  schedule: null
+  schedule: null,
+  adjusted_reference: null
 )
 ```
 

data/docs/PlaidApi.md

@@ -3556,7 +3556,7 @@ end
 
 Retrieve Liabilities data
 
-The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities is supported for US and Canada accounts only. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filter` parameter when [creating a Link token](/docs/api/tokens/#linktokencreate).  The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.  Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
+The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filter` parameter when [creating a Link token](/docs/api/tokens/#linktokencreate).  The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.  Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
 
 ### Examples
 

data/docs/ProcessorTokenCreateRequest.md

@@ -8,7 +8,7 @@
 | **secret** | **String** | Your Plaid API `secret`. | [optional] |
 | **access_token** | **String** | The access token associated with the Item data is being requested for. |  |
 | **account_id** | **String** | The `account_id` value obtained from the `onSuccess` callback in Link |  |
-| **processor** | **String** | The processor you are integrating with. Valid values are `\"achq\"`, `\"checkbook\"`, `\"circle\"`, `\"drivewealth\"`, `\"dwolla\"`, `\"galileo\"`, \"`interactive_brokers`\", `\"modern_treasury\"`, `\"ocrolus\"`, `\"prime_trust\"`, `\"velox\"`, `\"vesta\"`, `\"vopay\"` |  |
+| **processor** | **String** | The processor you are integrating with. Valid values are `\"achq\"`, `\"check\"`, `\"checkbook\"`, `\"circle\"`, `\"drivewealth\"`, `\"dwolla\"`, `\"galileo\"`, \"`interactive_brokers`\", `\"modern_treasury\"`, `\"ocrolus\"`, `\"prime_trust\"`, `\"rize\"`, `\"sila_money\"`, `\"unit\"`, `\"velox\"`, `\"vesta\"`, `\"vopay\"`, `\"wyre\"` |  |
 
 ## Example
 

data/lib/plaid.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/api/plaid_api.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0
@@ -2795,7 +2795,7 @@ module Plaid
     end
 
     # Retrieve Liabilities data
-    # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities is supported for US and Canada accounts only. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filter` parameter when [creating a Link token](/docs/api/tokens/#linktokencreate).  The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.  Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
+    # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filter` parameter when [creating a Link token](/docs/api/tokens/#linktokencreate).  The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.  Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
     # @param liabilities_get_request [LiabilitiesGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiabilitiesGetResponse]
@@ -2805,7 +2805,7 @@ module Plaid
     end
 
     # Retrieve Liabilities data
-    # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities is supported for US and Canada accounts only. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filter` parameter when [creating a Link token](/docs/api/tokens/#linktokencreate).  The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.  Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
+    # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filter` parameter when [creating a Link token](/docs/api/tokens/#linktokencreate).  The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.  Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
     # @param liabilities_get_request [LiabilitiesGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers

data/lib/plaid/api_client.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/api_error.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/configuration.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/account_assets.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/account_assets_all_of.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/account_balance.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0
@@ -19,7 +19,7 @@ module Plaid
     # 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`.
     attr_accessor :available
 
-    # 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`.
+    # 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, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.  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`.
     attr_accessor :current
 
     # 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.

data/lib/plaid/models/account_base.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/account_filters_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/account_identity.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/account_identity_all_of.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/account_subtype.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/account_type.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/accounts_balance_get_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/accounts_balance_get_request_options.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/accounts_get_request.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/accounts_get_request_options.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/accounts_get_response.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/ach_class.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0

data/lib/plaid/models/address.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.5.0
+The version of the OpenAPI document: 2020-09-14_1.5.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.0.0