UserDoNotDisturbModifyRequest

Bases: OCIRequest

Modify the user level data associated with Do Not Disturb. The response is either a SuccessResponse or an ErrorResponse. Engineering Note: This command is used internally by Call Processing. The following element is only used in AS data mode and ignored in XS data mode: isDoNotDisturbSync

Attributes:

user_id (str):

is_active (Optional[bool]):

ring_splash (Optional[bool]):

is_do_not_disturb_sync (Optional[bool]):

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

@dataclass(kw_only=True)
class UserDoNotDisturbModifyRequest(OCIRequest):
    """Modify the user level data associated with Do Not Disturb.
        The response is either a SuccessResponse or an ErrorResponse.
        Engineering Note: This command is used internally by Call Processing.
        The following element is only used in AS data mode and ignored in XS data mode: isDoNotDisturbSync

    Attributes:

        user_id (str):

        is_active (Optional[bool]):

        ring_splash (Optional[bool]):

        is_do_not_disturb_sync (Optional[bool]):

    """

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

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

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

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

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 UserDoNotDisturbModifyRequest

client = Client()

command = UserDoNotDisturbModifyRequest(
    user_id=...,
    is_active=...,
    ring_splash=...,
    is_do_not_disturb_sync=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserDoNotDisturbModifyRequest",
    user_id=...,
    is_active=...,
    ring_splash=...,
    is_do_not_disturb_sync=...,
)

print(response)