Email

class q2_sdk.hq.db.email.EmailRow

Bases: RepresentationRowBase

EmailID: IntElement = 'EmailID'

UserID: IntElement = 'UserID'

EmailAddress: StringElement = 'EmailAddress'

class q2_sdk.hq.db.email.Email(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)

REPRESENTATION_ROW_CLASS

alias of EmailRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get_by_user(user_id, serialize_for_cli=False)

Return type:

List[EmailRow]

async get_by_id(email_id, serialize_for_cli=False)

Return type:

List[EmailRow]

async get_primary(user_id, serialize_for_cli=False)

Return type:

List[EmailRow]

async create(user_id, email)

async update(email_id, email)

async delete(email_id, online_session, online_user)