ServiceProviderExternalCustomRingbackGetRequest

Bases: OCIRequest

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

Attributes:

service_provider_id (str):

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

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

    Attributes:

        service_provider_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to ServiceProviderExternalCustomRingbackGetRequest.

Attributes:

prefix_digits (Optional[str]):

server_net_address (Optional[str]):

server_port (Optional[int]):

timeout_seconds (int):

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

@dataclass(kw_only=True)
class ServiceProviderExternalCustomRingbackGetResponse(OCIDataResponse):
    """Response to ServiceProviderExternalCustomRingbackGetRequest.

    Attributes:

        prefix_digits (Optional[str]):

        server_net_address (Optional[str]):

        server_port (Optional[int]):

        timeout_seconds (int):

    """

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

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

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

    timeout_seconds: int = field(metadata={"alias": "timeoutSeconds"})

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 ServiceProviderExternalCustomRingbackGetRequest

client = Client()

command = ServiceProviderExternalCustomRingbackGetRequest(
    service_provider_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderExternalCustomRingbackGetRequest",
    service_provider_id=...,
)

print(response)