GroupCallParkModifyInstanceRequest

Bases: OCIRequest

Modifies a Call Park group. Replaces the entire list of users in the group. The users are in the list are in the order they will try to be parked on. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

name (str):

new_name (Optional[str]):

user_id_list (Optional[Nillable[ReplacementUserIdList]]):

recall_alternate_user_id (Optional[Nillable[str]]):

recall_to (Optional[str]):

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

@dataclass(kw_only=True)
class GroupCallParkModifyInstanceRequest(OCIRequest):
    """Modifies a Call Park group. Replaces the entire list of users in the group.
        The users are in the list are in the order they will try to be parked on.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        name (str):

        new_name (Optional[str]):

        user_id_list (Optional[Nillable[ReplacementUserIdList]]):

        recall_alternate_user_id (Optional[Nillable[str]]):

        recall_to (Optional[str]):

    """

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

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

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

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

    user_id_list: Optional[Nillable[ReplacementUserIdList]] = field(
        default=None, metadata={"alias": "userIdList"}
    )

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

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

    def __post_init__(self):
        nillable_fields = ["user_id_list", "recall_alternate_user_id"]
        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_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 GroupCallParkModifyInstanceRequest

client = Client()

command = GroupCallParkModifyInstanceRequest(
    service_provider_id=...,
    group_id=...,
    name=...,
    new_name=...,
    user_id_list=...,
    recall_alternate_user_id=...,
    recall_to=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupCallParkModifyInstanceRequest",
    service_provider_id=...,
    group_id=...,
    name=...,
    new_name=...,
    user_id_list=...,
    recall_alternate_user_id=...,
    recall_to=...,
)

print(response)