AccountAddress

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

Bases: TableRow

UserID: int
AddressID: int
HostAccountID: int
StreetAddress1: str
StreetAddress2: str
City: str
State: str
PostalCode: str
CustomerID: int
AddressType: str
CountryID: int
IsInternational: bool
Province: str
ISsoCodeA3: str
CountryName: str
class q2_sdk.hq.db.account_address.AccountAddressHistoryRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

ChangeAccountID: int
HostAccountID: int
TransactionID: int
OldAddressID: int
StreetAddress1: str
StreetAddress2: str
City: str
State: str
PostalCode: str
EmailAddress: str
HomePhoneNumber: str
WorkPhoneNumber: str
CellPhoneNumber: str
CountryID: int
Province: str
IsoCodeA3: str
Status: str
class q2_sdk.hq.db.account_address.AccountAddress(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 = 'AccountAddress'
REPRESENTATION_ROW_CLASS

alias of AccountAddressRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

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

list[AccountAddressRow]

async get_by_address_id(address_id, serialize_for_cli=False)[source]
Return type:

list[AccountAddressRow]

async get_history(host_account_id, serialize_for_cli=False)[source]
Return type:

list[AccountAddressHistoryRow]

async create(host_account_id, address_id)[source]
async update(host_account_id, address_id, current_address_id=None)[source]
async delete(host_account_id, online_session, online_user)[source]