' Options:
'Date: 2024-05-17 01:54:31
'Version: 6.40
'Tip: To override a DTO option, remove "''" prefix before updating
'BaseUrl: https://evovoice.io
'
'''GlobalNamespace:
'''MakePartial: True
'''MakeVirtual: True
'''MakeDataContractsExtensible: False
'''AddReturnMarker: True
'''AddDescriptionAsComments: True
'''AddDataContractAttributes: False
'''AddIndexesToDataMembers: False
'''AddGeneratedCodeAttributes: False
'''AddResponseStatus: False
'''AddImplicitVersion:
'''InitializeCollections: True
'''ExportValueTypes: False
'IncludeTypes: ListSessions.*
'''ExcludeTypes:
'''AddNamespaces:
'''AddDefaultXmlNamespace: http://schemas.servicestack.net/types
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports System.IO
Imports Voice.Api
Imports Voice.Api.Portal
Imports Voice.Api.Sys
Imports Voice.Api.Customers
Imports Voice.Api.Accounts
Imports Voice.Api.Sessions
Namespace Global
Namespace Voice.Api
Public Partial Class EntityInfo
'''
'''The ID of the object
'''
Public Overridable Property Id As String
'''
'''The date the object was created
'''
Public Overridable Property DateCreated As String
'''
'''The date the object was last modified
'''
Public Overridable Property DateLastModified As String
'''
'''The user that created this object
'''
Public Overridable Property CreatedBy As String
'''
'''The user that last modified this object
'''
Public Overridable Property LastModifiedBy As String
End Class
Public Partial Class ListRequest(Of T)
Implements IGet
Public Sub New()
SpecificIds = New List(Of String)
End Sub
'''
'''The page of data to retrieve
'''
Public Overridable Property Page As Integer
'''
'''If you want all objects to be returned. This should be used with care
'''
Public Overridable Property All As Boolean
'''
'''The number per page to retrieve
'''
Public Overridable Property CountPerPage As Integer
'''
'''Specific IDs
'''
Public Overridable Property SpecificIds As List(Of String)
'''
'''Specify a sort field
'''
Public Overridable Property SortField As String
'''
'''Specify a sort order
'''
Public Overridable Property SortOrder As SortOrders
'''
'''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 SessionInfo)
Public Sub New()
Items = New List(Of SessionInfo)
End Sub
'''
'''The items
'''
Public Overridable Property Items As List(Of SessionInfo)
'''
'''The total number of items
'''
Public Overridable Property TotalCount As Integer
'''
'''The total number of pages
'''
Public Overridable Property TotalPages As Integer
'''
'''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
Public Sub New()
AncestorIds = New List(Of String)
End Sub
'''
'''The name of this account
'''
Public Overridable Property Name As String
'''
'''The ID of this account's parent
'''
Public Overridable Property ParentAccountId As String
'''
'''The twilio account SID
'''
Public Overridable Property TwilioAccountSid As String
'''
'''The ancestors of this account. Useful for breadcrumbs
'''
Public Overridable Property AncestorIds As List(Of String)
'''
'''The max number of phone numbers this account can have
'''
Public Overridable Property MaxPhoneNumbers As Integer
'''
'''This account is BYOA
'''
Public Overridable Property IsBYOA As Boolean
'''
'''TrustHub Profile Sid
'''
Public Overridable Property TrustHubProfileSid As String
'''
'''The ID of the logo file
'''
Public Overridable Property LogoId As String
'''
'''The URI of the logo file
'''
Public Overridable Property LogoUri As String
'''
'''The billing settings for this account
'''
Public Overridable Property BillingSettings As BillingSettings
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.Portal
Public Partial Class HostedSuiteCompletedForm
Public Sub New()
ContactsIds = New List(Of String)
ContactsNames = New List(Of String)
Fields = New List(Of HostedSuiteCompletedFormField)
End Sub
Public Overridable Property Id As String
Public Overridable Property Name As String
Public Overridable Property DateCreated As String
Public Overridable Property DateCompleted As String
Public Overridable Property FormId As String
Public Overridable Property FormName As String
Public Overridable Property ClientId As String
Public Overridable Property ClientName As String
Public Overridable Property ContactId As String
Public Overridable Property ContactName As String
Public Overridable Property ContactsIds As List(Of String)
Public Overridable Property ContactsNames As List(Of String)
Public Overridable Property EmailSubject As String
Public Overridable Property CallerNumber As String
Public Overridable Property Fields As List(Of HostedSuiteCompletedFormField)
End Class
Public Partial Class HostedSuiteCompletedFormField
Public Sub New()
Values = New List(Of String)
End Sub
Public Overridable Property Name As String
Public Overridable Property Values As List(Of String)
End Class
End Namespace
Namespace Voice.Api.Sessions
'''
'''Retrieve a list of sessions
'''
Public Partial Class ListSessions
Inherits ListRequest(Of SessionInfo)
Implements IReturn(Of ListResponse(Of SessionInfo))
Public Sub New()
AccountIds = New List(Of String)
CustomerIds = New List(Of String)
EndpointIds = New List(Of String)
End Sub
'''
'''The account IDs for the sessions to retrieve
'''
Public Overridable Property AccountIds As List(Of String)
'''
'''Whether to search live or archived sessions
'''
Public Overridable Property SearchArchive As Boolean
'''
'''The start date to retrieve usage records for (YYYY-MM-DD)
'''
Public Overridable Property StartDate As String
'''
'''The end date to retrieve usage records for (YYYY-MM-DD)
'''
Public Overridable Property EndDate As String
'''
'''The IDs of the customers whose sessions you want to retrieve
'''
Public Overridable Property CustomerIds As List(Of String)
'''
'''The IDs of the endpoints whose sessions you want to retrieve
'''
Public Overridable Property EndpointIds As List(Of String)
'''
'''Filter by the from (this is a contains search)
'''
Public Overridable Property From As String
'''
'''Filter by the to (this is a contains search)
'''
Public Overridable Property To As String
'''
'''Filter by text in the log
'''
Public Overridable Property Log As String
'''
'''Filter by parent session ID
'''
Public Overridable Property ParentSessionId As String
End Class
Public Partial Class SessionInfo
Inherits EntityInfo
Public Sub New()
CustomerBreadcrumb = New List(Of CustomerBreadcrumb)
Log = New List(Of SessionLogInfo)
Members = New List(Of SessionMemberInfo)
End Sub
'''
'''The state of the session
'''
Public Overridable Property DialState As SessionDialState
'''
'''The call state of the session
'''
Public Overridable Property CallState As SessionCallState
'''
'''The queue state of the session
'''
Public Overridable Property QueueState As SessionQueueStates
'''
'''The ID of the account associated with the flow
'''
Public Overridable Property AccountId As String
'''
'''The name of the account associated with the session
'''
Public Overridable Property AccountName As String
'''
'''The ID of the customer this session is associated with
'''
Public Overridable Property CustomerId As String
'''
'''The customer breadcrumb this session is associated with
'''
Public Overridable Property CustomerBreadcrumb As List(Of CustomerBreadcrumb)
'''
'''The name of the customer this session is associated with
'''
Public Overridable Property CustomerName As String
'''
'''The ID of the endpoint associated with this session
'''
Public Overridable Property EndpointId As String
'''
'''The name of the endpoint associated with this session
'''
Public Overridable Property EndpointName As String
'''
'''The date the call completed
'''
Public Overridable Property DateCompleted As String
'''
'''The destination of the session (e.g. what was entered into the Dial box)
'''
Public Overridable Property Destination As String
'''
'''The to address if any
'''
Public Overridable Property ToAddress As String
'''
'''The from address if any
'''
Public Overridable Property FromAddress As String
'''
'''The from name if any
'''
Public Overridable Property FromName As String
'''
'''Answered by name (if any)
'''
Public Overridable Property AnsweredByName As String
'''
'''The ID of the queue member assigned to this call
'''
Public Overridable Property QueueMemberId As String
'''
'''The flow channel
'''
Public Overridable Property Channel As FlowChannels
'''
'''Has the session ended
'''
Public Overridable Property Ended As Boolean
'''
'''The outcome of the call
'''
Public Overridable Property Outcome As String
'''
'''The twilio Call SID of this session
'''
Public Overridable Property CallSid As String
'''
'''Any console data for this session
'''
Public Overridable Property ConsoleData As String
'''
'''The name of the hold queue for this call
'''
Public Overridable Property HoldQueueName As String
'''
'''The user ID who put this call on hold
'''
Public Overridable Property HeldByUserId As String
'''
'''The reason for the hold
'''
Public Overridable Property HoldReason As SessionHoldReasons
'''
'''The SID of the conference if in a conference call
'''
Public Overridable Property ConferenceSid As String
'''
'''The display name for this session
'''
Public Overridable Property DisplayName As String
'''
'''The log entries for this session
'''
Public Overridable Property Log As List(Of SessionLogInfo)
'''
'''The members of this session
'''
Public Overridable Property Members As List(Of SessionMemberInfo)
'''
'''The callback number (typically used for SIP to User calls)
'''
Public Overridable Property CallbackNumber As String
'''
'''The ID of the endpoint that answered
'''
Public Overridable Property AnsweredById As String
'''
'''Is this session incoming or outgoing?
'''
Public Overridable Property Direction As SessionDirections
'''
'''The phone number that this session is coming from (used with SMS chats)
'''
Public Overridable Property FromPhoneNumber As String
'''
'''The Call SID of the most recently added conference participant
'''
Public Overridable Property MostRecentParticipantCallSid As String
'''
'''Was this session missed?
'''
Public Overridable Property WasMissed As Boolean
'''
'''The ring queue that the call is currently in
'''
Public Overridable Property RingQueueId As String
End Class
End Namespace
Namespace Voice.Api.Sys
Public Partial Class LogEntryInfo
Inherits EntityInfo
Public Sub New()
CustomerBreadcrumb = New List(Of CustomerBreadcrumb)
End Sub
'''
'''The account ID this endpoint is associated with
'''
Public Overridable Property AccountId As String
'''
'''The name of the account this endpoint is associated with
'''
Public Overridable Property AccountName As String
'''
'''The ID of the customer this endpoint is associated with
'''
Public Overridable Property CustomerId As String
'''
'''The name of the customer this endpoint is associated with
'''
Public Overridable Property CustomerName As String
'''
'''The breadcrumb to the customer for this endpoint
'''
Public Overridable Property CustomerBreadcrumb As List(Of CustomerBreadcrumb)
Public Overridable Property UserName As String
Public Overridable Property Description As String
End Class
End Namespace
End Namespace