VendorConfig

class q2_sdk.hq.db.vendor_config.ConfigDataType

Bases: object

Bool = 'Bool'

Currency = 'Currency'

Date = 'Date'

File = 'File'

Int = 'Int'

Integer = 'Integer'

Number = 'Number'

String = 'String'

static from_value(value)

Return type:

ConfigDataType

class q2_sdk.hq.db.vendor_config.VendorConfigRow(element, row_class=None, rename_fields=None)

Bases: TableRow

VendorID: int

ConfigID: int

ConfigValue: str

ConfigName: str

Description: str

DataTypeID: int

VendorName: str

DataType: str

class q2_sdk.hq.db.vendor_config.VendorConfig(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)

NAME = 'VendorConfig'

REPRESENTATION_ROW_CLASS

alias of VendorConfigRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(vendor_name, serialize_for_cli=False, zone_id=0)

Return type:

List[VendorConfigRow]

async get_all()

Return type:

List[VendorConfigRow]

async create(vendor_name, config_name, config_value, data_type, description=None)

async update(vendor_name, config_name, config_value, data_type, description=None)

async delete(vendor_name, config_name)