| GET | /integrations |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Retrieve integrations
*/
@Api(Description="Retrieve integrations")
open class ListIntegrations : ListRequest<IntegrationInfo>()
{
/**
* Filter by accounts
*/
@ApiMember(Description="Filter by accounts")
var accountIds:ArrayList<String> = ArrayList<String>()
/**
* Filter by name
*/
@ApiMember(Description="Filter by name")
var nameFilter:String? = null
/**
* The IDs of the parent customers you want to filter by
*/
@ApiMember(Description="The IDs of the parent customers you want to filter by")
var customerIds:ArrayList<String> = ArrayList<String>()
/**
* If you want a shall customer integration filter (e.g. no deep children)
*/
@ApiMember(Description="If you want a shall customer integration filter (e.g. no deep children)")
var shallowParent:Boolean? = null
}
open class ListRequest<T> : IGet
{
/**
* The page of data to retrieve
*/
@ApiMember(Description="The page of data to retrieve")
var page:Int? = 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")
var all:Boolean? = null
/**
* The number per page to retrieve
*/
@ApiMember(Description="The number per page to retrieve")
var countPerPage:Int? = null
/**
* Specific IDs
*/
@ApiMember(Description="Specific IDs")
var specificIds:ArrayList<String> = ArrayList<String>()
/**
* Specify a sort field
*/
@ApiMember(Description="Specify a sort field")
var sortField:String? = null
/**
* Specify a sort order
*/
@ApiMember(Description="Specify a sort order")
var sortOrder:SortOrders? = 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")
var simplifiedPaging:Boolean? = null
}
enum class SortOrders
{
Ascend,
Descend,
}
open class IntegrationInfo : EntityInfo()
{
/**
* The ID of the account associated with this integration
*/
@ApiMember(Description="The ID of the account associated with this integration")
var accountId:String? = null
/**
* The ID of the customer this integration is associated with
*/
@ApiMember(Description="The ID of the customer this integration is associated with")
var customerId:String? = null
/**
* The name of the customer this integration is associated with
*/
@ApiMember(Description="The name of the customer this integration is associated with")
var customerName:String? = null
/**
* The date the integration was sync'd last
*/
@ApiMember(Description="The date the integration was sync'd last")
var dateLastSync:String? = null
/**
* The breadcrumb to the customer for this integration
*/
@ApiMember(Description="The breadcrumb to the customer for this integration")
var customerBreadcrumb:ArrayList<CustomerBreadcrumb> = ArrayList<CustomerBreadcrumb>()
/**
* The name of the integration (e.g. HostedSuite Dallas)
*/
@ApiMember(Description="The name of the integration (e.g. HostedSuite Dallas)")
var name:String? = null
/**
* Automatically create new customers / users when sync'ing with CRM?
*/
@ApiMember(Description="Automatically create new customers / users when sync'ing with CRM?")
var automaticallyCreateCustomers:Boolean? = null
/**
* The type of integration
*/
@ApiMember(Description="The type of integration")
@SerializedName("type") var Type:IntegrationTypes? = null
/**
* The status of the integration
*/
@ApiMember(Description="The status of the integration")
var status:IntegrationStatuses? = null
/**
* The status of the integration
*/
@ApiMember(Description="The status of the integration")
var statusMessage:String? = null
/**
* The settings type for this integration
*/
@ApiMember(Description="The settings type for this integration")
var settingsDataType:DataType? = null
/**
* The settings for this integration
*/
@ApiMember(Description="The settings for this integration")
var settings:Struct? = null
/**
* The features supported by this integration
*/
@ApiMember(Description="The features supported by this integration")
var features:ArrayList<IntegrationFeatures> = ArrayList<IntegrationFeatures>()
/**
* Is this integration authorized (OAuth)?
*/
@ApiMember(Description="Is this integration authorized (OAuth)?")
var isAuthorized:Boolean? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
var lastModifiedBy:String? = null
}
open class CustomerBreadcrumb
{
var id:String? = null
var name:String? = null
}
enum class IntegrationTypes
{
HostedSuite,
OfficeRnd,
Zoho,
}
enum class IntegrationStatuses
{
NotConfigured,
Error,
Ok,
}
open class DataType
{
var typeName:String? = null
var fields:ArrayList<DataField> = ArrayList<DataField>()
}
open class DataField
{
var id:String? = null
var name:String? = null
@SerializedName("type") var Type:ValueTypes? = null
var uiHint:UIHints? = null
var uiTab:String? = null
var isAsync:Boolean? = null
var disableBinding:Boolean? = null
var structType:DataType? = null
var listType:DataType? = null
var description:String? = null
var possibleValues:ArrayList<String> = ArrayList<String>()
var isOutput:Boolean? = null
var customFieldValuesUrl:String? = null
var defaultValue:Value? = null
var transitionNameFormat:String? = null
var uniqueness:DataFieldUniqueness? = null
var voiceOnly:Boolean? = null
var conditionalVisibilityField:String? = null
var conditionalVisibilityValue:String? = null
var noEvalTemplate:Boolean? = null
var userMode:UserDataFieldModes? = null
var anyValueType:Boolean? = null
}
enum class ValueTypes
{
NotSpecified,
String,
Boolean,
Number,
List,
Struct,
Transition,
Custom,
Date,
AudioFile,
TimeZoneId,
PhoneNumber,
User,
Endpoint,
Time,
File,
FaxNumber,
EmailAccount,
Customer,
Flow,
Team,
FlowReference,
Integration,
}
enum class UIHints
{
None,
LargeText,
InlineForm,
Password,
InlineStruct,
}
open class Value
{
var boolValue:Boolean? = null
var stringValue:String? = null
var numberValue:Double? = null
var listValue:ArrayList<Struct> = ArrayList<Struct>()
var structValue:Struct? = null
}
open class Struct : HashMap<String,Value>()
{
}
enum class DataFieldUniqueness
{
NotUnique,
Unique,
UniqueToCustomer,
}
enum class UserDataFieldModes
{
Hidden,
ReadOnly,
ReadWrite,
}
enum class IntegrationFeatures
{
CrmSync,
OAuth2,
}
open class ListResponse<AccountInfo>
{
/**
* The items
*/
@ApiMember(Description="The items")
var items:ArrayList<AccountInfo> = ArrayList<AccountInfo>()
/**
* The total number of items
*/
@ApiMember(Description="The total number of items")
var totalCount:Int? = null
/**
* The total number of pages
*/
@ApiMember(Description="The total number of pages")
var totalPages:Int? = null
/**
* Are there more pages of items? Used with simplified paging
*/
@ApiMember(Description="Are there more pages of items? Used with simplified paging")
var hasMorePages:Boolean? = null
}
open class AccountInfo : EntityInfo()
{
/**
* The name of this account
*/
@ApiMember(Description="The name of this account")
var name:String? = null
/**
* The ID of this account's parent
*/
@ApiMember(Description="The ID of this account's parent")
var parentAccountId:String? = null
/**
* The twilio account SID
*/
@ApiMember(Description="The twilio account SID")
var twilioAccountSid:String? = null
/**
* The ancestors of this account. Useful for breadcrumbs
*/
@ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
var ancestorIds:ArrayList<String> = ArrayList<String>()
/**
* The max number of phone numbers this account can have
*/
@ApiMember(Description="The max number of phone numbers this account can have")
var maxPhoneNumbers:Int? = null
/**
* This account is BYOA
*/
@ApiMember(Description="This account is BYOA")
var isBYOA:Boolean? = null
/**
* TrustHub Profile Sid
*/
@ApiMember(Description="TrustHub Profile Sid")
var trustHubProfileSid:String? = null
/**
* The ID of the logo file
*/
@ApiMember(Description="The ID of the logo file")
var logoId:String? = null
/**
* The URI of the logo file
*/
@ApiMember(Description="The URI of the logo file")
var logoUri:String? = null
/**
* The billing settings for this account
*/
@ApiMember(Description="The billing settings for this account")
var billingSettings:BillingSettings? = null
}
open class BillingSettings
{
var base:BillingItem? = null
var localNumbers:BillingItem? = null
var tollFreeNumbers:BillingItem? = null
var inboundVoiceCalls:BillingItem? = null
var outboundVoiceCalls:BillingItem? = null
var inboundFaxes:BillingItem? = null
var outboundFaxes:BillingItem? = null
var inboundSmsMessages:BillingItem? = null
var outboundSmsMessages:BillingItem? = null
}
open class BillingItem
{
var baseCost:Double? = null
var rawUnitMultiplier:Double? = null
var unitCost:Double? = null
var allowance:Int? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /integrations HTTP/1.1 Host: evovoice.io Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":[{"accountId":"String","customerId":"String","customerName":"String","dateLastSync":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"name":"String","automaticallyCreateCustomers":false,"type":"HostedSuite","status":"NotConfigured","statusMessage":"String","settingsDataType":{"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":[{"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":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,"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,"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,"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}]},"settings":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"features":["CrmSync"],"isAuthorized":false,"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"totalCount":0,"totalPages":0,"hasMorePages":false}