ThirdPartyData

class q2_sdk.hq.db.third_party_data.ThirdPartyDataRow(element, row_class=None, rename_fields=None)

Bases: TableRow

VendorID: int

UserID: int

DataID: int

DataValue: str

class q2_sdk.hq.db.third_party_data.ThirdPartyData(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)

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(user_id, vendor_name, serialize_for_cli=False)

async create(user_id, vendor_name, data_name, data_value)

async add_or_update(user_id, vendor_name, data_name, data_value)

Upserts third-party data, factoring in Q2_ThirdPartyDataShared and Q2_VendorGroupMembers.

async update(user_id, vendor_name, data_name, data_value)

async delete(user_id, vendor_name, data_name)

async delete_all_for_vendor(vendor_name)

async get_by_vendor_paginated(vendor_id=None, vendor_name=None, page_number=1, return_count=500)

Return type:

list[ThirdPartyDataRow]