EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest

Bases: OCIRequest

Request to get the list of all available trunk groups defined in an enterprise. 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 EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

response_size_limit (Optional[int]):

search_criteria_trunk_group_name (Optional[List[SearchCriteriaTrunkGroupName]]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

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

@dataclass(kw_only=True)
class EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest(OCIRequest):
    """Request to get the list of all available trunk groups defined in an enterprise.  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 EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        response_size_limit (Optional[int]):

        search_criteria_trunk_group_name (Optional[List[SearchCriteriaTrunkGroupName]]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

    """

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

    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"})
    )

    search_criteria_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

Responses

Bases: OCIDataResponse

Response to EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest.

Attributes:

trunk_group (Optional[List[EnterpriseTrunkTrunkGroupKey]]):

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

@dataclass(kw_only=True)
class EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListResponse(OCIDataResponse):
    """Response to EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest.

    Attributes:

        trunk_group (Optional[List[EnterpriseTrunkTrunkGroupKey]]):

    """

    trunk_group: Optional[List[EnterpriseTrunkTrunkGroupKey]] = field(
        default=None, metadata={"alias": "trunkGroup"}
    )

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 EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest

client = Client()

command = EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest(
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_trunk_group_name=...,
    search_criteria_group_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("EnterpriseEnterpriseTrunkGetAvailableTrunkGroupListRequest",
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_trunk_group_name=...,
    search_criteria_group_id=...,
)

print(response)