OpenAPI generated code at 2021-10-15T19:46:09Z

.openapi-generator/FILES

@@ -114,6 +114,8 @@ plaid/model/credit_filter.py
 plaid/model/customer_initiated_return_risk.py
 plaid/model/customer_initiated_risk_tier.py
 plaid/model/deductions.py
+plaid/model/deductions_breakdown.py
+plaid/model/deductions_total.py
 plaid/model/default_update_webhook.py
 plaid/model/deposit_switch_address_data.py
 plaid/model/deposit_switch_alt_create_request.py
@@ -129,18 +131,23 @@ plaid/model/deposit_switch_target_user.py
 plaid/model/deposit_switch_token_create_request.py
 plaid/model/deposit_switch_token_create_response.py
 plaid/model/depository_filter.py
-plaid/model/distribution_details.py
+plaid/model/distribution_breakdown.py
 plaid/model/document_metadata.py
 plaid/model/earnings.py
+plaid/model/earnings_breakdown.py
 plaid/model/earnings_total.py
 plaid/model/email.py
 plaid/model/employee.py
 plaid/model/employee_income_summary_field_string.py
 plaid/model/employer.py
 plaid/model/employer_income_summary_field_string.py
+plaid/model/employer_verification.py
 plaid/model/employers_search_request.py
 plaid/model/employers_search_response.py
 plaid/model/employment_details.py
+plaid/model/employment_verification.py
+plaid/model/employment_verification_get_request.py
+plaid/model/employment_verification_get_response.py
 plaid/model/error.py
 plaid/model/external_payment_options.py
 plaid/model/external_payment_refund_details.py
@@ -163,14 +170,15 @@ plaid/model/income_summary.py
 plaid/model/income_summary_field_number.py
 plaid/model/income_summary_field_string.py
 plaid/model/income_verification_create_request.py
+plaid/model/income_verification_create_request_options.py
 plaid/model/income_verification_create_response.py
 plaid/model/income_verification_documents_download_request.py
-plaid/model/income_verification_documents_download_response.py
 plaid/model/income_verification_paystub_get_request.py
 plaid/model/income_verification_paystub_get_response.py
 plaid/model/income_verification_paystubs_get_request.py
 plaid/model/income_verification_paystubs_get_response.py
 plaid/model/income_verification_precheck_employer.py
+plaid/model/income_verification_precheck_employer_address.py
 plaid/model/income_verification_precheck_military_info.py
 plaid/model/income_verification_precheck_request.py
 plaid/model/income_verification_precheck_response.py
@@ -325,6 +333,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/platform_ids.py
 plaid/model/processor_apex_processor_token_create_request.py
 plaid/model/processor_auth_get_request.py
 plaid/model/processor_auth_get_response.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.4.0
+- Updating to OAS 2020-09-14_1.36.1
+
 ## 8.3.0
 - Updating to OAS 2020-09-14_1.34.1.
 - Fixed an issue with enums in this library. The library is supposed to be able to gracefully handle

plaid/__init__.py

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

plaid/api/plaid_api.py

@@ -73,6 +73,8 @@
 from plaid.model.deposit_switch_token_create_response import DepositSwitchTokenCreateResponse
 from plaid.model.employers_search_request import EmployersSearchRequest
 from plaid.model.employers_search_response import EmployersSearchResponse
+from plaid.model.employment_verification_get_request import EmploymentVerificationGetRequest
+from plaid.model.employment_verification_get_response import EmploymentVerificationGetResponse
 from plaid.model.error import Error
 from plaid.model.identity_get_request import IdentityGetRequest
 from plaid.model.identity_get_response import IdentityGetResponse
@@ -3871,6 +3873,128 @@ def __employers_search(
             callable=__employers_search
         )
 
+        def __employment_verification_get(
+            self,
+            employment_verification_get_request,
+            **kwargs
+        ):
+            """Retrieve a summary of an individual's employment information.  # noqa: E501
+
+            `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user.  # noqa: E501
+            This method makes a synchronous HTTP request by default. To make an
+            asynchronous HTTP request, please pass async_req=True
+
+            >>> thread = api.employment_verification_get(employment_verification_get_request, async_req=True)
+            >>> result = thread.get()
+
+            Args:
+                employment_verification_get_request (EmploymentVerificationGetRequest):
+
+            Keyword Args:
+                _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
+                    will be returned without reading/decoding response data.
+                    Default is True.
+                _request_timeout (float/tuple): timeout setting for this request. If one
+                    number provided, it will be total request timeout. It can also
+                    be a pair (tuple) of (connection, read) timeouts.
+                    Default is None.
+                _check_input_type (bool): specifies if type checking
+                    should be done one the data sent to the server.
+                    Default is True.
+                _check_return_type (bool): specifies if type checking
+                    should be done one the data received from the server.
+                    Default is True.
+                _host_index (int/None): specifies the index of the server
+                    that we want to use.
+                    Default is read from the configuration.
+                async_req (bool): execute request asynchronously
+
+            Returns:
+                EmploymentVerificationGetResponse
+                    If the method is called asynchronously, returns the request
+                    thread.
+            """
+            kwargs['async_req'] = kwargs.get(
+                'async_req', False
+            )
+            kwargs['_return_http_data_only'] = kwargs.get(
+                '_return_http_data_only', True
+            )
+            kwargs['_preload_content'] = kwargs.get(
+                '_preload_content', True
+            )
+            kwargs['_request_timeout'] = kwargs.get(
+                '_request_timeout', None
+            )
+            kwargs['_check_input_type'] = kwargs.get(
+                '_check_input_type', True
+            )
+            kwargs['_check_return_type'] = kwargs.get(
+                '_check_return_type', True
+            )
+            kwargs['_host_index'] = kwargs.get('_host_index')
+            kwargs['employment_verification_get_request'] = \
+                employment_verification_get_request
+            return self.call_with_http_info(**kwargs)
+
+        self.employment_verification_get = _Endpoint(
+            settings={
+                'response_type': (EmploymentVerificationGetResponse,),
+                'auth': [
+                    'clientId',
+                    'plaidVersion',
+                    'secret'
+                ],
+                'endpoint_path': '/employment/verification/get',
+                'operation_id': 'employment_verification_get',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'employment_verification_get_request',
+                ],
+                'required': [
+                    'employment_verification_get_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'employment_verification_get_request':
+                        (EmploymentVerificationGetRequest,),
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                    'employment_verification_get_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client,
+            callable=__employment_verification_get
+        )
+
         def __identity_get(
             self,
             identity_get_request,
@@ -4122,7 +4246,7 @@ def __income_verification_documents_download(
         ):
             """Download the original documents used for income verification  # noqa: E501
 
-            `/income/verification/documents/download` provides the ability to download the source paystub PDF that the end user uploaded via Paystub Import.  The response to `/income/verification/documents/download` is a ZIP file in binary data. The `request_id`  is returned in the `Plaid-Request-ID` header.  For Payroll Income, the most recent file available for download with the payroll provider will also be available from this endpoint.  # noqa: E501
+            `/income/verification/documents/download` provides the ability to download the source documents associated with the verification.  If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint.  The response to `/income/verification/documents/download` is ZIP file in binary data. If a document_id is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification.  The `request_id` is returned in the `Plaid-Request-ID` header.  # 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.3.0'
+        self.user_agent = 'Plaid Python v8.4.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.34.1\n"\
-               "SDK Package Version: 8.3.0".\
+               "Version of the API: 2020-09-14_1.39.0\n"\
+               "SDK Package Version: 8.4.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

plaid/model/asset_report_create_request.py

@@ -62,7 +62,7 @@ class AssetReportCreateRequest(ModelNormal):
             'min_items': 1,
         },
         ('days_requested',): {
-            'inclusive_maximum': 730,
+            'inclusive_maximum': 731,
             'inclusive_minimum': 0,
         },
     }

plaid/model/asset_report_create_request_options.py

@@ -75,8 +75,8 @@ def openapi_types():
         """
         lazy_import()
         return {
-            'client_report_id': (str,),  # noqa: E501
-            'webhook': (str,),  # noqa: E501
+            'client_report_id': (str, none_type,),  # noqa: E501
+            'webhook': (str, none_type,),  # noqa: E501
             'user': (AssetReportUser,),  # noqa: E501
         }
 
@@ -137,8 +137,8 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            client_report_id (str): Client-generated identifier, which can be used by lenders to track loan applications.. [optional]  # noqa: E501
-            webhook (str): URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.. [optional]  # noqa: E501
+            client_report_id (str, none_type): Client-generated identifier, which can be used by lenders to track loan applications.. [optional]  # noqa: E501
+            webhook (str, none_type): URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.. [optional]  # noqa: E501
             user (AssetReportUser): [optional]  # noqa: E501
         """
 

plaid/model/asset_report_get_request.py

@@ -139,7 +139,7 @@ def __init__(self, asset_report_token, *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
-            include_insights (bool): `true` if you would like to retrieve the Asset Report with Insights, `false` otherwise. This field defaults to `false` if omitted.. [optional]  # noqa: E501
+            include_insights (bool): `true` if you would like to retrieve the Asset Report with Insights, `false` otherwise. This field defaults to `false` if omitted.. [optional] if omitted the server will use the default value of False  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

plaid/model/asset_report_refresh_request.py

@@ -58,7 +58,7 @@ class AssetReportRefreshRequest(ModelNormal):
 
     validations = {
         ('days_requested',): {
-            'inclusive_maximum': 730,
+            'inclusive_maximum': 731,
             'inclusive_minimum': 0,
         },
     }
@@ -82,7 +82,7 @@ def openapi_types():
             'asset_report_token': (str,),  # noqa: E501
             'client_id': (str,),  # noqa: E501
             'secret': (str,),  # noqa: E501
-            'days_requested': (int,),  # noqa: E501
+            'days_requested': (int, none_type,),  # noqa: E501
             'options': (AssetReportRefreshRequestOptions,),  # noqa: E501
         }
 
@@ -150,7 +150,7 @@ def __init__(self, asset_report_token, *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
-            days_requested (int): The maximum number of days of history to include in the Asset Report. Must be an integer. If not specified, the value from the original call to `/asset_report/create` will be used.. [optional]  # noqa: E501
+            days_requested (int, none_type): The maximum number of days of history to include in the Asset Report. Must be an integer. If not specified, the value from the original call to `/asset_report/create` will be used.. [optional]  # noqa: E501
             options (AssetReportRefreshRequestOptions): [optional]  # noqa: E501
         """
 

plaid/model/asset_report_refresh_request_options.py

@@ -75,8 +75,8 @@ def openapi_types():
         """
         lazy_import()
         return {
-            'client_report_id': (str,),  # noqa: E501
-            'webhook': (str,),  # noqa: E501
+            'client_report_id': (str, none_type,),  # noqa: E501
+            'webhook': (str, none_type,),  # noqa: E501
             'user': (AssetReportUser,),  # noqa: E501
         }
 
@@ -137,8 +137,8 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            client_report_id (str): Client-generated identifier, which can be used by lenders to track loan applications.. [optional]  # noqa: E501
-            webhook (str): URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.. [optional]  # noqa: E501
+            client_report_id (str, none_type): Client-generated identifier, which can be used by lenders to track loan applications.. [optional]  # noqa: E501
+            webhook (str, none_type): URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.. [optional]  # noqa: E501
             user (AssetReportUser): [optional]  # noqa: E501
         """
 

plaid/model/credit_card_liability.py

@@ -88,6 +88,7 @@ def openapi_types():
             'last_payment_amount': (float,),  # noqa: E501
             'last_payment_date': (date,),  # noqa: E501
             'last_statement_issue_date': (date,),  # noqa: E501
+            'last_statement_balance': (float,),  # noqa: E501
             'minimum_payment_amount': (float,),  # noqa: E501
             'next_payment_due_date': (date, none_type,),  # noqa: E501
         }
@@ -104,6 +105,7 @@ def discriminator():
         'last_payment_amount': 'last_payment_amount',  # noqa: E501
         'last_payment_date': 'last_payment_date',  # noqa: E501
         'last_statement_issue_date': 'last_statement_issue_date',  # noqa: E501
+        'last_statement_balance': 'last_statement_balance',  # noqa: E501
         'minimum_payment_amount': 'minimum_payment_amount',  # noqa: E501
         'next_payment_due_date': 'next_payment_due_date',  # noqa: E501
     }
@@ -120,7 +122,7 @@ def discriminator():
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, account_id, aprs, is_overdue, last_payment_amount, last_payment_date, last_statement_issue_date, minimum_payment_amount, next_payment_due_date, *args, **kwargs):  # noqa: E501
+    def __init__(self, account_id, aprs, is_overdue, last_payment_amount, last_payment_date, last_statement_issue_date, last_statement_balance, minimum_payment_amount, next_payment_due_date, *args, **kwargs):  # noqa: E501
         """CreditCardLiability - a model defined in OpenAPI
 
         Args:
@@ -130,6 +132,7 @@ def __init__(self, account_id, aprs, is_overdue, last_payment_amount, last_payme
             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_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.
             next_payment_due_date (date, none_type): The due date for the next payment. The due date is `null` if a payment is not expected. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
 
@@ -195,6 +198,7 @@ def __init__(self, account_id, aprs, is_overdue, last_payment_amount, last_payme
         self.last_payment_amount = last_payment_amount
         self.last_payment_date = last_payment_date
         self.last_statement_issue_date = last_statement_issue_date
+        self.last_statement_balance = last_statement_balance
         self.minimum_payment_amount = minimum_payment_amount
         self.next_payment_due_date = next_payment_due_date
         for var_name, var_value in kwargs.items():