def get_categories_using_get_with_http_info(self, country, **kwargs): # noqa: E501
"""Retrieves a list of categories returned by the Yapily Categorisation engine for a given locale # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_categories_using_get_with_http_info(country, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str country: country (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(ApiListResponseOfCategory, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'country'
]
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 get_categories_using_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'country' is set
if self.api_client.client_side_validation and ('country' not in local_var_params or # noqa: E501
local_var_params['country'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `country` when calling `get_categories_using_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'country' in local_var_params:
path_params['country'] = local_var_params['country'] # 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;charset=UTF-8']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth', 'tokenAuth'] # noqa: E501
return self.api_client.call_api(
'/categories/{country}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiListResponseOfCategory', # 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 oauth_token_with_http_info(self, grant_type, **kwargs): # noqa: E501
"""Retrieve Access Token # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.oauth_token_with_http_info(grant_type, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str grant_type: Grant type (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(YapilyAccessToken, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['grant_type']
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 oauth_token" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'grant_type' is set
if self.api_client.client_side_validation and (
'grant_type' not in local_var_params or # noqa: E501
local_var_params['grant_type'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `grant_type` when calling `oauth_token`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
if 'grant_type' in local_var_params:
form_params.append(
('grant_type', local_var_params['grant_type'])) # noqa: E501
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/x-www-form-urlencoded']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/oauth/token',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='YapilyAccessToken', # 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 get_statements_using_get_with_http_info(self, consent, account_id, **kwargs): # noqa: E501
"""Get account statements # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_statements_using_get_with_http_info(consent, account_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str consent: Consent Token (required)
:param str account_id: accountId (required)
:param str _from: from
:param str before: before
:param int limit: limit
:param str sort: sort
:param int offset: offset
: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(ApiListResponseOfAccountStatement, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'consent',
'account_id',
'_from',
'before',
'limit',
'sort',
'offset'
]
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 get_statements_using_get" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'consent' is set
if self.api_client.client_side_validation and ('consent' not in local_var_params or # noqa: E501
local_var_params['consent'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `consent` when calling `get_statements_using_get`") # noqa: E501
# verify the required parameter 'account_id' is set
if self.api_client.client_side_validation and ('account_id' not in local_var_params or # noqa: E501
local_var_params['account_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `account_id` when calling `get_statements_using_get`") # noqa: E501
collection_formats = {}
path_params = {}
if 'account_id' in local_var_params:
path_params['accountId'] = local_var_params['account_id'] # noqa: E501
query_params = []
if '_from' in local_var_params and local_var_params['_from'] is not None: # noqa: E501
query_params.append(('from', local_var_params['_from'])) # noqa: E501
if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501
query_params.append(('before', local_var_params['before'])) # noqa: E501
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 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501
query_params.append(('sort', local_var_params['sort'])) # 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
header_params = {}
if 'consent' in local_var_params:
header_params['consent'] = local_var_params['consent'] # noqa: E501
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json;charset=UTF-8']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth', 'tokenAuth'] # noqa: E501
return self.api_client.call_api(
'/accounts/{accountId}/statements', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiListResponseOfAccountStatement', # 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 update_embedded_payment_authorisation_using_put_with_http_info(
self, consent_id, payment_auth_request, **kwargs): # noqa: E501
"""Update an embedded payment initiation with SCA info # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_embedded_payment_authorisation_using_put_with_http_info(consent_id, payment_auth_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str consent_id: Consent Id (required)
:param PaymentEmbeddedAuthorisationRequest payment_auth_request: paymentAuthRequest (required)
:param str x_yapily_api_version: Api Version
:param str psu_id: PSU ID
:param str psu_corporate_id: PSU ID CORPORATE
:param str psu_ip_address: PSU IP ADDRESS
: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(ApiResponseOfPaymentEmbeddedAuthorisationRequestResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'consent_id', 'payment_auth_request', 'x_yapily_api_version',
'psu_id', 'psu_corporate_id', 'psu_ip_address'
]
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 update_embedded_payment_authorisation_using_put"
% key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'consent_id' is set
if self.api_client.client_side_validation and (
'consent_id' not in local_var_params or # noqa: E501
local_var_params['consent_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `consent_id` when calling `update_embedded_payment_authorisation_using_put`"
) # noqa: E501
# verify the required parameter 'payment_auth_request' is set
if self.api_client.client_side_validation and (
'payment_auth_request' not in local_var_params or # noqa: E501
local_var_params['payment_auth_request'] is None
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `payment_auth_request` when calling `update_embedded_payment_authorisation_using_put`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'consent_id' in local_var_params:
path_params['consentId'] = local_var_params[
'consent_id'] # noqa: E501
query_params = []
header_params = {}
if 'x_yapily_api_version' in local_var_params:
header_params['x-yapily-api-version'] = local_var_params[
'x_yapily_api_version'] # noqa: E501
if 'psu_id' in local_var_params:
header_params['psu-id'] = local_var_params['psu_id'] # noqa: E501
if 'psu_corporate_id' in local_var_params:
header_params['psu-corporate-id'] = local_var_params[
'psu_corporate_id'] # noqa: E501
if 'psu_ip_address' in local_var_params:
header_params['psu-ip-address'] = local_var_params[
'psu_ip_address'] # noqa: E501
form_params = []
local_var_files = {}
body_params = None
if 'payment_auth_request' in local_var_params:
body_params = local_var_params['payment_auth_request']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json;charset=UTF-8']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json;charset=UTF-8']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth', 'tokenAuth'] # noqa: E501
return self.api_client.call_api(
'/embedded-payment-auth-requests/{consentId}',
'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=
'ApiResponseOfPaymentEmbeddedAuthorisationRequestResponse', # 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_payment_with_sort_code_using_post_with_http_info(
self, consent, payment_request, **kwargs): # noqa: E501
"""Create a new single payment # 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_payment_with_sort_code_using_post_with_http_info(consent, payment_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str consent: Consent Token (required)
:param SortCodePaymentRequest payment_request: paymentRequest (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(ApiResponseOfPaymentResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['consent', 'payment_request']
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_payment_with_sort_code_using_post" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'consent' is set
if self.api_client.client_side_validation and (
'consent' not in local_var_params or # noqa: E501
local_var_params['consent'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `consent` when calling `create_payment_with_sort_code_using_post`"
) # noqa: E501
# verify the required parameter 'payment_request' is set
if self.api_client.client_side_validation and (
'payment_request' not in local_var_params or # noqa: E501
local_var_params['payment_request'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `payment_request` when calling `create_payment_with_sort_code_using_post`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
if 'consent' in local_var_params:
header_params['consent'] = local_var_params[
'consent'] # noqa: E501
form_params = []
local_var_files = {}
body_params = None
if 'payment_request' in local_var_params:
body_params = local_var_params['payment_request']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json;charset=UTF-8']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json;charset=UTF-8']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth', 'tokenAuth'] # noqa: E501
return self.api_client.call_api(
'/payment-sortcode',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiResponseOfPaymentResponse', # 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 get_application_me_using_get_with_http_info(self,
**kwargs): # noqa: E501
"""Returns the details of the application that owns the request credentials # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_application_me_using_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(Application, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = []
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 get_application_me_using_get" %
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
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json;charset=UTF-8']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth', 'tokenAuth'] # noqa: E501
return self.api_client.call_api(
'/me',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Application', # 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 delete_user_using_delete_with_http_info(self, user_uuid,
**kwargs): # noqa: E501
"""Delete an application user and sub-resources (including consent resources on institution APIs if they exist) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_user_using_delete_with_http_info(user_uuid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str user_uuid: userUuid (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(ApiResponseOfUserDeleteResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['user_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 delete_user_using_delete" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'user_uuid' is set
if self.api_client.client_side_validation and (
'user_uuid' not in local_var_params or # noqa: E501
local_var_params['user_uuid'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `user_uuid` when calling `delete_user_using_delete`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'user_uuid' in local_var_params:
path_params['userUuid'] = local_var_params[
'user_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;charset=UTF-8']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth', 'tokenAuth'] # noqa: E501
return self.api_client.call_api(
'/users/{userUuid}',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiResponseOfUserDeleteResponse', # 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 get_users_using_get_with_http_info(self, **kwargs): # noqa: E501
"""Get application users # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_users_using_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str x_yapily_api_version: Api Version
:param list[str] filter_application_user_id: Filter users by the provided application user Id (applicationUserId) when the user was created.
: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(list[ApplicationUser], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['x_yapily_api_version', 'filter_application_user_id']
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 get_users_using_get" % key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'filter_application_user_id' in local_var_params and local_var_params[
'filter_application_user_id'] is not None: # noqa: E501
query_params.append(
('filter[applicationUserId]',
local_var_params['filter_application_user_id'])) # noqa: E501
collection_formats[
'filter[applicationUserId]'] = 'multi' # noqa: E501
header_params = {}
if 'x_yapily_api_version' in local_var_params:
header_params['x-yapily-api-version'] = local_var_params[
'x_yapily_api_version'] # noqa: E501
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json;charset=UTF-8']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth', 'tokenAuth'] # noqa: E501
return self.api_client.call_api(
'/users',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[ApplicationUser]', # 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 get_user_consents_using_get_with_http_info(self, user_uuid,
**kwargs): # noqa: E501
"""Get latest user consents # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_user_consents_using_get_with_http_info(user_uuid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str user_uuid: userUuid (required)
:param str filter_institution: Use this parameter to filter consent by institution, using the Yapily institution Id. This replaces the deprecated `institutionId` query param.
:param int limit: Use this parameter to limit consent results, max limit is 20
: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(list[Consent], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['user_uuid', 'filter_institution', 'limit']
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 get_user_consents_using_get" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'user_uuid' is set
if self.api_client.client_side_validation and (
'user_uuid' not in local_var_params or # noqa: E501
local_var_params['user_uuid'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `user_uuid` when calling `get_user_consents_using_get`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'user_uuid' in local_var_params:
path_params['userUuid'] = local_var_params[
'user_uuid'] # noqa: E501
query_params = []
if 'filter_institution' in local_var_params and local_var_params[
'filter_institution'] is not None: # noqa: E501
query_params.append(
('filter[institution]',
local_var_params['filter_institution'])) # noqa: E501
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
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json;charset=UTF-8']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth', 'tokenAuth'] # noqa: E501
return self.api_client.call_api(
'/users/{userUuid}/consents',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[Consent]', # 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 get_consents_using_get_with_http_info(self, **kwargs): # noqa: E501
"""Get consents sorted by creation date # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_consents_using_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param list[str] filter_application_user_id: Filter consents by your application user Id (applicationUserId)
:param list[str] filter_user_uuid: Filter consents by Yapily user Id (userUuid)
:param list[str] filter_institution: Use this parameter to filter consent by institution, using the Yapily institution Id
:param list[str] filter_status: Use this parameter to filter consent by status
:param str _from: Use this parameter to filter consents created after the date specified
:param str before: Use this parameter to filter consents created before the date specified
:param int limit: Use this parameter to limit consent results, max limit is 20
:param int offset: Use this parameter to specify the offset of the results
: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(ApiListResponseOfConsent, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'filter_application_user_id', 'filter_user_uuid',
'filter_institution', 'filter_status', '_from', 'before', 'limit',
'offset'
]
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 get_consents_using_get" % key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'filter_application_user_id' in local_var_params and local_var_params[
'filter_application_user_id'] is not None: # noqa: E501
query_params.append(
('filter[applicationUserId]',
local_var_params['filter_application_user_id'])) # noqa: E501
collection_formats[
'filter[applicationUserId]'] = 'multi' # noqa: E501
if 'filter_user_uuid' in local_var_params and local_var_params[
'filter_user_uuid'] is not None: # noqa: E501
query_params.append(
('filter[userUuid]',
local_var_params['filter_user_uuid'])) # noqa: E501
collection_formats['filter[userUuid]'] = 'multi' # noqa: E501
if 'filter_institution' in local_var_params and local_var_params[
'filter_institution'] is not None: # noqa: E501
query_params.append(
('filter[institution]',
local_var_params['filter_institution'])) # noqa: E501
collection_formats['filter[institution]'] = 'multi' # noqa: E501
if 'filter_status' in local_var_params and local_var_params[
'filter_status'] is not None: # noqa: E501
query_params.append(
('filter[status]',
local_var_params['filter_status'])) # noqa: E501
collection_formats['filter[status]'] = 'multi' # noqa: E501
if '_from' in local_var_params and local_var_params[
'_from'] is not None: # noqa: E501
query_params.append(
('from', local_var_params['_from'])) # noqa: E501
if 'before' in local_var_params and local_var_params[
'before'] is not None: # noqa: E501
query_params.append(
('before', local_var_params['before'])) # noqa: E501
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
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json;charset=UTF-8']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth', 'tokenAuth'] # noqa: E501
return self.api_client.call_api(
'/consents',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ApiListResponseOfConsent', # 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)