| Required role: | User |
| GET | /app/settings-objects |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
enum SettingsObjectTypes
{
Endpoint,
Customer,
}
enum EndpointTypes
{
PhoneNumber,
User,
FaxNumber,
EmailAddress,
Unused_1,
Unused_2,
Unused_3,
Unused_4,
Unused_5,
Team,
}
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,
}
class Struct extends Map<String,Value?> implements IConvertible
{
Struct();
Struct.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "Struct";
TypeContext? context = _ctx;
}
class Value implements IConvertible
{
bool? boolValue;
String? stringValue;
double? numberValue;
List<Struct>? listValue;
Struct? structValue;
Value({this.boolValue,this.stringValue,this.numberValue,this.listValue,this.structValue});
Value.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
boolValue = json['boolValue'];
stringValue = json['stringValue'];
numberValue = JsonConverters.toDouble(json['numberValue']);
listValue = JsonConverters.fromJson(json['listValue'],'List<Struct>',context!);
structValue = JsonConverters.fromJson(json['structValue'],'Struct',context!);
return this;
}
Map<String, dynamic> toJson() => {
'boolValue': boolValue,
'stringValue': stringValue,
'numberValue': numberValue,
'listValue': JsonConverters.toJson(listValue,'List<Struct>',context!),
'structValue': JsonConverters.toJson(structValue,'Struct',context!)
};
getTypeName() => "Value";
TypeContext? context = _ctx;
}
class SettingsPossibleValue implements IConvertible
{
String? displayName;
Value? value;
SettingsPossibleValue({this.displayName,this.value});
SettingsPossibleValue.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
displayName = json['displayName'];
value = JsonConverters.fromJson(json['value'],'Value',context!);
return this;
}
Map<String, dynamic> toJson() => {
'displayName': displayName,
'value': JsonConverters.toJson(value,'Value',context!)
};
getTypeName() => "SettingsPossibleValue";
TypeContext? context = _ctx;
}
enum UIHints
{
None,
LargeText,
InlineForm,
Password,
InlineStruct,
}
class DataType implements IConvertible
{
String? typeName;
List<DataField>? fields;
DataType({this.typeName,this.fields});
DataType.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
typeName = json['typeName'];
fields = JsonConverters.fromJson(json['fields'],'List<DataField>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'typeName': typeName,
'fields': JsonConverters.toJson(fields,'List<DataField>',context!)
};
getTypeName() => "DataType";
TypeContext? context = _ctx;
}
enum DataFieldUniqueness
{
NotUnique,
Unique,
UniqueToCustomer,
}
enum UserDataFieldModes
{
Hidden,
ReadOnly,
ReadWrite,
}
class DataField implements IConvertible
{
String? id;
String? name;
ValueTypes? type;
UIHints? uiHint;
String? uiTab;
bool? isAsync;
bool? disableBinding;
DataType? structType;
DataType? listType;
String? description;
List<String>? possibleValues;
bool? isOutput;
String? customFieldValuesUrl;
Value? defaultValue;
String? transitionNameFormat;
DataFieldUniqueness? uniqueness;
bool? voiceOnly;
String? conditionalVisibilityField;
String? conditionalVisibilityValue;
bool? noEvalTemplate;
UserDataFieldModes? userMode;
bool? anyValueType;
DataField({this.id,this.name,this.type,this.uiHint,this.uiTab,this.isAsync,this.disableBinding,this.structType,this.listType,this.description,this.possibleValues,this.isOutput,this.customFieldValuesUrl,this.defaultValue,this.transitionNameFormat,this.uniqueness,this.voiceOnly,this.conditionalVisibilityField,this.conditionalVisibilityValue,this.noEvalTemplate,this.userMode,this.anyValueType});
DataField.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
name = json['name'];
type = JsonConverters.fromJson(json['type'],'ValueTypes',context!);
uiHint = JsonConverters.fromJson(json['uiHint'],'UIHints',context!);
uiTab = json['uiTab'];
isAsync = json['isAsync'];
disableBinding = json['disableBinding'];
structType = JsonConverters.fromJson(json['structType'],'DataType',context!);
listType = JsonConverters.fromJson(json['listType'],'DataType',context!);
description = json['description'];
possibleValues = JsonConverters.fromJson(json['possibleValues'],'List<String>',context!);
isOutput = json['isOutput'];
customFieldValuesUrl = json['customFieldValuesUrl'];
defaultValue = JsonConverters.fromJson(json['defaultValue'],'Value',context!);
transitionNameFormat = json['transitionNameFormat'];
uniqueness = JsonConverters.fromJson(json['uniqueness'],'DataFieldUniqueness',context!);
voiceOnly = json['voiceOnly'];
conditionalVisibilityField = json['conditionalVisibilityField'];
conditionalVisibilityValue = json['conditionalVisibilityValue'];
noEvalTemplate = json['noEvalTemplate'];
userMode = JsonConverters.fromJson(json['userMode'],'UserDataFieldModes',context!);
anyValueType = json['anyValueType'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'name': name,
'type': JsonConverters.toJson(type,'ValueTypes',context!),
'uiHint': JsonConverters.toJson(uiHint,'UIHints',context!),
'uiTab': uiTab,
'isAsync': isAsync,
'disableBinding': disableBinding,
'structType': JsonConverters.toJson(structType,'DataType',context!),
'listType': JsonConverters.toJson(listType,'DataType',context!),
'description': description,
'possibleValues': JsonConverters.toJson(possibleValues,'List<String>',context!),
'isOutput': isOutput,
'customFieldValuesUrl': customFieldValuesUrl,
'defaultValue': JsonConverters.toJson(defaultValue,'Value',context!),
'transitionNameFormat': transitionNameFormat,
'uniqueness': JsonConverters.toJson(uniqueness,'DataFieldUniqueness',context!),
'voiceOnly': voiceOnly,
'conditionalVisibilityField': conditionalVisibilityField,
'conditionalVisibilityValue': conditionalVisibilityValue,
'noEvalTemplate': noEvalTemplate,
'userMode': JsonConverters.toJson(userMode,'UserDataFieldModes',context!),
'anyValueType': anyValueType
};
getTypeName() => "DataField";
TypeContext? context = _ctx;
}
class SettingsField implements IConvertible
{
String? name;
String? displayName;
ValueTypes? type;
Value? value;
bool? readOnly;
List<SettingsPossibleValue>? possibleValues;
DataField? dataField;
SettingsField({this.name,this.displayName,this.type,this.value,this.readOnly,this.possibleValues,this.dataField});
SettingsField.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
name = json['name'];
displayName = json['displayName'];
type = JsonConverters.fromJson(json['type'],'ValueTypes',context!);
value = JsonConverters.fromJson(json['value'],'Value',context!);
readOnly = json['readOnly'];
possibleValues = JsonConverters.fromJson(json['possibleValues'],'List<SettingsPossibleValue>',context!);
dataField = JsonConverters.fromJson(json['dataField'],'DataField',context!);
return this;
}
Map<String, dynamic> toJson() => {
'name': name,
'displayName': displayName,
'type': JsonConverters.toJson(type,'ValueTypes',context!),
'value': JsonConverters.toJson(value,'Value',context!),
'readOnly': readOnly,
'possibleValues': JsonConverters.toJson(possibleValues,'List<SettingsPossibleValue>',context!),
'dataField': JsonConverters.toJson(dataField,'DataField',context!)
};
getTypeName() => "SettingsField";
TypeContext? context = _ctx;
}
class SettingsObject implements IConvertible
{
String? id;
String? name;
String? description;
bool? readOnly;
SettingsObjectTypes? type;
EndpointTypes? endpointType;
List<SettingsField>? fields;
SettingsObject({this.id,this.name,this.description,this.readOnly,this.type,this.endpointType,this.fields});
SettingsObject.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
name = json['name'];
description = json['description'];
readOnly = json['readOnly'];
type = JsonConverters.fromJson(json['type'],'SettingsObjectTypes',context!);
endpointType = JsonConverters.fromJson(json['endpointType'],'EndpointTypes',context!);
fields = JsonConverters.fromJson(json['fields'],'List<SettingsField>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'name': name,
'description': description,
'readOnly': readOnly,
'type': JsonConverters.toJson(type,'SettingsObjectTypes',context!),
'endpointType': JsonConverters.toJson(endpointType,'EndpointTypes',context!),
'fields': JsonConverters.toJson(fields,'List<SettingsField>',context!)
};
getTypeName() => "SettingsObject";
TypeContext? context = _ctx;
}
class ListSettingsObjectsResponse implements IConvertible
{
List<SettingsObject>? settingsObjects;
ListSettingsObjectsResponse({this.settingsObjects});
ListSettingsObjectsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
settingsObjects = JsonConverters.fromJson(json['settingsObjects'],'List<SettingsObject>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'settingsObjects': JsonConverters.toJson(settingsObjects,'List<SettingsObject>',context!)
};
getTypeName() => "ListSettingsObjectsResponse";
TypeContext? context = _ctx;
}
/**
* Get all configurable settings objects for the authenticated user
*/
// @Api(Description="Get all configurable settings objects for the authenticated user")
class ListSettingsObjects implements IGet, IConvertible
{
ListSettingsObjects();
ListSettingsObjects.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "ListSettingsObjects";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'evovoice.io', types: <String, TypeInfo> {
'SettingsObjectTypes': TypeInfo(TypeOf.Enum, enumValues:SettingsObjectTypes.values),
'EndpointTypes': TypeInfo(TypeOf.Enum, enumValues:EndpointTypes.values),
'ValueTypes': TypeInfo(TypeOf.Enum, enumValues:ValueTypes.values),
'Struct': TypeInfo(TypeOf.Class, create:() => Struct()),
'Value': TypeInfo(TypeOf.Class, create:() => Value()),
'List<Struct>': TypeInfo(TypeOf.Class, create:() => <Struct>[]),
'SettingsPossibleValue': TypeInfo(TypeOf.Class, create:() => SettingsPossibleValue()),
'UIHints': TypeInfo(TypeOf.Enum, enumValues:UIHints.values),
'DataType': TypeInfo(TypeOf.Class, create:() => DataType()),
'List<DataField>': TypeInfo(TypeOf.Class, create:() => <DataField>[]),
'DataField': TypeInfo(TypeOf.Class, create:() => DataField()),
'DataFieldUniqueness': TypeInfo(TypeOf.Enum, enumValues:DataFieldUniqueness.values),
'UserDataFieldModes': TypeInfo(TypeOf.Enum, enumValues:UserDataFieldModes.values),
'SettingsField': TypeInfo(TypeOf.Class, create:() => SettingsField()),
'List<SettingsPossibleValue>': TypeInfo(TypeOf.Class, create:() => <SettingsPossibleValue>[]),
'SettingsObject': TypeInfo(TypeOf.Class, create:() => SettingsObject()),
'List<SettingsField>': TypeInfo(TypeOf.Class, create:() => <SettingsField>[]),
'ListSettingsObjectsResponse': TypeInfo(TypeOf.Class, create:() => ListSettingsObjectsResponse()),
'List<SettingsObject>': TypeInfo(TypeOf.Class, create:() => <SettingsObject>[]),
'ListSettingsObjects': TypeInfo(TypeOf.Class, create:() => ListSettingsObjects()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /app/settings-objects HTTP/1.1 Host: evovoice.io Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}},"readOnly":false,"possibleValues":[{"displayName":"String","value":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}}}],"dataField":{"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":false,"structType":{"typeName":"String","fields":[{"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":false,"structType":{"typeName":"String","fields":[{"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":false,"structType":{"typeName":"String","fields":[{}]},"listType":{"typeName":"String","fields":[{}]},"description":"String","possibleValues":["String"],"isOutput":false,"customFieldValuesUrl":"String","defaultValue":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}},"transitionNameFormat":"String","uniqueness":"NotUnique","voiceOnly":false,"conditionalVisibilityField":"String","conditionalVisibilityValue":"String","noEvalTemplate":false,"userMode":"Hidden","anyValueType":false}]},"listType":{"typeName":"String","fields":[{"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":false,"structType":{"typeName":"String","fields":[{}]},"listType":{"typeName":"String","fields":[{}]},"description":"String","possibleValues":["String"],"isOutput":false,"customFieldValuesUrl":"String","defaultValue":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}},"transitionNameFormat":"String","uniqueness":"NotUnique","voiceOnly":false,"conditionalVisibilityField":"String","conditionalVisibilityValue":"String","noEvalTemplate":false,"userMode":"Hidden","anyValueType":false}]},"description":"String","possibleValues":["String"],"isOutput":false,"customFieldValuesUrl":"String","defaultValue":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}},"transitionNameFormat":"String","uniqueness":"NotUnique","voiceOnly":false,"conditionalVisibilityField":"String","conditionalVisibilityValue":"String","noEvalTemplate":false,"userMode":"Hidden","anyValueType":false}]},"listType":{"typeName":"String","fields":[{"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":false,"structType":{"typeName":"String","fields":[{"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":false,"structType":{"typeName":"String","fields":[{}]},"listType":{"typeName":"String","fields":[{}]},"description":"String","possibleValues":["String"],"isOutput":false,"customFieldValuesUrl":"String","defaultValue":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}},"transitionNameFormat":"String","uniqueness":"NotUnique","voiceOnly":false,"conditionalVisibilityField":"String","conditionalVisibilityValue":"String","noEvalTemplate":false,"userMode":"Hidden","anyValueType":false}]},"listType":{"typeName":"String","fields":[{"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":false,"structType":{"typeName":"String","fields":[{}]},"listType":{"typeName":"String","fields":[{}]},"description":"String","possibleValues":["String"],"isOutput":false,"customFieldValuesUrl":"String","defaultValue":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}},"transitionNameFormat":"String","uniqueness":"NotUnique","voiceOnly":false,"conditionalVisibilityField":"String","conditionalVisibilityValue":"String","noEvalTemplate":false,"userMode":"Hidden","anyValueType":false}]},"description":"String","possibleValues":["String"],"isOutput":false,"customFieldValuesUrl":"String","defaultValue":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}},"transitionNameFormat":"String","uniqueness":"NotUnique","voiceOnly":false,"conditionalVisibilityField":"String","conditionalVisibilityValue":"String","noEvalTemplate":false,"userMode":"Hidden","anyValueType":false}]},"description":"String","possibleValues":["String"],"isOutput":false,"customFieldValuesUrl":"String","defaultValue":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{}],"structValue":{}}}}}},"transitionNameFormat":"String","uniqueness":"NotUnique","voiceOnly":false,"conditionalVisibilityField":"String","conditionalVisibilityValue":"String","noEvalTemplate":false,"userMode":"Hidden","anyValueType":false}}]}]}