UserCommPilotExpressModifyRequest

Bases: OCIRequest

Modify the user's commPilot express service setting. The response is either a SuccessResponse or an ErrorResponse. Engineering Note: This command is used internally by Call Processing.

Attributes:

user_id (str):

profile (Optional[Nillable[str]]):

available_in_office (Optional[CommPilotExpressAvailableInOfficeModify]):

available_out_of_office (Optional[CommPilotExpressAvailableOutOfOfficeModify]):

busy (Optional[CommPilotExpressBusyModify]):

unavailable (Optional[CommPilotExpressUnavailableModify]):

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

@dataclass(kw_only=True)
class UserCommPilotExpressModifyRequest(OCIRequest):
    """Modify the user's commPilot express service setting.
        The response is either a SuccessResponse or an ErrorResponse.
        Engineering Note: This command is used internally by Call Processing.

    Attributes:

        user_id (str):

        profile (Optional[Nillable[str]]):

        available_in_office (Optional[CommPilotExpressAvailableInOfficeModify]):

        available_out_of_office (Optional[CommPilotExpressAvailableOutOfOfficeModify]):

        busy (Optional[CommPilotExpressBusyModify]):

        unavailable (Optional[CommPilotExpressUnavailableModify]):

    """

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

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

    available_in_office: Optional[CommPilotExpressAvailableInOfficeModify] = field(
        default=None, metadata={"alias": "availableInOffice"}
    )

    available_out_of_office: Optional[CommPilotExpressAvailableOutOfOfficeModify] = (
        field(default=None, metadata={"alias": "availableOutOfOffice"})
    )

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

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

    def __post_init__(self):
        nillable_fields = ["profile"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 UserCommPilotExpressModifyRequest

client = Client()

command = UserCommPilotExpressModifyRequest(
    user_id=...,
    profile=...,
    available_in_office=...,
    available_out_of_office=...,
    busy=...,
    unavailable=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserCommPilotExpressModifyRequest",
    user_id=...,
    profile=...,
    available_in_office=...,
    available_out_of_office=...,
    busy=...,
    unavailable=...,
)

print(response)