Skip to content

UserPriorityAlertModifyCriteriaRequest

Bases: OCIRequest

Modify a criteria for the user's priority alert service. The following elements are only used in AS data mode: callToNumberList

For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

criteria_name (str):

new_criteria_name (Optional[str]):

time_schedule (Optional[Nillable[TimeSchedule]]):

from_dn_criteria (Optional[PriorityAlertCriteriaFromDnModify]):

holiday_schedule (Optional[Nillable[HolidaySchedule]]):

blacklisted (Optional[bool]):

call_to_number_list (Optional[Nillable[ReplacementCallToNumberList]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPriorityAlertModifyCriteriaRequest(OCIRequest):
    """Modify a criteria for the user's priority alert service.
        The following elements are only used in AS data mode:
          callToNumberList

        For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        criteria_name (str):

        new_criteria_name (Optional[str]):

        time_schedule (Optional[Nillable[TimeSchedule]]):

        from_dn_criteria (Optional[PriorityAlertCriteriaFromDnModify]):

        holiday_schedule (Optional[Nillable[HolidaySchedule]]):

        blacklisted (Optional[bool]):

        call_to_number_list (Optional[Nillable[ReplacementCallToNumberList]]):

    """

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

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

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

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

    from_dn_criteria: Optional[PriorityAlertCriteriaFromDnModify] = field(
        default=None, metadata={"alias": "fromDnCriteria"}
    )

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

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

    call_to_number_list: Optional[Nillable[ReplacementCallToNumberList]] = field(
        default=None, metadata={"alias": "callToNumberList"}
    )

    def __post_init__(self):
        nillable_fields = ["time_schedule", "holiday_schedule", "call_to_number_list"]
        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/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 UserPriorityAlertModifyCriteriaRequest

client = Client()

command = UserPriorityAlertModifyCriteriaRequest(
    user_id=...,
    criteria_name=...,
    new_criteria_name=...,
    time_schedule=...,
    from_dn_criteria=...,
    holiday_schedule=...,
    blacklisted=...,
    call_to_number_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPriorityAlertModifyCriteriaRequest",
    user_id=...,
    criteria_name=...,
    new_criteria_name=...,
    time_schedule=...,
    from_dn_criteria=...,
    holiday_schedule=...,
    blacklisted=...,
    call_to_number_list=...,
)

print(response)