Skip to content

UserExecutiveModifyScreeningAlertingRequest

Bases: OCIRequest

Modify the screening and alerting setting of an executive. Both executive and the executive assistant can run this command. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

enable_screening (Optional[bool]):

screening_alert_type (Optional[str]):

alert_broad_works_mobility_location (Optional[bool]):

alert_broad_works_anywhere_locations (Optional[bool]):

alert_shared_call_appearance_locations (Optional[bool]):

alerting_mode (Optional[str]):

alerting_calling_line_id_name_mode (Optional[str]):

alerting_custom_calling_line_id_name (Optional[Nillable[str]]):

unicode_alerting_custom_calling_line_id_name (Optional[Nillable[str]]):

alerting_calling_line_id_phone_number_mode (Optional[str]):

alerting_custom_calling_line_id_phone_number (Optional[Nillable[str]]):

call_push_recall_number_of_rings (Optional[int]):

next_assistant_number_of_rings (Optional[int]):

enable_rollover (Optional[bool]):

rollover_wait_time_seconds (Optional[Nillable[int]]):

rollover_action (Optional[str]):

rollover_forward_to_phone_number (Optional[Nillable[str]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserExecutiveModifyScreeningAlertingRequest(OCIRequest):
    """Modify the screening and alerting setting of an executive.
        Both executive and the executive assistant can run this command.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        enable_screening (Optional[bool]):

        screening_alert_type (Optional[str]):

        alert_broad_works_mobility_location (Optional[bool]):

        alert_broad_works_anywhere_locations (Optional[bool]):

        alert_shared_call_appearance_locations (Optional[bool]):

        alerting_mode (Optional[str]):

        alerting_calling_line_id_name_mode (Optional[str]):

        alerting_custom_calling_line_id_name (Optional[Nillable[str]]):

        unicode_alerting_custom_calling_line_id_name (Optional[Nillable[str]]):

        alerting_calling_line_id_phone_number_mode (Optional[str]):

        alerting_custom_calling_line_id_phone_number (Optional[Nillable[str]]):

        call_push_recall_number_of_rings (Optional[int]):

        next_assistant_number_of_rings (Optional[int]):

        enable_rollover (Optional[bool]):

        rollover_wait_time_seconds (Optional[Nillable[int]]):

        rollover_action (Optional[str]):

        rollover_forward_to_phone_number (Optional[Nillable[str]]):

    """

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    rollover_wait_time_seconds: Optional[Nillable[int]] = field(
        default=None, metadata={"alias": "rolloverWaitTimeSeconds"}
    )

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

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

    def __post_init__(self):
        nillable_fields = [
            "alerting_custom_calling_line_id_name",
            "unicode_alerting_custom_calling_line_id_name",
            "alerting_custom_calling_line_id_phone_number",
            "rollover_wait_time_seconds",
            "rollover_forward_to_phone_number",
        ]
        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_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 UserExecutiveModifyScreeningAlertingRequest

client = Client()

command = UserExecutiveModifyScreeningAlertingRequest(
    user_id=...,
    enable_screening=...,
    screening_alert_type=...,
    alert_broad_works_mobility_location=...,
    alert_broad_works_anywhere_locations=...,
    alert_shared_call_appearance_locations=...,
    alerting_mode=...,
    alerting_calling_line_id_name_mode=...,
    alerting_custom_calling_line_id_name=...,
    unicode_alerting_custom_calling_line_id_name=...,
    alerting_calling_line_id_phone_number_mode=...,
    alerting_custom_calling_line_id_phone_number=...,
    call_push_recall_number_of_rings=...,
    next_assistant_number_of_rings=...,
    enable_rollover=...,
    rollover_wait_time_seconds=...,
    rollover_action=...,
    rollover_forward_to_phone_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserExecutiveModifyScreeningAlertingRequest",
    user_id=...,
    enable_screening=...,
    screening_alert_type=...,
    alert_broad_works_mobility_location=...,
    alert_broad_works_anywhere_locations=...,
    alert_shared_call_appearance_locations=...,
    alerting_mode=...,
    alerting_calling_line_id_name_mode=...,
    alerting_custom_calling_line_id_name=...,
    unicode_alerting_custom_calling_line_id_name=...,
    alerting_calling_line_id_phone_number_mode=...,
    alerting_custom_calling_line_id_phone_number=...,
    call_push_recall_number_of_rings=...,
    next_assistant_number_of_rings=...,
    enable_rollover=...,
    rollover_wait_time_seconds=...,
    rollover_action=...,
    rollover_forward_to_phone_number=...,
)

print(response)