GroupBroadWorksAnywhereModifyInstanceRequest

Bases: OCIRequest

Request to modify a BroadWorks Anywhere instance. The following elements are only used in AS data mode: networkClassOfService The response is either SuccessResponse or ErrorResponse.

Attributes:

service_user_id (str):

service_instance_profile (Optional[ServiceInstanceModifyProfile]):

broad_works_anywhere_scope (Optional[str]):

prompt_for_clid (Optional[str]):

silent_prompt_mode (Optional[bool]):

prompt_for_passcode (Optional[bool]):

network_class_of_service (Optional[str]):

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

@dataclass(kw_only=True)
class GroupBroadWorksAnywhereModifyInstanceRequest(OCIRequest):
    """Request to modify a BroadWorks Anywhere instance.
        The following elements are only used in AS data mode:
          networkClassOfService
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_user_id (str):

        service_instance_profile (Optional[ServiceInstanceModifyProfile]):

        broad_works_anywhere_scope (Optional[str]):

        prompt_for_clid (Optional[str]):

        silent_prompt_mode (Optional[bool]):

        prompt_for_passcode (Optional[bool]):

        network_class_of_service (Optional[str]):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

    service_instance_profile: Optional[ServiceInstanceModifyProfile] = field(
        default=None, metadata={"alias": "serviceInstanceProfile"}
    )

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

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

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

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

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

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 GroupBroadWorksAnywhereModifyInstanceRequest

client = Client()

command = GroupBroadWorksAnywhereModifyInstanceRequest(
    service_user_id=...,
    service_instance_profile=...,
    broad_works_anywhere_scope=...,
    prompt_for_clid=...,
    silent_prompt_mode=...,
    prompt_for_passcode=...,
    network_class_of_service=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupBroadWorksAnywhereModifyInstanceRequest",
    service_user_id=...,
    service_instance_profile=...,
    broad_works_anywhere_scope=...,
    prompt_for_clid=...,
    silent_prompt_mode=...,
    prompt_for_passcode=...,
    network_class_of_service=...,
)

print(response)