UserHotelingGuestModifyRequest21

Bases: OCIRequest

Modify the user level data associated with Hoteling Guest. Provisioning error will be given when setting hostUserId to not nil value while Hoteling Guest feature is not active. 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]):

host_user_id (Optional[Nillable[str]]):

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

@dataclass(kw_only=True)
class UserHotelingGuestModifyRequest21(OCIRequest):
    """Modify the user level data associated with Hoteling Guest.
        Provisioning error will be given when setting hostUserId to not nil value while Hoteling Guest feature is not active.
        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]):

        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"}
    )

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

    def __post_init__(self):
        nillable_fields = ["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 UserHotelingGuestModifyRequest21

client = Client()

command = UserHotelingGuestModifyRequest21(
    user_id=...,
    is_active=...,
    enable_association_limit=...,
    association_limit_hours=...,
    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("UserHotelingGuestModifyRequest21",
    user_id=...,
    is_active=...,
    enable_association_limit=...,
    association_limit_hours=...,
    host_user_id=...,
)

print(response)