GroupDialableCallerIDModifyRequest

Bases: OCIRequest

Modify the group's Dialable Caller ID settings and criteria list. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

use_group_criteria (Optional[bool]):

ns_screening_failure_policy (Optional[str]):

criteria_priority_order (Optional[List[DialableCallerIDCriteriaPriorityOrder]]):

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

@dataclass(kw_only=True)
class GroupDialableCallerIDModifyRequest(OCIRequest):
    """Modify the group's Dialable Caller ID settings and criteria list.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        use_group_criteria (Optional[bool]):

        ns_screening_failure_policy (Optional[str]):

        criteria_priority_order (Optional[List[DialableCallerIDCriteriaPriorityOrder]]):

    """

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

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

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

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

    criteria_priority_order: Optional[List[DialableCallerIDCriteriaPriorityOrder]] = (
        field(default=None, metadata={"alias": "criteriaPriorityOrder"})
    )

Responses

Bases: OCIResponse

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

class SuccessResponse(OCIResponse):
    pass

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 GroupDialableCallerIDModifyRequest

client = Client()

command = GroupDialableCallerIDModifyRequest(
    service_provider_id=...,
    group_id=...,
    use_group_criteria=...,
    ns_screening_failure_policy=...,
    criteria_priority_order=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupDialableCallerIDModifyRequest",
    service_provider_id=...,
    group_id=...,
    use_group_criteria=...,
    ns_screening_failure_policy=...,
    criteria_priority_order=...,
)

print(response)