SetMessageGroupMembers models

DataSet models for SetMessageGroupMembers.

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

q2_message_group_member_edit = SetMessageGroupMembers.Q2MessageGroupMemberEdit(
    group_id=1,
    group_name="...",
    admin_user_id=1,
    admin_name="...",
    visible_to_end_user=True,
    allow_replies=True,
)

class q2_sdk.hq.hq_api.backoffice.SetMessageGroupMembers_models.Q2MessageGroupMemberEdit(group_id=0, group_name='', admin_user_id=0, admin_name='', is_enrolled=None, notification_email_address=None, visible_to_end_user=False, allow_replies=False, group_description=None, original_record=None)

Bases: object

Represents a row in the Q2_MessageGroupMemberEdit table.

group_id: int = 0

group_name: str = ''

admin_user_id: int = 0

admin_name: str = ''

is_enrolled: bool | None = None

notification_email_address: str | None = None

visible_to_end_user: bool = False

allow_replies: bool = False

group_description: str | None = None

original_record: Q2MessageGroupMemberEdit | None = None

static get_columns()

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

Return type:

list[list[str]]

to_row_values()

Returns column values in get_columns() order.

Return type:

list[Any]

classmethod from_hq_response(row_elem)

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

Return type:

Q2MessageGroupMemberEdit

q2_sdk.hq.hq_api.backoffice.SetMessageGroupMembers_models.build_message_group_member_edit_dataset(q2_message_group_member_edit=None)

Build the message_group_member_edit DataSet parameter for SetMessageGroupMembers.

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