Skip to content

GroupRoutePointModifyFailoverPolicyRequest

Bases: OCIRequest

Modify the route point failover policy. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_user_id (str):

enable_failover_support (Optional[bool]):

external_system (Optional[Nillable[str]]):

failover_phone_number (Optional[Nillable[str]]):

per_call_enable_failover_support (Optional[bool]):

per_call_call_failure_timeout_seconds (Optional[int]):

per_call_outbound_call_failure_timeout_seconds (Optional[int]):

per_call_failover_phone_number (Optional[Nillable[str]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupRoutePointModifyFailoverPolicyRequest(OCIRequest):
    """Modify the route point failover policy.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_user_id (str):

        enable_failover_support (Optional[bool]):

        external_system (Optional[Nillable[str]]):

        failover_phone_number (Optional[Nillable[str]]):

        per_call_enable_failover_support (Optional[bool]):

        per_call_call_failure_timeout_seconds (Optional[int]):

        per_call_outbound_call_failure_timeout_seconds (Optional[int]):

        per_call_failover_phone_number (Optional[Nillable[str]]):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

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

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

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "external_system",
            "failover_phone_number",
            "per_call_failover_phone_number",
        ]
        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 GroupRoutePointModifyFailoverPolicyRequest

client = Client()

command = GroupRoutePointModifyFailoverPolicyRequest(
    service_user_id=...,
    enable_failover_support=...,
    external_system=...,
    failover_phone_number=...,
    per_call_enable_failover_support=...,
    per_call_call_failure_timeout_seconds=...,
    per_call_outbound_call_failure_timeout_seconds=...,
    per_call_failover_phone_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("GroupRoutePointModifyFailoverPolicyRequest",
    service_user_id=...,
    enable_failover_support=...,
    external_system=...,
    failover_phone_number=...,
    per_call_enable_failover_support=...,
    per_call_call_failure_timeout_seconds=...,
    per_call_outbound_call_failure_timeout_seconds=...,
    per_call_failover_phone_number=...,
)

print(response)