def get_sle_config_with_http_info(self, param, **kwargs): # noqa: E501
"""Returns the current value of a SLE configuration parameter # 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_sle_config_with_http_info(param, async_req=True)
>>> result = thread.get()
:param async_req bool
:param SleConfigParams param: Name of the parameter to return (required)
:return: SleConfigParamsValues
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['param'] # noqa: E501
all_params.append('authentication')
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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_sle_config" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'param' is set
if ('param' not in local_var_params
or local_var_params['param'] is None):
raise ApiValueError(
"Missing the required parameter `param` when calling `get_sle_config`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'param' in local_var_params:
path_params['param'] = local_var_params['param'] # 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
if 'authentication' in local_var_params:
auth_settings = [local_var_params['authentication']]
else:
auth_settings = []
return self.api_client.call_api(
'/sle-config/{param}',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SleConfigParamsValues', # 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_x_com_value_with_http_info(self, dag_id, dag_run_id, task_id,
xcom_key, x_com,
**kwargs): # noqa: E501
"""Update an XCom entry # 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_x_com_value_with_http_info(dag_id, dag_run_id, task_id, xcom_key, x_com, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str dag_id: The DAG ID. (required)
:param str dag_run_id: The DAG Run ID. (required)
:param str task_id: The Task ID. (required)
:param str xcom_key: The XCom Key. (required)
:param XCom x_com: (required)
:param list[str] update_mask: The fields to update on the connection (connection, pool etc). If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields.
: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(XCom, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'dag_id', 'dag_run_id', 'task_id', 'xcom_key', 'x_com',
'update_mask'
]
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_x_com_value" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'dag_id' is set
if self.api_client.client_side_validation and (
'dag_id' not in local_var_params or # noqa: E501
local_var_params['dag_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `dag_id` when calling `update_x_com_value`"
) # noqa: E501
# verify the required parameter 'dag_run_id' is set
if self.api_client.client_side_validation and (
'dag_run_id' not in local_var_params or # noqa: E501
local_var_params['dag_run_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `dag_run_id` when calling `update_x_com_value`"
) # noqa: E501
# verify the required parameter 'task_id' is set
if self.api_client.client_side_validation and (
'task_id' not in local_var_params or # noqa: E501
local_var_params['task_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `task_id` when calling `update_x_com_value`"
) # noqa: E501
# verify the required parameter 'xcom_key' is set
if self.api_client.client_side_validation and (
'xcom_key' not in local_var_params or # noqa: E501
local_var_params['xcom_key'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `xcom_key` when calling `update_x_com_value`"
) # noqa: E501
# verify the required parameter 'x_com' is set
if self.api_client.client_side_validation and (
'x_com' not in local_var_params or # noqa: E501
local_var_params['x_com'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `x_com` when calling `update_x_com_value`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'dag_id' in local_var_params:
path_params['dag_id'] = local_var_params['dag_id'] # noqa: E501
if 'dag_run_id' in local_var_params:
path_params['dag_run_id'] = local_var_params[
'dag_run_id'] # noqa: E501
if 'task_id' in local_var_params:
path_params['task_id'] = local_var_params['task_id'] # noqa: E501
if 'xcom_key' in local_var_params:
path_params['xcom_key'] = local_var_params[
'xcom_key'] # noqa: E501
query_params = []
if 'update_mask' in local_var_params and local_var_params[
'update_mask'] is not None: # noqa: E501
query_params.append(
('update_mask', local_var_params['update_mask'])) # noqa: E501
collection_formats['update_mask'] = 'csv' # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'x_com' in local_var_params:
body_params = local_var_params['x_com']
# 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']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{key}',
'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='XCom', # 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 template_controller_delete_by_id_with_http_info(
self, id, **kwargs): # noqa: E501
"""template_controller_delete_by_id # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.template_controller_delete_by_id_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: (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 = ['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 template_controller_delete_by_id" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and (
'id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `id` when calling `template_controller_delete_by_id`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/templates/{id}',
'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 get_instruments_details_with_http_info(self, consumerKey, sessionToken, instrumentTokens, **kwargs): # noqa: E501
"""Get full details # noqa: E501
Get full details # 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_instruments_details_with_http_info(consumerKey, sessionToken, instrumentTokens, async_req=True)
>>> result = thread.get()
:param consumerKey: (required)
:type consumerKey: str
:param sessionToken: (required)
:type sessionToken: str
:param instrumentTokens: (required)
:type instrumentTokens: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
: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.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(list[Instrument], status_code(int), headers(HTTPHeaderDict))
"""
local_var_params = locals()
all_params = [
'consumerKey',
'sessionToken',
'instrumentTokens'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth'
]
)
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_instruments_details" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'consumerKey' is set
if self.api_client.client_side_validation and ('consumerKey' not in local_var_params or # noqa: E501
local_var_params['consumerKey'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `consumerKey` when calling `get_instruments_details`") # noqa: E501
# verify the required parameter 'sessionToken' is set
if self.api_client.client_side_validation and ('sessionToken' not in local_var_params or # noqa: E501
local_var_params['sessionToken'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `sessionToken` when calling `get_instruments_details`") # noqa: E501
# verify the required parameter 'instrumentTokens' is set
if self.api_client.client_side_validation and ('instrumentTokens' not in local_var_params or # noqa: E501
local_var_params['instrumentTokens'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `instrumentTokens` when calling `get_instruments_details`") # noqa: E501
collection_formats = {}
path_params = {}
if 'instrumentTokens' in local_var_params:
path_params['instrumentTokens'] = local_var_params['instrumentTokens'] # noqa: E501
query_params = []
header_params = {}
if 'consumerKey' in local_var_params:
header_params['consumerKey'] = local_var_params['consumerKey'] # noqa: E501
if 'sessionToken' in local_var_params:
header_params['sessionToken'] = local_var_params['sessionToken'] # noqa: E501
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 = ['bearerAuth'] # noqa: E501
return self.api_client.call_api(
'/quotes/v1.0/instruments/{instrumentTokens}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[Instrument]', # 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,
_request_auth=local_var_params.get('_request_auth'))
def get_x_com_entry_with_http_info(self, dag_id, dag_run_id, task_id,
**kwargs): # noqa: E501
"""Get all XCom entries # noqa: E501
This endpoint allows specifying `~` as the dag_id, dag_run_id, task_id to retrieve XCOM entries for for all DAGs, DAG Runs and task instances. # 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_x_com_entry_with_http_info(dag_id, dag_run_id, task_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str dag_id: The DAG ID. (required)
:param str dag_run_id: The DAG Run ID. (required)
:param str task_id: The Task ID. (required)
:param int limit: The numbers of items to return.
:param int offset: The number of items to skip before starting to collect the result set.
: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(XComCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['dag_id', 'dag_run_id', 'task_id', '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_x_com_entry" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'dag_id' is set
if self.api_client.client_side_validation and (
'dag_id' not in local_var_params or # noqa: E501
local_var_params['dag_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `dag_id` when calling `get_x_com_entry`"
) # noqa: E501
# verify the required parameter 'dag_run_id' is set
if self.api_client.client_side_validation and (
'dag_run_id' not in local_var_params or # noqa: E501
local_var_params['dag_run_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `dag_run_id` when calling `get_x_com_entry`"
) # noqa: E501
# verify the required parameter 'task_id' is set
if self.api_client.client_side_validation and (
'task_id' not in local_var_params or # noqa: E501
local_var_params['task_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `task_id` when calling `get_x_com_entry`"
) # noqa: E501
if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params[
'limit'] < 1: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `limit` when calling `get_x_com_entry`, must be a value greater than or equal to `1`"
) # noqa: E501
if self.api_client.client_side_validation and 'offset' in local_var_params and local_var_params[
'offset'] < 0: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `offset` when calling `get_x_com_entry`, must be a value greater than or equal to `0`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'dag_id' in local_var_params:
path_params['dag_id'] = local_var_params['dag_id'] # noqa: E501
if 'dag_run_id' in local_var_params:
path_params['dag_run_id'] = local_var_params[
'dag_run_id'] # noqa: E501
if 'task_id' in local_var_params:
path_params['task_id'] = local_var_params['task_id'] # noqa: E501
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
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 = [] # noqa: E501
return self.api_client.call_api(
'/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='XComCollection', # 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 add_identity_link_with_http_info(self, id, **kwargs): # noqa: E501
"""add_identity_link # noqa: E501
Adds an identity link to a task by id. Can be used to link any user or group to a task and specify a relation. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.add_identity_link_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: The id of the task to add a link to. (required)
:param IdentityLinkDto identity_link_dto:
: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 = ['id', 'identity_link_dto']
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 add_identity_link" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and (
'id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `id` when calling `add_identity_link`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'identity_link_dto' in local_var_params:
body_params = local_var_params['identity_link_dto']
# 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']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/task/{id}/identity-links',
'POST',
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 get_bank_deposits_key_with_http_info(self, key,
**kwargs): # noqa: E501
"""Returns a Bank Deposit # noqa: E501
Returns a Bank Deposit ### Endpoint Availability * Accounting: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area `Bank`: Read Only, Restricted Access, Full Access # 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_bank_deposits_key_with_http_info(key, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str key: The Bank Deposit Key. (required)
:param str nested_attributes: Specify the attributes that you want to expose for nested entities of the Deposit (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)
:param bool show_legacy_id: Display the legacy_id for the Deposit.
:param str attributes: Specify the attributes that you want to expose for the Deposit (expose all attributes with 'all'). These are in addition to the base attributes (name, path)
: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(BankDeposit, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'key', 'nested_attributes', 'show_legacy_id', 'attributes'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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_bank_deposits_key" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'key' is set
if self.api_client.client_side_validation and (
'key' not in local_var_params or # noqa: E501
local_var_params['key'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `key` when calling `get_bank_deposits_key`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'key' in local_var_params:
path_params['key'] = local_var_params['key'] # noqa: E501
query_params = []
if 'nested_attributes' in local_var_params and local_var_params[
'nested_attributes'] is not None: # noqa: E501
query_params.append(
('nested_attributes',
local_var_params['nested_attributes'])) # noqa: E501
if 'show_legacy_id' in local_var_params and local_var_params[
'show_legacy_id'] is not None: # noqa: E501
query_params.append(
('show_legacy_id',
local_var_params['show_legacy_id'])) # noqa: E501
if 'attributes' in local_var_params and local_var_params[
'attributes'] is not None: # noqa: E501
query_params.append(
('attributes', local_var_params['attributes'])) # 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 = [] # noqa: E501
return self.api_client.call_api(
'/bank_deposits/{key}',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='BankDeposit', # 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 api_videostream_video_id_get_with_http_info(self, video_id,
**kwargs): # noqa: E501
"""api_videostream_video_id_get # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_videostream_video_id_get_with_http_info(video_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int video_id: (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(file, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['video_id'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 api_videostream_video_id_get" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'video_id' is set
if ('video_id' not in local_var_params
or local_var_params['video_id'] is None):
raise ApiValueError(
"Missing the required parameter `video_id` when calling `api_videostream_video_id_get`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'video_id' in local_var_params:
path_params['videoId'] = local_var_params['video_id'] # 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/octet-stream']) # noqa: E501
# Authentication setting
auth_settings = ['bearer'] # noqa: E501
return self.api_client.call_api(
'/api/Videostream/{videoId}',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='file', # 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 api_videostream_post_with_http_info(self, **kwargs): # noqa: E501
"""api_videostream_post # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_videostream_post_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param Video video:
: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(UlTokenModel, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['video'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 api_videostream_post" % 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 'video' in local_var_params:
body_params = local_var_params['video']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['text/plain', 'application/json', 'text/json']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json', 'text/json',
'application/*+json']) # noqa: E501
# Authentication setting
auth_settings = ['bearer'] # noqa: E501
return self.api_client.call_api(
'/api/Videostream',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='UlTokenModel', # 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 api_web_vehicle_controller_index_with_http_info(self, **kwargs): # noqa: E501
"""api_web_vehicle_controller_index # noqa: E501
List of vehicles (buses, ferries, and trains) ## Direction ### World To figure out which way the vehicle is pointing at the location, use `/data/{index}/attributes/bearing`. This can be the compass bearing, or the direction towards the next stop or intermediate location. ### Trip To get the direction around the stops in the trip use `/data/{index}/attributes/direction_id`. ## Location ### World Use `/data/{index}/attributes/latitude` and `/data/{index}/attributes/longitude` to get the location of a vehicle. ### Trip Use `/data/{index}/attributes/current_stop_sequence` to get the stop number along the trip. Useful for linear stop indicators. Position relative to the current stop is in `/data/{index}/attributes/current_status`. ## Movement ### World Use `/data/{index}/attributes/speed` to get the speed of the vehicle in meters per second. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_web_vehicle_controller_index_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page_offset: Offset (0-based) of first element in the page
:param int page_limit: Max number of elements to return
:param str sort: Results can be [sorted](http://jsonapi.org/format/#fetching-sorting) by the id or any `/data/{index}/attributes` key. Assumes ascending; may be prefixed with '-' for descending | JSON pointer | Direction | `sort` | |--------------|-----------|------------| | `/data/{index}/attributes/bearing` | ascending | `bearing` | | `/data/{index}/attributes/bearing` | descending | `-bearing` | | `/data/{index}/attributes/current_status` | ascending | `current_status` | | `/data/{index}/attributes/current_status` | descending | `-current_status` | | `/data/{index}/attributes/current_stop_sequence` | ascending | `current_stop_sequence` | | `/data/{index}/attributes/current_stop_sequence` | descending | `-current_stop_sequence` | | `/data/{index}/attributes/direction_id` | ascending | `direction_id` | | `/data/{index}/attributes/direction_id` | descending | `-direction_id` | | `/data/{index}/attributes/label` | ascending | `label` | | `/data/{index}/attributes/label` | descending | `-label` | | `/data/{index}/attributes/latitude` | ascending | `latitude` | | `/data/{index}/attributes/latitude` | descending | `-latitude` | | `/data/{index}/attributes/longitude` | ascending | `longitude` | | `/data/{index}/attributes/longitude` | descending | `-longitude` | | `/data/{index}/attributes/speed` | ascending | `speed` | | `/data/{index}/attributes/speed` | descending | `-speed` | | `/data/{index}/attributes/updated_at` | ascending | `updated_at` | | `/data/{index}/attributes/updated_at` | descending | `-updated_at` |
:param str fields_vehicle: Fields to include with the response. Multiple fields **MUST** be a comma-separated (U+002C COMMA, \",\") list. Note that fields can also be selected for included data types: see the [V3 API Best Practices](https://www.mbta.com/developers/v3-api/best-practices) for an example.
:param str include: Relationships to include. * `trip` * `stop` * `route` The value of the include parameter **MUST** be a comma-separated (U+002C COMMA, \",\") list of relationship paths. A relationship path is a dot-separated (U+002E FULL-STOP, \".\") list of relationship names. [JSONAPI \"include\" behavior](http://jsonapi.org/format/#fetching-includes) | include | Description | |---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `trip` | The trip which the vehicle is currently operating. | | `stop` | The vehicle's current (when `current_status` is **STOPPED_AT**) or *next* stop. | | `route` | The one route that is designated for that trip, as in GTFS `trips.txt`. A trip might also provide service on other routes, identified by the MBTA's `multi_route_trips.txt` GTFS extension. `filter[route]` does consider the multi_route_trips GTFS extension, so it is possible to filter for one route and get a different route included in the response. |
:param str filter_id: Filter by multiple IDs. Multiple IDs **MUST** be a comma-separated (U+002C COMMA, \",\") list. Cannot be combined with any other filter.
:param str filter_trip: Filter by `/data/{index}/relationships/trip/data/id`. Multiple `/data/{index}/relationships/trip/data/id` **MUST** be a comma-separated (U+002C COMMA, \",\") list. Cannot be combined with any other filter.
:param str filter_label: Filter by label. Multiple `label` **MUST** be a comma-separated (U+002C COMMA, \",\") list.
:param str filter_route: Filter by route. If the vehicle is on a [multi-route trip](https://groups.google.com/forum/#!msg/massdotdevelopers/1egrhNjT9eA/iy6NFymcCgAJ), it will be returned for any of the routes. Multiple `route_id` **MUST** be a comma-separated (U+002C COMMA, \",\") list.
:param str filter_direction_id: Filter by direction of travel along the route. The meaning of `direction_id` varies based on the route. You can programmatically get the direction names from `/routes` `/data/{index}/attributes/direction_names` or `/routes/{id}` `/data/attributes/direction_names`. Only used if `filter[route]` is also present.
:param str filter_route_type: Filter by route_type: https://developers.google.com/transit/gtfs/reference/routes-file. Multiple `route_type` **MUST** be a comma-separated (U+002C COMMA, \",\") list.
: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(Vehicles, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['page_offset', 'page_limit', 'sort', 'fields_vehicle', 'include', 'filter_id', 'filter_trip', 'filter_label', 'filter_route', 'filter_direction_id', 'filter_route_type'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 api_web_vehicle_controller_index" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'page_offset' in local_var_params and local_var_params['page_offset'] < 0: # noqa: E501
raise ApiValueError("Invalid value for parameter `page_offset` when calling `api_web_vehicle_controller_index`, must be a value greater than or equal to `0`") # noqa: E501
if self.api_client.client_side_validation and 'page_limit' in local_var_params and local_var_params['page_limit'] < 1: # noqa: E501
raise ApiValueError("Invalid value for parameter `page_limit` when calling `api_web_vehicle_controller_index`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'page_offset' in local_var_params and local_var_params['page_offset'] is not None: # noqa: E501
query_params.append(('page[offset]', local_var_params['page_offset'])) # noqa: E501
if 'page_limit' in local_var_params and local_var_params['page_limit'] is not None: # noqa: E501
query_params.append(('page[limit]', local_var_params['page_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 'fields_vehicle' in local_var_params and local_var_params['fields_vehicle'] is not None: # noqa: E501
query_params.append(('fields[vehicle]', local_var_params['fields_vehicle'])) # noqa: E501
if 'include' in local_var_params and local_var_params['include'] is not None: # noqa: E501
query_params.append(('include', local_var_params['include'])) # noqa: E501
if 'filter_id' in local_var_params and local_var_params['filter_id'] is not None: # noqa: E501
query_params.append(('filter[id]', local_var_params['filter_id'])) # noqa: E501
if 'filter_trip' in local_var_params and local_var_params['filter_trip'] is not None: # noqa: E501
query_params.append(('filter[trip]', local_var_params['filter_trip'])) # noqa: E501
if 'filter_label' in local_var_params and local_var_params['filter_label'] is not None: # noqa: E501
query_params.append(('filter[label]', local_var_params['filter_label'])) # noqa: E501
if 'filter_route' in local_var_params and local_var_params['filter_route'] is not None: # noqa: E501
query_params.append(('filter[route]', local_var_params['filter_route'])) # noqa: E501
if 'filter_direction_id' in local_var_params and local_var_params['filter_direction_id'] is not None: # noqa: E501
query_params.append(('filter[direction_id]', local_var_params['filter_direction_id'])) # noqa: E501
if 'filter_route_type' in local_var_params and local_var_params['filter_route_type'] is not None: # noqa: E501
query_params.append(('filter[route_type]', local_var_params['filter_route_type'])) # 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/vnd.api+json']) # noqa: E501
# Authentication setting
auth_settings = ['api_key_in_header', 'api_key_in_query'] # noqa: E501
return self.api_client.call_api(
'/vehicles', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Vehicles', # 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 notify_token_update__for_token_state_change_with_http_info(
self, **kwargs): # noqa: E501
"""Outbound API used by MDES to notify the Token Requestor of significant Token updates, such as when the Token is activated, suspended, unsuspended or deleted; or when information about the Token or its product configuration has changed. # noqa: E501
This API is used by MDES to notify the Token Requestor of significant Token updates. Typical notification scenarios include <br> <br> 1. Informing the merchant a token is active 2. Informing the merchant a token has been suspended by the Issuer 3. Informing the merchant a token has been unsuspended by the Issuer 4. Informing the merchant a token has been deleted by the Issuer 5. Informing the merchant of a product configuration change (such as a change in Card Art) 6. Informing the merchant of underlying changes to the FPAN metadata associated to the token<br> __Connection Security__<br> Mastercard will connect via TLS protocol and verify the server certificate before establishing a connection to the client endpoint. During this handshake, the client server can request TLS client authentication. Mastercard will present a client certificate which identifies as “ws.mastercard.com” This client certificate is issued by the Entrust L1K certificate and should be available in most trust stores. <br><br> __Conditional Objects__<br> The contents of the notifyTokenUpdated API will vary depending which of the above scneraios triggered the notification. <br> 1. *productConfig* - Provided when Product Configuration has changed (e.g. such as card art). 2. *tokenInfo* - Provided when either the details of the token or associated FPAN have changed (such as token or PAN expiry). The optional objects will always contain a minimum set of data which be returned regardless of whether or not updates have been made. These fields are denoted as required fields.<br> # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.notify_token_update__for_token_state_change_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param NotifyTokenUpdatedRequestSchema notify_token_updated_request_schema: Contains the details of the request message.
: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(NotifyTokenUpdatedResponseSchema, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['notify_token_updated_request_schema']
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 notify_token_update__for_token_state_change" %
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 'notify_token_updated_request_schema' in local_var_params:
body_params = local_var_params[
'notify_token_updated_request_schema']
# 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']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/digitization/static/1/0/notifyTokenUpdated',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='NotifyTokenUpdatedResponseSchema', # 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 api_web_vehicle_controller_show_with_http_info(self, id, **kwargs): # noqa: E501
"""api_web_vehicle_controller_show # noqa: E501
Single vehicle (bus, ferry, or train) ## Direction ### World To figure out which way the vehicle is pointing at the location, use `/data/attributes/bearing`. This can be the compass bearing, or the direction towards the next stop or intermediate location. ### Trip To get the direction around the stops in the trip use `/data/attributes/direction_id`. ## Location ### World Use `/data/attributes/latitude` and `/data/attributes/longitude` to get the location of a vehicle. ### Trip Use `/data/attributes/current_stop_sequence` to get the stop number along the trip. Useful for linear stop indicators. Position relative to the current stop is in `/data/attributes/current_status`. ## Movement ### World Use `/data/attributes/speed` to get the speed of the vehicle in meters per second. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_web_vehicle_controller_show_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: Unique identifier for a vehicle (required)
:param str fields_vehicle: Fields to include with the response. Multiple fields **MUST** be a comma-separated (U+002C COMMA, \",\") list. Note that fields can also be selected for included data types: see the [V3 API Best Practices](https://www.mbta.com/developers/v3-api/best-practices) for an example.
:param str include: Relationships to include. * `trip` * `stop` * `route` The value of the include parameter **MUST** be a comma-separated (U+002C COMMA, \",\") list of relationship paths. A relationship path is a dot-separated (U+002E FULL-STOP, \".\") list of relationship names. [JSONAPI \"include\" behavior](http://jsonapi.org/format/#fetching-includes) | include | Description | |---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `trip` | The trip which the vehicle is currently operating. | | `stop` | The vehicle's current (when `current_status` is **STOPPED_AT**) or *next* stop. | | `route` | The one route that is designated for that trip, as in GTFS `trips.txt`. A trip might also provide service on other routes, identified by the MBTA's `multi_route_trips.txt` GTFS extension. `filter[route]` does consider the multi_route_trips GTFS extension, so it is possible to filter for one route and get a different route included in the response. |
: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(Vehicle, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'fields_vehicle', 'include'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 api_web_vehicle_controller_show" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and ('id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `id` when calling `api_web_vehicle_controller_show`") # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
if 'fields_vehicle' in local_var_params and local_var_params['fields_vehicle'] is not None: # noqa: E501
query_params.append(('fields[vehicle]', local_var_params['fields_vehicle'])) # noqa: E501
if 'include' in local_var_params and local_var_params['include'] is not None: # noqa: E501
query_params.append(('include', local_var_params['include'])) # 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/vnd.api+json']) # noqa: E501
# Authentication setting
auth_settings = ['api_key_in_header', 'api_key_in_query'] # noqa: E501
return self.api_client.call_api(
'/vehicles/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Vehicle', # 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 api_web_facility_controller_index_with_http_info(
self, **kwargs): # noqa: E501
"""api_web_facility_controller_index # noqa: E501
List Escalators and Elevators Amenities at a station stop (`/data/relationships/stop`) such as elevators, escalators, parking lots, and bike storage. An [MBTA extension](https://groups.google.com/forum/#!topic/gtfs-changes/EzC5m9k45pA). This spec is not yet finalized. ## Accessibility Riders with limited mobility can search any facility, either `ELEVATOR` or `ESCALATOR`, while riders that need wheelchair access can search for `ELEVATOR` only. The lack of an `ELEVATOR` MAY NOT make a stop wheelchair inaccessible. Riders should check `/stops/{id}` `/data/attributes/wheelchair_boarding` is `1` to guarantee a path is available from the station entrance to the stop or `0` if it MAY be accessible. Completely avoid `2` as that is guaranteed to be INACCESSIBLE. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_web_facility_controller_index_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int page_offset: Offset (0-based) of first element in the page
:param int page_limit: Max number of elements to return
:param str sort: Results can be [sorted](http://jsonapi.org/format/#fetching-sorting) by the id or any `/data/{index}/attributes` key. Assumes ascending; may be prefixed with '-' for descending | JSON pointer | Direction | `sort` | |--------------|-----------|------------| | `/data/{index}/attributes/latitude` | ascending | `latitude` | | `/data/{index}/attributes/latitude` | descending | `-latitude` | | `/data/{index}/attributes/long_name` | ascending | `long_name` | | `/data/{index}/attributes/long_name` | descending | `-long_name` | | `/data/{index}/attributes/longitude` | ascending | `longitude` | | `/data/{index}/attributes/longitude` | descending | `-longitude` | | `/data/{index}/attributes/properties` | ascending | `properties` | | `/data/{index}/attributes/properties` | descending | `-properties` | | `/data/{index}/attributes/short_name` | ascending | `short_name` | | `/data/{index}/attributes/short_name` | descending | `-short_name` | | `/data/{index}/attributes/type` | ascending | `type` | | `/data/{index}/attributes/type` | descending | `-type` |
:param str fields_facility: Fields to include with the response. Multiple fields **MUST** be a comma-separated (U+002C COMMA, \",\") list. Note that fields can also be selected for included data types: see the [V3 API Best Practices](https://www.mbta.com/developers/v3-api/best-practices) for an example.
:param str include: Relationships to include. * `stop` The value of the include parameter **MUST** be a comma-separated (U+002C COMMA, \",\") list of relationship paths. A relationship path is a dot-separated (U+002E FULL-STOP, \".\") list of relationship names. [JSONAPI \"include\" behavior](http://jsonapi.org/format/#fetching-includes)
:param str filter_stop: Filter by `/data/{index}/relationships/stop/data/id`. Multiple `/data/{index}/relationships/stop/data/id` **MUST** be a comma-separated (U+002C COMMA, \",\") list.
:param str filter_type: Filter by multiple types. Multiple types **MUST** be a comma-separated (U+002C COMMA, \",\") list.
: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(Facilities, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'page_offset', 'page_limit', 'sort', 'fields_facility', 'include',
'filter_stop', 'filter_type'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 api_web_facility_controller_index" % key)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'page_offset' in local_var_params and local_var_params[
'page_offset'] < 0: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `page_offset` when calling `api_web_facility_controller_index`, must be a value greater than or equal to `0`"
) # noqa: E501
if self.api_client.client_side_validation and 'page_limit' in local_var_params and local_var_params[
'page_limit'] < 1: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `page_limit` when calling `api_web_facility_controller_index`, must be a value greater than or equal to `1`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'page_offset' in local_var_params and local_var_params[
'page_offset'] is not None: # noqa: E501
query_params.append(
('page[offset]',
local_var_params['page_offset'])) # noqa: E501
if 'page_limit' in local_var_params and local_var_params[
'page_limit'] is not None: # noqa: E501
query_params.append(
('page[limit]', local_var_params['page_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 'fields_facility' in local_var_params and local_var_params[
'fields_facility'] is not None: # noqa: E501
query_params.append(
('fields[facility]',
local_var_params['fields_facility'])) # noqa: E501
if 'include' in local_var_params and local_var_params[
'include'] is not None: # noqa: E501
query_params.append(
('include', local_var_params['include'])) # noqa: E501
if 'filter_stop' in local_var_params and local_var_params[
'filter_stop'] is not None: # noqa: E501
query_params.append(
('filter[stop]',
local_var_params['filter_stop'])) # noqa: E501
if 'filter_type' in local_var_params and local_var_params[
'filter_type'] is not None: # noqa: E501
query_params.append(
('filter[type]',
local_var_params['filter_type'])) # 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/vnd.api+json']) # noqa: E501
# Authentication setting
auth_settings = ['api_key_in_header', 'api_key_in_query'] # noqa: E501
return self.api_client.call_api(
'/facilities',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Facilities', # 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 api_web_facility_controller_show_with_http_info(
self, id, **kwargs): # noqa: E501
"""api_web_facility_controller_show # noqa: E501
Specific Escalator or Elevator Amenities at a station stop (`/data/{index}/relationships/stop`) such as elevators, escalators, parking lots, and bike storage. An [MBTA extension](https://groups.google.com/forum/#!topic/gtfs-changes/EzC5m9k45pA). This spec is not yet finalized. ## Accessibility Riders with limited mobility can search any facility, either `ELEVATOR` or `ESCALATOR`, while riders that need wheelchair access can search for `ELEVATOR` only. The lack of an `ELEVATOR` MAY NOT make a stop wheelchair inaccessible. Riders should check `/stops/{id}` `/data/attributes/wheelchair_boarding` is `1` to guarantee a path is available from the station entrance to the stop or `0` if it MAY be accessible. Completely avoid `2` as that is guaranteed to be INACCESSIBLE. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_web_facility_controller_show_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: Unique identifier for facility (required)
:param str fields_facility: Fields to include with the response. Multiple fields **MUST** be a comma-separated (U+002C COMMA, \",\") list. Note that fields can also be selected for included data types: see the [V3 API Best Practices](https://www.mbta.com/developers/v3-api/best-practices) for an example.
:param str include: Relationships to include. * `stop` The value of the include parameter **MUST** be a comma-separated (U+002C COMMA, \",\") list of relationship paths. A relationship path is a dot-separated (U+002E FULL-STOP, \".\") list of relationship names. [JSONAPI \"include\" behavior](http://jsonapi.org/format/#fetching-includes)
: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(Facility, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'fields_facility', 'include'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 api_web_facility_controller_show" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and (
'id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `id` when calling `api_web_facility_controller_show`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
if 'fields_facility' in local_var_params and local_var_params[
'fields_facility'] is not None: # noqa: E501
query_params.append(
('fields[facility]',
local_var_params['fields_facility'])) # noqa: E501
if 'include' in local_var_params and local_var_params[
'include'] is not None: # noqa: E501
query_params.append(
('include', local_var_params['include'])) # 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/vnd.api+json']) # noqa: E501
# Authentication setting
auth_settings = ['api_key_in_header', 'api_key_in_query'] # noqa: E501
return self.api_client.call_api(
'/facilities/{id}',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Facility', # 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 card_info_lookup_with_http_info(self, content_type, client_request_id,
api_key, timestamp,
card_info_lookup_request,
**kwargs): # noqa: E501
"""Card information lookup. # noqa: E501
Use this to look up card related information such as issuer country, card function and card brand. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.card_info_lookup_with_http_info(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str content_type: Content type. (required)
:param str client_request_id: A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. (required)
:param str api_key: Key given to merchant after boarding associating their requests with the appropriate app in Apigee. (required)
:param int timestamp: Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). (required)
:param CardInfoLookupRequest card_info_lookup_request: Accepted request type: CardInfoLookupRequest. (required)
:param str message_signature: Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
:param str region: Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
: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(CardInfoLookupResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'content_type', 'client_request_id', 'api_key', 'timestamp',
'card_info_lookup_request', 'message_signature', 'region'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 card_info_lookup" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'content_type' is set
if ('content_type' not in local_var_params
or local_var_params['content_type'] is None):
raise ApiValueError(
"Missing the required parameter `content_type` when calling `card_info_lookup`"
) # noqa: E501
# verify the required parameter 'client_request_id' is set
if ('client_request_id' not in local_var_params
or local_var_params['client_request_id'] is None):
raise ApiValueError(
"Missing the required parameter `client_request_id` when calling `card_info_lookup`"
) # noqa: E501
# verify the required parameter 'api_key' is set
if ('api_key' not in local_var_params
or local_var_params['api_key'] is None):
raise ApiValueError(
"Missing the required parameter `api_key` when calling `card_info_lookup`"
) # noqa: E501
# verify the required parameter 'timestamp' is set
if ('timestamp' not in local_var_params
or local_var_params['timestamp'] is None):
raise ApiValueError(
"Missing the required parameter `timestamp` when calling `card_info_lookup`"
) # noqa: E501
# verify the required parameter 'card_info_lookup_request' is set
if ('card_info_lookup_request' not in local_var_params
or local_var_params['card_info_lookup_request'] is None):
raise ApiValueError(
"Missing the required parameter `card_info_lookup_request` when calling `card_info_lookup`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
if 'content_type' in local_var_params:
header_params['Content-Type'] = local_var_params[
'content_type'] # noqa: E501
if 'client_request_id' in local_var_params:
header_params['Client-Request-Id'] = local_var_params[
'client_request_id'] # noqa: E501
if 'api_key' in local_var_params:
header_params['Api-Key'] = local_var_params[
'api_key'] # noqa: E501
if 'timestamp' in local_var_params:
header_params['Timestamp'] = local_var_params[
'timestamp'] # noqa: E501
if 'message_signature' in local_var_params:
header_params['Message-Signature'] = local_var_params[
'message_signature'] # noqa: E501
if 'region' in local_var_params:
header_params['Region'] = local_var_params['region'] # noqa: E501
form_params = []
local_var_files = {}
body_params = None
if 'card_info_lookup_request' in local_var_params:
body_params = local_var_params['card_info_lookup_request']
# 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']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/card-information',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CardInfoLookupResponse', # 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 projects_get_with_http_info(self, **kwargs): # noqa: E501
"""Fetch projects list # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.projects_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int limit: Limited the result. Default is 100. Maximum can be 1000.
:param int page: Set current Page. Default is 1.
:param str customer_id: Filter projects by customer_id. You can add multiple ids separate by comma like id,id,id.
:param str status: Filter projects by status.
: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(Projects, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['limit', 'page', 'customer_id', 'status']
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 projects_get" % key)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params[
'limit'] > 1000: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `limit` when calling `projects_get`, must be a value less than or equal to `1000`"
) # noqa: E501
if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params[
'limit'] < 1: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `limit` when calling `projects_get`, must be a value greater than or equal to `1`"
) # noqa: E501
if self.api_client.client_side_validation and 'page' in local_var_params and local_var_params[
'page'] < 1: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `page` when calling `projects_get`, must be a value greater than or equal to `1`"
) # noqa: E501
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 'page' in local_var_params and local_var_params[
'page'] is not None: # noqa: E501
query_params.append(
('page', local_var_params['page'])) # noqa: E501
if 'customer_id' in local_var_params and local_var_params[
'customer_id'] is not None: # noqa: E501
query_params.append(
('customer_id', local_var_params['customer_id'])) # noqa: E501
if 'status' in local_var_params and local_var_params[
'status'] is not None: # noqa: E501
query_params.append(
('status', local_var_params['status'])) # 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 = ['Bearer', 'basicAuth'] # noqa: E501
return self.api_client.call_api(
'/projects',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Projects', # 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_identity_links_with_http_info(self, id, **kwargs): # noqa: E501
"""get_identity_links # noqa: E501
Gets the identity links for a task by id, which are the users and groups that are in *some* relation to it (including assignee and owner). # 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_identity_links_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: The id of the task to retrieve the identity links for. (required)
:param str type: Filter by the type of links to include.
: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[IdentityLinkDto], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', '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 get_identity_links" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if self.api_client.client_side_validation and (
'id' not in local_var_params or # noqa: E501
local_var_params['id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `id` when calling `get_identity_links`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
if 'type' in local_var_params and local_var_params[
'type'] is not None: # noqa: E501
query_params.append(
('type', local_var_params['type'])) # 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 = [] # noqa: E501
return self.api_client.call_api(
'/task/{id}/identity-links',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[IdentityLinkDto]', # 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 similarity_similarity_post_with_http_info(self,
**kwargs): # noqa: E501
"""similarity_similarity_post # noqa: E501
\"Similarity\" admin task POST params: - search_similar_documents: bool - search_similar_text_units: bool - similarity_threshold: int - use_idf: bool - delete: bool - project: bool # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.similarity_similarity_post_with_http_info(async_req=True)
>>> result = thread.get()
:param request_body:
:type request_body: dict(str, object)
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
: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.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(SimilarityPOSTObjectResponse, status_code(int), headers(HTTPHeaderDict))
"""
local_var_params = locals()
all_params = ['request_body']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout', '_request_auth'
])
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 similarity_similarity_post" %
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 'request_body' in local_var_params:
body_params = local_var_params['request_body']
# 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 = ['AuthToken'] # noqa: E501
return self.api_client.call_api(
'/api/v1/similarity/similarity/',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='SimilarityPOSTObjectResponse', # 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,
_request_auth=local_var_params.get('_request_auth'))
def get_bank_deposits_with_http_info(self, **kwargs): # noqa: E501
"""Returns all Bank Deposits # noqa: E501
Returns all Bank Deposits ### Endpoint Availability * Accounting: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area `Bank`: Read Only, Restricted Access, Full Access # 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_bank_deposits_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param datetime updated_or_created_since: Use this to limit the response to Deposits changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.
:param datetime deleted_since: Use this to limit the response to Deposits deleted since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Not inclusive of the passed timestamp.
:param datetime from_date: Use this to filter by Deposits dates
:param datetime to_date: Use this to filter by Deposits dates
:param bool show_legacy_id: Display the legacy_id for the Deposits.
:param int items_per_page: Returns the given number of Deposits per request.
:param int page: Go to specific page of Deposits
:param str attributes: Specify the attributes that you want to expose for the Deposits (expose all attributes with 'all'). These are in addition to the base attributes (name, path)
:param str sort: Order by a given attribute (required) and direction (optional; `asc` or `desc`; defaults to `asc`). Available attributes are: created_at, updated_at, date Example: `sort=created_at` or `sort=created_at:desc`
: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[BankDeposit], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'updated_or_created_since', 'deleted_since', 'from_date',
'to_date', 'show_legacy_id', 'items_per_page', 'page',
'attributes', 'sort'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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_bank_deposits" % key)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'items_per_page' in local_var_params and local_var_params[
'items_per_page'] > 200: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `items_per_page` when calling `get_bank_deposits`, must be a value less than or equal to `200`"
) # noqa: E501
if self.api_client.client_side_validation and 'items_per_page' in local_var_params and local_var_params[
'items_per_page'] < 1: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `items_per_page` when calling `get_bank_deposits`, must be a value greater than or equal to `1`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'updated_or_created_since' in local_var_params and local_var_params[
'updated_or_created_since'] is not None: # noqa: E501
query_params.append(
('updated_or_created_since',
local_var_params['updated_or_created_since'])) # noqa: E501
if 'deleted_since' in local_var_params and local_var_params[
'deleted_since'] is not None: # noqa: E501
query_params.append(
('deleted_since',
local_var_params['deleted_since'])) # noqa: E501
if 'from_date' in local_var_params and local_var_params[
'from_date'] is not None: # noqa: E501
query_params.append(
('from_date', local_var_params['from_date'])) # noqa: E501
if 'to_date' in local_var_params and local_var_params[
'to_date'] is not None: # noqa: E501
query_params.append(
('to_date', local_var_params['to_date'])) # noqa: E501
if 'show_legacy_id' in local_var_params and local_var_params[
'show_legacy_id'] is not None: # noqa: E501
query_params.append(
('show_legacy_id',
local_var_params['show_legacy_id'])) # noqa: E501
if 'items_per_page' in local_var_params and local_var_params[
'items_per_page'] is not None: # noqa: E501
query_params.append(
('items_per_page',
local_var_params['items_per_page'])) # noqa: E501
if 'page' in local_var_params and local_var_params[
'page'] is not None: # noqa: E501
query_params.append(
('page', local_var_params['page'])) # noqa: E501
if 'attributes' in local_var_params and local_var_params[
'attributes'] is not None: # noqa: E501
query_params.append(
('attributes', local_var_params['attributes'])) # 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
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 = [] # noqa: E501
return self.api_client.call_api(
'/bank_deposits',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[BankDeposit]', # 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_new_contact_with_http_info(self, contact_request,
**kwargs): # noqa: E501
"""Creates a new contact notification for the current 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.create_new_contact_with_http_info(contact_request, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param ContactRequest contact_request: (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(Contact, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['contact_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_new_contact" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'contact_request' is set
if self.api_client.client_side_validation and (
'contact_request' not in local_var_params or # noqa: E501
local_var_params['contact_request'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `contact_request` when calling `create_new_contact`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'contact_request' in local_var_params:
body_params = local_var_params['contact_request']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['applicaton/json', 'application/json']) # noqa: E501
# HTTP header `Content-Type`
header_params[
'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/contact',
'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Contact', # 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_bank_deposits_key_with_http_info(self, key,
**kwargs): # noqa: E501
"""Deletes a Bank Deposit # noqa: E501
Deletes a Bank Deposit ### Endpoint Availability * Accounting: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area `Bank`: Full Access # 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_bank_deposits_key_with_http_info(key, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str key: The Bank Deposit Key. (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 = ['key'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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_bank_deposits_key" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'key' is set
if self.api_client.client_side_validation and (
'key' not in local_var_params or # noqa: E501
local_var_params['key'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `key` when calling `delete_bank_deposits_key`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'key' in local_var_params:
path_params['key'] = local_var_params['key'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/bank_deposits/{key}',
'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 public_test_get_with_http_info(self, **kwargs): # noqa: E501
"""Tests the connection to the API server, and returns its version. You can use this to make sure the API is reachable, and matches the expected version. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.public_test_get_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str expected_result: The value \"exception\" will trigger an error response. This may be useful for testing wrapper libraries.
: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(object, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['expected_result'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 public_test_get" % key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'expected_result' in local_var_params:
query_params.append(
('expected_result',
local_var_params['expected_result'])) # 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 = ['bearerAuth'] # noqa: E501
return self.api_client.call_api(
'/public/test',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='object', # 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 app_api_space_put_with_http_info(self, space_name, space,
**kwargs): # noqa: E501
"""Update an existing space # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.app_api_space_put_with_http_info(space_name, space, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str space_name: space name (required)
:param Space space: Optional description in *Markdown* (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(Space, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['space_name', 'space'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 app_api_space_put" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'space_name' is set
if ('space_name' not in local_var_params
or local_var_params['space_name'] is None):
raise ApiValueError(
"Missing the required parameter `space_name` when calling `app_api_space_put`"
) # noqa: E501
# verify the required parameter 'space' is set
if ('space' not in local_var_params
or local_var_params['space'] is None):
raise ApiValueError(
"Missing the required parameter `space` when calling `app_api_space_put`"
) # noqa: E501
if 'space_name' in local_var_params and not re.search(
r'^[a-zA-Z][_a-zA-Z0-9]{4,59}$',
local_var_params['space_name']): # noqa: E501
raise ApiValueError(
"Invalid value for parameter `space_name` when calling `app_api_space_put`, must conform to the pattern `/^[a-zA-Z][_a-zA-Z0-9]{4,59}$/`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'space_name' in local_var_params:
path_params['space_name'] = local_var_params[
'space_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'space' in local_var_params:
body_params = local_var_params['space']
# 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']) # noqa: E501
# Authentication setting
auth_settings = ['api_key', 'basic', 'jwt'] # noqa: E501
return self.api_client.call_api(
'/space/{space_name}',
'PUT',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Space', # 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 public_get_time_get_with_http_info(self, **kwargs): # noqa: E501
"""Retrieves the current time (in milliseconds). This API endpoint can be used to check the clock skew between your software and Deribit's systems. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.public_get_time_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(object, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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 public_get_time_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']) # noqa: E501
# Authentication setting
auth_settings = ['bearerAuth'] # noqa: E501
return self.api_client.call_api(
'/public/get_time',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='object', # 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_x_com_value_with_http_info(self, dag_id, dag_run_id, task_id,
xcom_key, **kwargs): # noqa: E501
"""Delete an XCom entry # 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_x_com_value_with_http_info(dag_id, dag_run_id, task_id, xcom_key, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str dag_id: The DAG ID. (required)
:param str dag_run_id: The DAG Run ID. (required)
:param str task_id: The Task ID. (required)
:param str xcom_key: The XCom Key. (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 = ['dag_id', 'dag_run_id', 'task_id', 'xcom_key']
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_x_com_value" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'dag_id' is set
if self.api_client.client_side_validation and (
'dag_id' not in local_var_params or # noqa: E501
local_var_params['dag_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `dag_id` when calling `delete_x_com_value`"
) # noqa: E501
# verify the required parameter 'dag_run_id' is set
if self.api_client.client_side_validation and (
'dag_run_id' not in local_var_params or # noqa: E501
local_var_params['dag_run_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `dag_run_id` when calling `delete_x_com_value`"
) # noqa: E501
# verify the required parameter 'task_id' is set
if self.api_client.client_side_validation and (
'task_id' not in local_var_params or # noqa: E501
local_var_params['task_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `task_id` when calling `delete_x_com_value`"
) # noqa: E501
# verify the required parameter 'xcom_key' is set
if self.api_client.client_side_validation and (
'xcom_key' not in local_var_params or # noqa: E501
local_var_params['xcom_key'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `xcom_key` when calling `delete_x_com_value`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'dag_id' in local_var_params:
path_params['dag_id'] = local_var_params['dag_id'] # noqa: E501
if 'dag_run_id' in local_var_params:
path_params['dag_run_id'] = local_var_params[
'dag_run_id'] # noqa: E501
if 'task_id' in local_var_params:
path_params['task_id'] = local_var_params['task_id'] # noqa: E501
if 'xcom_key' in local_var_params:
path_params['xcom_key'] = local_var_params[
'xcom_key'] # 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 = [] # noqa: E501
return self.api_client.call_api(
'/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{key}',
'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 get_live_exchange_rates_with_http_info(self, **kwargs): # noqa: E501
"""Returns all Live Exchange Rates # noqa: E501
Returns all Live Exchange Rates ### Endpoint Availability * Accounting: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 # 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_live_exchange_rates_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param bool show_legacy_id: Display the legacy_id for the Currencies.
:param int items_per_page: Returns the given number of Currencies per request.
:param int page: Go to specific page of Currencies
:param str attributes: Specify the attributes that you want to expose for the Currencies (expose all attributes with 'all'). These are in addition to the base attributes (name, path)
: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[LiveExchangeRate], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'show_legacy_id', 'items_per_page', 'page', 'attributes'
] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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_live_exchange_rates" % key)
local_var_params[key] = val
del local_var_params['kwargs']
if self.api_client.client_side_validation and 'items_per_page' in local_var_params and local_var_params[
'items_per_page'] > 200: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `items_per_page` when calling `get_live_exchange_rates`, must be a value less than or equal to `200`"
) # noqa: E501
if self.api_client.client_side_validation and 'items_per_page' in local_var_params and local_var_params[
'items_per_page'] < 1: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `items_per_page` when calling `get_live_exchange_rates`, must be a value greater than or equal to `1`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'show_legacy_id' in local_var_params and local_var_params[
'show_legacy_id'] is not None: # noqa: E501
query_params.append(
('show_legacy_id',
local_var_params['show_legacy_id'])) # noqa: E501
if 'items_per_page' in local_var_params and local_var_params[
'items_per_page'] is not None: # noqa: E501
query_params.append(
('items_per_page',
local_var_params['items_per_page'])) # noqa: E501
if 'page' in local_var_params and local_var_params[
'page'] is not None: # noqa: E501
query_params.append(
('page', local_var_params['page'])) # noqa: E501
if 'attributes' in local_var_params and local_var_params[
'attributes'] is not None: # noqa: E501
query_params.append(
('attributes', local_var_params['attributes'])) # 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 = [] # noqa: E501
return self.api_client.call_api(
'/live_exchange_rates',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[LiveExchangeRate]', # 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_code_with_http_info(self, project, uniform_path,
**kwargs): # noqa: E501
"""Download source code # noqa: E501
Starts a download of the source code file at the given uniform path This service is public API since Teamscale 5.2. The API requires the user to have View Project permissions on the project. # 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_code_with_http_info(project, uniform_path, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str project: The project alias or id. (required)
:param str uniform_path: The uniform path of the source code file to be downloaded. (required)
:param str t: The commit for which the source code should be downloaded.
: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 = ['project', 'uniform_path', 't']
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_code" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'project' is set
if self.api_client.client_side_validation and (
'project' not in local_var_params or # noqa: E501
local_var_params['project'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `project` when calling `get_code`"
) # noqa: E501
# verify the required parameter 'uniform_path' is set
if self.api_client.client_side_validation and (
'uniform_path' not in local_var_params or # noqa: E501
local_var_params['uniform_path'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `uniform_path` when calling `get_code`"
) # noqa: E501
if self.api_client.client_side_validation and 'project' in local_var_params and not re.search(
r'^(?!aliases$)[-_.a-zA-Z0-9]+$',
local_var_params['project']): # noqa: E501
raise ApiValueError(
"Invalid value for parameter `project` when calling `get_code`, must conform to the pattern `/^(?!aliases$)[-_.a-zA-Z0-9]+$/`"
) # noqa: E501
if self.api_client.client_side_validation and 't' in local_var_params and not re.search(
r'(?:(.+):)?(HEAD|\d+)(?:p(\d+))?',
local_var_params['t']): # noqa: E501
raise ApiValueError(
"Invalid value for parameter `t` when calling `get_code`, must conform to the pattern `/(?:(.+):)?(HEAD|\d+)(?:p(\d+))?/`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'project' in local_var_params:
path_params['project'] = local_var_params['project'] # noqa: E501
if 'uniform_path' in local_var_params:
path_params['uniformPath'] = local_var_params[
'uniform_path'] # noqa: E501
query_params = []
if 't' in local_var_params and local_var_params[
't'] is not None: # noqa: E501
query_params.append(('t', local_var_params['t'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/api/projects/{project}/source-code-download/{uniformPath}',
'GET',
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 delete_digitization_with_http_info(self, **kwargs): # noqa: E501
"""Used to delete one or more Tokens. The API is limited to 10 Tokens per request. # noqa: E501
This API is used to delete one or more Tokens. The API is limited to 10 Tokens per request. MDES will coordinate the deactivation of the Tokens and notify any relevant parties that the Tokens have now been deactivated. # 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_digitization_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param DeleteRequestSchema delete_request_schema: Contains the details of the request message.
: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(DeleteResponseSchema, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['delete_request_schema'] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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_digitization" % 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 'delete_request_schema' in local_var_params:
body_params = local_var_params['delete_request_schema']
# 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']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/digitization/static/1/0/delete',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DeleteResponseSchema', # 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 template_controller_find_with_http_info(self, **kwargs): # noqa: E501
"""template_controller_find # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.template_controller_find_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param TemplateFilter1 filter:
: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[TemplateWithRelations], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['filter']
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 template_controller_find" % key)
local_var_params[key] = val
del local_var_params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'filter' in local_var_params and local_var_params[
'filter'] is not None: # noqa: E501
query_params.append(
('filter', local_var_params['filter'])) # 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 = [] # noqa: E501
return self.api_client.call_api(
'/templates',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[TemplateWithRelations]', # 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_sle_config_list_with_http_info(self, **kwargs): # noqa: E501
"""Get a list of the available configuration parameters # 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_sle_config_list_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: list[SleConfigParams]
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [] # noqa: E501
all_params.append('authentication')
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_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_sle_config_list" % 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']) # noqa: E501
# Authentication setting
if 'authentication' in local_var_params:
auth_settings = [local_var_params['authentication']]
else:
auth_settings = []
return self.api_client.call_api(
'/sle-config',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[SleConfigParams]', # 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)
