Skip to content

UserRouteListModifyRequest

Bases: OCIRequest

Modify the route list setting and the list of number ranges and number prefixes assigned to a user. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

treat_originations_and_pbx_redirections_as_screened (Optional[bool]):

use_route_list_identity_for_non_emergency_calls (Optional[bool]):

use_route_list_identity_for_emergency_calls (Optional[bool]):

ignore_calling_name_for_call_processing (Optional[bool]):

assigned_number_range_start_list (Optional[Nillable[ReplacementDNList]]):

assigned_number_prefix_list (Optional[Nillable[EnterpriseTrunkReplacementNumberPrefixList]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserRouteListModifyRequest(OCIRequest):
    """Modify the route list setting and the list of number ranges and number prefixes assigned to a user.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        treat_originations_and_pbx_redirections_as_screened (Optional[bool]):

        use_route_list_identity_for_non_emergency_calls (Optional[bool]):

        use_route_list_identity_for_emergency_calls (Optional[bool]):

        ignore_calling_name_for_call_processing (Optional[bool]):

        assigned_number_range_start_list (Optional[Nillable[ReplacementDNList]]):

        assigned_number_prefix_list (Optional[Nillable[EnterpriseTrunkReplacementNumberPrefixList]]):

    """

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

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

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

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

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

    assigned_number_range_start_list: Optional[Nillable[ReplacementDNList]] = field(
        default=None, metadata={"alias": "assignedNumberRangeStartList"}
    )

    assigned_number_prefix_list: Optional[
        Nillable[EnterpriseTrunkReplacementNumberPrefixList]
    ] = field(default=None, metadata={"alias": "assignedNumberPrefixList"})

    def __post_init__(self):
        nillable_fields = [
            "assigned_number_range_start_list",
            "assigned_number_prefix_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 UserRouteListModifyRequest

client = Client()

command = UserRouteListModifyRequest(
    user_id=...,
    treat_originations_and_pbx_redirections_as_screened=...,
    use_route_list_identity_for_non_emergency_calls=...,
    use_route_list_identity_for_emergency_calls=...,
    ignore_calling_name_for_call_processing=...,
    assigned_number_range_start_list=...,
    assigned_number_prefix_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserRouteListModifyRequest",
    user_id=...,
    treat_originations_and_pbx_redirections_as_screened=...,
    use_route_list_identity_for_non_emergency_calls=...,
    use_route_list_identity_for_emergency_calls=...,
    ignore_calling_name_for_call_processing=...,
    assigned_number_range_start_list=...,
    assigned_number_prefix_list=...,
)

print(response)