Skip to content

UserPersonalAssistantModifyRequest

Bases: OCIRequest

Modify the User Personal Assistant information. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

presence (Optional[str]):

enable_transfer_to_attendant (Optional[bool]):

attendant_number (Optional[Nillable[str]]):

enable_ring_splash (Optional[bool]):

enable_expiration_time (Optional[bool]):

expiration_time (Optional[Nillable[str]]):

alert_me_first (Optional[bool]):

alert_me_first_number_of_rings (Optional[int]):

criteria_activation (Optional[List[CriteriaActivation]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalAssistantModifyRequest(OCIRequest):
    """Modify the User Personal Assistant information.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        presence (Optional[str]):

        enable_transfer_to_attendant (Optional[bool]):

        attendant_number (Optional[Nillable[str]]):

        enable_ring_splash (Optional[bool]):

        enable_expiration_time (Optional[bool]):

        expiration_time (Optional[Nillable[str]]):

        alert_me_first (Optional[bool]):

        alert_me_first_number_of_rings (Optional[int]):

        criteria_activation (Optional[List[CriteriaActivation]]):

    """

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

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

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

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

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

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

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

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

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

    criteria_activation: Optional[List[CriteriaActivation]] = field(
        default=None, metadata={"alias": "criteriaActivation"}
    )

    def __post_init__(self):
        nillable_fields = ["attendant_number", "expiration_time"]
        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 UserPersonalAssistantModifyRequest

client = Client()

command = UserPersonalAssistantModifyRequest(
    user_id=...,
    presence=...,
    enable_transfer_to_attendant=...,
    attendant_number=...,
    enable_ring_splash=...,
    enable_expiration_time=...,
    expiration_time=...,
    alert_me_first=...,
    alert_me_first_number_of_rings=...,
    criteria_activation=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPersonalAssistantModifyRequest",
    user_id=...,
    presence=...,
    enable_transfer_to_attendant=...,
    attendant_number=...,
    enable_ring_splash=...,
    enable_expiration_time=...,
    expiration_time=...,
    alert_me_first=...,
    alert_me_first_number_of_rings=...,
    criteria_activation=...,
)

print(response)