| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /flows/parameters |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
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,
}
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;
}
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;
}
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 GetParameterField implements IConvertible
{
String? fieldName;
ValueTypes? valueType;
DataField? field;
GetParameterField({this.fieldName,this.valueType,this.field});
GetParameterField.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
fieldName = json['fieldName'];
valueType = JsonConverters.fromJson(json['valueType'],'ValueTypes',context!);
field = JsonConverters.fromJson(json['field'],'DataField',context!);
return this;
}
Map<String, dynamic> toJson() => {
'fieldName': fieldName,
'valueType': JsonConverters.toJson(valueType,'ValueTypes',context!),
'field': JsonConverters.toJson(field,'DataField',context!)
};
getTypeName() => "GetParameterField";
TypeContext? context = _ctx;
}
class GetParameterFieldNamesResponse implements IConvertible
{
List<GetParameterField>? customer;
List<GetParameterField>? system;
List<GetParameterField>? session;
List<GetParameterField>? endpoint;
List<GetParameterField>? user;
GetParameterFieldNamesResponse({this.customer,this.system,this.session,this.endpoint,this.user});
GetParameterFieldNamesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
customer = JsonConverters.fromJson(json['customer'],'List<GetParameterField>',context!);
system = JsonConverters.fromJson(json['system'],'List<GetParameterField>',context!);
session = JsonConverters.fromJson(json['session'],'List<GetParameterField>',context!);
endpoint = JsonConverters.fromJson(json['endpoint'],'List<GetParameterField>',context!);
user = JsonConverters.fromJson(json['user'],'List<GetParameterField>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'customer': JsonConverters.toJson(customer,'List<GetParameterField>',context!),
'system': JsonConverters.toJson(system,'List<GetParameterField>',context!),
'session': JsonConverters.toJson(session,'List<GetParameterField>',context!),
'endpoint': JsonConverters.toJson(endpoint,'List<GetParameterField>',context!),
'user': JsonConverters.toJson(user,'List<GetParameterField>',context!)
};
getTypeName() => "GetParameterFieldNamesResponse";
TypeContext? context = _ctx;
}
/**
* Gets the possible field names for a specified value source
*/
// @Api(Description="Gets the possible field names for a specified value source")
class GetParameterFieldNames implements IGet, IConvertible
{
/**
* The account ID associated with the flow
*/
// @ApiMember(Description="The account ID associated with the flow")
String? accountId;
/**
* Exclude built in fields like customer name
*/
// @ApiMember(Description="Exclude built in fields like customer name")
bool? excludeBuiltInFields;
GetParameterFieldNames({this.accountId,this.excludeBuiltInFields});
GetParameterFieldNames.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
accountId = json['accountId'];
excludeBuiltInFields = json['excludeBuiltInFields'];
return this;
}
Map<String, dynamic> toJson() => {
'accountId': accountId,
'excludeBuiltInFields': excludeBuiltInFields
};
getTypeName() => "GetParameterFieldNames";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'team.evovoice.io', types: <String, TypeInfo> {
'ValueTypes': TypeInfo(TypeOf.Enum, enumValues:ValueTypes.values),
'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()),
'Struct': TypeInfo(TypeOf.Class, create:() => Struct()),
'Value': TypeInfo(TypeOf.Class, create:() => Value()),
'List<Struct>': TypeInfo(TypeOf.Class, create:() => <Struct>[]),
'DataFieldUniqueness': TypeInfo(TypeOf.Enum, enumValues:DataFieldUniqueness.values),
'UserDataFieldModes': TypeInfo(TypeOf.Enum, enumValues:UserDataFieldModes.values),
'GetParameterField': TypeInfo(TypeOf.Class, create:() => GetParameterField()),
'GetParameterFieldNamesResponse': TypeInfo(TypeOf.Class, create:() => GetParameterFieldNamesResponse()),
'List<GetParameterField>': TypeInfo(TypeOf.Class, create:() => <GetParameterField>[]),
'GetParameterFieldNames': TypeInfo(TypeOf.Class, create:() => GetParameterFieldNames()),
});
Dart GetParameterFieldNames DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /flows/parameters HTTP/1.1 Host: team.evovoice.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
]
}