GroupFindMeFollowMeAddAlertingGroupRequest

Bases: OCIRequest

Add an alerting group to a Find-me/Follow-me instance. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_user_id (str):

alerting_group_name (str):

alerting_group_description (Optional[str]):

use_diversion_inhibitor (bool):

answer_confirmation_required (bool):

number_of_rings (int):

phone_number (Optional[str]):

user_id (Optional[str]):

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

@dataclass(kw_only=True)
class GroupFindMeFollowMeAddAlertingGroupRequest(OCIRequest):
    """Add an alerting group to a Find-me/Follow-me instance.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_user_id (str):

        alerting_group_name (str):

        alerting_group_description (Optional[str]):

        use_diversion_inhibitor (bool):

        answer_confirmation_required (bool):

        number_of_rings (int):

        phone_number (Optional[str]):

        user_id (Optional[str]):

    """

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

    alerting_group_name: str = field(metadata={"alias": "alertingGroupName"})

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

    use_diversion_inhibitor: bool = field(metadata={"alias": "useDiversionInhibitor"})

    answer_confirmation_required: bool = field(
        metadata={"alias": "answerConfirmationRequired"}
    )

    number_of_rings: int = field(metadata={"alias": "numberOfRings"})

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

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

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 GroupFindMeFollowMeAddAlertingGroupRequest

client = Client()

command = GroupFindMeFollowMeAddAlertingGroupRequest(
    service_user_id=...,
    alerting_group_name=...,
    alerting_group_description=...,
    use_diversion_inhibitor=...,
    answer_confirmation_required=...,
    number_of_rings=...,
    phone_number=...,
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupFindMeFollowMeAddAlertingGroupRequest",
    service_user_id=...,
    alerting_group_name=...,
    alerting_group_description=...,
    use_diversion_inhibitor=...,
    answer_confirmation_required=...,
    number_of_rings=...,
    phone_number=...,
    user_id=...,
)

print(response)