def create_financial_requirement_with_http_info(self,
**kwargs): # noqa: E501
"""Create a new FinancialRequirement # noqa: E501
Create a new FinancialRequirement record # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_financial_requirement_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param FinancialRequirement financial_requirement:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: 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.
:return: tuple(FinancialRequirement, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['financial_requirement']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method create_financial_requirement" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'financial_requirement' in local_var_params:
body_params = local_var_params['financial_requirement']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
[
'application/json', 'application/x-www-form-urlencoded',
'multipart/form-data'
]) # noqa: E501
# Authentication setting
auth_settings = ['API_Key'] # noqa: E501
return self.api_client.call_api(
'/v1/financial-requirement',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FinancialRequirement', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def retrieve_financial_requirement_with_http_info(self, uuid,
**kwargs): # noqa: E501
"""Retrieve a FinancialRequirement # noqa: E501
Retrieve a FinancialRequirement # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.retrieve_financial_requirement_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str uuid: (required)
:param str borrower_uuid: Borrower to filter results for
:param str search: A search term.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: 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.
:return: tuple(FinancialRequirement, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['uuid', 'borrower_uuid', 'search']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method retrieve_financial_requirement" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'uuid' is set
if self.api_client.client_side_validation and (
'uuid' not in local_var_params or # noqa: E501
local_var_params['uuid'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `uuid` when calling `retrieve_financial_requirement`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'uuid' in local_var_params:
path_params['uuid'] = local_var_params['uuid'] # noqa: E501
query_params = []
if 'borrower_uuid' in local_var_params and local_var_params[
'borrower_uuid'] is not None: # noqa: E501
query_params.append(
('borrower_uuid',
local_var_params['borrower_uuid'])) # noqa: E501
if 'search' in local_var_params and local_var_params[
'search'] is not None: # noqa: E501
query_params.append(
('search', local_var_params['search'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_Key'] # noqa: E501
return self.api_client.call_api(
'/v1/financial-requirement/{uuid}',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FinancialRequirement', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def list_financial_requirements_with_http_info(self,
**kwargs): # noqa: E501
"""List FinancialRequirements # noqa: E501
List FinancialRequirement records # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_financial_requirements_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int limit: Number of results to return per page.
:param int offset: The initial index from which to return the results.
:param str borrower_uuid: Borrower to filter results for
:param str search: A search term.
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: 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.
:return: tuple(InlineResponse2004, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['limit', 'offset', 'borrower_uuid', 'search']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method list_financial_requirements" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'limit' in local_var_params and local_var_params[
'limit'] is not None: # noqa: E501
query_params.append(
('limit', local_var_params['limit'])) # noqa: E501
if 'offset' in local_var_params and local_var_params[
'offset'] is not None: # noqa: E501
query_params.append(
('offset', local_var_params['offset'])) # noqa: E501
if 'borrower_uuid' in local_var_params and local_var_params[
'borrower_uuid'] is not None: # noqa: E501
query_params.append(
('borrower_uuid',
local_var_params['borrower_uuid'])) # noqa: E501
if 'search' in local_var_params and local_var_params[
'search'] is not None: # noqa: E501
query_params.append(
('search', local_var_params['search'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_Key'] # noqa: E501
return self.api_client.call_api(
'/v1/financial-requirement',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='InlineResponse2004', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def create_document_file_with_http_info(self, **kwargs): # noqa: E501
"""Submit a new DocumentFile # noqa: E501
Add a new file to Fincura for processing. The minimal document creation request requires just a borrower_uuid and the media_type of the file to process. POST /v1/document-file HTTP/1.1 Host: api-local.fincura.com:8000 Accept: application/json Authorization: Bearer eyJ0e...nFTRKTbcg Content-Type: application/json { \"borrower_uuid\": \"6e64724a-25fc-4e1a-8071-1ef29845ab1d\", \"media_type\": \"application/pdf\"\" } The above request will create a new document record in Fincura and return a url to send the file to, as seen below. { \"uuid\": \"18ef4ec9-b313-49a3-81c6-8c486f956df3\", \"upload_url\": \"https://upload.fincura.com/18ef4ec9-b313-49a3-81c6-8c486f956df3/document.pdf?signature=mWFg4xsgm4EtFEt\" } In a subsequent request, the file can be sent to the `upload_url` via [HTTP PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT). The `Content-Length` and `Content-Type` headers are required. The `Content-Type` should match the `media_type` from the previous request. PUT /18ef4ec9-b313-49a3-81c6-8c486f956df3/document.pdf?signature=mWFg4xsgm4EtFEt HTTP/1.1 Host: upload.fincura.com Content-Length: 18828 Content-Type: application/pdf {FILE DATA} Fincura will begin processing the file once it has been completely uploaded. Additional fields described below: # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_document_file_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param DocumentFileCreate document_file_create:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: 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.
:return: tuple(DocumentFileCreate, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['document_file_create']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method create_document_file" % key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'document_file_create' in local_var_params:
body_params = local_var_params['document_file_create']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
[
'application/json', 'application/x-www-form-urlencoded',
'multipart/form-data'
]) # noqa: E501
# Authentication setting
auth_settings = ['API_Key'] # noqa: E501
return self.api_client.call_api(
'/v1/document-file',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DocumentFileCreate', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def destroy_webhook_with_http_info(self, uuid, **kwargs): # noqa: E501
"""Delete a webhook # noqa: E501
Delete a webhook from Fincura. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.destroy_webhook_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str uuid: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: 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.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['uuid']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method destroy_webhook" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'uuid' is set
if self.api_client.client_side_validation and (
'uuid' not in local_var_params or # noqa: E501
local_var_params['uuid'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `uuid` when calling `destroy_webhook`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'uuid' in local_var_params:
path_params['uuid'] = local_var_params['uuid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['API_Key'] # noqa: E501
return self.api_client.call_api(
'/v1/webhook/{uuid}',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def retrieve_data_view_from_document_file_with_http_info(
self, document_file_uuid, **kwargs): # noqa: E501
"""Get DataView from a DocumentFile # noqa: E501
Retrieve a DataView from the standardized output of a DocumentFile submitted to Fincura # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.retrieve_data_view_from_document_file_with_http_info(document_file_uuid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str document_file_uuid: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: 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.
:return: tuple(DataView, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['document_file_uuid']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method retrieve_data_view_from_document_file" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'document_file_uuid' is set
if self.api_client.client_side_validation and (
'document_file_uuid' not in local_var_params or # noqa: E501
local_var_params['document_file_uuid'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `document_file_uuid` when calling `retrieve_data_view_from_document_file`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'document_file_uuid' in local_var_params:
path_params['document_file_uuid'] = local_var_params[
'document_file_uuid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['API_Key'] # noqa: E501
return self.api_client.call_api(
'/v1/data-view/from_document_file/{document_file_uuid}',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DataView', # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
