Skip to content

EnterprisePreAlertingAnnouncementGetRequest

Bases: OCIRequest

Get the Enterprise pre-alerting service settings. The response is either a EnterprisePreAlertingAnnouncementGetResponse or an ErrorResponse.

Attributes:

service_provider_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class EnterprisePreAlertingAnnouncementGetRequest(OCIRequest):
    """Get the Enterprise pre-alerting service settings.
        The response is either a EnterprisePreAlertingAnnouncementGetResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

    """

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

Responses

Bases: OCIDataResponse

Get the Enterprise level pre-alerting service settings. The response is either a EnterprisePreAlertingAnnouncementGetResponse or an ErrorResponse.

Attributes:

announcement_interruption (str):

interruption_digit_sequence (Optional[str]):

audio_selection (str):

audio_file_description (Optional[str]):

audio_media_type (Optional[str]):

audio_file_url (Optional[str]):

video_selection (str):

video_file_description (Optional[str]):

video_media_type (Optional[str]):

video_file_url (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class EnterprisePreAlertingAnnouncementGetResponse(OCIDataResponse):
    """Get the Enterprise level pre-alerting service settings.
        The response is either a EnterprisePreAlertingAnnouncementGetResponse or an ErrorResponse.

    Attributes:

        announcement_interruption (str):

        interruption_digit_sequence (Optional[str]):

        audio_selection (str):

        audio_file_description (Optional[str]):

        audio_media_type (Optional[str]):

        audio_file_url (Optional[str]):

        video_selection (str):

        video_file_description (Optional[str]):

        video_media_type (Optional[str]):

        video_file_url (Optional[str]):

    """

    announcement_interruption: str = field(
        metadata={"alias": "announcementInterruption"}
    )

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

    audio_selection: str = field(metadata={"alias": "audioSelection"})

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

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

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

    video_selection: str = field(metadata={"alias": "videoSelection"})

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

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

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

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import EnterprisePreAlertingAnnouncementGetRequest

client = Client()

command = EnterprisePreAlertingAnnouncementGetRequest(
    service_provider_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("EnterprisePreAlertingAnnouncementGetRequest",
    service_provider_id=...,
)

print(response)