UserCommPilotExpressGetRequest

Bases: OCIRequest

Get the user's commPilot express service setting. The response is either a UserCommPilotExpressGetResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserCommPilotExpressGetRequest(OCIRequest):
    """Get the user's commPilot express service setting.
        The response is either a UserCommPilotExpressGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserCommPilotExpressGetRequest.

Attributes:

profile (Optional[str]):

available_in_office (CommPilotExpressAvailableInOffice):

available_out_of_office (CommPilotExpressAvailableOutOfOffice):

busy (CommPilotExpressBusy):

unavailable (CommPilotExpressUnavailable):

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

@dataclass(kw_only=True)
class UserCommPilotExpressGetResponse(OCIDataResponse):
    """Response to the UserCommPilotExpressGetRequest.

    Attributes:

        profile (Optional[str]):

        available_in_office (CommPilotExpressAvailableInOffice):

        available_out_of_office (CommPilotExpressAvailableOutOfOffice):

        busy (CommPilotExpressBusy):

        unavailable (CommPilotExpressUnavailable):

    """

    profile: Optional[str] = field(default=None, metadata={"alias": "profile"})

    available_in_office: CommPilotExpressAvailableInOffice = field(
        metadata={"alias": "availableInOffice"}
    )

    available_out_of_office: CommPilotExpressAvailableOutOfOffice = field(
        metadata={"alias": "availableOutOfOffice"}
    )

    busy: CommPilotExpressBusy = field(metadata={"alias": "busy"})

    unavailable: CommPilotExpressUnavailable = field(metadata={"alias": "unavailable"})

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 UserCommPilotExpressGetRequest

client = Client()

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

print(response)