Merge pull request #522 from plaid/generated_20240705T203143Z

OpenAPI generated code at 2024-07-05T20:31:43Z

.openapi-generator/FILES

@@ -189,6 +189,8 @@ plaid/model/beacon_account_risk_evaluate_request_options.py
 plaid/model/beacon_account_risk_evaluate_response.py
 plaid/model/beacon_audit_trail.py
 plaid/model/beacon_audit_trail_source.py
+plaid/model/beacon_bank_account_insights.py
+plaid/model/beacon_bank_accounts.py
 plaid/model/beacon_duplicate_detected_webhook.py
 plaid/model/beacon_duplicate_get_request.py
 plaid/model/beacon_duplicate_get_response.py
@@ -213,6 +215,8 @@ plaid/model/beacon_report_syndication_original_report.py
 plaid/model/beacon_report_type.py
 plaid/model/beacon_report_updated_webhook.py
 plaid/model/beacon_user.py
+plaid/model/beacon_user_account_insights_get_request.py
+plaid/model/beacon_user_account_insights_get_response.py
 plaid/model/beacon_user_address.py
 plaid/model/beacon_user_create_request.py
 plaid/model/beacon_user_create_response.py
@@ -280,10 +284,13 @@ plaid/model/cra_check_report_create_response.py
 plaid/model/cra_check_report_failed_webhook.py
 plaid/model/cra_check_report_income_insights_get_request.py
 plaid/model/cra_check_report_income_insights_get_response.py
+plaid/model/cra_check_report_network_attributes_get_request.py
+plaid/model/cra_check_report_network_attributes_get_response.py
 plaid/model/cra_check_report_partner_insights_get_options.py
 plaid/model/cra_check_report_partner_insights_get_request.py
 plaid/model/cra_check_report_partner_insights_get_response.py
 plaid/model/cra_check_report_pdf_get_request.py
+plaid/model/cra_check_report_product.py
 plaid/model/cra_check_report_ready_webhook.py
 plaid/model/cra_income_insights.py
 plaid/model/cra_loan_application.py
@@ -307,6 +314,8 @@ plaid/model/cra_loans_register_response.py
 plaid/model/cra_loans_unregister_request.py
 plaid/model/cra_loans_update_request.py
 plaid/model/cra_loans_update_response.py
+plaid/model/cra_network_attributes_item.py
+plaid/model/cra_network_attributes_report.py
 plaid/model/cra_partner_insights.py
 plaid/model/cra_partner_insights_complete_webhook.py
 plaid/model/cra_partner_insights_error_webhook.py
@@ -569,7 +578,6 @@ plaid/model/hosted_link_delivery_method.py
 plaid/model/hosted_mmd_verification_webhook.py
 plaid/model/id_number_type.py
 plaid/model/identity_default_update_webhook.py
-plaid/model/identity_document.py
 plaid/model/identity_document_metadata.py
 plaid/model/identity_document_upload.py
 plaid/model/identity_document_upload_metadata.py
@@ -1196,6 +1204,8 @@ plaid/model/sandbox_transfer_test_clock_get_request.py
 plaid/model/sandbox_transfer_test_clock_get_response.py
 plaid/model/sandbox_transfer_test_clock_list_request.py
 plaid/model/sandbox_transfer_test_clock_list_response.py
+plaid/model/sandbox_user_reset_login_request.py
+plaid/model/sandbox_user_reset_login_response.py
 plaid/model/scopes.py
 plaid/model/scopes_context.py
 plaid/model/scopes_nullable.py
@@ -1479,7 +1489,11 @@ plaid/model/user_create_response.py
 plaid/model/user_custom_password.py
 plaid/model/user_data_overview.py
 plaid/model/user_id_number.py
+plaid/model/user_items_get_request.py
+plaid/model/user_items_get_response.py
 plaid/model/user_permission_revoked_webhook.py
+plaid/model/user_remove_request.py
+plaid/model/user_remove_response.py
 plaid/model/user_stated_income_source_category.py
 plaid/model/user_stated_income_source_frequency.py
 plaid/model/user_stated_income_source_pay_type.py

CHANGELOG.md

@@ -1,8 +1,89 @@
 See full changelog for the OpenAPI Schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 24.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.
+
 # 23.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

README.md

@@ -1,21 +1,20 @@
-plaid-python [![PyPI version](https://badge.fury.io/py/plaid-python.svg)](https://badge.fury.io/py/plaid-python)
-============
+# plaid-python [![PyPI version](https://badge.fury.io/py/plaid-python.svg)](https://badge.fury.io/py/plaid-python)
 
 The official python client library for the [Plaid API][1], which is generated from our [OpenAPI spec](https://github.com/plaid/plaid-openapi).
 
 ## Table of Contents
 
-* [Installation](#installation)
-* [Versioning](#versioning)
-* [Getting Started](#getting-started)
-    + [Calling Endpoints](#calling-endpoints)
-    + [Errors](#errors)
-    + [Converting the response to a JSON](#converting-the-response-to-a-json)
-    + [Dates](#dates)
-* [Examples](#examples)
-* [Migration Guide](#migration-guide)
-* [Contributing](#contributing)
-* [License](#license)
+- [Installation](#installation)
+- [Versioning](#versioning)
+- [Getting Started](#getting-started)
+  - [Calling Endpoints](#calling-endpoints)
+  - [Errors](#errors)
+  - [Converting the response to a JSON](#converting-the-response-to-a-json)
+  - [Dates](#dates)
+- [Examples](#examples)
+- [Migration Guide](#migration-guide)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
@@ -24,6 +23,7 @@ This library only supports `python3`!
 ```console
 $ pip3 install plaid-python
 ```
+
 ## Versioning
 
 This release only supports the latest Plaid API version, `2020-09-14`.
@@ -32,7 +32,6 @@ For information about what has changed between versions and how to update your i
 
 The plaid-python 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-python/blob/master/CHANGELOG.md). New versions are published as [GitHub tags](https://github.com/plaid/plaid-python/tags), not as Releases. New versions are also published on [PyPi](https://pypi.org/project/plaid-python/). Plaid uses semantic versioning to version the client libraries, with potentially breaking changes being indicated by a major version bump.
 
-
 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
@@ -47,7 +46,6 @@ from plaid.api import plaid_api
 
 # Available environments are
 # 'Production'
-# 'Development'
 # 'Sandbox'
 configuration = plaid.Configuration(
     host=plaid.Environment.Sandbox,
@@ -102,6 +100,7 @@ response = ... # type TransactionsSyncResponse
 # to_dict makes it first a python dictionary, and then we turn it into a string JSON.
 json_string = json.dumps(response.to_dict(), default=str)
 ```
+
 ### Dates
 
 Dates and datetimes in requests, which are represented as strings in the API and in previous client library versions, are represented in this version of the Python client library as Python `datetime.date` or `datetime.datetime` objects. If you need to convert between dates and strings, you can use the `datetime.strptime` method. For an example, see the Retrieve Transactions sample code later in this Readme. For more information on the Python's `datetime` module, see [Python's official documentation](https://docs.python.org/3/library/datetime.html).
@@ -119,18 +118,20 @@ b = date.fromisoformat('2022-05-05')
 
 If the API reference documentation for a field specifies `format: date-time`, the following is acceptable:
 
-
 ```py
 from datetime import datetime
 
 a = datetime(2022, 5, 5, 22, 35, 49, tzinfo=datetime.timezone.utc)
 ```
+
 ## Examples
 
 For more examples, see the [test suites](https://github.com/plaid/plaid-python/tree/master/tests), [Quickstart](https://github.com/plaid/quickstart/tree/master/python), or [API Reference documentation](https://plaid.com/docs/api/).
 
 ### Create an Item using Link
+
 Exchange a `public_token` from [Plaid Link][4] for a Plaid access token:
+
 ```python
 import plaid
 from plaid.model.item_public_token_exchange_request import ItemPublicTokenExchangeRequest
@@ -144,6 +145,7 @@ access_token = exchange_response['access_token']
 ```
 
 ### Remove Item
+
 ```python
 import plaid
 from plaid.model.item_remove_request import ItemRemoveRequest
@@ -156,6 +158,7 @@ response = client.item_remove(request)
 ```
 
 ### Retrieve Transactions (preferred method)
+
 ```python
 import plaid
 from plaid.model.transactions_sync_request import TransactionsSyncRequest
@@ -177,8 +180,8 @@ while (response['has_more']):
     transactions += response['added']
 ```
 
-
 ### Retrieve Transactions (older method)
+
 ```python
 import plaid
 from plaid.model.transactions_get_request_options import TransactionsGetRequestOptions
@@ -230,7 +233,9 @@ Migrating from version 8.0.0 or later of the library to a recent version should
 Version 8.0.0 of the client library was released in August 2021 and contains multiple interface changes, as described below.
 
 #### Client initialization
+
 From:
+
 ```python
 from plaid import Client
 Client(
@@ -243,6 +248,7 @@ Client(
 ```
 
 To:
+
 ```python
 import plaid
 from plaid.api import plaid_api
@@ -257,15 +263,19 @@ configuration = plaid.Configuration(
 api_client = plaid.ApiClient(configuration)
 client = plaid_api.PlaidApi(api_client)
 ```
+
 #### Endpoints
+
 All endpoint requests now take a request model and the functions have been renamed to include `_`.
 
 From:
+
 ```python
 response = client.Auth.get(access_token)
 ```
 
 To:
+
 ```python
 import plaid
 from plaid.model.auth_get_request import AuthGetRequest
@@ -281,6 +291,7 @@ response = client.auth_get(ag_request)
 #### Errors
 
 From:
+
 ```python
 try:
     client.Auth.get(access_token)
@@ -296,6 +307,7 @@ except APIError as e:
 ```
 
 To:
+
 ```python
 try:
     request = AssetReportGetRequest(
@@ -308,7 +320,6 @@ except plaid.ApiException as e:
     else:
 ```
 
-
 #### Data type changes
 
 See the sections above on [Dates](#dates) and [Converting the response to a JSON](#converting-the-response-to-a-json).
@@ -318,12 +329,14 @@ See the sections above on [Dates](#dates) and [Converting the response to a JSON
 While the API and previous library versions prior to 8.0.0 represent enums using strings, this current library uses Python classes with restricted values.
 
 From:
+
 ```
 'products': ['auth', 'transactions'],
 'country_codes': ['US'],
 ```
 
 To:
+
 ```
 products=[Products('auth'), Products('transactions')],
 country_codes=[CountryCode('US')],
@@ -337,6 +350,7 @@ Global configuration options: [configuration.py](https://github.com/plaid/plaid-
 Per-request configuration options: [api_client.py](https://github.com/plaid/plaid-python/blob/master/plaid/api_client.py#L117)
 
 From:
+
 ```
 class PlaidClient(plaid.Client):
    def __init__(
@@ -348,16 +362,17 @@ class PlaidClient(plaid.Client):
 ```
 
 To:
+
 ```
 response = client.accounts_balance_get(request, _request_timeout=60)
 ```
 
-
 ## Contributing
 
 Please see [Contributing](CONTRIBUTING.md) for guidelines and instructions for local development.
 
 ## License
+
 [MIT][6]
 
 [1]: https://plaid.com

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.525.1
+    The version of the OpenAPI document: 2020-09-14_1.534.3
     Generated by: https://openapi-generator.tech
 """
 
 
-__version__ = "23.0.0"
+__version__ = "24.0.0"
 
 # import ApiClient
 from plaid.api_client import ApiClient