UserSMDIMessageDeskAddServerRequest

Bases: OCIRequest

Request to add a SMDI Server for a user. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

device_name (str):

net_address (str):

port (int):

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

@dataclass(kw_only=True)
class UserSMDIMessageDeskAddServerRequest(OCIRequest):
    """Request to add a SMDI Server for a user.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        device_name (str):

        net_address (str):

        port (int):

    """

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

    device_name: str = field(metadata={"alias": "deviceName"})

    net_address: str = field(metadata={"alias": "netAddress"})

    port: int = field(metadata={"alias": "port"})

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 UserSMDIMessageDeskAddServerRequest

client = Client()

command = UserSMDIMessageDeskAddServerRequest(
    user_id=...,
    device_name=...,
    net_address=...,
    port=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserSMDIMessageDeskAddServerRequest",
    user_id=...,
    device_name=...,
    net_address=...,
    port=...,
)

print(response)