SystemPreferredCarrierDeleteRequest

Bases: OCIRequest

Delete a carrier from the system. The response is either a SuccessResponse or an ErrorResponse. An ErrorResponse is returned if the carrier is in use, or if the carrier didn't exist prior to deletion..

Attributes:

carrier (str):

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

@dataclass(kw_only=True)
class SystemPreferredCarrierDeleteRequest(OCIRequest):
    """Delete a carrier from the system.
        The response is either a SuccessResponse or an ErrorResponse.
        An ErrorResponse is returned if the carrier is in use, or if the carrier didn't exist prior to deletion..

    Attributes:

        carrier (str):

    """

    carrier: str = field(metadata={"alias": "carrier"})

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

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 SystemPreferredCarrierDeleteRequest

client = Client()

command = SystemPreferredCarrierDeleteRequest(
    carrier=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemPreferredCarrierDeleteRequest",
    carrier=...,
)

print(response)