GroupAutoAttendantSubmenuGetUsageListRequest

Bases: OCIRequest

Get a list of Auto Attendant Business Hours Menu,After Hours Menu,Holiday Menu and Submenus that use this submenu. The response is either GroupAutoAttendantSubmenuGetUsageListResponse or ErrorResponse. This request is only valid for Standard auto attendants.

Attributes:

service_user_id (str):

submenu_id (str):

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

@dataclass(kw_only=True)
class GroupAutoAttendantSubmenuGetUsageListRequest(OCIRequest):
    """Get a list of Auto Attendant Business Hours Menu,After Hours Menu,Holiday Menu and Submenus that use this submenu.
        The response is either GroupAutoAttendantSubmenuGetUsageListResponse or ErrorResponse.
        This request is only valid for Standard auto attendants.

    Attributes:

        service_user_id (str):

        submenu_id (str):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

    submenu_id: str = field(metadata={"alias": "submenuId"})

Responses

Bases: OCIDataResponse

Response to the GroupAutoAttendantSubmenuGetUsageListRequest. Contains a table with column headings: "Type" and "Submenu ID".

The "Type" Column will contain one of the following: Business Hours Menu,
After Hours Menu, Holiday Menu or Submenu.

The "Submenu ID" Column will be left blank when the "Type" Column contains one
of the base menu types (Business Hours Menu, After Hours Menu or Holiday Menu),
and will contain the Submenu ID when the "Type" Column contains type Submenu.

Attributes:

submenu_table (OCITable):

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

@dataclass(kw_only=True)
class GroupAutoAttendantSubmenuGetUsageListResponse(OCIDataResponse):
    """Response to the GroupAutoAttendantSubmenuGetUsageListRequest.
        Contains a table with column headings:
        \"Type\" and \"Submenu ID\".

        The \"Type\" Column will contain one of the following: Business Hours Menu,
        After Hours Menu, Holiday Menu or Submenu.

        The \"Submenu ID\" Column will be left blank when the \"Type\" Column contains one
        of the base menu types (Business Hours Menu, After Hours Menu or Holiday Menu),
        and will contain the Submenu ID when the \"Type\" Column contains type Submenu.

    Attributes:

        submenu_table (OCITable):

    """

    submenu_table: OCITable = field(metadata={"alias": "submenuTable"})

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 GroupAutoAttendantSubmenuGetUsageListRequest

client = Client()

command = GroupAutoAttendantSubmenuGetUsageListRequest(
    service_user_id=...,
    submenu_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAutoAttendantSubmenuGetUsageListRequest",
    service_user_id=...,
    submenu_id=...,
)

print(response)