Skip to content

UserCustomRingbackUserModifyCriteriaRequest20

Bases: OCIRequest

Modify a criteria for the user's custom ringback service. 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]]):

holiday_schedule (Optional[Nillable[HolidaySchedule]]):

blacklisted (Optional[bool]):

from_dn_criteria (Optional[CriteriaFromDnModify]):

call_to_number_list (Optional[Nillable[ReplacementCallToNumberList]]):

audio_selection (Optional[str]):

audio_file (Optional[ExtendedMediaFileLevelResource20]):

video_selection (Optional[str]):

video_file (Optional[ExtendedMediaFileLevelResource20]):

call_waiting_audio_selection (Optional[str]):

call_waiting_audio_file (Optional[ExtendedMediaFileLevelResource20]):

call_waiting_video_selection (Optional[str]):

call_waiting_video_file (Optional[ExtendedMediaFileLevelResource20]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserCustomRingbackUserModifyCriteriaRequest20(OCIRequest):
    """Modify a criteria for the user's custom ringback service.
        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]]):

        holiday_schedule (Optional[Nillable[HolidaySchedule]]):

        blacklisted (Optional[bool]):

        from_dn_criteria (Optional[CriteriaFromDnModify]):

        call_to_number_list (Optional[Nillable[ReplacementCallToNumberList]]):

        audio_selection (Optional[str]):

        audio_file (Optional[ExtendedMediaFileLevelResource20]):

        video_selection (Optional[str]):

        video_file (Optional[ExtendedMediaFileLevelResource20]):

        call_waiting_audio_selection (Optional[str]):

        call_waiting_audio_file (Optional[ExtendedMediaFileLevelResource20]):

        call_waiting_video_selection (Optional[str]):

        call_waiting_video_file (Optional[ExtendedMediaFileLevelResource20]):

    """

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

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

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

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

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

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

    audio_file: Optional[ExtendedMediaFileLevelResource20] = field(
        default=None, metadata={"alias": "audioFile"}
    )

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

    video_file: Optional[ExtendedMediaFileLevelResource20] = field(
        default=None, metadata={"alias": "videoFile"}
    )

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

    call_waiting_audio_file: Optional[ExtendedMediaFileLevelResource20] = field(
        default=None, metadata={"alias": "callWaitingAudioFile"}
    )

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

    call_waiting_video_file: Optional[ExtendedMediaFileLevelResource20] = field(
        default=None, metadata={"alias": "callWaitingVideoFile"}
    )

    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_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 UserCustomRingbackUserModifyCriteriaRequest20

client = Client()

command = UserCustomRingbackUserModifyCriteriaRequest20(
    user_id=...,
    criteria_name=...,
    new_criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    blacklisted=...,
    from_dn_criteria=...,
    call_to_number_list=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
    call_waiting_audio_selection=...,
    call_waiting_audio_file=...,
    call_waiting_video_selection=...,
    call_waiting_video_file=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserCustomRingbackUserModifyCriteriaRequest20",
    user_id=...,
    criteria_name=...,
    new_criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    blacklisted=...,
    from_dn_criteria=...,
    call_to_number_list=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
    call_waiting_audio_selection=...,
    call_waiting_audio_file=...,
    call_waiting_video_selection=...,
    call_waiting_video_file=...,
)

print(response)