EnterpriseVoiceVPNAddPolicyRequest

Bases: OCIRequest

Add the enterprise level data associated with a Voice VPN location code. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

location_dialing_code (str):

min_extension_length (int):

max_extension_length (int):

description (Optional[str]):

route_group_id (Optional[str]):

policy_selection (str):

digit_manipulation (Optional[List[EnterpriseVoiceVPNDigitManipulation]]):

treatment_id (Optional[str]):

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

@dataclass(kw_only=True)
class EnterpriseVoiceVPNAddPolicyRequest(OCIRequest):
    """Add the enterprise level data associated with a Voice VPN location code.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        location_dialing_code (str):

        min_extension_length (int):

        max_extension_length (int):

        description (Optional[str]):

        route_group_id (Optional[str]):

        policy_selection (str):

        digit_manipulation (Optional[List[EnterpriseVoiceVPNDigitManipulation]]):

        treatment_id (Optional[str]):

    """

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

    location_dialing_code: str = field(metadata={"alias": "locationDialingCode"})

    min_extension_length: int = field(metadata={"alias": "minExtensionLength"})

    max_extension_length: int = field(metadata={"alias": "maxExtensionLength"})

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

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

    policy_selection: str = field(metadata={"alias": "policySelection"})

    digit_manipulation: Optional[List[EnterpriseVoiceVPNDigitManipulation]] = field(
        default=None, metadata={"alias": "digitManipulation"}
    )

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

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 EnterpriseVoiceVPNAddPolicyRequest

client = Client()

command = EnterpriseVoiceVPNAddPolicyRequest(
    service_provider_id=...,
    location_dialing_code=...,
    min_extension_length=...,
    max_extension_length=...,
    description=...,
    route_group_id=...,
    policy_selection=...,
    digit_manipulation=...,
    treatment_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterpriseVoiceVPNAddPolicyRequest",
    service_provider_id=...,
    location_dialing_code=...,
    min_extension_length=...,
    max_extension_length=...,
    description=...,
    route_group_id=...,
    policy_selection=...,
    digit_manipulation=...,
    treatment_id=...,
)

print(response)