Evo Voice

<back to all web services

PatchCustomer

Update a specific customer

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
PATCH/customers/{customerId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Update a specific customer
*/
@Api(Description="Update a specific customer")
open class PatchCustomer : IPatch
{
    /**
    * The ID of the customer you want to update
    */
    @ApiMember(Description="The ID of the customer you want to update")
    open var customerId:String? = null

    /**
    * The name for the customer
    */
    @ApiMember(Description="The name for the customer")
    open var name:String? = null

    /**
    * The parent customer for this customer
    */
    @ApiMember(Description="The parent customer for this customer")
    open var parentCustomerId:String? = null

    /**
    * The reference ID for this customer (e.g. in a third party system)
    */
    @ApiMember(Description="The reference ID for this customer (e.g. in a third party system)")
    open var referenceId:String? = null

    /**
    * Data values for this customer
    */
    @ApiMember(Description="Data values for this customer")
    @SerializedName("data") open var Data:Struct? = null

    /**
    * The list of tag IDs for this customer
    */
    @ApiMember(Description="The list of tag IDs for this customer")
    open var tagIds:ArrayList<String>? = null

    /**
    * This customer's schedule
    */
    @ApiMember(Description="This customer's schedule")
    open var schedule:Schedule? = null

    /**
    * Override this customer's billing settings? Otherwise inherits from parent
    */
    @ApiMember(Description="Override this customer's billing settings? Otherwise inherits from parent")
    open var overrideBillingSettings:Boolean? = null

    /**
    * Updated billing settings for this customer
    */
    @ApiMember(Description="Updated billing settings for this customer")
    open var billingSettings:BillingSettings? = null

    /**
    * Should this customer override the parent customer's app settings
    */
    @ApiMember(Description="Should this customer override the parent customer's app settings")
    open var overrideAppSettings:Boolean? = null

    /**
    * App / Portal settings for this customer
    */
    @ApiMember(Description="App / Portal settings for this customer")
    open var appSettings:AppSettings? = null
}

open class Struct : HashMap<String,Value>()
{
}

open class Value
{
    open var boolValue:Boolean? = null
    open var stringValue:String? = null
    open var numberValue:Double? = null
    open var listValue:ArrayList<Struct>? = null
    open var structValue:Struct? = null
}

open class Schedule
{
    open var timeZoneId:String? = null
    open var inherit:Boolean? = null
    open var forceClosed:Boolean? = null
    open var rules:ArrayList<SchedulingRule>? = null
    open var defaultState:String? = null
}

open class SchedulingRule
{
    open var id:String? = null
    open var name:String? = null
    open var priority:Int? = null
    open var state:String? = null
    open var source:String? = null
    open var condition:String? = null
    open var simpleRuleType:SimpleSchedulingRuleTypes? = null
    open var customerState:String? = null
    open var flowId:String? = null
    open var flowParams:Struct? = null
    open var isAllDay:Boolean? = null
    open var startDate:String? = null
    open var startTime:String? = null
    open var endTime:String? = null
    open var bySetPosition:ArrayList<Int>? = null
    open var byMonth:ArrayList<Int>? = null
    open var byWeekNo:ArrayList<Int>? = null
    open var byYearDay:ArrayList<Int>? = null
    open var byMonthDay:ArrayList<Int>? = null
    open var byDay:ArrayList<ScheduleDay>? = null
    open var byHour:ArrayList<Int>? = null
    open var byMinute:ArrayList<Int>? = null
    open var interval:Int? = null
    open var count:Int? = null
    open var untilDate:String? = null
    open var frequency:SchedulingRuleFrequency? = null
}

enum class SimpleSchedulingRuleTypes
{
    Always,
    CustomerState,
    Time,
}

open class ScheduleDay
{
    open var offset:Int? = null
    open var dayOfWeek:DayOfWeek? = null
}

enum class SchedulingRuleFrequency
{
    None,
    Secondly,
    Minutely,
    Hourly,
    Daily,
    Weekly,
    Monthly,
    Yearly,
}

open class BillingSettings
{
    open var base:BillingItem? = null
    open var localNumbers:BillingItem? = null
    open var tollFreeNumbers:BillingItem? = null
    open var inboundVoiceCalls:BillingItem? = null
    open var outboundVoiceCalls:BillingItem? = null
    open var inboundFaxes:BillingItem? = null
    open var outboundFaxes:BillingItem? = null
    open var inboundSmsMessages:BillingItem? = null
    open var outboundSmsMessages:BillingItem? = null
    open var aiInsights:BillingItem? = null
    open var aiLiveMinutes:BillingItem? = null
}

open class BillingItem
{
    open var baseCost:Double? = null
    open var rawUnitMultiplier:Double? = null
    open var unitCost:Double? = null
    open var allowance:Int? = null
}

open class AppSettings
{
    open var enablePhoneNumberManagement:Boolean? = null
    open var enableDeviceManagement:Boolean? = null
    open var enableDialer:Boolean? = null
    open var enableCallHistory:Boolean? = null
    open var enableAssistants:Boolean? = null
    open var showFileNameInMessageCenter:Boolean? = null
    open var chakraTheme:String? = null
    open var customCss:String? = null
    open var pageTitle:String? = null
    open var stringMappings:String? = null
    open var logoutUrl:String? = null
    open var portMyNumberUrl:String? = null
}

open class CustomerInfo : EntityInfo()
{
    /**
    * The ID of the account associated with this customer
    */
    @ApiMember(Description="The ID of the account associated with this customer")
    open var accountId:String? = null

    /**
    * The parent customer ID for this customer
    */
    @ApiMember(Description="The parent customer ID for this customer")
    open var parentCustomerId:String? = null

    /**
    * The breadcrumb to this customer
    */
    @ApiMember(Description="The breadcrumb to this customer")
    open var breadcrumb:ArrayList<CustomerBreadcrumb>? = null

    /**
    * The name of the account associated with this customer
    */
    @ApiMember(Description="The name of the account associated with this customer")
    open var accountName:String? = null

    /**
    * Is this customer staging or production?
    */
    @ApiMember(Description="Is this customer staging or production?")
    open var isStaging:Boolean? = null

    /**
    * The name of the company
    */
    @ApiMember(Description="The name of the company")
    open var name:String? = null

    /**
    * The reference ID for this company
    */
    @ApiMember(Description="The reference ID for this company")
    open var referenceId:String? = null

    /**
    * This customer's data values
    */
    @ApiMember(Description="This customer's data values")
    @SerializedName("data") open var Data:Struct? = null

    /**
    * The list of tags for this customer
    */
    @ApiMember(Description="The list of tags for this customer")
    open var tags:ArrayList<Tag>? = null

    /**
    * This customer's schedule
    */
    @ApiMember(Description="This customer's schedule")
    open var schedule:Schedule? = null

    /**
    * Integration data for this customer
    */
    @ApiMember(Description="Integration data for this customer")
    open var integrationData:EntityIntegrationData? = null

    /**
    * Override this customer's billing settings? Otherwise inherits from parent
    */
    @ApiMember(Description="Override this customer's billing settings? Otherwise inherits from parent")
    open var overrideBillingSettings:Boolean? = null

    /**
    * Billing settings for this customer
    */
    @ApiMember(Description="Billing settings for this customer")
    open var billingSettings:BillingSettings? = null

    /**
    * Should this customer override the parent customer's app settings
    */
    @ApiMember(Description="Should this customer override the parent customer's app settings")
    open var overrideAppSettings:Boolean? = null

    /**
    * App / Portal settings for this customer
    */
    @ApiMember(Description="App / Portal settings for this customer")
    open var appSettings:AppSettings? = null
}

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

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

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

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

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

open class CustomerBreadcrumb
{
    open var id:String? = null
    open var name:String? = null
}

open class Tag
{
    open var id:String? = null
    open var name:String? = null
    open var color:TagColors? = null
}

enum class TagColors
{
    Magenta,
    Red,
    Volcano,
    Orange,
    Gold,
    Lime,
    Green,
    Cyan,
    Blue,
    GeekBlue,
    Purple,
}

open class EntityIntegrationData : HashMap<String,IntegrationData>()
{
}

open class IntegrationData
{
    open var thirdPartyId:String? = null
}

Kotlin PatchCustomer DTOs

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

HTTP + CSV

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

PATCH /customers/{customerId} HTTP/1.1 
Host: team.evovoice.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"customerId":"String","name":"String","parentCustomerId":"String","referenceId":"String","tagIds":["String"],"schedule":{"timeZoneId":"String","inherit":false,"forceClosed":false,"rules":[{"id":"String","name":"String","priority":0,"state":"String","source":"String","condition":"String","simpleRuleType":"Always","customerState":"String","flowId":"String","isAllDay":false,"startDate":"String","startTime":"String","endTime":"String","bySetPosition":[0],"byMonth":[0],"byWeekNo":[0],"byYearDay":[0],"byMonthDay":[0],"byDay":[{"offset":0,"dayOfWeek":"Sunday"}],"byHour":[0],"byMinute":[0],"interval":0,"count":0,"untilDate":"String","frequency":"None"}],"defaultState":"String"},"overrideBillingSettings":false,"billingSettings":{"base":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"localNumbers":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"tollFreeNumbers":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundVoiceCalls":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundVoiceCalls":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundFaxes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundFaxes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundSmsMessages":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundSmsMessages":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"aiInsights":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"aiLiveMinutes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0}},"overrideAppSettings":false,"appSettings":{"enablePhoneNumberManagement":false,"enableDeviceManagement":false,"enableDialer":false,"enableCallHistory":false,"enableAssistants":false,"showFileNameInMessageCenter":false,"chakraTheme":"String","customCss":"String","pageTitle":"String","stringMappings":"String","logoutUrl":"String","portMyNumberUrl":"String"}}

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

{"accountId":"String","parentCustomerId":"String","breadcrumb":[{"id":"String","name":"String"}],"accountName":"String","isStaging":false,"name":"String","referenceId":"String","tags":[{"id":"String","name":"String","color":"Magenta"}],"schedule":{"timeZoneId":"String","inherit":false,"forceClosed":false,"rules":[{"id":"String","name":"String","priority":0,"state":"String","source":"String","condition":"String","simpleRuleType":"Always","customerState":"String","flowId":"String","isAllDay":false,"startDate":"String","startTime":"String","endTime":"String","bySetPosition":[0],"byMonth":[0],"byWeekNo":[0],"byYearDay":[0],"byMonthDay":[0],"byDay":[{"offset":0,"dayOfWeek":"Sunday"}],"byHour":[0],"byMinute":[0],"interval":0,"count":0,"untilDate":"String","frequency":"None"}],"defaultState":"String"},"integrationData":{"String":{"thirdPartyId":"String"}},"overrideBillingSettings":false,"billingSettings":{"base":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"localNumbers":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"tollFreeNumbers":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundVoiceCalls":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundVoiceCalls":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundFaxes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundFaxes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"inboundSmsMessages":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"outboundSmsMessages":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"aiInsights":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0},"aiLiveMinutes":{"baseCost":0,"rawUnitMultiplier":0,"unitCost":0,"allowance":0}},"overrideAppSettings":false,"appSettings":{"enablePhoneNumberManagement":false,"enableDeviceManagement":false,"enableDialer":false,"enableCallHistory":false,"enableAssistants":false,"showFileNameInMessageCenter":false,"chakraTheme":"String","customCss":"String","pageTitle":"String","stringMappings":"String","logoutUrl":"String","portMyNumberUrl":"String"},"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}