AccountAddress

class q2_sdk.hq.db.account_address.AccountAddressRow

Bases: RepresentationRowBase

UserID: IntElement = 'UserID'

AddressID: IntElement = 'AddressID'

HostAccountID: IntElement = 'HostAccountID'

StreetAddress1: StringElement = 'StreetAddress1'

StreetAddress2: StringElement = 'StreetAddress2'

City: StringElement = 'City'

State: StringElement = 'State'

PostalCode: StringElement = 'PostalCode'

CustomerID: IntElement = 'CustomerID'

AddressType: StringElement = 'AddressType'

CountryID: IntElement = 'CountryID'

IsInternational: BoolElement = 'IsInternational'

Province: StringElement = 'Province'

ISsoCodeA3: StringElement = 'ISsoCodeA3'

CountryName: StringElement = 'CountryName'

class q2_sdk.hq.db.account_address.AccountAddressHistoryRow

Bases: RepresentationRowBase

ChangeAccountID: IntElement = 'ChangeAccountID'

HostAccountID: IntElement = 'HostAccountID'

TransactionID: IntElement = 'TransactionID'

OldAddressID: IntElement = 'OldAddressID'

StreetAddress1: StringElement = 'StreetAddress1'

StreetAddress2: StringElement = 'StreetAddress2'

City: StringElement = 'City'

State: StringElement = 'State'

PostalCode: StringElement = 'PostalCode'

EmailAddress: StringElement = 'EmailAddress'

HomePhoneNumber: StringElement = 'HomePhoneNumber'

WorkPhoneNumber: StringElement = 'WorkPhoneNumber'

CellPhoneNumber: StringElement = 'CellPhoneNumber'

CountryID: IntElement = 'CountryID'

Province: StringElement = 'Province'

IsoCodeA3: StringElement = 'IsoCodeA3'

Status: StringElement = 'Status'

class q2_sdk.hq.db.account_address.AccountAddress(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 = 'AccountAddress'

REPRESENTATION_ROW_CLASS

alias of AccountAddressRow

add_arguments(parser)

Hook for subclassed DbObjects to add custom arguments.

async get(host_account_id, serialize_for_cli=False)

Return type:

list[AccountAddressRow]

async get_by_address_id(address_id, serialize_for_cli=False)

Return type:

list[AccountAddressRow]

async get_history(host_account_id, serialize_for_cli=False)

Return type:

list[AccountAddressHistoryRow]

async create(host_account_id, address_id)

async update(host_account_id, address_id, current_address_id=None)

async delete(host_account_id, online_session, online_user)