Evo Voice

PatchAlert

Update a specific alert

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
PATCH	/alerts/{alertId}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EntityInfo:
    # @ApiMember(Description="The ID of the object")
    id: Optional[str] = None
    """
    The ID of the object
    """


    # @ApiMember(Description="The date the object was created")
    date_created: Optional[str] = None
    """
    The date the object was created
    """


    # @ApiMember(Description="The date the object was last modified")
    date_last_modified: Optional[str] = None
    """
    The date the object was last modified
    """


    # @ApiMember(Description="The user that created this object")
    created_by: Optional[str] = None
    """
    The user that created this object
    """


    # @ApiMember(Description="The user that last modified this object")
    last_modified_by: Optional[str] = None
    """
    The user that last modified this object
    """


class AlertTriggers(str, Enum):
    CALL_SPEND = 'CallSpend'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AlertInfo(EntityInfo):
    # @ApiMember(Description="The ID of the account associated with this alert")
    account_id: Optional[str] = None
    """
    The ID of the account associated with this alert
    """


    # @ApiMember(Description="The name of the alert")
    name: Optional[str] = None
    """
    The name of the alert
    """


    # @ApiMember(Description="The trigger alert")
    trigger: Optional[AlertTriggers] = None
    """
    The trigger alert
    """


    # @ApiMember(Description="The number of hours for the window over which the alert will trigger")
    window_hours: float = 0.0
    """
    The number of hours for the window over which the alert will trigger
    """


    # @ApiMember(Description="The value at which the alert will trigger")
    threshold: float = 0.0
    """
    The value at which the alert will trigger
    """


    # @ApiMember(Description="The email addresses (one per line) to notify")
    notification_email_addresses: Optional[str] = None
    """
    The email addresses (one per line) to notify
    """


# @Api(Description="Update a specific alert")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PatchAlert(IPatch):
    """
    Update a specific alert
    """

    # @ApiMember(Description="The ID of the alert you want to update")
    alert_id: Optional[str] = None
    """
    The ID of the alert you want to update
    """


    # @ApiMember(Description="The name for the alert")
    name: Optional[str] = None
    """
    The name for the alert
    """


    # @ApiMember(Description="The trigger alert")
    trigger: Optional[AlertTriggers] = None
    """
    The trigger alert
    """


    # @ApiMember(Description="The number of hours for the window over which the alert will trigger")
    window_hours: Optional[float] = None
    """
    The number of hours for the window over which the alert will trigger
    """


    # @ApiMember(Description="The value at which the alert will trigger")
    threshold: Optional[float] = None
    """
    The value at which the alert will trigger
    """


    # @ApiMember(Description="The email addresses (one per line) to notify")
    notification_email_addresses: Optional[str] = None
    """
    The email addresses (one per line) to notify
    """

Python PatchAlert DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /alerts/{alertId} HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchAlert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Alerts">
  <AlertId>String</AlertId>
  <Name>String</Name>
  <NotificationEmailAddresses>String</NotificationEmailAddresses>
  <Threshold>0</Threshold>
  <Trigger>CallSpend</Trigger>
  <WindowHours>0</WindowHours>
</PatchAlert>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AlertInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Alerts">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
  <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
  <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
  <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
  <AccountId>String</AccountId>
  <Name>String</Name>
  <NotificationEmailAddresses>String</NotificationEmailAddresses>
  <Threshold>0</Threshold>
  <Trigger>CallSpend</Trigger>
  <WindowHours>0</WindowHours>
</AlertInfo>