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}

"use strict";
export class EntityInfo {
    /** @param {{id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the object */
    id;
    /**
     * @type {string}
     * @description The date the object was created */
    dateCreated;
    /**
     * @type {string}
     * @description The date the object was last modified */
    dateLastModified;
    /**
     * @type {string}
     * @description The user that created this object */
    createdBy;
    /**
     * @type {string}
     * @description The user that last modified this object */
    lastModifiedBy;
}
/** @typedef {'CallSpend'} */
export var AlertTriggers;
(function (AlertTriggers) {
    AlertTriggers["CallSpend"] = "CallSpend"
})(AlertTriggers || (AlertTriggers = {}));
export class AlertInfo extends EntityInfo {
    /** @param {{accountId?:string,name?:string,trigger?:AlertTriggers,windowHours?:number,threshold?:number,notificationEmailAddresses?:string,id?:string,dateCreated?:string,dateLastModified?:string,createdBy?:string,lastModifiedBy?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the account associated with this alert */
    accountId;
    /**
     * @type {string}
     * @description The name of the alert */
    name;
    /**
     * @type {AlertTriggers}
     * @description The trigger alert */
    trigger;
    /**
     * @type {number}
     * @description The number of hours for the window over which the alert will trigger */
    windowHours;
    /**
     * @type {number}
     * @description The value at which the alert will trigger */
    threshold;
    /**
     * @type {string}
     * @description The email addresses (one per line) to notify */
    notificationEmailAddresses;
}
export class PatchAlert {
    /** @param {{alertId?:string,name?:string,trigger?:AlertTriggers,windowHours?:number,threshold?:number,notificationEmailAddresses?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the alert you want to update */
    alertId;
    /**
     * @type {string}
     * @description The name for the alert */
    name;
    /**
     * @type {?AlertTriggers}
     * @description The trigger alert */
    trigger;
    /**
     * @type {?number}
     * @description The number of hours for the window over which the alert will trigger */
    windowHours;
    /**
     * @type {?number}
     * @description The value at which the alert will trigger */
    threshold;
    /**
     * @type {string}
     * @description The email addresses (one per line) to notify */
    notificationEmailAddresses;
}

JavaScript 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>