UserPBXIntegrationModifyRequest

Bases: OCIRequest

Modify the user level data associated with PBX Integration service. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

proxy_to_header_from_network (Optional[bool]):

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

@dataclass(kw_only=True)
class UserPBXIntegrationModifyRequest(OCIRequest):
    """Modify the user level data associated with PBX Integration service.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        proxy_to_header_from_network (Optional[bool]):

    """

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

    proxy_to_header_from_network: Optional[bool] = field(
        default=None, metadata={"alias": "proxyToHeaderFromNetwork"}
    )

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 UserPBXIntegrationModifyRequest

client = Client()

command = UserPBXIntegrationModifyRequest(
    user_id=...,
    proxy_to_header_from_network=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPBXIntegrationModifyRequest",
    user_id=...,
    proxy_to_header_from_network=...,
)

print(response)