UserBroadWorksAnywhereModifyRequest

Bases: OCIRequest

Request to modify the user-level settings for the BroadWorks Anywhere service for a specified user. The response is either SuccessResponse or ErrorResponse.

Attributes:

user_id (str):

alert_all_locations_for_click_to_dial_calls (Optional[bool]):

alert_all_locations_for_group_paging_calls (Optional[bool]):

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

@dataclass(kw_only=True)
class UserBroadWorksAnywhereModifyRequest(OCIRequest):
    """Request to modify the user-level settings for the BroadWorks Anywhere service for a specified user.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        user_id (str):

        alert_all_locations_for_click_to_dial_calls (Optional[bool]):

        alert_all_locations_for_group_paging_calls (Optional[bool]):

    """

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

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

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

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 UserBroadWorksAnywhereModifyRequest

client = Client()

command = UserBroadWorksAnywhereModifyRequest(
    user_id=...,
    alert_all_locations_for_click_to_dial_calls=...,
    alert_all_locations_for_group_paging_calls=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserBroadWorksAnywhereModifyRequest",
    user_id=...,
    alert_all_locations_for_click_to_dial_calls=...,
    alert_all_locations_for_group_paging_calls=...,
)

print(response)