UserPreAlertingAnnouncementModifyRequest20

Bases: OCIRequest

Modify the user's pre-alerting service setting. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

user_id (str):

is_active (Optional[bool]):

audio_selection (Optional[str]):

audio_file (Optional[ExtendedMediaFileLevelResource20]):

video_selection (Optional[str]):

video_file (Optional[ExtendedMediaFileLevelResource20]):

criteria_activation (Optional[List[CriteriaActivation]]):

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

@dataclass(kw_only=True)
class UserPreAlertingAnnouncementModifyRequest20(OCIRequest):
    """Modify the user's pre-alerting service setting.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        user_id (str):

        is_active (Optional[bool]):

        audio_selection (Optional[str]):

        audio_file (Optional[ExtendedMediaFileLevelResource20]):

        video_selection (Optional[str]):

        video_file (Optional[ExtendedMediaFileLevelResource20]):

        criteria_activation (Optional[List[CriteriaActivation]]):

    """

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

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

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

    audio_file: Optional[ExtendedMediaFileLevelResource20] = field(
        default=None, metadata={"alias": "audioFile"}
    )

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

    video_file: Optional[ExtendedMediaFileLevelResource20] = field(
        default=None, metadata={"alias": "videoFile"}
    )

    criteria_activation: Optional[List[CriteriaActivation]] = field(
        default=None, metadata={"alias": "criteriaActivation"}
    )

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 UserPreAlertingAnnouncementModifyRequest20

client = Client()

command = UserPreAlertingAnnouncementModifyRequest20(
    user_id=...,
    is_active=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
    criteria_activation=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserPreAlertingAnnouncementModifyRequest20",
    user_id=...,
    is_active=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
    criteria_activation=...,
)

print(response)