UpdateUserProfile models

DataSet models for UpdateUserProfile.

These typed dataclass models represent the tables and columns within the DataSet parameters for the UpdateUserProfile HQ operation.

IMPORTANT: Update operations require a GET first to populate the original_record field. HQ uses the unchanged row for optimistic concurrency checking.

Usage:

from q2_sdk.hq.hq_api.backoffice import UpdateUserProfile

q2_phone_number = UpdateUserProfile.Q2PhoneNumber(
    country_id=1,
    city_or_area_code="...",
    local_number="...",
    phone_type=1,
)

q2_email = UpdateUserProfile.Q2Email(
    email_address="...",
    user_id=1,
)

q2_user_logon = UpdateUserProfile.Q2UserLogon(
    user_id=1,
    login_name="...",
    user_password="...",
    ui_source_id=1,
    status=1,
    create_date="...",
    auto_generated=True,
    password_change_required=True,
    password_has_never_changed=True,
)

q2_user_account = UpdateUserProfile.Q2UserAccount(
    user_id=1,
    customer_account_id=1,
    access=1,
)

q2_access_code_target = UpdateUserProfile.Q2AccessCodeTarget(
    user_id=1,
    notification_type_id=1,
    target_address="...",
    access_code_target_type_id=1,
)

q2_auth_token = UpdateUserProfile.Q2AuthToken(
    user_id=1,
    create_date="...",
    serial="...",
)

q2_user = UpdateUserProfile.Q2User(
    customer_id=1,
    create_date="...",
    auto_generated=True,
    use_customer_accounts=True,
    user_status_id=1,
)

q2_address = UpdateUserProfile.Q2Address(
    street_address1="...",
    city="...",
    address_type=1,
    country_id=1,
    is_international=True,
)

transaction_rights = UpdateUserProfile.TransactionRights(
    transaction_type_id=1,
    transaction_type="...",
    description="...",
    enabled=True,
    authorize=True,
    cancel=True,
    create=True,
    create_restricted=True,
    update=True,
    view=1,
    limit_per_transaction=1.0,
    limit_per_day=1.0,
    limit_per_month=1.0,
    limit_per_acct_per_day=1.0,
    count_per_acct_per_day=1,
    count_per_day=1,
    count_per_month=1,
    dual_approval_limit=1.0,
    token_required_limit=1.0,
    bit_flags=1,
)

user_rights = UpdateUserProfile.UserRights(
    rights_short_name="...",
    rights_long_name="...",
    has_rights=True,
)

user_monetary_rights = UpdateUserProfile.UserMonetaryRights(
    rights_short_name="...",
    rights_long_name="...",
    amount=1.0,
)

q2_customer_account_view = UpdateUserProfile.Q2CustomerAccountView(
    customer_account_id=1,
    customer_id=1,
    host_account_id=1,
    account_number_internal="...",
    product_name="...",
    is_external_account=True,
    product_id=1,
    product_type_id=1,
    user_access=1,
    current_access_flag=1,
)

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.Q2PhoneNumber(phone_id=-1, country_id=0, city_or_area_code='', local_number='', extension=None, phone_type=0, user_id=None, customer_id=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_PhoneNumber table.

phone_id: int = -1

country_id: int = 0

city_or_area_code: str = ''

local_number: str = ''

extension: str | None = None

phone_type: int = 0

user_id: int | None = None

customer_id: int | None = None

original_record: Q2PhoneNumber | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2PhoneNumber

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.Q2Email(email_id=-1, email_address='', user_id=0, original_record=None)[source]

Bases: object

Represents a row in the Q2_Email table.

email_id: int = -1

email_address: str = ''

user_id: int = 0

original_record: Q2Email | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2Email

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.Q2UserLogon(user_logon_id=-1, user_id=0, login_name='', user_password='', ui_source_id=0, last_change=None, last_logon=None, status=0, status_reason=None, last_failed=None, create_date='', num_invalid_attempts=None, auto_generated=False, deleted_date=None, sync_pwd_user_logon_id=None, csr_assist_policy_id=None, csr_assist_admin_user_id=None, mla_challenge_code=None, password_change_required=False, password_has_never_changed=False, original_record=None)[source]

Bases: object

Represents a row in the Q2_UserLogon table.

user_logon_id: int = -1

user_id: int = 0

login_name: str = ''

user_password: str = ''

ui_source_id: int = 0

last_change: str | None = None

last_logon: str | None = None

status: int = 0

status_reason: str | None = None

last_failed: str | None = None

create_date: str = ''

num_invalid_attempts: int | None = None

auto_generated: bool = False

deleted_date: str | None = None

sync_pwd_user_logon_id: int | None = None

csr_assist_policy_id: int | None = None

csr_assist_admin_user_id: int | None = None

mla_challenge_code: str | None = None

password_change_required: bool = False

password_has_never_changed: bool = False

original_record: Q2UserLogon | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2UserLogon

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.Q2UserAccount(user_account_id=-1, user_id=0, customer_account_id=0, access=0, host_account_id=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_UserAccount table.

user_account_id: int = -1

user_id: int = 0

customer_account_id: int = 0

access: int = 0

host_account_id: int | None = None

original_record: Q2UserAccount | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2UserAccount

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.Q2AccessCodeTarget(target_id=-1, user_id=0, notification_type_id=0, target_address='', access_code_target_type_id=0, country_id=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_AccessCodeTarget table.

target_id: int = -1

user_id: int = 0

notification_type_id: int = 0

target_address: str = ''

access_code_target_type_id: int = 0

country_id: int | None = None

original_record: Q2AccessCodeTarget | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2AccessCodeTarget

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.Q2AuthToken(auth_token_id=-1, user_id=0, create_date='', deleted_date=None, serial='', first_use=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_AuthToken table.

auth_token_id: int = -1

user_id: int = 0

create_date: str = ''

deleted_date: str | None = None

serial: str = ''

first_use: str | None = None

original_record: Q2AuthToken | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2AuthToken

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.Q2User(user_id=-1, customer_id=0, first_name=None, middle_name=None, last_name=None, salutation=None, suffix=None, ssn=None, create_date='', deleted_date=None, default_email_id=None, default_address_id=None, auto_generated=False, host_user=None, host_pwd=None, user_info=None, profile_updated=None, mobile_auth_code=None, use_customer_accounts=False, primary_cif=None, last_user_profile_update=None, user_role_id=None, policy_id=None, user_status_id=0, status_change_date=None, dob=None, is_primary_contact=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_User table.

user_id: int = -1

customer_id: int = 0

first_name: str | None = None

middle_name: str | None = None

last_name: str | None = None

salutation: str | None = None

suffix: str | None = None

ssn: str | None = None

create_date: str = ''

deleted_date: str | None = None

default_email_id: int | None = None

default_address_id: int | None = None

auto_generated: bool = False

host_user: str | None = None

host_pwd: str | None = None

user_info: str | None = None

profile_updated: bool | None = None

mobile_auth_code: str | None = None

use_customer_accounts: bool = False

primary_cif: str | None = None

last_user_profile_update: str | None = None

user_role_id: int | None = None

policy_id: int | None = None

user_status_id: int = 0

status_change_date: str | None = None

dob: str | None = None

is_primary_contact: bool | None = None

original_record: Q2User | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2User

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.Q2Address(address_id=-1, street_address1='', street_address2=None, city='', state=None, postal_code=None, customer_id=None, address_type=0, user_id=None, country_id=0, is_international=False, province=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_Address table.

address_id: int = -1

street_address1: str = ''

street_address2: str | None = None

city: str = ''

state: str | None = None

postal_code: str | None = None

customer_id: int | None = None

address_type: int = 0

user_id: int | None = None

country_id: int = 0

is_international: bool = False

province: str | None = None

original_record: Q2Address | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2Address

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.TransactionRights(transaction_type_id=0, transaction_type='', description='', enabled=False, authorize=False, cancel=False, create=False, create_restricted=False, update=False, view=0, limit_per_transaction=0.0, limit_per_day=0.0, limit_per_month=0.0, limit_per_acct_per_day=0.0, count_per_acct_per_day=0, count_per_day=0, count_per_month=0, dual_approval_limit=0.0, token_required_limit=0.0, bit_flags=0, original_record=None)[source]

Bases: object

Represents a row in the TransactionRights table.

transaction_type_id: int = 0

transaction_type: str = ''

description: str = ''

enabled: bool = False

authorize: bool = False

cancel: bool = False

create: bool = False

create_restricted: bool = False

update: bool = False

view: int = 0

limit_per_transaction: float = 0.0

limit_per_day: float = 0.0

limit_per_month: float = 0.0

limit_per_acct_per_day: float = 0.0

count_per_acct_per_day: int = 0

count_per_day: int = 0

count_per_month: int = 0

dual_approval_limit: float = 0.0

token_required_limit: float = 0.0

bit_flags: int = 0

original_record: TransactionRights | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: TransactionRights

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.UserRights(rights_short_name='', rights_long_name='', has_rights=False, original_record=None)[source]

Bases: object

Represents a row in the UserRights table.

rights_short_name: str = ''

rights_long_name: str = ''

has_rights: bool = False

original_record: UserRights | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: UserRights

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.UserMonetaryRights(rights_short_name='', rights_long_name='', amount=0.0, original_record=None)[source]

Bases: object

Represents a row in the UserMonetaryRights table.

rights_short_name: str = ''

rights_long_name: str = ''

amount: float = 0.0

original_record: UserMonetaryRights | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: UserMonetaryRights

class q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.Q2CustomerAccountView(customer_account_id=0, customer_id=0, is_cif_rel=None, host_account_id=0, account_number_internal='', product_name='', is_user_enabled=None, is_external_account=False, product_id=0, product_type_id=0, user_access=0, current_access_flag=0, valid_customer_access_flag=None, valid_system_access_flag=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_CustomerAccountView table.

customer_account_id: int = 0

customer_id: int = 0

is_cif_rel: bool | None = None

host_account_id: int = 0

account_number_internal: str = ''

product_name: str = ''

is_user_enabled: bool | None = None

is_external_account: bool = False

product_id: int = 0

product_type_id: int = 0

user_access: int = 0

current_access_flag: int = 0

valid_customer_access_flag: int | None = None

valid_system_access_flag: int | None = None

original_record: Q2CustomerAccountView | None = None

static get_columns()[source]

Returns [[HqColumnName, pythonAttrName], …] mapping.

Return type:: list[list[str]]

to_row_values()[source]

Returns column values in get_columns() order.

Return type:: list[Any]

classmethod from_hq_response(row_elem)[source]

Parse an lxml row element into this model with original_record set.

Return type:: Q2CustomerAccountView

q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.build_dup_dataset(q2_phone_number=None, q2_email=None, q2_user_logon=None, q2_user_account=None, q2_access_code_target=None, q2_auth_token=None, q2_user=None, q2_address=None)[source]

Build the dup DataSet parameter for UpdateUserProfile.

For update operations, each model instance should have its original_record set to the pre-modification state (from a prior GET call).

For add operations, set auto-increment ID fields to negative values.

Return type:: DataSetBuilder
Returns:: DataSetBuilder ready to pass as the ‘dup’ parameter

q2_sdk.hq.hq_api.backoffice.UpdateUserProfile_models.build_user_rights_dataset(transaction_rights=None, user_rights=None, user_monetary_rights=None, q2_customer_account_view=None)[source]

Build the user_rights DataSet parameter for UpdateUserProfile.

For update operations, each model instance should have its original_record set to the pre-modification state (from a prior GET call).

For add operations, set auto-increment ID fields to negative values.

Return type:: DataSetBuilder
Returns:: DataSetBuilder ready to pass as the ‘user_rights’ parameter