Skip to content

Commit 0e2f9d9

Browse files
otherchenAndrew Chen
otherchen
and
Andrew Chen
authored
OpenAPI generated code at 2021-10-15T19:46:09Z (plaid#374)
Co-authored-by: Andrew Chen <[email protected]>
1 parent 950d04d commit 0e2f9d9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+2132
-157
lines changed

‎.openapi-generator/FILES

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ plaid/model/credit_filter.py
114114
plaid/model/customer_initiated_return_risk.py
115115
plaid/model/customer_initiated_risk_tier.py
116116
plaid/model/deductions.py
117+
plaid/model/deductions_breakdown.py
118+
plaid/model/deductions_total.py
117119
plaid/model/default_update_webhook.py
118120
plaid/model/deposit_switch_address_data.py
119121
plaid/model/deposit_switch_alt_create_request.py
@@ -129,18 +131,23 @@ plaid/model/deposit_switch_target_user.py
129131
plaid/model/deposit_switch_token_create_request.py
130132
plaid/model/deposit_switch_token_create_response.py
131133
plaid/model/depository_filter.py
132-
plaid/model/distribution_details.py
134+
plaid/model/distribution_breakdown.py
133135
plaid/model/document_metadata.py
134136
plaid/model/earnings.py
137+
plaid/model/earnings_breakdown.py
135138
plaid/model/earnings_total.py
136139
plaid/model/email.py
137140
plaid/model/employee.py
138141
plaid/model/employee_income_summary_field_string.py
139142
plaid/model/employer.py
140143
plaid/model/employer_income_summary_field_string.py
144+
plaid/model/employer_verification.py
141145
plaid/model/employers_search_request.py
142146
plaid/model/employers_search_response.py
143147
plaid/model/employment_details.py
148+
plaid/model/employment_verification.py
149+
plaid/model/employment_verification_get_request.py
150+
plaid/model/employment_verification_get_response.py
144151
plaid/model/error.py
145152
plaid/model/external_payment_options.py
146153
plaid/model/external_payment_refund_details.py
@@ -163,14 +170,15 @@ plaid/model/income_summary.py
163170
plaid/model/income_summary_field_number.py
164171
plaid/model/income_summary_field_string.py
165172
plaid/model/income_verification_create_request.py
173+
plaid/model/income_verification_create_request_options.py
166174
plaid/model/income_verification_create_response.py
167175
plaid/model/income_verification_documents_download_request.py
168-
plaid/model/income_verification_documents_download_response.py
169176
plaid/model/income_verification_paystub_get_request.py
170177
plaid/model/income_verification_paystub_get_response.py
171178
plaid/model/income_verification_paystubs_get_request.py
172179
plaid/model/income_verification_paystubs_get_response.py
173180
plaid/model/income_verification_precheck_employer.py
181+
plaid/model/income_verification_precheck_employer_address.py
174182
plaid/model/income_verification_precheck_military_info.py
175183
plaid/model/income_verification_precheck_request.py
176184
plaid/model/income_verification_precheck_response.py
@@ -325,6 +333,7 @@ plaid/model/paystub_ytd_details.py
325333
plaid/model/pending_expiration_webhook.py
326334
plaid/model/personal_finance_category.py
327335
plaid/model/phone_number.py
336+
plaid/model/platform_ids.py
328337
plaid/model/processor_apex_processor_token_create_request.py
329338
plaid/model/processor_auth_get_request.py
330339
plaid/model/processor_auth_get_response.py

‎CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
See full changelog for the OpenAPI Schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
22

3+
## 8.4.0
4+
- Updating to OAS 2020-09-14_1.36.1
5+
36
## 8.3.0
47
- Updating to OAS 2020-09-14_1.34.1.
58
- Fixed an issue with enums in this library. The library is supposed to be able to gracefully handle

‎plaid/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"""
99

1010

11-
__version__ = "8.3.0"
11+
__version__ = "8.4.0"
1212

1313
# import ApiClient
1414
from plaid.api_client import ApiClient

‎plaid/api/plaid_api.py

Lines changed: 125 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@
7373
from plaid.model.deposit_switch_token_create_response import DepositSwitchTokenCreateResponse
7474
from plaid.model.employers_search_request import EmployersSearchRequest
7575
from plaid.model.employers_search_response import EmployersSearchResponse
76+
from plaid.model.employment_verification_get_request import EmploymentVerificationGetRequest
77+
from plaid.model.employment_verification_get_response import EmploymentVerificationGetResponse
7678
from plaid.model.error import Error
7779
from plaid.model.identity_get_request import IdentityGetRequest
7880
from plaid.model.identity_get_response import IdentityGetResponse
@@ -3871,6 +3873,128 @@ def __employers_search(
38713873
callable=__employers_search
38723874
)
38733875

3876+
def __employment_verification_get(
3877+
self,
3878+
employment_verification_get_request,
3879+
**kwargs
3880+
):
3881+
"""Retrieve a summary of an individual's employment information. # noqa: E501
3882+
3883+
`/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. # noqa: E501
3884+
This method makes a synchronous HTTP request by default. To make an
3885+
asynchronous HTTP request, please pass async_req=True
3886+
3887+
>>> thread = api.employment_verification_get(employment_verification_get_request, async_req=True)
3888+
>>> result = thread.get()
3889+
3890+
Args:
3891+
employment_verification_get_request (EmploymentVerificationGetRequest):
3892+
3893+
Keyword Args:
3894+
_return_http_data_only (bool): response data without head status
3895+
code and headers. Default is True.
3896+
_preload_content (bool): if False, the urllib3.HTTPResponse object
3897+
will be returned without reading/decoding response data.
3898+
Default is True.
3899+
_request_timeout (float/tuple): timeout setting for this request. If one
3900+
number provided, it will be total request timeout. It can also
3901+
be a pair (tuple) of (connection, read) timeouts.
3902+
Default is None.
3903+
_check_input_type (bool): specifies if type checking
3904+
should be done one the data sent to the server.
3905+
Default is True.
3906+
_check_return_type (bool): specifies if type checking
3907+
should be done one the data received from the server.
3908+
Default is True.
3909+
_host_index (int/None): specifies the index of the server
3910+
that we want to use.
3911+
Default is read from the configuration.
3912+
async_req (bool): execute request asynchronously
3913+
3914+
Returns:
3915+
EmploymentVerificationGetResponse
3916+
If the method is called asynchronously, returns the request
3917+
thread.
3918+
"""
3919+
kwargs['async_req'] = kwargs.get(
3920+
'async_req', False
3921+
)
3922+
kwargs['_return_http_data_only'] = kwargs.get(
3923+
'_return_http_data_only', True
3924+
)
3925+
kwargs['_preload_content'] = kwargs.get(
3926+
'_preload_content', True
3927+
)
3928+
kwargs['_request_timeout'] = kwargs.get(
3929+
'_request_timeout', None
3930+
)
3931+
kwargs['_check_input_type'] = kwargs.get(
3932+
'_check_input_type', True
3933+
)
3934+
kwargs['_check_return_type'] = kwargs.get(
3935+
'_check_return_type', True
3936+
)
3937+
kwargs['_host_index'] = kwargs.get('_host_index')
3938+
kwargs['employment_verification_get_request'] = \
3939+
employment_verification_get_request
3940+
return self.call_with_http_info(**kwargs)
3941+
3942+
self.employment_verification_get = _Endpoint(
3943+
settings={
3944+
'response_type': (EmploymentVerificationGetResponse,),
3945+
'auth': [
3946+
'clientId',
3947+
'plaidVersion',
3948+
'secret'
3949+
],
3950+
'endpoint_path': '/employment/verification/get',
3951+
'operation_id': 'employment_verification_get',
3952+
'http_method': 'POST',
3953+
'servers': None,
3954+
},
3955+
params_map={
3956+
'all': [
3957+
'employment_verification_get_request',
3958+
],
3959+
'required': [
3960+
'employment_verification_get_request',
3961+
],
3962+
'nullable': [
3963+
],
3964+
'enum': [
3965+
],
3966+
'validation': [
3967+
]
3968+
},
3969+
root_map={
3970+
'validations': {
3971+
},
3972+
'allowed_values': {
3973+
},
3974+
'openapi_types': {
3975+
'employment_verification_get_request':
3976+
(EmploymentVerificationGetRequest,),
3977+
},
3978+
'attribute_map': {
3979+
},
3980+
'location_map': {
3981+
'employment_verification_get_request': 'body',
3982+
},
3983+
'collection_format_map': {
3984+
}
3985+
},
3986+
headers_map={
3987+
'accept': [
3988+
'application/json'
3989+
],
3990+
'content_type': [
3991+
'application/json'
3992+
]
3993+
},
3994+
api_client=api_client,
3995+
callable=__employment_verification_get
3996+
)
3997+
38743998
def __identity_get(
38753999
self,
38764000
identity_get_request,
@@ -4122,7 +4246,7 @@ def __income_verification_documents_download(
41224246
):
41234247
"""Download the original documents used for income verification # noqa: E501
41244248
4125-
`/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
4249+
`/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
41264250
This method makes a synchronous HTTP request by default. To make an
41274251
asynchronous HTTP request, please pass async_req=True
41284252

‎plaid/api_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
7474
self.default_headers[header_name] = header_value
7575
self.cookie = cookie
7676
# Set default User-Agent.
77-
self.user_agent = 'Plaid Python v8.3.0'
77+
self.user_agent = 'Plaid Python v8.4.0'
7878

7979
def __enter__(self):
8080
return self

‎plaid/configuration.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -427,8 +427,8 @@ def to_debug_report(self):
427427
return "Python SDK Debug Report:\n"\
428428
"OS: {env}\n"\
429429
"Python Version: {pyversion}\n"\
430-
"Version of the API: 2020-09-14_1.34.1\n"\
431-
"SDK Package Version: 8.3.0".\
430+
"Version of the API: 2020-09-14_1.39.0\n"\
431+
"SDK Package Version: 8.4.0".\
432432
format(env=sys.platform, pyversion=sys.version)
433433

434434
def get_host_settings(self):

‎plaid/model/asset_report_create_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class AssetReportCreateRequest(ModelNormal):
6262
'min_items': 1,
6363
},
6464
('days_requested',): {
65-
'inclusive_maximum': 730,
65+
'inclusive_maximum': 731,
6666
'inclusive_minimum': 0,
6767
},
6868
}

‎plaid/model/asset_report_create_request_options.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ def openapi_types():
7575
"""
7676
lazy_import()
7777
return {
78-
'client_report_id': (str,), # noqa: E501
79-
'webhook': (str,), # noqa: E501
78+
'client_report_id': (str, none_type,), # noqa: E501
79+
'webhook': (str, none_type,), # noqa: E501
8080
'user': (AssetReportUser,), # noqa: E501
8181
}
8282

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

‎plaid/model/asset_report_get_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ def __init__(self, asset_report_token, *args, **kwargs): # noqa: E501
139139
_visited_composed_classes = (Animal,)
140140
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
141141
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
142-
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
142+
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
143143
"""
144144

145145
_check_type = kwargs.pop('_check_type', True)

‎plaid/model/asset_report_refresh_request.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class AssetReportRefreshRequest(ModelNormal):
5858

5959
validations = {
6060
('days_requested',): {
61-
'inclusive_maximum': 730,
61+
'inclusive_maximum': 731,
6262
'inclusive_minimum': 0,
6363
},
6464
}
@@ -82,7 +82,7 @@ def openapi_types():
8282
'asset_report_token': (str,), # noqa: E501
8383
'client_id': (str,), # noqa: E501
8484
'secret': (str,), # noqa: E501
85-
'days_requested': (int,), # noqa: E501
85+
'days_requested': (int, none_type,), # noqa: E501
8686
'options': (AssetReportRefreshRequestOptions,), # noqa: E501
8787
}
8888

@@ -150,7 +150,7 @@ def __init__(self, asset_report_token, *args, **kwargs): # noqa: E501
150150
_visited_composed_classes = (Animal,)
151151
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
152152
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
153-
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
153+
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
154154
options (AssetReportRefreshRequestOptions): [optional] # noqa: E501
155155
"""
156156

‎plaid/model/asset_report_refresh_request_options.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ def openapi_types():
7575
"""
7676
lazy_import()
7777
return {
78-
'client_report_id': (str,), # noqa: E501
79-
'webhook': (str,), # noqa: E501
78+
'client_report_id': (str, none_type,), # noqa: E501
79+
'webhook': (str, none_type,), # noqa: E501
8080
'user': (AssetReportUser,), # noqa: E501
8181
}
8282

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

‎plaid/model/credit_card_liability.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ def openapi_types():
8888
'last_payment_amount': (float,), # noqa: E501
8989
'last_payment_date': (date,), # noqa: E501
9090
'last_statement_issue_date': (date,), # noqa: E501
91+
'last_statement_balance': (float,), # noqa: E501
9192
'minimum_payment_amount': (float,), # noqa: E501
9293
'next_payment_due_date': (date, none_type,), # noqa: E501
9394
}
@@ -104,6 +105,7 @@ def discriminator():
104105
'last_payment_amount': 'last_payment_amount', # noqa: E501
105106
'last_payment_date': 'last_payment_date', # noqa: E501
106107
'last_statement_issue_date': 'last_statement_issue_date', # noqa: E501
108+
'last_statement_balance': 'last_statement_balance', # noqa: E501
107109
'minimum_payment_amount': 'minimum_payment_amount', # noqa: E501
108110
'next_payment_due_date': 'next_payment_due_date', # noqa: E501
109111
}
@@ -120,7 +122,7 @@ def discriminator():
120122
])
121123

122124
@convert_js_args_to_python_args
123-
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
125+
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
124126
"""CreditCardLiability - a model defined in OpenAPI
125127
126128
Args:
@@ -130,6 +132,7 @@ def __init__(self, account_id, aprs, is_overdue, last_payment_amount, last_payme
130132
last_payment_amount (float): The amount of the last payment.
131133
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.
132134
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).
135+
last_statement_balance (float): The total amount owed as of the last statement issued
133136
minimum_payment_amount (float): The minimum payment due for the next billing cycle.
134137
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).
135138
@@ -195,6 +198,7 @@ def __init__(self, account_id, aprs, is_overdue, last_payment_amount, last_payme
195198
self.last_payment_amount = last_payment_amount
196199
self.last_payment_date = last_payment_date
197200
self.last_statement_issue_date = last_statement_issue_date
201+
self.last_statement_balance = last_statement_balance
198202
self.minimum_payment_amount = minimum_payment_amount
199203
self.next_payment_due_date = next_payment_due_date
200204
for var_name, var_value in kwargs.items():

0 commit comments

Comments
 (0)