UserPrimaryEndpointAdvancedSettingModifyRequest

Bases: OCIRequest

Modify the Users Primary Endpoint line control settings. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in XS data mode and ignored in AS data mode: allowVideo

Attributes:

user_id (str):

allow_origination (Optional[bool]):

allow_termination (Optional[bool]):

allow_video (Optional[bool]):

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

@dataclass(kw_only=True)
class UserPrimaryEndpointAdvancedSettingModifyRequest(OCIRequest):
    """Modify the Users Primary Endpoint line control settings.
          The response is either a SuccessResponse or an ErrorResponse.
          The following elements are only used in XS data mode and ignored in AS data mode:
                allowVideo

    Attributes:

        user_id (str):

        allow_origination (Optional[bool]):

        allow_termination (Optional[bool]):

        allow_video (Optional[bool]):

    """

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

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

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

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

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 UserPrimaryEndpointAdvancedSettingModifyRequest

client = Client()

command = UserPrimaryEndpointAdvancedSettingModifyRequest(
    user_id=...,
    allow_origination=...,
    allow_termination=...,
    allow_video=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPrimaryEndpointAdvancedSettingModifyRequest",
    user_id=...,
    allow_origination=...,
    allow_termination=...,
    allow_video=...,
)

print(response)