User

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

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)

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)

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)

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()

hydrate_stored_proc_params()

class q2_sdk.hq.db.user.SearchUserResponse(success, result=None, error_message=None)

Bases: object

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

success: bool

result: list = None

error_message: str = None

class q2_sdk.hq.db.user.UserRow

Bases: RepresentationRowBase

UserID: IntElement = 'UserID'

CustomerID: IntElement = 'CustomerID'

FirstName: StringElement = 'FirstName'

MiddleName: StringElement = 'MiddleName'

LastName: StringElement = 'LastName'

Salutation: StringElement = 'Salutation'

Suffix: StringElement = 'Suffix'

SSN: StringElement = 'SSN'

CreateDate: StringElement = 'CreateDate'

DeletedDate: StringElement = 'DeletedDate'

DefaultEmailID: IntElement = 'DefaultEmailID'

DefaultAddressID: IntElement = 'DefaultAddressID'

AutoGenerated: BoolElement = 'AutoGenerated'

HostUser: StringElement = 'HostUser'

HostPwd: StringElement = 'HostPwd'

UserInfo: StringElement = 'UserInfo'

ProfileUpdated: BoolElement = 'ProfileUpdated'

MobileAuthCode: StringElement = 'MobileAuthCode'

UseCustomerAccounts: BoolElement = 'UseCustomerAccounts'

PrimaryCIF: StringElement = 'PrimaryCIF'

LastUserProfileUpdate: StringElement = 'LastUserProfileUpdate'

UserRoleID: IntElement = 'UserRoleID'

PolicyID: IntElement = 'PolicyID'

UserStatusID: IntElement = 'UserStatusID'

StatusChangeDate: StringElement = 'StatusChangeDate'

DOB: StringElement = 'DOB'

IsOpenBanking: BoolElement = 'IsOpenBanking'

class q2_sdk.hq.db.user.User(logger, hq_credentials=None, ret_table_obj=None)

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)

Hook for subclassed DbObjects to add custom arguments.

async get_deleted(deleted_after, serialize_for_cli=False, extended=False)

async get(user_id=None, login_name=None, social_security=None, primary_cif=None, extended=False, combine=False, serialize_for_cli=False)

Return type:

List[UserRow]

async get_many(user_ids)

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)

async get_account_related_users(host_account_id, serialize_for_cli=False)

async set_profile_updated_flag(user_id)

get_cli_response(extended, response)

async update_dob(user_id, dob)

async update(user_id, ssn=None, primary_cif=None, unset_primary_cif=False)

async delete(user_id, serialize_for_cli=None)

async search_by_create_date(created_on, serialize_for_cli=False, extended=False)

Return type:

List[UserRow]

async search(first_name='', last_name='', email_address='', phone_number='', sso_identifier='', serialize_for_cli=False, extended=False)

Return type:

SearchUserResponse

async search_by_sso_identifier(sso_identifier)

async get_admin_users_by_customer_id(customer_id, serialize_for_cli=False)