MessageRecipientGroup

class q2_sdk.hq.db.message_recipient_group.MessageRecipientGroupRow

Bases: RepresentationRowBase

GroupID: IntElement = 'GroupID'

GroupName: StringElement = 'GroupName'

VisibleToEndUser: BoolElement = 'VisibleToEndUser'

AllowReplies: BoolElement = 'AllowReplies'

GroupDescription: StringElement = 'GroupDescription'

class q2_sdk.hq.db.message_recipient_group.MessageRecipientGroup(logger, hq_credentials=None, ret_table_obj=None)

Bases: DbObject

Used to gather the CSR message groups that can receive secure messages from within the Q2 platform. Generally used in combination with the SendSecureMessageAsXML HQ method to send a message from an end user to a CSR message group

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 = 'GroupName'

NAME = 'MessageRecipientGroup'

REPRESENTATION_ROW_CLASS

alias of MessageRecipientGroupRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False)

Return type:

List[MessageRecipientGroupRow]