UserDoNotDisturbGetRequest

Bases: OCIRequest

Request the user level data associated with Do Not Disturb. The response is either a UserDoNotDisturbGetResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserDoNotDisturbGetRequest(OCIRequest):
    """Request the user level data associated with Do Not Disturb.
        The response is either a UserDoNotDisturbGetResponse or an
        ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserDoNotDisturbGetRequest.

Attributes:

is_active (bool):

ring_splash (bool):

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

@dataclass(kw_only=True)
class UserDoNotDisturbGetResponse(OCIDataResponse):
    """Response to UserDoNotDisturbGetRequest.

    Attributes:

        is_active (bool):

        ring_splash (bool):

    """

    is_active: bool = field(metadata={"alias": "isActive"})

    ring_splash: bool = field(metadata={"alias": "ringSplash"})

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 UserDoNotDisturbGetRequest

client = Client()

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

print(response)