Skip to content

UserPersonalAssistantAddCriteriaRequest

Bases: OCIRequest

Adds a User Personal Assistant Schedule Selective Criteria Entry. The response is either a SuccessResponse or an ErrorResponse.

The following elements will take the defined default value if they are not set:
  enableTransferToAttendant will be set to false.
  enableRingSplash will be set to false.
  alertMeFirst will be set to false.
  alertMeFirstNumberOfRings will be set to the user Personal Assistant Number of rings setting.

Attributes:

user_id (str):

criteria_name (str):

time_schedule (Optional[TimeSchedule]):

holiday_schedule (Optional[HolidaySchedule]):

presence (Optional[str]):

enable_transfer_to_attendant (Optional[bool]):

attendant_number (Optional[str]):

enable_ring_splash (Optional[bool]):

alert_me_first (Optional[bool]):

alert_me_first_number_of_rings (Optional[int]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPersonalAssistantAddCriteriaRequest(OCIRequest):
    """Adds a User Personal Assistant Schedule Selective Criteria Entry.
        The response is either a SuccessResponse or an ErrorResponse.

        The following elements will take the defined default value if they are not set:
          enableTransferToAttendant will be set to false.
          enableRingSplash will be set to false.
          alertMeFirst will be set to false.
          alertMeFirstNumberOfRings will be set to the user Personal Assistant Number of rings setting.

    Attributes:

        user_id (str):

        criteria_name (str):

        time_schedule (Optional[TimeSchedule]):

        holiday_schedule (Optional[HolidaySchedule]):

        presence (Optional[str]):

        enable_transfer_to_attendant (Optional[bool]):

        attendant_number (Optional[str]):

        enable_ring_splash (Optional[bool]):

        alert_me_first (Optional[bool]):

        alert_me_first_number_of_rings (Optional[int]):

    """

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

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

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

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

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

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

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

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

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

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 UserPersonalAssistantAddCriteriaRequest

client = Client()

command = UserPersonalAssistantAddCriteriaRequest(
    user_id=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    presence=...,
    enable_transfer_to_attendant=...,
    attendant_number=...,
    enable_ring_splash=...,
    alert_me_first=...,
    alert_me_first_number_of_rings=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPersonalAssistantAddCriteriaRequest",
    user_id=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    presence=...,
    enable_transfer_to_attendant=...,
    attendant_number=...,
    enable_ring_splash=...,
    alert_me_first=...,
    alert_me_first_number_of_rings=...,
)

print(response)