Evo Voice

<back to all web services

AppUpdateSystemSettings

Requires Authentication
The following routes are available for this service:
PATCH/portal/system-settings
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class AppUpdateSystemSettings
    {
        public String accountId = null;
        public String customerId = null;
        public String customerTimeZoneId = null;
        
        public String getAccountId() { return accountId; }
        public AppUpdateSystemSettings setAccountId(String value) { this.accountId = value; return this; }
        public String getCustomerId() { return customerId; }
        public AppUpdateSystemSettings setCustomerId(String value) { this.customerId = value; return this; }
        public String getCustomerTimeZoneId() { return customerTimeZoneId; }
        public AppUpdateSystemSettings setCustomerTimeZoneId(String value) { this.customerTimeZoneId = value; return this; }
    }

    public static class AppSystemSettingsInfo
    {
        public ArrayList<EndpointDataField> endpointFields = null;
        /**
        * Is this customer a HostedSuite customer?
        */
        @ApiMember(Description="Is this customer a HostedSuite customer?")
        public Boolean isHostedSuiteCustomer = null;

        /**
        * The customer's time zone
        */
        @ApiMember(Description="The customer's time zone")
        public String customerTimeZoneId = null;
        
        public ArrayList<EndpointDataField> getEndpointFields() { return endpointFields; }
        public AppSystemSettingsInfo setEndpointFields(ArrayList<EndpointDataField> value) { this.endpointFields = value; return this; }
        public Boolean getIsHostedSuiteCustomer() { return isHostedSuiteCustomer; }
        public AppSystemSettingsInfo setIsHostedSuiteCustomer(Boolean value) { this.isHostedSuiteCustomer = value; return this; }
        public String getCustomerTimeZoneId() { return customerTimeZoneId; }
        public AppSystemSettingsInfo setCustomerTimeZoneId(String value) { this.customerTimeZoneId = value; return this; }
    }

    public static class EndpointDataField extends DataField
    {
        public Boolean showInSearch = null;
        public Boolean showInLists = null;
        public EndpointTypes endpointType = null;
        public Boolean isCallerId = null;
        public Boolean isKnob = null;
        
        public Boolean isShowInSearch() { return showInSearch; }
        public EndpointDataField setShowInSearch(Boolean value) { this.showInSearch = value; return this; }
        public Boolean isShowInLists() { return showInLists; }
        public EndpointDataField setShowInLists(Boolean value) { this.showInLists = value; return this; }
        public EndpointTypes getEndpointType() { return endpointType; }
        public EndpointDataField setEndpointType(EndpointTypes value) { this.endpointType = value; return this; }
        public Boolean getIsCallerId() { return isCallerId; }
        public EndpointDataField setIsCallerId(Boolean value) { this.isCallerId = value; return this; }
        public Boolean getIsKnob() { return isKnob; }
        public EndpointDataField setIsKnob(Boolean value) { this.isKnob = value; return this; }
    }

    public static class DataField
    {
        public String id = null;
        public String name = null;
        public ValueTypes type = null;
        public UIHints uiHint = null;
        public String uiTab = null;
        public Boolean isAsync = null;
        public Boolean disableBinding = null;
        public DataType structType = null;
        public DataType listType = null;
        public String description = null;
        public ArrayList<String> possibleValues = null;
        public Boolean isOutput = null;
        public String customFieldValuesUrl = null;
        public Value defaultValue = null;
        public String transitionNameFormat = null;
        public DataFieldUniqueness uniqueness = null;
        public Boolean voiceOnly = null;
        public String conditionalVisibilityField = null;
        public String conditionalVisibilityValue = null;
        public Boolean noEvalTemplate = null;
        public UserDataFieldModes userMode = null;
        public Boolean anyValueType = null;
        
        public String getId() { return id; }
        public DataField setId(String value) { this.id = value; return this; }
        public String getName() { return name; }
        public DataField setName(String value) { this.name = value; return this; }
        public ValueTypes getType() { return type; }
        public DataField setType(ValueTypes value) { this.type = value; return this; }
        public UIHints getUiHint() { return uiHint; }
        public DataField setUiHint(UIHints value) { this.uiHint = value; return this; }
        public String getUiTab() { return uiTab; }
        public DataField setUiTab(String value) { this.uiTab = value; return this; }
        public Boolean getIsAsync() { return isAsync; }
        public DataField setIsAsync(Boolean value) { this.isAsync = value; return this; }
        public Boolean isDisableBinding() { return disableBinding; }
        public DataField setDisableBinding(Boolean value) { this.disableBinding = value; return this; }
        public DataType getStructType() { return structType; }
        public DataField setStructType(DataType value) { this.structType = value; return this; }
        public DataType getListType() { return listType; }
        public DataField setListType(DataType value) { this.listType = value; return this; }
        public String getDescription() { return description; }
        public DataField setDescription(String value) { this.description = value; return this; }
        public ArrayList<String> getPossibleValues() { return possibleValues; }
        public DataField setPossibleValues(ArrayList<String> value) { this.possibleValues = value; return this; }
        public Boolean getIsOutput() { return isOutput; }
        public DataField setIsOutput(Boolean value) { this.isOutput = value; return this; }
        public String getCustomFieldValuesUrl() { return customFieldValuesUrl; }
        public DataField setCustomFieldValuesUrl(String value) { this.customFieldValuesUrl = value; return this; }
        public Value getDefaultValue() { return defaultValue; }
        public DataField setDefaultValue(Value value) { this.defaultValue = value; return this; }
        public String getTransitionNameFormat() { return transitionNameFormat; }
        public DataField setTransitionNameFormat(String value) { this.transitionNameFormat = value; return this; }
        public DataFieldUniqueness getUniqueness() { return uniqueness; }
        public DataField setUniqueness(DataFieldUniqueness value) { this.uniqueness = value; return this; }
        public Boolean isVoiceOnly() { return voiceOnly; }
        public DataField setVoiceOnly(Boolean value) { this.voiceOnly = value; return this; }
        public String getConditionalVisibilityField() { return conditionalVisibilityField; }
        public DataField setConditionalVisibilityField(String value) { this.conditionalVisibilityField = value; return this; }
        public String getConditionalVisibilityValue() { return conditionalVisibilityValue; }
        public DataField setConditionalVisibilityValue(String value) { this.conditionalVisibilityValue = value; return this; }
        public Boolean isNoEvalTemplate() { return noEvalTemplate; }
        public DataField setNoEvalTemplate(Boolean value) { this.noEvalTemplate = value; return this; }
        public UserDataFieldModes getUserMode() { return userMode; }
        public DataField setUserMode(UserDataFieldModes value) { this.userMode = value; return this; }
        public Boolean isAnyValueType() { return anyValueType; }
        public DataField setAnyValueType(Boolean value) { this.anyValueType = value; return this; }
    }

    public static enum ValueTypes
    {
        NotSpecified,
        String,
        Boolean,
        Number,
        List,
        Struct,
        Transition,
        Custom,
        Date,
        AudioFile,
        TimeZoneId,
        PhoneNumber,
        User,
        Endpoint,
        Time,
        File,
        FaxNumber,
        EmailAccount,
        Customer,
        Flow,
        Team,
        FlowReference,
        Integration,
        Assistant;
    }

    public static enum UIHints
    {
        None,
        LargeText,
        InlineForm,
        Password,
        InlineStruct;
    }

    public static class DataType
    {
        public String typeName = null;
        public ArrayList<DataField> fields = null;
        
        public String getTypeName() { return typeName; }
        public DataType setTypeName(String value) { this.typeName = value; return this; }
        public ArrayList<DataField> getFields() { return fields; }
        public DataType setFields(ArrayList<DataField> value) { this.fields = value; return this; }
    }

    public static class Value
    {
        public Boolean boolValue = null;
        public String stringValue = null;
        public Double numberValue = null;
        public ArrayList<Struct> listValue = null;
        public Struct structValue = null;
        
        public Boolean isBoolValue() { return boolValue; }
        public Value setBoolValue(Boolean value) { this.boolValue = value; return this; }
        public String getStringValue() { return stringValue; }
        public Value setStringValue(String value) { this.stringValue = value; return this; }
        public Double getNumberValue() { return numberValue; }
        public Value setNumberValue(Double value) { this.numberValue = value; return this; }
        public ArrayList<Struct> getListValue() { return listValue; }
        public Value setListValue(ArrayList<Struct> value) { this.listValue = value; return this; }
        public Struct getStructValue() { return structValue; }
        public Value setStructValue(Struct value) { this.structValue = value; return this; }
    }

    public static class Struct extends HashMap<String,Value>
    {
        
    }

    public static enum DataFieldUniqueness
    {
        NotUnique,
        Unique,
        UniqueToCustomer;
    }

    public static enum UserDataFieldModes
    {
        Hidden,
        ReadOnly,
        ReadWrite;
    }

    public static enum EndpointTypes
    {
        PhoneNumber,
        User,
        FaxNumber,
        EmailAddress,
        Unused1,
        Unused2,
        Unused3,
        Unused4,
        Unused5,
        Team,
        Assistant;
    }

}

Java AppUpdateSystemSettings DTOs

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

HTTP + XML

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

PATCH /portal/system-settings HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AppUpdateSystemSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.App.Portal">
  <AccountId>String</AccountId>
  <CustomerId>String</CustomerId>
  <CustomerTimeZoneId>String</CustomerTimeZoneId>
</AppUpdateSystemSettings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AppSystemSettingsInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.App.Portal">
  <CustomerTimeZoneId>String</CustomerTimeZoneId>
  <EndpointFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings">
    <d2p1:EndpointDataField>
      <AnyValueType xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</AnyValueType>
      <ConditionalVisibilityField xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</ConditionalVisibilityField>
      <ConditionalVisibilityValue xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</ConditionalVisibilityValue>
      <CustomFieldValuesUrl xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</CustomFieldValuesUrl>
      <DefaultValue xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
        <BoolValue>false</BoolValue>
        <ListValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
        </ListValue>
        <NumberValue>0</NumberValue>
        <StringValue>String</StringValue>
        <StructValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      </DefaultValue>
      <Description xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Description>
      <DisableBinding xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</DisableBinding>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Id>
      <IsAsync xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</IsAsync>
      <IsOutput xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</IsOutput>
      <ListType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" />
      <Name xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Name>
      <NoEvalTemplate xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</NoEvalTemplate>
      <PossibleValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
        <d4p1:string>String</d4p1:string>
      </PossibleValues>
      <StructType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" />
      <TransitionNameFormat xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</TransitionNameFormat>
      <Type xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">NotSpecified</Type>
      <UIHint xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">None</UIHint>
      <UITab xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</UITab>
      <Uniqueness xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">NotUnique</Uniqueness>
      <UserMode xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">Hidden</UserMode>
      <VoiceOnly xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</VoiceOnly>
      <d2p1:EndpointType>PhoneNumber</d2p1:EndpointType>
      <d2p1:IsCallerId>false</d2p1:IsCallerId>
      <d2p1:IsKnob>false</d2p1:IsKnob>
      <d2p1:ShowInLists>false</d2p1:ShowInLists>
      <d2p1:ShowInSearch>false</d2p1:ShowInSearch>
    </d2p1:EndpointDataField>
  </EndpointFields>
  <IsHostedSuiteCustomer>false</IsHostedSuiteCustomer>
</AppSystemSettingsInfo>