GroupDialPlanPolicyAddAccessCodeRequest

Bases: OCIRequest

Request to add a Group level Dial Plan Access Code and its all attribues. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

access_code (str):

include_code_for_network_translations_and_routing (bool):

include_code_for_screening_services (bool):

enable_secondary_dial_tone (bool):

description (Optional[str]):

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

@dataclass(kw_only=True)
class GroupDialPlanPolicyAddAccessCodeRequest(OCIRequest):
    """Request to add a Group level Dial Plan Access Code and its all attribues.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        access_code (str):

        include_code_for_network_translations_and_routing (bool):

        include_code_for_screening_services (bool):

        enable_secondary_dial_tone (bool):

        description (Optional[str]):

    """

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

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

    access_code: str = field(metadata={"alias": "accessCode"})

    include_code_for_network_translations_and_routing: bool = field(
        metadata={"alias": "includeCodeForNetworkTranslationsAndRouting"}
    )

    include_code_for_screening_services: bool = field(
        metadata={"alias": "includeCodeForScreeningServices"}
    )

    enable_secondary_dial_tone: bool = field(
        metadata={"alias": "enableSecondaryDialTone"}
    )

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

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 GroupDialPlanPolicyAddAccessCodeRequest

client = Client()

command = GroupDialPlanPolicyAddAccessCodeRequest(
    service_provider_id=...,
    group_id=...,
    access_code=...,
    include_code_for_network_translations_and_routing=...,
    include_code_for_screening_services=...,
    enable_secondary_dial_tone=...,
    description=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupDialPlanPolicyAddAccessCodeRequest",
    service_provider_id=...,
    group_id=...,
    access_code=...,
    include_code_for_network_translations_and_routing=...,
    include_code_for_screening_services=...,
    enable_secondary_dial_tone=...,
    description=...,
)

print(response)