UserPreferredCarrierUserGetRequest

Bases: OCIRequest

Requests the currently configured preferred carriers for a user. The response is either a UserPreferredCarrierUserGetResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserPreferredCarrierUserGetRequest(OCIRequest):
    """Requests the currently configured preferred carriers for a user.
        The response is either a UserPreferredCarrierUserGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to a UserPreferredCarrierUserGetRequest.

Attributes:

intra_lata_carrier (UserPreferredCarrierName):

inter_lata_carrier (UserPreferredCarrierName):

international_carrier (UserPreferredCarrierName):

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

@dataclass(kw_only=True)
class UserPreferredCarrierUserGetResponse(OCIDataResponse):
    """Response to a UserPreferredCarrierUserGetRequest.

    Attributes:

        intra_lata_carrier (UserPreferredCarrierName):

        inter_lata_carrier (UserPreferredCarrierName):

        international_carrier (UserPreferredCarrierName):

    """

    intra_lata_carrier: UserPreferredCarrierName = field(
        metadata={"alias": "intraLataCarrier"}
    )

    inter_lata_carrier: UserPreferredCarrierName = field(
        metadata={"alias": "interLataCarrier"}
    )

    international_carrier: UserPreferredCarrierName = field(
        metadata={"alias": "internationalCarrier"}
    )

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 UserPreferredCarrierUserGetRequest

client = Client()

command = UserPreferredCarrierUserGetRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("UserPreferredCarrierUserGetRequest",
    user_id=...,
)

print(response)