UserExecutiveAssistantGetRequest

Bases: OCIRequest

Get the setting of an executive assistant. The response is either UserExecutiveAssistantGetResponse or ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserExecutiveAssistantGetRequest(OCIRequest):
    """Get the setting of an executive assistant.
        The response is either UserExecutiveAssistantGetResponse or ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserExecutiveAssistantGetRequest. Contains the executive assistant setting and a table of executives this assistant has been assigned to. The criteria table's column headings are: "User Id", "Last Name", "First Name", ", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", "Assistant Opt-in Status" and "Executive Allow Opt-in". The possible values for "Assistant Opt-in Status" and "Executive Allow Opt-in" columns are "true" and "false".

Attributes:

enable_divert (bool):

divert_to_phone_number (Optional[str]):

executive_table (OCITable):

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

@dataclass(kw_only=True)
class UserExecutiveAssistantGetResponse(OCIDataResponse):
    """Response to the UserExecutiveAssistantGetRequest.
        Contains the executive assistant setting and a table of executives this assistant has been assigned to.
        The criteria table's column headings are: \"User Id\", \"Last Name\", \"First Name\", \", \"Hiragana Last Name\",
        \"Hiragana First Name\", \"Phone Number\", \"Extension\", \"Department\", \"Email Address\",
        \"Assistant Opt-in Status\" and \"Executive Allow Opt-in\".
        The possible values for \"Assistant Opt-in Status\" and \"Executive Allow Opt-in\" columns are \"true\" and \"false\".

    Attributes:

        enable_divert (bool):

        divert_to_phone_number (Optional[str]):

        executive_table (OCITable):

    """

    enable_divert: bool = field(metadata={"alias": "enableDivert"})

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

    executive_table: OCITable = field(metadata={"alias": "executiveTable"})

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 UserExecutiveAssistantGetRequest

client = Client()

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

print(response)