"""
Logoff
"""
from q2_sdk.core.q2_logging.logger import Q2LoggerType
from q2_sdk.hq.models.hq_request.backoffice import BackOfficeRequest
from q2_sdk.hq.models.hq_response import HqResponse
from q2_sdk.hq.models.hq_params.backoffice import BackOfficeAuthenticatedParamsObj
from q2_sdk.hq.models.hq_credentials import BackOfficeHqCredentials
[docs]
class ParamsObj(BackOfficeAuthenticatedParamsObj):
"""Parameters definition for Logoff"""
def __init__(self, logger: Q2LoggerType, hq_credentials: BackOfficeHqCredentials):
"""
:param logger: Reference to calling request's logger (self.logger in your extension)
:param hq_credentials: BackOfficeHqCredentials instance
"""
super().__init__(logger, hq_credentials)
self.request_params = {}
[docs]
async def execute(params_obj: ParamsObj, **kwargs) -> HqResponse:
"""
:param params_obj: Object containing everything necessary to call this HQ endpoint
"""
request = BackOfficeRequest("Logoff", **kwargs)
return await request.execute(params_obj, **kwargs)