Skip to content

ServiceProviderDialableCallerIDCriteriaAddRequest

Bases: OCIRequest

Add a new Dialable Caller ID Criteria. Criteria are added at the bottom of the list with the lowest priority. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

name (str):

description (Optional[str]):

prefix_digits (Optional[str]):

match_call_type (Optional[List[str]]):

match_alternate_call_indicator (Optional[List[str]]):

match_local_category (bool):

match_national_category (bool):

match_interlata_category (bool):

match_intralata_category (bool):

match_international_category (bool):

match_private_category (bool):

match_emergency_category (bool):

match_other_category (bool):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderDialableCallerIDCriteriaAddRequest(OCIRequest):
    """Add a new Dialable Caller ID Criteria. Criteria are added at the bottom of the list with the lowest priority. The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        name (str):

        description (Optional[str]):

        prefix_digits (Optional[str]):

        match_call_type (Optional[List[str]]):

        match_alternate_call_indicator (Optional[List[str]]):

        match_local_category (bool):

        match_national_category (bool):

        match_interlata_category (bool):

        match_intralata_category (bool):

        match_international_category (bool):

        match_private_category (bool):

        match_emergency_category (bool):

        match_other_category (bool):

    """

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

    name: str = field(metadata={"alias": "name"})

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

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

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

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

    match_local_category: bool = field(metadata={"alias": "matchLocalCategory"})

    match_national_category: bool = field(metadata={"alias": "matchNationalCategory"})

    match_interlata_category: bool = field(metadata={"alias": "matchInterlataCategory"})

    match_intralata_category: bool = field(metadata={"alias": "matchIntralataCategory"})

    match_international_category: bool = field(
        metadata={"alias": "matchInternationalCategory"}
    )

    match_private_category: bool = field(metadata={"alias": "matchPrivateCategory"})

    match_emergency_category: bool = field(metadata={"alias": "matchEmergencyCategory"})

    match_other_category: bool = field(metadata={"alias": "matchOtherCategory"})

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 ServiceProviderDialableCallerIDCriteriaAddRequest

client = Client()

command = ServiceProviderDialableCallerIDCriteriaAddRequest(
    service_provider_id=...,
    name=...,
    description=...,
    prefix_digits=...,
    match_call_type=...,
    match_alternate_call_indicator=...,
    match_local_category=...,
    match_national_category=...,
    match_interlata_category=...,
    match_intralata_category=...,
    match_international_category=...,
    match_private_category=...,
    match_emergency_category=...,
    match_other_category=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderDialableCallerIDCriteriaAddRequest",
    service_provider_id=...,
    name=...,
    description=...,
    prefix_digits=...,
    match_call_type=...,
    match_alternate_call_indicator=...,
    match_local_category=...,
    match_national_category=...,
    match_interlata_category=...,
    match_intralata_category=...,
    match_international_category=...,
    match_private_category=...,
    match_emergency_category=...,
    match_other_category=...,
)

print(response)