GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest

Bases: OCIRequest

Request to get the list of all available trunk groups defined in a group. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. The response is either a GroupEnterpriseTrunkGetAvailableTrunkGroupListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

response_size_limit (Optional[int]):

search_criteria_trunk_group_name (Optional[List[SearchCriteriaTrunkGroupName]]):

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

@dataclass(kw_only=True)
class GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest(OCIRequest):
    """Request to get the list of all available trunk groups defined in a group.
        It is possible to search by various criteria to restrict the number of rows returned.
        Multiple search criteria are logically ANDed together.
        The response is either a GroupEnterpriseTrunkGetAvailableTrunkGroupListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_size_limit (Optional[int]):

        search_criteria_trunk_group_name (Optional[List[SearchCriteriaTrunkGroupName]]):

    """

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

    group_id: str = field(metadata={"alias": "groupId"})

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_trunk_group_name: Optional[List[SearchCriteriaTrunkGroupName]] = (
        field(default=None, metadata={"alias": "searchCriteriaTrunkGroupName"})
    )

Responses

Bases: OCIDataResponse

Response to GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest.

Attributes:

trunk_group_name (Optional[List[str]]):

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

@dataclass(kw_only=True)
class GroupEnterpriseTrunkGetAvailableTrunkGroupListResponse(OCIDataResponse):
    """Response to GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest.

    Attributes:

        trunk_group_name (Optional[List[str]]):

    """

    trunk_group_name: Optional[List[str]] = field(
        default=None, metadata={"alias": "trunkGroupName"}
    )

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 GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest

client = Client()

command = GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest(
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_trunk_group_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupEnterpriseTrunkGetAvailableTrunkGroupListRequest",
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_trunk_group_name=...,
)

print(response)