UserBroadWorksMobilityMobileIdentityDeleteRequest

Bases: OCIRequest

Delete a mobile identity from the user's list of mobile identities. The response is either a SuccessResponse or an ErrorResponse. If another Mobile Identity is set to ring mobile only and only has this mobile identity in the alerting list, the identity is deleted and ErrorResponse is returned. The ErrorResponse is info type and contains the affected mobile numbers in the summary. When a delete request is attempted on the primary mobile identity, the delete will fail unless it is the last mobile identity in the user's list.

Attributes:

user_id (str):

mobile_number (str):

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

@dataclass(kw_only=True)
class UserBroadWorksMobilityMobileIdentityDeleteRequest(OCIRequest):
    """Delete a mobile identity from the user's list of mobile identities.
        The response is either a SuccessResponse or an ErrorResponse. If another Mobile Identity is set to ring mobile only and only has this mobile identity
        in the alerting list, the identity is deleted and ErrorResponse is returned. The ErrorResponse is info type and  contains the affected mobile numbers
        in the summary.
        When a delete request is attempted on the primary mobile identity, the delete will fail unless it is the last mobile identity in the user's list.

    Attributes:

        user_id (str):

        mobile_number (str):

    """

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

    mobile_number: str = field(metadata={"alias": "mobileNumber"})

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

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 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 UserBroadWorksMobilityMobileIdentityDeleteRequest

client = Client()

command = UserBroadWorksMobilityMobileIdentityDeleteRequest(
    user_id=...,
    mobile_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserBroadWorksMobilityMobileIdentityDeleteRequest",
    user_id=...,
    mobile_number=...,
)

print(response)