Evo Voice

<back to all web services

GetParameterFieldNames

Gets the possible field names for a specified value source

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

public class dtos
{

    /**
    * Gets the possible field names for a specified value source
    */
    @Api(Description="Gets the possible field names for a specified value source")
    public static class GetParameterFieldNames implements IGet
    {
        /**
        * The account ID associated with the flow
        */
        @ApiMember(Description="The account ID associated with the flow")
        public String accountId = null;

        /**
        * Exclude built in fields like customer name
        */
        @ApiMember(Description="Exclude built in fields like customer name")
        public Boolean excludeBuiltInFields = null;
        
        public String getAccountId() { return accountId; }
        public GetParameterFieldNames setAccountId(String value) { this.accountId = value; return this; }
        public Boolean isExcludeBuiltInFields() { return excludeBuiltInFields; }
        public GetParameterFieldNames setExcludeBuiltInFields(Boolean value) { this.excludeBuiltInFields = value; return this; }
    }

    public static class GetParameterFieldNamesResponse
    {
        public ArrayList<GetParameterField> customer = null;
        public ArrayList<GetParameterField> system = null;
        public ArrayList<GetParameterField> session = null;
        public ArrayList<GetParameterField> endpoint = null;
        public ArrayList<GetParameterField> user = null;
        
        public ArrayList<GetParameterField> getCustomer() { return customer; }
        public GetParameterFieldNamesResponse setCustomer(ArrayList<GetParameterField> value) { this.customer = value; return this; }
        public ArrayList<GetParameterField> getSystem() { return system; }
        public GetParameterFieldNamesResponse setSystem(ArrayList<GetParameterField> value) { this.system = value; return this; }
        public ArrayList<GetParameterField> getSession() { return session; }
        public GetParameterFieldNamesResponse setSession(ArrayList<GetParameterField> value) { this.session = value; return this; }
        public ArrayList<GetParameterField> getEndpoint() { return endpoint; }
        public GetParameterFieldNamesResponse setEndpoint(ArrayList<GetParameterField> value) { this.endpoint = value; return this; }
        public ArrayList<GetParameterField> getUser() { return user; }
        public GetParameterFieldNamesResponse setUser(ArrayList<GetParameterField> value) { this.user = value; return this; }
    }

    public static class GetParameterField
    {
        public String fieldName = null;
        public ValueTypes valueType = null;
        public DataField field = null;
        
        public String getFieldName() { return fieldName; }
        public GetParameterField setFieldName(String value) { this.fieldName = value; return this; }
        public ValueTypes getValueType() { return valueType; }
        public GetParameterField setValueType(ValueTypes value) { this.valueType = value; return this; }
        public DataField getField() { return field; }
        public GetParameterField setField(DataField value) { this.field = 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 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 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;
    }

}

Java GetParameterFieldNames DTOs

GET /flows/parameters HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsonl

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

{"customer":[{"fieldName":"String","valueType":"NotSpecified"}],"system":[{"fieldName":"String","valueType":"NotSpecified"}],"session":[{"fieldName":"String","valueType":"NotSpecified"}],"endpoint":[{"fieldName":"String","valueType":"NotSpecified"}],"user":[{"fieldName":"String","valueType":"NotSpecified"}]}