Evo Voice

BillingReport

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

The following routes are available for this service:
All Verbs	/reports/billing

import Foundation
import ServiceStack

public class BillingReport : ReportRequest
{
    public var startDate:String
    public var endDate:String
    public var includeCustomerIds:Bool

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

    private enum CodingKeys : String, CodingKey {
        case startDate
        case endDate
        case includeCustomerIds
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        startDate = try container.decodeIfPresent(String.self, forKey: .startDate)
        endDate = try container.decodeIfPresent(String.self, forKey: .endDate)
        includeCustomerIds = try container.decodeIfPresent(Bool.self, forKey: .includeCustomerIds)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if startDate != nil { try container.encode(startDate, forKey: .startDate) }
        if endDate != nil { try container.encode(endDate, forKey: .endDate) }
        if includeCustomerIds != nil { try container.encode(includeCustomerIds, forKey: .includeCustomerIds) }
    }
}

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

    /**
    * The webhook to call after the report is complete with the data from the report
    */
    // @ApiMember(Description="The webhook to call after the report is complete with the data from the report")
    public var webhookUrl:String

    required public init(){}
}

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 BillingReport DTOs

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

HTTP + JSV

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

POST /reports/billing HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	startDate: String,
	endDate: String,
	includeCustomerIds: False,
	accountId: String,
	emailAddressToNotify: String,
	webhookUrl: String
}

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

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