Requires any of the roles: | SystemAdministrator, Manager, Customer |
All Verbs | /reports/sync-phone-numbers |
---|
import Foundation
import ServiceStack
public class SyncPhoneNumbersReport : ReportRequest
{
public var syncDocumoNumbers:Bool?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case syncDocumoNumbers
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
syncDocumoNumbers = try container.decodeIfPresent(Bool.self, forKey: .syncDocumoNumbers)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if syncDocumoNumbers != nil { try container.encode(syncDocumoNumbers, forKey: .syncDocumoNumbers) }
}
}
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 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 SyncPhoneNumbersReport DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /reports/sync-phone-numbers HTTP/1.1
Host: evovoice.io
Accept: application/json
Content-Type: application/json
Content-Length: length
{"syncDocumoNumbers":false,"accountId":"String","emailAddressToNotify":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"id":"String","name":"String","status":"Queued","statusMessage":"String","dateCreated":"String","dateUpdated":"String","downloadLink":"String","jobId":"String","emailAddressToNotify":"String","server":"String"}