User

class q2_sdk.hq.db.user.UpdateUserValues(user_id, ssn=None, primary_cif=None, unset_primary_cif=False)[source]

Bases: object

UpdateUserValues(user_id: int, ssn: str = None, primary_cif: str = None, unset_primary_cif: bool = False)

user_id: int
ssn: str = None
primary_cif: str = None
unset_primary_cif: bool = False
class q2_sdk.hq.db.user.DeleteUserParams(success, error_message, response)[source]

Bases: object

DeleteUserParams(success: bool, error_message: None, response: q2_sdk.hq.models.hq_response.HqResponse)

success: bool
error_message: None
response: HqResponse
class q2_sdk.hq.db.user.GetUserValues(social_security, primary_cif, user_id, login_name)[source]

Bases: object

GetUserValues(social_security: str, primary_cif: str, user_id: int, login_name: str)

social_security: str
primary_cif: str
user_id: int
login_name: str
class q2_sdk.hq.db.user.SearchUserValues(first_name=None, last_name=None, email_address=None, phone_number=None, local_number=None, city_or_areacode=None, sso_identifier=None)[source]

Bases: object

SearchUserValues(first_name: str = None, last_name: str = None, email_address: str = None, phone_number: str = None, local_number: str = None, city_or_areacode: str = None, sso_identifier: str = None)

first_name: str = None
last_name: str = None
email_address: str = None
phone_number: str = None
local_number: str = None
city_or_areacode: str = None
sso_identifier: str = None
valid_inputs()[source]
hydrate_stored_proc_params()[source]
class q2_sdk.hq.db.user.SearchUserResponse(success, result=None, error_message=None)[source]

Bases: object

SearchUserResponse(success: bool, result: Optional[list] = None, error_message: Optional[str] = None)

success: bool
result: Optional[list] = None
error_message: Optional[str] = None
class q2_sdk.hq.db.user.UserRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

UserID: int
CustomerID: int
FirstName: str
MiddleName: str
LastName: str
Salutation: str
Suffix: str
SSN: str
CreateDate: str
DeletedDate: str
DefaultEmailID: int
DefaultAddressID: int
AutoGenerated: bool
HostUser: str
HostPwd: str
UserInfo: str
ProfileUpdated: bool
MobileAuthCode: str
UseCustomerAccounts: bool
PrimaryCIF: str
LastUserProfileUpdate: str
UserRoleID: int
PolicyID: int
UserStatusID: int
StatusChangeDate: str
DOB: str
IsOpenBanking: bool
class q2_sdk.hq.db.user.User(logger, hq_credentials=None, ret_table_obj=None)[source]

Bases: DbObject

Queries the Q2_User table for rows that match the given arguments. Gathers additional details on specific users

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 = 'User'
REPRESENTATION_ROW_CLASS

alias of UserRow

add_arguments(parser)[source]

Hook for subclassed DbObjects to add custom arguments.

async get_deleted(deleted_after, serialize_for_cli=False, extended=False)[source]
async get(user_id=None, login_name=None, social_security=None, primary_cif=None, extended=False, combine=False, serialize_for_cli=False)[source]
Return type:

List[UserRow]

async get_many(user_ids)[source]

Retrieves multiple users matching the given user IDs :param: user_ids: list of Q2_User.UserIDs

Return type:

list[UserRow]

async get_users_under_customer(customer_id, extended=False, serialize_for_cli=False, include_deleted=False)[source]
async set_profile_updated_flag(user_id)[source]
get_cli_response(extended, response)[source]
async update_dob(user_id, dob)[source]
async update(user_id, ssn=None, primary_cif=None, unset_primary_cif=False)[source]
async delete(user_id, serialize_for_cli=None)[source]
async search_by_create_date(created_on, serialize_for_cli=False, extended=False)[source]
Return type:

List[UserRow]

async search(first_name='', last_name='', email_address='', phone_number='', sso_identifier='', serialize_for_cli=False, extended=False)[source]
Return type:

SearchUserResponse

async search_by_sso_identifier(sso_identifier)[source]
async get_admin_users_by_customer_id(customer_id, serialize_for_cli=False)[source]