Message Template

class q2_sdk.hq.db.message_template.MessageTemplateRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

MessageTemplateToCategoryID: int

MessageTemplateID: int

MessageTemplateCategoryID: int

CategoryName: str

TemplateCategoryCreateDate: str

TemplateCategoryCreatedByAdminUserID: str

TemplateCategoryLastModifiedDate: str

TemplateCategoryLastModifiedByAdminUserID: int

TemplateCategoryDeletedDate: str

TemplateCategoryDeletedByAdminUserID: int

TemplateCreatedDate: str

TemplateCreatedByAdminUserID: int

TemplateLastModifiedDate: str

TemplateLastModifiedByAdminUserID: int

MessageTemplate: str

TemplateName: str

class q2_sdk.hq.db.message_template.MessageTemplate(logger, hq_credentials=None, ret_table_obj=None)[source]

Bases: DbObject

Programmatic access to the Q2 database. Not as flexible as a true ORM, but takes the guesswork out of database schemas and ensures safety in the transactions.

Parameters:

logger – Reference to calling request’s logger (self.logger in your extension)
hq_credentials (Optional[HqCredentials]) – HQ Connectivity Information (Defaults to settings file)
ret_table_obj (Optional[bool]) – Flag to return list of LXML elements if False or TableRow objects from DB calls if True (Defaults to settings file)

GET_BY_NAME_KEY = 'TemplateName'

NAME = 'MessageTemplate'

REPRESENTATION_ROW_CLASS: alias of MessageTemplateRow

add_arguments(parser)[source]: Hook for subclassed DbObjects to add custom arguments.

async get(extended=False, serialize_for_cli=False)[source]

Return type:: List[MessageTemplateRow]