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 Foundation
import ServiceStack

/**
* Update a specific alert
*/
// @Api(Description="Update a specific alert")
public class PatchAlert : IPatch, Codable
{
    /**
    * The ID of the alert you want to update
    */
    // @ApiMember(Description="The ID of the alert you want to update")
    public var alertId:String

    /**
    * The name for the alert
    */
    // @ApiMember(Description="The name for the alert")
    public var name:String

    /**
    * The trigger alert
    */
    // @ApiMember(Description="The trigger alert")
    public var trigger:AlertTriggers?

    /**
    * The number of hours for the window over which the alert will trigger
    */
    // @ApiMember(Description="The number of hours for the window over which the alert will trigger")
    public var windowHours:Double?

    /**
    * The value at which the alert will trigger
    */
    // @ApiMember(Description="The value at which the alert will trigger")
    public var threshold:Double?

    /**
    * The email addresses (one per line) to notify
    */
    // @ApiMember(Description="The email addresses (one per line) to notify")
    public var notificationEmailAddresses:String

    required public init(){}
}

public enum AlertTriggers : String, Codable
{
    case CallSpend
}

public class AlertInfo : EntityInfo
{
    /**
    * The ID of the account associated with this alert
    */
    // @ApiMember(Description="The ID of the account associated with this alert")
    public var accountId:String

    /**
    * The name of the alert
    */
    // @ApiMember(Description="The name of the alert")
    public var name:String

    /**
    * The trigger alert
    */
    // @ApiMember(Description="The trigger alert")
    public var trigger:AlertTriggers

    /**
    * The number of hours for the window over which the alert will trigger
    */
    // @ApiMember(Description="The number of hours for the window over which the alert will trigger")
    public var windowHours:Double

    /**
    * The value at which the alert will trigger
    */
    // @ApiMember(Description="The value at which the alert will trigger")
    public var threshold:Double

    /**
    * The email addresses (one per line) to notify
    */
    // @ApiMember(Description="The email addresses (one per line) to notify")
    public var notificationEmailAddresses:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case accountId
        case name
        case trigger
        case windowHours
        case threshold
        case notificationEmailAddresses
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        accountId = try container.decodeIfPresent(String.self, forKey: .accountId)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        trigger = try container.decodeIfPresent(AlertTriggers.self, forKey: .trigger)
        windowHours = try container.decodeIfPresent(Double.self, forKey: .windowHours)
        threshold = try container.decodeIfPresent(Double.self, forKey: .threshold)
        notificationEmailAddresses = try container.decodeIfPresent(String.self, forKey: .notificationEmailAddresses)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if accountId != nil { try container.encode(accountId, forKey: .accountId) }
        if name != nil { try container.encode(name, forKey: .name) }
        if trigger != nil { try container.encode(trigger, forKey: .trigger) }
        if windowHours != nil { try container.encode(windowHours, forKey: .windowHours) }
        if threshold != nil { try container.encode(threshold, forKey: .threshold) }
        if notificationEmailAddresses != nil { try container.encode(notificationEmailAddresses, forKey: .notificationEmailAddresses) }
    }
}

public class EntityInfo : Codable
{
    /**
    * The ID of the object
    */
    // @ApiMember(Description="The ID of the object")
    public var id:String

    /**
    * The date the object was created
    */
    // @ApiMember(Description="The date the object was created")
    public var dateCreated:String

    /**
    * The date the object was last modified
    */
    // @ApiMember(Description="The date the object was last modified")
    public var dateLastModified:String

    /**
    * The user that created this object
    */
    // @ApiMember(Description="The user that created this object")
    public var createdBy:String

    /**
    * The user that last modified this object
    */
    // @ApiMember(Description="The user that last modified this object")
    public var lastModifiedBy:String

    required public init(){}
}

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