Skip to content

UserPreferredCarrierUserModifyRequest

Bases: OCIRequest

Modifies the currently configured preferred carriers for a user. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

intra_lata_carrier (Optional[UserPreferredCarrierNameModify]):

inter_lata_carrier (Optional[UserPreferredCarrierNameModify]):

international_carrier (Optional[UserPreferredCarrierNameModify]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserPreferredCarrierUserModifyRequest(OCIRequest):
    """Modifies the currently configured preferred carriers for a user.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        intra_lata_carrier (Optional[UserPreferredCarrierNameModify]):

        inter_lata_carrier (Optional[UserPreferredCarrierNameModify]):

        international_carrier (Optional[UserPreferredCarrierNameModify]):

    """

    user_id: str = field(metadata={"alias": "userId"})

    intra_lata_carrier: Optional[UserPreferredCarrierNameModify] = field(
        default=None, metadata={"alias": "intraLataCarrier"}
    )

    inter_lata_carrier: Optional[UserPreferredCarrierNameModify] = field(
        default=None, metadata={"alias": "interLataCarrier"}
    )

    international_carrier: Optional[UserPreferredCarrierNameModify] = field(
        default=None, metadata={"alias": "internationalCarrier"}
    )

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 UserPreferredCarrierUserModifyRequest

client = Client()

command = UserPreferredCarrierUserModifyRequest(
    user_id=...,
    intra_lata_carrier=...,
    inter_lata_carrier=...,
    international_carrier=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPreferredCarrierUserModifyRequest",
    user_id=...,
    intra_lata_carrier=...,
    inter_lata_carrier=...,
    international_carrier=...,
)

print(response)