def get_task_local_variable_binary_with_http_info(self, id, var_name,
**kwargs): # noqa: E501
"""get_task_local_variable_binary # noqa: E501
Retrieves a binary variable from the context of a given task by id. Applicable for byte array and file variables. # 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_task_local_variable_binary_with_http_info(id, var_name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: The id of the task to retrieve the variable for. (required)
:param str var_name: The name of the variable to retrieve. (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 = ['id', 'var_name']
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_task_local_variable_binary" % 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_task_local_variable_binary`"
) # noqa: E501
# verify the required parameter 'var_name' is set
if self.api_client.client_side_validation and (
'var_name' not in local_var_params or # noqa: E501
local_var_params['var_name'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `var_name` when calling `get_task_local_variable_binary`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'var_name' in local_var_params:
path_params['varName'] = local_var_params['var_name'] # 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', 'text/plain',
'application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/task/{id}/localVariables/{varName}/data',
'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 document_payments_post_with_http_info(self, body,
**kwargs): # noqa: E501
"""Create document payment # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.document_payments_post_with_http_info(body, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param DocumentPayment body: (required)
:param bool paid: Mark document as paid when amount less then payment amount.
: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(DocumentPayment, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['body', 'paid']
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 document_payments_post" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'body' is set
if self.api_client.client_side_validation and (
'body' not in local_var_params or # noqa: E501
local_var_params['body'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `body` when calling `document_payments_post`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'paid' in local_var_params and local_var_params[
'paid'] is not None: # noqa: E501
query_params.append(
('paid', local_var_params['paid'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in local_var_params:
body_params = local_var_params['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']) # noqa: E501
# Authentication setting
auth_settings = ['Bearer', 'basicAuth'] # noqa: E501
return self.api_client.call_api(
'/document-payments',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DocumentPayment', # 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 request(self,
method,
url,
query_params=None,
headers=None,
body=None,
post_params=None,
_preload_content=True,
_request_timeout=None):
"""Perform requests.
:param method: http request method
:param url: http request url
:param query_params: query parameters in the url
:param headers: http request headers
:param body: request json body, for `application/json`
:param post_params: request post parameters,
`application/x-www-form-urlencoded`
and `multipart/form-data`
: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.
"""
method = method.upper()
assert method in [
'GET', 'HEAD', 'DELETE', 'POST', 'PUT', 'PATCH', 'OPTIONS'
]
if post_params and body:
raise ApiValueError(
"body parameter cannot be used with post_params parameter.")
post_params = post_params or {}
headers = headers or {}
timeout = None
if _request_timeout:
if isinstance(_request_timeout, (int, ) if six.PY3 else
(int, long)): # noqa: E501,F821
timeout = urllib3.Timeout(total=_request_timeout)
elif (isinstance(_request_timeout, tuple)
and len(_request_timeout) == 2):
timeout = urllib3.Timeout(connect=_request_timeout[0],
read=_request_timeout[1])
if 'Content-Type' not in headers:
headers['Content-Type'] = 'application/json'
try:
# For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
if query_params:
url += '?' + urlencode(query_params)
if re.search('json', headers['Content-Type'], re.IGNORECASE):
request_body = None
if body is not None:
request_body = json.dumps(body)
r = self.pool_manager.request(
method,
url,
body=request_body,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
elif headers[
'Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501
r = self.pool_manager.request(
method,
url,
fields=post_params,
encode_multipart=False,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
elif headers['Content-Type'] == 'multipart/form-data':
# must del headers['Content-Type'], or the correct
# Content-Type which generated by urllib3 will be
# overwritten.
del headers['Content-Type']
r = self.pool_manager.request(
method,
url,
fields=post_params,
encode_multipart=True,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
# Pass a `string` parameter directly in the body to support
# other content types than Json when `body` argument is
# provided in serialized form
elif isinstance(body, str) or isinstance(body, bytes):
request_body = body
r = self.pool_manager.request(
method,
url,
body=request_body,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
else:
# Cannot generate the request from given parameters
msg = """Cannot prepare a request message for provided
arguments. Please check that your arguments match
declared content type."""
raise ApiException(status=0, reason=msg)
# For `GET`, `HEAD`
else:
r = self.pool_manager.request(method,
url,
fields=query_params,
preload_content=_preload_content,
timeout=timeout,
headers=headers)
except urllib3.exceptions.SSLError as e:
msg = "{0}\n{1}".format(type(e).__name__, str(e))
raise ApiException(status=0, reason=msg)
if _preload_content:
r = RESTResponse(r)
# In the python 3, the response.data is bytes.
# we need to decode it to string.
if six.PY3:
r.data = r.data.decode('utf8')
# log response body
logger.debug("response body: %s", r.data)
if not 200 <= r.status <= 299:
raise ApiException(http_resp=r)
return r
def create_issue_metric_descriptor_with_http_info(self, project,
issue_metric_descriptor,
**kwargs): # noqa: E501
"""Create issue metric # noqa: E501
Creates an issue metric descriptor in the system. This service is public API since Teamscale 6.0. The API requires the user to have Edit Issue Metrics 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.create_issue_metric_descriptor_with_http_info(project, issue_metric_descriptor, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str project: The project alias or id. (required)
:param IssueMetricDescriptor issue_metric_descriptor: (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 = ['project', 'issue_metric_descriptor']
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_issue_metric_descriptor" % 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 `create_issue_metric_descriptor`"
) # noqa: E501
# verify the required parameter 'issue_metric_descriptor' is set
if self.api_client.client_side_validation and (
'issue_metric_descriptor' not in local_var_params
or # noqa: E501
local_var_params['issue_metric_descriptor'] is None
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `issue_metric_descriptor` when calling `create_issue_metric_descriptor`"
) # 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 `create_issue_metric_descriptor`, must conform to the pattern `/^(?!aliases$)[-_.a-zA-Z0-9]+$/`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'project' in local_var_params:
path_params['project'] = local_var_params['project'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'issue_metric_descriptor' in local_var_params:
body_params = local_var_params['issue_metric_descriptor']
# 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 = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/api/projects/{project}/issues/metrics',
'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 api_web_live_facility_controller_index_with_http_info(self, **kwargs): # noqa: E501
"""api_web_live_facility_controller_index # noqa: E501
Live Facility Data Live data about a given facility. # 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_live_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/properties` | ascending | `properties` | | `/data/{index}/attributes/properties` | descending | `-properties` | | `/data/{index}/attributes/updated_at` | ascending | `updated_at` | | `/data/{index}/attributes/updated_at` | descending | `-updated_at` |
:param str include: Relationships to include. * `facility` 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_id: Filter by multiple parking facility ids. **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(LiveFacility, 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', 'include', 'filter_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_web_live_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_live_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_live_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 '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
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(
'/live_facilities', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='LiveFacility', # 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_migration_tax_returns_with_http_info(self, **kwargs): # noqa: E501
"""Returns all Migration Tax Returns # noqa: E501
Returns all Migration Tax Returns ### Endpoint Availability * Accounting: 🇬🇧, 🇮🇪 * Accounting Start: 🇬🇧, 🇮🇪 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area `Statutory Reporting`: 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_migration_tax_returns_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 Migration Tax Returns.
:param int items_per_page: Returns the given number of Migration Tax Returns per request.
:param int page: Go to specific page of Migration Tax Returns
:param str attributes: Specify the attributes that you want to expose for the Migration Tax Returns (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[MigrationTaxReturn], 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_migration_tax_returns" %
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_migration_tax_returns`, 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_migration_tax_returns`, 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(
'/migration_tax_returns',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[MigrationTaxReturn]', # 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_asset_with_http_info(self, asset_id, **kwargs): # noqa: E501
"""Used to retrieve static Assets from the MDES repository. # noqa: E501
This API is used to retrieve static Assets from MDES’s repository, such as - Card art, MasterCard brand logos, Issuers’ logos, and Terms and Conditions. Every Asset in the repository is referenced using an Asset ID. Once an Asset has been assigned to an Asset ID, the contents of the Asset will not change. If contents do need to change (for example, Issuer has supplied new artwork for a product), they will be updated in the repository and be assigned a new Asset ID. Different types of Assets are supported in the repository, such as images and text files; and for each type of Asset, multiple formats may be supported. For example, a single image Asset may be supported in various file formats; or variant sizes, allowing the Token Requestor to select the most appropriate format to use for a particular target device. # 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_asset_with_http_info(asset_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str asset_id: An Asset ID corresponds to an individual Digital Asset. Digital Assets are returned as part of the Product Configuration from the Tokenize Response. The Asset ID itself is supplied as a Get request in the form of https://{INSERT ENVIRONMENT URL HERE}/mdes/assets/static/1/0/asset/{AssetID} - See JSON examples for details. (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(AssetResponseSchema, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['asset_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 get_asset" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'asset_id' is set
if ('asset_id' not in local_var_params or
local_var_params['asset_id'] is None):
raise ApiValueError("Missing the required parameter `asset_id` when calling `get_asset`") # noqa: E501
collection_formats = {}
path_params = {}
if 'asset_id' in local_var_params:
path_params['AssetId'] = local_var_params['asset_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/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/assets/static/1/0/asset/{AssetId}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='AssetResponseSchema', # 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_annotation_raw_update_with_http_info(self, coll_id, aid, annotation_update, **kwargs): # noqa: E501
"""Update an annotation # 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_annotation_raw_update_with_http_info(coll_id, aid, annotation_update, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str coll_id: collection id (required)
:param str aid: annotation id (required)
:param AnnotationUpdate annotation_update: Annotation (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 = ['coll_id', 'aid', 'annotation_update'] # 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_annotation_raw_update" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'coll_id' is set
if ('coll_id' not in local_var_params or
local_var_params['coll_id'] is None):
raise ApiValueError("Missing the required parameter `coll_id` when calling `app_api_annotation_raw_update`") # noqa: E501
# verify the required parameter 'aid' is set
if ('aid' not in local_var_params or
local_var_params['aid'] is None):
raise ApiValueError("Missing the required parameter `aid` when calling `app_api_annotation_raw_update`") # noqa: E501
# verify the required parameter 'annotation_update' is set
if ('annotation_update' not in local_var_params or
local_var_params['annotation_update'] is None):
raise ApiValueError("Missing the required parameter `annotation_update` when calling `app_api_annotation_raw_update`") # noqa: E501
if 'coll_id' in local_var_params and not re.search(r'[0-9a-fA-F]{24}', local_var_params['coll_id']): # noqa: E501
raise ApiValueError("Invalid value for parameter `coll_id` when calling `app_api_annotation_raw_update`, must conform to the pattern `/[0-9a-fA-F]{24}/`") # noqa: E501
collection_formats = {}
path_params = {}
if 'coll_id' in local_var_params:
path_params['collId'] = local_var_params['coll_id'] # noqa: E501
if 'aid' in local_var_params:
path_params['aid'] = local_var_params['aid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'annotation_update' in local_var_params:
body_params = local_var_params['annotation_update']
# 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', 'jwt'] # noqa: E501
return self.api_client.call_api(
'/raw/annotation/{collId}/{aid}', 'PUT',
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_kadaster_personen_with_http_info(self, q, **kwargs): # noqa: E501
"""get_kadaster_personen # noqa: E501
Het zoeken van bij het kadaster geregistreerde natuurlijke personen die niet in de basisregistratie personen (BRP) zijn ingeschreven (of wel zijn ingeschreven maar niet zijn _gematched_ bij het inschrijven van de akte). Kadasternatuurlijkpersonen worden niet geactualiseerd. # 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_kadaster_personen_with_http_info(q, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str q: Free query parameter. Dit endpoint evolueert naar free query zoeken. In deze versie kan alleen een combinatie van (het begin van) de geslachtsnaam en geboortedatum [YYYY-mm-dd] worden opgegeven. (required)
:param str fields: Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.0.0/features/fields.feature)
: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(KadasterNatuurlijkPersoonHalCollectie, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['q', 'fields']
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_kadaster_personen" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'q' is set
if self.api_client.client_side_validation and (
'q' not in local_var_params or # noqa: E501
local_var_params['q'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `q` when calling `get_kadaster_personen`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'fields' in local_var_params and local_var_params[
'fields'] is not None: # noqa: E501
query_params.append(
('fields', local_var_params['fields'])) # noqa: E501
if 'q' in local_var_params and local_var_params[
'q'] is not None: # noqa: E501
query_params.append(('q', local_var_params['q'])) # 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/hal+json', 'application/problem+json']) # noqa: E501
# Authentication setting
auth_settings = ['apiKeyAuth'] # noqa: E501
return self.api_client.call_api(
'/kadasternatuurlijkpersonen',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='KadasterNatuurlijkPersoonHalCollectie', # 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_project_with_http_info(self, create_project_object,
**kwargs): # noqa: E501
"""Create a new 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.create_project_with_http_info(create_project_object, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param CreateProjectObject create_project_object: Project object that needs to be created (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(Project, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['create_project_object'] # 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 create_project" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'create_project_object' is set
if ('create_project_object' not in local_var_params
or local_var_params['create_project_object'] is None):
raise ApiValueError(
"Missing the required parameter `create_project_object` when calling `create_project`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'create_project_object' in local_var_params:
body_params = local_var_params['create_project_object']
# 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 = ['oauth'] # noqa: E501
return self.api_client.call_api(
'/project',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Project', # 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_annotation_raw_remove_target_with_http_info(self, coll_id, aid, **kwargs): # noqa: E501
"""delete a target # noqa: E501
delete observation targets # 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_annotation_raw_remove_target_with_http_info(coll_id, aid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str coll_id: collection id (required)
:param str aid: annotation id (required)
:param str tsid: time series id
:param int index: time series index
:param Frequency freq: frequency
:param datetime real_start: start time from when values were valid
: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(Annotation, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['coll_id', 'aid', 'tsid', 'index', 'freq', 'real_start'] # 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_annotation_raw_remove_target" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'coll_id' is set
if ('coll_id' not in local_var_params or
local_var_params['coll_id'] is None):
raise ApiValueError("Missing the required parameter `coll_id` when calling `app_api_annotation_raw_remove_target`") # noqa: E501
# verify the required parameter 'aid' is set
if ('aid' not in local_var_params or
local_var_params['aid'] is None):
raise ApiValueError("Missing the required parameter `aid` when calling `app_api_annotation_raw_remove_target`") # noqa: E501
if 'coll_id' in local_var_params and not re.search(r'[0-9a-fA-F]{24}', local_var_params['coll_id']): # noqa: E501
raise ApiValueError("Invalid value for parameter `coll_id` when calling `app_api_annotation_raw_remove_target`, must conform to the pattern `/[0-9a-fA-F]{24}/`") # noqa: E501
if 'tsid' in local_var_params and not re.search(r'[0-9a-fA-F]{24}', local_var_params['tsid']): # noqa: E501
raise ApiValueError("Invalid value for parameter `tsid` when calling `app_api_annotation_raw_remove_target`, must conform to the pattern `/[0-9a-fA-F]{24}/`") # noqa: E501
collection_formats = {}
path_params = {}
if 'coll_id' in local_var_params:
path_params['collId'] = local_var_params['coll_id'] # noqa: E501
if 'aid' in local_var_params:
path_params['aid'] = local_var_params['aid'] # noqa: E501
query_params = []
if 'tsid' in local_var_params:
query_params.append(('tsid', local_var_params['tsid'])) # noqa: E501
if 'index' in local_var_params:
query_params.append(('index', local_var_params['index'])) # noqa: E501
if 'freq' in local_var_params:
query_params.append(('freq', local_var_params['freq'])) # noqa: E501
if 'real_start' in local_var_params:
query_params.append(('realStart', local_var_params['real_start'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['api_key', 'jwt'] # noqa: E501
return self.api_client.call_api(
'/raw/annotation/{collId}/{aid}/targets', 'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Annotation', # 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 set_binary_task_local_variable_with_http_info(self, id, var_name,
**kwargs): # noqa: E501
"""set_binary_task_local_variable # noqa: E501
Sets the serialized value for a binary variable or the binary value for a file variable. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.set_binary_task_local_variable_with_http_info(id, var_name, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: The id of the task to retrieve the variable for. (required)
:param str var_name: The name of the variable to retrieve. (required)
:param file data: The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory.
:param str value_type: The name of the variable type. Either Bytes for a byte array variable or File for a file variable.
: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', 'var_name', 'data', 'value_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 set_binary_task_local_variable" % 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 `set_binary_task_local_variable`"
) # noqa: E501
# verify the required parameter 'var_name' is set
if self.api_client.client_side_validation and (
'var_name' not in local_var_params or # noqa: E501
local_var_params['var_name'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `var_name` when calling `set_binary_task_local_variable`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
if 'var_name' in local_var_params:
path_params['varName'] = local_var_params['var_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
if 'data' in local_var_params:
local_var_files['data'] = local_var_params['data'] # noqa: E501
if 'value_type' in local_var_params:
form_params.append(
('valueType', local_var_params['value_type'])) # noqa: E501
body_params = None
# 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
['multipart/form-data']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/task/{id}/localVariables/{varName}/data',
'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 modify_task_local_variables_with_http_info(self, id,
**kwargs): # noqa: E501
"""modify_task_local_variables # noqa: E501
Updates or deletes the variables in the context of a task. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.modify_task_local_variables_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 set variables for. (required)
:param PatchVariablesDto patch_variables_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', 'patch_variables_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 modify_task_local_variables" %
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 `modify_task_local_variables`"
) # 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 'patch_variables_dto' in local_var_params:
body_params = local_var_params['patch_variables_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}/localVariables',
'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_task_local_variables_with_http_info(self, id,
**kwargs): # noqa: E501
"""get_task_local_variables # noqa: E501
Retrieves all variables of a given task 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.get_task_local_variables_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 variables from. (required)
:param bool deserialize_values: Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on the server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine.
: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(dict(str, VariableValueDto), status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'deserialize_values']
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_task_local_variables" % 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_task_local_variables`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'id' in local_var_params:
path_params['id'] = local_var_params['id'] # noqa: E501
query_params = []
if 'deserialize_values' in local_var_params and local_var_params[
'deserialize_values'] is not None: # noqa: E501
query_params.append(
('deserializeValues',
local_var_params['deserialize_values'])) # 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}/localVariables',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='dict(str, VariableValueDto)', # 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_decode_session_log_with_http_info(self, project_uuid,
training_version, session_uuid,
**kwargs): # noqa: E501
"""Get decode session # noqa: E501
Returns the log of a decoding session # 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_decode_session_log_with_http_info(project_uuid, training_version, session_uuid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str project_uuid: UUID of the project (required)
:param int training_version: Training version of the project (required)
:param str session_uuid: UUID of the session (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(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['project_uuid', 'training_version',
'session_uuid'] # 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_decode_session_log" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'project_uuid' is set
if ('project_uuid' not in local_var_params
or local_var_params['project_uuid'] is None):
raise ApiValueError(
"Missing the required parameter `project_uuid` when calling `get_decode_session_log`"
) # noqa: E501
# verify the required parameter 'training_version' is set
if ('training_version' not in local_var_params
or local_var_params['training_version'] is None):
raise ApiValueError(
"Missing the required parameter `training_version` when calling `get_decode_session_log`"
) # noqa: E501
# verify the required parameter 'session_uuid' is set
if ('session_uuid' not in local_var_params
or local_var_params['session_uuid'] is None):
raise ApiValueError(
"Missing the required parameter `session_uuid` when calling `get_decode_session_log`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'project_uuid' in local_var_params:
path_params['project_uuid'] = local_var_params[
'project_uuid'] # noqa: E501
if 'training_version' in local_var_params:
path_params['training_version'] = local_var_params[
'training_version'] # noqa: E501
if 'session_uuid' in local_var_params:
path_params['session_uuid'] = local_var_params[
'session_uuid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['text/plain']) # noqa: E501
# Authentication setting
auth_settings = ['oauth'] # noqa: E501
return self.api_client.call_api(
'/project/{project_uuid}/training/{training_version}/decode/session/{session_uuid}/log',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='str', # 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_azure_cost_reports_with_http_info(self, **kwargs): # noqa: E501
"""Query to obtain cost reports # 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_azure_cost_reports_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str delta: Toggle to include delta values in report.
:param object filter: The filter to apply to the report as a URL encoded dictionary.
:param object group_by: The grouping to apply to the report as a URL encoded dictionary.
:param object order_by: The ordering to apply to the report as a URL encoded dictionary.
:param int offset: Parameter for selecting the offset of data.
:param int limit: Parameter for selecting the amount of data in a returned.
: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(ReportCost, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'delta',
'filter',
'group_by',
'order_by',
'offset',
'limit'
]
all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout'
]
)
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_azure_cost_reports" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
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_azure_cost_reports`, must be a value greater than or equal to `0`") # noqa: E501
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 `get_azure_cost_reports`, 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 `get_azure_cost_reports`, must be a value greater than or equal to `1`") # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
if 'delta' in local_var_params and local_var_params['delta'] is not None: # noqa: E501
query_params.append(('delta', local_var_params['delta'])) # noqa: E501
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
if 'group_by' in local_var_params and local_var_params['group_by'] is not None: # noqa: E501
query_params.append(('group_by', local_var_params['group_by'])) # noqa: E501
if 'order_by' in local_var_params and local_var_params['order_by'] is not None: # noqa: E501
query_params.append(('order_by', local_var_params['order_by'])) # noqa: E501
if 'offset' in local_var_params and local_var_params['offset'] is not None: # noqa: E501
query_params.append(('offset', local_var_params['offset'])) # noqa: E501
if 'limit' in local_var_params and local_var_params['limit'] is not None: # noqa: E501
query_params.append(('limit', local_var_params['limit'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/csv']) # noqa: E501
# Authentication setting
auth_settings = ['basic_auth'] # noqa: E501
return self.api_client.call_api(
'/reports/azure/costs/', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ReportCost', # 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 post_migration_tax_returns_with_http_info(self, migration_tax_returns,
**kwargs): # noqa: E501
"""Creates a Migration Tax Return # noqa: E501
Creates a Migration Tax Return ### Endpoint Availability * Accounting: 🇬🇧, 🇮🇪 * Accounting Start: 🇬🇧, 🇮🇪 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area `Statutory Reporting`: 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.post_migration_tax_returns_with_http_info(migration_tax_returns, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param PostMigrationTaxReturns migration_tax_returns: (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(MigrationTaxReturn, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['migration_tax_returns'] # 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 post_migration_tax_returns" %
key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'migration_tax_returns' is set
if self.api_client.client_side_validation and (
'migration_tax_returns' not in local_var_params
or # noqa: E501
local_var_params['migration_tax_returns'] is None
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `migration_tax_returns` when calling `post_migration_tax_returns`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'migration_tax_returns' in local_var_params:
body_params = local_var_params['migration_tax_returns']
# 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(
'/migration_tax_returns',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='MigrationTaxReturn', # 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_collection_version_artifact_by_id_with_http_info(
self, id, **kwargs): # noqa: E501
"""get_collection_version_artifact_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.get_collection_version_artifact_by_id_with_http_info(id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str id: The CollectionVersion id (required)
:param str search: Term to search for
: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(CollectionVersionArtifactDetail, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', 'search'] # 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_collection_version_artifact_by_id" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'id' is set
if ('id' not in local_var_params or local_var_params['id'] is None):
raise ApiValueError(
"Missing the required parameter `id` when calling `get_collection_version_artifact_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 = []
if 'search' in local_var_params:
query_params.append(
('search', local_var_params['search'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/api/v2/collection-versions/{id}/artifact/',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='CollectionVersionArtifactDetail', # 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 request(self,
method,
url,
query_params=None,
headers=None,
post_params=None,
body=None,
_preload_content=True,
_request_timeout=None):
"""Makes the HTTP request using RESTClient."""
if method == "GET":
return self.rest_client.GET(url,
query_params=query_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
headers=headers)
elif method == "HEAD":
return self.rest_client.HEAD(url,
query_params=query_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
headers=headers)
elif method == "OPTIONS":
return self.rest_client.OPTIONS(url,
query_params=query_params,
headers=headers,
_preload_content=_preload_content,
_request_timeout=_request_timeout)
elif method == "POST":
return self.rest_client.POST(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body)
elif method == "PUT":
return self.rest_client.PUT(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body)
elif method == "PATCH":
return self.rest_client.PATCH(url,
query_params=query_params,
headers=headers,
post_params=post_params,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body)
elif method == "DELETE":
return self.rest_client.DELETE(url,
query_params=query_params,
headers=headers,
_preload_content=_preload_content,
_request_timeout=_request_timeout,
body=body)
else:
raise ApiValueError("http method must be `GET`, `HEAD`, `OPTIONS`,"
" `POST`, `PATCH`, `PUT` or `DELETE`.")
def get_connections_with_http_info(self, **kwargs): # noqa: E501
"""Get all connection entries # 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_connections_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
: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(ConnectionCollection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['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_connections" % 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'] < 1: # noqa: E501
raise ApiValueError(
"Invalid value for parameter `limit` when calling `get_connections`, 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_connections`, must be a value greater than or equal to `0`"
) # 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 '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(
'/connections',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='ConnectionCollection', # 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_issue_finding_churn_with_http_info(self, project, issue_id,
**kwargs): # noqa: E501
"""Get issue finding churn # noqa: E501
Determines an aggregated finding churn across all commits of the issue. This service is public API since Teamscale 5.9. 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_issue_finding_churn_with_http_info(project, issue_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str project: The project alias or id. (required)
:param str issue_id: ID of the issue to determine the finding churn for (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(FindingChurnList, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['project', 'issue_id']
all_params.extend([
'async_req', '_return_http_data_only', '_preload_content',
'_request_timeout'
])
for key, val in six.iteritems(local_var_params['kwargs']):
if key not in all_params:
raise ApiTypeError("Got an unexpected keyword argument '%s'"
" to method get_issue_finding_churn" % 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_issue_finding_churn`"
) # noqa: E501
# verify the required parameter 'issue_id' is set
if self.api_client.client_side_validation and (
'issue_id' not in local_var_params or # noqa: E501
local_var_params['issue_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `issue_id` when calling `get_issue_finding_churn`"
) # 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_issue_finding_churn`, must conform to the pattern `/^(?!aliases$)[-_.a-zA-Z0-9]+$/`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'project' in local_var_params:
path_params['project'] = local_var_params['project'] # noqa: E501
if 'issue_id' in local_var_params:
path_params['issueId'] = local_var_params['issue_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/json']) # noqa: E501
# Authentication setting
auth_settings = ['basicAuth'] # noqa: E501
return self.api_client.call_api(
'/api/projects/{project}/issues/{issueId}/finding-churn',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='FindingChurnList', # 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_connection_with_http_info(self, connection_id, connection,
**kwargs): # noqa: E501
"""Update a connection 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_connection_with_http_info(connection_id, connection, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param int connection_id: The Connection ID. (required)
:param Connection connection: (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(Connection, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['connection_id', 'connection', '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_connection" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'connection_id' is set
if self.api_client.client_side_validation and (
'connection_id' not in local_var_params or # noqa: E501
local_var_params['connection_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `connection_id` when calling `update_connection`"
) # noqa: E501
# verify the required parameter 'connection' is set
if self.api_client.client_side_validation and (
'connection' not in local_var_params or # noqa: E501
local_var_params['connection'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `connection` when calling `update_connection`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'connection_id' in local_var_params:
path_params['connection_id'] = local_var_params[
'connection_id'] # 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 'connection' in local_var_params:
body_params = local_var_params['connection']
# 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(
'/connections/{connection_id}',
'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Connection', # 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_live_facility_controller_show_with_http_info(self, id, **kwargs): # noqa: E501
"""api_web_live_facility_controller_show # noqa: E501
List live parking data for specific parking facility Live data about a given facility. # 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_live_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 include: Relationships to include. * `facility` 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(LiveFacility, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['id', '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_live_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_live_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 '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(
'/live_facilities/{id}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='LiveFacility', # 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 lead_captures_geti_capture_lead_captures_with_http_info(self, company_id, **kwargs): # noqa: E501
"""List iCapture lead captures # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.lead_captures_geti_capture_lead_captures_with_http_info(company_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str company_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(list[LeadCaptureResourceModel], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'company_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 lead_captures_geti_capture_lead_captures" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'company_id' is set
if self.api_client.client_side_validation and ('company_id' not in local_var_params or # noqa: E501
local_var_params['company_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `company_id` when calling `lead_captures_geti_capture_lead_captures`") # noqa: E501
collection_formats = {}
path_params = {}
if 'company_id' in local_var_params:
path_params['companyId'] = local_var_params['company_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/json', 'text/json', 'application/xml', 'text/xml']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/companies/{companyId}/leadcaptures/iCapture', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[LeadCaptureResourceModel]', # 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 margin_required_with_http_info(self, consumerKey, sessionToken,
**kwargs): # noqa: E501
"""Get Margin Required for an order by amount or quantity. # noqa: E501
Returns margin required for Equity, Super Multiple & MTF Order. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.margin_required_with_http_info(consumerKey, sessionToken, async_req=True)
>>> result = thread.get()
:param consumerKey: (required)
:type consumerKey: str
:param sessionToken: (required)
:type sessionToken: str
:param ReqMargin:
:type ReqMargin: ReqMargin
: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[MarginDet], status_code(int), headers(HTTPHeaderDict))
"""
local_var_params = locals()
all_params = ['consumerKey', 'sessionToken', 'ReqMargin']
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 margin_required" % 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 `margin_required`"
) # 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 `margin_required`"
) # noqa: E501
collection_formats = {}
path_params = {}
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
if 'ReqMargin' in local_var_params:
body_params = local_var_params['ReqMargin']
# 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 = ['bearerAuth'] # noqa: E501
return self.api_client.call_api(
'/margin/1.0/margin/required',
'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[MarginDet]', # 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 lead_captures_get_contacts_with_http_info(self, company_id, application_internal_name, model, **kwargs): # noqa: E501
"""List active contacts submitted by lead capture app since latest updated date/time # noqa: E501
ContactId: The id representing the contact <br /> ThirdPartyId: Id generated by the third party. Populated via POST request to a MarketSharp lead capture endpoint and using thirdPartyId or MSM_thirdPartyId <br /> InquiryDateTime: Date/time of when the inquiry was created (this can be modified by the user <br /> AppointmentDate: Date/time of the appointment <br /> AppointmentSetDateTime: Date/time of when the appointment was set. Time will always be 12:00am <br /> AppointmentResult: The current result of the appointment that was scheduled <br /> AppointmentPresenteDateTime: Populated when the current appointment result counts towards a presentation in MarketSharp. Populates with appointment date/time <br /> AppointmentSoldDateTime: Populated when the current appointment result counts towards a sold appointment in MarketSharp. Populates with appointment date/time <br /> ContractApprovedDateTime: Populated when the current contract status is marked Approved. Returns contract date. Time will always be 12:00am <br /> ContractStatus: Is a required field in MarketSharp <br /> LatestUpdatedTime: Takes the latest updated time between the inquiry, appointment, job or job product <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.lead_captures_get_contacts_with_http_info(company_id, application_internal_name, model, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str company_id: (required)
:param str application_internal_name: (required)
:param LeadCaptureContactBindingModel model: (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(list[LeadCaptureContactResourceModel], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'company_id',
'application_internal_name',
'model'
]
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 lead_captures_get_contacts" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'company_id' is set
if self.api_client.client_side_validation and ('company_id' not in local_var_params or # noqa: E501
local_var_params['company_id'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `company_id` when calling `lead_captures_get_contacts`") # noqa: E501
# verify the required parameter 'application_internal_name' is set
if self.api_client.client_side_validation and ('application_internal_name' not in local_var_params or # noqa: E501
local_var_params['application_internal_name'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `application_internal_name` when calling `lead_captures_get_contacts`") # noqa: E501
# verify the required parameter 'model' is set
if self.api_client.client_side_validation and ('model' not in local_var_params or # noqa: E501
local_var_params['model'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `model` when calling `lead_captures_get_contacts`") # noqa: E501
collection_formats = {}
path_params = {}
if 'company_id' in local_var_params:
path_params['companyId'] = local_var_params['company_id'] # noqa: E501
if 'application_internal_name' in local_var_params:
path_params['applicationInternalName'] = local_var_params['application_internal_name'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'model' in local_var_params:
body_params = local_var_params['model']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'text/json', 'application/xml', 'text/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json', 'text/json', 'application/x-www-form-urlencoded']) # noqa: E501
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/companies/{companyId}/leadcaptures/{applicationInternalName}/contacts/filter', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[LeadCaptureContactResourceModel]', # 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 document_payments_get_with_http_info(self, **kwargs): # noqa: E501
"""Fetch document payments 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.document_payments_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 document_id: Filter payments by document_id. You can add multiple ids separate by comma like id,id,id.
:param str payment_at: Filter payments by payment_at. You can filter one date with payment_at=2014-12-10 or between like 2015-01-01,2015-12-31.
:param str reference: Filter payments by reference. You can add multiple references separate by comma like id,id,id.
: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(DocumentPayments, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'limit', 'page', 'document_id', 'payment_at', 'reference'
]
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 document_payments_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 `document_payments_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 `document_payments_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 `document_payments_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 'document_id' in local_var_params and local_var_params[
'document_id'] is not None: # noqa: E501
query_params.append(
('document_id', local_var_params['document_id'])) # noqa: E501
if 'payment_at' in local_var_params and local_var_params[
'payment_at'] is not None: # noqa: E501
query_params.append(
('payment_at', local_var_params['payment_at'])) # noqa: E501
if 'reference' in local_var_params and local_var_params[
'reference'] is not None: # noqa: E501
query_params.append(
('reference', local_var_params['reference'])) # 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(
'/document-payments',
'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='DocumentPayments', # 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 cancel_payment_schedule_with_http_info(self, content_type,
client_request_id, api_key,
timestamp, order_id,
**kwargs): # noqa: E501
"""Cancel a gateway payment schedule. # noqa: E501
Use this to cancel an existing gateway payment schedule. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.cancel_payment_schedule_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, 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 str order_id: Gateway order identifier as returned in the parameter orderId. (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 str store_id: An optional outlet ID for clients that support multiple stores in the same developer app.
: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(PaymentSchedulesResponse, 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',
'order_id', 'message_signature', 'region', 'store_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 cancel_payment_schedule" % 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 `cancel_payment_schedule`"
) # 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 `cancel_payment_schedule`"
) # 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 `cancel_payment_schedule`"
) # 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 `cancel_payment_schedule`"
) # noqa: E501
# verify the required parameter 'order_id' is set
if ('order_id' not in local_var_params
or local_var_params['order_id'] is None):
raise ApiValueError(
"Missing the required parameter `order_id` when calling `cancel_payment_schedule`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'order_id' in local_var_params:
path_params['order-id'] = local_var_params[
'order_id'] # noqa: E501
query_params = []
if 'store_id' in local_var_params:
query_params.append(
('storeId', local_var_params['store_id'])) # noqa: E501
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
# 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(
'/payment-schedules/{order-id}',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='PaymentSchedulesResponse', # 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_provider_with_http_info(self, uuid, **kwargs): # noqa: E501
"""Delete a provider # 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_provider_with_http_info(uuid, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str uuid: ID of provider to delete (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ['uuid'] # 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_provider" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'uuid' is set
if self.api_client.client_side_validation and (
'uuid' not in local_var_params or # noqa: E501
local_var_params['uuid'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `uuid` when calling `delete_provider`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'uuid' in local_var_params:
path_params['uuid'] = local_var_params['uuid'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# Authentication setting
auth_settings = ['basic_auth'] # noqa: E501
return self.api_client.call_api(
'/providers/{uuid}/',
'DELETE',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get('async_req'),
_return_http_data_only=local_var_params.get(
'_return_http_data_only'), # noqa: E501
_preload_content=local_var_params.get('_preload_content', True),
_request_timeout=local_var_params.get('_request_timeout'),
collection_formats=collection_formats)
def user_controller_create_with_http_info(self, reference_code, **kwargs): # noqa: E501
"""user_controller_create # noqa: E501
Used for registering a new <b>User</b>.<br><br><i><b>References:</b> <a href=\"/documentation.html#tocsuser\" target=\"_blank\">UserModel</a></i> # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.user_controller_create_with_http_info(reference_code, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str reference_code: (required)
:param UserExcludingIdUsernameIsVirtualRolesSubscriptionReferenceCode user_excluding_id_username_is_virtual_roles_subscription_reference_code:
: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(User, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'reference_code',
'user_excluding_id_username_is_virtual_roles_subscription_reference_code'
]
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 user_controller_create" % key
)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'reference_code' is set
if self.api_client.client_side_validation and ('reference_code' not in local_var_params or # noqa: E501
local_var_params['reference_code'] is None): # noqa: E501
raise ApiValueError("Missing the required parameter `reference_code` when calling `user_controller_create`") # noqa: E501
collection_formats = {}
path_params = {}
if 'reference_code' in local_var_params:
path_params['referenceCode'] = local_var_params['reference_code'] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'user_excluding_id_username_is_virtual_roles_subscription_reference_code' in local_var_params:
body_params = local_var_params['user_excluding_id_username_is_virtual_roles_subscription_reference_code']
# 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(
'/user/register/{referenceCode}', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='User', # 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)
