Evo Voice

<back to all web services

EndpointsReport

This report returns all of the endpoints broken down by type per tab

import Foundation
import ServiceStack

/**
* This report returns all of the endpoints broken down by type per tab
*/
// @Api(Description="This report returns all of the endpoints broken down by type per tab")
public class EndpointsReport : ReportRequest
{
    /**
    * The types of endpoints to return
    */
    // @ApiMember(Description="The types of endpoints to return")
    public var types:[EndpointTypes] = []

    /**
    * Filter by specific customer
    */
    // @ApiMember(Description="Filter by specific customer")
    public var customerId:String?

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

    private enum CodingKeys : String, CodingKey {
        case types
        case customerId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        types = try container.decodeIfPresent([EndpointTypes].self, forKey: .types) ?? []
        customerId = try container.decodeIfPresent(String.self, forKey: .customerId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if types.count > 0 { try container.encode(types, forKey: .types) }
        if customerId != nil { try container.encode(customerId, forKey: .customerId) }
    }
}

public class ReportRequest : IPost, Codable
{
    /**
    * The account ID this report should be run for
    */
    // @ApiMember(Description="The account ID this report should be run for")
    public var accountId:String?

    /**
    * The email address to notify after the report is run
    */
    // @ApiMember(Description="The email address to notify after the report is run")
    public var emailAddressToNotify:String?

    required public init(){}
}

public enum EndpointTypes : String, Codable
{
    case PhoneNumber
    case User
    case FaxNumber
    case EmailAddress
    case Unused_1
    case Unused_2
    case Unused_3
    case Unused_4
    case Unused_5
    case Team
}

public class ReportInfo : Codable
{
    public var id:String?
    public var name:String?
    public var status:ReportStatuses?
    public var statusMessage:String?
    public var dateCreated:String?
    public var dateUpdated:String?
    public var downloadLink:String?
    public var jobId:String?
    public var emailAddressToNotify:String?
    public var server:String?

    required public init(){}
}

public enum ReportStatuses : String, Codable
{
    case Queued
    case Running
    case Completed
    case Error
}

Swift EndpointsReport DTOs

GET /reports/endpoints HTTP/1.1 
Host: evovoice.io 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":"String","name":"String","status":"Queued","statusMessage":"String","dateCreated":"String","dateUpdated":"String","downloadLink":"String","jobId":"String","emailAddressToNotify":"String","server":"String"}