UpdateGroup models

DataSet models for UpdateGroup.

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

q2_form_to_group_edit = UpdateGroup.Q2FormToGroupEdit(
    form_id=1,
    display_name="...",
    group_id=1,
    group_desc="...",
    display_in_list=True,
)

q2_sec_alert_profile = UpdateGroup.Q2SecAlertProfile(
    description="...",
    enable_email_by_default=True,
)

q2_dashboard_profile = UpdateGroup.Q2DashboardProfile(
    description="...",
)

q2_group = UpdateGroup.Q2Group(
    group_desc="...",
    sec_alert_profile_id=1,
    is_commercial=True,
    is_treasury=True,
)

q2_message_recipient_group_to_group_edit = UpdateGroup.Q2MessageRecipientGroupToGroupEdit(
    secure_message_group_id=1,
    secure_message_group_name="...",
    group_id=1,
    group_desc="...",
)

q2_group_default_landing_page = UpdateGroup.Q2GroupDefaultLandingPage(
    group_id=1,
    navigation_node_id=1,
    property_id=1,
    description="...",
)

q2_ui_selection_to_group_edit = UpdateGroup.Q2UiSelectionToGroupEdit(
    ui_selection_id=1,
    short_name="...",
    description="...",
    group_id=1,
    language="...",
)

q2_edv_profile = UpdateGroup.Q2EdvProfile(
    description="...",
    token_lifetime_in_minutes=1,
)

q2_ach_class_code_to_group_edit = UpdateGroup.Q2AchClassCodeToGroupEdit(
    ach_class_code_id=1,
    ach_class_code="...",
    end_user_description="...",
    group_id=1,
)

q2_ach_class_code_group_enabled_edit = UpdateGroup.Q2AchClassCodeGroupEnabledEdit(
    ach_class_code_id=1,
    ach_class_code="...",
    group_id=1,
)

transaction_rights = UpdateGroup.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 = UpdateGroup.UserRights(
    rights_short_name="...",
    rights_long_name="...",
    has_rights=True,
)

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

q2_customer_account_view = UpdateGroup.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.UpdateGroup_models.Q2FormToGroupEdit(form_id=0, display_name='', group_id=0, group_desc='', is_available_to_group=None, display_in_list=False, original_record=None)[source]

Bases: object

Represents a row in the Q2_FormToGroupEdit table.

form_id: int = 0

display_name: str = ''

group_id: int = 0

group_desc: str = ''

is_available_to_group: bool | None = None

display_in_list: bool = False

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_models.Q2SecAlertProfile(sec_alert_profile_id=-1, description='', enable_email_by_default=False, original_record=None)[source]

Bases: object

Represents a row in the Q2_SecAlertProfile table.

sec_alert_profile_id: int = -1

description: str = ''

enable_email_by_default: bool = False

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_models.Q2DashboardProfile(dashboard_profile_id=-1, description='', original_record=None)[source]

Bases: object

Represents a row in the Q2_DashboardProfile table.

dashboard_profile_id: int = -1

description: str = ''

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_models.Q2Group(group_id=-1, group_desc='', deleted_date=None, default_ui_selection_id=None, dashboard_profile_id=None, sec_alert_profile_id=0, is_commercial=False, is_treasury=False, policy_id=None, edv_profile_id=None, currency_exchange_plan_id=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_Group table.

group_id: int = -1

group_desc: str = ''

deleted_date: str | None = None

default_ui_selection_id: int | None = None

dashboard_profile_id: int | None = None

sec_alert_profile_id: int = 0

is_commercial: bool = False

is_treasury: bool = False

policy_id: int | None = None

edv_profile_id: int | None = None

currency_exchange_plan_id: int | None = None

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_models.Q2MessageRecipientGroupToGroupEdit(is_available_to_group=None, secure_message_group_id=0, secure_message_group_name='', secure_message_group_description=None, group_id=0, group_desc='', original_record=None)[source]

Bases: object

Represents a row in the Q2_MessageRecipientGroupToGroupEdit table.

is_available_to_group: bool | None = None

secure_message_group_id: int = 0

secure_message_group_name: str = ''

secure_message_group_description: str | None = None

group_id: int = 0

group_desc: str = ''

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_models.Q2GroupDefaultLandingPage(is_default=None, group_id=0, navigation_node_id=0, route=None, short_name=None, property_id=0, text_value=None, description='', original_record=None)[source]

Bases: object

Represents a row in the Q2_GroupDefaultLandingPage table.

is_default: bool | None = None

group_id: int = 0

navigation_node_id: int = 0

route: str | None = None

short_name: str | None = None

property_id: int = 0

text_value: str | None = None

description: str = ''

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_models.Q2UiSelectionToGroupEdit(ui_selection_id=0, short_name='', description='', group_id=0, is_available_to_group=None, language='', original_record=None)[source]

Bases: object

Represents a row in the Q2_UiSelectionToGroupEdit table.

ui_selection_id: int = 0

short_name: str = ''

description: str = ''

group_id: int = 0

is_available_to_group: bool | None = None

language: str = ''

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_models.Q2EdvProfile(edv_profile_id=-1, description='', token_lifetime_in_minutes=0, original_record=None)[source]

Bases: object

Represents a row in the Q2_EdvProfile table.

edv_profile_id: int = -1

description: str = ''

token_lifetime_in_minutes: int = 0

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_models.Q2AchClassCodeToGroupEdit(ach_class_code_id=0, ach_class_code='', end_user_description='', group_id=0, is_available_to_group=None, ach_pass_thru_requires_entitled_account=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_AchClassCodeToGroupEdit table.

ach_class_code_id: int = 0

ach_class_code: str = ''

end_user_description: str = ''

group_id: int = 0

is_available_to_group: bool | None = None

ach_pass_thru_requires_entitled_account: bool | None = None

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_models.Q2AchClassCodeGroupEnabledEdit(ach_class_code_id=0, ach_class_code='', group_id=0, is_enabled_for_group=None, original_record=None)[source]

Bases: object

Represents a row in the Q2_AchClassCodeGroupEnabledEdit table.

ach_class_code_id: int = 0

ach_class_code: str = ''

group_id: int = 0

is_enabled_for_group: bool | None = None

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

class q2_sdk.hq.hq_api.backoffice.UpdateGroup_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.UpdateGroup_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.UpdateGroup_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.UpdateGroup_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.UpdateGroup_models.build_group_edit_dataset(q2_form_to_group_edit=None, q2_sec_alert_profile=None, q2_dashboard_profile=None, q2_group=None, q2_message_recipient_group_to_group_edit=None, q2_group_default_landing_page=None, q2_ui_selection_to_group_edit=None, q2_edv_profile=None, q2_ach_class_code_to_group_edit=None, q2_ach_class_code_group_enabled_edit=None)[source]

Build the group_edit DataSet parameter for UpdateGroup.

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

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

Build the group_rights DataSet parameter for UpdateGroup.

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