SecAlertUserPref

class q2_sdk.hq.db.sec_alert_user_pref.SecAlertUserPrefRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

SecAlertUserPrefID: int
UserID: int
EmailID: int
SmsID: int
PhoneID: int
PushTargetID: int
FirstName: str
LastName: str
EmailAddress: str
PhoneNumber: str
CountryCodePhoneNumber: str
AreaCodePhoneNumber: str
SmsNumber: str
CountryCodeSmsNumber: str
AreaCodeSmsNumber: str
Nickname: str
class q2_sdk.hq.db.sec_alert_user_pref.SecAlertUserPref(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 = 'SecAlertUserPref'
REPRESENTATION_ROW_CLASS

alias of SecAlertUserPrefRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

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

List[SecAlertUserPrefRow]

async add(user_id, email_address=None, phone_id=None, sms_id=None, push_target_id=None)[source]
async update(user_id=None, email_id=None, email_address=None, phone_id=None, phone_country_id=None, phone_city_or_area_code=None, phone_local_number=None, phone_extension=None, sms_id=None, sms_country_id=None, sms_city_or_area_code=None, sms_local_number=None, sms_extension=None, push_target_id=None)[source]
async remove(sec_alert_user_pref_id)[source]

Note: this only works in the dev environment

exception q2_sdk.hq.db.sec_alert_user_pref.EmailUnrelatedToUserError[source]

Bases: Exception

Email Address not related to User

exception q2_sdk.hq.db.sec_alert_user_pref.PhoneUnrelatedToUserError[source]

Bases: Exception

Phone Number not related to User

exception q2_sdk.hq.db.sec_alert_user_pref.SmsUnrelatedToUserError[source]

Bases: Exception

Sms(Phone Number) not related to User

exception q2_sdk.hq.db.sec_alert_user_pref.PushTargetUnrelatedToUserError[source]

Bases: Exception

Push Notification Targets not relevant to the User