Skip to content

UserPersonalAssistantGetRequest24

Bases: OCIRequest

Request to get the User Personal Assistant information. The response is either a UserPersonalAssistantGetResponse24 or an ErrorResponse.

Attributes:

user_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalAssistantGetRequest24(OCIRequest):
    """Request to get the User Personal Assistant information.
        The response is either a UserPersonalAssistantGetResponse24 or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserPersonalAssistantGetRequest24. The response contains the user Personal Assistant information and a table of Schedule Selective Criteria entries. The schedule table's column headings are: "Is Active", "Criteria Name", "Time Schedule", "Holiday Schedule", "Presence", "Transfer to Attendant", "Attendant Number", "Play Ring Splash", "Alert Me First", "Number of Rings".

Attributes:

presence (str):

enable_transfer_to_attendant (bool):

attendant_number (Optional[str]):

enable_ring_splash (bool):

enable_expiration_time (bool):

expiration_time (Optional[str]):

alert_me_first (bool):

alert_me_first_number_of_rings (int):

schedule_table (Optional[OCITable]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalAssistantGetResponse24(OCIDataResponse):
    """Response to the UserPersonalAssistantGetRequest24.
        The response contains the user Personal Assistant information and a table of Schedule Selective Criteria entries.
        The schedule table's column headings are: \"Is Active\", \"Criteria Name\", \"Time Schedule\", \"Holiday Schedule\",
        \"Presence\", \"Transfer to Attendant\", \"Attendant Number\", \"Play Ring Splash\", \"Alert Me First\", \"Number of Rings\".

    Attributes:

        presence (str):

        enable_transfer_to_attendant (bool):

        attendant_number (Optional[str]):

        enable_ring_splash (bool):

        enable_expiration_time (bool):

        expiration_time (Optional[str]):

        alert_me_first (bool):

        alert_me_first_number_of_rings (int):

        schedule_table (Optional[OCITable]):

    """

    presence: str = field(metadata={"alias": "presence"})

    enable_transfer_to_attendant: bool = field(
        metadata={"alias": "enableTransferToAttendant"}
    )

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

    enable_ring_splash: bool = field(metadata={"alias": "enableRingSplash"})

    enable_expiration_time: bool = field(metadata={"alias": "enableExpirationTime"})

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

    alert_me_first: bool = field(metadata={"alias": "alertMeFirst"})

    alert_me_first_number_of_rings: int = field(
        metadata={"alias": "alertMeFirstNumberOfRings"}
    )

    schedule_table: Optional[OCITable] = field(
        default=None, metadata={"alias": "scheduleTable"}
    )

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserPersonalAssistantGetRequest24

client = Client()

command = UserPersonalAssistantGetRequest24(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserPersonalAssistantGetRequest24",
    user_id=...,
)

print(response)