Message Template

class q2_sdk.hq.db.message_template.MessageTemplateRow

Bases: RepresentationRowBase

MessageTemplateToCategoryID: IntElement = 'MessageTemplateToCategoryID'

MessageTemplateID: IntElement = 'MessageTemplateID'

MessageTemplateCategoryID: IntElement = 'MessageTemplateCategoryID'

CategoryName: StringElement = 'CategoryName'

TemplateCategoryCreateDate: StringElement = 'TemplateCategoryCreateDate'

TemplateCategoryCreatedByAdminUserID: StringElement = 'TemplateCategoryCreatedByAdminUserID'

TemplateCategoryLastModifiedDate: StringElement = 'TemplateCategoryLastModifiedDate'

TemplateCategoryLastModifiedByAdminUserID: IntElement = 'TemplateCategoryLastModifiedByAdminUserID'

TemplateCategoryDeletedDate: StringElement = 'TemplateCategoryDeletedDate'

TemplateCategoryDeletedByAdminUserID: IntElement = 'TemplateCategoryDeletedByAdminUserID'

TemplateCreatedDate: StringElement = 'TemplateCreatedDate'

TemplateCreatedByAdminUserID: IntElement = 'TemplateCreatedByAdminUserID'

TemplateLastModifiedDate: StringElement = 'TemplateLastModifiedDate'

TemplateLastModifiedByAdminUserID: IntElement = 'TemplateLastModifiedByAdminUserID'

MessageTemplate: StringElement = 'MessageTemplate'

TemplateName: StringElement = 'TemplateName'

class q2_sdk.hq.db.message_template.MessageTemplate(logger, hq_credentials=None, ret_table_obj=None)

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)

Hook for subclassed DbObjects to add custom arguments.

async get(extended=False, serialize_for_cli=False)

Return type:

List[MessageTemplateRow]