DateAlert

class q2_sdk.hq.db.date_alert.DateAlertRow[source]

Bases: RepresentationRowBase

AlertDefinitionID: IntElement = 'AlertDefinitionID'
AlertTypeID: IntElement = 'AlertTypeID'
UserID: IntElement = 'UserID'
Enabled: BoolElement = 'Enabled'
SendSecureMessage: BoolElement = 'SendSecureMessage'
OneTimeAlert: BoolElement = 'OneTimeAlert'
NotificationTypeID: IntElement = 'NotificationTypeID'
NotificationTime: StringElement = 'NotificationTime'
Operand: StringElement = 'Operand'
ComparisonValue: StringElement = 'ComparisonValue'
LastAlerted: StringElement = 'LastAlerted'
CountryID: IntElement = 'CountryID'
CityOrAreaCode: StringElement = 'CityOrAreaCode'
LocalNumber: StringElement = 'LocalNumber'
EmailAddress: StringElement = 'EmailAddress'
CreateDate: StringElement = 'CreateDate'
AlertDateTypeID: StringElement = 'AlertDateTypeID'
UserText: StringElement = 'UserText'
class q2_sdk.hq.db.date_alert.DateAlert(logger, hq_credentials=None, ret_table_obj=None)[source]

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 = 'DateAlert'
REPRESENTATION_ROW_CLASS

alias of DateAlertRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(user_id, serialize_for_cli=False)[source]
Return type:

List[DateAlertRow]

async create(alert_info, create_date=None)[source]
async update(alert_info, alert_definition_id)[source]