Evo Voice

<back to all web services

PatchSettingsObject

Update the specified settings object

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Update the specified settings object
    */
    @Api(Description="Update the specified settings object")
    public static class PatchSettingsObject implements IPatch
    {
        /**
        * The ID of the settings object
        */
        @ApiMember(Description="The ID of the settings object")
        public String id = null;

        /**
        * The data values to set
        */
        @ApiMember(Description="The data values to set")
        public Struct data = null;
        
        public String getId() { return id; }
        public PatchSettingsObject setId(String value) { this.id = value; return this; }
        public Struct getData() { return data; }
        public PatchSettingsObject setData(Struct value) { this.data = value; return this; }
    }

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

    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 SettingsObject
    {
        public String id = null;
        public String name = null;
        public String description = null;
        public Boolean readOnly = null;
        public SettingsObjectTypes type = null;
        public EndpointTypes endpointType = null;
        public ArrayList<SettingsField> fields = null;
        
        public String getId() { return id; }
        public SettingsObject setId(String value) { this.id = value; return this; }
        public String getName() { return name; }
        public SettingsObject setName(String value) { this.name = value; return this; }
        public String getDescription() { return description; }
        public SettingsObject setDescription(String value) { this.description = value; return this; }
        public Boolean isReadOnly() { return readOnly; }
        public SettingsObject setReadOnly(Boolean value) { this.readOnly = value; return this; }
        public SettingsObjectTypes getType() { return type; }
        public SettingsObject setType(SettingsObjectTypes value) { this.type = value; return this; }
        public EndpointTypes getEndpointType() { return endpointType; }
        public SettingsObject setEndpointType(EndpointTypes value) { this.endpointType = value; return this; }
        public ArrayList<SettingsField> getFields() { return fields; }
        public SettingsObject setFields(ArrayList<SettingsField> value) { this.fields = value; return this; }
    }

    public static enum SettingsObjectTypes
    {
        Endpoint,
        Customer;
    }

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

    public static class SettingsField
    {
        public String name = null;
        public String displayName = null;
        public ValueTypes type = null;
        public Value value = null;
        public Boolean readOnly = null;
        public ArrayList<SettingsPossibleValue> possibleValues = null;
        public DataField dataField = null;
        
        public String getName() { return name; }
        public SettingsField setName(String value) { this.name = value; return this; }
        public String getDisplayName() { return displayName; }
        public SettingsField setDisplayName(String value) { this.displayName = value; return this; }
        public ValueTypes getType() { return type; }
        public SettingsField setType(ValueTypes value) { this.type = value; return this; }
        public Value getValue() { return value; }
        public SettingsField setValue(Value value) { this.value = value; return this; }
        public Boolean isReadOnly() { return readOnly; }
        public SettingsField setReadOnly(Boolean value) { this.readOnly = value; return this; }
        public ArrayList<SettingsPossibleValue> getPossibleValues() { return possibleValues; }
        public SettingsField setPossibleValues(ArrayList<SettingsPossibleValue> value) { this.possibleValues = value; return this; }
        public DataField getDataField() { return dataField; }
        public SettingsField setDataField(DataField value) { this.dataField = 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 class SettingsPossibleValue
    {
        public String displayName = null;
        public Value value = null;
        
        public String getDisplayName() { return displayName; }
        public SettingsPossibleValue setDisplayName(String value) { this.displayName = value; return this; }
        public Value getValue() { return value; }
        public SettingsPossibleValue setValue(Value value) { this.value = 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 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 enum DataFieldUniqueness
    {
        NotUnique,
        Unique,
        UniqueToCustomer;
    }

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

}

Java PatchSettingsObject DTOs

PATCH /app/settings-objects/{id} HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchSettingsObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.App">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Id>String</Id>
</PatchSettingsObject>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SettingsObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.App">
  <Description>String</Description>
  <EndpointType>PhoneNumber</EndpointType>
  <Fields>
    <SettingsField>
      <DataField xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" />
      <DisplayName>String</DisplayName>
      <Name>String</Name>
      <PossibleValues>
        <SettingsPossibleValue>
          <DisplayName>String</DisplayName>
          <Value xmlns:d6p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
            <d6p1:BoolValue>false</d6p1:BoolValue>
            <d6p1:ListValue xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
            </d6p1:ListValue>
            <d6p1:NumberValue>0</d6p1:NumberValue>
            <d6p1:StringValue>String</d6p1:StringValue>
            <d6p1:StructValue xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
          </Value>
        </SettingsPossibleValue>
      </PossibleValues>
      <ReadOnly>false</ReadOnly>
      <Type>NotSpecified</Type>
      <Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
        <d4p1:BoolValue>false</d4p1:BoolValue>
        <d4p1:ListValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
        </d4p1:ListValue>
        <d4p1:NumberValue>0</d4p1:NumberValue>
        <d4p1:StringValue>String</d4p1:StringValue>
        <d4p1:StructValue xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      </Value>
    </SettingsField>
  </Fields>
  <Id>String</Id>
  <Name>String</Name>
  <ReadOnly>false</ReadOnly>
  <Type>Endpoint</Type>
</SettingsObject>