Skip to content

UserBroadWorksMobilityModifyRequest21

Bases: OCIRequest

Modify the user's BroadWorks Mobility service settings. The response is either a SuccessResponse or an ErrorResponse.

The isActive, useMobileIdentityCallAnchoring, and preventCallsToOwnMobiles parameters can be modified by users with Group Authorization Level and above.
The mobileIdentity, profileIdentityDevicesToRing, rofileIdentityIncludeSharedCallAppearance, profileIdentityIncludeBroadworksAnywhere mobileIdentity and profileIdentityMobilityNumbersAlerted parameters can be modified by users with User Authorization Level and above when the BroadWorks Mobility service is turned on.

Attributes:

user_id (str):

is_active (Optional[bool]):

use_mobile_identity_call_anchoring (Optional[bool]):

prevent_calls_to_own_mobiles (Optional[bool]):

mobile_identity (Optional[List[BroadWorksMobilityUserMobileIdentityModifyEntry]]):

profile_identity_devices_to_ring (Optional[str]):

profile_identity_include_shared_call_appearance (Optional[bool]):

profile_identity_include_broadworks_anywhere (Optional[bool]):

profile_identity_include_executive_assistant (Optional[bool]):

profile_identity_mobility_numbers_alerted (Optional[Nillable[BroadWorksMobilityAlertingMobileNumberReplacementList]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserBroadWorksMobilityModifyRequest21(OCIRequest):
    """Modify the user's BroadWorks Mobility service settings.
        The response is either a SuccessResponse or an ErrorResponse.

        The isActive, useMobileIdentityCallAnchoring, and preventCallsToOwnMobiles parameters can be modified by users with Group Authorization Level and above.
        The mobileIdentity, profileIdentityDevicesToRing, rofileIdentityIncludeSharedCallAppearance, profileIdentityIncludeBroadworksAnywhere mobileIdentity and profileIdentityMobilityNumbersAlerted parameters can be modified by users with User Authorization Level and above when the BroadWorks Mobility service is turned on.

    Attributes:

        user_id (str):

        is_active (Optional[bool]):

        use_mobile_identity_call_anchoring (Optional[bool]):

        prevent_calls_to_own_mobiles (Optional[bool]):

        mobile_identity (Optional[List[BroadWorksMobilityUserMobileIdentityModifyEntry]]):

        profile_identity_devices_to_ring (Optional[str]):

        profile_identity_include_shared_call_appearance (Optional[bool]):

        profile_identity_include_broadworks_anywhere (Optional[bool]):

        profile_identity_include_executive_assistant (Optional[bool]):

        profile_identity_mobility_numbers_alerted (Optional[Nillable[BroadWorksMobilityAlertingMobileNumberReplacementList]]):

    """

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

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

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

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

    mobile_identity: Optional[List[BroadWorksMobilityUserMobileIdentityModifyEntry]] = (
        field(default=None, metadata={"alias": "mobileIdentity"})
    )

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

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

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

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

    profile_identity_mobility_numbers_alerted: Optional[
        Nillable[BroadWorksMobilityAlertingMobileNumberReplacementList]
    ] = field(default=None, metadata={"alias": "profileIdentityMobilityNumbersAlerted"})

    def __post_init__(self):
        nillable_fields = ["profile_identity_mobility_numbers_alerted"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

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 UserBroadWorksMobilityModifyRequest21

client = Client()

command = UserBroadWorksMobilityModifyRequest21(
    user_id=...,
    is_active=...,
    use_mobile_identity_call_anchoring=...,
    prevent_calls_to_own_mobiles=...,
    mobile_identity=...,
    profile_identity_devices_to_ring=...,
    profile_identity_include_shared_call_appearance=...,
    profile_identity_include_broadworks_anywhere=...,
    profile_identity_include_executive_assistant=...,
    profile_identity_mobility_numbers_alerted=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserBroadWorksMobilityModifyRequest21",
    user_id=...,
    is_active=...,
    use_mobile_identity_call_anchoring=...,
    prevent_calls_to_own_mobiles=...,
    mobile_identity=...,
    profile_identity_devices_to_ring=...,
    profile_identity_include_shared_call_appearance=...,
    profile_identity_include_broadworks_anywhere=...,
    profile_identity_include_executive_assistant=...,
    profile_identity_mobility_numbers_alerted=...,
)

print(response)