GroupCallPickupModifyInstanceRequest

Bases: OCIRequest

Modifies a Call Pickup group. Replaces the entire list of users in the group. 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]]):

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

@dataclass(kw_only=True)
class GroupCallPickupModifyInstanceRequest(OCIRequest):
    """Modifies a Call Pickup group. Replaces the entire list of users in the group.
        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]]):

    """

    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"}
    )

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

client = Client()

command = GroupCallPickupModifyInstanceRequest(
    service_provider_id=...,
    group_id=...,
    name=...,
    new_name=...,
    user_id_list=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCallPickupModifyInstanceRequest",
    service_provider_id=...,
    group_id=...,
    name=...,
    new_name=...,
    user_id_list=...,
)

print(response)