Skip to content

GroupFindMeFollowMeAddAlertingGroupSelectiveCriteriaRequest

Bases: OCIRequest

Add a criteria to the Find-me/Follow-me alerting group. For the callToNumber, the extension and number elements are not used and the only types accepted for each number are Primary and Alternates. If other type is specified the command fails. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_user_id (str):

alerting_group_name (str):

criteria_name (str):

time_schedule (Optional[TimeSchedule]):

holiday_schedule (Optional[HolidaySchedule]):

blacklisted (bool):

from_dn_criteria (CriteriaFromDn):

call_to_number (Optional[List[CallToNumber]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupFindMeFollowMeAddAlertingGroupSelectiveCriteriaRequest(OCIRequest):
    """Add a criteria to the Find-me/Follow-me alerting group.
        For the callToNumber, the extension and number elements are not used and the only types accepted for each number are Primary and Alternates. If other type is specified the command fails.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_user_id (str):

        alerting_group_name (str):

        criteria_name (str):

        time_schedule (Optional[TimeSchedule]):

        holiday_schedule (Optional[HolidaySchedule]):

        blacklisted (bool):

        from_dn_criteria (CriteriaFromDn):

        call_to_number (Optional[List[CallToNumber]]):

    """

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

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

    criteria_name: str = field(metadata={"alias": "criteriaName"})

    time_schedule: Optional[TimeSchedule] = field(
        default=None, metadata={"alias": "timeSchedule"}
    )

    holiday_schedule: Optional[HolidaySchedule] = field(
        default=None, metadata={"alias": "holidaySchedule"}
    )

    blacklisted: bool = field(metadata={"alias": "blacklisted"})

    from_dn_criteria: CriteriaFromDn = field(metadata={"alias": "fromDnCriteria"})

    call_to_number: Optional[List[CallToNumber]] = field(
        default=None, metadata={"alias": "callToNumber"}
    )

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupFindMeFollowMeAddAlertingGroupSelectiveCriteriaRequest

client = Client()

command = GroupFindMeFollowMeAddAlertingGroupSelectiveCriteriaRequest(
    service_user_id=...,
    alerting_group_name=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    blacklisted=...,
    from_dn_criteria=...,
    call_to_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupFindMeFollowMeAddAlertingGroupSelectiveCriteriaRequest",
    service_user_id=...,
    alerting_group_name=...,
    criteria_name=...,
    time_schedule=...,
    holiday_schedule=...,
    blacklisted=...,
    from_dn_criteria=...,
    call_to_number=...,
)

print(response)