Evo Voice

<back to all web services

ListSettingsObjects

Get all configurable settings objects for the authenticated user

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Get all configurable settings objects for the authenticated user
*/
@Api(Description="Get all configurable settings objects for the authenticated user")
open class ListSettingsObjects : IGet
{
}

open class ListSettingsObjectsResponse
{
    open var settingsObjects:ArrayList<SettingsObject>? = null
}

open class SettingsObject
{
    open var id:String? = null
    open var name:String? = null
    open var description:String? = null
    open var readOnly:Boolean? = null
    @SerializedName("type") open var Type:SettingsObjectTypes? = null
    open var endpointType:EndpointTypes? = null
    open var fields:ArrayList<SettingsField>? = null
}

enum class SettingsObjectTypes
{
    Endpoint,
    Customer,
}

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

open class SettingsField
{
    open var name:String? = null
    open var displayName:String? = null
    @SerializedName("type") open var Type:ValueTypes? = null
    open var value:Value? = null
    open var readOnly:Boolean? = null
    open var possibleValues:ArrayList<SettingsPossibleValue>? = null
    open var dataField:DataField? = null
}

enum class 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,
}

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 Struct : HashMap<String,Value>()
{
}

open class SettingsPossibleValue
{
    open var displayName:String? = null
    open var value:Value? = null
}

open class DataField
{
    open var id:String? = null
    open var name:String? = null
    @SerializedName("type") open var Type:ValueTypes? = null
    open var uiHint:UIHints? = null
    open var uiTab:String? = null
    open var isAsync:Boolean? = null
    open var disableBinding:Boolean? = null
    open var structType:DataType? = null
    open var listType:DataType? = null
    open var description:String? = null
    open var possibleValues:ArrayList<String>? = null
    open var isOutput:Boolean? = null
    open var customFieldValuesUrl:String? = null
    open var defaultValue:Value? = null
    open var transitionNameFormat:String? = null
    open var uniqueness:DataFieldUniqueness? = null
    open var voiceOnly:Boolean? = null
    open var conditionalVisibilityField:String? = null
    open var conditionalVisibilityValue:String? = null
    open var noEvalTemplate:Boolean? = null
    open var userMode:UserDataFieldModes? = null
    open var anyValueType:Boolean? = null
}

enum class UIHints
{
    None,
    LargeText,
    InlineForm,
    Password,
    InlineStruct,
}

open class DataType
{
    open var typeName:String? = null
    open var fields:ArrayList<DataField>? = null
}

enum class DataFieldUniqueness
{
    NotUnique,
    Unique,
    UniqueToCustomer,
}

enum class UserDataFieldModes
{
    Hidden,
    ReadOnly,
    ReadWrite,
}

Kotlin ListSettingsObjects DTOs

GET /app/settings-objects HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml

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

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