OpenAPI generated code at 2024-11-14T16:35:28Z (#536)

Co-authored-by: lzhang <lzhang@plaid.com>

.openapi-generator/FILES

@@ -164,6 +164,7 @@ plaid/model/base_report.py
 plaid/model/base_report_account.py
 plaid/model/base_report_account_balances.py
 plaid/model/base_report_account_insights.py
+plaid/model/base_report_account_metadata.py
 plaid/model/base_report_attributes.py
 plaid/model/base_report_average_flow_insights.py
 plaid/model/base_report_average_monthly_balances.py
@@ -271,6 +272,7 @@ plaid/model/counterparty_type.py
 plaid/model/country_code.py
 plaid/model/cra_bank_income.py
 plaid/model/cra_bank_income_account.py
+plaid/model/cra_bank_income_account_metadata.py
 plaid/model/cra_bank_income_bonus_type.py
 plaid/model/cra_bank_income_cause.py
 plaid/model/cra_bank_income_complete_result.py
@@ -346,6 +348,7 @@ plaid/model/cra_partner_insights_get_request.py
 plaid/model/cra_partner_insights_get_response.py
 plaid/model/cra_partner_insights_item.py
 plaid/model/cra_partner_insights_item_account.py
+plaid/model/cra_partner_insights_item_account_metadata.py
 plaid/model/cra_partner_insights_prism.py
 plaid/model/cra_pdf_add_ons.py
 plaid/model/cra_prediction_interval.py
@@ -763,6 +766,7 @@ plaid/model/item_application_scopes_update_response.py
 plaid/model/item_application_unlink_request.py
 plaid/model/item_application_unlink_response.py
 plaid/model/item_consented_data_scope.py
+plaid/model/item_create_authentication.py
 plaid/model/item_error_webhook.py
 plaid/model/item_get_request.py
 plaid/model/item_get_response.py
@@ -785,6 +789,8 @@ plaid/model/item_status_nullable.py
 plaid/model/item_status_transactions.py
 plaid/model/item_webhook_update_request.py
 plaid/model/item_webhook_update_response.py
+plaid/model/item_with_consent_fields.py
+plaid/model/item_with_consent_fields_all_of.py
 plaid/model/jwk_public_key.py
 plaid/model/jwt_header.py
 plaid/model/kyc_check_address_summary.py
@@ -1017,13 +1023,16 @@ plaid/model/payment_initiation_consent_create_request.py
 plaid/model/payment_initiation_consent_create_response.py
 plaid/model/payment_initiation_consent_get_request.py
 plaid/model/payment_initiation_consent_get_response.py
+plaid/model/payment_initiation_consent_payer_details.py
+plaid/model/payment_initiation_consent_payer_numbers.py
 plaid/model/payment_initiation_consent_payment_execute_request.py
 plaid/model/payment_initiation_consent_payment_execute_response.py
 plaid/model/payment_initiation_consent_processing_mode.py
 plaid/model/payment_initiation_consent_revoke_request.py
 plaid/model/payment_initiation_consent_revoke_response.py
 plaid/model/payment_initiation_consent_scope.py
 plaid/model/payment_initiation_consent_status.py
+plaid/model/payment_initiation_consent_type.py
 plaid/model/payment_initiation_maximum_payment_amount.py
 plaid/model/payment_initiation_metadata.py
 plaid/model/payment_initiation_optional_restriction_bacs.py
@@ -1333,6 +1342,8 @@ plaid/model/signal_user.py
 plaid/model/signal_warning.py
 plaid/model/simulated_transfer_sweep.py
 plaid/model/single_document_risk_signal.py
+plaid/model/sms_verification.py
+plaid/model/sms_verification_status.py
 plaid/model/source.py
 plaid/model/standalone_account_type.py
 plaid/model/standalone_currency_code_list.py
@@ -1364,7 +1375,15 @@ plaid/model/taxpayer_identifier_type.py
 plaid/model/taxpayer_identifiers.py
 plaid/model/total.py
 plaid/model/total_canonical_description.py
+plaid/model/total_inflow_amount.py
+plaid/model/total_inflow_amount30d.py
+plaid/model/total_inflow_amount60d.py
+plaid/model/total_inflow_amount90d.py
 plaid/model/total_monthly_income_insights.py
+plaid/model/total_outflow_amount.py
+plaid/model/total_outflow_amount30d.py
+plaid/model/total_outflow_amount60d.py
+plaid/model/total_outflow_amount90d.py
 plaid/model/transaction.py
 plaid/model/transaction_all_of.py
 plaid/model/transaction_base.py
@@ -1519,6 +1538,7 @@ plaid/model/transfer_platform_person_create_request.py
 plaid/model/transfer_platform_person_create_response.py
 plaid/model/transfer_platform_person_id_number.py
 plaid/model/transfer_platform_person_name.py
+plaid/model/transfer_platform_requirement.py
 plaid/model/transfer_platform_requirement_submission.py
 plaid/model/transfer_platform_requirement_submit_request.py
 plaid/model/transfer_platform_requirement_submit_response.py
@@ -1606,6 +1626,8 @@ plaid/model/verification_of_asset.py
 plaid/model/verification_of_asset_response.py
 plaid/model/verification_refresh_status.py
 plaid/model/verification_status.py
+plaid/model/verify_sms_details.py
+plaid/model/verify_sms_details_status.py
 plaid/model/w2.py
 plaid/model/w2_box12.py
 plaid/model/w2_box12_override.py

CHANGELOG.md

@@ -1,5 +1,120 @@
 See full changelog for the OpenAPI Schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 28.0.0
+- Updating to OAS 2020-09-14_1.586.4
+
+## Breaking changes in this version
+- [BREAKING] Changed the type returned by `/item/get` from `Item` to `ItemWithConsentFields`.
+- [Breaking] Changed `ConsentEventCode` enum values. Replaced `PLAID_END_USER_PRIVACY_POLICY` with `USER_AGREEMENT`
+- [Breaking] Created `ItemWithConsentFields`, a new object definition that extends the `Item` object to include 1033-related consent fields.
+- [Breaking] Removed the 1033-related consent fields from the `Item` object, ensuring that these fields now only appear in the `ItemWithConsentFields` object within the `/item/get` response.
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.586.4
+- Update `cause` and make it nullable
+
+### 2020-09-14_1.586.3
+- Update `email` description in `/user_account/session/get` response
+
+### 2020-09-14_1.586.2
+- Update `event_type` description of `/sandbox/transfer/simulate`. Added `funds_available` to status list
+
+### 2020-09-14_1.586.1
+- [Breaking] Changed `ConsentEventCode` enum values. Replaced `PLAID_END_USER_PRIVACY_POLICY` with `USER_AGREEMENT`
+
+### 2020-09-14_1.586.0
+- Add `webhook` field to requests for `/sandbox/transfer/simulate`, `/sandbox/transfer/refund/simulate`, `/sandbox/transfer/ledger/simulate_available` and `/sandbox/transfer/sweep/simulate`.
+
+### 2020-09-14_1.585.5
+- Correct a typo in /link/token/create description
+
+### 2020-09-14_1.585.4
+- Updated transition date to move away from deprecated fields in CRA Base Report API
+
+### 2020-09-14_1.585.3
+- Fixed erroneous missing `last_statement_balance` field in `StudentLoan` object -- field was returned in API but not in specification.
+
+### 2020-09-14_1.585.2
+- Remove minimum length for `end_customer` in `user/create`
+
+### 2020-09-14_1.585.1
+- Deprecate `options` in `payment_initiation/consent/create`
+
+### 2020-09-14_1.585.0
+- [Breaking] Created `ItemWithConsentFields`, a new object definition that extends the `Item` object to include 1033-related consent fields.
+- [Breaking] Removed the 1033-related consent fields from the `Item` object, ensuring that these fields now only appear in the `ItemWithConsentFields` object within the `/item/get` response.
+
+### 2020-09-14_1.584.1
+- Deprecated `version` in `cra/check_report/partner_insights/get` in favor of `model_version`
+
+### 2020-09-14_1.584.0
+- Made total inflow/outflow amount fields in the `cra/check_report/base_report/get` response nullable
+
+### 2020-09-14_1.583.1
+- Updated `description` field in `payment_configuration` object in `/link/token/create` to be optional
+
+### 2020-09-14_1.583.0
+- Added total inflow/outflow amount fields to `attributes` object in the `cra/check_report/base_report/get` response
+
+### 2020-09-14_1.582.0
+- Added a new field in `/link/token/create`
+
+### 2020-09-14_1.581.0
+-  Update `verify_sms` object in the response of all of the identity verification endpoints to add `redacted_at` timestamp:
+  - `identity_verification/create`
+  - `identity_verification/get`
+  - `identity_verification/list`
+  - `identity_verification/retry`
+
+### 2020-09-14_1.580.4
+- Fixed an incorrect example response in `/user_account/session/get`
+
+### 2020-09-14_1.580.3
+- Fix wrong nullable annotation in `/signal/evaluate` response
+
+### 2020-09-14_1.580.2
+- Make `scores` nullable in `/signal/evaluate` and `/processor/signal/evaluate` response
+
+### 2020-09-14_1.580.1
+ - Add new `payer_details` field to `payment_initiation/consent/create` in preparation to new account restrictions
+
+### 2020-09-14_1.579.1
+ - Add new `type` field to `payment_initiation/consent/create` and deprecate the `scopes` field
+
+### 2020-09-14_1.578.1
+-  Update `verify_sms` object in the response of all of the identity verification endpoints to support nullable `verification.phone_number` and expand allowed statuses for `verification.status`:
+   - `identity_verification/create`
+   - `identity_verification/get`
+   - `identity_verification/list`
+   - `identity_verification/retry`
+
+### 2020-09-14_1.578.0
+-  Add `verify_sms` object in the response of all of the identity verification endpoints:
+   - `identity_verification/create`
+   - `identity_verification/get`
+   - `identity_verification/list`
+   - `identity_verification/retry`
+
+### 2020-09-14_1.577.1
+- Added support for `signal` to `required_if_supported_products`.
+- Added support for `cra_network_insights` to `Products` array.
+- Define `MonitoringInsightsWebhook`
+- Fix definition for JWTHeader object
+
+### 2020-09-14_1.577.0
+- Updated description for the `is_primary_account` field of base reports
+
+### 2020-09-14_1.576.0
+- Expose beacon_user_id in `/identity_verification/*` endpoints
+- Added new optional parameter `days_required` to `cra_options` in `/link/token/create` and to `/cra/check_report/create`
+- Added new metadata object with `start_date` and `end_date` in the responses for:
+    - `/cra/check_report/base_report/get`
+    - `/cra/check_report/income_insights/get`
+    - `/cra/check_report/partner_insights/get`
+
+### 2020-09-14_1.575.1
+- Update `date_of_birth` field description in `user/create`
+
 # 27.0.0
 - Updating to OAS 2020-09-14_1.575.0
 - Removed `__init.py__` from the `/tests/` directory to prevent tests from being imported as a module.
@@ -396,8 +511,9 @@ See full changelog for the OpenAPI Schema (OAS) [here](https://github.com/plaid/
 
 ## 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
+- [Breaking] Renamed `bank_income` to `report` in the `cra/check_report/income_insights/get` response
+- [Breaking] For Python only, updated certain fields (primarily ones used by Identity Verification and Monitor) to be represented as string types instead of classes. This is a side effect of a broader change to remove `minLength` verification to work around incorrect behavior in the Ruby client library when receiving `nil` for a type with a `minLength` set. Classes that have been replaced by strings in Python are: `ClientUserID`, `ClientUserIDNullable`, `DeprecatedClientUserID`, `EntityWatchlistScreeningName`, `EntityWatchlistScreeningProgramName`, `GenericCountryCode`, `GenericCountryCodeNullable`, `IdentityVerificationDocumentCountryCode`, `IndividualWatchlistScreeningProgramName`, `ReviewComment`, `SourceUID`, `WatchlistScreeningDocumentValue`, `WatchlistScreeningDocumentValueNullable`, and `WatchlistScreeningIndividualName`. 
+
 
 ### 2020-09-14_1.520.0
 
@@ -410,7 +526,7 @@ See full changelog for the OpenAPI Schema (OAS) [here](https://github.com/plaid/
 
 ### 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.
+- [Breaking] For Python only, updated certain fields (primarily ones used by Identity Verification and Monitor) to be represented as string types instead of classes. This is a side effect of a broader change to remove `minLength` verification to work around incorrect behavior in the Ruby client library when receiving `nil` for a type with a `minLength` set. Classes that have been replaced by strings in Python are: `ClientUserID`, `ClientUserIDNullable`, `DeprecatedClientUserID`, `EntityWatchlistScreeningName`, `EntityWatchlistScreeningProgramName`, `GenericCountryCode`, `GenericCountryCodeNullable`, `IdentityVerificationDocumentCountryCode`, `IndividualWatchlistScreeningProgramName`, `ReviewComment`, `SourceUID`, `WatchlistScreeningDocumentValue`, `WatchlistScreeningDocumentValueNullable`, and `WatchlistScreeningIndividualName`. 
 
 ### 2020-09-14_1.524.0
 

plaid/__init__.py

@@ -5,12 +5,12 @@
 
     The Plaid REST API. Please see https://plaid.com/docs/api for more details.  # noqa: E501
 
-    The version of the OpenAPI document: 2020-09-14_1.575.0
+    The version of the OpenAPI document: 2020-09-14_1.586.4
     Generated by: https://openapi-generator.tech
 """
 
 
-__version__ = "27.0.0"
+__version__ = "28.0.0"
 
 # import ApiClient
 from plaid.api_client import ApiClient