Country

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

Bases: TableRow

CountryID: int
IsoCode: int
IsoCodeA2: str
IsoCodeA3: str
Name: str
DialingCode: int
CityAreaCodeEditMask: str
LocalNumberEditMask: str
IsValidForInternationalAddress: bool
SmsDialingCode: int
PostalCodeRequired: bool
ProvinceRequired: bool
class q2_sdk.hq.db.country.Country(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)

GET_BY_NAME_KEY = 'Name'
NAME = 'Country'
REPRESENTATION_ROW_CLASS

alias of CountryRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

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

List[CountryRow]