Skip to content

UserExecutiveAddFilteringSelectiveCriteriaRequest

Bases: OCIRequest

Add a filtering criteria to an executive user. Both executive and the executive assistant can run this command. For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

criteria_name (str):

time_schedule (Optional[TimeSchedule]):

holiday_schedule (Optional[HolidaySchedule]):

filter (bool):

from_dn_criteria (ExecutiveCallFilteringCriteriaFromDn):

call_to_number (Optional[List[CallToNumber]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserExecutiveAddFilteringSelectiveCriteriaRequest(OCIRequest):
    """Add a filtering criteria to an executive user.
        Both executive and the executive assistant can run this command.
        For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        criteria_name (str):

        time_schedule (Optional[TimeSchedule]):

        holiday_schedule (Optional[HolidaySchedule]):

        filter (bool):

        from_dn_criteria (ExecutiveCallFilteringCriteriaFromDn):

        call_to_number (Optional[List[CallToNumber]]):

    """

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

    filter: bool = field(metadata={"alias": "filter"})

    from_dn_criteria: ExecutiveCallFilteringCriteriaFromDn = field(
        metadata={"alias": "fromDnCriteria"}
    )

    call_to_number: Optional[List[CallToNumber]] = field(
        default=None, metadata={"alias": "callToNumber"}
    )

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 UserExecutiveAddFilteringSelectiveCriteriaRequest

client = Client()

command = UserExecutiveAddFilteringSelectiveCriteriaRequest(
    user_id=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    filter=...,
    from_dn_criteria=...,
    call_to_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("UserExecutiveAddFilteringSelectiveCriteriaRequest",
    user_id=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    filter=...,
    from_dn_criteria=...,
    call_to_number=...,
)

print(response)