MarketingPageName

class q2_sdk.hq.db.marketing_page_name.MarketingPageNameRow

Bases: RepresentationRowBase

MarketingPageNameID: IntElement = 'MarketingPageNameID'

ShortName: StringElement = 'ShortName'

Description: StringElement = 'Description'

AllowMarketing: BoolElement = 'AllowMarketing'

SystemNotification: BoolElement = 'SystemNotification'

WedgeAddressID: IntElement = 'WedgeAddressID'

class q2_sdk.hq.db.marketing_page_name.SystemNotificationRow

Bases: RepresentationRowBase

CampaignName: StringElement = 'CampaignName'

StartDate: StringElement = 'StartDate'

EndDate: StringElement = 'EndDate'

ZoneID: IntElement = 'ZoneID'

class q2_sdk.hq.db.marketing_page_name.MarketingPageName(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)

GET_BY_NAME_KEY = 'ShortName'

NAME = 'MarketingPageName'

REPRESENTATION_ROW_CLASS

alias of MarketingPageNameRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(short_name, serialize_for_cli=False)

Return type:

List[MarketingPageNameRow]

async add(short_name, description, allow_marketing, system_notification, wedge_address_id=None)

async get_system_notifications(serialize_for_cli=False)

Fetches Marketing messages that are marked as System Notifications and enabled. Can be used with Q2API GetMarketingCampaign call.

Return type:

list[SystemNotificationRow]