RubyGems - plaid - Versions diffs - 28.0.0 → 30.0.0 - Mend

plaid 28.0.0 → 30.0.0

Files changed (1584) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a47e3154e4fdde76edba57b64b298f02a15745c34ba09c23a3c06041a67fbb80
-  data.tar.gz: 357a205f3b38c92e9358ae96c0ed441f355df4590cdc545f99874aad5048107e
+  metadata.gz: 67fba6112d49bd324d89d7d5a2f46a6d5f2c0bfecf27d773f55643529c50d3d1
+  data.tar.gz: d4791e65fa7a21cda4b8352c2ab6acf0d0c21bdc4869ac264e9803e1a1b91d7a
 SHA512:
-  metadata.gz: 4cb7d5d02dc7660c480b010a224a0ef7c7706460191f403ca79046dd5512ff46a10d9786bbec168f61bc4020caaefbcbbf7668c912a588ad0b44da5143454bc4
-  data.tar.gz: 8b56b64351186d36325deffd604726186832580e11e3fdb3118fc2dab94dd719db9b85b9e3be63a0f62095af7ce75d752b81ab309518e4c2cbffa31664bf9bd6
+  metadata.gz: fd816baec44255b9e08938ea452f40fe80481d9383fee6f6e0bcc781d8135c1a14d9b64c280db75c9115542d0266041dee8b77c6d3b60451c0b7f70697b3c6cc
+  data.tar.gz: 68e3939932591cc95f83ecdceb7aa9941c19fd882b042efd36e0b1f2c1f0801cadd55319b3f4bc2be21be0046e80252c635dd140c3b5cc852346b0291e5820bc

data/CHANGELOG.md CHANGED Viewed

@@ -1,4 +1,199 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
+# 30.0.0
+- Updating to OAS 2020-09-14_1.534.3
+## Breaking changes in this version
+### 2020-09-14_1.532.2
+- [Breaking] Rename `/cra/check_report/network_attributes/get` to `/cra/check_report/network_insights/get`
+### 2020-09-14_1.528.0
+- [Breaking] Renamed `/user_account/session/get` operationId `sessionGet` to `userAccountSessionGet` for consistency with existing API naming scheme.
+### 2020-09-14_1.527.0
+- [Breaking] Removed `development.plaid.com` as a valid server and updated docs to remove references to Development, due to the decomissioning of the Development environment
+### 2020-09-14_1.526.0
+- [Breaking] Renamed `/user_account/session/get` operationId `sessionGet` to `userAccountSessionGet` for consistency with existing API naming scheme.
+## OpenAPI Schema Changes
+### 2020-09-14_1.534.3
+- Add 'Beacon' to product enum list and make available in `/link/token/create` products
+### 2020-09-14_1.534.2
+- Mark some `BaseReportAccountInsights` fields as optional.
+### 2020-09-14_1.534.1
+- Internal changes only
+### 2020-09-14_1.533.1
+- Add `user_action_required` to transfer authorization's `decision` enum.
+- Add `authorization_id` to transfer object in `/link/token/create` request.
+### 2020-09-14_1.533.0
+- Made `user` request field optional in `beacon/user/update`
+### 2020-09-14_1.532.4
+- fix `/cra/check_report/pdf/get` external doc url
+### 2020-09-14_1.532.3
+- Docs updates
+### 2020-09-14_1.532.2
+- [Breaking] Rename `/cra/check_report/network_attributes/get` to `/cra/check_report/network_insights/get`
+### 2020-09-14_1.532.1
+- Internal changes only
+### 2020-09-14_1.531.1
+- Update idempotency key expiration time to 48 hours in `virtual-accounts/#wallet-transaction-execute-request-idempotency-key`
+### 2020-09-14_1.531.0
+- Add `balance_plus` to `products` in `LinkTokenCreateRequest`
+- Add `balance_plus` to `additional_consented_products` in `LinkTokenCreateRequest`
+### 2020-09-14_1.530.0
+- Add `/user/remove` endpoint
+### 2020-09-14_1.529.0
+- Added `/sandbox/user/reset_login` endpoint
+### 2020-09-14_1.528.0
+- Added `beacon/user/account_insights/get` endpoint
+- Updated `description`field for `access_tokens` in `beacon/user/create` and `beacon/user/update` requests
+- [Breaking] Renamed `/user_account/session/get` operationId `sessionGet` to `userAccountSessionGet` for consistency with existing API naming scheme.
+### 2020-09-14_1.527.0
+- [Breaking] Removed `development.plaid.com` as a valid server and updated docs to remove references to Development, due to the decomissioning of the Development environment
+### 2020-09-14_1.526.0
+- [Breaking] Renamed `/user_account/session/get` operationId `sessionGet` to `userAccountSessionGet` for consistency with existing API naming scheme.
+# 29.0.0
+- Updating to OAS 2020-09-14_1.525.1
+## Breaking changes in this version
+### 2020-09-14_1.525.1
+[Breaking] Renamed `bank_income` to `report` in the `cra/check_report/income_insights/get` response
+### 2020-09-14_1.520.0
+- [Breaking] Contains fixes to Balance Plus (beta):
+  - [Breaking] Convert `risk_level` string to an enum object `RiskLevel`.
+  - [Breaking] Adds missing `required` labels
+## OpenAPI Schema Changes
+### 2020-09-14_1.525.1
+[Breaking] Renamed `bank_income` to `report` in the `cra/check_report/income_insights/get` response
+### 2020-09-14_1.524.1
+- Remove `minLength` validations from several attributes. Fixes multiple validation bugs in the ruby client libraries which do not handle `nil` gracefully before this change.
+### 2020-09-14_1.524.0
+- Add transfer refund event types to TransferEventType enum.
+### 2020-09-14_1.523.0
+- Added support for the `layer` product.
+### 2020-09-14_1.522.0
+- Added support for the `/user_account/session/get` API.
+### 2020-09-14_1.521.0
+- Internal changes only
+### 2020-09-14_1.520.0
+- [Breaking] Contains fixes to Balance Plus (beta):
+  - [Breaking] Convert `risk_level` string to an enum object `RiskLevel`.
+  - [Breaking] Adds missing `required` labels to certain fields within `BalancePlusAttributes`, `AccountsBalanceGetResponsePaymentRiskAssessment`, `AccountsBalanceGetRequestPaymentDetails`, and `RiskReason`.
+  - Adds missing `additionalProperties` field to `BalancePlusAttributes`
+  - Fix incorrect response example for Balance Plus
+  - Docs updates for Balance Plus
+### 2020-09-14_1.519.0
+- Add `rtp` to network options in `/transfer/intent/create`
+- Added `access_tokens` field to `/beacon/user/create` and `/beacon/user/update` requests
+- Added `item_ids` to `/beacon/user/*` responses
+### 2020-09-14_1.518.9
+- Update `description` field for `decision_rationale` in `transfer/authorization/create` response
+### 2020-09-14_1.518.8
+- Fix incorrect documentation for ENTITY_SCREENING: STATUS_UPDATED webhook which wrongly documented `screening_id` instead of `entity_screening_id` in the payload.
+### 2020-09-14_1.518.7
+- Internal changes only
+### 2020-09-14_1.518.6
+- Add `add_ons` in cra/check_report/pdf/get
+### 2020-09-14_1.518.5
+- Internal changes only
+### 2020-09-14_1.518.4
+- Add `Recall` as a possible Virtual Account wallet transaction type
+### 2020-09-14_1.518.3
+- Internal changes only
+### 2020-09-14_1.518.2
+- Documentation edits to cra endpoints
+- Add `income-sensitive repayment` to StudentRepaymentPlan and update description for repayment plan type
+### 2020-09-14_1.518.1
+- Documentation edits to cra endpoints
+- Add item, account, and transaction IDs to `/cra/base_report/get` response
+### 2020-09-14_1.518.0
+- Add several cra related properties to `/user/create` and `/link/token/create`
+### 2020-09-14_1.517.7
+- Add `cra/check_report/pdf/get` endpoint
+### 2020-09-14_1.517.6
+- Add `cra/check_report/base_report/get` endpoint
+### 2020-09-14_1.517.5
+- Add `error_message` to `document_metadata` object for `credit/payroll_income/get` and `credit/bank_statements/uploads/get`
+### 2020-09-14_1.517.4
+- Add `production` to the `secrets` object in `/partner/customer/create` response and deprecate `development`
+### 2020-09-14_1.517.3
+- Add new enums to `canonical_description` in `credit/payroll_income/get`: `RETIREMENT`, `GIG ECONOMY`, and `STOCK COMPENSATION`
+### 2020-09-14_1.517.2
+- Added `ITEM: EVENTS` webhook and example to documentation
+### 2020-09-14_1.517.1
+- Added `public_tokens` on `SESSION_FINISHED` webhook
+- Deprecated `public_token` on `SESSION_FINISHED` webhook
+- Added `ITEM_ADD_RESULT` webhook
 # 28.0.0
 - Updating to OAS 2020-09-14_1.517.0

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (28.0.0)
+    plaid (30.0.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (>= 1.0.1, < 2.0)
@@ -11,7 +11,7 @@ GEM
     ast (2.4.1)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    faraday (2.9.0)
+    faraday (2.9.2)
       faraday-net_http (>= 2.0, < 3.2)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)

data/Makefile CHANGED Viewed

@@ -1,5 +1,5 @@
 # Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
-RUBY_PACKAGE_VERSION=28.0.0
+RUBY_PACKAGE_VERSION=30.0.0
 .PHONY: release
 release:

data/README.md CHANGED Viewed

@@ -4,18 +4,18 @@ The official Ruby bindings for the [Plaid API](https://plaid.com/docs). It's gen
 ## Table of Contents
-* [Installation](#installation)
-* [Versioning](#versioning)
-* [Getting Started](#getting-started)
-  + [Create a client](#create-a-client)
-  + [Tuning Faraday](#tuning-faraday)
-  + [Dates](#dates)
-* [Examples](#examples)
-* [Errors](#errors)
-* [Response objects](#response-objects)
-* [Migration Guide](#migration-guide)
-* [Contributing](#contributing)
-* [License](#license)
+- [Installation](#installation)
+- [Versioning](#versioning)
+- [Getting Started](#getting-started)
+  - [Create a client](#create-a-client)
+  - [Tuning Faraday](#tuning-faraday)
+  - [Dates](#dates)
+- [Examples](#examples)
+- [Errors](#errors)
+- [Response objects](#response-objects)
+- [Migration Guide](#migration-guide)
+- [Contributing](#contributing)
+- [License](#license)
 ## Installation
@@ -37,22 +37,21 @@ The gem supports Ruby 3.0.0+ only.
 ### Versioning
-Versions > 14 are generated from our OpenAPI schema.
+Versions > 14 are generated from our OpenAPI schema.
 Each major version of `plaid-ruby` targets a specific version of the Plaid API:
-| API version | plaid-ruby release |
-| ----------- | ------------------ |
-| [`2020-09-14`][api-version-2020-09-14] (**latest**) | `12.x.x` and higher |
-| [`2019-05-29`][api-version-2019-05-29] | `11.x.x`, `10.x.x`, `9.x.x`, `8.x.x`, `7.x.x` |
-| [`2018-05-22`][api-version-2018-05-22] | `6.x.x` |
-| `2017-03-08` | `5.x.x` |
+| API version                                         | plaid-ruby release                            |
+| --------------------------------------------------- | --------------------------------------------- |
+| [`2020-09-14`][api-version-2020-09-14] (**latest**) | `12.x.x` and higher                           |
+| [`2019-05-29`][api-version-2019-05-29]              | `11.x.x`, `10.x.x`, `9.x.x`, `8.x.x`, `7.x.x` |
+| [`2018-05-22`][api-version-2018-05-22]              | `6.x.x`                                       |
+| `2017-03-08`                                        | `5.x.x`                                       |
 For information about what has changed between versions and how to update your integration, head to the [version changelog][version-changelog].
 The plaid-ruby client library is typically updated on a monthly basis. The canonical source for the latest version number is the [client library changelog](https://github.com/plaid/plaid-ruby/blob/master/CHANGELOG.md). New versions are published as [GitHub tags](https://github.com/plaid/plaid-ruby/tags), not as Releases. New versions are also published on [RubyGems.org](https://rubygems.org/gems/plaid/).
 All users are strongly recommended to use a recent version of the library, as older versions do not contain support for new endpoints and fields. For more details, see the [Migration Guide](#migration-guide).
 ## Getting started
@@ -76,11 +75,10 @@ api_client = Plaid::ApiClient.new(
 client = Plaid::PlaidApi.new(api_client)
 ```
-The `server_index` field is the environment which the client will be running in. Your choices for the `server_index` field include:
+The `server_index` field is the environment which the client will be running in. Your choices for the `server_index` field are:
-- `Plaid::Configuration::Environment["sandbox"]` allows you to do your initial integrations tests against preloaded data without being billed or making expensive API calls. More information about using the API sandbox can be found on the [API Sandbox documentation](https://plaid.com/docs/api#sandbox).
-- `Plaid::Configuration::Environment["development"]` allows you to test against both real and test accounts without being billed. More information about Plaid test accounts can be found in our [API documentation](https://plaid.com/docs/api/#sandbox).
-- `Plaid::Configuration::Environment["production"]` is the production environment where you can launch your production ready application and be charged for your Plaid usage.
+- `Plaid::Configuration::Environment["sandbox"]` allows you to do your initial integrations tests against preloaded data without being billed. More information about using the API sandbox can be found on the [API Sandbox documentation](https://plaid.com/docs/api#sandbox).
+- `Plaid::Configuration::Environment["production"]` is the production environment where you can test with real data and launch.
 ### Tuning Faraday
@@ -95,6 +93,7 @@ api_client.connection.options[:timeout] = 60*20 # 20 minutes
 ```
 To use custom middleware, reinitialize the Faraday::Connection object:
 ```
 configuration = Plaid::Configuration.new
 api_client = Plaid::ApiClient.new(configuration)
@@ -105,7 +104,7 @@ end
 ### Dates
-Dates and datetimes in requests, which are represented as strings in the API and previous versions of the client library, are represented in this version of the Ruby client library as Ruby `Date` or `DateTime` objects.
+Dates and datetimes in requests, which are represented as strings in the API and previous versions of the client library, are represented in this version of the Ruby client library as Ruby `Date` or `DateTime` objects.
 Time zone information is required for request fields that accept datetimes. Failing to include time zone information (or passing in a string, instead of a `Date` or `DateTime` object) will result in an error. See the following examples for guidance on `Date` and `DateTime` usage.
@@ -132,7 +131,6 @@ a = Time.parse("2022-05-06T22:35:49Z").to_datetime
 b = Date.parse("2022-05-06T22:35:49Z").to_datetime
 ```
 ## Examples
 For more examples, see the [test suites](https://github.com/plaid/plaid-ruby/tree/master/test), [Quickstart](https://github.com/plaid/quickstart/tree/master/ruby), or [API Reference documentation](https://plaid.com/docs/api/).
@@ -193,6 +191,7 @@ client.item_remove(item_remove_request)
 ```
 ### Get paginated transactions (preferred method)
 ```ruby
 request = Plaid::ItemPublicTokenExchangeRequest.new
 request.public_token = public_token
@@ -219,6 +218,7 @@ end
 ```
 ### Get paginated transactions (older method)
 ```ruby
 request = Plaid::ItemPublicTokenExchangeRequest.new
 request.public_token = public_token
@@ -297,7 +297,6 @@ All API calls return a response object that is accessible only with dot notation
 (i.e., `response.foo.bar`) and not with bracket notation. Expected keys for all types of responses are defined,
 and any attempt to access an unknown key will cause `NoMethodError` exception.
 ## Migration guide
 ### 14.0.0 or later to latest
@@ -308,9 +307,10 @@ Migrating from a version released on or after August 2021 to a recent version sh
 Version 14.0.0 of the client library was released in August 2021 and contains multiple interface changes, as described below.
 #### Client initialization
 From:
 ```ruby
 client = Plaid::Client.new(env: :sandbox,
                             client_id: client_id,
@@ -318,6 +318,7 @@ client = Plaid::Client.new(env: :sandbox,
 ```
 To:
 ```ruby
 configuration = Plaid::Configuration.new
 configuration.server_index = Plaid::Configuration::Environment["sandbox"]
@@ -333,14 +334,17 @@ client = Plaid::PlaidApi.new(api_client)
 ```
 #### Endpoints
 All endpoint requests now take a request model and the functions have been renamed to include `_`.
 From:
 ```ruby
 response = client.auth.get(access_token)
 ```
 To:
 ```ruby
 auth_get_request = Plaid::AuthGetRequest.new
 auth_get_request.access_token = access_token
@@ -355,6 +359,7 @@ response = client.auth_get(auth_get_request)
 #### Errors
 From:
 ```ruby
 begin
   client.auth.get(auth_get_request)
@@ -365,6 +370,7 @@ end
 ```
 To:
 ```ruby
 begin
   client.auth_get(auth_get_request)
@@ -374,12 +380,10 @@ rescue Plaid::ApiError => e
 end
 ```
 #### Date type differences
 See [Dates](#dates) for information on updates to date formats.
 ## Contributing
 Bug reports are welcome on GitHub. See also [contributing guidelines](CONTRIBUTING.md).