Skip to content

EnterpriseEnterpriseTrunkModifyRequest

Bases: OCIRequest

Request to modify an enterprise trunk in an enterprise. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

enterprise_trunk_name (str):

new_enterprise_trunk_name (Optional[str]):

maximum_reroute_attempts (Optional[int]):

route_exhaustion_action (Optional[str]):

route_exhaustion_forward_address (Optional[Nillable[str]]):

ordered_routing (Optional[object]):

priority_weighted_routing (Optional[object]):

enable_capacity_management (Optional[bool]):

max_active_calls (Optional[Nillable[int]]):

capacity_exceeded_trap_initial_calls (Optional[Nillable[int]]):

capacity_exceeded_trap_offset_calls (Optional[Nillable[int]]):

maximum_active_incoming_calls_allowed (Optional[Nillable[int]]):

maximum_active_outgoing_calls_allowed (Optional[Nillable[int]]):

minimum_active_calls_reserved (Optional[Nillable[int]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseEnterpriseTrunkModifyRequest(OCIRequest):
    """Request to modify an enterprise trunk in an enterprise.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        enterprise_trunk_name (str):

        new_enterprise_trunk_name (Optional[str]):

        maximum_reroute_attempts (Optional[int]):

        route_exhaustion_action (Optional[str]):

        route_exhaustion_forward_address (Optional[Nillable[str]]):

        ordered_routing (Optional[object]):

        priority_weighted_routing (Optional[object]):

        enable_capacity_management (Optional[bool]):

        max_active_calls (Optional[Nillable[int]]):

        capacity_exceeded_trap_initial_calls (Optional[Nillable[int]]):

        capacity_exceeded_trap_offset_calls (Optional[Nillable[int]]):

        maximum_active_incoming_calls_allowed (Optional[Nillable[int]]):

        maximum_active_outgoing_calls_allowed (Optional[Nillable[int]]):

        minimum_active_calls_reserved (Optional[Nillable[int]]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    enterprise_trunk_name: str = field(metadata={"alias": "enterpriseTrunkName"})

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

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

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

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

    ordered_routing: Optional[object] = field(
        default=None, metadata={"alias": "orderedRouting"}
    )

    priority_weighted_routing: Optional[object] = field(
        default=None, metadata={"alias": "priorityWeightedRouting"}
    )

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "route_exhaustion_forward_address",
            "max_active_calls",
            "capacity_exceeded_trap_initial_calls",
            "capacity_exceeded_trap_offset_calls",
            "maximum_active_incoming_calls_allowed",
            "maximum_active_outgoing_calls_allowed",
            "minimum_active_calls_reserved",
        ]
        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 EnterpriseEnterpriseTrunkModifyRequest

client = Client()

command = EnterpriseEnterpriseTrunkModifyRequest(
    service_provider_id=...,
    enterprise_trunk_name=...,
    new_enterprise_trunk_name=...,
    maximum_reroute_attempts=...,
    route_exhaustion_action=...,
    route_exhaustion_forward_address=...,
    ordered_routing=...,
    priority_weighted_routing=...,
    enable_capacity_management=...,
    max_active_calls=...,
    capacity_exceeded_trap_initial_calls=...,
    capacity_exceeded_trap_offset_calls=...,
    maximum_active_incoming_calls_allowed=...,
    maximum_active_outgoing_calls_allowed=...,
    minimum_active_calls_reserved=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterpriseEnterpriseTrunkModifyRequest",
    service_provider_id=...,
    enterprise_trunk_name=...,
    new_enterprise_trunk_name=...,
    maximum_reroute_attempts=...,
    route_exhaustion_action=...,
    route_exhaustion_forward_address=...,
    ordered_routing=...,
    priority_weighted_routing=...,
    enable_capacity_management=...,
    max_active_calls=...,
    capacity_exceeded_trap_initial_calls=...,
    capacity_exceeded_trap_offset_calls=...,
    maximum_active_incoming_calls_allowed=...,
    maximum_active_outgoing_calls_allowed=...,
    minimum_active_calls_reserved=...,
)

print(response)