Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
24 changes: 16 additions & 8 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -313,13 +313,14 @@ docs/BusinessWebsiteSSL.md
docs/BusinessWhoisRecord.md
docs/CRALoansRegisterRequest.md
docs/CashAdvanceDecisionOutcome.md
docs/CashAdvanceDetails.md
docs/CashAdvanceDetailsAmountApproved.md
docs/CashAdvanceDetailsAmountDue.md
docs/CashAdvanceInfo.md
docs/CashAdvanceInfoAmountApproved.md
docs/CashAdvanceInfoAmountDue.md
docs/CashAdvanceRepayment.md
docs/CashAdvanceRepaymentAmountDue.md
docs/CashAdvanceRepaymentAmountPaid.md
docs/CashAdvanceRepaymentStatus.md
docs/CashAdvanceType.md
docs/CashFlowInsight.md
docs/CashFlowUpdatesEventWebhookCodes.md
docs/CashFlowUpdatesExpectedDepositMissedWebhook.md
Expand Down Expand Up @@ -561,6 +562,7 @@ docs/CraReportGetRequestProduct.md
docs/CraReportGetResponse.md
docs/CraReportGetResponseProduct.md
docs/CraReportScope.md
docs/CraReportUpdatedWebhook.md
docs/CraServicingSubscription.md
docs/CraServicingSubscriptionCreateRequest.md
docs/CraServicingSubscriptionCreateResponse.md
Expand Down Expand Up @@ -709,6 +711,7 @@ docs/CreditPayrollIncomeRefreshResponse.md
docs/CreditPayrollIncomeRiskSignalsGetRequest.md
docs/CreditPayrollIncomeRiskSignalsGetResponse.md
docs/CreditPlatformIds.md
docs/CreditProduct.md
docs/CreditRelayCreateRequest.md
docs/CreditRelayCreateResponse.md
docs/CreditRelayGetRequest.md
Expand Down Expand Up @@ -1530,6 +1533,7 @@ docs/ProtectCashAdvanceRepaymentCreateResponse.md
docs/ProtectComputeRequest.md
docs/ProtectComputeResponse.md
docs/ProtectComputeSubscores.md
docs/ProtectDeviceModelInputs.md
docs/ProtectEvent.md
docs/ProtectEventGetRequest.md
docs/ProtectEventGetResponse.md
Expand All @@ -1546,7 +1550,6 @@ docs/ProtectReportCreateRequest.md
docs/ProtectReportCreateResponse.md
docs/ProtectReportSource.md
docs/ProtectReportType.md
docs/ProtectSDKModelInputs.md
docs/ProtectUser.md
docs/ProtectUserEventWebhook.md
docs/ProtectUserInsightsGetRequest.md
Expand Down Expand Up @@ -2100,6 +2103,7 @@ docs/WalletTransaction.md
docs/WalletTransactionAmount.md
docs/WalletTransactionCounterparty.md
docs/WalletTransactionCounterpartyBACS.md
docs/WalletTransactionCounterpartyHolderCategory.md
docs/WalletTransactionCounterpartyInternational.md
docs/WalletTransactionCounterpartyNumbers.md
docs/WalletTransactionExecuteRequest.md
Expand Down Expand Up @@ -2500,13 +2504,14 @@ lib/plaid/models/business_website_build_status.rb
lib/plaid/models/business_website_ssl.rb
lib/plaid/models/business_whois_record.rb
lib/plaid/models/cash_advance_decision_outcome.rb
lib/plaid/models/cash_advance_details.rb
lib/plaid/models/cash_advance_details_amount_approved.rb
lib/plaid/models/cash_advance_details_amount_due.rb
lib/plaid/models/cash_advance_info.rb
lib/plaid/models/cash_advance_info_amount_approved.rb
lib/plaid/models/cash_advance_info_amount_due.rb
lib/plaid/models/cash_advance_repayment.rb
lib/plaid/models/cash_advance_repayment_amount_due.rb
lib/plaid/models/cash_advance_repayment_amount_paid.rb
lib/plaid/models/cash_advance_repayment_status.rb
lib/plaid/models/cash_advance_type.rb
lib/plaid/models/cash_flow_insight.rb
lib/plaid/models/cash_flow_updates_event_webhook_codes.rb
lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb
Expand Down Expand Up @@ -2749,6 +2754,7 @@ lib/plaid/models/cra_report_get_request_product.rb
lib/plaid/models/cra_report_get_response.rb
lib/plaid/models/cra_report_get_response_product.rb
lib/plaid/models/cra_report_scope.rb
lib/plaid/models/cra_report_updated_webhook.rb
lib/plaid/models/cra_servicing_subscription.rb
lib/plaid/models/cra_servicing_subscription_create_request.rb
lib/plaid/models/cra_servicing_subscription_create_response.rb
Expand Down Expand Up @@ -2897,6 +2903,7 @@ lib/plaid/models/credit_payroll_income_refresh_response.rb
lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb
lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb
lib/plaid/models/credit_platform_ids.rb
lib/plaid/models/credit_product.rb
lib/plaid/models/credit_relay_create_request.rb
lib/plaid/models/credit_relay_create_response.rb
lib/plaid/models/credit_relay_get_request.rb
Expand Down Expand Up @@ -3716,6 +3723,7 @@ lib/plaid/models/protect_cash_advance_repayment_create_response.rb
lib/plaid/models/protect_compute_request.rb
lib/plaid/models/protect_compute_response.rb
lib/plaid/models/protect_compute_subscores.rb
lib/plaid/models/protect_device_model_inputs.rb
lib/plaid/models/protect_event.rb
lib/plaid/models/protect_event_get_request.rb
lib/plaid/models/protect_event_get_response.rb
Expand All @@ -3732,7 +3740,6 @@ lib/plaid/models/protect_report_create_request.rb
lib/plaid/models/protect_report_create_response.rb
lib/plaid/models/protect_report_source.rb
lib/plaid/models/protect_report_type.rb
lib/plaid/models/protect_sdk_model_inputs.rb
lib/plaid/models/protect_user.rb
lib/plaid/models/protect_user_event_webhook.rb
lib/plaid/models/protect_user_insights_get_request.rb
Expand Down Expand Up @@ -4287,6 +4294,7 @@ lib/plaid/models/wallet_transaction.rb
lib/plaid/models/wallet_transaction_amount.rb
lib/plaid/models/wallet_transaction_counterparty.rb
lib/plaid/models/wallet_transaction_counterparty_bacs.rb
lib/plaid/models/wallet_transaction_counterparty_holder_category.rb
lib/plaid/models/wallet_transaction_counterparty_international.rb
lib/plaid/models/wallet_transaction_counterparty_numbers.rb
lib/plaid/models/wallet_transaction_execute_request.rb
Expand Down
102 changes: 102 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,107 @@
See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).

# 51.0.0
- Updating to OAS 2020-09-14_1.740.1

## Breaking changes in this version

- [BREAKING] `/processor/token/create`: the `processor` enum value `paynote` is replaced by `seamlessach` (SeamlessChex rebranded Paynote to Seamless ACH). Send `seamlessach` instead. The API still accepts `paynote` during a transition period, and processor tokens already issued under `paynote` keep working and do not need to be regenerated.
- [BREAKING] `/protect/compute`: the generic `cash-advance-onboarding-1.0` and `cash-advance-ongoing-1.0` models are removed. Use the client-scoped model issued for your client: `cash-advance-onboarding-<client>-1.0` or `cash-advance-ongoing-<client>-1.0`.
- [BREAKING] `/protect/cash_advance/repayment/create`: the repayment status `DELIVERED` is replaced by `PARTIAL_PAYMENT`, which indicates a payment was made but an outstanding balance remains. `amount_paid` is no longer required and is now nullable; it is required only when `status` is `REPAID` or `PARTIAL_PAYMENT`.
- [BREAKING] `/protect/cash_advance/decision/create`: `is_taken` moves out of the `cash_advance` object to the top level of the request, and the `cash_advance` object schema is renamed from `CashAdvanceDetails` to `CashAdvanceInfo`. A new required `advance_type` field (`FIRST` / `REPEAT`) and an optional non-negative `previous_advance_count` field are added. `is_taken` must be `false` when the decision is `DECLINED`; when `true`, both `client_advance_id` and `cash_advance` are required. `advance_type` is required only when `is_taken` is `true`.
- [BREAKING] `/protect/event/send`: `protect_session_id` is renamed to `device_session_id`, both at the top level and within `event`.
- [BREAKING] `/protect/compute`: the `sdk` model inputs object is renamed to `device`, its `sdk_session_id` field is renamed to `device_session_id`, and the `ProtectSDKModelInputs` schema is now `ProtectDeviceModelInputs`.

## OpenAPI Schema Changes
### 2020-09-14_1.740.1

- Added the missing `PRODUCT_GENERATION_ERROR` enum value to `options.error_webhook_code` on `/sandbox/cra/servicing/simulate`. This change brings the OpenAPI specification in line with actual API behavior; the endpoint already accepted the value and emitted it on the resulting `CRA_REPORT_UPDATED` webhook.

### 2020-09-14_1.740.0

### 2020-09-14_1.739.0

- Document `options.transactions.days_requested` on `/sandbox/public_token/create`, which controls how much transaction history the Sandbox Item is created with, matching `transactions.days_requested` on `/link/token/create`. The field was already present in the client libraries; only its documentation visibility changes.
- Deprecate `options.transactions.start_date` and `options.transactions.end_date` on `/sandbox/public_token/create` in favor of `days_requested`, and remove them from the API reference. Both are still accepted and still have no effect on the history available on the Item.

### 2020-09-14_1.738.0

- [Breaking] SeamlessChex has rebranded Paynote to Seamless ACH. On `/processor/token/create`, the `processor` enum value `paynote` is replaced by `seamlessach`. Client libraries no longer expose `paynote` as an enum member, so upgrading to this version requires sending `seamlessach` instead. The API still accepts `paynote` during a transition period, so integrations pinned to an older client library continue to work, but the value is retired and will stop being accepted. Processor tokens already issued under `paynote` keep working and do not need to be regenerated.

### 2020-09-14_1.737.2

- Add `client_user_id` to the `/cra/report/get` response.

### 2020-09-14_1.737.1

- Internal changes only.

### 2020-09-14_1.737.0

- Document the `CRA_REPORT_UPDATED` webhook (`CRA_REPORT` type), fired when a subscribed CRA report is updated. The `successful_products`/`failed_products` fields indicate which products were updated, and `scope` indicates the data the report was computed over.

### 2020-09-14_1.736.3

### 2020-09-14_1.736.2

- [Breaking] Remove the generic `cash-advance-onboarding-1.0` and `cash-advance-ongoing-1.0` models from `/protect/compute`. Cash advance scoring now requires the client-scoped model issued for your client, named `cash-advance-onboarding-<client>-1.0` or `cash-advance-ongoing-<client>-1.0`.

### 2020-09-14_1.736.1

- Hide `/beta/webhook_events/list` from public API docs until GA, and document its errors, mutually exclusive `cursor`/`start_time` behavior, and additional request/response examples. The request/response shapes are unchanged.

### 2020-09-14_1.736.0

- [Breaking] Make `amount_paid` nullable on `/protect/cash_advance/repayment/create`; it is now required only when `status` is `REPAID` or `PARTIAL_PAYMENT`.
- Make `advance_type` optional on `/protect/cash_advance/decision/create`; it is now required only when `is_taken` is `true`.

### 2020-09-14_1.735.0

- [Breaking] Add the required `advance_type` field (`FIRST` / `REPEAT`) and the optional non-negative `previous_advance_count` field to the `/protect/cash_advance/decision/create` request body.
- [Breaking] Replace the `DELIVERED` repayment status with `PARTIAL_PAYMENT` on `/protect/cash_advance/repayment/create`. `PARTIAL_PAYMENT` indicates a payment has been made but an outstanding balance remains.
- [Breaking] Move `is_taken` out of the `cash_advance` object to the top level of the `/protect/cash_advance/decision/create` request. It must be `false` when the decision is `DECLINED`, and when `true` both `client_advance_id` and `cash_advance` are required.
- [Breaking] Rename the `cash_advance` object schema from `CashAdvanceDetails` to `CashAdvanceInfo` on `/protect/cash_advance/decision/create`.

### 2020-09-14_1.734.1

- Add `kikoff_enterprise` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Kikoff Enterprise integration.

### 2020-09-14_1.734.0

- Make `device_data` optional and deprecated on `/protect/client/session/start`. The field remains accepted for backward compatibility.

### 2020-09-14_1.733.0

- Added a `running_balance` field to the Transaction object. It is the balance of the account after that transaction was applied, as reported by the financial institution, and is only present where the institution sends one.

### 2020-09-14_1.732.0

- internal changes only

### 2020-09-14_1.731.0

- Add the optional `holder_category` and `is_verified` fields to the counterparty on `/wallet/transaction/execute`. `holder_category` tells payee verification whether the counterparty is a person or a company, and `is_verified` lets you declare that you have already verified the counterparty so Plaid skips its own payee verification check. Both apply to GBP payouts and remain hidden from public documentation.
- `payee_verification_status` on e-wallet transactions is now also populated for GBP payouts.

### 2020-09-14_1.730.4

- Clarify that client-specific Link session model requests can use a major-version alias and that `/protect/compute` responses return the exact minor version used.

### 2020-09-14_1.730.3

### 2020-09-14_1.730.2

- Hide the `require_extracted_data` field on Protect Link-session model inputs from the public API reference. The request contract is unchanged.

### 2020-09-14_1.730.1

- Noted that `merchant_category_code` on the Transaction object is in beta.

### 2020-09-14_1.730.0

- [Breaking] Renamed the `protect_session_id` field in the request of the deprecated `/protect/event/send` to `device_session_id`, both at the top level and within `event`.
- [Breaking] Renamed the `sdk` model inputs object in the request of `/protect/compute` to `device`, and its `sdk_session_id` field to `device_session_id`. The `ProtectSDKModelInputs` schema is now `ProtectDeviceModelInputs`.

# 50.0.0
- Updating to OAS 2020-09-14_1.729.1

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -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=50.0.0
RUBY_PACKAGE_VERSION=51.0.0

.PHONY: release
release:
Expand Down
14 changes: 9 additions & 5 deletions lib/plaid.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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.729.1
The version of the OpenAPI document: 2020-09-14_1.740.1

Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.3.0
Expand Down Expand Up @@ -332,13 +332,14 @@
Plaid.autoload :BusinessWhoisRecord, 'plaid/models/business_whois_record'
Plaid.autoload :CRALoansRegisterRequest, 'plaid/models/cra_loans_register_request'
Plaid.autoload :CashAdvanceDecisionOutcome, 'plaid/models/cash_advance_decision_outcome'
Plaid.autoload :CashAdvanceDetails, 'plaid/models/cash_advance_details'
Plaid.autoload :CashAdvanceDetailsAmountApproved, 'plaid/models/cash_advance_details_amount_approved'
Plaid.autoload :CashAdvanceDetailsAmountDue, 'plaid/models/cash_advance_details_amount_due'
Plaid.autoload :CashAdvanceInfo, 'plaid/models/cash_advance_info'
Plaid.autoload :CashAdvanceInfoAmountApproved, 'plaid/models/cash_advance_info_amount_approved'
Plaid.autoload :CashAdvanceInfoAmountDue, 'plaid/models/cash_advance_info_amount_due'
Plaid.autoload :CashAdvanceRepayment, 'plaid/models/cash_advance_repayment'
Plaid.autoload :CashAdvanceRepaymentAmountDue, 'plaid/models/cash_advance_repayment_amount_due'
Plaid.autoload :CashAdvanceRepaymentAmountPaid, 'plaid/models/cash_advance_repayment_amount_paid'
Plaid.autoload :CashAdvanceRepaymentStatus, 'plaid/models/cash_advance_repayment_status'
Plaid.autoload :CashAdvanceType, 'plaid/models/cash_advance_type'
Plaid.autoload :CashFlowInsight, 'plaid/models/cash_flow_insight'
Plaid.autoload :CashFlowUpdatesEventWebhookCodes, 'plaid/models/cash_flow_updates_event_webhook_codes'
Plaid.autoload :CashFlowUpdatesExpectedDepositMissedWebhook, 'plaid/models/cash_flow_updates_expected_deposit_missed_webhook'
Expand Down Expand Up @@ -580,6 +581,7 @@
Plaid.autoload :CraReportGetResponse, 'plaid/models/cra_report_get_response'
Plaid.autoload :CraReportGetResponseProduct, 'plaid/models/cra_report_get_response_product'
Plaid.autoload :CraReportScope, 'plaid/models/cra_report_scope'
Plaid.autoload :CraReportUpdatedWebhook, 'plaid/models/cra_report_updated_webhook'
Plaid.autoload :CraServicingSubscription, 'plaid/models/cra_servicing_subscription'
Plaid.autoload :CraServicingSubscriptionCreateRequest, 'plaid/models/cra_servicing_subscription_create_request'
Plaid.autoload :CraServicingSubscriptionCreateResponse, 'plaid/models/cra_servicing_subscription_create_response'
Expand Down Expand Up @@ -728,6 +730,7 @@
Plaid.autoload :CreditPayrollIncomeRiskSignalsGetRequest, 'plaid/models/credit_payroll_income_risk_signals_get_request'
Plaid.autoload :CreditPayrollIncomeRiskSignalsGetResponse, 'plaid/models/credit_payroll_income_risk_signals_get_response'
Plaid.autoload :CreditPlatformIds, 'plaid/models/credit_platform_ids'
Plaid.autoload :CreditProduct, 'plaid/models/credit_product'
Plaid.autoload :CreditRelayCreateRequest, 'plaid/models/credit_relay_create_request'
Plaid.autoload :CreditRelayCreateResponse, 'plaid/models/credit_relay_create_response'
Plaid.autoload :CreditRelayGetRequest, 'plaid/models/credit_relay_get_request'
Expand Down Expand Up @@ -1548,6 +1551,7 @@
Plaid.autoload :ProtectComputeRequest, 'plaid/models/protect_compute_request'
Plaid.autoload :ProtectComputeResponse, 'plaid/models/protect_compute_response'
Plaid.autoload :ProtectComputeSubscores, 'plaid/models/protect_compute_subscores'
Plaid.autoload :ProtectDeviceModelInputs, 'plaid/models/protect_device_model_inputs'
Plaid.autoload :ProtectEvent, 'plaid/models/protect_event'
Plaid.autoload :ProtectEventGetRequest, 'plaid/models/protect_event_get_request'
Plaid.autoload :ProtectEventGetResponse, 'plaid/models/protect_event_get_response'
Expand All @@ -1564,7 +1568,6 @@
Plaid.autoload :ProtectReportCreateResponse, 'plaid/models/protect_report_create_response'
Plaid.autoload :ProtectReportSource, 'plaid/models/protect_report_source'
Plaid.autoload :ProtectReportType, 'plaid/models/protect_report_type'
Plaid.autoload :ProtectSDKModelInputs, 'plaid/models/protect_sdk_model_inputs'
Plaid.autoload :ProtectUser, 'plaid/models/protect_user'
Plaid.autoload :ProtectUserEventWebhook, 'plaid/models/protect_user_event_webhook'
Plaid.autoload :ProtectUserInsightsGetRequest, 'plaid/models/protect_user_insights_get_request'
Expand Down Expand Up @@ -2118,6 +2121,7 @@
Plaid.autoload :WalletTransactionAmount, 'plaid/models/wallet_transaction_amount'
Plaid.autoload :WalletTransactionCounterparty, 'plaid/models/wallet_transaction_counterparty'
Plaid.autoload :WalletTransactionCounterpartyBACS, 'plaid/models/wallet_transaction_counterparty_bacs'
Plaid.autoload :WalletTransactionCounterpartyHolderCategory, 'plaid/models/wallet_transaction_counterparty_holder_category'
Plaid.autoload :WalletTransactionCounterpartyInternational, 'plaid/models/wallet_transaction_counterparty_international'
Plaid.autoload :WalletTransactionCounterpartyNumbers, 'plaid/models/wallet_transaction_counterparty_numbers'
Plaid.autoload :WalletTransactionExecuteRequest, 'plaid/models/wallet_transaction_execute_request'
Expand Down
Loading