Source code for q2_sdk.hq.db.message_template

from argparse import _SubParsersAction
from functools import partial
from typing import List
from lxml.objectify import IntElement, StringElement
from q2_sdk.core.dynamic_imports import (
    api_ExecuteStoredProcedure as ExecuteStoredProcedure,
)
from .db_object import DbObject
from .representation_row_base import RepresentationRowBase


[docs] class MessageTemplateRow(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"
[docs] class MessageTemplate(DbObject): GET_BY_NAME_KEY = "TemplateName" NAME = "MessageTemplate" REPRESENTATION_ROW_CLASS = MessageTemplateRow
[docs] def add_arguments(self, parser: _SubParsersAction): subparser = parser.add_parser("get_message_template") subparser.set_defaults(parser="get") subparser.set_defaults(func=partial(self.get, serialize_for_cli=True)) subparser.add_argument( "--extended", action="store_true", help="Extends the output of rows" )
[docs] async def get( self, extended=False, serialize_for_cli=False ) -> List[MessageTemplateRow]: sql_parameters = None if extended: sql_parameters = ExecuteStoredProcedure.SqlParameters([ ExecuteStoredProcedure.SqlParam( ExecuteStoredProcedure.DataType.Bit, "extended", True ) ]) response = await self.call_hq( "sdk_GetMessageTemplate", sql_parameters=sql_parameters ) if serialize_for_cli: columns = [ "MessageTemplateID", "MessageTemplateCategoryID", "CategoryName", "TemplateName", ] response = self.serialize_for_cli(response, columns) return response