GroupDepartmentAddRequest

Bases: OCIRequest

Add a department to a group. The response is either a SuccessResponse or an ErrorResponse.

The following elements are only used in AS data mode:
   callingLineIdName
   caliingLineIdPhoneNumber

Attributes:

service_provider_id (str):

group_id (str):

department_name (str):

parent_department_key (Optional[DepartmentKey]):

calling_line_id_name (Optional[str]):

calling_line_id_phone_number (Optional[str]):

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

@dataclass(kw_only=True)
class GroupDepartmentAddRequest(OCIRequest):
    """Add a department to a group.
        The response is either a SuccessResponse or an ErrorResponse.

        The following elements are only used in AS data mode:
           callingLineIdName
           caliingLineIdPhoneNumber

    Attributes:

        service_provider_id (str):

        group_id (str):

        department_name (str):

        parent_department_key (Optional[DepartmentKey]):

        calling_line_id_name (Optional[str]):

        calling_line_id_phone_number (Optional[str]):

    """

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

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

    department_name: str = field(metadata={"alias": "departmentName"})

    parent_department_key: Optional[DepartmentKey] = field(
        default=None, metadata={"alias": "parentDepartmentKey"}
    )

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

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

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 GroupDepartmentAddRequest

client = Client()

command = GroupDepartmentAddRequest(
    service_provider_id=...,
    group_id=...,
    department_name=...,
    parent_department_key=...,
    calling_line_id_name=...,
    calling_line_id_phone_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupDepartmentAddRequest",
    service_provider_id=...,
    group_id=...,
    department_name=...,
    parent_department_key=...,
    calling_line_id_name=...,
    calling_line_id_phone_number=...,
)

print(response)