UpdateAdminUser models

DataSet models for UpdateAdminUser.

These typed dataclass models represent the tables and columns within the DataSet parameters for the UpdateAdminUser 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 UpdateAdminUser

q2_user = UpdateAdminUser.Q2User(
    create_date="...",
)

q2_address = UpdateAdminUser.Q2Address(
    street_address1="...",
    city="...",
    state="...",
    postal_code="...",
    address_type=1,
)

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

q2_phone = UpdateAdminUser.Q2Phone(
    country_id=1,
    city_or_area_code="...",
    local_number="...",
    phone_type="...",
)

q2_user_logon = UpdateAdminUser.Q2UserLogon(
    user_id=1,
    login_name="...",
    user_password="...",
    ui_source_id=1,
    create_date="...",
    group_id=1,
    authentication_type_id=1,
)

q2_user_fi = UpdateAdminUser.Q2UserFI(
    fiid=1,
    user_id=1,
)

q2_admin_auth_token = UpdateAdminUser.Q2AdminAuthToken(
    user_id=1,
    create_date="...",
    serial="...",
)

q2_admin_user_property_view = UpdateAdminUser.Q2AdminUserPropertyView(
    user_property_data_id=1,
    property_name="...",
    property_long_name="...",
    property_data_type="...",
    is_group_property=True,
    is_user_property=True,
)

class q2_sdk.hq.hq_api.backoffice.UpdateAdminUser_models.Q2User(user_id=-1, first_name=None, middle_name=None, last_name=None, salutation=None, suffix=None, ssn=None, create_date='', deleted_date=None, default_email_id=None, employee_id=None, default_address_id=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_User table.

user_id: int = -1

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

employee_id: str | None = None

default_address_id: int | 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.UpdateAdminUser_models.Q2Address(address_id=-1, street_address1='', street_address2=None, city='', state='', postal_code='', address_type=0, user_id=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 = ''

postal_code: str = ''

address_type: int = 0

user_id: int | 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.UpdateAdminUser_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.UpdateAdminUser_models.Q2Phone(phone_id=-1, country_id=0, city_or_area_code='', local_number='', extension=None, phone_type='', user_id=None, address_id=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_Phone table.

phone_id: int = -1

country_id: int = 0

city_or_area_code: str = ''

local_number: str = ''

extension: str | None = None

phone_type: str = ''

user_id: int | None = None

address_id: int | None = None

original_record: Q2Phone | 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:: Q2Phone

class q2_sdk.hq.hq_api.backoffice.UpdateAdminUser_models.Q2UserLogon(user_logon_id=-1, user_id=0, login_name='', user_password='', ui_source_id=0, last_change=None, last_logon=None, status=None, status_reason=None, last_failed=None, host_user=None, host_pwd=None, create_date='', num_invalid_attempts=None, group_id=0, deleted_date=None, authentication_type_id=0, 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 | None = None

status_reason: str | None = None

last_failed: str | None = None

host_user: str | None = None

host_pwd: str | None = None

create_date: str = ''

num_invalid_attempts: int | None = None

group_id: int = 0

deleted_date: str | None = None

authentication_type_id: int = 0

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.UpdateAdminUser_models.Q2UserFI(user_fiid=-1, fiid=0, user_id=0, original_record=None)[source]

Bases: object

Represents a row in the Q2_UserFI table.

user_fiid: int = -1

fiid: int = 0

user_id: int = 0

original_record: Q2UserFI | 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:: Q2UserFI

class q2_sdk.hq.hq_api.backoffice.UpdateAdminUser_models.Q2AdminAuthToken(admin_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_AdminAuthToken table.

admin_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: Q2AdminAuthToken | 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:: Q2AdminAuthToken

class q2_sdk.hq.hq_api.backoffice.UpdateAdminUser_models.Q2AdminUserPropertyView(user_property_data_id=0, group_id=None, fiid=None, ui_source_id=None, user_id=None, property_id=None, property_name='', property_long_name='', property_data_type='', property_value=None, weight=None, is_group_property=False, is_user_property=False, original_record=None)[source]

Bases: object

Represents a row in the Q2_AdminUserPropertyView table.

user_property_data_id: int = 0

group_id: int | None = None

fiid: int | None = None

ui_source_id: int | None = None

user_id: int | None = None

property_id: int | None = None

property_name: str = ''

property_long_name: str = ''

property_data_type: str = ''

property_value: str | None = None

weight: int | None = None

is_group_property: bool = False

is_user_property: bool = False

original_record: Q2AdminUserPropertyView | 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:: Q2AdminUserPropertyView

q2_sdk.hq.hq_api.backoffice.UpdateAdminUser_models.build_daue_dataset(q2_user=None, q2_address=None, q2_email=None, q2_phone=None, q2_user_logon=None, q2_user_fi=None, q2_admin_auth_token=None)[source]

Build the daue DataSet parameter for UpdateAdminUser.

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 ‘daue’ parameter

q2_sdk.hq.hq_api.backoffice.UpdateAdminUser_models.build_admin_user_properties_dataset(q2_admin_user_property_view=None)[source]

Build the admin_user_properties DataSet parameter for UpdateAdminUser.

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 ‘admin_user_properties’ parameter