TipConfig

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

Bases: TableRow

EndpointURL: str
PayloadStoredProcName: str
TimeoutInMs: int
OptionalConfigJson: str
IsEnabled: bool
IsActiveMode: bool
FallbackTransactionStatusShortName: str
class q2_sdk.hq.db.tip_config.GetTipConfigByGtTypeRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

ConfigID: int
OptionalGtTypeShortName_: str
OptionalUiSourceShortName_: str
OptionalGtFlavorShortName_: str
OptionalGroupID_: int
IsEnabled: bool
IsActiveMode: bool
FallbackTransactionStatusShortName_: str
EndpointURL: str
PayloadStoredProcName: str
TimeoutInMs: int
OptionalConfigJson: str
class q2_sdk.hq.db.tip_config.TipConfigDefaultParamsFactory(endpoint_url, optional_ui_source_short_name=None, optional_gt_flavor_short_name=None, optional_group_id=None, is_enabled=True, is_active_mode=False, fallback_transaction_status_short_name='Drafted')[source]

Bases: object

TipConfigDefaultParamsFactory(endpoint_url: str, optional_ui_source_short_name: Optional[str] = None, optional_gt_flavor_short_name: Optional[str] = None, optional_group_id: Optional[int] = None, is_enabled: bool = True, is_active_mode: bool = False, fallback_transaction_status_short_name: str = ‘Drafted’)

endpoint_url: str
optional_ui_source_short_name: Optional[str] = None
optional_gt_flavor_short_name: Optional[str] = None
optional_group_id: Optional[int] = None
is_enabled: bool = True
is_active_mode: bool = False
fallback_transaction_status_short_name: str = 'Drafted'
build_sql_params(gt_type_short_name)[source]
Return type:

SqlParameters

class q2_sdk.hq.db.tip_config.TipConfig(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 = 'TipConfig'
REPRESENTATION_ROW_CLASS

alias of GetTipConfigRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get(user_id, gt_type_short_name, ui_source_short_name=None, optional_gt_flavor_short_name=None, serialize_for_cli=False)[source]
Return type:

List[GetTipConfigRow]

async get_by_gt_type(gt_type_short_name, serialize_for_cli=False)[source]
Return type:

List[GetTipConfigByGtTypeRow]

async add_default_record_for_gt_type_short_name(gt_type_short_name, config_factory, serialize_for_cli=False)[source]
Return type:

Union[List[TableRow], List[ObjectifiedElement]]

async add_default_records_for_gt_type_short_names(endpoint_url, is_enabled=True, is_active_mode=False, serialize_for_cli=False)[source]
Return type:

List[Union[List[TableRow], List[ObjectifiedElement]]]