UserRole

class q2_sdk.hq.db.user_role.UserRoleRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

UserRoleID: int

CustomerID: int

Description: str

PolicyID: int

DeletedDate: str

Enabled: bool

ExtendedDescription: str

IsTemplate: bool

IsOpenBanking: bool

class q2_sdk.hq.db.user_role.UserRole(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 = 'Description'

NAME = 'UserRole'

REPRESENTATION_ROW_CLASS: alias of UserRoleRow

add_arguments(parser)[source]: Hook for subclassed DbObjects to add custom arguments.

async get_by_customer_id(customer_id, include_deleted=False, serialize_for_cli=False)[source]

Return type:: List[UserRoleRow]