Skip to content

GroupFindMeFollowMeModifyAlertingGroupRequest

Bases: OCIRequest

Modify a Find-me/Follow-me alerting group. The response is either SuccessResponse or ErrorResponse.

Attributes:

service_user_id (str):

alerting_group_name (str):

new_alerting_group_name (Optional[str]):

alerting_group_description (Optional[Nillable[str]]):

use_diversion_inhibitor (Optional[bool]):

answer_confirmation_required (Optional[bool]):

number_of_rings (Optional[int]):

phone_number_or_user_list (Optional[Nillable[FindMeFollowMeAlertingGroupReplacementOutgoingDNSIPURIorUserIdList]]):

criteria_activation (Optional[List[CriteriaActivation]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupFindMeFollowMeModifyAlertingGroupRequest(OCIRequest):
    """Modify a Find-me/Follow-me alerting group.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_user_id (str):

        alerting_group_name (str):

        new_alerting_group_name (Optional[str]):

        alerting_group_description (Optional[Nillable[str]]):

        use_diversion_inhibitor (Optional[bool]):

        answer_confirmation_required (Optional[bool]):

        number_of_rings (Optional[int]):

        phone_number_or_user_list (Optional[Nillable[FindMeFollowMeAlertingGroupReplacementOutgoingDNSIPURIorUserIdList]]):

        criteria_activation (Optional[List[CriteriaActivation]]):

    """

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

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

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

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

    use_diversion_inhibitor: Optional[bool] = field(
        default=None, metadata={"alias": "useDiversionInhibitor"}
    )

    answer_confirmation_required: Optional[bool] = field(
        default=None, metadata={"alias": "answerConfirmationRequired"}
    )

    number_of_rings: Optional[int] = field(
        default=None, metadata={"alias": "numberOfRings"}
    )

    phone_number_or_user_list: Optional[
        Nillable[FindMeFollowMeAlertingGroupReplacementOutgoingDNSIPURIorUserIdList]
    ] = field(default=None, metadata={"alias": "phoneNumberOrUserList"})

    criteria_activation: Optional[List[CriteriaActivation]] = field(
        default=None, metadata={"alias": "criteriaActivation"}
    )

    def __post_init__(self):
        nillable_fields = ["alerting_group_description", "phone_number_or_user_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 GroupFindMeFollowMeModifyAlertingGroupRequest

client = Client()

command = GroupFindMeFollowMeModifyAlertingGroupRequest(
    service_user_id=...,
    alerting_group_name=...,
    new_alerting_group_name=...,
    alerting_group_description=...,
    use_diversion_inhibitor=...,
    answer_confirmation_required=...,
    number_of_rings=...,
    phone_number_or_user_list=...,
    criteria_activation=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupFindMeFollowMeModifyAlertingGroupRequest",
    service_user_id=...,
    alerting_group_name=...,
    new_alerting_group_name=...,
    alerting_group_description=...,
    use_diversion_inhibitor=...,
    answer_confirmation_required=...,
    number_of_rings=...,
    phone_number_or_user_list=...,
    criteria_activation=...,
)

print(response)