ServiceProviderExternalCustomRingbackModifyRequest

Bases: OCIRequest

Modify the service provider level data associated with External Custom Ringback. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

prefix_digits (Optional[Nillable[str]]):

server_net_address (Optional[Nillable[str]]):

server_port (Optional[Nillable[int]]):

timeout_seconds (Optional[int]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class ServiceProviderExternalCustomRingbackModifyRequest(OCIRequest):
    """Modify the service provider level data associated with External Custom Ringback.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        prefix_digits (Optional[Nillable[str]]):

        server_net_address (Optional[Nillable[str]]):

        server_port (Optional[Nillable[int]]):

        timeout_seconds (Optional[int]):

    """

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

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

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

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

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

    def __post_init__(self):
        nillable_fields = ["prefix_digits", "server_net_address", "server_port"]
        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 ServiceProviderExternalCustomRingbackModifyRequest

client = Client()

command = ServiceProviderExternalCustomRingbackModifyRequest(
    service_provider_id=...,
    prefix_digits=...,
    server_net_address=...,
    server_port=...,
    timeout_seconds=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderExternalCustomRingbackModifyRequest",
    service_provider_id=...,
    prefix_digits=...,
    server_net_address=...,
    server_port=...,
    timeout_seconds=...,
)

print(response)