Evo Voice

<back to all web services

GetIntegration

Get a specific integration

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Get a specific integration
*/
@Api(Description="Get a specific integration")
open class GetIntegration : IGet
{
    /**
    * The ID of the integration you want to get
    */
    @ApiMember(Description="The ID of the integration you want to get")
    open var integrationId:String? = null
}

open class IntegrationInfo : EntityInfo()
{
    /**
    * The ID of the account associated with this integration
    */
    @ApiMember(Description="The ID of the account associated with this integration")
    open 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")
    open 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")
    open var customerName:String? = null

    /**
    * The date the integration was sync'd last
    */
    @ApiMember(Description="The date the integration was sync'd last")
    open var dateLastSync:String? = null

    /**
    * The breadcrumb to the customer for this integration
    */
    @ApiMember(Description="The breadcrumb to the customer for this integration")
    open var customerBreadcrumb:ArrayList<CustomerBreadcrumb>? = null

    /**
    * The name of the integration (e.g. HostedSuite Dallas)
    */
    @ApiMember(Description="The name of the integration (e.g. HostedSuite Dallas)")
    open 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?")
    open var automaticallyCreateCustomers:Boolean? = null

    /**
    * The type of integration
    */
    @ApiMember(Description="The type of integration")
    @SerializedName("type") open var Type:IntegrationTypes? = null

    /**
    * The status of the integration
    */
    @ApiMember(Description="The status of the integration")
    open var status:IntegrationStatuses? = null

    /**
    * The status of the integration
    */
    @ApiMember(Description="The status of the integration")
    open var statusMessage:String? = null

    /**
    * The settings type for this integration
    */
    @ApiMember(Description="The settings type for this integration")
    open var settingsDataType:DataType? = null

    /**
    * The settings for this integration
    */
    @ApiMember(Description="The settings for this integration")
    open var settings:Struct? = null

    /**
    * The features supported by this integration
    */
    @ApiMember(Description="The features supported by this integration")
    open var features:ArrayList<IntegrationFeatures>? = null

    /**
    * Is this integration authorized (OAuth)?
    */
    @ApiMember(Description="Is this integration authorized (OAuth)?")
    open var isAuthorized:Boolean? = null
}

open class EntityInfo
{
    /**
    * The ID of the object
    */
    @ApiMember(Description="The ID of the object")
    open var id:String? = null

    /**
    * The date the object was created
    */
    @ApiMember(Description="The date the object was created")
    open var dateCreated:String? = null

    /**
    * The date the object was last modified
    */
    @ApiMember(Description="The date the object was last modified")
    open var dateLastModified:String? = null

    /**
    * The user that created this object
    */
    @ApiMember(Description="The user that created this object")
    open var createdBy:String? = null

    /**
    * The user that last modified this object
    */
    @ApiMember(Description="The user that last modified this object")
    open var lastModifiedBy:String? = null
}

open class CustomerBreadcrumb
{
    open var id:String? = null
    open var name:String? = null
}

enum class IntegrationTypes
{
    HostedSuite,
    OfficeRnd,
    Zoho,
}

enum class IntegrationStatuses
{
    NotConfigured,
    Error,
    Ok,
}

open class DataType
{
    open var typeName:String? = null
    open var fields:ArrayList<DataField>? = null
}

open class DataField
{
    open var id:String? = null
    open var name:String? = null
    @SerializedName("type") open var Type:ValueTypes? = null
    open var uiHint:UIHints? = null
    open var uiTab:String? = null
    open var isAsync:Boolean? = null
    open var disableBinding:Boolean? = null
    open var structType:DataType? = null
    open var listType:DataType? = null
    open var description:String? = null
    open var possibleValues:ArrayList<String>? = null
    open var isOutput:Boolean? = null
    open var customFieldValuesUrl:String? = null
    open var defaultValue:Value? = null
    open var transitionNameFormat:String? = null
    open var uniqueness:DataFieldUniqueness? = null
    open var voiceOnly:Boolean? = null
    open var conditionalVisibilityField:String? = null
    open var conditionalVisibilityValue:String? = null
    open var noEvalTemplate:Boolean? = null
    open var userMode:UserDataFieldModes? = null
    open 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,
    Assistant,
}

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

open class Value
{
    open var boolValue:Boolean? = null
    open var stringValue:String? = null
    open var numberValue:Double? = null
    open var listValue:ArrayList<Struct>? = null
    open 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,
}

Kotlin GetIntegration DTOs

GET /integrations/{integrationId} HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv

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

{
	accountId: String,
	customerId: String,
	customerName: String,
	dateLastSync: String,
	customerBreadcrumb: 
	[
		{
			id: String,
			name: String
		}
	],
	name: String,
	automaticallyCreateCustomers: False,
	type: HostedSuite,
	status: NotConfigured,
	statusMessage: String,
	features: 
	[
		CrmSync
	],
	isAuthorized: False,
	id: String,
	dateCreated: String,
	dateLastModified: String,
	createdBy: String,
	lastModifiedBy: String
}