Source code for ambra_sdk.service.entrypoints.generated.training
""" Training.
Do not edit this file by hand.
This is generated by parsing api.html service doc.
"""
from ambra_sdk.exceptions.service import AllDone
from ambra_sdk.exceptions.service import NotFound
from ambra_sdk.service.query import QueryO
from ambra_sdk.service.query import AsyncQueryO
class Training:
"""Training."""
def __init__(self, api):
self._api = api
[docs] def todo(
self,
):
"""Todo.
"""
request_data = {
}
errors_mapping = {}
errors_mapping[('ALL_DONE', None)] = AllDone('No more training is needed')
query_data = {
'api': self._api,
'url': '/training/todo',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return QueryO(**query_data)
[docs] def done(
self,
account_id,
form_number,
additional_parameters=None,
):
"""Done.
:param account_id: Id of the account the training is for
:param form_number: The formstack id of the form
:param additional_parameters: Additional parameters will be logged as part of the TRAINING_DONE user audit event
"""
request_data = {
'account_id': account_id,
'form_number': form_number,
}
if additional_parameters is not None:
additional_parameters_dict = {'{prefix}{k}'.format(prefix='', k=k): v for k,v in additional_parameters.items()}
request_data.update(additional_parameters_dict)
errors_mapping = {}
errors_mapping[('NOT_FOUND', None)] = NotFound('The form was not found for this user')
query_data = {
'api': self._api,
'url': '/training/done',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return QueryO(**query_data)
class AsyncTraining:
"""AsyncTraining."""
def __init__(self, api):
self._api = api
[docs] def todo(
self,
):
"""Todo.
"""
request_data = {
}
errors_mapping = {}
errors_mapping[('ALL_DONE', None)] = AllDone('No more training is needed')
query_data = {
'api': self._api,
'url': '/training/todo',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return AsyncQueryO(**query_data)
[docs] def done(
self,
account_id,
form_number,
additional_parameters=None,
):
"""Done.
:param account_id: Id of the account the training is for
:param form_number: The formstack id of the form
:param additional_parameters: Additional parameters will be logged as part of the TRAINING_DONE user audit event
"""
request_data = {
'account_id': account_id,
'form_number': form_number,
}
if additional_parameters is not None:
additional_parameters_dict = {'{prefix}{k}'.format(prefix='', k=k): v for k,v in additional_parameters.items()}
request_data.update(additional_parameters_dict)
errors_mapping = {}
errors_mapping[('NOT_FOUND', None)] = NotFound('The form was not found for this user')
query_data = {
'api': self._api,
'url': '/training/done',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return AsyncQueryO(**query_data)