GroupCollaborateBridgeConsolidatedDeleteInstanceRequest

Bases: OCIRequest

Delete a collaborate bridge from a group. The request fails when attempting to delete the default collaborate bridge. If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above. When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above. When omitted, the number(s) will be left assigned to the group. An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege.

The response is either SuccessResponse or ErrorResponse.

Attributes:

service_user_id (str):

unassign_phone_numbers (Optional[str]):

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

@dataclass(kw_only=True)
class GroupCollaborateBridgeConsolidatedDeleteInstanceRequest(OCIRequest):
    """Delete a collaborate bridge from a group.
        The request fails when attempting to delete the default collaborate bridge.
        If UnassignPhoneNumbersLevel is set to 'Group', the user's primary phone number, fax number and any alternate numbers, will be un-assigned from the group if the command is executed by a service provider administrator or above.
        When set to 'Service Provider', they will be un-assigned from the group and service provider if the command is executed by a provisioning administrator or above.
        When omitted, the number(s) will be left assigned to the group.
        An ErrorResponse will be returned if any number cannot be unassigned because of insufficient privilege.

        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_user_id (str):

        unassign_phone_numbers (Optional[str]):

    """

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

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

Responses

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

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 GroupCollaborateBridgeConsolidatedDeleteInstanceRequest

client = Client()

command = GroupCollaborateBridgeConsolidatedDeleteInstanceRequest(
    service_user_id=...,
    unassign_phone_numbers=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCollaborateBridgeConsolidatedDeleteInstanceRequest",
    service_user_id=...,
    unassign_phone_numbers=...,
)

print(response)