Host Account Data Element With References

class q2_sdk.hq.db.host_account_data_element_with_references.HADEParams[source]

Bases: object

HADEParams()

build_stored_proc_params()[source]
class q2_sdk.hq.db.host_account_data_element_with_references.GetHADEParams(HADE_ID=None, HADEDataType=None, HADEName=None, HostAccountClickTypeID=None, UiTextElementID=None)[source]

Bases: HADEParams

GetHADEParams(HADE_ID: int | None = None, HADEDataType: str | None = None, HADEName: str | None = None, HostAccountClickTypeID: int | None = None, UiTextElementID: int | None = None)

HADE_ID: int | None = None
HADEDataType: str | None = None
HADEName: str | None = None
HostAccountClickTypeID: int | None = None
UiTextElementID: int | None = None
class q2_sdk.hq.db.host_account_data_element_with_references.CreateHADEParams(HADEDesc, HADEDataType, HADEName, HostAccountClickTypeID=None, ClickTypeAttributes=None, UiTextElementID=None, AdditionalDescUiTextElementID=None, IsEditable=False, ExcludeInUserAccountResponse=False)[source]

Bases: HADEParams

CreateHADEParams(HADEDesc: str, HADEDataType: str, HADEName: str, HostAccountClickTypeID: int | None = None, ClickTypeAttributes: str | None = None, UiTextElementID: int | None = None, AdditionalDescUiTextElementID: int | None = None, IsEditable: bool | None = False, ExcludeInUserAccountResponse: bool | None = False)

HADEDesc: str
HADEDataType: str
HADEName: str
HostAccountClickTypeID: int | None = None
ClickTypeAttributes: str | None = None
UiTextElementID: int | None = None
AdditionalDescUiTextElementID: int | None = None
IsEditable: bool | None = False
ExcludeInUserAccountResponse: bool | None = False
class q2_sdk.hq.db.host_account_data_element_with_references.UpdateHADEParams(HADE_ID, HADEDesc=None, HADEDataType=None, HADEName=None, HostAccountClickTypeID=None, ClickTypeAttributes=None, UiTextElementID=None, AdditionalDescUiTextElementID=None, IsEditable=False, ExcludeInUserAccountResponse=False)[source]

Bases: HADEParams

UpdateHADEParams(HADE_ID: int | None, HADEDesc: str | None = None, HADEDataType: str | None = None, HADEName: str | None = None, HostAccountClickTypeID: int | None = None, ClickTypeAttributes: str | None = None, UiTextElementID: int | None = None, AdditionalDescUiTextElementID: int | None = None, IsEditable: bool | None = False, ExcludeInUserAccountResponse: bool | None = False)

HADE_ID: int | None
HADEDesc: str | None = None
HADEDataType: str | None = None
HADEName: str | None = None
HostAccountClickTypeID: int | None = None
ClickTypeAttributes: str | None = None
UiTextElementID: int | None = None
AdditionalDescUiTextElementID: int | None = None
IsEditable: bool | None = False
ExcludeInUserAccountResponse: bool | None = False
class q2_sdk.hq.db.host_account_data_element_with_references.HostAccountDataElementWithReferencesRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

HADE_ID: str
HADEDesc: str
HADEDataType: str
HADEName: str
HostAccountClickTypeID: int
ClickTypeAttributes: str
UiTextElementID: int
AdditionalDescUiTextElementID: int
IsEditable: bool
ExcludeInUserAccountResponse: bool
class q2_sdk.hq.db.host_account_data_element_with_references.HostAccountDataElementWithReferences(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 = 'HostAccountDataElementWithReferences'
REPRESENTATION_ROW_CLASS

alias of HostAccountDataElementWithReferencesRow

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

list[HostAccountDataElementWithReferencesRow]

async create(hade_params)[source]

Create new HostAccountDataElement objects from the provided parameters and references

Return type:

Any

async update(hade_params)[source]

Update HostAccountDataElement objects based on the provided parameters and references

Return type:

Any