Skip to content

GroupTrunkGroupUserCreationTaskAddRequest14sp4

Bases: OCIRequest

Add a user creation task for a trunk group. The response is either SuccessResponse or ErrorResponse.

Attributes:

trunk_group_key (TrunkGroupKey):

task_name (str):

user_id_format (str):

user_id_domain (str):

populate_extension (bool):

line_port_format (str):

line_port_domain (str):

populate_contact (bool):

contact_format (Optional[str]):

contact_domain (Optional[str]):

user_phone_numbers (Optional[object]):

user_extensions (Optional[object]):

service_pack_name (Optional[List[str]]):

user_service (Optional[List[str]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupTrunkGroupUserCreationTaskAddRequest14sp4(OCIRequest):
    """Add a user creation task for a trunk group.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        trunk_group_key (TrunkGroupKey):

        task_name (str):

        user_id_format (str):

        user_id_domain (str):

        populate_extension (bool):

        line_port_format (str):

        line_port_domain (str):

        populate_contact (bool):

        contact_format (Optional[str]):

        contact_domain (Optional[str]):

        user_phone_numbers (Optional[object]):

        user_extensions (Optional[object]):

        service_pack_name (Optional[List[str]]):

        user_service (Optional[List[str]]):

    """

    trunk_group_key: TrunkGroupKey = field(metadata={"alias": "trunkGroupKey"})

    task_name: str = field(metadata={"alias": "taskName"})

    user_id_format: str = field(metadata={"alias": "userIdFormat"})

    user_id_domain: str = field(metadata={"alias": "userIdDomain"})

    populate_extension: bool = field(metadata={"alias": "populateExtension"})

    line_port_format: str = field(metadata={"alias": "linePortFormat"})

    line_port_domain: str = field(metadata={"alias": "linePortDomain"})

    populate_contact: bool = field(metadata={"alias": "populateContact"})

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

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

    user_phone_numbers: Optional[object] = field(
        default=None, metadata={"alias": "userPhoneNumbers"}
    )

    user_extensions: Optional[object] = field(
        default=None, metadata={"alias": "userExtensions"}
    )

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

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

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 GroupTrunkGroupUserCreationTaskAddRequest14sp4

client = Client()

command = GroupTrunkGroupUserCreationTaskAddRequest14sp4(
    trunk_group_key=...,
    task_name=...,
    user_id_format=...,
    user_id_domain=...,
    populate_extension=...,
    line_port_format=...,
    line_port_domain=...,
    populate_contact=...,
    contact_format=...,
    contact_domain=...,
    user_phone_numbers=...,
    user_extensions=...,
    service_pack_name=...,
    user_service=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupTrunkGroupUserCreationTaskAddRequest14sp4",
    trunk_group_key=...,
    task_name=...,
    user_id_format=...,
    user_id_domain=...,
    populate_extension=...,
    line_port_format=...,
    line_port_domain=...,
    populate_contact=...,
    contact_format=...,
    contact_domain=...,
    user_phone_numbers=...,
    user_extensions=...,
    service_pack_name=...,
    user_service=...,
)

print(response)