Host Account Data Element

enum q2_sdk.hq.db.host_account_data_element.HADEDataTypes(value)

Bases: Enum

Valid values are as follows:

Boolean = <HADEDataTypes.Boolean: 'Boolean'>

Currency = <HADEDataTypes.Currency: 'Currency'>

Date = <HADEDataTypes.Date: 'Date'>

Number = <HADEDataTypes.Number: 'Number'>

Rate = <HADEDataTypes.Rate: 'Rate'>

String = <HADEDataTypes.String: 'String'>

class q2_sdk.hq.db.host_account_data_element.CreateHADEParams(hade_desc, hade_data_type, hade_name, host_account_click_type_id=None, click_type_attributes=None, ui_text_element=None, ui_text_element_id=None, additional_desc_ui_text_element=None, additional_desc_ui_text_element_id=None, is_editable=False)

Bases: object

CreateHADEParams(hade_desc: str, hade_data_type: q2_sdk.hq.db.host_account_data_element.HADEDataTypes | str, hade_name: str, host_account_click_type_id: int | None = None, click_type_attributes: str | None = None, ui_text_element: str | None = None, ui_text_element_id: int | None = None, additional_desc_ui_text_element: str | None = None, additional_desc_ui_text_element_id: int | None = None, is_editable: bool = False)

hade_desc: str

hade_data_type: HADEDataTypes | str

hade_name: str

host_account_click_type_id: int | None = None

click_type_attributes: str | None = None

ui_text_element: str | None = None

ui_text_element_id: int | None = None

additional_desc_ui_text_element: str | None = None

additional_desc_ui_text_element_id: int | None = None

is_editable: bool = False

build_stored_proc_params()

class q2_sdk.hq.db.host_account_data_element.HostAccountDataElementRow(element, row_class=None, rename_fields=None)

Bases: TableRow

HADE_ID: str

HADEDesc: str

HADEDataType: str

HADEName: str

HostAccountClickTypeID: int

ClickTypeAttributes: str

UiTextElementID: int

AdditionalDescUiTextElementID: int

class q2_sdk.hq.db.host_account_data_element.HostAccountDataElement(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 = 'HADEName'

NAME = 'HostAccountDataElement'

REPRESENTATION_ROW_CLASS

alias of HostAccountDataElementRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(serialize_for_cli=False)

Note: this only works in the dev environment

Return type:

List[HostAccountDataElementRow]

async create(data_element_param)

Return type:

None