Merge pull request #550 from plaid/generated_20250519T185319Z

OpenAPI generated code at 2025-05-19T18:53:19Z

Author: mattnguyen1

.openapi-generator/FILES

@@ -254,9 +254,12 @@ plaid/model/cash_flow_updates_new_loan_payment_webhook.py
 plaid/model/cash_flow_updates_nsf_webhook.py
 plaid/model/cashflow_attributes_version.py
 plaid/model/cashflow_report_get_request.py
+plaid/model/cashflow_report_get_request_options.py
 plaid/model/cashflow_report_get_response.py
+plaid/model/cashflow_report_payment_meta.py
 plaid/model/cashflow_report_refresh_request.py
 plaid/model/cashflow_report_refresh_response.py
+plaid/model/cashflow_report_transaction.py
 plaid/model/categories_get_response.py
 plaid/model/category.py
 plaid/model/category_insight_details.py

CHANGELOG.md

@@ -1,5 +1,42 @@
 See full changelog for the OpenAPI Schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 32.0.0
+- Updating to OAS 2020-09-14_1.627.4
+
+## Breaking changes in this version
+- [BREAKING] (beta) Updated `user_token` field in `UserCreateResponse` to be optional.
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.627.4
+- Fix incorrect placement of `nullable: true` on `AccountBaseNullable` object, making the object actually `nullable`.
+
+### 2020-09-14_1.627.3
+- Add missing `unsent` value as a possible `verification_status` to reflect actual API behavior.
+
+### 2020-09-14_1.637.2
+- (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/create`
+- (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/remove`
+
+### 2020-09-14_1.637.2
+- (beta) Add `user_id` to `/session/token/create` response
+
+### 2020-09-14_1.637.1
+- Add optional `institution_id` to `/item/import`
+
+### 2020-09-14_1.637.0
+- Add `android_package_name` to `/session/token/create`
+
+### 2020-09-14_1.636.0
+- Update `average_inflow_amount` to be positive.
+
+### 2020-09-14_1.635.4
+- [BREAKING] (beta) Updated `user_token` field in `UserCreateResponse` to be optional.
+- [BREAKING for Go] (beta) Updated `user_token` field in `UserRemoveRequest` to be optional.
+- Other hidden changes.
+
+### 2020-09-14_1.635.3
+- (beta) Add `user_id` to `/link/token/create` response
+
 # 31.0.0
 - Updating to OAS 2020-09-14_1.635.2
 

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

plaid/api/plaid_api.py

@@ -3,7 +3,7 @@
 
     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.635.2
+    The version of the OpenAPI document: 2020-09-14_1.627.4
     Generated by: https://openapi-generator.tech
 """
 
@@ -14879,6 +14879,7 @@ def __init__(self, api_client=None):
             params_map={
                 'all': [
                     'user_create_request',
+                    'plaid_new_user_api_enabled',
                 ],
                 'required': [
                     'user_create_request',
@@ -14898,11 +14899,15 @@ def __init__(self, api_client=None):
                 'openapi_types': {
                     'user_create_request':
                         (UserCreateRequest,),
+                    'plaid_new_user_api_enabled':
+                        (str,),
                 },
                 'attribute_map': {
+                    'plaid_new_user_api_enabled': 'Plaid-New-User-API-Enabled',
                 },
                 'location_map': {
                     'user_create_request': 'body',
+                    'plaid_new_user_api_enabled': 'header',
                 },
                 'collection_format_map': {
                 }
@@ -14987,6 +14992,7 @@ def __init__(self, api_client=None):
             params_map={
                 'all': [
                     'user_remove_request',
+                    'plaid_new_user_api_enabled',
                 ],
                 'required': [
                     'user_remove_request',
@@ -15006,11 +15012,15 @@ def __init__(self, api_client=None):
                 'openapi_types': {
                     'user_remove_request':
                         (UserRemoveRequest,),
+                    'plaid_new_user_api_enabled':
+                        (str,),
                 },
                 'attribute_map': {
+                    'plaid_new_user_api_enabled': 'Plaid-New-User-API-Enabled',
                 },
                 'location_map': {
                     'user_remove_request': 'body',
+                    'plaid_new_user_api_enabled': 'header',
                 },
                 'collection_format_map': {
                 }
@@ -18064,7 +18074,7 @@ def bank_transfer_event_sync(
     ):
         """Sync bank transfer events  # noqa: E501
 
-        `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).  # noqa: E501
+        `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://plaid.com/docs/auth/coverage/microdeposit-events/).  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -26692,7 +26702,7 @@ def item_remove(
     ):
         """Remove an Item  # noqa: E501
 
-        The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.  Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item. For money movement products such as Auth and Transfer, if the Item is at Chase or PNC, calling `/item/remove` will invalidate the TAN, and subsequent ACH transfer attempts using that TAN will be returned.  In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available.  Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint.  Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager.  API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.  # noqa: E501
+        The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.  Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item.   In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available.  Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint.  Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager.  API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -27688,7 +27698,7 @@ def oauth_token(
     ):
         """Create or refresh an OAuth access token  # noqa: E501
 
-        `/oauth/token` issues an access token and refresh token depending on the `grant_type` provided:   - `refresh_token` allows refreshing an access token using a refresh token. Only the `refresh_token` field is required.   - `urn:ietf:params:oauth:grant-type:token-exchange` allows exchanging a subject token for an OAuth token. The following `subject_token_type`s are supported:     - `urn:plaid:params:tokensdb::user-token` allows exchanging a Plaid-issued user token for an OAuth token. `audience` must be the same as the `client_id`. `subject_token` must be a Plaid-issued user token issued from the `/user/create` endpoint.     - `urn:plaid:params:oauth::user-token` allows exchanging a refresh token for an OAuth token to another `client_id`. The other `client_id` is provided in `audience`. `subject_token` must be an OAuth refresh token issued from the `/oauth/token` endpoint.  Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.  # noqa: E501
+        `/oauth/token` issues an access token and refresh token depending on the `grant_type` provided. This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -30178,7 +30188,7 @@ def processor_signal_decision_report(
     ):
         """Report whether you initiated an ACH transaction  # noqa: E501
 
-        After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated.  If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.  # noqa: E501
+        After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated.  If you are using the [Plaid Transfer product](https://plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -30427,7 +30437,7 @@ def processor_signal_return_report(
     ):
         """Report a return for an ACH transaction  # noqa: E501
 
-        Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.  If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.  # noqa: E501
+        Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.  If you are using the [Plaid Transfer product](https://plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -36735,7 +36745,7 @@ def transfer_migrate_account(
     ):
         """Migrate account into Transfers  # noqa: E501
 
-        As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints.  If you require access to other endpoints, create the Item through Link instead.  Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.  # noqa: E501
+        As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints.  If you require access to other endpoints, create the Item through Link instead.  Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager or [Support](https://dashboard.plaid.com/support).  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -38572,6 +38582,7 @@ def user_create(
             user_create_request (UserCreateRequest):
 
         Keyword Args:
+            plaid_new_user_api_enabled (str): The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -38738,6 +38749,7 @@ def user_remove(
             user_remove_request (UserRemoveRequest):
 
         Keyword Args:
+            plaid_new_user_api_enabled (str): The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object

plaid/api_client.py

@@ -3,7 +3,7 @@
 
     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.635.2
+    The version of the OpenAPI document: 2020-09-14_1.627.4
     Generated by: https://openapi-generator.tech
 """
 
@@ -76,7 +76,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Plaid Python v31.0.0'
+        self.user_agent = 'Plaid Python v32.0.0'
 
     def __enter__(self):
         return self

plaid/configuration.py

@@ -3,7 +3,7 @@
 
     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.635.2
+    The version of the OpenAPI document: 2020-09-14_1.627.4
     Generated by: https://openapi-generator.tech
 """
 
@@ -431,8 +431,8 @@ def to_debug_report(self):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 2020-09-14_1.635.2\n"\
-               "SDK Package Version: 31.0.0".\
+               "Version of the API: 2020-09-14_1.627.4\n"\
+               "SDK Package Version: 32.0.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

plaid/exceptions.py

@@ -3,7 +3,7 @@
 
     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.635.2
+    The version of the OpenAPI document: 2020-09-14_1.627.4
     Generated by: https://openapi-generator.tech
 """
 

plaid/model/account_access.py

@@ -3,7 +3,7 @@
 
     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.635.2
+    The version of the OpenAPI document: 2020-09-14_1.627.4
     Generated by: https://openapi-generator.tech
 """
 

plaid/model/account_assets.py

@@ -3,7 +3,7 @@
 
     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.635.2
+    The version of the OpenAPI document: 2020-09-14_1.627.4
     Generated by: https://openapi-generator.tech
 """
 

plaid/model/account_balance.py

@@ -3,7 +3,7 @@
 
     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.635.2
+    The version of the OpenAPI document: 2020-09-14_1.627.4
     Generated by: https://openapi-generator.tech
 """