Skip to content

UserPersonalAssistantGetCriteriaRequest

Bases: OCIRequest

Gets a User Personal Assistant Schedule Selective Criteria Entry. The response is either UserPersonalAssistantGetCriteriaResponse or ErrorResponse.

Attributes:

user_id (str):

criteria_name (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalAssistantGetCriteriaRequest(OCIRequest):
    """Gets a User Personal Assistant Schedule Selective Criteria Entry.
        The response is either UserPersonalAssistantGetCriteriaResponse or ErrorResponse.

    Attributes:

        user_id (str):

        criteria_name (str):

    """

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

    criteria_name: str = field(metadata={"alias": "criteriaName"})

Responses

Bases: OCIDataResponse

Response to the UserPersonalAssistantGetCriteriaRequest.

Attributes:

time_schedule (Optional[TimeSchedule]):

holiday_schedule (Optional[HolidaySchedule]):

presence (str):

enable_transfer_to_attendant (bool):

attendant_number (Optional[str]):

enable_ring_splash (bool):

alert_me_first (bool):

alert_me_first_number_of_rings (int):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalAssistantGetCriteriaResponse(OCIDataResponse):
    """Response to the UserPersonalAssistantGetCriteriaRequest.

    Attributes:

        time_schedule (Optional[TimeSchedule]):

        holiday_schedule (Optional[HolidaySchedule]):

        presence (str):

        enable_transfer_to_attendant (bool):

        attendant_number (Optional[str]):

        enable_ring_splash (bool):

        alert_me_first (bool):

        alert_me_first_number_of_rings (int):

    """

    time_schedule: Optional[TimeSchedule] = field(
        default=None, metadata={"alias": "timeSchedule"}
    )

    holiday_schedule: Optional[HolidaySchedule] = field(
        default=None, metadata={"alias": "holidaySchedule"}
    )

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

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

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

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 UserPersonalAssistantGetCriteriaRequest

client = Client()

command = UserPersonalAssistantGetCriteriaRequest(
    user_id=...,
    criteria_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserPersonalAssistantGetCriteriaRequest",
    user_id=...,
    criteria_name=...,
)

print(response)