| GET | /integrations |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Integrations
Imports Voice.Api
Imports Voice.Api.Customers
Imports Voice.Api.Flows.Data
Imports Voice.Api.Endpoints
Imports Voice.Api.Accounts
Namespace Global
Namespace Voice.Api
Public Partial Class EntityInfo
'''<Summary>
'''The ID of the object
'''</Summary>
<ApiMember(Description:="The ID of the object")>
Public Overridable Property Id As String
'''<Summary>
'''The date the object was created
'''</Summary>
<ApiMember(Description:="The date the object was created")>
Public Overridable Property DateCreated As String
'''<Summary>
'''The date the object was last modified
'''</Summary>
<ApiMember(Description:="The date the object was last modified")>
Public Overridable Property DateLastModified As String
'''<Summary>
'''The user that created this object
'''</Summary>
<ApiMember(Description:="The user that created this object")>
Public Overridable Property CreatedBy As String
'''<Summary>
'''The user that last modified this object
'''</Summary>
<ApiMember(Description:="The user that last modified this object")>
Public Overridable Property LastModifiedBy As String
End Class
Public Partial Class ListRequest(Of T)
Implements IGet
'''<Summary>
'''The page of data to retrieve
'''</Summary>
<ApiMember(Description:="The page of data to retrieve")>
Public Overridable Property Page As Integer
'''<Summary>
'''If you want all objects to be returned. This should be used with care
'''</Summary>
<ApiMember(Description:="If you want all objects to be returned. This should be used with care")>
Public Overridable Property All As Boolean
'''<Summary>
'''The number per page to retrieve
'''</Summary>
<ApiMember(Description:="The number per page to retrieve")>
Public Overridable Property CountPerPage As Integer
'''<Summary>
'''Specific IDs
'''</Summary>
<ApiMember(Description:="Specific IDs")>
Public Overridable Property SpecificIds As List(Of String)
'''<Summary>
'''Specify a sort field
'''</Summary>
<ApiMember(Description:="Specify a sort field")>
Public Overridable Property SortField As String
'''<Summary>
'''Specify a sort order
'''</Summary>
<ApiMember(Description:="Specify a sort order")>
Public Overridable Property SortOrder As SortOrders
'''<Summary>
'''Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
'''</Summary>
<ApiMember(Description:="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")>
Public Overridable Property SimplifiedPaging As Boolean
End Class
Public Partial Class ListResponse(Of T)
'''<Summary>
'''The items
'''</Summary>
<ApiMember(Description:="The items")>
Public Overridable Property Items As List(Of AccountInfo)
'''<Summary>
'''The total number of items
'''</Summary>
<ApiMember(Description:="The total number of items")>
Public Overridable Property TotalCount As Integer
'''<Summary>
'''The total number of pages
'''</Summary>
<ApiMember(Description:="The total number of pages")>
Public Overridable Property TotalPages As Integer
'''<Summary>
'''Are there more pages of items? Used with simplified paging
'''</Summary>
<ApiMember(Description:="Are there more pages of items? Used with simplified paging")>
Public Overridable Property HasMorePages As Boolean
End Class
Public Enum SortOrders
Ascend
Descend
End Enum
End Namespace
Namespace Voice.Api.Accounts
Public Partial Class AccountInfo
Inherits EntityInfo
'''<Summary>
'''The name of this account
'''</Summary>
<ApiMember(Description:="The name of this account")>
Public Overridable Property Name As String
'''<Summary>
'''The ID of this account's parent
'''</Summary>
<ApiMember(Description:="The ID of this account's parent")>
Public Overridable Property ParentAccountId As String
'''<Summary>
'''The twilio account SID
'''</Summary>
<ApiMember(Description:="The twilio account SID")>
Public Overridable Property TwilioAccountSid As String
'''<Summary>
'''The ancestors of this account. Useful for breadcrumbs
'''</Summary>
<ApiMember(Description:="The ancestors of this account. Useful for breadcrumbs")>
Public Overridable Property AncestorIds As List(Of String)
'''<Summary>
'''The max number of phone numbers this account can have
'''</Summary>
<ApiMember(Description:="The max number of phone numbers this account can have")>
Public Overridable Property MaxPhoneNumbers As Integer
'''<Summary>
'''This account is BYOA
'''</Summary>
<ApiMember(Description:="This account is BYOA")>
Public Overridable Property IsBYOA As Boolean
'''<Summary>
'''TrustHub Profile Sid
'''</Summary>
<ApiMember(Description:="TrustHub Profile Sid")>
Public Overridable Property TrustHubProfileSid As String
'''<Summary>
'''The ID of the logo file
'''</Summary>
<ApiMember(Description:="The ID of the logo file")>
Public Overridable Property LogoId As String
'''<Summary>
'''The URI of the logo file
'''</Summary>
<ApiMember(Description:="The URI of the logo file")>
Public Overridable Property LogoUri As String
'''<Summary>
'''The billing settings for this account
'''</Summary>
<ApiMember(Description:="The billing settings for this account")>
Public Overridable Property BillingSettings As BillingSettings
End Class
Public Partial Class BillingItem
Public Overridable Property BaseCost As Double
Public Overridable Property RawUnitMultiplier As Double
Public Overridable Property UnitCost As Double
Public Overridable Property Allowance As Integer
End Class
Public Partial Class BillingSettings
Public Overridable Property Base As BillingItem
Public Overridable Property LocalNumbers As BillingItem
Public Overridable Property TollFreeNumbers As BillingItem
Public Overridable Property InboundVoiceCalls As BillingItem
Public Overridable Property OutboundVoiceCalls As BillingItem
Public Overridable Property InboundFaxes As BillingItem
Public Overridable Property OutboundFaxes As BillingItem
Public Overridable Property InboundSmsMessages As BillingItem
Public Overridable Property OutboundSmsMessages As BillingItem
Public Overridable Property AIInsights As BillingItem
Public Overridable Property AILiveMinutes As BillingItem
End Class
End Namespace
Namespace Voice.Api.Customers
Public Partial Class CustomerBreadcrumb
Public Overridable Property Id As String
Public Overridable Property Name As String
End Class
End Namespace
Namespace Voice.Api.Endpoints
Public Enum UserDataFieldModes
Hidden
[ReadOnly]
ReadWrite
End Enum
End Namespace
Namespace Voice.Api.Flows.Data
Public Partial Class DataField
Public Overridable Property Id As String
Public Overridable Property Name As String
Public Overridable Property Type As ValueTypes
Public Overridable Property UIHint As UIHints
Public Overridable Property UITab As String
Public Overridable Property IsAsync As Boolean
Public Overridable Property DisableBinding As Boolean
Public Overridable Property StructType As DataType
Public Overridable Property ListType As DataType
Public Overridable Property Description As String
Public Overridable Property PossibleValues As List(Of String)
Public Overridable Property IsOutput As Boolean
Public Overridable Property CustomFieldValuesUrl As String
Public Overridable Property DefaultValue As Value
Public Overridable Property TransitionNameFormat As String
Public Overridable Property Uniqueness As DataFieldUniqueness
Public Overridable Property VoiceOnly As Boolean
Public Overridable Property ConditionalVisibilityField As String
Public Overridable Property ConditionalVisibilityValue As String
Public Overridable Property NoEvalTemplate As Boolean
Public Overridable Property UserMode As UserDataFieldModes
Public Overridable Property AnyValueType As Boolean
End Class
Public Enum DataFieldUniqueness
NotUnique
Unique
UniqueToCustomer
End Enum
Public Partial Class DataType
Public Overridable Property TypeName As String
Public Overridable Property Fields As List(Of DataField)
End Class
Public Partial Class Struct
Inherits Dictionary(Of String, Value)
End Class
Public Enum UIHints
None
LargeText
InlineForm
Password
InlineStruct
End Enum
Public Partial Class Value
Public Overridable Property BoolValue As Boolean?
Public Overridable Property StringValue As String
Public Overridable Property NumberValue As Double?
Public Overridable Property ListValue As List(Of Struct)
Public Overridable Property StructValue As Struct
End Class
Public 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
End Enum
End Namespace
Namespace Voice.Api.Integrations
Public Enum IntegrationFeatures
CrmSync
OAuth2
End Enum
Public Partial Class IntegrationInfo
Inherits EntityInfo
'''<Summary>
'''The ID of the account associated with this integration
'''</Summary>
<ApiMember(Description:="The ID of the account associated with this integration")>
Public Overridable Property AccountId As String
'''<Summary>
'''The ID of the customer this integration is associated with
'''</Summary>
<ApiMember(Description:="The ID of the customer this integration is associated with")>
Public Overridable Property CustomerId As String
'''<Summary>
'''The name of the customer this integration is associated with
'''</Summary>
<ApiMember(Description:="The name of the customer this integration is associated with")>
Public Overridable Property CustomerName As String
'''<Summary>
'''The date the integration was sync'd last
'''</Summary>
<ApiMember(Description:="The date the integration was sync'd last")>
Public Overridable Property DateLastSync As String
'''<Summary>
'''The breadcrumb to the customer for this integration
'''</Summary>
<ApiMember(Description:="The breadcrumb to the customer for this integration")>
Public Overridable Property CustomerBreadcrumb As List(Of CustomerBreadcrumb)
'''<Summary>
'''The name of the integration (e.g. HostedSuite Dallas)
'''</Summary>
<ApiMember(Description:="The name of the integration (e.g. HostedSuite Dallas)")>
Public Overridable Property Name As String
'''<Summary>
'''Automatically create new customers / users when sync'ing with CRM?
'''</Summary>
<ApiMember(Description:="Automatically create new customers / users when sync'ing with CRM?")>
Public Overridable Property AutomaticallyCreateCustomers As Boolean
'''<Summary>
'''The type of integration
'''</Summary>
<ApiMember(Description:="The type of integration")>
Public Overridable Property Type As IntegrationTypes
'''<Summary>
'''The status of the integration
'''</Summary>
<ApiMember(Description:="The status of the integration")>
Public Overridable Property Status As IntegrationStatuses
'''<Summary>
'''The status of the integration
'''</Summary>
<ApiMember(Description:="The status of the integration")>
Public Overridable Property StatusMessage As String
'''<Summary>
'''The settings type for this integration
'''</Summary>
<ApiMember(Description:="The settings type for this integration")>
Public Overridable Property SettingsDataType As DataType
'''<Summary>
'''The settings for this integration
'''</Summary>
<ApiMember(Description:="The settings for this integration")>
Public Overridable Property Settings As Struct
'''<Summary>
'''The features supported by this integration
'''</Summary>
<ApiMember(Description:="The features supported by this integration")>
Public Overridable Property Features As List(Of IntegrationFeatures)
'''<Summary>
'''Is this integration authorized (OAuth)?
'''</Summary>
<ApiMember(Description:="Is this integration authorized (OAuth)?")>
Public Overridable Property IsAuthorized As Boolean
End Class
Public Enum IntegrationStatuses
NotConfigured
[Error]
OK
End Enum
Public Enum IntegrationTypes
HostedSuite
OfficeRnd
Zoho
End Enum
'''<Summary>
'''Retrieve integrations
'''</Summary>
<Api(Description:="Retrieve integrations")>
Public Partial Class ListIntegrations
Inherits ListRequest(Of IntegrationInfo)
'''<Summary>
'''Filter by accounts
'''</Summary>
<ApiMember(Description:="Filter by accounts")>
Public Overridable Property AccountIds As List(Of String)
'''<Summary>
'''Filter by name
'''</Summary>
<ApiMember(Description:="Filter by name")>
Public Overridable Property NameFilter As String
'''<Summary>
'''The IDs of the parent customers you want to filter by
'''</Summary>
<ApiMember(Description:="The IDs of the parent customers you want to filter by")>
Public Overridable Property CustomerIds As List(Of String)
'''<Summary>
'''If you want a shall customer integration filter (e.g. no deep children)
'''</Summary>
<ApiMember(Description:="If you want a shall customer integration filter (e.g. no deep children)")>
Public Overridable Property ShallowParent As Boolean
End Class
End Namespace
End Namespace
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 /integrations HTTP/1.1 Host: team.evovoice.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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,
features:
[
CrmSync
],
isAuthorized: False,
id: String,
dateCreated: String,
dateLastModified: String,
createdBy: String,
lastModifiedBy: String
}
],
totalCount: 0,
totalPages: 0,
hasMorePages: False
}