SendNotificationWithHtml module
Send an email, sms, or voice call with optional email html body
- class q2_sdk.hq.hq_api.q2_api.SendNotificationWithHtml.ParamsObj(logger, notification_type, target_address, subject, text_body, html_body, add_html_header_and_footer, add_disclaimer, ui_short_name, hq_credentials=None)[source]
Bases:
Q2ApiParamsObjParameters definition for SendNotificationWithHtml
- 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)text_body (
str)html_body (
str)add_html_header_and_footer (
bool)add_disclaimer (
bool)ui_short_name (
str) – Corresponds to ShortName column in the Q2_UiSelection table. Should almost always be “Q2”hq_credentials (
Optional[HqCredentials]) – Defaults to settings.HQ_CREDENTIALS
- async q2_sdk.hq.hq_api.q2_api.SendNotificationWithHtml.execute(params_obj, use_json=False, **kwargs)[source]
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 endpointuse_json – If True, will call HQ’s .ashx (json) endpoint instead of .asmx (soap)
- Return type:
- async q2_sdk.hq.hq_api.q2_api.SendNotificationWithHtml.get_soap(params_obj, **kwargs)[source]
Deprecated. Please use execute instead
- Return type: