plaid 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown → 15.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe0ca3d7b660a970cdad6e714a20e1c45df2f949cd3dd4e81df7f58d090e5c1
-  data.tar.gz: 0ad09461c6f6c3964980c0d2360d78371256add5088bb4420e862f0ac4b074b1
+  metadata.gz: 88ae578241b841997d3353e6f389b316fbbadadd8189d754f1cab2b430f182ae
+  data.tar.gz: efe301498dc7c82f7756bfd4cc1614097775b95252ac9dd0c66868b61cde5055
 SHA512:
-  metadata.gz: 323b881ddac6f9e2ba29dd97a27c9c102c464f8eb90f9f9e6dee20233b03fc0a9c32a554f2c8bcfce7eec74c7593be8f8abbca910f700d7b88183596e833df2b
-  data.tar.gz: f91dbede2c50b6115847241a268d869f521831ba81b6caf383b24d8f62bfa464f7e6a35a9f552ca3124927108550d9f8eaee44f667f85a5cb1bf2cc794c7eb2e
+  metadata.gz: 462c4623a2a4bfeadb2794597e0119a8ae31177585f66ea752386311aebdaeb9f786b2ac43fa8be534469e9ed6765e25405913dc7a5af728d1213f554ca64b0c
+  data.tar.gz: 000ff25b3cb65b4a798b4aafaeaa4482afa757566224d84fa6c3b13a995ea516586f871395a2da4273dd40d8b5a54929fc64357d4fa3148330a7be3ff647349c

data/CHANGELOG.md

@@ -1,6 +1,397 @@
-# 14.0.0.beta.5-plural-income-breakdown
-Manually change IncomeBreakdown to Array<IncomeBreakdown> in the Paystub class.
-*This change was not auto-generated and will only be available on this release and Gem versions >=14.1.0*
+See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
+
+# 15.3.0
+- Updating to OAS 2020-09-14_1.97.0
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.97.0
+- [Beta] Rename some `Credit` refs that were preventing client library generation from completing successfully
+
+### 2020-09-14_1.96.0
+- remove unused `payroll_income_id` from `/credit/payroll_income/get` field
+- add status object to items in `/credit/payroll_income/get` response body
+
+### 2020-09-14_1.95.1
+- Add `TransferEventsUpdateWebhook` schema
+
+### 2020-09-14_1.95.0
+- Add `institution_data` parameter to `/link/token/create`
+
+### 2020-09-14_1.94.2
+- Tidy up YAML
+
+### 2020-09-14_1.94.1
+- Add `highnote` processor to `/processor/token/create`
+
+# 15.2.0
+- Updating to OAS 2020-09-14_1.94.0
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.94.0
+- Add `use_case`, `company_legal_name`, `city`, `region`, `country_code`, `postal_code` as a required response field of `Application`
+
+### 2020-09-14_1.93.2
+- Remove `income_verification_id` from income webhook example
+- Fix incorrect URL for `/user/create` endpoint
+
+### 2020-09-14_1.93.1
+- Remove deprecated `income_verification_id` from income webhooks
+- Standardize income webhook casing
+
+### 2020-09-14_1.93.0
+- Add several new fields to `/signal/evaluate` response
+- 
+### 2020-09-14_1.92.4
+- Add `/sandbox/transfer/fire_webhook` endpoint
+
+### 2020-09-14_1.91.4
+- Mark certain Income endpoints as deprecated in favor of the new `/credit/*` endpoints.
+
+### 2020-09-14_1.91.3
+- Add `checkout` processor to `/processor/token/create`
+
+### 2020-09-14_1.91.2
+- Add `webhook_type` parameter to `/sandbox/item/fire_webhook`
+- Support for investments transactions, investments holdings and liabilities `DEFAULT_UPDATE` webhooks
+
+### 2020-09-14_1.90.2
+- Add new warning type to `/credit/bank_income/get` response
+
+### 2020-09-14_1.90.1
+- Add `marqeta` and `solid` as Auth processor partners
+- Fix schema of `cause` parameter for Asset Reports
+- Fix some invalid examples
+ 
+### 2020-09-14_1.90.0
+- Add `/credit/employment/get` endpoint
+- Add optional `access_tokens` array to `/credit/payroll_income/precheck` request
+
+### 2020-09-14_1.89.3
+- Update description of `/sandbox/item/fire_webhook`
+
+### 2020-09-14_1.89.2
+- Update description of `accounts/get`
+
+### 2020-09-14_1.89.1
+- Added `AUTH_DATA_UPDATE` webhook code as valid input to `/sandbox/item/fire_webhook`
+- Update description for `/sandbox/item/fire_webhook`
+
+### 2020-09-14_1.89.0
+- Add `/transfer/migrate_account` endpoint
+
+### 2020-09-14_1.88.2
+- Fix operationId for `/credit/payroll_income/precheck`
+
+### 2020-09-14_1.88.1
+- Remove deprecated fields from `/item/application/list`
+
+### 2020-09-14_1.88.0
+- Add `wire_routing_number` parameter to `/bank_transfer/migrate_account`
+
+### 2020-09-14_1.87.1
+- Specify minimum length of 1 for `description` on `TransferIntentCreateRequest`
+
+### 2020-09-14_1.87.0
+- Add `consent_id` support in the Institutions Search request
+
+### 2020-09-14_1.86.1
+- Add `apex_clearing` as a processor partner
+
+### 2020-09-14_1.86.0
+- Introduce Credit Payroll Income APIs
+- Introduce Credit Precheck API
+
+### 2020-09-14_1.85.1
+- Add `/identity_verification/create` endpoint, kept private for now
+
+### 2020-09-14_1.85.0
+- Add `status` field to `ConnectedApplication`
+
+# 15.1.0
+- Updating to OAS 2020-09-14_1.84.5
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.84.5
+- Added missing `asset_report_id` field to `/asset_report/relay/refresh`
+
+### 2020-09-14_1.84.4
+- Change summary description and url for `/credit/bank_income/get`
+
+### 2020-09-14_1.84.3
+- Slight wording change for `/credit/bank_income/get` response fields
+
+### 2020-09-14_1.84.3
+- Move `user_token` to top level of `link/token/create` request 
+
+### 2020-09-14_1.84.2
+- Correct typo in enum value for Investment subtypes (`person` -> `pension`)
+
+### 2020-09-14_1.84.1
+- Fix schema to properly handle personal finance categories in `/transactions/get`
+
+### 2020-09-14_1.84.0
+- Add `user_token` parameter to `link/token/create`
+
+### 2020-09-14_1.83.1
+- Add new fields to `/credit/bank_income/get` response
+
+### 2020-09-14_1.83.0
+- Remove `permitted` decision for `/transfer/authorization/create`
+
+### 2020-09-14_1.82.0
+- Add beta field `consented_products` to `/item/get/` endpoint response
+
+### 2020-09-14_1.82.0
+- Revamp LinkTokenCreate.IncomeVerificationOptions for GA
+
+### 2020-09-14_1.81.0
+- Add `/transaction/rules/create`, `/transaction/rules/list` and `/transaction/rules/remove` endpoints
+
+### 2020-09-14_1.80.0
+- Added `/user/create` endpoint
+
+# 15.0.0
+- Updating to OAS 2020-09-14_1.79.0
+
+## Breaking changes
+- Many enum fields have been de-anonymized and renamed, new names can be found in the `2020-09-14_1.64.15` change message
+- Non integer numbers are now `float64` fields
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.79.0
+- Update to include all changes up to `2020-09-14_1.77.4` (Undo revert from `1.78.x` updates)
+
+### 2020-09-14_1.77.4
+- Remove the word "Asset" before "Relay" in every asset report relay related responses and request objects
+
+### 2020-09-14_1.77.3
+- Add "AssetReport" at the beginning of relay related responses and request objects to match the same pattern as other assets related objects
+
+### 2020-09-14_1.77.2
+- Add `ProductAccess` fields for upcoming partner
+
+# 14.14.0
+- Updating to OAS 2020-09-14_1.78.2
+- Ruby library 14.13.0 was erroneously released as a `minor` version; 14.13.0 changes will be re-released as a `major` version shortly.
+
+# 14.13.0
+- Updating to OAS 2020-09-14_1.77.1
+
+# Breaking changes
+- Many enum fields have been de-anonymized and renamed, new names can be found in the `2020-09-14_1.64.15` change message
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.77.1
+- Fix extraneous field in enum that caused issue in code generation
+- Added `asset_report_id` to the example for `/asset_report/relay/refresh`
+
+### 2020-09-14_1.77.0
+- Explicitly set `format: double` for non-integer numbers so generated fields prefer float64
+
+### 2020-09-14_1.76.0
+- Add three new endpoints for Assets: `/asset_report/relay/create`, `/asset_report/relay/get`, and `/asset_report/relay/rmeove`
+
+### 2020-09-14_1.75.0
+- Added `/asset_report/relay/refresh` endpoint
+
+### 2020-09-14_1.74.0
+- Add `recurring_transactions` to list of products
+
+### 2020-09-14_1.73.0
+- Add new endpoint for `/credit/bank_income/get`
+
+### 2020-09-14_1.72.0
+- Updated documentation URLs for all product endpoints. They can now be found
+at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/#endpoint`
+
+### 2020-09-14_1.71.0
+- internal changes
+
+### 2020-09-14_1.70.0
+- Remove deprecated `income_verification_id` from `/sandbox/income/fire_webhook`
+
+### 2020-09-14_1.69.1
+- Reorder processors enum
+
+### 2020-09-14_1.69.0
+- Added `/beta/transactions/v1/enhance` endpoint
+
+### 2020-09-14_1.68.1
+- Added `status` object to sample responses for `/institutions/get` and `institutions/search` endpoints
+
+### 2020-09-14_1.68.0
+- Mark `include_personal_finance_category_beta` property as deprecated.
+- Add new argument `include_personal_finance_category` to TransactionsGetRequestOptions.
+- Update docs for `/transactions/get` request and response, referencing personal_finance_category taxonomy csv file.
+
+### 2020-09-14_1.67.1
+- internal changes
+
+### 2020-09-14_1.67.0
+- Removed unused `/income/verification/summary/get` endpoint
+
+### 2020-09-14_1.66.0
+- Added Payment Consent endpoints
+
+### 2020-09-14_1.65.0
+- Removed unused `/income/verification/paystub/get` endpoint
+
+### 2020-09-14_1.64.15
+- De-anonymized enums:
+  - `PaymentInitiationPaymentReverseResponse.properties.status` => `PaymentInitiationRefundStatus`
+  - `PaymentInitiationPaymentCreateResponse.properties.status` => `PaymentInitiationPaymentCreateStatus`
+  - `PaymentInitiationRefund.properties.status` => `PaymentInitiationRefundStatus`
+  - `PaymentAmount.properties.currency` => `PaymentAmountCurrency`
+  - `InvestmentTransaction.properties.type` => `InvestmentTransactionType`
+  - `InvestmentTransaction.properties.subtype` => `InvestmentTransactionSubtype`
+  - `TransferAuthorizationDecisionRationale.properties.code` => `TransferAuthorizationDecisionRationaleCode`
+  - `TransferAuthorizationGuaranteeDecisionRationale.properties.code` => `TransferAuthorizationGuaranteeDecisionRationaleCode`
+  - `TransferAuthorization.properties.decision` => `TransferAuthorizationDecision`
+  - `TransferEventListRequest.properties.transfer_type` => `TransferEventListTransferType`
+  - `BankTransferEventListRequest.properties.bank_transfer_type` => `BankTransferEventListBankTransferType`
+  - `BankTransferEventListRequest.properties.direction` => `BankTransferEventListDirection`
+  - `TransferIntentCreate.properties.status` => `TransferIntentStatus`
+  - `TransferIntentGet.properties.status` => `TransferIntentStatus`
+  - `TransferIntentGet.properties.authorization_decision` => `TransferIntentAuthorizationDecision`
+- `IncomeVerificationPrecheckMilitaryInfo.properties.branch` is now a string field (previously enum)
+
+### 2020-09-14_1.64.15
+- Made `last_statement_balance` and `minimum_payment_amount` `nullable` for credit card liabilities schema to reflect existing API behavior.
+
+### 2020-09-14_1.64.14
+- Made `last_payment_amount` and `last_statement_issue_date` `nullable` for credit card liabilities schema to reflect existing API behavior.
+- Fix transfers examples to reflect more consistent usage of `region` field.
+
+# 14.12.1
+- Updating to OAS 2020-09-14_1.64.13
+- Fix issue where library did not correctly detect if app is a Rails app.
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.64.13
+- Deprecate `idempotency_key` parameter in transfer/create
+
+### 2020-09-14_1.64.12
+- Removed the unused `required_product_access` and `optional_product_access` parameters from `RequestedScopes`
+
+### 2020-09-14_1.64.11
+- Fix some examples that were not consistent with their schemas
+- Add `adjustments` as an investments transaction type to make OpenAPI file consistent with values returned by the API
+- Clarify description field for `marital_status` to reflect possible values
+
+### 2020-09-14_1.64.10
+- Updated the external docs URL for Bank Transfers sandbox endpoints
+
+### 2020-09-14_1.64.9
+- De-anonymized the object filters under `LinkTokenCreateRequestAccountSubtypes`, as anonymous objects aren't compatible with the generated CLibs.
+- De-anonymized some misc. objects
+  - `PaymentInitiationMetadata/properties/maximum_payment_amount`
+  - `PaystubOverride/properties/employer`
+  - `PaystubOverride/properties/employee`
+  - `PaystubOverride/properties/employee/properties/address`
+  - `LiabilitiesDefaultUpdateWebhook/properties/account_ids_with_updated_liabilities`
+
+### 2020-09-14_1.64.8
+- Updated the description of the historical_balances array
+
+### 2020-09-14_1.64.7
+- Add new possible enums for income verification earnings breakdown canonical description
+
+### 2020-09-14_1.64.6
+- Hid a few product enum values that are deprecated or no longer valid for certain request fields. This affects the documentation only.
+
+### 2020-09-14_1.64.5
+- Make guarantee fields required in Transfer endpoints
+
+### 2020-09-14_1.64.4
+- Updated description for `failure_reason` field in Transfer endpoints
+
+### 2020-09-14_1.64.3
+- Make `repayment_id` required in `/transfer/repayment/return/list` endpoint
+
+### 2020-09-14_1.64.2
+- Update description for legal name field in `BankTransferUser` 
+
+### 2020-09-14_1.64.1
+- Update descriptions for `/transfer/repayment/list` and `/transfer/repayment/return/list` endpoints
+
+### 2020-09-14_1.64.0
+- Remove `scheme_automatic_downgrade` from `/payment_initiation/payment/create`
+
+### 2020-09-14_1.63.1
+- Update description for `/sandbox/transfer/sweep/simulate` endpoint
+
+### 2020-09-14_1.63.0
+- Refactor account subtype enums for greater specificity. This has no changes to the API but is a major semver change for Python, Node, Go, and Java client library interfaces to the AccountSubtype object within account filtering contexts in `/link/token/create`. The `AccountSubtype` namespace in this context is now prefixed with the AccountType. (Example for Node: Old: `AccountSubtype.checking` New: `DepositoryAccountSubtype.checking`)
+
+### 2020-09-14_1.62.7
+- Update description for `datetime` and `authorized_datetime` fields in Transactions endpoints
+
+### 2020-09-14_1.62.6
+- Make `sweep_id` / `sweep_amount` fields on Transfer Event nullable
+
+### 2020-09-14_1.62.6
+- Set `institution_status` to be nullable in `InstitutionsGetResponse`
+
+### 2020-09-14_1.62.5
+- Update external docs URLs for Transfer and Bank Transfer endpoints
+- Update description for `ach_return_code` field in Transfer endpoints
+
+### 2020-09-14_1.62.4
+- Add `join_date` to `/application/get` and `/item/application/list`
+- Remove `created_at` from `/application/get`
+
+### 2020-09-14_1.62.3
+- Updated various description fields for Income
+
+### 2020-09-14_1.62.2
+- Add `employment` as an available product in Product array.
+
+# 14.12.0
+- Updating to OAS 2020-09-14_1.62.1
+
+# 14.11.1
+- Added a release step to the `Makefile` to purge previously released version of plaid-ruby in the current release.
+
+# 14.11.0
+- Updating to OAS 2020-09-14_1.61.0
+
+# 14.10.0
+- Updating to OAS 2020-09-14_1.58.1
+
+# 14.9.0
+- Updating to OAS 2020-09-14_1.54.2
+
+# 14.8.0
+- Updating to OAS 2020-09-14_1.46.1
+
+# 14.7.0
+- Updating to OAS 2020-09-14_1.44.0
+
+# 14.6.0
+- Updating to OAS 2020-09-14_1.40.3
+
+# 14.5.0
+- Updating to OAS 2020-09-14_1.36.4
+
+# 14.4.0
+- Updating to OAS 2020-09-14_1.34.1
+- Fixed an issue with enums in this library. The library is supposed to be able to gracefully handle
+    new enum values being returned from endpoints. Previously, if there were new enum values
+    endpoint calls would fail.
+
+# 14.3.0
+Updating to OAS 2020-09-14_1.33.0.
+
+# 14.2.0
+Updating to OAS 2020-09-14_1.31.1.
+
+# 14.1.0
+Updating to OAS 2020-09-14_1.26.1.
+
+# 14.0.0
+The official release of the `plaid-ruby` generated library. Refer to the beta migration guide for tips on migrating from older version of the libraries.
+
+This particular version is pinned to OpenAPI version `2020-09-14_1.20.6`.
 
 # 14.0.0.beta.5
 Generated from OAS version 2020-09-14_1.16.4. See full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
@@ -14,9 +405,9 @@ Type fixes, see full changelog [here](https://github.com/plaid/plaid-openapi/blo
 
 # 14.0.0.beta.1
 
-This version represents a transition in how we maintain our external client libraries. We are now using an [API spec](https://github.com/plaid/plaid-openapi) written in `OpenAPI 3.0.0` and running our definition file through [OpenAPITool's `python` generator](https://github.com/OpenAPITools/openapi-generator).
+This version represents a transition in how we maintain our external client libraries. We are now using an [API spec](https://github.com/plaid/plaid-openapi) written in `OpenAPI 3.0.0` and running our definition file through [OpenAPITool's `ruby` generator](https://github.com/OpenAPITools/openapi-generator).
 
-The minimum required ruby version is 2.7.1.
+The minimum required ruby version is 2.4.0.
 
 **Ruby Migration Guide:**
 
@@ -85,6 +476,15 @@ rescue Plaid::ApiError => e
 end
 ```
 
+# 13.2.0
+- Add support for `options` to `/payment_initiation/payment/create`
+
+# 13.1.0
+- Add Standing Orders support to Payment Initiation
+
+# 13.0.1
+- Add `update_type` to `Item` model.
+
 # 13.0.0
 - Add support for providing a payment initiation schedule
 - Add back the (now deprecated) `/item/public_token/create` endpoint

data/CONTRIBUTING.md

@@ -1,13 +1,9 @@
 # Contributing
 
-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).
+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].
 
 ## Setup
 
-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.
-
 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.
 
 ## Running Tests

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.7.1
+FROM ruby:2.4.0
 
 # Create app directory
 WORKDIR /usr/src/app
@@ -6,7 +6,9 @@ WORKDIR /usr/src/app
 # Copy app to directory
 COPY . /usr/src/app
 
+ENV BUNDLER_VERSION 2.2.9
+RUN gem update --system
 RUN gem install bundler:2.2.9
 RUN bundle install
 
-CMD ["bundle", "exec", "rake", "test"]
+CMD ["bundle", "exec", "rake", "test"]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (14.0.0.beta.5.pre.plural.pre.income.pre.breakdown)
+    plaid (15.3.0)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM
@@ -10,25 +10,29 @@ GEM
     ast (2.4.1)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    faraday (1.8.0)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
     minitest (5.14.2)
     minitest-around (0.5.0)
       minitest (~> 5.0)
@@ -82,4 +86,4 @@ DEPENDENCIES
   rubocop (~> 0.91.0)
 
 BUNDLED WITH
-   2.2.22
+   2.2.32

data/Makefile

@@ -1,2 +1,11 @@
 # Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
-RUBY_PACKAGE_VERSION=14.0.0.beta.5-plural-income-breakdown
+RUBY_PACKAGE_VERSION=15.3.0
+
+.PHONY: release
+release:
+# Remove previously released versions of plaid-ruby
+	rm -rf pkg
+# Release
+	bundle config set --local path 'vendor/bundle' && \
+	bundle && \
+	bundle exec rake release