Evo Voice

<back to all web services

ListSettingsObjects

Get all configurable settings objects for the authenticated user

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.App;
using Voice.Api.Endpoints;
using Voice.Api.Flows.Data;

namespace Voice.Api.App
{
    ///<summary>
    ///Get all configurable settings objects for the authenticated user
    ///</summary>
    [Api(Description="Get all configurable settings objects for the authenticated user")]
    public partial class ListSettingsObjects
        : IGet
    {
    }

    public partial class ListSettingsObjectsResponse
    {
        public virtual List<SettingsObject> SettingsObjects { get; set; }
    }

    public partial class SettingsField
    {
        public virtual string Name { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual ValueTypes Type { get; set; }
        public virtual Value Value { get; set; }
        public virtual bool ReadOnly { get; set; }
        public virtual List<SettingsPossibleValue> PossibleValues { get; set; }
        public virtual DataField DataField { get; set; }
    }

    public partial class SettingsObject
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual bool ReadOnly { get; set; }
        public virtual SettingsObjectTypes Type { get; set; }
        public virtual EndpointTypes? EndpointType { get; set; }
        public virtual List<SettingsField> Fields { get; set; }
    }

    public enum SettingsObjectTypes
    {
        Endpoint,
        Customer,
    }

    public partial class SettingsPossibleValue
    {
        public virtual string DisplayName { get; set; }
        public virtual Value Value { get; set; }
    }

}

namespace Voice.Api.Endpoints
{
    public enum EndpointTypes
    {
        PhoneNumber,
        User,
        FaxNumber,
        EmailAddress,
        Unused_1,
        Unused_2,
        Unused_3,
        Unused_4,
        Unused_5,
        Team,
        Assistant,
    }

    public enum UserDataFieldModes
    {
        Hidden,
        ReadOnly,
        ReadWrite,
    }

}

namespace Voice.Api.Flows.Data
{
    public partial class DataField
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
        public virtual ValueTypes Type { get; set; }
        public virtual UIHints UIHint { get; set; }
        public virtual string UITab { get; set; }
        public virtual bool IsAsync { get; set; }
        public virtual bool DisableBinding { get; set; }
        public virtual DataType StructType { get; set; }
        public virtual DataType ListType { get; set; }
        public virtual string Description { get; set; }
        public virtual List<string> PossibleValues { get; set; }
        public virtual bool IsOutput { get; set; }
        public virtual string CustomFieldValuesUrl { get; set; }
        public virtual Value DefaultValue { get; set; }
        public virtual string TransitionNameFormat { get; set; }
        public virtual DataFieldUniqueness Uniqueness { get; set; }
        public virtual bool VoiceOnly { get; set; }
        public virtual string ConditionalVisibilityField { get; set; }
        public virtual string ConditionalVisibilityValue { get; set; }
        public virtual bool NoEvalTemplate { get; set; }
        public virtual UserDataFieldModes UserMode { get; set; }
        public virtual bool AnyValueType { get; set; }
    }

    public enum DataFieldUniqueness
    {
        NotUnique,
        Unique,
        UniqueToCustomer,
    }

    public partial class DataType
    {
        public virtual string TypeName { get; set; }
        public virtual List<DataField> Fields { get; set; }
    }

    public partial class Struct
        : Dictionary<string, Value>
    {
    }

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

    public partial class Value
    {
        public virtual bool? BoolValue { get; set; }
        public virtual string StringValue { get; set; }
        public virtual double? NumberValue { get; set; }
        public virtual List<Struct> ListValue { get; set; }
        public virtual Struct StructValue { get; set; }
    }

    public 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,
    }

}

C# ListSettingsObjects DTOs

GET /app/settings-objects HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv

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

{
	settingsObjects: 
	[
		{
			id: String,
			name: String,
			description: String,
			readOnly: False,
			type: Endpoint,
			endpointType: PhoneNumber,
			fields: 
			[
				{
					name: String,
					displayName: String,
					type: NotSpecified,
					value: 
					{
						boolValue: False,
						stringValue: String,
						numberValue: 0,
						listValue: 
						[
							null
						]
					},
					readOnly: False,
					possibleValues: 
					[
						{
							displayName: String,
							value: 
							{
								boolValue: False,
								stringValue: String,
								numberValue: 0,
								listValue: 
								[
									null
								]
							}
						}
					]
				}
			]
		}
	]
}