Message

class q2_sdk.hq.db.message.MessageRow

Bases: RepresentationRowBase

MessageID: IntElement = 'MessageID'

From: StringElement = 'From'

To: StringElement = 'To'

Subject: StringElement = 'Subject'

Body: StringElement = 'Body'

ReceivedDate: StringElement = 'ReceivedDate'

UnreadByCustomer: BoolElement = 'UnreadByCustomer'

HasAttachment: BoolElement = 'HasAttachment'

ToUser: BoolElement = 'ToUser'

AllowReplies: BoolElement = 'AllowReplies'

class q2_sdk.hq.db.message.MessageThreadRow

Bases: RepresentationRowBase

Generation: IntElement = 'Generation'

MessageID: IntElement = 'MessageID'

From: StringElement = 'From'

To: StringElement = 'To'

Subject: StringElement = 'Subject'

Body: StringElement = 'Body'

CreateDate: StringElement = 'CreateDate'

ReceivedDate: StringElement = 'ReceivedDate'

ExpirationDate: StringElement = 'ExpirationDate'

ReadDate: StringElement = 'ReadDate'

ParentID: IntElement = 'ParentID'

ResolvedState: BoolElement = 'ResolvedState'

HasAttachment: StringElement = 'HasAttachment'

MessageStatus: StringElement = 'MessageStatus'

class q2_sdk.hq.db.message.Message(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)

NAME = 'Message'

REPRESENTATION_ROW_CLASS

alias of MessageRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(user_id, serialize_for_cli=False)

Return type:

List[MessageRow]

async get_message_thread(**kwargs)