Source code for q2_sdk.hq.db.message_template

from argparse import _SubParsersAction
from functools import partial
from typing import List

from q2_sdk.core.dynamic_imports import (
    api_ExecuteStoredProcedure as ExecuteStoredProcedure,
)
from q2_sdk.hq.table_row import TableRow

from .db_object import DbObject


[docs] class MessageTemplateRow(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
[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