Base

class q2_sdk.hq.models.external_auth.base.AuthorizationStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]: Bases: Enum

class q2_sdk.hq.models.external_auth.base.StandardAuthResponseFields(success, status_description, hq_error_return_code, end_user_message)[source]

Bases: object

StandardAuthResponseFields(success: ‘bool’, status_description: ‘Optional[str]’, hq_error_return_code: ‘Optional[int]’, end_user_message: ‘Optional[str]’)

class q2_sdk.hq.models.external_auth.base.BaseAuthResponse(standard_auth_response_fields)[source]

Bases: object

All other auth responses have at least this info

<Q2Bridge request="RequestType" messageID="messageID">
  <Status>"Success"/"Error"</Status>
  <HQErrorReturnCode>{0}</HQErrorReturnCode>
  <StatusDescription>{0}</StatusDescription>
  <EndUserMessage>{0}</EndUserMessage>
</Q2Bridge>

classmethod get_success(*args, **kwargs)[source]

Returns OK to HQ

Return type:: Self

classmethod get_failure(*args, **kwargs)[source]

Returns Failure to HQ

Return type:: Self

class q2_sdk.hq.models.external_auth.base.BaseAuthRequest(raw)[source]

Bases: object

BaseAuthRequest(raw: ‘objectify.Element’)

class q2_sdk.hq.models.external_auth.base.Password(value, encrypted)[source]

Bases: object

Password(value: ‘str’, encrypted: ‘bool’)