Skip to content

SystemPreferredCarrierModifyRequest

Bases: OCIRequest

Modify the attributes of a carrier. The response is either a SuccessResponse or an ErrorResponse. An ErrorResponse is returned if countryCode modification is attempted while the carrier is assigned to a service provider. An ErrorResponse is returned if an attempt to set isIntraLata to false is made while the carrier is used as an intra-LATA carrier. An ErrorResponse is returned if an attempt to set isInternational to false is made while the carrier is used as an international carrier.

Attributes:

carrier (str):

cic (Optional[str]):

country_code (Optional[str]):

is_intra_lata (Optional[bool]):

is_inter_lata (Optional[bool]):

is_international (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemPreferredCarrierModifyRequest(OCIRequest):
    """Modify the attributes of a carrier.
        The response is either a SuccessResponse or an ErrorResponse.
        An ErrorResponse is returned if countryCode modification is attempted while the carrier is assigned to a service provider.
        An ErrorResponse is returned if an attempt to set isIntraLata to false is made while the carrier is used as an intra-LATA carrier.
        An ErrorResponse is returned if an attempt to set isInternational to false is made while the carrier is used as an international carrier.

    Attributes:

        carrier (str):

        cic (Optional[str]):

        country_code (Optional[str]):

        is_intra_lata (Optional[bool]):

        is_inter_lata (Optional[bool]):

        is_international (Optional[bool]):

    """

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

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

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

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

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

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

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

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

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

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 SystemPreferredCarrierModifyRequest

client = Client()

command = SystemPreferredCarrierModifyRequest(
    carrier=...,
    cic=...,
    country_code=...,
    is_intra_lata=...,
    is_inter_lata=...,
    is_international=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemPreferredCarrierModifyRequest",
    carrier=...,
    cic=...,
    country_code=...,
    is_intra_lata=...,
    is_inter_lata=...,
    is_international=...,
)

print(response)