RubyGems - plaid - Versions diffs - 29.0.0 → 31.0.0 - Mend

plaid 29.0.0 → 31.0.0

Files changed (1645) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 605c730869b6db93fa4b04fc9a4e0daf6baeb0b913424cbb586717aacc40e361
-  data.tar.gz: 9f4cf9f231339f8996123e5112c528d641fee47b07cd50d1b742720a78dc1c65
+  metadata.gz: 12f918312c6b7a5872318f0aab38f6b82baaf76334d470277a5a77e4102ef09d
+  data.tar.gz: 991dd969c0ad6fc0eb4307d398b9a64e349e1200b7d0e4270e2118f5c41b5b15
 SHA512:
-  metadata.gz: 24d38a6c273166819b18dedd467e081ce55d9e175649fe479d9e522bafe6170b2e27d3ac0781392c58fccd39f7603a284b528613a6fff73cd54702e33adbec39
-  data.tar.gz: aadfb478cfa0cdc4aebaa001c4e04041b00ef04f4893cef5fc35ae1a51185a79a2240db6a47c38f2bc75f26a07e206071e40362475009d1f3b13817965bd6d0c
+  metadata.gz: ef4d819f3b4f17af1142c97171c11f7060b7569f45f7b8ca4aa0f75c63dc572b7aa44bc6869197c766a5fbb65a84c62e899cfafb2b6a7c44dc442f68b81a00e4
+  data.tar.gz: e9f74dbc662f0199db87e219947a10443698ce424554d046b62b7a59a4e1304b38d52b16766a7f1d07f95698fd2598db305d7d21d7682daaa0e74a490e4f6d47

data/CHANGELOG.md CHANGED Viewed

@@ -1,8 +1,244 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
+# 31.0.0
+- Updating to OAS 2020-09-14_1.556.0
+## Breaking changes in this version
+### 2020-09-14_1.548.0
+- [BREAKING] Changed fields of `CraMonitoringGetResponse` to be simple `objects` instead of `arrays`
+- [BREAKING] Moved `income_sources` to the `income` module in the response
+### 2020-09-14_1.545.0
+- [BREAKING] Rename network attributes to network insights in the `cra/check_report/network_insights/get` schemas
+### 2020-09-14_1.543.2
+- [Breaking] Added `data_breach` report type to BeaconReport response object
+### 2020-09-14_1.540.2
+- [Breaking] Updated `document_status` field in `identity/document/upload` to include parsing_type
+## OpenAPI Schema Changes
+### 2020-09-14_1.556.0
+- Added plural named array fields to `BaseReportAccountInsights` in  /cra/base_report/get
+### 2020-09-14_1.555.0
+- Add `require_all_items` field to /asset_report/create
+### 2020-09-14_1.554.0
+- Add `sector` and `industry` properties to the `Security` model.
+### 2020-09-14_1.553.0
+- Add `ISSUE_RESOLVED` webhook
+### 2020-09-14_1.552.0
+- Add `ytd_amount` to `PaystubOverrideEarningsTotal` in /credit/payroll_income/get
+### 2020-09-14_1.551.0
+- Internal changes only
+### 2020-09-14_1.550.0
+- Add `/fdx/recipient` and `/fdx/recipients` endpoints
+### 2020-09-14_1.549.0
+- Made fields required instead of omitempty for CRA Income Insights Transactions
+### 2020-09-14_1.548.4
+- Set CreditAmountWithCurrency fields as required
+### 2020-09-14_1.548.3
+- Added missing `LOGIN_REPAIRED` enum value to possible webhook codes for `/sandbox/item/fire_webhook` request in order to match endpoint description.
+### 2020-09-14_1.548.2
+- [BREAKING] Moved `forecasted_monthly_income` to be a level higher.
+### 2020-09-14_1.548.1
+- Made the fields in account_insights array fields as required.
+### 2020-09-14_1.548.0
+- [BREAKING] Changed fields of `CraMonitoringGetResponse` to be simple `objects` instead of `arrays`
+- [BREAKING] Moved `income_sources` to the `income` module in the response
+### 2020-09-14_1.547.2
+- Add `cra_item_add_results` field to `results` object in `/link/token/get` response.
+### 2020-09-14_1.547.1
+- Increase `/wallet/transactions/list` cursor size to 1024 characters.
+### 2020-09-14_1.547.0
+- Add `ledger_id` to the request and response of a number of transfer endpoints.
+### 2020-09-14_1.546.0
+- Added `WalletTransactionRelation` object.
+- Added `related_transactions` field to WalletTransaction object.
+### 2020-09-14_1.545.3
+- Some description updates to CRA Base Report fields
+### 2020-09-14_1.545.2
+- Updated phone number examples in Identity Verification endpoints.
+### 2020-09-14_1.545.1
+- Add `update.item_ids` field to `/link/token/create` request.
+### 2020-09-14_1.545.0
+- [BREAKING] Rename network attributes to network insights in the `cra/check_report/network_insights/get` schemas
+### 2020-09-14_1.544.0
+- Added `is_shareable` field to the `/identity_verification/retry` endpoint
+### 2020-09-14_1.543.2
+- [Breaking] Added `data_breach` report type to BeaconReport response object
+### 2020-09-14_1.543.1
+- Added `consumer_statement` field to `Account` in `BaseReport`
+- make `warnings` for BaseReportGetResponse required
+### 2020-09-14_1.543.0
+- Add `/network_insights/report/get`
+### 2020-09-14_1.542.0
+- Added `error_code_reason` field to plaidError
+### 2020-09-14_1.541.1
+- Add `update.user` field to `/link/token/create` request.
+### 2020-09-14_1.541.0
+- (pre-release) Add `reauthorization_enabled` field to /link/token/create request
+### 2020-09-14_1.540.2
+- [Breaking] Updated `document_status` field in `identity/document/upload` to include parsing_type
+### 2020-09-14_1.540.1
+- Added `MonitoringInsightsWebhook`
+- Added `webhook` field in `cra/monitoring_insights/subscribe`
+### 2020-09-14_1.540.0
+- Added `file_type` field to `/credit/payroll_income/risk_signals/get`
+### 2020-09-14_1.539.0
+- Add `authorization_usage` field to the `transfer/metrics/get` response
+### 2020-09-14_1.538.0
+- Added cra/monitoring_insights/subscribe
+- Added cra/monitoring_insights/unsubscribe
+- Added cra/monitoring_insights/get
+### 2020-09-14_1.537.0
+- Added depository_accounts to Beacon
+- Added event_date to BeaconReports
+### 2020-09-14_1.536.0
+- Internal changes only
+### 2020-09-14_1.535.3
+- Added missing values to `PlaidErrorType` enum.
+### 2020-09-14_1.535.2
+- Make some `CraBankIncomeSummary` fields visible.
+-
+### 2020-09-14_1.535.1
+### 2020-09-14_1.535.0
+- [Breaking for Go] Updated `consumer_report_user_identity` field in `/user/update` to be required to reflect actual API behavior.
+### 2020-09-14_1.534.7
+- Add `stated_account_number_enabled` to `investments_auth` in `LinkTokenCreateRequest`
+### 2020-09-14_1.534.6
+- [Breaking] Updated base report endpoints and objects to include `cra` prefix
+### 2020-09-14_1.534.5
+- Add `enable_multi_item_link` field to `/link/token/create`
+### 2020-09-14_1.534.4
+- Undeprecate `/identity/match`'s `legal_name.is_business_name_detected`
+# 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

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (29.0.0)
+    plaid (31.0.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (>= 1.0.1, < 2.0)
@@ -11,12 +11,14 @@ GEM
     ast (2.4.1)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    faraday (2.9.2)
-      faraday-net_http (>= 2.0, < 3.2)
+    faraday (2.11.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      logger
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (3.1.0)
+    faraday-net_http (3.3.0)
       net-http
+    logger (1.6.1)
     minitest (5.14.2)
     minitest-around (0.5.0)
       minitest (~> 5.0)
@@ -56,7 +58,7 @@ GEM
       parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.7.0)
-    uri (0.13.0)
+    uri (0.13.1)
 PLATFORMS
   ruby

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=29.0.0
+RUBY_PACKAGE_VERSION=31.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).