Evo Voice

<back to all web services

PatchIntegration

Update a specific integration

The following routes are available for this service:
PATCH/integrations/{integrationId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Update a specific integration
*/
@Api(Description="Update a specific integration")
open class PatchIntegration : IPatch
{
    /**
    * The ID of the integration you want to update
    */
    @ApiMember(Description="The ID of the integration you want to update")
    open var integrationId:String? = null

    /**
    * The name for the integration
    */
    @ApiMember(Description="The name for the integration")
    open var name:String? = null

    /**
    * The parent customer for this integration
    */
    @ApiMember(Description="The parent customer for this integration")
    open var customerId: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

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

open class Struct : HashMap<String,Value>()
{
}

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 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,
}

enum class DataFieldUniqueness
{
    NotUnique,
    Unique,
    UniqueToCustomer,
}

enum class UserDataFieldModes
{
    Hidden,
    ReadOnly,
    ReadWrite,
}

enum class IntegrationFeatures
{
    CrmSync,
    OAuth2,
}

Kotlin PatchIntegration DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /integrations/{integrationId} HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchIntegration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Integrations">
  <AutomaticallyCreateCustomers>false</AutomaticallyCreateCustomers>
  <CustomerId>String</CustomerId>
  <IntegrationId>String</IntegrationId>
  <Name>String</Name>
  <Settings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</PatchIntegration>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IntegrationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Integrations">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
  <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
  <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
  <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
  <AccountId>String</AccountId>
  <AutomaticallyCreateCustomers>false</AutomaticallyCreateCustomers>
  <CustomerBreadcrumb xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
    <d2p1:CustomerBreadcrumb>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:CustomerBreadcrumb>
  </CustomerBreadcrumb>
  <CustomerId>String</CustomerId>
  <CustomerName>String</CustomerName>
  <DateLastSync>String</DateLastSync>
  <Features>
    <IntegrationFeatures>CrmSync</IntegrationFeatures>
  </Features>
  <IsAuthorized>false</IsAuthorized>
  <Name>String</Name>
  <Settings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <SettingsDataType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Flows.Data" i:nil="true" />
  <Status>NotConfigured</Status>
  <StatusMessage>String</StatusMessage>
  <Type>HostedSuite</Type>
</IntegrationInfo>