EnterprisePreAlertingAnnouncementModifyRequest

Bases: OCIRequest

Modify the enterprise level pre-alerting service settings. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

announcement_interruption (Optional[str]):

interruption_digit_sequence (Optional[str]):

audio_selection (Optional[str]):

audio_file (Optional[ExtendedMediaFileResource]):

video_selection (Optional[str]):

video_file (Optional[ExtendedMediaFileResource]):

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

@dataclass(kw_only=True)
class EnterprisePreAlertingAnnouncementModifyRequest(OCIRequest):
    """Modify the enterprise level pre-alerting service settings.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        announcement_interruption (Optional[str]):

        interruption_digit_sequence (Optional[str]):

        audio_selection (Optional[str]):

        audio_file (Optional[ExtendedMediaFileResource]):

        video_selection (Optional[str]):

        video_file (Optional[ExtendedMediaFileResource]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

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

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

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

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

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

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

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 EnterprisePreAlertingAnnouncementModifyRequest

client = Client()

command = EnterprisePreAlertingAnnouncementModifyRequest(
    service_provider_id=...,
    announcement_interruption=...,
    interruption_digit_sequence=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterprisePreAlertingAnnouncementModifyRequest",
    service_provider_id=...,
    announcement_interruption=...,
    interruption_digit_sequence=...,
    audio_selection=...,
    audio_file=...,
    video_selection=...,
    video_file=...,
)

print(response)