| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /flows |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
/**
* Lists all the flows
*/
@Api(Description="Lists all the flows")
public static class ListFlows extends ListRequest<FlowInfo>
{
/**
* Filter by accounts
*/
@ApiMember(Description="Filter by accounts")
public ArrayList<String> accountIds = null;
/**
* The IDs of the customers whose flows you want to retrieve
*/
@ApiMember(Description="The IDs of the customers whose flows you want to retrieve")
public ArrayList<String> customerIds = null;
/**
* Filter by name
*/
@ApiMember(Description="Filter by name")
public String nameFilter = null;
/**
* The list of tag IDs to filter by (must contain all)
*/
@ApiMember(Description="The list of tag IDs to filter by (must contain all)")
public ArrayList<String> tagIds = null;
/**
* List flows by specific role
*/
@ApiMember(Description="List flows by specific role")
public FlowRoles role = null;
/**
* Exclude nodes
*/
@ApiMember(Description="Exclude nodes")
public Boolean includeNodes = null;
/**
* Node Type Filter
*/
@ApiMember(Description="Node Type Filter")
public String nodeTypeFilter = null;
public ArrayList<String> getAccountIds() { return accountIds; }
public ListFlows setAccountIds(ArrayList<String> value) { this.accountIds = value; return this; }
public ArrayList<String> getCustomerIds() { return customerIds; }
public ListFlows setCustomerIds(ArrayList<String> value) { this.customerIds = value; return this; }
public String getNameFilter() { return nameFilter; }
public ListFlows setNameFilter(String value) { this.nameFilter = value; return this; }
public ArrayList<String> getTagIds() { return tagIds; }
public ListFlows setTagIds(ArrayList<String> value) { this.tagIds = value; return this; }
public FlowRoles getRole() { return role; }
public ListFlows setRole(FlowRoles value) { this.role = value; return this; }
public Boolean isIncludeNodes() { return includeNodes; }
public ListFlows setIncludeNodes(Boolean value) { this.includeNodes = value; return this; }
public String getNodeTypeFilter() { return nodeTypeFilter; }
public ListFlows setNodeTypeFilter(String value) { this.nodeTypeFilter = value; return this; }
}
public static class ListRequest<T> implements IGet
{
/**
* The page of data to retrieve
*/
@ApiMember(Description="The page of data to retrieve")
public Integer page = null;
/**
* If you want all objects to be returned. This should be used with care
*/
@ApiMember(Description="If you want all objects to be returned. This should be used with care")
public Boolean all = null;
/**
* The number per page to retrieve
*/
@ApiMember(Description="The number per page to retrieve")
public Integer countPerPage = null;
/**
* Specific IDs
*/
@ApiMember(Description="Specific IDs")
public ArrayList<String> specificIds = null;
/**
* Specify a sort field
*/
@ApiMember(Description="Specify a sort field")
public String sortField = null;
/**
* Specify a sort order
*/
@ApiMember(Description="Specify a sort order")
public SortOrders sortOrder = null;
/**
* Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
*/
@ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")
public Boolean simplifiedPaging = null;
public Integer getPage() { return page; }
public ListRequest<T> setPage(Integer value) { this.page = value; return this; }
public Boolean isAll() { return all; }
public ListRequest<T> setAll(Boolean value) { this.all = value; return this; }
public Integer getCountPerPage() { return countPerPage; }
public ListRequest<T> setCountPerPage(Integer value) { this.countPerPage = value; return this; }
public ArrayList<String> getSpecificIds() { return specificIds; }
public ListRequest<T> setSpecificIds(ArrayList<String> value) { this.specificIds = value; return this; }
public String getSortField() { return sortField; }
public ListRequest<T> setSortField(String value) { this.sortField = value; return this; }
public SortOrders getSortOrder() { return sortOrder; }
public ListRequest<T> setSortOrder(SortOrders value) { this.sortOrder = value; return this; }
public Boolean isSimplifiedPaging() { return simplifiedPaging; }
public ListRequest<T> setSimplifiedPaging(Boolean value) { this.simplifiedPaging = value; return this; }
}
public static enum SortOrders
{
Ascend,
Descend;
}
public static class FlowInfo extends EntityInfo
{
/**
* The name of this flow
*/
@ApiMember(Description="The name of this flow")
public String name = null;
/**
* The roles that this flow has
*/
@ApiMember(Description="The roles that this flow has")
public ArrayList<FlowRoles> roles = null;
/**
* What this flow does
*/
@ApiMember(Description="What this flow does")
public String description = null;
/**
* Any notes for this flow
*/
@ApiMember(Description="Any notes for this flow")
public String notes = null;
/**
* The ID of the account associated with the flow
*/
@ApiMember(Description="The ID of the account associated with the flow")
public String accountId = null;
/**
* The name of the account associated with the flow
*/
@ApiMember(Description="The name of the account associated with the flow")
public String accountName = null;
/**
* The ID of the customer this flow is associated with
*/
@ApiMember(Description="The ID of the customer this flow is associated with")
public String customerId = null;
/**
* The name of the customer this flow is associated with
*/
@ApiMember(Description="The name of the customer this flow is associated with")
public String customerName = null;
/**
* The breadcrumb to the flow for this endpoint
*/
@ApiMember(Description="The breadcrumb to the flow for this endpoint")
public ArrayList<CustomerBreadcrumb> customerBreadcrumb = null;
/**
* The nodes in this flow
*/
@ApiMember(Description="The nodes in this flow")
public ArrayList<FlowNode> nodes = null;
/**
* The flow's parameters
*/
@ApiMember(Description="The flow's parameters")
public ArrayList<FlowParameter> parameters = null;
/**
* The flow's exits
*/
@ApiMember(Description="The flow's exits")
public ArrayList<FlowExit> exits = null;
/**
* The UI data for the flow
*/
@ApiMember(Description="The UI data for the flow")
public FlowUI ui = null;
/**
* The list of tags for this flow
*/
@ApiMember(Description="The list of tags for this flow")
public ArrayList<Tag> tags = null;
/**
* The number of nodes in this flow
*/
@ApiMember(Description="The number of nodes in this flow")
public Integer nodeCount = null;
public String getName() { return name; }
public FlowInfo setName(String value) { this.name = value; return this; }
public ArrayList<FlowRoles> getRoles() { return roles; }
public FlowInfo setRoles(ArrayList<FlowRoles> value) { this.roles = value; return this; }
public String getDescription() { return description; }
public FlowInfo setDescription(String value) { this.description = value; return this; }
public String getNotes() { return notes; }
public FlowInfo setNotes(String value) { this.notes = value; return this; }
public String getAccountId() { return accountId; }
public FlowInfo setAccountId(String value) { this.accountId = value; return this; }
public String getAccountName() { return accountName; }
public FlowInfo setAccountName(String value) { this.accountName = value; return this; }
public String getCustomerId() { return customerId; }
public FlowInfo setCustomerId(String value) { this.customerId = value; return this; }
public String getCustomerName() { return customerName; }
public FlowInfo setCustomerName(String value) { this.customerName = value; return this; }
public ArrayList<CustomerBreadcrumb> getCustomerBreadcrumb() { return customerBreadcrumb; }
public FlowInfo setCustomerBreadcrumb(ArrayList<CustomerBreadcrumb> value) { this.customerBreadcrumb = value; return this; }
public ArrayList<FlowNode> getNodes() { return nodes; }
public FlowInfo setNodes(ArrayList<FlowNode> value) { this.nodes = value; return this; }
public ArrayList<FlowParameter> getParameters() { return parameters; }
public FlowInfo setParameters(ArrayList<FlowParameter> value) { this.parameters = value; return this; }
public ArrayList<FlowExit> getExits() { return exits; }
public FlowInfo setExits(ArrayList<FlowExit> value) { this.exits = value; return this; }
public FlowUI getUi() { return ui; }
public FlowInfo setUi(FlowUI value) { this.ui = value; return this; }
public ArrayList<Tag> getTags() { return tags; }
public FlowInfo setTags(ArrayList<Tag> value) { this.tags = value; return this; }
public Integer getNodeCount() { return nodeCount; }
public FlowInfo setNodeCount(Integer value) { this.nodeCount = value; return this; }
}
public static class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
public String id = null;
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
public String dateCreated = null;
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
public String dateLastModified = null;
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
public String createdBy = null;
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
public String lastModifiedBy = null;
public String getId() { return id; }
public EntityInfo setId(String value) { this.id = value; return this; }
public String getDateCreated() { return dateCreated; }
public EntityInfo setDateCreated(String value) { this.dateCreated = value; return this; }
public String getDateLastModified() { return dateLastModified; }
public EntityInfo setDateLastModified(String value) { this.dateLastModified = value; return this; }
public String getCreatedBy() { return createdBy; }
public EntityInfo setCreatedBy(String value) { this.createdBy = value; return this; }
public String getLastModifiedBy() { return lastModifiedBy; }
public EntityInfo setLastModifiedBy(String value) { this.lastModifiedBy = value; return this; }
}
public static enum FlowRoles
{
Ui,
Reference,
PhoneNumberRouting,
UserDialOut,
FaxNumberRouting;
}
public static class CustomerBreadcrumb
{
public String id = null;
public String name = null;
public String getId() { return id; }
public CustomerBreadcrumb setId(String value) { this.id = value; return this; }
public String getName() { return name; }
public CustomerBreadcrumb setName(String value) { this.name = value; return this; }
}
public static class FlowNode
{
/**
* The ID of this node. Must be unique within the flow but can be anything
*/
@ApiMember(Description="The ID of this node. Must be unique within the flow but can be anything")
public String id = null;
/**
* Is this the starting node for the flow. Only one node can have this set
*/
@ApiMember(Description="Is this the starting node for the flow. Only one node can have this set")
public Boolean isStartNode = null;
/**
* The name of the node, descriptive to be used as a reminder in the GUI
*/
@ApiMember(Description="The name of the node, descriptive to be used as a reminder in the GUI")
public String name = null;
/**
* The specification for the node
*/
@ApiMember(Description="The specification for the node")
public FlowNodeSpec spec = null;
/**
* The UI data for the node
*/
@ApiMember(Description="The UI data for the node")
public FlowNodeUI ui = null;
/**
* The data for this node. These will be POST'd to the endpoint when it is called.
*/
@ApiMember(Description="The data for this node. These will be POST'd to the endpoint when it is called.")
public NodeParameterMap parameters = null;
public String getId() { return id; }
public FlowNode setId(String value) { this.id = value; return this; }
public Boolean getIsStartNode() { return isStartNode; }
public FlowNode setIsStartNode(Boolean value) { this.isStartNode = value; return this; }
public String getName() { return name; }
public FlowNode setName(String value) { this.name = value; return this; }
public FlowNodeSpec getSpec() { return spec; }
public FlowNode setSpec(FlowNodeSpec value) { this.spec = value; return this; }
public FlowNodeUI getUi() { return ui; }
public FlowNode setUi(FlowNodeUI value) { this.ui = value; return this; }
public NodeParameterMap getParameters() { return parameters; }
public FlowNode setParameters(NodeParameterMap value) { this.parameters = value; return this; }
}
public static class FlowNodeSpec
{
/**
* The name of this node
*/
@ApiMember(Description="The name of this node")
public String name = null;
/**
* A description of this node
*/
@ApiMember(Description="A description of this node")
public String description = null;
/**
* Icon class for this node (FontAwesome)
*/
@ApiMember(Description="Icon class for this node (FontAwesome)")
public String iconClass = null;
/**
* The type name for this node
*/
@ApiMember(Description="The type name for this node")
public String typeName = null;
/**
* The category this node should be grouped under
*/
@ApiMember(Description="The category this node should be grouped under")
public FlowNodeCategories category = null;
/**
* The URL where this node is located
*/
@ApiMember(Description="The URL where this node is located")
public String url = null;
/**
* The data type for this node
*/
@ApiMember(Description="The data type for this node")
public DataType dataType = null;
/**
* URL for documentation for this node
*/
@ApiMember(Description="URL for documentation for this node")
public String documentationUrl = null;
/**
* The channels that this node is restricted to
*/
@ApiMember(Description="The channels that this node is restricted to")
public ArrayList<FlowChannels> restrictToChannels = null;
public String getName() { return name; }
public FlowNodeSpec setName(String value) { this.name = value; return this; }
public String getDescription() { return description; }
public FlowNodeSpec setDescription(String value) { this.description = value; return this; }
public String getIconClass() { return iconClass; }
public FlowNodeSpec setIconClass(String value) { this.iconClass = value; return this; }
public String getTypeName() { return typeName; }
public FlowNodeSpec setTypeName(String value) { this.typeName = value; return this; }
public FlowNodeCategories getCategory() { return category; }
public FlowNodeSpec setCategory(FlowNodeCategories value) { this.category = value; return this; }
public String getUrl() { return url; }
public FlowNodeSpec setUrl(String value) { this.url = value; return this; }
public DataType getDataType() { return dataType; }
public FlowNodeSpec setDataType(DataType value) { this.dataType = value; return this; }
public String getDocumentationUrl() { return documentationUrl; }
public FlowNodeSpec setDocumentationUrl(String value) { this.documentationUrl = value; return this; }
public ArrayList<FlowChannels> getRestrictToChannels() { return restrictToChannels; }
public FlowNodeSpec setRestrictToChannels(ArrayList<FlowChannels> value) { this.restrictToChannels = value; return this; }
}
public static enum FlowNodeCategories
{
General,
Voice,
Logic,
DateAndTime,
Audio,
Messaging,
Assistant,
Flows,
Fax,
Network,
Cookies,
CallCenter,
Intelligence;
}
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 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 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 enum UIHints
{
None,
LargeText,
InlineForm,
Password,
InlineStruct;
}
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;
}
public static enum FlowChannels
{
Voice,
Chat,
Fax;
}
public static class FlowNodeUI
{
/**
* The X position of the node
*/
@ApiMember(Description="The X position of the node")
public Double x = null;
/**
* The Y position of the node
*/
@ApiMember(Description="The Y position of the node")
public Double y = null;
/**
* Notes for this node
*/
@ApiMember(Description="Notes for this node")
public String notes = null;
public Double getX() { return x; }
public FlowNodeUI setX(Double value) { this.x = value; return this; }
public Double getY() { return y; }
public FlowNodeUI setY(Double value) { this.y = value; return this; }
public String getNotes() { return notes; }
public FlowNodeUI setNotes(String value) { this.notes = value; return this; }
}
public static class NodeParameterMap extends HashMap<String,NodeParameter>
{
}
public static class NodeParameter
{
public String id = null;
public ValueTypes type = null;
public ValueSources source = null;
public Boolean isAsync = null;
public String referenceId = null;
public Value value = null;
public Boolean noEvalTemplate = null;
public ArrayList<NodeParameterMap> listParameters = null;
public NodeParameterMap structParameters = null;
public Boolean isOutput = null;
public String expression = null;
public DataType listType = null;
public String getId() { return id; }
public NodeParameter setId(String value) { this.id = value; return this; }
public ValueTypes getType() { return type; }
public NodeParameter setType(ValueTypes value) { this.type = value; return this; }
public ValueSources getSource() { return source; }
public NodeParameter setSource(ValueSources value) { this.source = value; return this; }
public Boolean getIsAsync() { return isAsync; }
public NodeParameter setIsAsync(Boolean value) { this.isAsync = value; return this; }
public String getReferenceId() { return referenceId; }
public NodeParameter setReferenceId(String value) { this.referenceId = value; return this; }
public Value getValue() { return value; }
public NodeParameter setValue(Value value) { this.value = value; return this; }
public Boolean isNoEvalTemplate() { return noEvalTemplate; }
public NodeParameter setNoEvalTemplate(Boolean value) { this.noEvalTemplate = value; return this; }
public ArrayList<NodeParameterMap> getListParameters() { return listParameters; }
public NodeParameter setListParameters(ArrayList<NodeParameterMap> value) { this.listParameters = value; return this; }
public NodeParameterMap getStructParameters() { return structParameters; }
public NodeParameter setStructParameters(NodeParameterMap value) { this.structParameters = value; return this; }
public Boolean getIsOutput() { return isOutput; }
public NodeParameter setIsOutput(Boolean value) { this.isOutput = value; return this; }
public String getExpression() { return expression; }
public NodeParameter setExpression(String value) { this.expression = value; return this; }
public DataType getListType() { return listType; }
public NodeParameter setListType(DataType value) { this.listType = value; return this; }
}
public static enum ValueSources
{
Value,
Flow,
System,
Customer,
Session,
Endpoint,
Expression,
User;
}
public static class FlowParameter extends DataField
{
public Boolean isPublic = null;
public Boolean isKnob = null;
public Boolean getIsPublic() { return isPublic; }
public FlowParameter setIsPublic(Boolean value) { this.isPublic = value; return this; }
public Boolean getIsKnob() { return isKnob; }
public FlowParameter setIsKnob(Boolean value) { this.isKnob = value; return this; }
}
public static class FlowExit
{
/**
* The unique ID for this exit
*/
@ApiMember(Description="The unique ID for this exit")
public String id = null;
/**
* The name of this exit
*/
@ApiMember(Description="The name of this exit")
public String name = null;
/**
* The UI for the exit
*/
@ApiMember(Description="The UI for the exit")
public FlowNodeUI ui = null;
public String getId() { return id; }
public FlowExit setId(String value) { this.id = value; return this; }
public String getName() { return name; }
public FlowExit setName(String value) { this.name = value; return this; }
public FlowNodeUI getUi() { return ui; }
public FlowExit setUi(FlowNodeUI value) { this.ui = value; return this; }
}
public static class FlowUI
{
public String selectedNode = null;
public Double canvasX = null;
public Double canvasY = null;
public Double canvasZoom = null;
public String getSelectedNode() { return selectedNode; }
public FlowUI setSelectedNode(String value) { this.selectedNode = value; return this; }
public Double getCanvasX() { return canvasX; }
public FlowUI setCanvasX(Double value) { this.canvasX = value; return this; }
public Double getCanvasY() { return canvasY; }
public FlowUI setCanvasY(Double value) { this.canvasY = value; return this; }
public Double getCanvasZoom() { return canvasZoom; }
public FlowUI setCanvasZoom(Double value) { this.canvasZoom = value; return this; }
}
public static class Tag
{
public String id = null;
public String name = null;
public TagColors color = null;
public String getId() { return id; }
public Tag setId(String value) { this.id = value; return this; }
public String getName() { return name; }
public Tag setName(String value) { this.name = value; return this; }
public TagColors getColor() { return color; }
public Tag setColor(TagColors value) { this.color = value; return this; }
}
public static enum TagColors
{
Magenta,
Red,
Volcano,
Orange,
Gold,
Lime,
Green,
Cyan,
Blue,
GeekBlue,
Purple;
}
public static class ListResponse<T>
{
/**
* The items
*/
@ApiMember(Description="The items")
public ArrayList<AccountInfo> items = null;
/**
* The total number of items
*/
@ApiMember(Description="The total number of items")
public Integer totalCount = null;
/**
* The total number of pages
*/
@ApiMember(Description="The total number of pages")
public Integer totalPages = null;
/**
* Are there more pages of items? Used with simplified paging
*/
@ApiMember(Description="Are there more pages of items? Used with simplified paging")
public Boolean hasMorePages = null;
public ArrayList<AccountInfo> getItems() { return items; }
public ListResponse<T> setItems(ArrayList<AccountInfo> value) { this.items = value; return this; }
public Integer getTotalCount() { return totalCount; }
public ListResponse<T> setTotalCount(Integer value) { this.totalCount = value; return this; }
public Integer getTotalPages() { return totalPages; }
public ListResponse<T> setTotalPages(Integer value) { this.totalPages = value; return this; }
public Boolean isHasMorePages() { return hasMorePages; }
public ListResponse<T> setHasMorePages(Boolean value) { this.hasMorePages = value; return this; }
}
public static class AccountInfo extends EntityInfo
{
/**
* The name of this account
*/
@ApiMember(Description="The name of this account")
public String name = null;
/**
* The ID of this account's parent
*/
@ApiMember(Description="The ID of this account's parent")
public String parentAccountId = null;
/**
* The twilio account SID
*/
@ApiMember(Description="The twilio account SID")
public String twilioAccountSid = null;
/**
* The ancestors of this account. Useful for breadcrumbs
*/
@ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
public ArrayList<String> ancestorIds = null;
/**
* The max number of phone numbers this account can have
*/
@ApiMember(Description="The max number of phone numbers this account can have")
public Integer maxPhoneNumbers = null;
/**
* This account is BYOA
*/
@ApiMember(Description="This account is BYOA")
public Boolean isBYOA = null;
/**
* TrustHub Profile Sid
*/
@ApiMember(Description="TrustHub Profile Sid")
public String trustHubProfileSid = null;
/**
* The ID of the logo file
*/
@ApiMember(Description="The ID of the logo file")
public String logoId = null;
/**
* The URI of the logo file
*/
@ApiMember(Description="The URI of the logo file")
public String logoUri = null;
/**
* The billing settings for this account
*/
@ApiMember(Description="The billing settings for this account")
public BillingSettings billingSettings = null;
public String getName() { return name; }
public AccountInfo setName(String value) { this.name = value; return this; }
public String getParentAccountId() { return parentAccountId; }
public AccountInfo setParentAccountId(String value) { this.parentAccountId = value; return this; }
public String getTwilioAccountSid() { return twilioAccountSid; }
public AccountInfo setTwilioAccountSid(String value) { this.twilioAccountSid = value; return this; }
public ArrayList<String> getAncestorIds() { return ancestorIds; }
public AccountInfo setAncestorIds(ArrayList<String> value) { this.ancestorIds = value; return this; }
public Integer getMaxPhoneNumbers() { return maxPhoneNumbers; }
public AccountInfo setMaxPhoneNumbers(Integer value) { this.maxPhoneNumbers = value; return this; }
public Boolean getIsBYOA() { return isBYOA; }
public AccountInfo setIsBYOA(Boolean value) { this.isBYOA = value; return this; }
public String getTrustHubProfileSid() { return trustHubProfileSid; }
public AccountInfo setTrustHubProfileSid(String value) { this.trustHubProfileSid = value; return this; }
public String getLogoId() { return logoId; }
public AccountInfo setLogoId(String value) { this.logoId = value; return this; }
public String getLogoUri() { return logoUri; }
public AccountInfo setLogoUri(String value) { this.logoUri = value; return this; }
public BillingSettings getBillingSettings() { return billingSettings; }
public AccountInfo setBillingSettings(BillingSettings value) { this.billingSettings = value; return this; }
}
public static class BillingSettings
{
public BillingItem base = null;
public BillingItem localNumbers = null;
public BillingItem tollFreeNumbers = null;
public BillingItem inboundVoiceCalls = null;
public BillingItem outboundVoiceCalls = null;
public BillingItem inboundFaxes = null;
public BillingItem outboundFaxes = null;
public BillingItem inboundSmsMessages = null;
public BillingItem outboundSmsMessages = null;
public BillingItem aiInsights = null;
public BillingItem aiLiveMinutes = null;
public BillingItem getBase() { return base; }
public BillingSettings setBase(BillingItem value) { this.base = value; return this; }
public BillingItem getLocalNumbers() { return localNumbers; }
public BillingSettings setLocalNumbers(BillingItem value) { this.localNumbers = value; return this; }
public BillingItem getTollFreeNumbers() { return tollFreeNumbers; }
public BillingSettings setTollFreeNumbers(BillingItem value) { this.tollFreeNumbers = value; return this; }
public BillingItem getInboundVoiceCalls() { return inboundVoiceCalls; }
public BillingSettings setInboundVoiceCalls(BillingItem value) { this.inboundVoiceCalls = value; return this; }
public BillingItem getOutboundVoiceCalls() { return outboundVoiceCalls; }
public BillingSettings setOutboundVoiceCalls(BillingItem value) { this.outboundVoiceCalls = value; return this; }
public BillingItem getInboundFaxes() { return inboundFaxes; }
public BillingSettings setInboundFaxes(BillingItem value) { this.inboundFaxes = value; return this; }
public BillingItem getOutboundFaxes() { return outboundFaxes; }
public BillingSettings setOutboundFaxes(BillingItem value) { this.outboundFaxes = value; return this; }
public BillingItem getInboundSmsMessages() { return inboundSmsMessages; }
public BillingSettings setInboundSmsMessages(BillingItem value) { this.inboundSmsMessages = value; return this; }
public BillingItem getOutboundSmsMessages() { return outboundSmsMessages; }
public BillingSettings setOutboundSmsMessages(BillingItem value) { this.outboundSmsMessages = value; return this; }
public BillingItem getAiInsights() { return aiInsights; }
public BillingSettings setAiInsights(BillingItem value) { this.aiInsights = value; return this; }
public BillingItem getAiLiveMinutes() { return aiLiveMinutes; }
public BillingSettings setAiLiveMinutes(BillingItem value) { this.aiLiveMinutes = value; return this; }
}
public static class BillingItem
{
public Double baseCost = null;
public Double rawUnitMultiplier = null;
public Double unitCost = null;
public Integer allowance = null;
public Double getBaseCost() { return baseCost; }
public BillingItem setBaseCost(Double value) { this.baseCost = value; return this; }
public Double getRawUnitMultiplier() { return rawUnitMultiplier; }
public BillingItem setRawUnitMultiplier(Double value) { this.rawUnitMultiplier = value; return this; }
public Double getUnitCost() { return unitCost; }
public BillingItem setUnitCost(Double value) { this.unitCost = value; return this; }
public Integer getAllowance() { return allowance; }
public BillingItem setAllowance(Integer value) { this.allowance = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /flows HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListResponseOfFlowInfoM153aFo_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
<HasMorePages>false</HasMorePages>
<Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows">
<d2p1:FlowInfo>
<CreatedBy>String</CreatedBy>
<DateCreated>String</DateCreated>
<DateLastModified>String</DateLastModified>
<Id>String</Id>
<LastModifiedBy>String</LastModifiedBy>
<d2p1:AccountId>String</d2p1:AccountId>
<d2p1:AccountName>String</d2p1:AccountName>
<d2p1:CustomerBreadcrumb xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
<d4p1:CustomerBreadcrumb>
<d4p1:Id>String</d4p1:Id>
<d4p1:Name>String</d4p1:Name>
</d4p1:CustomerBreadcrumb>
</d2p1:CustomerBreadcrumb>
<d2p1:CustomerId>String</d2p1:CustomerId>
<d2p1:CustomerName>String</d2p1:CustomerName>
<d2p1:Description>String</d2p1:Description>
<d2p1:Exits>
<d2p1:FlowExit>
<d2p1:Id>String</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:UI>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:X>0</d2p1:X>
<d2p1:Y>0</d2p1:Y>
</d2p1:UI>
</d2p1:FlowExit>
</d2p1:Exits>
<d2p1:Name>String</d2p1:Name>
<d2p1:NodeCount>0</d2p1:NodeCount>
<d2p1:Nodes>
<d2p1:FlowNode>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsStartNode>false</d2p1:IsStartNode>
<d2p1:Name>String</d2p1:Name>
<d2p1:Parameters xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringNodeParameteripFhVFNS>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value i:nil="true" />
</d6p1:KeyValueOfstringNodeParameteripFhVFNS>
</d2p1:Parameters>
<d2p1:Spec>
<d2p1:Category>General</d2p1:Category>
<d2p1:DataType xmlns:d7p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" />
<d2p1:Description>String</d2p1:Description>
<d2p1:DocumentationUrl>String</d2p1:DocumentationUrl>
<d2p1:IconClass>String</d2p1:IconClass>
<d2p1:Name>String</d2p1:Name>
<d2p1:RestrictToChannels>
<d2p1:FlowChannels>Voice</d2p1:FlowChannels>
</d2p1:RestrictToChannels>
<d2p1:TypeName>String</d2p1:TypeName>
<d2p1:Url>String</d2p1:Url>
</d2p1:Spec>
<d2p1:UI>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:X>0</d2p1:X>
<d2p1:Y>0</d2p1:Y>
</d2p1:UI>
</d2p1:FlowNode>
</d2p1:Nodes>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:Parameters>
<d2p1:FlowParameter>
<AnyValueType xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</AnyValueType>
<ConditionalVisibilityField xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</ConditionalVisibilityField>
<ConditionalVisibilityValue xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</ConditionalVisibilityValue>
<CustomFieldValuesUrl xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</CustomFieldValuesUrl>
<DefaultValue xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
<BoolValue>false</BoolValue>
<ListValue xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:ArrayOfKeyValueOfstringValue8Ahp2kgT i:nil="true" />
</ListValue>
<NumberValue>0</NumberValue>
<StringValue>String</StringValue>
<StructValue xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</DefaultValue>
<Description xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Description>
<DisableBinding xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</DisableBinding>
<Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Id>
<IsAsync xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</IsAsync>
<IsOutput xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</IsOutput>
<ListType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" />
<Name xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</Name>
<NoEvalTemplate xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</NoEvalTemplate>
<PossibleValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">
<d6p1:string>String</d6p1:string>
</PossibleValues>
<StructType i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" />
<TransitionNameFormat xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</TransitionNameFormat>
<Type xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">NotSpecified</Type>
<UIHint xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">None</UIHint>
<UITab xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">String</UITab>
<Uniqueness xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">NotUnique</Uniqueness>
<UserMode xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">Hidden</UserMode>
<VoiceOnly xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data">false</VoiceOnly>
<d2p1:IsKnob>false</d2p1:IsKnob>
<d2p1:IsPublic>false</d2p1:IsPublic>
</d2p1:FlowParameter>
</d2p1:Parameters>
<d2p1:Roles>
<d2p1:FlowRoles>UI</d2p1:FlowRoles>
</d2p1:Roles>
<d2p1:Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings">
<d4p1:Tag>
<d4p1:Color>Magenta</d4p1:Color>
<d4p1:Id>String</d4p1:Id>
<d4p1:Name>String</d4p1:Name>
</d4p1:Tag>
</d2p1:Tags>
<d2p1:UI>
<d2p1:CanvasX>0</d2p1:CanvasX>
<d2p1:CanvasY>0</d2p1:CanvasY>
<d2p1:CanvasZoom>0</d2p1:CanvasZoom>
<d2p1:SelectedNode>String</d2p1:SelectedNode>
</d2p1:UI>
</d2p1:FlowInfo>
</Items>
<TotalCount>0</TotalCount>
<TotalPages>0</TotalPages>
</ListResponseOfFlowInfoM153aFo_P>