SendNotification2 module

Send an email, sms or voice call (IsoCodeA3=ISO 3166 country code=’USA’, ‘CAN’, ‘MEX’, …)

class q2_sdk.hq.hq_api.q2_api.SendNotification2.ParamsObj(logger, notification_type, target_address, subject, body, target_country_iso_code_a3, hq_credentials=None)

Bases: Q2ApiParamsObj

Parameters definition for SendNotification2

Parameters:

• logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)

• notification_type (str) – Corresponds to the Q2_NotificationType table (relevant options are sms/email)

• target_address (str)

• subject (str)

• body (str)

• target_country_iso_code_a3 (str)

• hq_credentials (Optional[HqCredentials]) – Defaults to settings.HQ_CREDENTIALS

async q2_sdk.hq.hq_api.q2_api.SendNotification2.execute(params_obj, use_json=False, **kwargs)

This is the default way to submit the request to HQ. In theory, both json and soap payloads are equally accepted by HQ, though several variables may affect that (HQ version, Q2SDK implementation bugs, etc). This should not affect anything about the way your code deals with the data. In fact, the only difference to consuming extensions is the logging. Basically, call this with default parameters unless you find a compelling reason not to.

Parameters:

• params_obj (ParamsObj) – Object containing everything necessary to call this HQ endpoint

• use_json – If True, will call HQ’s .ashx (json) endpoint instead of .asmx (soap)

Return type:

HqResponse

async q2_sdk.hq.hq_api.q2_api.SendNotification2.get_soap(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

async q2_sdk.hq.hq_api.q2_api.SendNotification2.get_json(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

q2_sdk.hq.hq_api.q2_api.SendNotification2.build_json(params_obj)

q2_sdk.hq.hq_api.q2_api.SendNotification2.build_soap(params_obj)