Skip to content

GroupDialPlanPolicyModifyAccessCodeRequest

Bases: OCIRequest

Request to modify a Group level Dial Plan Access Code and its 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 (Optional[bool]):

include_code_for_screening_services (Optional[bool]):

enable_secondary_dial_tone (Optional[bool]):

description (Optional[Nillable[str]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupDialPlanPolicyModifyAccessCodeRequest(OCIRequest):
    """Request to modify a Group level Dial Plan Access Code and its 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 (Optional[bool]):

        include_code_for_screening_services (Optional[bool]):

        enable_secondary_dial_tone (Optional[bool]):

        description (Optional[Nillable[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: Optional[bool] = field(
        default=None, metadata={"alias": "includeCodeForNetworkTranslationsAndRouting"}
    )

    include_code_for_screening_services: Optional[bool] = field(
        default=None, metadata={"alias": "includeCodeForScreeningServices"}
    )

    enable_secondary_dial_tone: Optional[bool] = field(
        default=None, metadata={"alias": "enableSecondaryDialTone"}
    )

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

    def __post_init__(self):
        nillable_fields = ["description"]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

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 GroupDialPlanPolicyModifyAccessCodeRequest

client = Client()

command = GroupDialPlanPolicyModifyAccessCodeRequest(
    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("GroupDialPlanPolicyModifyAccessCodeRequest",
    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)