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
/**
* 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 SyncPhoneNumbersReport DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: team.evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SyncPhoneNumbersReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Reports">
<AccountId>String</AccountId>
<EmailAddressToNotify>String</EmailAddressToNotify>
<WebhookUrl>String</WebhookUrl>
<SyncDocumoNumbers>false</SyncDocumoNumbers>
</SyncPhoneNumbersReport>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ReportInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Reports"> <DateCreated>String</DateCreated> <DateUpdated>String</DateUpdated> <DownloadLink>String</DownloadLink> <EmailAddressToNotify>String</EmailAddressToNotify> <Id>String</Id> <JobId>String</JobId> <Name>String</Name> <Server>String</Server> <Status>Queued</Status> <StatusMessage>String</StatusMessage> </ReportInfo>