8.9.0

Author: stephenjayakar

.openapi-generator/FILES

@@ -98,7 +98,6 @@ plaid/model/bank_transfer_network.py
 plaid/model/bank_transfer_receiver_details.py
 plaid/model/bank_transfer_status.py
 plaid/model/bank_transfer_sweep.py
-plaid/model/bank_transfer_sweep_account.py
 plaid/model/bank_transfer_sweep_get_request.py
 plaid/model/bank_transfer_sweep_get_response.py
 plaid/model/bank_transfer_sweep_list_request.py
@@ -186,6 +185,7 @@ plaid/model/income_verification_paystubs_get_response.py
 plaid/model/income_verification_precheck_confidence.py
 plaid/model/income_verification_precheck_employer.py
 plaid/model/income_verification_precheck_employer_address.py
+plaid/model/income_verification_precheck_employer_address_data.py
 plaid/model/income_verification_precheck_military_info.py
 plaid/model/income_verification_precheck_request.py
 plaid/model/income_verification_precheck_response.py
@@ -329,6 +329,7 @@ plaid/model/payment_initiation_refund.py
 plaid/model/payment_initiation_standing_order_metadata.py
 plaid/model/payment_meta.py
 plaid/model/payment_schedule_interval.py
+plaid/model/payment_scheme.py
 plaid/model/payment_status_update_webhook.py
 plaid/model/paystub.py
 plaid/model/paystub_address.py
@@ -346,6 +347,7 @@ plaid/model/paystub_ytd_details.py
 plaid/model/pending_expiration_webhook.py
 plaid/model/personal_finance_category.py
 plaid/model/phone_number.py
+plaid/model/plaid_error.py
 plaid/model/platform_ids.py
 plaid/model/processor_apex_processor_token_create_request.py
 plaid/model/processor_auth_get_request.py
@@ -418,6 +420,7 @@ plaid/model/signal_return_report_response.py
 plaid/model/signal_score.py
 plaid/model/signal_scores.py
 plaid/model/signal_user.py
+plaid/model/simulated_transfer_sweep.py
 plaid/model/standalone_account_type.py
 plaid/model/standalone_currency_code_list.py
 plaid/model/standalone_investment_transaction_type.py

CHANGELOG.md

@@ -1,5 +1,8 @@
 See full changelog for the OpenAPI Schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+## 8.9.0
+- Updating to OAS 2020-09-14_1.61.0
+
 ## 8.8.0
 - Updating to OAS 2020-09-14_1.58.1
 

README.md

@@ -93,6 +93,39 @@ except plaid.ApiException as e:
 
 For more information on Plaid response codes, head to the [docs][3].
 
+## Data type differences from API and from previous versions
+
+### Converting the response to a JSON
+
+As this is a common question, we've included this in the README. `plaid-python` uses models like `TransactionsGetResponse` to encapsulate API responses. If you want to convert this to a JSON, do something like this:
+
+```python
+import json
+...
+response = ... # type TransactionsGetResponse
+# to_dict makes it first a python dictionary, and then we turn it into a string JSON.
+json_string = json.dumps(response.to_dict())
+```
+
+### Dates
+
+Dates and date times in requests and responses, which are represented as strings in the API and in previous client library versions, are represented in this version of the 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.
+
+### Enums
+While the API and previous library versions represent enums using strings, this current library uses Python classes with restricted values.
+
+Old:
+```
+'products': ['auth', 'transactions'],
+'country_codes': ['US'],
+```
+
+Current:
+```
+products=[Products('auth'), Products('transactions')],
+country_codes=[CountryCode('US')],
+```
+
 ## Examples
 
 ### Create an Item using Link
@@ -186,16 +219,6 @@ FILE.write(pdf.read())
 FILE.close()
 ```
 
-### Retrieve Other Data
-Most other item data can be retrieved by following this pattern:
-```python
-import plaid
-from plaid.model.auth_get_request import AuthGetRequest
-
-response = client.Auth.get(access_token)
-numbers = response['numbers']
-```
-
 ### Authentication
 
 Public endpoints (category information) require no authentication and can be
@@ -207,6 +230,7 @@ categories = client.categories_get({})
 
 Authenticated endpoints require a `(client_id, secret)` pair. You do not need to pass in authentication to individual endpoints once you have set it on the `plaid.Configuration` object.
 
+
 ## Contributing
 
 Please see [Contributing](CONTRIBUTING.md) for guidelines and instructions for local development.

plaid/__init__.py

@@ -8,7 +8,7 @@
 """
 
 
-__version__ = "8.8.0"
+__version__ = "8.9.0"
 
 # import ApiClient
 from plaid.api_client import ApiClient

plaid/api/plaid_api.py

@@ -364,7 +364,7 @@ def __accounts_get(
         ):
             """Retrieve accounts  # noqa: E501
 
-            The `/accounts/get`  endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.  This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead.  # noqa: E501
+            The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance.  This endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/webhooks/#item-new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you.  This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead. Note that some information is nullable.  # noqa: E501
             This method makes a synchronous HTTP request by default. To make an
             asynchronous HTTP request, please pass async_req=True
 
@@ -10116,9 +10116,9 @@ def __sandbox_transfer_sweep_simulate(
             sandbox_transfer_sweep_simulate_request,
             **kwargs
         ):
-            """Simulate creating a sweep for a set of transfers  # noqa: E501
+            """Simulate creating a sweep  # noqa: E501
 
-            Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment.  # noqa: E501
+            Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment.  - All `posted` or `pending` Transfers with sweep_status `unswept` will become `swept` - All `reversed` Transfers with sweep_status `swept` will become `reverse_swept`  # noqa: E501
             This method makes a synchronous HTTP request by default. To make an
             asynchronous HTTP request, please pass async_req=True
 

plaid/api_client.py

@@ -74,7 +74,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 v8.8.0'
+        self.user_agent = 'Plaid Python v8.9.0'
 
     def __enter__(self):
         return self

plaid/configuration.py

@@ -427,8 +427,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.58.1\n"\
-               "SDK Package Version: 8.8.0".\
+               "Version of the API: 2020-09-14_1.61.0\n"\
+               "SDK Package Version: 8.9.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

plaid/model/asset_report.py

@@ -85,7 +85,7 @@ def openapi_types():
         lazy_import()
         return {
             'asset_report_id': (str,),  # noqa: E501
-            'client_report_id': (str,),  # noqa: E501
+            'client_report_id': (str, none_type,),  # noqa: E501
             'date_generated': (datetime,),  # noqa: E501
             'days_requested': (float,),  # noqa: E501
             'user': (AssetReportUser,),  # noqa: E501
@@ -123,7 +123,7 @@ def __init__(self, asset_report_id, client_report_id, date_generated, days_reque
 
         Args:
             asset_report_id (str): A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.
-            client_report_id (str): An identifier you determine and submit for the Asset Report.
+            client_report_id (str, none_type): An identifier you determine and submit for the Asset Report.
             date_generated (datetime): The date and time when the Asset Report was created, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (e.g. \"2018-04-12T03:32:11Z\").
             days_requested (float): The duration of transaction history you requested
             user (AssetReportUser):

plaid/model/assets_error_webhook.py

@@ -25,8 +25,8 @@
 )
 
 def lazy_import():
-    from plaid.model.error import Error
-    globals()['Error'] = Error
+    from plaid.model.plaid_error import PlaidError
+    globals()['PlaidError'] = PlaidError
 
 
 class AssetsErrorWebhook(ModelNormal):
@@ -84,7 +84,7 @@ def openapi_types():
         return {
             'webhook_type': (str,),  # noqa: E501
             'webhook_code': (str,),  # noqa: E501
-            'error': (Error,),  # noqa: E501
+            'error': (PlaidError,),  # noqa: E501
             'asset_report_id': (str,),  # noqa: E501
         }
 
@@ -118,7 +118,7 @@ def __init__(self, webhook_type, webhook_code, error, asset_report_id, *args, **
         Args:
             webhook_type (str): `ASSETS`
             webhook_code (str): `ERROR`
-            error (Error):
+            error (PlaidError):
             asset_report_id (str): The ID associated with the Asset Report.
 
         Keyword Args:

plaid/model/bank_transfer_create_request.py

@@ -193,7 +193,7 @@ def __init__(self, idempotency_key, access_token, account_id, type, network, amo
             ach_class (ACHClass): [optional]  # noqa: E501
             custom_tag (str, none_type): An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.. [optional]  # noqa: E501
             metadata (BankTransferMetadata): [optional]  # noqa: E501
-            origination_account_id (str, none_type): Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified.. [optional]  # noqa: E501
+            origination_account_id (str, none_type): Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

plaid/model/bank_transfer_sweep.py

@@ -24,10 +24,6 @@
     validate_get_composed_info,
 )
 
-def lazy_import():
-    from plaid.model.bank_transfer_sweep_account import BankTransferSweepAccount
-    globals()['BankTransferSweepAccount'] = BankTransferSweepAccount
-
 
 class BankTransferSweep(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
@@ -65,7 +61,6 @@ def additional_properties_type():
         This must be a method because a model may have properties that are
         of type self, this must run after the class is loaded
         """
-        lazy_import()
         return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
 
     _nullable = False
@@ -80,14 +75,11 @@ def openapi_types():
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
-        lazy_import()
         return {
             'id': (str,),  # noqa: E501
-            'transfer_id': (str, none_type,),  # noqa: E501
             'created_at': (datetime,),  # noqa: E501
             'amount': (str,),  # noqa: E501
             'iso_currency_code': (str,),  # noqa: E501
-            'sweep_account': (BankTransferSweepAccount,),  # noqa: E501
         }
 
     @cached_property
@@ -97,11 +89,9 @@ def discriminator():
 
     attribute_map = {
         'id': 'id',  # noqa: E501
-        'transfer_id': 'transfer_id',  # noqa: E501
         'created_at': 'created_at',  # noqa: E501
         'amount': 'amount',  # noqa: E501
         'iso_currency_code': 'iso_currency_code',  # noqa: E501
-        'sweep_account': 'sweep_account',  # noqa: E501
     }
 
     _composed_schemas = {}
@@ -116,16 +106,14 @@ def discriminator():
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, id, transfer_id, created_at, amount, iso_currency_code, sweep_account, *args, **kwargs):  # noqa: E501
+    def __init__(self, id, created_at, amount, iso_currency_code, *args, **kwargs):  # noqa: E501
         """BankTransferSweep - a model defined in OpenAPI
 
         Args:
             id (str): Identifier of the sweep.
-            transfer_id (str, none_type): Identifier of the sweep transfer.
             created_at (datetime): The datetime when the sweep occurred, in RFC 3339 format.
             amount (str): The amount of the sweep.
             iso_currency_code (str): The currency of the sweep, e.g. \"USD\".
-            sweep_account (BankTransferSweepAccount):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -184,11 +172,9 @@ def __init__(self, id, transfer_id, created_at, amount, iso_currency_code, sweep
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         self.id = id
-        self.transfer_id = transfer_id
         self.created_at = created_at
         self.amount = amount
         self.iso_currency_code = iso_currency_code
-        self.sweep_account = sweep_account
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \

plaid/model/bank_transfer_sweep_get_request.py

@@ -73,7 +73,6 @@ def openapi_types():
             'sweep_id': (str,),  # noqa: E501
             'client_id': (str,),  # noqa: E501
             'secret': (str,),  # noqa: E501
-            'origination_account_id': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -85,7 +84,6 @@ def discriminator():
         'sweep_id': 'sweep_id',  # noqa: E501
         'client_id': 'client_id',  # noqa: E501
         'secret': 'secret',  # noqa: E501
-        'origination_account_id': 'origination_account_id',  # noqa: E501
     }
 
     _composed_schemas = {}
@@ -139,7 +137,6 @@ def __init__(self, sweep_id, *args, **kwargs):  # noqa: E501
                                 _visited_composed_classes = (Animal,)
             client_id (str): Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.. [optional]  # noqa: E501
             secret (str): Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.. [optional]  # noqa: E501
-            origination_account_id (str, none_type): If multiple origination accounts are available, `origination_account_id` must be used to specify the account that the sweep belongs to.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

plaid/model/cause.py

@@ -25,8 +25,8 @@
 )
 
 def lazy_import():
-    from plaid.model.error import Error
-    globals()['Error'] = Error
+    from plaid.model.plaid_error import PlaidError
+    globals()['PlaidError'] = PlaidError
 
 
 class Cause(ModelNormal):
@@ -83,7 +83,7 @@ def openapi_types():
         lazy_import()
         return {
             'item_id': (str,),  # noqa: E501
-            'error': (Error,),  # noqa: E501
+            'error': (PlaidError,),  # noqa: E501
         }
 
     @cached_property
@@ -113,7 +113,7 @@ def __init__(self, item_id, error, *args, **kwargs):  # noqa: E501
 
         Args:
             item_id (str): The `item_id` of the Item associated with this webhook, warning, or error
-            error (Error):
+            error (PlaidError):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types

plaid/model/credit_card_liability.py

@@ -86,7 +86,7 @@ def openapi_types():
             'aprs': ([APR],),  # noqa: E501
             'is_overdue': (bool, none_type,),  # noqa: E501
             'last_payment_amount': (float,),  # noqa: E501
-            'last_payment_date': (date,),  # noqa: E501
+            'last_payment_date': (date, none_type,),  # noqa: E501
             'last_statement_issue_date': (date,),  # noqa: E501
             'last_statement_balance': (float,),  # noqa: E501
             'minimum_payment_amount': (float,),  # noqa: E501
@@ -130,7 +130,7 @@ def __init__(self, account_id, aprs, is_overdue, last_payment_amount, last_payme
             aprs ([APR]): The various interest rates that apply to the account.
             is_overdue (bool, none_type): true if a payment is currently overdue. Availability for this field is limited.
             last_payment_amount (float): The amount of the last payment.
-            last_payment_date (date): The date of the last payment. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Availability for this field is limited.
+            last_payment_date (date, none_type): The date of the last payment. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Availability for this field is limited.
             last_statement_issue_date (date): The date of the last statement. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
             last_statement_balance (float): The total amount owed as of the last statement issued
             minimum_payment_amount (float): The minimum payment due for the next billing cycle.

plaid/model/default_update_webhook.py

@@ -25,8 +25,8 @@
 )
 
 def lazy_import():
-    from plaid.model.error import Error
-    globals()['Error'] = Error
+    from plaid.model.plaid_error import PlaidError
+    globals()['PlaidError'] = PlaidError
 
 
 class DefaultUpdateWebhook(ModelNormal):
@@ -86,7 +86,7 @@ def openapi_types():
             'webhook_code': (str,),  # noqa: E501
             'new_transactions': (float,),  # noqa: E501
             'item_id': (str,),  # noqa: E501
-            'error': (Error,),  # noqa: E501
+            'error': (PlaidError,),  # noqa: E501
         }
 
     @cached_property
@@ -154,7 +154,7 @@ def __init__(self, webhook_type, webhook_code, new_transactions, item_id, *args,
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            error (Error): [optional]  # noqa: E501
+            error (PlaidError): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)