UserDnGetActivationListRequest

Bases: OCIRequest

Request to get a list of DNs associated with a user and their activation state. The response is either UserDnGetActivationListResponse or ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserDnGetActivationListRequest(OCIRequest):
    """Request to get a list of DNs associated with a user and their activation state.
        The response is either UserDnGetActivationListResponse or ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserDnGetActivationListRequest. The response contains a table with columns: "Phone Number", and "Activated". The "Phone Number" column contains a single DN. The "Activated" column indicates if the phone number is activated or not.

Attributes:

dn_table (OCITable):

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

@dataclass(kw_only=True)
class UserDnGetActivationListResponse(OCIDataResponse):
    """Response to UserDnGetActivationListRequest.
        The response contains a table with columns: \"Phone Number\", and \"Activated\".
        The \"Phone Number\" column contains a single DN.
        The \"Activated\" column indicates if the phone number is activated or not.

    Attributes:

        dn_table (OCITable):

    """

    dn_table: OCITable = field(metadata={"alias": "dnTable"})

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 UserDnGetActivationListRequest

client = Client()

command = UserDnGetActivationListRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

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

print(response)