UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetRequest

Bases: OCIRequest

Request the originating permissions for Pinhole digit patterns for a user. The response is either a UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetRequest(OCIRequest):
    """Request the originating permissions for Pinhole digit patterns for a user.
        The response is either a UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetRequest.

Attributes:

use_custom_settings (bool):

user_permissions (Optional[OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions]):

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

@dataclass(kw_only=True)
class UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetResponse(OCIDataResponse):
    """Response to UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetRequest.

    Attributes:

        use_custom_settings (bool):

        user_permissions (Optional[OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions]):

    """

    use_custom_settings: bool = field(metadata={"alias": "useCustomSettings"})

    user_permissions: Optional[
        OutgoingPinholeDigitPlanDigitPatternOriginatingPermissions
    ] = field(default=None, metadata={"alias": "userPermissions"})

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 UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetRequest

client = Client()

command = UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetRequest(
    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("UserOutgoingCallingPlanPinholeDigitPlanOriginatingGetRequest",
    user_id=...,
)

print(response)