UserFlexibleSeatingGuestModifyRequest22

Bases: OCIRequest

Modify the user level data associated with flexible seating guest. accessDeviceEndpoint can only be configured by group or a higher level administrator. The request fails if isActive is set to false and the guest is associated to a host. The request fails when enableAssociationLimit, associationLimitHours, unlockPhonePINCode are changed when the guest is associated to a host. The request fails when accessDeviceEndpoint is set in the request when the guest is associated to a host. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

is_active (Optional[bool]):

enable_association_limit (Optional[bool]):

association_limit_hours (Optional[int]):

unlock_phone_pin_code (Optional[Nillable[str]]):

access_device_endpoint (Optional[Nillable[AccessDeviceMultipleContactEndpointModify22]]):

host_user_id (Optional[Nillable[str]]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class UserFlexibleSeatingGuestModifyRequest22(OCIRequest):
    """Modify the user level data associated with flexible seating guest.
                accessDeviceEndpoint can only be configured by group or a higher level administrator.
                The request fails if isActive is set to false and the guest is associated to a host.
                The request fails when enableAssociationLimit, associationLimitHours, unlockPhonePINCode are changed when the guest is associated to a host.
                The request fails when accessDeviceEndpoint is set in the request when the guest is associated to a host.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        is_active (Optional[bool]):

        enable_association_limit (Optional[bool]):

        association_limit_hours (Optional[int]):

        unlock_phone_pin_code (Optional[Nillable[str]]):

        access_device_endpoint (Optional[Nillable[AccessDeviceMultipleContactEndpointModify22]]):

        host_user_id (Optional[Nillable[str]]):

    """

    user_id: str = field(metadata={"alias": "userId"})

    is_active: Optional[bool] = field(default=None, metadata={"alias": "isActive"})

    enable_association_limit: Optional[bool] = field(
        default=None, metadata={"alias": "enableAssociationLimit"}
    )

    association_limit_hours: Optional[int] = field(
        default=None, metadata={"alias": "associationLimitHours"}
    )

    unlock_phone_pin_code: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "unlockPhonePINCode"}
    )

    access_device_endpoint: Optional[
        Nillable[AccessDeviceMultipleContactEndpointModify22]
    ] = field(default=None, metadata={"alias": "accessDeviceEndpoint"})

    host_user_id: Optional[Nillable[str]] = field(
        default=None, metadata={"alias": "hostUserId"}
    )

    def __post_init__(self):
        nillable_fields = [
            "unlock_phone_pin_code",
            "access_device_endpoint",
            "host_user_id",
        ]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserFlexibleSeatingGuestModifyRequest22

client = Client()

command = UserFlexibleSeatingGuestModifyRequest22(
    user_id=...,
    is_active=...,
    enable_association_limit=...,
    association_limit_hours=...,
    unlock_phone_pin_code=...,
    access_device_endpoint=...,
    host_user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserFlexibleSeatingGuestModifyRequest22",
    user_id=...,
    is_active=...,
    enable_association_limit=...,
    association_limit_hours=...,
    unlock_phone_pin_code=...,
    access_device_endpoint=...,
    host_user_id=...,
)

print(response)