tock

package ai.tock.bot

object BotIoc

val coreModules: List<Module>
fun setup(vararg modules: Module): Unit
fun setup(modules: List<Module>): Unit

fun getIntentsByNamespaceAndName(namespace: String, name: String): List<IntentDefinition>?
fun importApplicationDump(path: String): Unit
fun importI18nDump(path: String, replaceAllLabels: Boolean = false): Unit
fun importNlpDump(path: String): Unit
fun importNlpSentencesDump(path: String): Unit
fun registerAndInstallBot(botDefinition: BotDefinition, additionalModules: List<Module> = emptyList(), vararg routerHandlers: (Router) -> Unit): Unit
fun registerAndInstallBot(botProvider: BotProvider, additionalModules: List<Module> = emptyList(), vararg routerHandlers: (Router) -> Unit): Unit

package ai.tock.bot.admin.answer

abstract class AnswerConfiguration

AnswerConfiguration(answerType: AnswerConfigurationType)
val answerType: AnswerConfigurationType
open fun hasAnswer(): Boolean

enum class AnswerConfigurationType

builtin
message
script
simple

data class BuiltInAnswerConfiguration : AnswerConfiguration

BuiltInAnswerConfiguration(storyHandlerClassName: String?)
val storyHandlerClassName: String?

class DedicatedAnswerConfiguration : StoryDefinitionAnswersContainer

DedicatedAnswerConfiguration(botConfiguration: String, currentType: AnswerConfigurationType, answers: List<AnswerConfiguration>)
val answers: List<AnswerConfiguration>
val botConfiguration: String
val currentType: AnswerConfigurationType
fun findNextSteps(bus: BotBus, story: StoryDefinitionConfiguration): List<CharSequence>

data class MessageAnswerConfiguration : AnswerConfiguration

MessageAnswerConfiguration(messages: List<MessageConfiguration>)
val messages: List<MessageConfiguration>

data class ScriptAnswerConfiguration : AnswerConfiguration

ScriptAnswerConfiguration(scriptVersions: List<ScriptAnswerVersionedConfiguration>, current: ScriptAnswerVersionedConfiguration = scriptVersions.maxByOrNull { it.date } ?: error("no script version found"))
val current: ScriptAnswerVersionedConfiguration
val scriptVersions: List<ScriptAnswerVersionedConfiguration>

class ScriptAnswerVersionedConfiguration

ScriptAnswerVersionedConfiguration(script: String, compiledCode: List<Pair<String, ByteArray>>, version: BotVersion, mainClassName: String, date: Instant = now())
val compiledCode: List<Pair<String, ByteArray>>
val date: Instant
val mainClassName: String
val script: String
val storyDefinition: StoryDefinition?
val version: BotVersion

data class SimpleAnswer

SimpleAnswer(key: I18nLabelValue, delay: Long, mediaMessage: MediaMessageDescriptor? = null)
val delay: Long
val key: I18nLabelValue
val mediaMessage: MediaMessageDescriptor?

data class SimpleAnswerConfiguration : AnswerConfiguration

SimpleAnswerConfiguration(answers: List<SimpleAnswer>)
val answers: List<SimpleAnswer>
fun hasAnswer(): Boolean

package ai.tock.bot.admin.bot

data class ArtifactVersion

ArtifactVersion(major: String, minor: String, iteration: String)
val iteration: String
val major: String
val minor: String
val UNKNOWN: ArtifactVersion

data class BotApplicationConfiguration

BotApplicationConfiguration(applicationId: String, botId: String, namespace: String, nlpModel: String, connectorType: ConnectorType, ownerConnectorType: ConnectorType? = null, name: String = applicationId, baseUrl: String? = defaultBaseUrl, parameters: Map<String, String> = emptyMap(), path: String? = null, _id: Id<BotApplicationConfiguration> = newId(), targetConfigurationId: Id<BotApplicationConfiguration>? = null)
val _id: Id<BotApplicationConfiguration>
val applicationId: String
val baseUrl: String?
val botId: String
val connectorType: ConnectorType
val defaultBaseUrl: String
val name: String
val namespace: String
val nlpModel: String
val ownerConnectorType: ConnectorType?
val parameters: Map<String, String>
val path: String?
val targetConfigurationId: Id<BotApplicationConfiguration>?
val targetConnectorType: ConnectorType
fun toConnectorConfiguration(): ConnectorConfiguration

interface BotApplicationConfigurationDAO

abstract fun delete(conf: BotApplicationConfiguration): Unit
abstract fun delete(conf: BotConfiguration): Unit
abstract fun getBotConfigurations(): List<BotConfiguration>
abstract fun getBotConfigurationsByNamespaceAndBotId(namespace: String, botId: String): List<BotConfiguration>
abstract fun getBotConfigurationsByNamespaceAndNameAndBotId(namespace: String, name: String, botId: String): BotConfiguration?
abstract fun getConfigurationByApplicationIdAndBotId(namespace: String, applicationId: String, botId: String): BotApplicationConfiguration?
abstract fun getConfigurationById(id: Id<BotApplicationConfiguration>): BotApplicationConfiguration?
abstract fun getConfigurationByPath(path: String): BotApplicationConfiguration?
abstract fun getConfigurationByTargetId(id: Id<BotApplicationConfiguration>): BotApplicationConfiguration?
abstract fun getConfigurations(): List<BotApplicationConfiguration>
abstract fun getConfigurationsByBotNamespaceAndConfigurationName(namespace: String, botId: String, configurationName: String): List<BotApplicationConfiguration>
abstract fun getConfigurationsByNamespaceAndBotId(namespace: String, botId: String): List<BotApplicationConfiguration>
abstract fun getConfigurationsByNamespaceAndNlpModel(namespace: String, nlpModel: String): List<BotApplicationConfiguration>
abstract fun listenBotChanges(listener: () -> Unit): Unit
abstract fun listenChanges(listener: () -> Unit): Unit
abstract fun save(conf: BotApplicationConfiguration): BotApplicationConfiguration
abstract fun save(conf: BotConfiguration): Unit

data class BotApplicationConfigurationKey

BotApplicationConfigurationKey(applicationId: String, botDefinition: BotDefinition)
BotApplicationConfigurationKey(bus: BotBus)
BotApplicationConfigurationKey(applicationId: String, botId: String, namespace: String)
val applicationId: String
val botId: String
val namespace: String

data class BotConfiguration

BotConfiguration(name: String, botId: String, namespace: String, nlpModel: String, apiKey: String = UUID.randomUUID().toString(), webhookUrl: String? = null, supportedLocales: Set<Locale> = emptySet())
val apiKey: String
val botId: String
val name: String
val namespace: String
val nlpModel: String
val supportedLocales: Set<Locale>
val webhookUrl: String?

data class BotVersion

BotVersion(botVersion: ArtifactVersion, tockVersion: ArtifactVersion)
val botVersion: ArtifactVersion
fun getCurrentBotVersion(botId: String): BotVersion
val tockVersion: ArtifactVersion

package ai.tock.bot.admin.dialog

data class ActionReport

ActionReport(playerId: PlayerId, recipientId: PlayerId, date: Instant, message: Message, connectorType: ConnectorType?, userInterfaceType: UserInterfaceType, test: Boolean = false, id: Id<Action> = newId())
val connectorType: ConnectorType?
val date: Instant
val id: Id<Action>
val message: Message
val playerId: PlayerId
val recipientId: PlayerId
val test: Boolean
val userInterfaceType: UserInterfaceType

data class ApplicationDialogFlowData

ApplicationDialogFlowData(states: List<DialogFlowStateData>, transitions: List<DialogFlowStateTransitionData>, configuredFlow: List<StoryDefinitionConfigurationFlowNode>)
val configuredFlow: List<StoryDefinitionConfigurationFlowNode>
val states: List<DialogFlowStateData>
val transitions: List<DialogFlowStateTransitionData>

data class DialogFlowStateData

DialogFlowStateData(storyDefinitionId: String, intent: String, step: String?, entities: Set<String>, storyType: AnswerConfigurationType?, storyName: String = storyDefinitionId, count: Long = 0, _id: Id<DialogFlowStateData> = newId())
val _id: Id<DialogFlowStateData>
val count: Long
val entities: Set<String>
val intent: String
val step: String?
val storyDefinitionId: String
val storyName: String
val storyType: AnswerConfigurationType?

data class DialogFlowStateTransitionData

DialogFlowStateTransitionData(previousStateId: Id<DialogFlowStateData>?, nextStateId: Id<DialogFlowStateData>, intent: String?, step: String?, newEntities: Set<String>, type: DialogFlowStateTransitionType, count: Long = 0)
val count: Long
val intent: String?
val newEntities: Set<String>
val nextStateId: Id<DialogFlowStateData>
val previousStateId: Id<DialogFlowStateData>?
val step: String?
val type: DialogFlowStateTransitionType

data class DialogFlowTransitionStatsData

DialogFlowTransitionStatsData(applicationId: String?, transitionId: String?, dialogId: String?, text: String?, date: LocalDateTime)
val applicationId: String?
val date: LocalDateTime
val dialogId: String?
val text: String?
val transitionId: String?

data class DialogReport

DialogReport(actions: List<ActionReport> = emptyList(), userInterface: UserInterfaceType, id: Id<Dialog> = newId(), obfuscated: Boolean = false)
val actions: List<ActionReport>
val id: Id<Dialog>
val obfuscated: Boolean
val userInterface: UserInterfaceType

interface DialogReportDAO

abstract fun getDialog(id: Id<Dialog>): DialogReport?
abstract fun getNlpCallStats(actionId: Id<Action>, namespace: String): NlpCallStats?
abstract fun search(query: DialogReportQuery): DialogReportQueryResult

data class DialogReportQuery

DialogReportQuery(namespace: String, nlpModel: String, language: Locale? = null, start: Long = 0, size: Int = 1, playerId: PlayerId? = null, text: String? = null, dialogId: String? = null, intentName: String? = null, exactMatch: Boolean = false, from: ZonedDateTime? = null, to: ZonedDateTime? = null, connectorType: ConnectorType? = null, displayTests: Boolean = false, obfuscated: Boolean = false)
val connectorType: ConnectorType?
val dialogId: String?
val displayTests: Boolean
val exactMatch: Boolean
val from: ZonedDateTime?
val intentName: String?
val language: Locale?
val namespace: String
val nlpModel: String
val obfuscated: Boolean
val playerId: PlayerId?
val size: Int
val start: Long
val text: String?
val to: ZonedDateTime?

data class DialogReportQueryResult

DialogReportQueryResult(total: Long, start: Long = 0, end: Long = 0, dialogs: List<DialogReport> = emptyList())
val dialogs: List<DialogReport>
val end: Long
val start: Long
val total: Long

package ai.tock.bot.admin.message

data class AttachmentConfiguration : MessageConfiguration

AttachmentConfiguration(url: String, type: AttachmentType, delay: Long = 0)
val delay: Long
val eventType: EventType
fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId, locale: Locale, userInterfaceType: UserInterfaceType): Action
val type: AttachmentType
val url: String

data class ChoiceConfiguration : MessageConfiguration

ChoiceConfiguration(intentName: String, parameters: Map<String, String> = emptyMap(), delay: Long = 0)
val delay: Long
val eventType: EventType
val intentName: String
val parameters: Map<String, String>
fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId, locale: Locale, userInterfaceType: UserInterfaceType): Action

data class LocationConfiguration : MessageConfiguration

LocationConfiguration(location: UserLocation?, delay: Long = 0)
val delay: Long
val eventType: EventType
val location: UserLocation?
fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId, locale: Locale, userInterfaceType: UserInterfaceType): Action

interface MessageConfiguration

abstract val delay: Long
abstract val eventType: EventType
open fun toAction(bus: BotBus): Action
abstract fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId, locale: Locale, userInterfaceType: UserInterfaceType): Action

data class SentenceConfiguration : MessageConfiguration

SentenceConfiguration(text: I18nLabelValue?, messages: MutableList<SentenceElementConfiguration> = mutableListOf(), delay: Long = 0)
val delay: Long
val eventType: EventType
val messages: MutableList<SentenceElementConfiguration>
val text: I18nLabelValue?
fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId, locale: Locale, userInterfaceType: UserInterfaceType): Action

data class SentenceElementConfiguration

SentenceElementConfiguration(connectorType: ConnectorType = ConnectorType.none, attachments: List<AttachmentConfiguration> = emptyList(), choices: List<ChoiceConfiguration> = emptyList(), texts: Map<String, I18nLabelValue> = emptyMap(), locations: List<LocationConfiguration> = emptyList(), metadata: Map<String, String> = emptyMap(), subElements: List<SentenceSubElementConfiguration> = emptyList(), connectorMessage: ConnectorMessage? = null)
val attachments: List<AttachmentConfiguration>
val choices: List<ChoiceConfiguration>
val connectorType: ConnectorType
val locations: List<LocationConfiguration>
val metadata: Map<String, String>
val subElements: List<SentenceSubElementConfiguration>
val texts: Map<String, I18nLabelValue>

data class SentenceSubElementConfiguration

SentenceSubElementConfiguration(attachments: List<AttachmentConfiguration> = emptyList(), choices: List<ChoiceConfiguration> = emptyList(), texts: Map<String, I18nLabelValue> = emptyMap(), locations: List<LocationConfiguration> = emptyList(), metadata: Map<String, String> = emptyMap())
val attachments: List<AttachmentConfiguration>
val choices: List<ChoiceConfiguration>
val locations: List<LocationConfiguration>
val metadata: Map<String, String>
val texts: Map<String, I18nLabelValue>

package ai.tock.bot.admin.story

data class StoryDefinitionConfiguration : StoryDefinitionAnswersContainer

StoryDefinitionConfiguration(botDefinition: BotDefinition, storyDefinition: StoryDefinition, configurationName: String?)
StoryDefinitionConfiguration(storyId: String, botId: String, intent: IntentWithoutNamespace, currentType: AnswerConfigurationType, answers: List<AnswerConfiguration>, version: Int = 0, namespace: String = defaultNamespace, mandatoryEntities: List<StoryDefinitionConfigurationMandatoryEntity> = emptyList(), steps: List<StoryDefinitionConfigurationStep> = emptyList(), name: String = storyId, category: String = "default", description: String = "", userSentence: String = "", userSentenceLocale: Locale? = null, configurationName: String? = null, features: List<StoryDefinitionConfigurationFeature> = emptyList(), _id: Id<StoryDefinitionConfiguration> = newId(), tags: Set<StoryTag> = emptySet(), configuredAnswers: List<DedicatedAnswerConfiguration> = emptyList(), configuredSteps: List<StoryDefinitionConfigurationByBotStep> = emptyList())
val _id: Id<StoryDefinitionConfiguration>
val answers: List<AnswerConfiguration>
val botId: String
val category: String
val configurationName: String?
val configuredAnswers: List<DedicatedAnswerConfiguration>
val configuredSteps: List<StoryDefinitionConfigurationByBotStep>
val currentType: AnswerConfigurationType
val description: String
val features: List<StoryDefinitionConfigurationFeature>
fun findNextSteps(bus: BotBus, story: StoryDefinitionConfiguration): List<CharSequence>
val intent: IntentWithoutNamespace
val mandatoryEntities: List<StoryDefinitionConfigurationMandatoryEntity>
val name: String
val namespace: String
val steps: List<StoryDefinitionConfigurationStep>
val storyId: String
val tags: Set<StoryTag>
val userSentence: String
val userSentenceLocale: Locale?
val version: Int

data class StoryDefinitionConfigurationByBotStep

StoryDefinitionConfigurationByBotStep(botConfiguration: String, steps: List<StoryDefinitionConfigurationStep> = emptyList())
val botConfiguration: String
val steps: List<StoryDefinitionConfigurationStep>

interface StoryDefinitionConfigurationDAO

abstract fun createBuiltInStoriesIfNotExist(stories: List<StoryDefinitionConfiguration>): Unit
abstract fun delete(story: StoryDefinitionConfiguration): Unit
abstract fun getConfiguredStoryDefinitionByNamespaceAndBotIdAndIntent(namespace: String, botId: String, intent: String): StoryDefinitionConfiguration?
abstract fun getRuntimeStorySettings(namespace: String, botId: String): List<StoryDefinitionConfiguration>
abstract fun getStoryDefinitionById(id: Id<StoryDefinitionConfiguration>): StoryDefinitionConfiguration?
abstract fun getStoryDefinitionByNamespaceAndBotIdAndIntent(namespace: String, botId: String, intent: String): StoryDefinitionConfiguration?
abstract fun getStoryDefinitionByNamespaceAndBotIdAndStoryId(namespace: String, botId: String, storyId: String): StoryDefinitionConfiguration?
abstract fun getStoryDefinitionsByNamespaceAndBotId(namespace: String, botId: String): List<StoryDefinitionConfiguration>
abstract fun getStoryDefinitionsByNamespaceBotIdStoryId(namespace: String, botId: String, storyId: String): StoryDefinitionConfiguration?
abstract fun listenChanges(listener: () -> Unit): Unit
abstract fun save(story: StoryDefinitionConfiguration): Unit
abstract fun searchStoryDefinitionSummaries(request: StoryDefinitionConfigurationSummaryRequest): List<StoryDefinitionConfigurationSummary>

data class StoryDefinitionConfigurationFeature

StoryDefinitionConfigurationFeature(botApplicationConfigurationId: Id<BotApplicationConfiguration>?, enabled: Boolean = true, switchToStoryId: String?)
StoryDefinitionConfigurationFeature(botApplicationConfigurationId: Id<BotApplicationConfiguration>?, enabled: Boolean = true, endingRedirection: Boolean, switchToStoryId: String?)
StoryDefinitionConfigurationFeature(botApplicationConfigurationId: Id<BotApplicationConfiguration>?, enabled: Boolean = true, switchToStoryId: String?, endWithStoryId: String?)
val botApplicationConfigurationId: Id<BotApplicationConfiguration>?
val enabled: Boolean
val endWithStoryId: String?
val switchToStoryId: String?

data class StoryDefinitionConfigurationFlowNode

StoryDefinitionConfigurationFlowNode(ownerStoryId: String, childrenStoryIds: List<String>)
val childrenStoryIds: List<String>
val ownerStoryId: String

data class StoryDefinitionConfigurationMandatoryEntity : StoryDefinitionAnswersContainer

StoryDefinitionConfigurationMandatoryEntity(role: String, entityType: String = role, intent: IntentWithoutNamespace, answers: List<AnswerConfiguration>, currentType: AnswerConfigurationType)
val answers: List<AnswerConfiguration>
val currentType: AnswerConfigurationType
val entityType: String
val entityTypeName: String
val intent: IntentWithoutNamespace
val role: String

data class StoryDefinitionConfigurationStep : StoryDefinitionAnswersContainer

StoryDefinitionConfigurationStep(step: StoryStep<*>)
StoryDefinitionConfigurationStep(name: String, intent: IntentWithoutNamespace?, targetIntent: IntentWithoutNamespace?, answers: List<AnswerConfiguration>, currentType: AnswerConfigurationType, userSentence: String = "", userSentenceLabel: I18nLabelValue? = null, children: List<StoryDefinitionConfigurationStep> = emptyList(), level: Int = 0, entity: EntityStepSelection? = null)
val answers: List<AnswerConfiguration>
val children: List<StoryDefinitionConfigurationStep>
val currentType: AnswerConfigurationType
val entity: EntityStepSelection?
fun findNextSteps(bus: BotBus, story: StoryDefinitionConfiguration): List<CharSequence>
val hasNoChildren: Boolean
val intent: IntentWithoutNamespace?
val level: Int
val name: String
val targetIntent: IntentWithoutNamespace?
fun toStoryStep(story: StoryDefinitionConfiguration): StoryStep<StoryHandlerDefinition>
val userSentence: String
val userSentenceLabel: I18nLabelValue?

data class StoryDefinitionConfigurationSummary

StoryDefinitionConfigurationSummary(_id: Id<StoryDefinitionConfiguration>, storyId: String, botId: String, intent: IntentWithoutNamespace, currentType: AnswerConfigurationType, name: String = storyId, category: String = "default", description: String = "")
val _id: Id<StoryDefinitionConfiguration>
val botId: String
val category: String
val currentType: AnswerConfigurationType
val description: String
val intent: IntentWithoutNamespace
val name: String
val storyId: String

data class StoryDefinitionConfigurationSummaryRequest

StoryDefinitionConfigurationSummaryRequest(namespace: String, botId: String, category: String?, textSearch: String?, onlyConfiguredStory: Boolean)
val botId: String
val category: String?
val namespace: String
val onlyConfiguredStory: Boolean
val textSearch: String?

package ai.tock.bot.admin.story.dump

abstract class AnswerConfigurationDump

AnswerConfigurationDump(answerType: AnswerConfigurationType)
val answerType: AnswerConfigurationType
abstract fun toAnswer(currentType: AnswerConfigurationType, controller: StoryDefinitionConfigurationDumpController): AnswerConfiguration
fun toDump(answer: List<AnswerConfiguration>): List<AnswerConfigurationDump>
fun toDump(answer: AnswerConfiguration): AnswerConfigurationDump

data class BuiltInAnswerConfigurationDump : AnswerConfigurationDump

BuiltInAnswerConfigurationDump(conf: BuiltInAnswerConfiguration)
BuiltInAnswerConfigurationDump(storyHandlerClassName: String? = null)
val storyHandlerClassName: String?
fun toAnswer(currentType: AnswerConfigurationType, controller: StoryDefinitionConfigurationDumpController): AnswerConfiguration

data class MediaActionDescriptorDump : MediaMessageDescriptorDump

MediaActionDescriptorDump(media: MediaActionDescriptor)
MediaActionDescriptorDump(title: I18nLabelValue, url: String? = null)
val title: I18nLabelValue
fun toMedia(controller: StoryDefinitionConfigurationDumpController): MediaActionDescriptor
val type: MediaMessageType
var url: String?

data class MediaCardDescriptorDump : MediaMessageDescriptorDump

MediaCardDescriptorDump(media: MediaCardDescriptor)
MediaCardDescriptorDump(title: I18nLabelValue?, subTitle: I18nLabelValue?, file: MediaFileDescriptorDump?, actions: List<MediaActionDescriptorDump> = emptyList())
val actions: List<MediaActionDescriptorDump>
val file: MediaFileDescriptorDump?
val subTitle: I18nLabelValue?
val title: I18nLabelValue?
fun toMedia(controller: StoryDefinitionConfigurationDumpController): MediaCardDescriptor
val type: MediaMessageType

data class MediaCarouselDescriptorDump : MediaMessageDescriptorDump

MediaCarouselDescriptorDump(media: MediaCarouselDescriptor)
MediaCarouselDescriptorDump(cards: List<MediaCardDescriptorDump>)
val cards: List<MediaCardDescriptorDump>
fun toMedia(controller: StoryDefinitionConfigurationDumpController): MediaCarouselDescriptor
val type: MediaMessageType

class MediaFileDescriptorDump

MediaFileDescriptorDump(file: MediaFileDescriptor)
MediaFileDescriptorDump(suffix: String, name: String, data: ByteArray?, id: String = Dice.newId(), type: AttachmentType = UploadedFilesService.attachmentType(suffix), externalUrl: String? = null)
val data: ByteArray?
val externalUrl: String?
val id: String
val name: String
val suffix: String
fun toFile(controller: StoryDefinitionConfigurationDumpController): MediaFileDescriptor?
val type: AttachmentType

interface MediaMessageDescriptorDump

fun toDump(message: MediaMessageDescriptor?): MediaMessageDescriptorDump?
abstract fun toMedia(controller: StoryDefinitionConfigurationDumpController): MediaMessageDescriptor
abstract val type: MediaMessageType

data class MessageAnswerConfigurationDump : AnswerConfigurationDump

MessageAnswerConfigurationDump(conf: MessageAnswerConfiguration)
MessageAnswerConfigurationDump(messages: List<MessageConfiguration> = emptyList())
val messages: List<MessageConfiguration>
fun toAnswer(currentType: AnswerConfigurationType, controller: StoryDefinitionConfigurationDumpController): AnswerConfiguration

data class ScriptAnswerConfigurationDump : AnswerConfigurationDump

ScriptAnswerConfigurationDump(conf: ScriptAnswerConfiguration)
ScriptAnswerConfigurationDump(scriptVersions: List<ScriptAnswerVersionedConfigurationDump>, current: ScriptAnswerVersionedConfigurationDump = scriptVersions.maxByOrNull { it.date } ?: error("no script version found"))
val current: ScriptAnswerVersionedConfigurationDump
val scriptVersions: List<ScriptAnswerVersionedConfigurationDump>
fun toAnswer(currentType: AnswerConfigurationType, controller: StoryDefinitionConfigurationDumpController): AnswerConfiguration

data class ScriptAnswerVersionedConfigurationDump

ScriptAnswerVersionedConfigurationDump(conf: ScriptAnswerVersionedConfiguration)
ScriptAnswerVersionedConfigurationDump(script: String, version: BotVersion, date: Instant = now())
val date: Instant
val script: String
fun toAnswer(controller: StoryDefinitionConfigurationDumpController, compile: Boolean = false): ScriptAnswerVersionedConfiguration
val version: BotVersion

data class SimpleAnswerConfigurationDump : AnswerConfigurationDump

SimpleAnswerConfigurationDump(conf: SimpleAnswerConfiguration)
SimpleAnswerConfigurationDump(answers: List<SimpleAnswerDump>)
val answers: List<SimpleAnswerDump>
fun toAnswer(currentType: AnswerConfigurationType, controller: StoryDefinitionConfigurationDumpController): AnswerConfiguration

data class SimpleAnswerDump

SimpleAnswerDump(answer: SimpleAnswer)
SimpleAnswerDump(key: I18nLabelValue, delay: Long, mediaMessage: MediaMessageDescriptorDump? = null)
val delay: Long
val key: I18nLabelValue
val mediaMessage: MediaMessageDescriptorDump?
fun toAnswer(controller: StoryDefinitionConfigurationDumpController): SimpleAnswer

data class StoryDefinitionConfigurationDump

StoryDefinitionConfigurationDump(def: StoryDefinitionConfiguration)
StoryDefinitionConfigurationDump(storyId: String, botId: String, intent: IntentWithoutNamespace, currentType: AnswerConfigurationType, answers: List<AnswerConfigurationDump>, version: Int = 0, namespace: String = defaultNamespace, mandatoryEntities: List<StoryDefinitionConfigurationMandatoryEntityDump> = emptyList(), steps: List<StoryDefinitionConfigurationStepDump> = emptyList(), name: String = storyId, category: String = "default", description: String = "", userSentence: String = "", userSentenceLocale: Locale? = null, configurationName: String? = null, features: List<StoryDefinitionConfigurationFeatureDump> = emptyList(), tags: Set<StoryTag> = emptySet(), configuredAnswers: List<DedicatedAnswerConfiguration> = emptyList(), configuredSteps: List<StoryDefinitionConfigurationByBotStep> = emptyList())
val answers: List<AnswerConfigurationDump>
val botId: String
val category: String
val configurationName: String?
val configuredAnswers: List<DedicatedAnswerConfiguration>
val configuredSteps: List<StoryDefinitionConfigurationByBotStep>
val currentType: AnswerConfigurationType
val description: String
val features: List<StoryDefinitionConfigurationFeatureDump>
val intent: IntentWithoutNamespace
val mandatoryEntities: List<StoryDefinitionConfigurationMandatoryEntityDump>
val name: String
val namespace: String
val steps: List<StoryDefinitionConfigurationStepDump>
val storyId: String
val tags: Set<StoryTag>
fun toStoryDefinitionConfiguration(controller: StoryDefinitionConfigurationDumpController): StoryDefinitionConfiguration
val userSentence: String
val userSentenceLocale: Locale?
val version: Int

interface StoryDefinitionConfigurationDumpController

abstract val botId: String
abstract fun buildScript(script: ScriptAnswerVersionedConfigurationDump, compile: Boolean): ScriptAnswerVersionedConfiguration
abstract fun checkIntent(intent: IntentWithoutNamespace?): IntentWithoutNamespace?
abstract fun keepFeature(feature: StoryDefinitionConfigurationFeatureDump): Boolean
abstract val targetNamespace: String

data class StoryDefinitionConfigurationFeatureDump

StoryDefinitionConfigurationFeatureDump(def: StoryDefinitionConfigurationFeature)
StoryDefinitionConfigurationFeatureDump(botApplicationConfigurationId: Id<BotApplicationConfiguration>?, enabled: Boolean = true, switchToStoryId: String? = null, endWithStoryId: String? = null)
val botApplicationConfigurationId: Id<BotApplicationConfiguration>?
val enabled: Boolean
val endWithStoryId: String?
val switchToStoryId: String?
fun toFeature(controller: StoryDefinitionConfigurationDumpController): StoryDefinitionConfigurationFeature?

data class StoryDefinitionConfigurationMandatoryEntityDump

StoryDefinitionConfigurationMandatoryEntityDump(def: StoryDefinitionConfigurationMandatoryEntity)
StoryDefinitionConfigurationMandatoryEntityDump(role: String, entityType: String = role, intent: IntentWithoutNamespace, answers: List<AnswerConfigurationDump>, currentType: AnswerConfigurationType)
val answers: List<AnswerConfigurationDump>
val currentType: AnswerConfigurationType
val entityType: String
val intent: IntentWithoutNamespace
val role: String
fun toEntity(controller: StoryDefinitionConfigurationDumpController): StoryDefinitionConfigurationMandatoryEntity

data class StoryDefinitionConfigurationStepDump

StoryDefinitionConfigurationStepDump(def: StoryDefinitionConfigurationStep, namespace: String, category: String)
StoryDefinitionConfigurationStepDump(name: String, intent: IntentWithoutNamespace?, targetIntent: IntentWithoutNamespace?, answers: List<AnswerConfigurationDump>, currentType: AnswerConfigurationType, userSentenceLabel: I18nLabelValue? = null, children: List<StoryDefinitionConfigurationStepDump> = emptyList(), level: Int = 0, entity: EntityStepSelection? = null)
val answers: List<AnswerConfigurationDump>
val children: List<StoryDefinitionConfigurationStepDump>
val currentType: AnswerConfigurationType
val entity: EntityStepSelection?
val intent: IntentWithoutNamespace?
val level: Int
val name: String
val targetIntent: IntentWithoutNamespace?
fun toStep(controller: StoryDefinitionConfigurationDumpController): StoryDefinitionConfigurationStep
val userSentenceLabel: I18nLabelValue?

package ai.tock.bot.admin.test

data class DialogExecutionReport

DialogExecutionReport(dialogReportId: Id<Dialog>, error: Boolean = false, errorActionId: Id<Action>? = null, returnedMessage: Message? = null, errorMessage: String? = null, indexOfStepError: Int? = null, date: Instant = Instant.now(), duration: Duration = Duration.ZERO)
val date: Instant
val dialogReportId: Id<Dialog>
val duration: Duration
val error: Boolean
val errorActionId: Id<Action>?
val errorMessage: String?
val indexOfStepError: Int?
val returnedMessage: Message?

fun findTestClient(): TestClientService
data class TestActionReport

TestActionReport(playerId: PlayerId, date: Instant, message: Message, connectorType: ConnectorType?, userInterfaceType: UserInterfaceType, id: Id<Action> = newId())
TestActionReport(report: ActionReport)
TestActionReport(playerId: PlayerId, date: Instant, messages: List<Message>, connectorType: ConnectorType?, userInterfaceType: UserInterfaceType = textChat, id: Id<Action>)
val connectorType: ConnectorType?
val date: Instant
fun findFirstMessage(): Message
val id: Id<Action>
val messages: List<Message>
val playerId: PlayerId
val userInterfaceType: UserInterfaceType

interface TestClientService

abstract fun getBotConfigurations(namespace: String, botId: String): List<BotApplicationConfiguration>
abstract fun priority(): Int
abstract fun saveAndExecuteTestPlan(testPlan: TestPlan, executionId: Id<TestPlanExecution>): TestPlanExecution

data class TestDialogReport

TestDialogReport(dialog: DialogReport)
TestDialogReport(actions: List<TestActionReport> = emptyList(), userInterface: UserInterfaceType, id: Id<Dialog>)
val actions: List<TestActionReport>
val id: Id<Dialog>
val userInterface: UserInterfaceType

data class TestPlan

TestPlan(dialogs: List<TestDialogReport>, name: String, applicationId: String, namespace: String, nlpModel: String, botApplicationConfigurationId: Id<BotApplicationConfiguration>, locale: Locale = defaultLocale, startAction: Message? = null, targetConnectorType: ConnectorType = ConnectorType.none, _id: Id<TestPlan> = newId())
val _id: Id<TestPlan>
val applicationId: String
val botApplicationConfigurationId: Id<BotApplicationConfiguration>
val dialogs: List<TestDialogReport>
val locale: Locale
val name: String
val namespace: String
val nlpModel: String
val startAction: Message?
val targetConnectorType: ConnectorType

interface TestPlanDAO

abstract fun getPlanExecution(testPlanId: Id<TestPlan>): TestPlanExecution?
abstract fun getPlanExecutions(testPlanId: Id<TestPlan>): List<TestPlanExecution>
abstract fun getPlansByApplicationId(applicationId: String): List<TestPlan>
abstract fun getTestPlan(testPlanId: Id<TestPlan>): TestPlan?
abstract fun getTestPlanExecution(testPlan: TestPlan, testPlanExecutionId: Id<TestPlanExecution>): TestPlanExecution?
abstract fun getTestPlans(): List<TestPlan>
abstract fun removeTestPlan(planId: Id<TestPlan>): Unit
abstract fun saveTestExecution(testPlanExecution: TestPlanExecution): Unit
abstract fun saveTestPlan(testPlan: TestPlan): Unit

data class TestPlanExecution

TestPlanExecution(testPlanId: Id<TestPlan>, dialogs: List<DialogExecutionReport>, nbErrors: Int, date: Instant = Instant.now(), duration: Duration = Duration.ZERO, _id: Id<TestPlanExecution> = newId(), status: TestPlanExecutionStatus = TestPlanExecutionStatus.PENDING)
val _id: Id<TestPlanExecution>
val date: Instant
val dialogs: List<DialogExecutionReport>
val duration: Duration
val nbErrors: Int
val status: TestPlanExecutionStatus
val testPlanId: Id<TestPlan>

enum class TestPlanExecutionStatus

COMPLETE
FAILED
PENDING
SUCCESS
UNKNOWN

package ai.tock.bot.admin.user

data class AnalyticsQuery

AnalyticsQuery(namespace: String, nlpModel: String, language: Locale, from: LocalDateTime = LocalDateTime.now().minusDays(7), to: LocalDateTime = LocalDateTime.now())
val from: LocalDateTime
val language: Locale
val namespace: String
val nlpModel: String
val to: LocalDateTime

data class UserAnalytics

UserAnalytics(playerId: PlayerId, applicationIds: MutableSet<String>, lastUserActionDate: LocalDate = LocalDate.now(), lastUserActionDateTime: LocalDateTime = LocalDateTime.now())
val applicationIds: MutableSet<String>
val lastUserActionDate: LocalDate
val lastUserActionDateTime: LocalDateTime
val playerId: PlayerId

data class UserAnalyticsQueryResult

UserAnalyticsQueryResult(dates: List<String> = emptyList(), usersData: List<List<Int?>> = emptyList(), connectorsType: List<String> = emptyList(), intents: List<String> = emptyList())
val connectorsType: List<String>
val dates: List<String>
val intents: List<String>
val usersData: List<List<Int?>>

data class UserReport

UserReport(playerId: PlayerId, applicationIds: MutableSet<String>, userPreferences: UserPreferences = UserPreferences(), userState: UserState = UserState(), lastUpdateDate: Instant = now(), lastActionText: String? = null, lastUserActionDate: Instant)
val applicationIds: MutableSet<String>
val lastActionText: String?
val lastUpdateDate: Instant
val lastUserActionDate: Instant
val playerId: PlayerId
val userPreferences: UserPreferences
val userState: UserState

interface UserReportDAO

abstract fun search(query: UserReportQuery): UserReportQueryResult
abstract fun search(query: AnalyticsQuery): List<UserAnalytics>

data class UserReportQuery

UserReportQuery(namespace: String, nlpModel: String, language: Locale, start: Long = 0, size: Int = 1, name: String? = null, from: ZonedDateTime? = null, to: ZonedDateTime? = null, flags: Map<String, String?> = emptyMap(), displayTests: Boolean = false)
val displayTests: Boolean
val flags: Map<String, String?>
val from: ZonedDateTime?
val language: Locale
val name: String?
val namespace: String
val nlpModel: String
val size: Int
val start: Long
val to: ZonedDateTime?

data class UserReportQueryResult

UserReportQueryResult(total: Long, start: Long = 0, end: Long = 0, users: List<UserReport> = emptyList())
val end: Long
val start: Long
val total: Long
val users: List<UserReport>

package ai.tock.bot.api.client

class ClientBotDefinition

ClientBotDefinition(apiKey: String, stories: List<ClientStoryDefinition>, unknownStory: ClientStoryDefinition)
val apiKey: String
val stories: List<ClientStoryDefinition>
val unknownStory: ClientStoryDefinition

interface ClientBus : Bus<ClientBus>

abstract val botDefinition: ClientBotDefinition
abstract fun end(card: Card): ClientBus
abstract fun end(carousel: Carousel): ClientBus
abstract fun end(i18nText: CharSequence, suggestions: List<Suggestion>, delay: Long = defaultDelay(currentAnswerIndex), vararg i18nArgs: Any?): ClientBus
open fun end(i18nText: CharSequence, suggestions: List<CharSequence>): ClientBus
abstract val entities: MutableList<Entity>
open fun entity(role: String): Entity?
open fun entityText(role: String): String?
open fun <T : Value> entityValue(role: String): T?
abstract fun handle(): Unit
abstract val message: UserMessage
open fun newAction(title: CharSequence, url: String? = null): Action
open fun newAttachment(url: String, type: AttachmentType? = null): Attachment
open fun newCard(title: CharSequence? = null, subTitle: CharSequence? = null, attachment: Attachment? = null, actions: List<Action> = emptyList(), delay: Long = defaultDelay(currentAnswerIndex)): Card
open fun newCard(title: CharSequence? = null, subTitle: CharSequence? = null, attachment: Attachment? = null, vararg actions: Action, delay: Long = defaultDelay(currentAnswerIndex)): Card
open fun newCarousel(cards: List<Card>, delay: Long = defaultDelay(currentAnswerIndex)): Carousel
open fun newCarousel(vararg cards: Card, delay: Long = defaultDelay(currentAnswerIndex)): Carousel
open fun removeEntity(role: String): Boolean
open fun removeEntity(entity: Entity): Boolean
abstract fun send(card: Card): ClientBus
abstract fun send(carousel: Carousel): ClientBus
abstract fun send(i18nText: CharSequence, suggestions: List<Suggestion>, delay: Long = defaultDelay(currentAnswerIndex), vararg i18nArgs: Any?): ClientBus
open fun send(i18nText: CharSequence, suggestions: List<CharSequence>): ClientBus
abstract var step: ClientStep?
abstract var story: ClientStoryDefinition
open fun translate(text: CharSequence?, vararg args: Any?): I18nText

class ClientStep

ClientStep(name: String, mainIntent: IntentAware = Intent(name), otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet())
val mainIntent: IntentAware
val name: String
val otherStarterIntents: Set<IntentAware>
val secondaryIntents: Set<IntentAware>

class ClientStoryDefinition : IntentAware

ClientStoryDefinition(mainIntent: IntentAware, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), steps: List<ClientStep> = emptyList(), storyId: String = mainIntent.wrappedIntent().name, handler: ClientStoryHandler)
val handler: ClientStoryHandler
fun isStarterIntent(intent: Intent): Boolean
val mainIntent: IntentAware
val otherStarterIntents: Set<IntentAware>
val secondaryIntents: Set<IntentAware>
val steps: List<ClientStep>
val storyId: String
fun wrappedIntent(): Intent

interface ClientStoryHandler

abstract fun handle(bus: ClientBus): Unit

fun newBot(apiKey: String, stories: List<ClientStoryDefinition>, unknownStory: ClientStoryDefinition = defaultUnknownStory()): ClientBotDefinition
fun newBot(apiKey: String, vararg stories: ClientStoryDefinition): ClientBotDefinition
fun newStory(mainIntent: String, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), steps: List<ClientStep> = emptyList(), storyId: String = mainIntent, handler: ClientBus.() -> Unit): ClientStoryDefinition
fun newStory(mainIntent: IntentAware, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), steps: List<ClientStep> = emptyList(), storyId: String = mainIntent.wrappedIntent().name, handler: ClientBus.() -> Unit): ClientStoryDefinition
fun newStoryHandler(handler: ClientBus.() -> Unit): ClientStoryHandler
class TockClientBus : ClientBus

TockClientBus(botDefinition: ClientBotDefinition, data: RequestData, sendAnswer: (BotResponse) -> Unit)
TockClientBus(botDefinition: ClientBotDefinition, requestId: String, request: UserRequest, sendAnswer: (BotResponse) -> Unit)
val applicationId: String
val botDefinition: ClientBotDefinition
val botId: PlayerId
val contextId: String?
val currentAnswerIndex: Int
fun defaultDelay(answerIndex: Int): Long
fun end(i18nText: CharSequence, suggestions: List<Suggestion>, delay: Long, vararg i18nArgs: Any?): ClientBus
fun end(card: Card): ClientBus
fun end(carousel: Carousel): ClientBus
fun endRawText(plainText: CharSequence?, delay: Long): ClientBus
val entities: MutableList<Entity>
fun handle(): Unit
fun i18n(defaultLabel: CharSequence, args: List<Any?>): I18nLabelValue
val intent: IntentAware?
val message: UserMessage
val request: UserRequest
val requestId: String
fun send(i18nText: CharSequence, suggestions: List<Suggestion>, delay: Long, vararg i18nArgs: Any?): ClientBus
fun send(carousel: Carousel): ClientBus
fun send(card: Card): ClientBus
val sendAnswer: (BotResponse) -> Unit
fun sendRawText(plainText: CharSequence?, delay: Long): ClientBus
var step: ClientStep?
val stepName: String?
lateinit var story: ClientStoryDefinition
val targetConnectorType: ConnectorType
val test: Boolean
val userId: PlayerId
val userInterfaceType: UserInterfaceType
val userLocale: Locale
fun withMessage(connectorType: ConnectorType, messageProvider: () -> ConnectorMessage): ClientBus
fun withMessage(connectorType: ConnectorType, connectorId: String, messageProvider: () -> ConnectorMessage): ClientBus

fun ClientBotDefinition.toConfiguration(): ClientConfiguration
fun unknownStory(handler: ClientBus.() -> Unit): ClientStoryDefinition

package ai.tock.bot.api.model

data class BotResponse

BotResponse(messages: List<BotMessage> = emptyList(), storyId: String, step: String?, entities: List<Entity> = emptyList(), context: ResponseContext)
val context: ResponseContext
val entities: List<Entity>
val messages: List<BotMessage>
val step: String?
val storyId: String

data class RequestContext

RequestContext(namespace: String, language: Locale, connectorType: ConnectorType, userInterface: UserInterfaceType, applicationId: String, userId: PlayerId, botId: PlayerId, user: UserData)
val applicationId: String
val botId: PlayerId
val connectorType: ConnectorType
val language: Locale
val namespace: String
val user: UserData
val userId: PlayerId
val userInterface: UserInterfaceType

data class ResponseContext

ResponseContext(requestId: String, date: Instant = now())
val date: Instant
val requestId: String

data class UserRequest

UserRequest(intent: String?, entities: List<Entity>, message: UserMessage, storyId: String, step: String?, context: RequestContext)
val context: RequestContext
val entities: List<Entity>
val intent: String?
val message: UserMessage
val step: String?
val storyId: String

package ai.tock.bot.api.model.configuration

data class ClientConfiguration

ClientConfiguration(stories: List<StoryConfiguration>)
val stories: List<StoryConfiguration>

data class StepConfiguration

StepConfiguration(name: String, mainIntent: String = name, otherStarterIntents: Set<String> = emptySet(), secondaryIntents: Set<String> = emptySet())
val mainIntent: String
val name: String
val otherStarterIntents: Set<String>
val secondaryIntents: Set<String>

data class StoryConfiguration

StoryConfiguration(mainIntent: String, otherStarterIntents: Set<String> = emptySet(), secondaryIntents: Set<String> = emptySet(), steps: List<StepConfiguration> = emptyList(), name: String = mainIntent)
val mainIntent: String
val name: String
val otherStarterIntents: Set<String>
val secondaryIntents: Set<String>
val steps: List<StepConfiguration>

package ai.tock.bot.api.model.context

data class Entity

Entity(type: String, role: String, content: String?, value: Value? = null, evaluated: Boolean = false, subEntities: List<Entity> = emptyList(), new: Boolean)
var content: String?
val evaluated: Boolean
val new: Boolean
val role: String
val subEntities: List<Entity>
val type: String
var value: Value?

data class UserData

UserData(firstName: String? = null, lastName: String? = null, email: String? = null, timezone: ZoneId, locale: Locale, picture: String? = null, gender: String? = null, test: Boolean = false)
var email: String?
var firstName: String?
var gender: String?
var lastName: String?
var locale: Locale
var picture: String?
var test: Boolean
var timezone: ZoneId

package ai.tock.bot.api.model.message.bot

data class Action

Action(title: I18nText, url: String? = null)
val title: I18nText
var url: String?

data class Attachment

Attachment(url: String, type: AttachmentType? = null)
val type: AttachmentType?
val url: String

enum class AttachmentType

audio
file
image
video

interface BotMessage

abstract val delay: Long

data class Card : BotMessage

Card(title: I18nText? = null, subTitle: I18nText? = null, attachment: Attachment? = null, actions: List<Action> = emptyList(), delay: Long = 0)
val actions: List<Action>
val attachment: Attachment?
val delay: Long
val subTitle: I18nText?
val title: I18nText?

data class Carousel : BotMessage

Carousel(cards: List<Card>, delay: Long = 0)
val cards: List<Card>
val delay: Long

data class CustomMessage : BotMessage

CustomMessage(message: ConstrainedValueWrapper<out ConnectorMessage>, delay: Long = 0)
val delay: Long
val message: ConstrainedValueWrapper<out ConnectorMessage>

data class I18nText : CharSequence, TranslatedSequence

I18nText(text: String, args: List<String?> = emptyList(), toBeTranslated: Boolean = true, key: String? = null)
val args: List<String?>
val key: String?
fun plus(other: Any?): I18nText
val text: String
val toBeTranslated: Boolean
fun toString(): String

data class Sentence : BotMessage

Sentence(text: I18nText, suggestions: List<Suggestion> = emptyList(), delay: Long = 0)
val delay: Long
val suggestions: List<Suggestion>
val text: I18nText

data class Suggestion

Suggestion(title: I18nText)
val title: I18nText

package ai.tock.bot.api.model.message.user

data class Choice : UserMessage

Choice(payload: String)
val payload: String
fun toString(): String

data class Text : UserMessage

Text(text: String)
val text: String
fun toString(): String

interface UserMessage

package ai.tock.bot.api.model.websocket

data class RequestData

RequestData(botRequest: UserRequest? = null, configuration: Boolean? = null, requestId: String = Dice.newId())
val botRequest: UserRequest?
val configuration: Boolean?
val requestId: String

data class ResponseData

ResponseData(requestId: String, botResponse: BotResponse? = null, botConfiguration: ClientConfiguration? = null)
val botConfiguration: ClientConfiguration?
val botResponse: BotResponse?
val requestId: String

package ai.tock.bot.api.webhook

fun webhook(botDefinition: ClientBotDefinition): Unit

package ai.tock.bot.api.websocket

fun start(botDefinition: ClientBotDefinition, url: String): Unit
fun start(botDefinition: ClientBotDefinition, serverPort: Int = intProperty("tock_websocket_port", 8080), serverHost: String = property("tock_websocket_host", "localhost"), ssl: Boolean = booleanProperty("tock_websocket_ssl", false)): Unit
fun startWithDemo(botDefinition: ClientBotDefinition): Unit

package ai.tock.bot.connector

interface Connector

open fun addSuggestions(text: CharSequence, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
open fun addSuggestions(message: ConnectorMessage, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
abstract val connectorType: ConnectorType
open fun hasFeature(feature: ConnectorFeature, targetConnectorType: ConnectorType): Boolean
open fun loadProfile(callback: ConnectorCallback, userId: PlayerId): UserPreferences?
open fun notify(controller: ConnectorController, recipientId: PlayerId, intent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Map<String, String> = emptyMap(), notificationType: ActionNotificationType?, errorListener: (Throwable) -> Unit = {}): Unit
open fun refreshProfile(callback: ConnectorCallback, userId: PlayerId): UserPreferences?
abstract fun register(controller: ConnectorController): Unit
abstract fun send(event: Event, callback: ConnectorCallback, delayInMs: Long = 0): Unit
open val supportedFeatures: Set<ConnectorFeature>
open fun toConnectorMessage(message: MediaMessage): BotBus.() -> List<ConnectorMessage>
open fun unregister(controller: ConnectorController): Unit

abstract class ConnectorBase : Connector

ConnectorBase(connectorType: ConnectorType, supportedFeatures: Set<ConnectorFeature> = emptySet())
open val connectorType: ConnectorType
open val supportedFeatures: Set<ConnectorFeature>
open fun toString(): String

interface ConnectorCallback

abstract val applicationId: String
abstract fun eventAnswered(event: Event): Unit
abstract fun eventSkipped(event: Event): Unit
abstract fun exceptionThrown(event: Event, throwable: Throwable): Unit
abstract fun userLocked(event: Event): Unit
abstract fun userLockReleased(event: Event): Unit

open class ConnectorCallbackBase : ConnectorCallback

ConnectorCallbackBase(applicationId: String, connectorType: ConnectorType)
open val applicationId: String
val connectorType: ConnectorType
open fun eventAnswered(event: Event): Unit
open fun eventSkipped(event: Event): Unit
open fun exceptionThrown(event: Event, throwable: Throwable): Unit
open fun userLocked(event: Event): Unit
open fun userLockReleased(event: Event): Unit

data class ConnectorConfiguration

ConnectorConfiguration(connectorId: String, path: String, type: ConnectorType, applicationName: String, baseUrl: String?, ownerConnectorType: ConnectorType? = null, parameters: Map<String, String> = emptyMap())
ConnectorConfiguration(connectorId: String, path: String, type: ConnectorType, ownerConnectorType: ConnectorType? = null, parameters: Map<String, String> = emptyMap())
val connectorId: String
fun getBaseUrl(): String
fun getName(): String
val ownerConnectorType: ConnectorType?
val parameters: Map<String, String>
val path: String
val type: ConnectorType

open class ConnectorData

ConnectorData(callback: ConnectorCallback, priorUserId: PlayerId? = null, saveTimeline: Boolean = true, groupId: String? = null, referer: String? = null)
val callback: ConnectorCallback
val groupId: String?
val priorUserId: PlayerId?
val referer: String?
var saveTimeline: Boolean
var skipAnswer: Boolean

class ConnectorException : Exception

ConnectorException(message: String)

enum class ConnectorFeature

CAROUSEL

@Target([AnnotationTarget.ANNOTATION_CLASS]) annotation class ConnectorHandler

ConnectorHandler(connectorTypeId: String)
val connectorTypeId: String

annotation class ConnectorIdHandler

ConnectorIdHandler(connectorId: String, value: KClass<out ConnectorStoryHandler<*>>)
val connectorId: String
val value: KClass<out ConnectorStoryHandler<*>>

@Target([AnnotationTarget.CLASS]) annotation class ConnectorIdHandlers

ConnectorIdHandlers(vararg handlers: ConnectorIdHandler)
vararg val handlers: Array<out ConnectorIdHandler>

interface ConnectorMessage : ConnectorMessageProvider

abstract val connectorType: ConnectorType
open fun obfuscate(): ConnectorMessage
open fun toConnectorMessage(): ConnectorMessage
open fun toGenericMessage(): GenericMessage?

interface ConnectorMessageProvider

abstract fun toConnectorMessage(): ConnectorMessage

interface ConnectorProvider

open fun check(connectorConfiguration: ConnectorConfiguration): List<String>
open fun configuration(): ConnectorTypeConfiguration
abstract fun connector(connectorConfiguration: ConnectorConfiguration): Connector
abstract val connectorType: ConnectorType
open fun createRequestFilter(connectorConfiguration: ConnectorConfiguration): RequestFilter
open val supportedResponseConnectorMessageTypes: Set<KClass<out ConnectorMessage>>

class ConnectorQueue

ConnectorQueue(executor: Executor)
fun add(action: Action, delayInMs: Long, send: (action: Action) -> Unit): Unit

interface ConnectorService

abstract fun install(controller: ConnectorController, configuration: BotApplicationConfiguration): Unit

data class ConnectorType

ConnectorType(id: String, userInterfaceType: UserInterfaceType = UserInterfaceType.textChat)
val id: String
val none: ConnectorType
val rest: ConnectorType
fun toString(): String
val userInterfaceType: UserInterfaceType

data class ConnectorTypeConfiguration

ConnectorTypeConfiguration(connectorType: ConnectorType, fields: List<ConnectorTypeConfigurationField> = emptyList(), svgIcon: String? = null)
fun commonSecurityFields(): List<ConnectorTypeConfigurationField>
val connectorConfigurations: Set<ConnectorTypeConfiguration>
val connectorType: ConnectorType
val fields: List<ConnectorTypeConfigurationField>
val svgIcon: String?

data class ConnectorTypeConfigurationField

ConnectorTypeConfigurationField(label: String, key: String, mandatory: Boolean = false)
val key: String
val label: String
val mandatory: Boolean

enum class NotifyBotStateModifier

ACTIVATE_ONLY_FOR_THIS_NOTIFICATION
KEEP_CURRENT_STATE
REACTIVATE

interface SerializableConnectorMessage : ConnectorMessage

package ai.tock.bot.connector.alexa

class AlexaConnector : ConnectorBase

val alexaTockMapper: AlexaTockMapper
val applicationId: String
val path: String
fun register(controller: ConnectorController): Unit
fun send(event: Event, callback: ConnectorCallback, delayInMs: Long): Unit
fun toConnectorMessage(message: MediaMessage): BotBus.() -> List<ConnectorMessage>

data class AlexaConnectorCallback : ConnectorCallbackBase, SpeechletV2

val alexaRequest: SpeechletRequestEnvelope<*>?
val applicationId: String
fun exceptionThrown(event: Event, throwable: Throwable): Unit
fun onIntent(requestEnvelope: SpeechletRequestEnvelope<IntentRequest>): SpeechletResponse?
fun onLaunch(requestEnvelope: SpeechletRequestEnvelope<LaunchRequest>): SpeechletResponse?
fun onSessionEnded(requestEnvelope: SpeechletRequestEnvelope<SessionEndedRequest>): Unit
fun onSessionStarted(requestEnvelope: SpeechletRequestEnvelope<SessionStartedRequest>): Unit

val alexaConnectorType: ConnectorType
fun alexaEndConversation(): AlexaMessage
@ConnectorHandler("alexa") @Target([AnnotationTarget.CLASS]) annotation class AlexaHandler

AlexaHandler(value: KClass<out ConnectorStoryHandler<*>>)
val value: KClass<out ConnectorStoryHandler<*>>

data class AlexaInputMessage : ConnectorMessage

AlexaInputMessage(intentRequest: IntentRequest)
AlexaInputMessage(intentRequest: String)
val connectorType: ConnectorType
val intentRequest: String
fun toGenericMessage(): GenericMessage

data class AlexaMessage : ConnectorMessage

AlexaMessage(end: Boolean, card: Card? = null, reprompt: String? = null)
val card: Card?
val connectorType: ConnectorType
val end: Boolean
val reprompt: String?
fun toGenericMessage(): GenericMessage

fun I18nTranslator.alexaReprompt(reprompt: CharSequence): AlexaMessage
fun I18nTranslator.alexaStandardCard(title: CharSequence, text: CharSequence, smallImageUrl: String, largeImageUrl: String = smallImageUrl): AlexaMessage
open class AlexaTockMapper

AlexaTockMapper(applicationId: String)
open fun alexaEntityToTockEntity(request: IntentRequest, intent: String, slot: String, botDefinition: BotDefinition): Entity?
open fun alexaEntityToTockEntityValue(request: IntentRequest, intent: String, slot: Slot, botDefinition: BotDefinition, index: Int): NlpEntityValue
open fun alexaIntentToTockIntent(request: IntentRequest, botDefinition: BotDefinition): String
val applicationId: String
open fun getSlots(request: IntentRequest): Map<String, Slot>?
open fun toEndSessionEvent(requestEnvelope: SpeechletRequestEnvelope<SessionEndedRequest>): EndSessionEvent
open fun toEvent(userId: String, request: IntentRequest, botDefinition: BotDefinition): Event
open fun toStartSessionEvent(requestEnvelope: SpeechletRequestEnvelope<SessionStartedRequest>): StartSessionEvent

fun <T : Bus<T>> T.endForAlexa(messageProvider: T.() -> AlexaMessage, delay: Long = defaultDelay(currentAnswerIndex)): T
fun <T : Bus<T>> T.sendToAlexa(messageProvider: T.() -> AlexaMessage, delay: Long = defaultDelay(currentAnswerIndex)): T
fun <T : Bus<T>> T.withAlexa(messageProvider: () -> AlexaMessage): T

package ai.tock.bot.connector.ga

fun I18nTranslator.basicCard(title: CharSequence?, subtitle: CharSequence?, formattedText: CharSequence?, image: GAImage?, buttons: List<GAButton>): GABasicCard
fun I18nTranslator.basicCard(title: CharSequence? = null, subtitle: CharSequence? = null, formattedText: CharSequence? = null, image: GAImage? = null, button: GAButton? = null): GABasicCard
fun I18nTranslator.basicCard(title: CharSequence, subtitle: CharSequence, image: GAImage, button: GAButton): GABasicCard
fun I18nTranslator.basicCard(title: CharSequence, button: GAButton): GABasicCard
fun I18nTranslator.basicCard(title: CharSequence, subtitle: CharSequence): GABasicCard
fun I18nTranslator.basicCard(title: CharSequence, image: GAImage): GABasicCard
fun I18nTranslator.basicCard(title: CharSequence, subtitle: CharSequence, image: GAImage): GABasicCard
fun I18nTranslator.basicCard(image: GAImage): GABasicCard
fun <T : Bus<T>> T.carouselItem(targetIntent: IntentAware, title: CharSequence, description: CharSequence? = null, image: GAImage? = null, vararg parameters: Pair<String, String>): GACarouselItem
fun <T : Bus<T>> T.carouselItem(targetIntent: IntentAware, title: CharSequence, description: CharSequence? = null, image: GAImage? = null, parameters: Parameters): GACarouselItem
fun <T : Bus<T>> T.carouselItem(targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>?, title: CharSequence, description: CharSequence? = null, image: GAImage? = null, parameters: Parameters): GACarouselItem
fun <T : Bus<T>> T.carouselItem(targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>?, title: CharSequence, description: CharSequence? = null, image: GAImage? = null, vararg parameters: Pair<String, String>): GACarouselItem
fun <T : Bus<T>> T.endForGoogleAssistant(messageProvider: T.() -> GAResponseConnectorMessage, delay: Long = defaultDelay(currentAnswerIndex)): T
fun I18nTranslator.expectedIntentForCarousel(items: List<GACarouselItem>): GAExpectedIntent
fun I18nTranslator.expectedIntentForList(items: List<GAListItem>, title: CharSequence? = null): GAExpectedIntent
fun I18nTranslator.expectedIntentForSimpleSelect(items: List<GASelectItem>): GAExpectedIntent
fun expectedTextIntent(): GAExpectedIntent
fun ConnectorMessage.findTransactionDecisionValueV3(): GATransactionDecisionValueV3?
fun ConnectorMessage.findTransactionRequirementsCheckResultV3(): GATransactionRequirementsCheckResultV3?
fun I18nTranslator.flexibleSimpleResponse(textToSpeech: CharSequence? = null, ssml: CharSequence? = null, displayText: CharSequence? = null): GASimpleResponse
fun I18nTranslator.gaButton(title: CharSequence, url: String): GAButton
class GAConnector : ConnectorBase

fun addSuggestions(text: CharSequence, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
fun addSuggestions(message: ConnectorMessage, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
val allowedProjectIds: Set<String>
val applicationId: String
fun loadProfile(callback: ConnectorCallback, userId: PlayerId): UserPreferences?
val path: String
fun register(controller: ConnectorController): Unit
fun send(event: Event, callback: ConnectorCallback, delayInMs: Long): Unit
fun toConnectorMessage(message: MediaMessage): BotBus.() -> List<ConnectorMessage>

val gaConnectorType: ConnectorType
fun I18nTranslator.gaFinalMessage(richResponse: GARichResponse): GAResponseConnectorMessage
fun I18nTranslator.gaFinalMessage(text: CharSequence? = null): GAResponseConnectorMessage
fun I18nTranslator.gaFlexibleMessageForCarousel(items: List<GACarouselItem>, suggestions: List<CharSequence> = emptyList(), oneItemTitle: CharSequence? = null, oneItemSubtitle: CharSequence? = null, oneItemDescription: CharSequence? = null, oneItemSuggestions: List<CharSequence> = emptyList()): GAResponseConnectorMessage
fun I18nTranslator.gaFlexibleMessageForCarousel(items: List<GACarouselItem>, suggestions: List<CharSequence> = emptyList(), oneItemSuggestions: List<CharSequence> = emptyList(), oneItemBasicCardProvider: (GACarouselItem) -> GABasicCard = { basicCard( it.title.raw, if (it.image != null) it.description?.raw else null, if (it.image == null) it.description?.raw else null, it.image ) }): GAResponseConnectorMessage
fun I18nTranslator.gaFlexibleMessageForList(items: List<GAListItem>, title: CharSequence? = null, suggestions: List<CharSequence> = emptyList(), oneItemTitle: CharSequence? = null, oneItemSubtitle: CharSequence? = null, oneItemDescription: CharSequence? = null, oneItemSuggestions: List<CharSequence> = emptyList()): GAResponseConnectorMessage
@ConnectorHandler("ga") @Target([AnnotationTarget.CLASS]) annotation class GAHandler

GAHandler(value: KClass<out ConnectorStoryHandler<*>>)
val value: KClass<out ConnectorStoryHandler<*>>

fun I18nTranslator.gaImage(url: String, accessibilityText: CharSequence, height: Int? = null, width: Int? = null): GAImage
fun gaLogout(): GAResponseConnectorMessage
fun I18nTranslator.gaMessage(inputPrompt: GAInputPrompt, possibleIntents: List<GAExpectedIntent> = listOf( expectedTextIntent() ), speechBiasingHints: List<String> = emptyList()): GAResponseConnectorMessage
fun I18nTranslator.gaMessage(text: CharSequence, vararg suggestions: CharSequence): GAResponseConnectorMessage
fun I18nTranslator.gaMessage(text: CharSequence, basicCard: GABasicCard): GAResponseConnectorMessage
fun I18nTranslator.gaMessage(richResponse: GARichResponse): GAResponseConnectorMessage
fun I18nTranslator.gaMessage(possibleIntent: GAExpectedIntent): GAResponseConnectorMessage
fun I18nTranslator.gaMessage(possibleIntents: List<GAExpectedIntent>): GAResponseConnectorMessage
fun I18nTranslator.gaMessage(text: CharSequence, possibleIntents: List<GAExpectedIntent>): GAResponseConnectorMessage
fun I18nTranslator.gaMessage(gaRichResponse: GARichResponse, listItems: List<GAListItem>, title: CharSequence? = null): GAResponseConnectorMessage
fun I18nTranslator.gaMessageForCarousel(items: List<GACarouselItem>, suggestions: List<CharSequence> = emptyList()): GAResponseConnectorMessage
fun I18nTranslator.gaMessageForList(items: List<GAListItem>, title: CharSequence? = null, suggestions: List<CharSequence> = emptyList()): GAResponseConnectorMessage
class GaNotificationClient

GaNotificationClient()
interface GaNotificationApi

@POST("./conversations:send") abstract fun push(@Body notification: GAPushNotification): Call<ResponseBody>

fun push(title: String, userId: String, intent: String, locale: String): Boolean

data class GARequestConnectorMessage : ConnectorMessage

GARequestConnectorMessage(request: GARequest)
val connectorType: ConnectorType
val request: GARequest

data class GAResponseConnectorMessage : ConnectorMessage

GAResponseConnectorMessage(input: GAExpectedInput)
GAResponseConnectorMessage(expectUserResponse: Boolean = true, expectedInputs: List<GAExpectedInput> = emptyList(), finalResponse: GAFinalResponse? = null, logoutEvent: Boolean = false)
val connectorType: ConnectorType
val expectedInput: GAExpectedInput?
val expectedInputs: List<GAExpectedInput>
val expectUserResponse: Boolean
val finalResponse: GAFinalResponse?
val logoutEvent: Boolean
fun toGenericMessage(): GenericMessage?

fun I18nTranslator.gaTransactionOrderDecision(order: GAOrder, orderOptions: GAOrderOptionsV3? = null, paymentParameters: GAPaymentParameters? = null, presentationOptions: GAPresentationOptions? = null): GAResponseConnectorMessage
fun I18nTranslator.gaTransactionOrderUpdate(orderUpdate: GAOrderUpdateV3): GAResponseConnectorMessage
fun I18nTranslator.gaTransactionRequirementsCheckV3(): GAResponseConnectorMessage
fun I18nTranslator.inputPrompt(richResponse: GARichResponse, noInputPrompts: List<GASimpleResponse> = emptyList()): GAInputPrompt
fun I18nTranslator.inputPrompt(text: CharSequence, linkOutSuggestion: GALinkOutSuggestion? = null, noInputPrompts: List<GASimpleResponse> = emptyList()): GAInputPrompt
fun I18nTranslator.item(simpleResponse: GASimpleResponse? = null, basicCard: GABasicCard? = null, structuredResponse: GAStructuredResponse? = null): GAItem
fun I18nTranslator.item(basicCard: GABasicCard): GAItem
fun I18nTranslator.item(structuredResponse: GAStructuredResponse): GAItem
fun I18nTranslator.item(simpleResponse: GASimpleResponse): GAItem
fun I18nTranslator.linkOutSuggestion(destinationName: CharSequence, url: String): GALinkOutSuggestion
fun <T : Bus<T>> T.listItem(title: CharSequence, targetIntent: IntentAware, vararg parameters: Pair<String, String>): GAListItem
fun <T : Bus<T>> T.listItem(title: CharSequence, targetIntent: IntentAware, description: CharSequence, imageUrl: String? = null, vararg parameters: Pair<String, String>): GAListItem
fun <T : Bus<T>> T.listItem(title: CharSequence, targetIntent: IntentAware, parameters: Parameters): GAListItem
fun <T : Bus<T>> T.listItem(title: CharSequence, targetIntent: IntentAware, description: CharSequence?, imageUrl: String? = null, parameters: Parameters): GAListItem
fun <T : Bus<T>> T.listItem(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>?, parameters: Parameters): GAListItem
fun <T : Bus<T>> T.listItem(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>?, vararg parameters: Pair<String, String>): GAListItem
fun <T : Bus<T>> T.listItem(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>?, description: CharSequence? = null, imageUrl: String? = null, parameters: Parameters): GAListItem
fun <T : Bus<T>> T.listItem(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>?, description: CharSequence? = null, imageUrl: String? = null, vararg parameters: Pair<String, String>): GAListItem
fun <T : Bus<T>> T.optionInfo(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, vararg parameters: Pair<String, String>): GAOptionInfo
fun I18nTranslator.optionValueSpec(simpleSelect: GASimpleSelect? = null, listSelect: GAListSelect? = null, carouselSelect: GACarouselSelect? = null): GAOptionValueSpec
fun I18nTranslator.permissionIntent(optionalContext: CharSequence? = null, vararg permissions: GAPermission): GAExpectedIntent
fun richResponse(items: List<GAItem>, linkOutSuggestion: GALinkOutSuggestion? = null, suggestions: List<GASuggestion>): GARichResponse
fun I18nTranslator.richResponse(items: List<GAItem>, linkOutSuggestion: GALinkOutSuggestion? = null, vararg suggestions: CharSequence): GARichResponse
fun I18nTranslator.richResponse(items: List<GAItem>, vararg suggestions: CharSequence): GARichResponse
fun I18nTranslator.richResponse(items: List<GAItem>, suggestions: List<CharSequence>): GARichResponse
fun I18nTranslator.richResponse(item: GAItem, linkOutSuggestion: GALinkOutSuggestion? = null, suggestions: List<CharSequence>): GARichResponse
fun I18nTranslator.richResponse(item: GAItem, linkOutSuggestion: GALinkOutSuggestion? = null, vararg suggestions: CharSequence): GARichResponse
fun I18nTranslator.richResponse(text: CharSequence, linkOutSuggestion: GALinkOutSuggestion? = null, suggestions: List<CharSequence>): GARichResponse
fun I18nTranslator.richResponse(text: CharSequence, linkOutSuggestion: GALinkOutSuggestion? = null, vararg suggestions: CharSequence): GARichResponse
fun I18nTranslator.richResponse(text: CharSequence, vararg suggestions: CharSequence): GARichResponse
fun I18nTranslator.richResponse(text: CharSequence, suggestions: List<CharSequence>): GARichResponse
fun I18nTranslator.richResponse(text: CharSequence, basicCard: GABasicCard, linkOutSuggestion: GALinkOutSuggestion? = null, suggestions: List<CharSequence>): GARichResponse
fun I18nTranslator.richResponse(text: CharSequence, basicCard: GABasicCard, suggestions: List<CharSequence>): GARichResponse
fun I18nTranslator.richResponse(text: CharSequence, basicCard: GABasicCard, vararg suggestions: CharSequence): GARichResponse
fun I18nTranslator.richResponse(basicCard: GABasicCard, linkOutSuggestion: GALinkOutSuggestion? = null, suggestions: List<CharSequence>): GARichResponse
fun I18nTranslator.richResponse(basicCard: GABasicCard, suggestions: List<CharSequence>): GARichResponse
fun I18nTranslator.richResponse(basicCard: GABasicCard, vararg suggestions: CharSequence): GARichResponse
fun <T : Bus<T>> T.selectItem(title: CharSequence, targetIntent: IntentAware, vararg parameters: Pair<String, String>): GASelectItem
fun <T : Bus<T>> T.selectItem(title: CharSequence, targetIntent: IntentAware, optionTitle: CharSequence? = null, vararg parameters: Pair<String, String>): GASelectItem
fun <T : Bus<T>> T.selectItem(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>, optionTitle: CharSequence? = null, parameters: Parameters): GASelectItem
fun <T : Bus<T>> T.selectItem(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, optionTitle: CharSequence? = null, vararg parameters: Pair<String, String>): GASelectItem
fun <T : Bus<T>> T.sendToGoogleAssistant(messageProvider: T.() -> GAResponseConnectorMessage, delay: Long = defaultDelay(currentAnswerIndex)): T
fun I18nTranslator.simpleResponse(text: CharSequence): GASimpleResponse
fun I18nTranslator.suggestion(text: CharSequence): GASuggestion
fun I18nTranslator.updatePermissionIntent(intent: String): GAExpectedIntent
fun <T : Bus<T>> T.withGoogleAssistant(messageProvider: () -> GAResponseConnectorMessage): T
fun <T : Bus<T>> T.withGoogleVoiceAssistant(messageProvider: () -> GAResponseConnectorMessage): T

package ai.tock.bot.connector.ga.model

enum class GAInputValueDataType

confirmation
datetime
deliveryAddress
mediaStatus
newSurface
option
permission
transactionDecisionV3
transactionRequirementsCheckV3
val value: String

enum class GAIntent

cancel
confirmation
datetime
deliveryAddress
fun findIntent(name: String): GAIntent?
main
mediaStatus
newSurface
noInput
option
permission
signIn
text
transactionDecisionV3
transactionRequirementsCheckV3
val type: GAInputValueDataType?
val value: String

package ai.tock.bot.connector.ga.model.notification

data class GANotification

GANotification(title: String)
val title: String

data class GaPushMessage

GaPushMessage(userNotification: GANotification, target: GATarget)
val target: GATarget
val userNotification: GANotification

data class GAPushNotification

GAPushNotification(customPushMessage: GaPushMessage)
val customPushMessage: GaPushMessage

data class GATarget

GATarget(userId: String, intent: String, locale: String)
val intent: String
val locale: String
val userId: String

package ai.tock.bot.connector.ga.model.request

data class GAArgument

GAArgument(name: String, rawText: String? = null, boolValue: Boolean? = null, textValue: String? = null, datetimeValue: GADateTime? = null, extension: GAArgumentValue? = null)
val boolValue: Boolean?
val builtInArg: GAArgumentBuiltInName?
val datetimeValue: GADateTime?
val extension: GAArgumentValue?
val healthcheck: Boolean
val name: String
val rawText: String?
val textValue: String?

enum class GAArgumentBuiltInName

CONFIRMATION
DATETIME
DELIVERY_ADDRESS_VALUE
MEDIA_STATUS
NEW_SURFACE
OPTION
PERMISSION
SIGN_IN
TRANSACTION_DECISION_VALUE
TRANSACTION_REQUIREMENTS_CHECK_RESULT

abstract class GAArgumentValue

GAArgumentValue(type: GAArgumentValueType)
val type: GAArgumentValueType

enum class GAArgumentValueType

holdValue
mediaStatus
newSurfaceValue
signInValue
transactionDecisionValue
transactionRequirementsCheckResult
transactionRequirementsCheckResultV3
val value: String

data class GACapability

GACapability(name: String)
const val AUDIO_OUTPUT: String
val name: String
const val SCREEN_OUTPUT: String

data class GAConversation

GAConversation(conversationId: String = Dice.newId(), type: GAConversationType = TYPE_UNSPECIFIED, conversationToken: String? = null)
val conversationId: String
val conversationToken: String?
val type: GAConversationType

enum class GAConversationType

ACTIVE
NEW
TYPE_UNSPECIFIED

data class GADate

GADate(year: Int, month: Int, day: Int)
val day: Int
val month: Int
val year: Int

data class GADateTime

GADateTime(date: GADate, time: GATimeOfDay)
val date: GADate
val time: GATimeOfDay

data class GADevice

GADevice(location: GALocation? = null)
val location: GALocation?

data class GAGoogleProvidedPaymentInstrument

GAGoogleProvidedPaymentInstrument(instrumentToken: String)
val instrumentToken: String

enum class GAHoldStatus

PERMISSION_DENIED

data class GAHoldValue : GAArgumentValue

GAHoldValue(userDecision: GAHoldStatus?)
val userDecision: GAHoldStatus?

data class GAInput

GAInput(rawInputs: List<GARawInput>, intent: String, arguments: List<GAArgument>?)
val arguments: List<GAArgument>?
val builtInIntent: GAIntent?
val healthcheck: Boolean
val intent: String
val rawInputs: List<GARawInput>

enum class GAInputType

KEYBOARD
TOUCH
UNSPECIFIED_INPUT_TYPE
URL
VOICE

data class GALatLng

GALatLng(latitude: Double, longitude: Double)
val latitude: Double
val longitude: Double

data class GALocation

GALocation(coordinates: GALatLng?, formattedAddress: String?, zipCode: String?, city: String?, postalAddress: GAPostalAddress?, name: String?, phoneNumber: String?, notes: String?)
val city: String?
val coordinates: GALatLng?
val formattedAddress: String?
val name: String?
val notes: String?
val phoneNumber: String?
val postalAddress: GAPostalAddress?
val zipCode: String?

enum class GANewSurfaceStatus

CANCELLED
NEW_SURFACE_STATUS_UNSPECIFIED
OK

data class GANewSurfaceValue : GAArgumentValue

GANewSurfaceValue(status: GANewSurfaceStatus)
val status: GANewSurfaceStatus

enum class GAPermission

DEVICE_COARSE_LOCATION
DEVICE_PRECISE_LOCATION
NAME
UNSPECIFIED_PERMISSION
UPDATE

data class GAPostalAddress

GAPostalAddress(revision: Double, regionCode: String, languageCode: String?, postalCode: String?, sortingCode: String?, administrativeArea: String?, locality: String?, sublocality: String?, addressLines: List<String>, recipients: List<String>?, organization: String?)
val addressLines: List<String>
val administrativeArea: String?
val languageCode: String?
val locality: String?
val organization: String?
val postalCode: String?
val recipients: List<String>?
val regionCode: String
val revision: Double
val sortingCode: String?
val sublocality: String?

data class GARawInput

GARawInput(createTime: String?, inputType: GAInputType?, query: String?)
val createTime: String?
val inputType: GAInputType?
val query: String?

data class GARequest

GARequest(user: GAUser, device: GADevice?, surface: GASurface, conversation: GAConversation, inputs: List<GAInput>, isInSandbox: Boolean = false, availableSurfaces: List<GASurface> = emptyList())
val availableSurfaces: List<GASurface>
val conversation: GAConversation
val device: GADevice?
fun getEventState(): EventState
val healthcheck: Boolean
val inputs: List<GAInput>
val isInSandbox: Boolean
val surface: GASurface
val user: GAUser

enum class GAResultType

ASSISTANT_SURFACE_NOT_SUPPORTED
OK
REGION_NOT_SUPPORTED
RESULT_TYPE_UNSPECIFIED
USER_ACTION_REQUIRED

enum class GASignInStatus

CANCELLED
ERROR
OK
SIGN_IN_STATUS_UNSPECIFIED

data class GASignInValue : GAArgumentValue

GASignInValue(status: GASignInStatus)
val status: GASignInStatus

data class GASurface

GASurface(capabilities: List<GACapability>)
val capabilities: List<GACapability>
fun hasAudio(): Boolean
fun hasScreen(): Boolean

data class GATimeOfDay

GATimeOfDay(hours: Int, minutes: Int, seconds: Int, nanos: Int)
val hours: Int
val minutes: Int
val nanos: Int
val seconds: Int

data class GATransactionDecisionCheckResult

GATransactionDecisionCheckResult(resultType: GAResultType)
val resultType: GAResultType

enum class GATransactionUserDecision

CART_CHANGE_REQUESTED
DELIVERY_ADDRESS_UPDATED
ORDER_ACCEPTED
ORDER_REJECTED
UNKNOWN_USER_DECISION

data class GAUser

GAUser(profile: GAUserProfile? = null, accessToken: String? = null, permissions: Set<GAPermission>? = null, userVerificationStatus: GAUserVerificationStatus = GAUserVerificationStatus.VERIFIED, locale: String = defaultLocale.toLanguageTag())
val accessToken: String?
fun findLocale(): Locale
val locale: String
val permissions: Set<GAPermission>?
val profile: GAUserProfile?
val userVerificationStatus: GAUserVerificationStatus

data class GAUserProfile

GAUserProfile(displayName: String?, givenName: String?, familyName: String?)
val displayName: String?
val familyName: String?
val givenName: String?

enum class GAUserVerificationStatus

GUEST
UNKNOWN
VERIFIED

package ai.tock.bot.connector.ga.model.request.transaction.v3

enum class GAPaymentType

BANK
GIFT_CARD
LOYALTY_PROGRAM
ON_FULFILLMENT
PAYMENT_CARD
PAYMENT_TYPE_UNSPECIFIED

enum class GAResultTypeV3

CAN_TRANSACT
CANNOT_TRANSACT
RESULT_TYPE_UNSPECIFIED

enum class GATransactionDecision

CART_CHANGE_REQUESTED
DELIVERY_ADDRESS_UPDATED
ORDER_ACCEPTED
ORDER_REJECTED
TRANSACTION_DECISION_UNSPECIFIED
USER_CANNOT_TRANSACT

data class GATransactionDecisionValueV3 : GAArgumentValue

GATransactionDecisionValueV3(transactionDecision: GATransactionDecision, order: GAOrder?, deliveryAddress: GALocation?)
val deliveryAddress: GALocation?
val order: GAOrder?
val transactionDecision: GATransactionDecision

data class GATransactionRequirementsCheckResultV3 : GAArgumentValue

GATransactionRequirementsCheckResultV3(resultType: GAResultTypeV3)
val resultType: GAResultTypeV3

package ai.tock.bot.connector.ga.model.response

data class GAAction

GAAction(type: GAActionType, button: GAButton)
val button: GAButton
val type: GAActionType

data class GAActionProvidedPaymentOptions

GAActionProvidedPaymentOptions(paymentType: GaPaymentType, displayName: String)
val displayName: String
val paymentType: GaPaymentType

enum class GAActionType

CALL
CANCEL
CUSTOMER_SERVICE
EMAIL
EXCHANGE
MODIFY
REORDER
RETURN
REVIEW
UNKNOWN
VIEW_DETAILS

data class GABasicCard

GABasicCard(title: String? = null, subtitle: String? = null, formattedText: String? = null, image: GAImage? = null, buttons: List<GAButton> = emptyList())
val buttons: List<GAButton>
val formattedText: String?
val image: GAImage?
val subtitle: String?
val title: String?
fun toGenericMessage(): GenericMessage

data class GAButton

GAButton(title: String, openUrlAction: GAOpenUrlAction)
val openUrlAction: GAOpenUrlAction
val title: String
fun toChoice(): Choice

data class GACancellationInfo

GACancellationInfo(reason: String)
val reason: String

enum class GACardNetwork

AMEX
DISCOVER
JCB
MASTERCARD
UNSPECIFIED_CARD_NETWORK
VISA

data class GACarouselItem

GACarouselItem(optionInfo: GAOptionInfo, title: String, description: String? = null, image: GAImage? = null)
val description: String?
val image: GAImage?
val optionInfo: GAOptionInfo
val title: String
fun toGenericElement(): GenericElement

data class GACarouselSelect

GACarouselSelect(items: List<GACarouselItem>)
val items: List<GACarouselItem>
fun toGenericMessage(): GenericMessage

enum class GACustomerInfoProperty

CUSTOMER_INFO_PROPERTY_UNSPECIFIED
EMAIL

data class GAExpectedInput

GAExpectedInput(inputPrompt: GAInputPrompt, possibleIntents: List<GAExpectedIntent> = listOf( GAExpectedIntent(GAIntent.text) ), speechBiasingHints: List<String> = emptyList())
val inputPrompt: GAInputPrompt
val possibleIntents: List<GAExpectedIntent>
val speechBiasingHints: List<String>
fun toGenericMessage(): GenericMessage?

data class GAExpectedIntent

GAExpectedIntent(intent: GAIntent, inputValueData: GAInputValueData? = null)
val inputValueData: GAInputValueData?
val intent: GAIntent
fun toGenericMessage(): GenericMessage?

data class GAFinalResponse

GAFinalResponse(richResponse: GARichResponse)
val richResponse: GARichResponse
fun toGenericMessage(): GenericMessage?

data class GAFulfillmentInfo

GAFulfillmentInfo(deliveryTime: String)
val deliveryTime: String

data class GAGoogleProvidedPaymentOptions

GAGoogleProvidedPaymentOptions(tokenizationParameters: GAPaymentMethodTokenizationParameters, supportedCardNetworks: Set<GACardNetwork>, prepaidCardDisallowed: Boolean)
val prepaidCardDisallowed: Boolean
val supportedCardNetworks: Set<GACardNetwork>
val tokenizationParameters: GAPaymentMethodTokenizationParameters

data class GAImage

GAImage(url: String, accessibilityText: String, height: Int? = null, width: Int? = null)
val accessibilityText: String
val height: Int?
fun toAttachment(): Attachment
fun toMetadata(): Map<String, String>
val url: String
val width: Int?

data class GAInputPrompt

GAInputPrompt(richInitialPrompt: GARichResponse, noInputPrompts: List<GASimpleResponse> = emptyList())
val noInputPrompts: List<GASimpleResponse>
val richInitialPrompt: GARichResponse
fun toGenericMessage(): GenericMessage?

abstract class GAInputValueData

GAInputValueData(type: GAInputValueDataType)
open fun toGenericMessage(): GenericMessage?
val type: GAInputValueDataType

data class GAInTransitInfo

GAInTransitInfo(updatedTime: String)
val updatedTime: String

data class GAItem

GAItem(simpleResponse: GASimpleResponse? = null, basicCard: GABasicCard? = null, structuredResponse: GAStructuredResponse? = null, mediaResponse: GAMediaResponse? = null)
val basicCard: GABasicCard?
val mediaResponse: GAMediaResponse?
val simpleResponse: GASimpleResponse?
val structuredResponse: GAStructuredResponse?
fun toGenericMessage(): GenericMessage?

enum class GALineItemType

DELIVERY
DISCOUNT
FEE
GRATUITY
REGULAR
SUBTOTAL
TAX
UNSPECIFIED

data class GALinkOutSuggestion

GALinkOutSuggestion(destinationName: String, url: String)
val destinationName: String
fun toChoice(): Choice
val url: String

data class GAListItem

GAListItem(optionInfo: GAOptionInfo, title: String, description: String? = null, image: GAImage? = null)
val description: String?
val image: GAImage?
val optionInfo: GAOptionInfo
val title: String
fun toGenericElement(): GenericElement

data class GAListSelect

GAListSelect(title: String?, items: List<GAListItem>)
val items: List<GAListItem>
val title: String?
fun toGenericMessage(): GenericMessage

data class GAMediaObject

GAMediaObject(name: String? = null, description: String? = null, contentUrl: String? = null, largeImage: GAImage? = null, icon: GAImage? = null)
val contentUrl: String?
val description: String?
val icon: GAImage?
val largeImage: GAImage?
val name: String?

data class GAMediaResponse

GAMediaResponse(mediaType: GAMediaType = MEDIA_TYPE_UNSPECIFIED, mediaObjects: List<GAMediaObject> = emptyList())
val mediaObjects: List<GAMediaObject>
val mediaType: GAMediaType

enum class GAMediaStatus

FAILED
FINISHED
STATUS_UNSPECIFIED

data class GAMediaStatusValue : GAArgumentValue

GAMediaStatusValue(status: GAMediaStatus)
val status: GAMediaStatus

enum class GAMediaType

AUDIO
MEDIA_TYPE_UNSPECIFIED

data class GAMerchant

GAMerchant(id: String, name: String)
val id: String
val name: String

data class GANewSurfaceValueSpec : GAInputValueData

GANewSurfaceValueSpec(capabilities: Set<String>, context: String, notificationTitle: String)
val capabilities: Set<String>
val context: String
val notificationTitle: String

data class GAOpenUrlAction

GAOpenUrlAction(url: String)
val url: String

data class GAOptionInfo

GAOptionInfo(key: String, synonyms: List<String>)
val key: String
val synonyms: List<String>
fun toChoice(): Choice

data class GAOptionValueSpec : GAInputValueData

GAOptionValueSpec(simpleSelect: GASimpleSelect? = null, listSelect: GAListSelect? = null, carouselSelect: GACarouselSelect? = null)
val carouselSelect: GACarouselSelect?
val listSelect: GAListSelect?
val simpleSelect: GASimpleSelect?
fun toGenericMessage(): GenericMessage?

data class GAOrderState

GAOrderState(state: GAState, label: String)
val label: String
val state: GAState

data class GAPaymentMethodTokenizationParameters

GAPaymentMethodTokenizationParameters(tokenizationType: GAPaymentMethodTokenizationType)
val tokenizationType: GAPaymentMethodTokenizationType

enum class GAPaymentMethodTokenizationType

PAYMENT_GATEWAY
UNSPECIFIED_TOKENIZATION_TYPE

data class GAPaymentOptions

GAPaymentOptions(googleProvidedOptions: GAGoogleProvidedPaymentOptions? = null, actionProvidedOptions: GAActionProvidedPaymentOptions? = null)
val actionProvidedOptions: GAActionProvidedPaymentOptions?
val googleProvidedOptions: GAGoogleProvidedPaymentOptions?

enum class GaPaymentType

BANK
GIFT_CARD
LOYALTY_PROGRAM
ON_FULFILLMENT
PAYMENT_CARD
PAYMENT_TYPE_UNSPECIFIED

data class GAPermissionValueSpec : GAInputValueData

GAPermissionValueSpec(optContext: String?, permissions: Set<GAPermission>, updatePermissionValueSpec: GAUpdatePermissionValueSpec? = null)
val optContext: String?
val permissions: Set<GAPermission>
val updatePermissionValueSpec: GAUpdatePermissionValueSpec?

enum class GAPriceType

ACTUAL
ESTIMATE
UNKNOWN

enum class GAReasonType

INELIGIBLE
PAYMENT_DECLINED
UNKNOWN

data class GAReceipt

GAReceipt(confirmedActionOrderId: String, userVisibleOrderId: String)
val confirmedActionOrderId: String
val userVisibleOrderId: String

data class GARejectionInfo

GARejectionInfo(type: GAReasonType, reason: String)
val reason: String
val type: GAReasonType

data class GAResponse

GAResponse(conversationToken: String, expectUserResponse: Boolean = true, expectedInputs: List<GAExpectedInput>?, finalResponse: GAFinalResponse? = null, responseMetadata: GAResponseMetadata? = null, isInSandbox: Boolean)
val conversationToken: String
val expectedInputs: List<GAExpectedInput>?
val expectUserResponse: Boolean
val finalResponse: GAFinalResponse?
val isInSandbox: Boolean
val responseMetadata: GAResponseMetadata?

data class GAResponseMetadata

GAResponseMetadata(status: GAStatus)
val status: GAStatus

data class GAReturnInfo

GAReturnInfo(reason: String)
val reason: String

data class GARichResponse

GARichResponse(items: List<GAItem>, suggestions: List<GASuggestion> = emptyList(), linkOutSuggestion: GALinkOutSuggestion? = null)
val items: List<GAItem>
val linkOutSuggestion: GALinkOutSuggestion?
val suggestions: List<GASuggestion>
fun toGenericMessage(): GenericMessage?

data class GASelectItem

GASelectItem(optionInfo: GAOptionInfo, title: String?)
val optionInfo: GAOptionInfo
val title: String?
fun toChoice(): Choice

data class GASimpleResponse

GASimpleResponse(textToSpeech: String? = null, ssml: String? = null, displayText: String? = null)
val displayText: String?
val ssml: String?
val textToSpeech: String?
fun toGenericMessage(): GenericMessage

data class GASimpleSelect

GASimpleSelect(items: List<GASelectItem>)
val items: List<GASelectItem>
fun toGenericMessage(): GenericMessage

enum class GAState

CANCELLED
CHANGE_REQUESTED
CONFIRMED
CREATED
FULFILLED
IN_TRANSIT
REJECTED
RETURNED

data class GAStatus

GAStatus(code: GAStatusCode = GAStatusCode.INTERNAL, message: String, details: List<GAStatusDetail>)
val code: GAStatusCode
val details: List<GAStatusDetail>
val message: String

enum class GAStatusCode

ABORTED
ALREADY_EXISTS
CANCELLED
DATA_LOSS
DEADLINE_EXCEEDED
FAILED_PRECONDITION
INTERNAL
INVALID_ARGUMENT
NOT_FOUND
OK
OUT_OF_RANGE
PERMISSION_DENIED
RESOURCE_EXHAUSTED
fun toOrdinal(): Int
UNAUTHENTICATED
UNAVAILABLE
UNIMPLEMENTED
UNKNOWN

data class GAStatusDetail

GAStatusDetail(stackTrace: String, requestBody: String? = null, requestParsed: GARequest? = null, type: String = "type.googleapis.com")
val requestBody: String?
val requestParsed: GARequest?
val stackTrace: String
val type: String

data class GAStructuredResponse

GAStructuredResponse(orderUpdateV3: GAOrderUpdateV3?)
val orderUpdateV3: GAOrderUpdateV3?

data class GASuggestion

GASuggestion(title: String)
val title: String

data class GAUpdatePermissionValueSpec

GAUpdatePermissionValueSpec(intent: String)
val intent: String

data class GAUserNotification

GAUserNotification(title: String, text: String)
val text: String
val title: String

package ai.tock.bot.connector.ga.model.response.transaction.v3

enum class GAActionDisplayName

BOOK
BUY
PAY
PLACE_ORDER
RESERVE
SCHEDULE
SEND
SUBSCRIBE

data class GAActionV3

GAActionV3(type: GAActionType, title: String?, openUrlAction: GAOpenUrlAction)
val openUrlAction: GAOpenUrlAction
val title: String?
val type: GAActionType

data class GAContents

GAContents(lineItems: List<GALineItemV3>? = null)
val lineItems: List<GALineItemV3>?

data class GaItemOption

GaItemOption(id: String? = null, name: String? = null, prices: List<GAPriceAttribute>? = emptyList(), note: String? = null, quantity: Int? = null, productId: String?)
val id: String?
val name: String?
val note: String?
val prices: List<GAPriceAttribute>?
val productId: String?
val quantity: Int?

data class GALineItemV3

GALineItemV3(id: String, name: String? = null, priceAttributes: List<GAPriceAttribute>? = emptyList(), image: GAImage? = null, description: String? = null, notes: List<String>? = emptyList(), purchase: GAPurchaseItemExtension? = null, reservation: GAReservationItemExtension? = null)
val description: String?
val id: String
val image: GAImage?
val name: String?
val notes: List<String>?
val priceAttributes: List<GAPriceAttribute>?
val purchase: GAPurchaseItemExtension?
val reservation: GAReservationItemExtension?

data class GAMerchantPaymentMethod

GAMerchantPaymentMethod(paymentMethodGroup: String?, paymentMethodId: String?, paymentMethodDisplayInfo: GAPaymentMethodDisplayInfo, paymentMethodStatus: GAPaymentMethodStatus?)
val paymentMethodDisplayInfo: GAPaymentMethodDisplayInfo
val paymentMethodGroup: String?
val paymentMethodId: String?
val paymentMethodStatus: GAPaymentMethodStatus?

data class GAMerchantPaymentOption

GAMerchantPaymentOption(merchantPaymentMethod: List<GAMerchantPaymentMethod>, defaultMerchantPaymentMethodId: String?, managePaymentMethodUrl: String?)
val defaultMerchantPaymentMethodId: String?
val managePaymentMethodUrl: String?
val merchantPaymentMethod: List<GAMerchantPaymentMethod>

enum class GAMoneyType

DELIVERY
DISCOUNT
FEE
GRATUITY
REGULAR
SUBTOTAL
TAX
TOTAL
TYPE_UNSPECIFIED

data class GAMoneyV3

GAMoneyV3(currencyCode: String?, amountInMicros: String?)
val amountInMicros: String?
val currencyCode: String?

data class GAOrder

GAOrder(googleOrderId: String? = null, merchantOrderId: String, buyerInfo: GAUserInfo? = null, image: GAImage? = null, createTime: String, lastUpdateTime: String? = null, transactionMerchant: GAMerchant? = null, contents: GAContents, priceAttributes: List<GAPriceAttribute>? = emptyList(), followUpActions: List<GAActionV3>? = emptyList(), termsOfServiceUrl: String? = null, note: String? = null, purchase: GAPurchaseOrderExtension? = null, ticket: GATicketOrderExtension? = null)
val buyerInfo: GAUserInfo?
val contents: GAContents
val createTime: String
val followUpActions: List<GAActionV3>?
val googleOrderId: String?
val image: GAImage?
val lastUpdateTime: String?
val merchantOrderId: String
val note: String?
val priceAttributes: List<GAPriceAttribute>?
val purchase: GAPurchaseOrderExtension?
val termsOfServiceUrl: String?
val ticket: GATicketOrderExtension?
val transactionMerchant: GAMerchant?

data class GAOrderOptionsV3

GAOrderOptionsV3(requestDeliveryAddress: Boolean = false, userInfoOptions: GAUserInfoOptions? = null)
val requestDeliveryAddress: Boolean
val userInfoOptions: GAUserInfoOptions?

data class GAOrderUpdateV3

GAOrderUpdateV3(type: String? = null, updateMask: String? = null, order: GAOrder, userNotification: GAUserNotification? = null, reason: String? = null)
val order: GAOrder
val reason: String?
val type: String?
val updateMask: String?
val userNotification: GAUserNotification?

data class GAPaymentMethodDisplayInfo

GAPaymentMethodDisplayInfo(paymentType: GAPaymentType?, paymentMethodDisplayName: String?)
val paymentMethodDisplayName: String?
val paymentType: GAPaymentType?

data class GAPaymentMethodStatus

GAPaymentMethodStatus(status: GAStatusCode?, statusMessage: String?)
val status: GAStatusCode?
val statusMessage: String?

enum class GAPaymentMethodStatusValue

STATUS_INAPPLICABLE
STATUS_OK
STATUS_REQUIRE_FIX
STATUS_UNSPECIFIED

data class GAPaymentParameters

GAPaymentParameters(merchantPaymentOption: GAMerchantPaymentOption?)
val merchantPaymentOption: GAMerchantPaymentOption?

data class GAPhoneNumber

GAPhoneNumber(e164PhoneNumber: String?, extension: String?, preferredDomesticCarrierCode: String?)
val e164PhoneNumber: String?
val extension: String?
val preferredDomesticCarrierCode: String?

data class GAPresentationOptions

GAPresentationOptions(actionDisplayName: GAActionDisplayName)
val actionDisplayName: GAActionDisplayName

data class GAPriceAttribute

GAPriceAttribute(type: GAMoneyType, name: String, state: GAPriceState, taxIncluded: Boolean?, amount: GAMoneyV3?)
val amount: GAMoneyV3?
val name: String
val state: GAPriceState
val taxIncluded: Boolean?
val type: GAMoneyType

data class GAPriceMoney

GAPriceMoney(currencyCode: String, amountInMicros: String)
val amountInMicros: String
val currencyCode: String

enum class GAPriceState

ACTUAL
ESTIMATE
STATE_UNSPECIFIED

data class GAPurchaseItemExtension

GAPurchaseItemExtension(status: GAPurchaseStatus = GAPurchaseStatus.PURCHASE_STATUS_UNSPECIFIED, userVisibleStatusLabel: String, type: GAPurchaseType = GAPurchaseType.PURCHASE_TYPE_UNSPECIFIED, quantity: Int? = null, itemOptions: List<GaItemOption>? = emptyList())
val itemOptions: List<GaItemOption>?
val quantity: Int?
val status: GAPurchaseStatus
val type: GAPurchaseType
val userVisibleStatusLabel: String

data class GAPurchaseOrderExtension

GAPurchaseOrderExtension(status: GAPurchaseStatus = GAPurchaseStatus.PURCHASE_STATUS_UNSPECIFIED, userVisibleStatusLabel: String, type: GAPurchaseType = GAPurchaseType.PURCHASE_TYPE_UNSPECIFIED)
val status: GAPurchaseStatus
val type: GAPurchaseType
val userVisibleStatusLabel: String

enum class GAPurchaseStatus

CANCELLED
CONFIRMED
CREATED
DELIVERED
PURCHASE_STATUS_UNSPECIFIED

enum class GAPurchaseType

PURCHASE_TYPE_UNSPECIFIED

data class GAReservationItemExtension

GAReservationItemExtension(status: GAReservationStatus = GAReservationStatus.RESERVATION_STATUS_UNSPECIFIED, userVisibleStatusLabel: String, type: GAReservationType? = GAReservationType.RESERVATION_TYPE_UNSPECIFIED, confirmationCode: String? = null, reservationTime: GATime? = null, userAcceptableTimeRange: GATime? = null, partySize: Int? = null, staffFacilitators: List<GAStaffFacilitator>? = null, location: GALocation? = null)
val confirmationCode: String?
val location: GALocation?
val partySize: Int?
val reservationTime: GATime?
val staffFacilitators: List<GAStaffFacilitator>?
val status: GAReservationStatus
val type: GAReservationType?
val userAcceptableTimeRange: GATime?
val userVisibleStatusLabel: String

enum class GAReservationStatus

CANCELLED
CHANGE_REQUESTED
CONFIRMED
FULFILLED
PENDING
REJECTED
RESERVATION_STATUS_UNSPECIFIED

enum class GAReservationType

RESERVATION_TYPE_UNSPECIFIED

data class GAStaffFacilitator

GAStaffFacilitator(name: String?, image: GAImage?)
val image: GAImage?
val name: String?

data class GATicketItemExtension

GATicketItemExtension(ticketEvent: TicketEvent, quantity: Int?, ticketType: String?)
val quantity: Int?
val ticketEvent: TicketEvent
val ticketType: String?

data class GATicketOrderExtension

GATicketOrderExtension(ticketEvent: TicketEvent)
val ticketEvent: TicketEvent

data class GATime

GATime(timeIso8601: String)
val timeIso8601: String

data class GATransactionDecisionValueSpecV3 : GAInputValueData

GATransactionDecisionValueSpecV3(order: GAOrder, orderOptions: GAOrderOptionsV3?, paymentParameters: GAPaymentParameters?, presentationOptions: GAPresentationOptions?)
val order: GAOrder
val orderOptions: GAOrderOptionsV3?
val paymentParameters: GAPaymentParameters?
val presentationOptions: GAPresentationOptions?

class GATransactionRequirementsCheckSpecV3 : GAInputValueData

GATransactionRequirementsCheckSpecV3()

data class GAUserInfo

GAUserInfo(email: String?, firstName: String?, lastName: String?, displayName: String?, phoneNumbers: List<GAPhoneNumber>?)
val displayName: String?
val email: String?
val firstName: String?
val lastName: String?
val phoneNumbers: List<GAPhoneNumber>?

data class GAUserInfoOptions

GAUserInfoOptions(userInfoProperties: Set<UserInfoProperty>?)
val userInfoProperties: Set<UserInfoProperty>?

data class TicketEvent

TicketEvent(type: TicketEventType = TicketEventType.EVENT_TYPE_UNKNOWN, name: String, description: String?, url: String?, location: GALocation?)
val description: String?
val location: GALocation?
val name: String
val type: TicketEventType
val url: String?

enum class TicketEventType

EVENT_TYPE_UNKNOWN

enum class UserInfoProperty

EMAIL
USER_INFO_PROPERTY_UNSPECIFIED

package ai.tock.bot.connector.media

data class MediaAction : MediaMessage

MediaAction(title: CharSequence, url: String? = null)
val title: CharSequence
fun toGenericMessage(): GenericMessage?
var url: String?

data class MediaActionDescriptor : MediaMessageDescriptor

MediaActionDescriptor(title: I18nLabelValue, url: String? = null)
val title: I18nLabelValue
fun toMessage(bus: BotBus): MediaAction
val type: MediaMessageType
var url: String?

data class MediaCard : MediaMessage

MediaCard(title: CharSequence?, subTitle: CharSequence?, file: MediaFile?, actions: List<MediaAction> = emptyList())
val actions: List<MediaAction>
fun checkValidity(): Boolean
val file: MediaFile?
val subTitle: CharSequence?
val title: CharSequence?
fun toGenericMessage(): GenericMessage?

data class MediaCardDescriptor : MediaMessageDescriptor

MediaCardDescriptor(title: I18nLabelValue?, subTitle: I18nLabelValue?, file: MediaFileDescriptor?, actions: List<MediaActionDescriptor> = emptyList(), fillCarousel: Boolean = false)
val actions: List<MediaActionDescriptor>
fun checkValidity(): Boolean
val file: MediaFileDescriptor?
val fillCarousel: Boolean
val subTitle: I18nLabelValue?
val title: I18nLabelValue?
fun toMessage(bus: BotBus): MediaCard
val type: MediaMessageType

data class MediaCarousel : MediaMessage

MediaCarousel(cards: List<MediaCard>)
val cards: List<MediaCard>
fun checkValidity(): Boolean
fun toGenericMessage(): GenericMessage?

data class MediaCarouselDescriptor : MediaMessageDescriptor

MediaCarouselDescriptor(cards: List<MediaCardDescriptor>)
val cards: List<MediaCardDescriptor>
fun checkValidity(): Boolean
fun toMessage(bus: BotBus): MediaCarousel
val type: MediaMessageType

data class MediaFile

MediaFile(url: String, name: String, type: AttachmentType = UploadedFilesService.attachmentType(url))
val name: String
val type: AttachmentType
val url: String

data class MediaFileDescriptor

MediaFileDescriptor(suffix: String, name: String, id: String = Dice.newId(), type: AttachmentType = UploadedFilesService.attachmentType(suffix), externalUrl: String? = null)
val externalUrl: String?
val id: String
val name: String
val suffix: String
fun toMessage(bus: BotBus): MediaFile
val type: AttachmentType

interface MediaMessage

open fun checkValidity(): Boolean
open fun toGenericMessage(): GenericMessage?

interface MediaMessageDescriptor

open fun checkValidity(): Boolean
abstract fun toMessage(bus: BotBus): MediaMessage
abstract val type: MediaMessageType

enum class MediaMessageType

action
card
carousel

package ai.tock.bot.connector.messenger

fun <T : Bus<T>> T.attachment(attachmentUrl: String, type: AttachmentType, vararg quickReplies: QuickReply): AttachmentMessage
fun <T : Bus<T>> T.attachment(attachmentUrl: String, type: AttachmentType, quickReplies: List<QuickReply>): AttachmentMessage
fun <T : Bus<T>> T.audio(audioUrl: String, vararg quickReplies: QuickReply): AttachmentMessage
fun <T : Bus<T>> T.audio(audioUrl: String, quickReplies: List<QuickReply>): AttachmentMessage
fun I18nTranslator.buttonsTemplate(text: CharSequence, vararg actions: UserAction): AttachmentMessage
fun I18nTranslator.buttonsTemplate(text: CharSequence, actions: List<UserAction>): AttachmentMessage
fun I18nTranslator.callToButton(title: CharSequence, phoneNumber: String): CallButton
fun emailQuickReply(): QuickReply
fun <T : Bus<T>> T.endForMessenger(delay: Long = defaultDelay(currentAnswerIndex), messageProvider: T.() -> MessengerConnectorMessage): T
fun I18nTranslator.genericElement(title: CharSequence, subtitle: CharSequence? = null, imageUrl: String? = null, buttons: List<Button>? = null): Element
fun genericTemplate(vararg elements: Element): AttachmentMessage
fun genericTemplate(elements: List<Element>, quickReplies: List<QuickReply>): AttachmentMessage
fun genericTemplate(elements: List<Element>, vararg quickReplies: QuickReply): AttachmentMessage
fun <T : Bus<T>> T.image(imageUrl: String, vararg quickReplies: QuickReply): AttachmentMessage
fun <T : Bus<T>> T.image(imageUrl: String, quickReplies: List<QuickReply>): AttachmentMessage
fun loginButton(url: String): LoginButton
fun logoutButton(): LogoutButton
fun mediaTemplate(mediaUrl: String, mediaType: MediaType = MediaType.image, sharable: Boolean = false, vararg actions: UserAction): AttachmentMessage
fun mediaTemplate(mediaUrl: String, mediaType: MediaType = MediaType.image, sharable: Boolean = false, actions: List<UserAction> = emptyList()): AttachmentMessage
class MessengerConnector : ConnectorBase

fun addSuggestions(text: CharSequence, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
fun addSuggestions(message: ConnectorMessage, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
fun getConnectorById(connectorId: String): MessengerConnector?
fun getSecondaryReceivers(): List<SecondaryReceiverData>?
fun getThreadOwner(userId: PlayerId): String?
fun healthcheck(): Boolean
fun loadProfile(callback: ConnectorCallback, userId: PlayerId): UserPreferences
fun notify(controller: ConnectorController, recipientId: PlayerId, intent: IntentAware, step: StoryStep<out StoryHandlerDefinition>?, parameters: Map<String, String>, notificationType: ActionNotificationType?, errorListener: (Throwable) -> Unit): Unit
fun passThreadControl(userId: PlayerId, targetAppId: String, metadata: String? = null): SendResponse?
fun refreshProfile(callback: ConnectorCallback, userId: PlayerId): UserPreferences?
fun register(controller: ConnectorController): Unit
fun requestThreadControl(userId: PlayerId, metadata: String? = null): SendResponse?
fun send(event: Event, callback: ConnectorCallback, delayInMs: Long): Unit
fun sendCustomEvent(customEventRequest: CustomEventRequest): Unit
fun sendEvent(event: Event, transformMessageRequest: (MessageRequest) -> MessageRequest = { it }, postMessage: (String) -> Unit = {}, transformActionRequest: (ActionRequest) -> ActionRequest = { it }, errorListener: (Throwable) -> Unit = {}): SendResponse?
fun sendOptInEvent(event: Event): Unit
fun takeThreadControl(userId: PlayerId, metadata: String? = null): SendResponse?
fun toConnectorMessage(message: MediaMessage): BotBus.() -> List<ConnectorMessage>
fun unregister(controller: ConnectorController): Unit

val messengerConnectorType: ConnectorType
@ConnectorHandler("messenger") @Target([AnnotationTarget.CLASS]) annotation class MessengerHandler

MessengerHandler(value: KClass<out ConnectorStoryHandler<*>>)
val value: KClass<out ConnectorStoryHandler<*>>

fun I18nTranslator.nlpPostbackButton(title: CharSequence, textToSend: CharSequence = title): PostbackButton
fun I18nTranslator.nlpQuickReply(title: CharSequence, textToSend: CharSequence = title, imageUrl: String? = null): QuickReply
fun <T : Bus<T>> T.postbackButton(title: CharSequence, targetIntent: IntentAware, vararg parameters: Pair<String, String>): PostbackButton
fun <T : Bus<T>> T.postbackButton(title: CharSequence, targetIntent: IntentAware, parameters: Parameters): PostbackButton
fun <T : Bus<T>> T.postbackButton(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters): PostbackButton
fun <T : Bus<T>> T.postbackButton(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, vararg parameters: Pair<String, String>): PostbackButton
fun <T : Bus<T>> T.quickReply(title: CharSequence, targetIntent: IntentAware, parameters: Parameters): QuickReply
fun <T : Bus<T>> T.quickReply(title: CharSequence, targetIntent: IntentAware, imageUrl: String? = null, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters): QuickReply
fun <T : Bus<T>> T.quickReply(title: CharSequence, targetIntent: IntentAware, imageUrl: String? = null, step: StoryStep<out StoryHandlerDefinition>? = null, vararg parameters: Pair<String, String>): QuickReply
fun <T : Bus<T>> T.quickReply(title: CharSequence, targetIntent: IntentAware, imageUrl: String? = null, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Collection<Pair<String, String>>): QuickReply
fun <T : Bus<T>> T.quickReply(title: CharSequence, targetIntent: IntentAware, imageUrl: String? = null, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Map<String, String>): QuickReply
fun <T : Bus<T>> T.sendToMessenger(delay: Long = defaultDelay(currentAnswerIndex), messageProvider: T.() -> MessengerConnectorMessage): T
fun standaloneMessengerAnswer(playerId: PlayerId, applicationId: String, recipientId: PlayerId, lastAnswer: Boolean = true, priority: ActionPriority = ActionPriority.normal, notificationType: ActionNotificationType? = null, messageProvider: () -> MessengerConnectorMessage): SendSentence
fun standaloneMessengerAnswers(playerId: PlayerId, applicationId: String, recipientId: PlayerId, priority: ActionPriority = ActionPriority.normal, notificationType: ActionNotificationType? = null, messagesProvider: () -> List<MessengerConnectorMessage>): List<SendSentence>
fun I18nTranslator.standaloneQuickReply(title: CharSequence, targetIntent: IntentAware, parameters: Parameters = Parameters(), step: StoryStep<out StoryHandlerDefinition>? = null, imageUrl: String? = null, busStep: StoryStep<out StoryHandlerDefinition>? = null, currentIntent: Intent? = null, sourceAppId: String?): QuickReply
fun I18nTranslator.text(text: CharSequence, vararg quickReplies: QuickReply): TextMessage
fun I18nTranslator.text(text: CharSequence, quickReplies: List<QuickReply>): TextMessage
fun I18nTranslator.urlButton(title: CharSequence, url: String): UrlButton
fun <T : Bus<T>> T.video(videoUrl: String, vararg quickReplies: QuickReply): AttachmentMessage
fun <T : Bus<T>> T.video(videoUrl: String, quickReplies: List<QuickReply>): AttachmentMessage
fun <T : Bus<T>> T.withMessenger(messageProvider: () -> MessengerConnectorMessage): T
fun <T : Bus<T>> T.withMessenger(connectorId: String, messageProvider: () -> MessengerConnectorMessage): T

package ai.tock.bot.connector.messenger.model

abstract class MessengerConnectorMessage : ConnectorMessage

MessengerConnectorMessage()
open val connectorType: ConnectorType
open fun findElements(): List<Element>

data class Recipient

Recipient(id: String?, userRef: String? = null)
val id: String?
val userRef: String?

data class Sender

Sender(id: String)
val id: String

data class UserProfile

UserProfile(firstName: String?, lastName: String?, profilePic: String?, locale: String?, timezone: Int, gender: String?)
val firstName: String?
val gender: String?
val lastName: String?
val locale: String?
val profilePic: String?
val timezone: Int

package ai.tock.bot.connector.messenger.model.attachment

data class AttachmentRequest

AttachmentRequest(message: AttachmentMessage, personaId: String? = null)
val message: AttachmentMessage
val personaId: String?

package ai.tock.bot.connector.messenger.model.handover

data class AppRolesWebhook : Webhook

AppRolesWebhook(recipient: Recipient, timestamp: Long, appRoles: Map<String, List<String>>)
val appRoles: Map<String, List<String>>
val recipient: Recipient
val sender: Sender?
val timestamp: Long

data class PassThreadControl

PassThreadControl(newOwnerAppId: String, metadata: String? = null)
val metadata: String?
val newOwnerAppId: String

data class PassThreadControlRequest

PassThreadControlRequest(recipient: Recipient, targetAppId: String? = null, metadata: String? = null)
val metadata: String?
val recipient: Recipient
val targetAppId: String?

data class PassThreadControlWebhook : Webhook

PassThreadControlWebhook(sender: Sender, recipient: Recipient, timestamp: Long, passThreadControl: PassThreadControl)
val passThreadControl: PassThreadControl
val recipient: Recipient
val sender: Sender
val timestamp: Long

data class RequestThreadControl

RequestThreadControl(requestOwnerAppId: String, metadata: String? = null)
val metadata: String?
val requestOwnerAppId: String

data class RequestThreadControlRequest

RequestThreadControlRequest(recipient: Recipient, metadata: String? = null)
val metadata: String?
val recipient: Recipient

data class RequestThreadControlWebhook : Webhook

RequestThreadControlWebhook(sender: Sender, recipient: Recipient, timestamp: Long, requestThreadControl: RequestThreadControl)
val recipient: Recipient
val requestThreadControl: RequestThreadControl
val sender: Sender
val timestamp: Long

data class SecondaryReceiverData

SecondaryReceiverData(id: String, name: String)
val id: String
val name: String

data class SecondaryReceiverResponse

SecondaryReceiverResponse(data: List<SecondaryReceiverData>)
val data: List<SecondaryReceiverData>

data class TakeThreadControl

TakeThreadControl(previousOwnerAppId: String, metadata: String? = null)
val metadata: String?
val previousOwnerAppId: String

data class TakeThreadControlRequest

TakeThreadControlRequest(recipient: Recipient, metadata: String? = null)
val metadata: String?
val recipient: Recipient

data class TakeThreadControlWebhook : Webhook

TakeThreadControlWebhook(sender: Sender, recipient: Recipient, timestamp: Long, takeThreadControl: TakeThreadControl)
val recipient: Recipient
val sender: Sender
val takeThreadControl: TakeThreadControl
val timestamp: Long

data class ThreadControlRequest

ThreadControlRequest(metadata: String, recipient: Recipient?, targetAppId: String)
val metadata: String
val recipient: Recipient?
val targetAppId: String

data class ThreadOwner

ThreadOwner(appId: String)
val appId: String

data class ThreadOwnerData

ThreadOwnerData(threadOwner: ThreadOwner)
val threadOwner: ThreadOwner

data class ThreadOwnerResponse

ThreadOwnerResponse(data: List<ThreadOwnerData>)
val data: List<ThreadOwnerData>

package ai.tock.bot.connector.messenger.model.send

data class ActionRequest

ActionRequest(recipient: Recipient, sender_action: SenderAction = typing_on, personaId: String? = null)
val personaId: String?
val recipient: Recipient
val sender_action: SenderAction

data class Attachment

Attachment(type: AttachmentType, payload: Payload)
val payload: Payload
val type: AttachmentType

class AttachmentMessage : Message

AttachmentMessage(attachment: Attachment, quickReplies: List<QuickReply>? = null)
val attachment: Attachment
fun copy(quickReplies: List<QuickReply>?): Message
fun equals(other: Any?): Boolean
fun findElements(): List<Element>
fun hashCode(): Int
fun obfuscate(): ConnectorMessage
fun toGenericMessage(): GenericMessage?
fun toString(): String

enum class AttachmentType

audio
file
fun fromTockAttachmentType(type: AttachmentType): AttachmentType
image
template
fun toTockAttachmentType(): AttachmentType
video

abstract class Button : UserAction

Button(type: ButtonType)
abstract fun toChoice(): Choice
val type: ButtonType

data class ButtonPayload : ModelPayload

ButtonPayload(text: String, buttons: List<Button>)
val buttons: List<Button>
fun obfuscate(): Payload
val text: String
fun toGenericMessage(): GenericMessage?

enum class ButtonType

account_link
account_unlink
phone_number
postback
web_url

data class CallButton : Button

CallButton(title: String, payload: String)
val payload: String
val title: String
fun toChoice(): Choice

data class CustomEvent

CustomEvent(eventName: String)
val eventName: String

data class CustomEventRequest

CustomEventRequest(customEvent: CustomEvent, pageId: String, pageScopedUserId: String, event: String = "CUSTOM_APP_EVENTS", advertiserTrackingEnabled: Short = 0, applicationTrackingEnabled: Short = 1, extinfo: String = mapper.writeValueAsString(listOf("mb1")))
CustomEventRequest(customEvents: List<CustomEvent>, pageId: String, pageScopedUserId: String, event: String = "CUSTOM_APP_EVENTS", advertiserTrackingEnabled: Short = 0, applicationTrackingEnabled: Short = 1, extinfo: String = mapper.writeValueAsString(listOf("mb1")))
val advertiserTrackingEnabled: Short
val applicationTrackingEnabled: Short
val customEvents: List<CustomEvent>
val event: String
val extinfo: String
val pageId: String
val pageScopedUserId: String

data class Element

Element(title: String, imageUrl: String? = null, subtitle: String? = null, buttons: List<Button>? = null)
val buttons: List<Button>?
val imageUrl: String?
fun obfuscate(): Element
val subtitle: String?
val title: String
fun toGenericElement(): GenericElement

class EmailQuickReply : QuickReply

EmailQuickReply()
fun equals(other: Any?): Boolean
fun hashCode(): Int

data class GenericPayload : ModelPayload

GenericPayload(elements: List<Element>)
val elements: List<Element>
fun obfuscate(): Payload
fun toGenericMessage(): GenericMessage?

enum class ListElementStyle

compact
large

data class ListPayload : ModelPayload

ListPayload(elements: List<Element>, topElementStyle: ListElementStyle?, buttons: List<Button>?)
val buttons: List<Button>?
val elements: List<Element>
fun obfuscate(): Payload
fun toGenericMessage(): GenericMessage?
val topElementStyle: ListElementStyle?

class LocationQuickReply : QuickReply

LocationQuickReply()
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun toLocation(): Location

data class LoginButton : Button

LoginButton(url: String)
fun toChoice(): Choice
val url: String

class LogoutButton : Button

LogoutButton()
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun toChoice(): Choice

data class MediaElement

MediaElement(mediaType: MediaType, attachmentId: String, buttons: List<Button>? = null)
val attachmentId: String
val buttons: List<Button>?
val mediaType: MediaType
fun toGenericElement(): GenericElement

data class MediaPayload : ModelPayload

MediaPayload(elements: List<MediaElement>, sharable: Boolean = false)
val elements: List<MediaElement>
val sharable: Boolean
fun toGenericMessage(): GenericMessage?

enum class MediaType

image
fun toAttachmentType(): AttachmentType
video

abstract class Message : MessengerConnectorMessage

Message(quickReplies: List<QuickReply>? = null)
abstract fun copy(quickReplies: List<QuickReply>? = null): Message
val quickReplies: List<QuickReply>?

data class MessageRequest

MessageRequest(recipient: Recipient, message: Message, messagingType: MessagingType = RESPONSE, notificationType: NotificationType = NO_PUSH, tag: MessageTag? = null, personaId: String? = null)
val message: Message
val messagingType: MessagingType
val notificationType: NotificationType
val personaId: String?
val recipient: Recipient
val tag: MessageTag?

enum class MessageTag

ACCOUNT_UPDATE
CONFIRMED_EVENT_UPDATE
HUMAN_AGENT
POST_PURCHASE_UPDATE
fun toMessageTag(action: Action): MessageTag?

enum class MessagingType

MESSAGE_TAG
RESPONSE
UPDATE

abstract class ModelPayload : Payload

ModelPayload(templateType: PayloadType)
val templateType: PayloadType

enum class NotificationType

NO_PUSH
REGULAR
SILENT_PUSH
fun toNotificationType(action: Action): NotificationType

abstract class Payload

Payload()
open fun obfuscate(): Payload
open fun toGenericMessage(): GenericMessage?

enum class PayloadType

button
generic
list
media

data class PostbackButton : Button

PostbackButton(payload: String?, title: String)
val payload: String?
val title: String
fun toChoice(): Choice

abstract class QuickReply : UserAction

QuickReply(contentType: QuickReplyContentType)
val contentType: QuickReplyContentType
open fun toChoice(): Choice?
open fun toLocation(): Location?

enum class QuickReplyContentType

location
text
user_email

enum class ReferralIdentifierType

OPEN_THREAD

enum class SenderAction

mark_seen
typing_off
typing_on

data class SendResponse

SendResponse(recipientId: String?, messageId: String?, attachmentId: String?)
val attachmentId: String?
val messageId: String?
val recipientId: String?

data class SendResponseError

SendResponseError(message: String?, type: String?, code: Int?, errorSubcode: Int?, traceId: String?)
val code: Int?
val errorSubcode: Int?
val message: String?
val traceId: String?
val type: String?

data class SendResponseErrorContainer

SendResponseErrorContainer(error: SendResponseError?)
val error: SendResponseError?

enum class SourceType

ADS
SHORTLINK

class TextMessage : Message

TextMessage(text: String, quickReplies: List<QuickReply>? = null)
fun copy(quickReplies: List<QuickReply>?): Message
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun obfuscate(): ConnectorMessage
val text: String
fun toGenericMessage(): GenericMessage?
fun toString(): String

data class TextQuickReply : QuickReply

TextQuickReply(title: String, payload: String, imageUrl: String? = null)
val imageUrl: String?
val payload: String
val title: String
fun toChoice(): Choice?

data class UrlButton : Button

UrlButton(url: String, title: String, webviewHeightRatio: String? = null, messengerExtensions: String? = null, fallBackUrl: String? = null)
val fallBackUrl: String?
val messengerExtensions: String?
val title: String
fun toChoice(): Choice
val url: String
val webviewHeightRatio: String?

data class UrlPayload : Payload

UrlPayload(url: String?, attachmentId: String?, reusable: Boolean?)
val attachmentId: String?
fun getUrlPayload(attachment: SendAttachment): UrlPayload
fun getUrlPayload(applicationId: String, url: String, useCache: Boolean): UrlPayload
val reusable: Boolean?
val url: String?

interface UserAction

fun extractButtons(userActions: List<UserAction>): List<Button>
fun extractQuickReplies(userActions: List<UserAction>): List<QuickReply>?

package ai.tock.bot.connector.messenger.model.webhook

data class AccountLinking

AccountLinking(status: AccountLinkingStatus, authorizationCode: String? = null)
val authorizationCode: String?
val status: AccountLinkingStatus

enum class AccountLinkingStatus

linked
unlinked

class AccountLinkingWebhook : Webhook

AccountLinkingWebhook(sender: Sender, recipient: Recipient, timestamp: Long, accountLinking: AccountLinking)
val accountLinking: AccountLinking
val recipient: Recipient
val sender: Sender
val timestamp: Long

data class Attachment

Attachment(type: AttachmentType, payload: Payload)
val payload: Payload
val type: AttachmentType

enum class AttachmentType

audio
fallback
file
image
location
template
video

data class CallbackRequest

CallbackRequest(objectType: String, entry: List<Entry>)
val entry: List<Entry>
val objectType: String

data class Entry

Entry(id: String, time: Number, messaging: List<Webhook?>? = null, standby: List<Webhook?>? = null)
val id: String
val messaging: List<Webhook?>?
val standby: List<Webhook?>?
val time: Number

data class FacebookLocation

FacebookLocation(userLocation: UserLocation)
FacebookLocation(lat: Double, long: Double)
val lat: Double
val long: Double
fun toUserLocation(): UserLocation

data class LocationPayload : Payload

LocationPayload(coordinates: FacebookLocation)
val coordinates: FacebookLocation

open class Message

Message(mid: String, text: String? = null, attachments: List<Attachment> = emptyList(), quickReply: UserActionPayload? = null)
open val attachments: List<Attachment>
open fun equals(other: Any?): Boolean
open fun hashCode(): Int
open val mid: String
open val quickReply: UserActionPayload?
open var text: String?

data class MessageEcho : Message

MessageEcho(mid: String, text: String? = null, attachments: List<Attachment> = emptyList(), echo: Boolean = true, appId: Long, metadata: String? = null)
val appId: Long
val attachments: List<Attachment>
val echo: Boolean
val metadata: String?
val mid: String
var text: String?

data class MessageEchoWebhook : Webhook

MessageEchoWebhook(sender: Sender, recipient: Recipient, timestamp: Long, message: MessageEcho)
val message: MessageEcho
val recipient: Recipient
val sender: Sender
val timestamp: Long

data class MessageWebhook : Webhook

MessageWebhook(sender: Sender, recipient: Recipient, timestamp: Long, message: Message, priorMessage: PriorMessage? = null)
fun getMessageId(): String
val message: Message
val priorMessage: PriorMessage?
val recipient: Recipient
val sender: Sender
val timestamp: Long

data class Optin

Optin(userRef: String? = null, ref: String? = null)
val ref: String?
val userRef: String?

data class OptinWebhook : Webhook

OptinWebhook(sender: Sender?, recipient: Recipient, timestamp: Long, optin: Optin)
val optin: Optin
fun playerId(playerType: PlayerType): PlayerId
val recipient: Recipient
val sender: Sender?
val timestamp: Long

abstract class Payload

Payload()

data class PostbackWebhook : Webhook

PostbackWebhook(sender: Sender, recipient: Recipient, timestamp: Long, postback: UserActionPayload, priorMessage: PriorMessage? = null)
val postback: UserActionPayload
val priorMessage: PriorMessage?
val recipient: Recipient
val sender: Sender
val timestamp: Long

data class PriorMessage

PriorMessage(source: String, identifier: String)
val identifier: String
val source: String

data class Referral

Referral(ref: String = "", source: SourceType = SHORTLINK, type: ReferralIdentifierType = ReferralIdentifierType.OPEN_THREAD)
val ref: String
val source: SourceType
val type: ReferralIdentifierType

data class UrlPayload : Payload

UrlPayload(url: String)
val url: String

data class UserActionPayload

UserActionPayload(payload: String?, referral: Referral? = null)
fun hasEmailPayloadFromMessenger(): Boolean
val payload: String?
val referral: Referral?

abstract class Webhook : MessengerConnectorMessage

Webhook()
open fun playerId(playerType: PlayerType): PlayerId
open val priorMessage: PriorMessage?
abstract val recipient: Recipient
open fun recipientId(playerType: PlayerType): PlayerId
abstract val sender: Sender?
abstract val timestamp: Long
open fun toGenericMessage(): GenericMessage?

package ai.tock.bot.connector.rocketchat

val rocketChatConnectorType: ConnectorType

package ai.tock.bot.connector.slack

fun I18nTranslator.attachmentField(title: String, value: String, short: Boolean = true): AttachmentField
fun emoji(emoji: SlackEmoji): String
fun emojiMessage(emoji: SlackEmoji): SlackMessageOut
fun <T : Bus<T>> T.endForSlack(delay: Long = defaultDelay(currentAnswerIndex), messageProvider: T.() -> SlackConnectorMessage): T
fun I18nTranslator.multiLineMessage(lines: List<CharSequence>, channel: String? = null): SlackMessageOut
fun <T : Bus<T>> T.sendToSlack(delay: Long = defaultDelay(currentAnswerIndex), messageProvider: T.() -> SlackConnectorMessage): T
fun I18nTranslator.slackAttachment(text: CharSequence? = null, vararg buttons: Button): SlackMessageAttachment
fun I18nTranslator.slackAttachment(vararg buttons: Button): SlackMessageAttachment
fun I18nTranslator.slackAttachment(text: CharSequence? = null, buttons: List<Button> = emptyList(), color: String = "good", pretext: String? = null, fallback: String = translate(text).toString(), vararg fields: AttachmentField): SlackMessageAttachment
fun <T : Bus<T>> T.slackButton(title: CharSequence, targetIntent: IntentAware? = null, parameters: Parameters = Parameters(), name: String = "default"): Button
fun <T : Bus<T>> T.slackButton(title: CharSequence, targetIntent: IntentAware?, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters = Parameters(), name: String = "default"): Button
fun <T : Bus<T>> T.slackButton(title: CharSequence, targetIntent: IntentAware?, step: StoryStep<out StoryHandlerDefinition>? = null, vararg parameters: Pair<String, String>, name: String = "default"): Button
object SlackClient

fun sendMessage(outToken1: String, outToken2: String, outToken3: String, message: SlackConnectorMessage): Unit
interface SlackApi

@POST("/services/{outToken1}/{outToken2}/{outToken3}") abstract fun sendMessage(@Path("outToken1") outToken1: String, @Path("outToken2") outToken2: String, @Path("outToken3") outToken3: String, @Body message: RequestBody): Call<Void>

class SlackConnector : ConnectorBase

SlackConnector(applicationId: String, path: String, outToken1: String, outToken2: String, outToken3: String, client: SlackClient)
fun addSuggestions(text: CharSequence, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
fun addSuggestions(message: ConnectorMessage, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
val applicationId: String
val client: SlackClient
val outToken1: String
val outToken2: String
val outToken3: String
val path: String
fun register(controller: ConnectorController): Unit
fun send(event: Event, callback: ConnectorCallback, delayInMs: Long): Unit
fun toConnectorMessage(message: MediaMessage): BotBus.() -> List<ConnectorMessage>

val slackConnectorType: ConnectorType
@ConnectorHandler("slack") @Target([AnnotationTarget.CLASS]) annotation class SlackHandler

SlackHandler(value: KClass<out ConnectorStoryHandler<*>>)
val value: KClass<out ConnectorStoryHandler<*>>

fun I18nTranslator.slackMessage(message: CharSequence, vararg attachments: SlackMessageAttachment): SlackMessageOut
fun I18nTranslator.slackMessage(message: CharSequence, channel: String? = null, vararg attachments: SlackMessageAttachment): SlackMessageOut
fun I18nTranslator.textMessage(message: CharSequence): SlackMessageOut
fun <T : Bus<T>> T.withSlack(messageProvider: () -> SlackConnectorMessage): T

package ai.tock.bot.connector.slack.model

data class AttachmentField

AttachmentField(title: String, value: String, short: Boolean = false)
val short: Boolean
val title: String
val value: String

data class Button

Button(name: String, text: String = "", value: String, type: String = "button")
val name: String
val text: String
fun toChoice(): Choice
val type: String
val value: String

data class CallbackEvent : EventApiMessage

CallbackEvent(token: String, teamId: String, apiAppId: String, event: MessageEvent)
val apiAppId: String
val event: MessageEvent
val teamId: String
val token: String

abstract class EventApiMessage : SlackConnectorMessage

EventApiMessage()

data class InteractiveMessageEvent : EventApiMessage

InteractiveMessageEvent(user: SlackUser, actions: List<Button> = emptyList())
val actions: List<Button>
val user: SlackUser

data class MessageEvent

MessageEvent(channel: String, user: String?, text: String, ts: String)
val channel: String
val text: String
val ts: String
val user: String?

abstract class SlackConnectorMessage : ConnectorMessage

SlackConnectorMessage()
open val connectorType: ConnectorType

enum class SlackEmoji

CRY
val format: String
GRINNING
HEART
SLIGHT_SMILE
SMILE
THUMBS_UP

data class SlackMessageAttachment

SlackMessageAttachment(actions: List<Button>, fields: List<AttachmentField>, fallback: String, color: String, text: String? = null, pretext: String? = null, callbackId: String = "default")
val actions: List<Button>
val callbackId: String
val color: String
val fallback: String
val fields: List<AttachmentField>
fun hasOnlyActions(): Boolean
val pretext: String?
val text: String?
fun toGenericElement(): GenericElement

data class SlackMessageOut : SlackConnectorMessage

SlackMessageOut(text: String, channel: String? = null, attachments: List<SlackMessageAttachment> = emptyList())
val attachments: List<SlackMessageAttachment>
val channel: String?
val text: String
fun toGenericMessage(): GenericMessage?

data class SlackUser

SlackUser(id: String, name: String)
val id: String
val name: String

data class UrlVerificationEvent : EventApiMessage

UrlVerificationEvent(token: String, challenge: String)
val challenge: String
val token: String

package ai.tock.bot.connector.slack.model.old

data class SlackMessageIn : SlackConnectorMessage

SlackMessageIn(token: String, team_id: String, team_domain: String, channel_id: String, channel_name: String, timestamp: Number, user_id: String, user_name: String, text: String, trigger_word: String?)
val channel_id: String
val channel_name: String
fun getRealMessage(): String
val team_domain: String
val team_id: String
var text: String
val timestamp: Number
fun toGenericMessage(): GenericMessage
val token: String
val trigger_word: String?
val user_id: String
val user_name: String

package ai.tock.bot.connector.teams

class NoMessageException : Exception

NoMessageException(exception: String)

class TeamsConnectorCallback : ConnectorCallbackBase

TeamsConnectorCallback(applicationId: String, activity: Activity)
val activity: Activity

val teamsConnectorType: ConnectorType
@ConnectorHandler("teams") @Target([AnnotationTarget.CLASS]) annotation class TeamsHandler

TeamsHandler(value: KClass<out ConnectorStoryHandler<*>>)
val value: KClass<out ConnectorStoryHandler<*>>

package ai.tock.bot.connector.teams.auth

class JWKHandler

JWKHandler()
var cacheKeys: MicrosoftValidSigningKeys?
fun getJWK(): MicrosoftValidSigningKeys?
fun launchJWKCollector(connectorId: String, msInterval: Long = 23 * 60 * 60 * 1000L): Unit
fun stopJWKCollector(): Unit

data class MicrosoftOpenidMetadata

MicrosoftOpenidMetadata(issuer: String, authorizationEndpoint: String, jwksUri: String, idTokenSigningAlgValuesSupported: ArrayList<String>, tokenEndpointAuthMethodsSupported: List<String>)
val authorizationEndpoint: String
val idTokenSigningAlgValuesSupported: ArrayList<String>
val issuer: String
val jwksUri: String
val tokenEndpointAuthMethodsSupported: List<String>

data class MicrosoftValidSigningKey : Serializable

MicrosoftValidSigningKey(kty: String, use: String, kid: String, x5t: String?, n: String, e: String, x5c: List<String>?, endorsements: List<String>?)
val e: String
val endorsements: List<String>?
val kid: String
val kty: String
val n: String
fun toString(): String
val use: String
val x5c: List<String>?
val x5t: String?

data class MicrosoftValidSigningKeys : Serializable

MicrosoftValidSigningKeys(keys: List<MicrosoftValidSigningKey>)
val keys: List<MicrosoftValidSigningKey>

package ai.tock.bot.connector.teams.messages

fun cardImage(url: String): CardImage
com.microsoft.bot.schema.models.CardAction

fun CardAction.equalsTo(other: CardAction?): Boolean

fun <T : Bus<T>> T.nlpCardAction(title: CharSequence): CardAction
abstract class TeamsBotMessage : ConnectorMessage

TeamsBotMessage(text: String?)
open val connectorType: ConnectorType
open fun equals(other: Any?): Boolean
open fun hashCode(): Int
val text: String?

class TeamsBotTextMessage : TeamsBotMessage

TeamsBotTextMessage(text: String)
fun equals(other: Any?): Boolean
fun toGenericMessage(): GenericMessage
fun toString(): String

class TeamsCardAction : TeamsBotMessage

TeamsCardAction(actionTitle: String, buttons: List<CardAction>)
val actionTitle: String
val buttons: List<CardAction>
fun equals(other: Any?): Boolean
fun hashCode(): Int
fun toGenericMessage(): GenericMessage?
fun toString(): String

class TeamsCarousel : TeamsBotMessage

TeamsCarousel(listMessage: List<TeamsBotMessage>)
val listMessage: List<TeamsBotMessage>
fun toGenericMessage(): GenericMessage?

fun I18nTranslator.teamsCarousel(carouselContent: List<TeamsBotMessage>): TeamsCarousel
class TeamsHeroCard : TeamsBotMessage

TeamsHeroCard(title: String?, subtitle: String?, attachmentContent: String, images: List<CardImage>?, buttons: List<CardAction>?, tap: CardAction?)
val attachmentContent: String
val buttons: List<CardAction>?
fun equals(other: Any?): Boolean
val images: List<CardImage>?
val subtitle: String?
val tap: CardAction?
val title: String?
fun toGenericMessage(): GenericMessage
fun toString(): String

fun I18nTranslator.teamsHeroCard(title: CharSequence? = null, subtitle: CharSequence? = null, attachmentContent: CharSequence, images: List<CardImage>? = null, buttons: List<CardAction>? = null, tap: CardAction? = null): TeamsHeroCard
fun I18nTranslator.teamsMessage(text: CharSequence): TeamsBotTextMessage
fun I18nTranslator.teamsMessageWithButtonCard(urlText: CharSequence, links: List<CardAction>): TeamsCardAction
fun <T : Bus<T>> T.urlCardAction(title: CharSequence, url: String): CardAction
fun <T : Bus<T>> T.withTeams(messageProvider: () -> TeamsBotMessage): T

package ai.tock.bot.connector.teams.token

interface LoginMicrosoftOnline

@Headers(["Host:login.microsoftonline.com", "Content-Type:application/x-www-form-urlencoded"]) @POST("/botframework.com/oauth2/v2.0/token") @FormUrlEncoded abstract fun login(@Field("grant_type") grantType: String = "client_credentials", @Field("client_id") clientId: String, @Field("client_secret") clientSecret: String, @Field("scope") scope: String = "https://api.botframework.com/.default"): Call<LoginResponse>

data class LoginResponse

LoginResponse(tokenType: String, expiresIn: Long, extExpiresIn: Long, accessToken: String)
val accessToken: String
val expiresIn: Long
val extExpiresIn: Long
val tokenType: String

class TokenHandler

TokenHandler(appId: String, password: String)
fun checkToken(): Unit
fun isTokenExpired(): Boolean
fun launchTokenCollector(connectorId: String, msInterval: Long = 60 * 60 * 1000L): Unit
var loginApi: LoginMicrosoftOnline
fun stopTokenCollector(): Unit
val teamsMapper: ObjectMapper
var token: String?

package ai.tock.bot.connector.twitter

fun <T : Bus<T>> T.directMessage(message: CharSequence): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithAttachment(message: CharSequence, mediaCategory: MediaCategory, contentType: String, bytes: ByteArray, vararg options: Option): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithAttachment(message: CharSequence, mediaCategory: MediaCategory, contentType: String, bytes: ByteArray, vararg options: OptionWithoutDescription): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithButtons(message: CharSequence, ctas: List<CTA>): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithButtons(message: CharSequence, vararg ctas: CTA): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithGIF(message: CharSequence, contentType: String, bytes: ByteArray, vararg options: Option): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithGIF(message: CharSequence, contentType: String, bytes: ByteArray, vararg options: OptionWithoutDescription): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithGIF(contentType: String, bytes: ByteArray, vararg options: Option): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithGIF(contentType: String, bytes: ByteArray, vararg options: OptionWithoutDescription): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithImage(message: CharSequence, contentType: String, bytes: ByteArray, vararg options: Option): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithImage(message: CharSequence, contentType: String, bytes: ByteArray, vararg options: OptionWithoutDescription): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithImage(contentType: String, bytes: ByteArray, vararg options: Option): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithImage(contentType: String, bytes: ByteArray, vararg options: OptionWithoutDescription): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithOptions(message: CharSequence, vararg options: Option): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithOptions(message: CharSequence, vararg options: OptionWithoutDescription): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithVideo(message: CharSequence, contentType: String, bytes: ByteArray, vararg options: Option): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithVideo(message: CharSequence, contentType: String, bytes: ByteArray, vararg options: OptionWithoutDescription): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithVideo(contentType: String, bytes: ByteArray, vararg options: Option): OutcomingEvent
fun <T : Bus<T>> T.directMessageWithVideo(contentType: String, bytes: ByteArray, vararg options: OptionWithoutDescription): OutcomingEvent
fun BotBus.endIfPublicTwitter(): Unit
const val MAX_METADATA: Int
const val MAX_OPTION_DESCRIPTION: Int
const val MAX_OPTION_LABEL: Int
fun I18nTranslator.nlpOption(label: CharSequence): OptionWithoutDescription
fun I18nTranslator.nlpOption(label: CharSequence, description: CharSequence): Option
fun <T : Bus<T>> T.option(label: CharSequence, description: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, vararg parameters: Pair<String, String>): Option
fun <T : Bus<T>> T.option(label: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, vararg parameters: Pair<String, String>): OptionWithoutDescription
fun <T : Bus<T>> T.option(label: CharSequence, description: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Map<String, String>): Option
fun <T : Bus<T>> T.option(label: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Map<String, String>): OptionWithoutDescription
fun BotBus.tweet(message: CharSequence): Tweet
fun BotBus.tweetWithInviteForDM(message: CharSequence, welcomeMessageID: String? = null, defaultMessage: String? = null): Tweet
class TwitterConnectorCallback : ConnectorCallbackBase

TwitterConnectorCallback(applicationId: String, visibility: ActionVisibility, threadId: Long?, reply: Boolean)
val applicationId: String
val reply: Boolean
val threadId: Long?
val visibility: ActionVisibility

val twitterConnectorType: ConnectorType
@ConnectorHandler("twitter") @Target([AnnotationTarget.CLASS]) annotation class TwitterHandler

TwitterHandler(value: KClass<out ConnectorStoryHandler<*>>)
val value: KClass<out ConnectorStoryHandler<*>>

fun <T : Bus<T>> T.webUrl(label: CharSequence, url: CharSequence): WebUrl
fun BotBus.withPublicTwitter(messageProvider: () -> TwitterPublicConnectorMessage): BotBus
fun BotBus.withTwitter(messageProvider: () -> TwitterConnectorMessage): BotBus
fun BotBus.withTwitter(connectorId: String, messageProvider: () -> TwitterConnectorMessage): BotBus

package ai.tock.bot.connector.twitter.model

abstract class AbstractOption

AbstractOption()
abstract fun toChoice(): Choice

data class Application

Application(id: String, name: String, url: String)
val id: String
val name: String
val url: String

data class Attachment

Attachment(type: String, media: AttachmentMedia)
val media: AttachmentMedia
val type: String

data class AttachmentData

AttachmentData(mediaCategory: MediaCategory, contentType: String, bytes: ByteArray)
val bytes: ByteArray
val contentType: String
val mediaCategory: MediaCategory

data class AttachmentMedia

AttachmentMedia(id: String)
val id: String

enum class Command

APPEND
val command: String
FINALIZE
INIT
STATUS

data class Coordinates

Coordinates(coordinates: List<Float>, type: String)
val coordinates: List<Float>
val type: String

abstract class CTA

CTA()
abstract fun toChoice(): Choice

data class DirectMessage

DirectMessage(id: String, created: Long, messageCreated: MessageCreate)
val created: Long
fun getMessageId(): String
val id: String
fun isQuote(): Boolean
val messageCreated: MessageCreate
fun playerId(playerType: PlayerType): PlayerId
fun recipientId(playerType: PlayerType): PlayerId
fun textWithoutUrls(): String

data class DirectMessageIndicateTyping

DirectMessageIndicateTyping(created: Long, senderId: String, target: Recipient)
val created: Long
val senderId: String
val target: Recipient

data class Entities

Entities(hashtags: List<Hashtag>? = null, mentions: List<Mention>? = null, urls: List<Url>? = null, symbols: List<Symbol>? = null, polls: List<Poll>? = null, media: List<MediaEntities>? = null)
val hashtags: List<Hashtag>?
val media: List<MediaEntities>?
val mentions: List<Mention>?
val polls: List<Poll>?
val symbols: List<Symbol>?
val urls: List<Url>?

abstract class Entity

Entity()
abstract val indices: List<Int>

data class Hashtag : Entity

Hashtag(text: String, indices: List<Int>)
val indices: List<Int>
val text: String

data class Image : Media

Image(imageType: String, width: Int, height: Int)
val height: Int
val imageType: String
val width: Int

abstract class Media

Media()

enum class MediaCategory

GIF
IMAGE
val mediaCategory: String
VIDEO

data class MediaEntities

MediaEntities(display_url: String, expanded_url: String, indices: List<Int>, media_url: String, media_url_https: String)
val display_url: String
val expanded_url: String
val indices: List<Int>
val media_url: String
val media_url_https: String

data class MediaUpload

MediaUpload(mediaId: Long, mediaIdString: String, size: Long?, expiresAfterSecs: Long, media: Media?)
val expiresAfterSecs: Long
val media: Media?
val mediaId: Long
val mediaIdString: String
val size: Long?

data class Mention : Entity

Mention(screenName: String, name: String, id: String, idStr: String, indices: List<Int>)
val id: String
val idStr: String
val indices: List<Int>
val name: String
val screenName: String

data class MessageCreate

MessageCreate(target: Recipient, senderId: String, sourceAppId: String? = null, messageData: MessageData)
val messageData: MessageData
val senderId: String
val sourceAppId: String?
val target: Recipient

data class MessageData

MessageData(text: String, entities: Entities? = null, ctas: List<CTA>? = null, attachment: Attachment? = null, quickReply: QuickReply? = null, quickReplyResponse: QuickReplyResponse? = null)
val attachment: Attachment?
val ctas: List<CTA>?
val entities: Entities?
val quickReply: QuickReply?
val quickReplyResponse: QuickReplyResponse?
val text: String
fun toGenericMessage(): GenericMessage

data class Option : AbstractOption

val description: String
val label: String
val metadata: String
fun of(label: String, description: String, metadata: String): Option
fun toChoice(): Choice

data class Options : QuickReply

Options(options: List<AbstractOption>)
val options: List<AbstractOption>
fun toChoices(): List<Choice>

data class OptionsResponse : QuickReplyResponse

OptionsResponse(metadata: String)
val metadata: String

data class OptionWithoutDescription : AbstractOption

val label: String
val metadata: String
fun of(label: String, metadata: String): OptionWithoutDescription
fun toChoice(): Choice

data class Poll

Poll(options: List<PollOption>, endDatetime: String, durationMinutes: Int)
val durationMinutes: Int
val endDatetime: String
val options: List<PollOption>

data class PollOption

PollOption(position: Int, text: String)
val position: Int
val text: String

abstract class QuickReply

QuickReply()
abstract fun toChoices(): List<Choice>

abstract class QuickReplyResponse

QuickReplyResponse()

data class Recipient

Recipient(recipientId: String)
val recipientId: String

data class Symbol : Entity

Symbol(indices: List<Int>, text: String)
val indices: List<Int>
val text: String

data class Text

Text(text: String, range: List<Int>)
val range: List<Int>
val text: String

fun MediaFile.toMediaCategory(): MediaCategory?
data class Tweet

Tweet(created: String, id: Long, text: String, lang: String, truncated: Boolean, user: User, inReplyToStatusId: Long? = null, inReplyToUserId: Long? = null, contributors: String? = null, isQuote: Boolean, coordinates: Coordinates? = null, entities: Entities, extendedEntities: Entities? = null, extendedTweet: Text? = null)
val contributors: String?
val coordinates: Coordinates?
val created: String
val entities: Entities
val extendedEntities: Entities?
val extendedTweet: Text?
val id: Long
val inReplyToStatusId: Long?
val inReplyToUserId: Long?
val isQuote: Boolean
val lang: String
fun playerId(playerType: PlayerType): PlayerId
val text: String
val truncated: Boolean
val user: User

abstract class TwitterConnectorMessage : ConnectorMessage

TwitterConnectorMessage()
open val connectorType: ConnectorType

abstract class TwitterPublicConnectorMessage : ConnectorMessage

TwitterPublicConnectorMessage()
open val connectorType: ConnectorType

data class Url : Entity

Url(url: String, expandedUrl: String, displayUrl: String, indices: List<Int>)
val displayUrl: String
val expandedUrl: String
val indices: List<Int>
val url: String

data class User

User(id: String, lang: String?, location: String?, createdTimestamp: Long? = null, created: String? = null, url: String? = null, description: String? = null, name: String, screenName: String, protected: Boolean, verified: Boolean, followersCount: Int, friendsCount: Int, statusesCount: Int, profileImageUrlHttps: String? = null, utcOffset: String? = null)
val created: String?
val createdTimestamp: Long?
val description: String?
val followersCount: Int
val friendsCount: Int
val id: String
val lang: String?
val location: String?
val name: String
val profileImageUrlHttps: String?
val protected: Boolean
val screenName: String
val statusesCount: Int
val url: String?
val utcOffset: String?
val verified: Boolean

data class Video : Media

Video(videoType: String)
val videoType: String

data class WebUrl : CTA

WebUrl(label: String, url: String, tcoUrl: String? = null)
val label: String
val tcoUrl: String?
fun toChoice(): Choice
val url: String

package ai.tock.bot.connector.twitter.model.incoming

data class DirectMessageIncomingEvent : IncomingEvent

DirectMessageIncomingEvent(forUserId: String, users: Map<String, User>, apps: Map<String, Application>?, directMessages: List<DirectMessage>)
val apps: Map<String, Application>?
val directMessages: List<DirectMessage>
val forUserId: String
val ignored: Boolean
fun playerId(playerType: PlayerType): PlayerId
fun recipientId(playerType: PlayerType): PlayerId
fun toEvent(applicationId: String): Event?
val users: Map<String, User>

data class DirectMessageIndicateTypingIncomingEvent : IncomingEvent

DirectMessageIndicateTypingIncomingEvent(forUserId: String, users: Map<String, User>, directMessagesIndicateTyping: List<DirectMessageIndicateTyping>)
val directMessagesIndicateTyping: List<DirectMessageIndicateTyping>
val forUserId: String
val ignored: Boolean
fun toEvent(applicationId: String): Event?
val users: Map<String, User>

abstract class IncomingEvent : TwitterConnectorMessage

IncomingEvent()
abstract val forUserId: String
abstract val ignored: Boolean
open fun playerId(playerType: PlayerType): PlayerId
open fun recipientId(playerType: PlayerType): PlayerId
abstract fun toEvent(applicationId: String): Event?
abstract val users: Map<String, User>

data class TweetIncomingEvent : IncomingEvent

TweetIncomingEvent(forUserId: String, tweets: List<Tweet>)
val forUserId: String
val ignored: Boolean
fun playerId(playerType: PlayerType): PlayerId
fun toEvent(applicationId: String): Event?
val tweets: List<Tweet>
val users: Map<String, User>

package ai.tock.bot.connector.twitter.model.outcoming

abstract class AbstractOutcomingEvent

AbstractOutcomingEvent()
abstract fun playerId(playerType: PlayerType): PlayerId
abstract fun recipientId(playerType: PlayerType): PlayerId
abstract fun toGenericMessage(): GenericMessage

data class DirectMessageOutcomingEvent : AbstractOutcomingEvent

DirectMessageOutcomingEvent(messageCreate: MessageCreate)
class Builder

Builder(target: Recipient, senderId: String, text: String)
fun build(): DirectMessageOutcomingEvent
var options: List<Option>
var optionsWithoutDescription: List<OptionWithoutDescription>
val senderId: String
var sourceAppId: String?
val target: Recipient
val text: String
fun withOptions(vararg options: Option): Builder
fun withOptions(vararg optionsWithoutDescription: OptionWithoutDescription): Builder
fun withSourceAppId(sourceAppId: String): Builder

fun builder(target: Recipient, senderId: String, text: String): Builder
val messageCreate: MessageCreate
fun playerId(playerType: PlayerType): PlayerId
fun recipientId(playerType: PlayerType): PlayerId
fun toGenericMessage(): GenericMessage
fun toString(): String

data class OutcomingEvent : TwitterConnectorMessage

OutcomingEvent(event: AbstractOutcomingEvent, attachmentData: AttachmentData? = null)
val attachmentData: AttachmentData?
val event: AbstractOutcomingEvent
fun playerId(playerType: PlayerType): PlayerId
fun recipientId(playerType: PlayerType): PlayerId
fun toGenericMessage(): GenericMessage?

data class Tweet : TwitterPublicConnectorMessage

Tweet(text: String, dmRecipientID: String? = null, welcomeMessageID: String? = null, defaultMessage: String? = null)
val defaultMessage: String?
val dmRecipientID: String?
val text: String
fun toGenericMessage(): GenericMessage?
val welcomeMessageID: String?

package ai.tock.bot.connector.web

ai.tock.bot.connector.web.send.Button

fun Button.toChoice(): Choice

ai.tock.bot.connector.web.send.WebCard

fun WebCard.toGenericMessage(): GenericMessage

ai.tock.bot.connector.web.send.WebCarousel

fun WebCarousel.toGenericMessage(): GenericMessage

ai.tock.bot.connector.web.send.WebWidget

fun WebWidget.toGenericMessage(): GenericMessage

data class OldWebMessage : WebConnectorMessage

OldWebMessage(text: String? = null, buttons: List<WebButton> = emptyList(), card: MediaCard? = null, carousel: MediaCarousel? = null)
val buttons: List<WebButton>
val card: MediaCard?
val carousel: MediaCarousel?
val connectorType: ConnectorType
val text: String?
fun toGenericMessage(): GenericMessage?

fun <ERROR CLASS>.toGenericMessage(): GenericMessage
fun <ERROR CLASS>.toMediaFile(): MediaFile
fun MediaFile.toWebMediaFile(): <ERROR CLASS>
fun <T : Bus<T>> T.webButton(title: CharSequence, targetIntent: IntentAware? = null, imageUrl: String? = null, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters = Parameters()): WebButton
data class WebButton

WebButton(title: String, payload: String? = null, imageUrl: String? = null)
val imageUrl: String?
val payload: String?
val title: String
fun toChoice(): Choice

fun <T : Bus<T>> T.webCard(card: WebCard): WebMessage
fun <T : Bus<T>> T.webCard(title: CharSequence?, subTitle: CharSequence?, buttons: List<Button> = emptyList()): WebCard
fun <T : Bus<T>> T.webCard(card: MediaCard): OldWebMessage
fun <T : Bus<T>> T.webCardWithAttachment(title: CharSequence?, subTitle: CharSequence?, attachmentUrl: CharSequence, buttons: List<Button>, type: AttachmentType = AttachmentType.file, attachementName: String = ""): WebCard
fun <T : Bus<T>> T.webCarousel(vararg cards: WebCard, buttons: List<Button> = emptyList()): WebMessage
fun <T : Bus<T>> T.webCarousel(cards: List<WebCard>, buttons: List<Button> = emptyList()): WebMessage
fun <T : Bus<T>> T.webCarousel(carousel: MediaCarousel): OldWebMessage
class WebConnector : ConnectorBase, OrchestrationConnector

fun addSuggestions(text: CharSequence, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
fun addSuggestions(message: ConnectorMessage, suggestions: List<CharSequence>): BotBus.() -> ConnectorMessage?
val applicationId: String
fun getOrchestrationHandlers(): OrchestrationHandlers
fun loadProfile(callback: ConnectorCallback, userId: PlayerId): UserPreferences
val path: String
fun register(controller: ConnectorController): Unit
fun send(event: Event, callback: ConnectorCallback, delayInMs: Long): Unit
fun toConnectorMessage(message: MediaMessage): BotBus.() -> List<ConnectorMessage>

interface WebConnectorMessage : SerializableConnectorMessage
data class WebConnectorRequest

WebConnectorRequest(query: String? = null, payload: String? = null, userId: String, locale: Locale = defaultLocale, ref: String? = null, connectorId: String? = null)
val connectorId: String?
val locale: Locale
val payload: String?
val query: String?
val ref: String?
fun toEvent(applicationId: String): Event
val userId: String

val webConnectorType: ConnectorType
fun <T : Bus<T>> T.webDeepLink(ref: String): WebMessage
@ConnectorHandler("web") @Target([AnnotationTarget.CLASS]) annotation class WebHandler

WebHandler(value: KClass<out ConnectorStoryHandler<*>>)
val value: KClass<out ConnectorStoryHandler<*>>

fun <T : Bus<T>> T.webImage(imageUrl: String, title: CharSequence): WebMessage
fun <T : Bus<T>> T.webIntentQuickReply(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters = Parameters(), imageUrl: String? = null, style: <ERROR CLASS>): Button
fun <T : Bus<T>> T.webIntentQuickReply(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters = Parameters(), imageUrl: String? = null, style: String? = ButtonStyle.primary.name): Button
fun WebMediaFile(url: String, name: String, type: AttachmentType = attachmentType(url)): <ERROR CLASS>
fun I18nTranslator.webMessage(title: CharSequence, vararg buttons: WebButton): OldWebMessage
fun I18nTranslator.webMessage(title: CharSequence, buttons: List<WebButton>): OldWebMessage
fun I18nTranslator.webMessage(title: CharSequence, vararg buttons: Button): WebMessage
fun I18nTranslator.webMessage(title: CharSequence, buttons: List<Button> = emptyList()): WebMessage
data class WebMessage : WebConnectorMessage

WebMessage(content: <ERROR CLASS>)
WebMessage(text: String? = null, buttons: List<Button> = emptyList(), card: WebCard? = null, carousel: WebCarousel? = null, widget: WebWidget? = null, image: <ERROR CLASS>? = null, version: String = "1", deepLink: <ERROR CLASS>? = null)
val buttons: List<Button>
val card: WebCard?
val carousel: WebCarousel?
val connectorType: ConnectorType
val deepLink: <ERROR CLASS>?
val image: <ERROR CLASS>?
val text: String?
fun toGenericMessage(): GenericMessage
val version: String
val widget: WebWidget?

fun <T : Bus<T>> T.webNlpQuickReply(title: CharSequence, nlpText: String? = null, imageUrl: String? = null, style: <ERROR CLASS>): Button
fun <T : Bus<T>> T.webNlpQuickReply(title: CharSequence, nlpText: String? = null, imageUrl: String? = null, style: String? = ButtonStyle.primary.name): Button
fun <T : Bus<T>> T.webPostbackButton(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters = Parameters(), imageUrl: String? = null, style: <ERROR CLASS>): Button
fun <T : Bus<T>> T.webPostbackButton(title: CharSequence, targetIntent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters = Parameters(), imageUrl: String? = null, style: String? = ButtonStyle.primary.name): Button
fun <T : Bus<T>> T.webQuickReply(title: CharSequence, targetIntent: IntentAware? = null, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters = Parameters(), imageUrl: String? = null): Button
data class WebRequestInfos

WebRequestInfos(headers: MultiMap, cookies: Map<String, Cookie>)
fun firstCookie(name: String): String?
fun firstHeader(name: String): String?
fun headers(name: String): List<String>

object WebRequestInfosByEvent

fun get(eventId: String): WebRequestInfos?

fun <T : Bus<T>> T.webTextButton(text: CharSequence): WebButton
fun <T : Bus<T>> T.webUrlButton(title: CharSequence, url: String, imageUrl: String? = null, target: <ERROR CLASS>, style: <ERROR CLASS>): Button
fun <T : Bus<T>> T.webUrlButton(title: CharSequence, url: String, imageUrl: String? = null, target: String? = HrefTargetType._blank.name, style: <ERROR CLASS>): Button
fun <T : Bus<T>> T.webUrlButton(title: CharSequence, url: String, imageUrl: String? = null, target: <ERROR CLASS>, style: String? = ButtonStyle.primary.name): Button
fun <T : Bus<T>> T.webUrlButton(title: CharSequence, url: String, imageUrl: String? = null, target: String? = HrefTargetType._blank.name, style: String? = ButtonStyle.primary.name): Button
fun <T : Bus<T>> T.webWidget(widget: WebWidget, buttons: List<Button> = emptyList()): WebMessage
fun <T : Bus<T>> T.withWeb(messageProvider: () -> WebConnectorMessage): T

package ai.tock.bot.connector.whatsapp

fun <T : Bus<T>> T.endForWhatsApp(messageProvider: T.() -> WhatsAppBotMessage, delay: Long = defaultDelay(currentAnswerIndex)): T
fun <T : Bus<T>> T.sendToWhatsApp(messageProvider: T.() -> WhatsAppBotMessage, delay: Long = defaultDelay(currentAnswerIndex)): T
class WhatsAppConnector : ConnectorBase

WhatsAppConnector(applicationId: String, path: String, url: String, login: String, password: String, requestFilter: RequestFilter)
val applicationId: String
fun register(controller: ConnectorController): Unit
fun send(event: Event, callback: ConnectorCallback, delayInMs: Long): Unit

class WhatsAppConnectorCallback : ConnectorCallbackBase

WhatsAppConnectorCallback(applicationId: String, recipientType: WhatsAppBotRecipientType)
val recipientType: WhatsAppBotRecipientType

class WhatsAppConnectorData : ConnectorData

WhatsAppConnectorData(callback: WhatsAppConnectorCallback, groupId: String? = null, originalUserId: String)
val originalUserId: String

val whatsAppConnectorType: ConnectorType
@ConnectorHandler("whatsapp") @Target([AnnotationTarget.CLASS]) annotation class WhatsAppHandler

WhatsAppHandler(value: KClass<out ConnectorStoryHandler<*>>)
val value: KClass<out ConnectorStoryHandler<*>>

fun BotBus.whatsAppImage(byteImages: ByteArray, contentType: String = "image/png", caption: CharSequence? = null): WhatsAppBotImageMessage
fun BotBus.whatsAppInteractiveMessage(nameSpace: String, templateName: String, components: List<WhatsAppComponent>? = emptyList()): WhatsAppBotInteractiveMessage
fun BotBus.whatsAppText(text: CharSequence, previewUrl: Boolean = false): WhatsAppBotTextMessage
fun <T : Bus<T>> T.withWhatsApp(messageProvider: () -> WhatsAppBotMessage): T

package ai.tock.bot.connector.whatsapp.model.common

data class WhatsAppError

WhatsAppError(code: Long, title: String, details: String?, href: String? = null)
val code: Long
val details: String?
val href: String?
val title: String

data class WhatsAppTextBody

WhatsAppTextBody(body: String)
val body: String

package ai.tock.bot.connector.whatsapp.model.send

data class WhatsAppBotAttachment

WhatsAppBotAttachment(byteImages: ByteArray, contentType: String, caption: String? = null)
WhatsAppBotAttachment(id: String = "", caption: String? = null)
val caption: String?
var id: String

data class WhatsAppBotImageMessage : WhatsAppBotMessage

WhatsAppBotImageMessage(image: WhatsAppBotAttachment, recipientType: WhatsAppBotRecipientType, userId: String? = null)
val image: WhatsAppBotAttachment
val recipientType: WhatsAppBotRecipientType

data class WhatsAppBotInteractiveMessage : WhatsAppBotMessage

WhatsAppBotInteractiveMessage(template: WhatsAppTemplate, recipientType: WhatsAppBotRecipientType, userId: String? = null)
val recipientType: WhatsAppBotRecipientType
val template: WhatsAppTemplate

abstract class WhatsAppBotMessage : ConnectorMessage

WhatsAppBotMessage(type: WhatsAppBotMessageType, userId: String?)
open val connectorType: ConnectorType
abstract val recipientType: WhatsAppBotRecipientType
val to: String
val type: WhatsAppBotMessageType

enum class WhatsAppBotMessageType

audio
contact
document
hsm
image
location
template
text

enum class WhatsAppBotRecipientType

group
individual

data class WhatsAppBotTextMessage : WhatsAppBotMessage

WhatsAppBotTextMessage(text: WhatsAppTextBody, recipientType: WhatsAppBotRecipientType, userId: String? = null, previewUrl: Boolean = false)
val previewUrl: Boolean
val recipientType: WhatsAppBotRecipientType
val text: WhatsAppTextBody

data class WhatsAppMessageRef

WhatsAppMessageRef(id: String)
val id: String

data class WhatsAppResponse

WhatsAppResponse(messages: List<WhatsAppMessageRef> = emptyList(), errors: List<WhatsAppError> = emptyList())
val errors: List<WhatsAppError>
val messages: List<WhatsAppMessageRef>

package ai.tock.bot.connector.whatsapp.model.webhook

data class WhatsAppAttachment

WhatsAppAttachment(id: String, mimeType: String, sha256: String, filename: String? = null, caption: String? = null)
val caption: String?
val filename: String?
val id: String
val mimeType: String
val sha256: String

class WhatsAppButton

WhatsAppButton(text: String, payload: String?)
val payload: String?
val text: String

class WhatsAppButtonMessage : WhatsAppMessage

WhatsAppButtonMessage(id: String, from: String, timestamp: String, context: WhatsAppContext? = null, groupId: String? = null, button: WhatsAppButton)
val button: WhatsAppButton
val context: WhatsAppContext?
val from: String
val groupId: String?
val id: String
val timestamp: String

data class WhatsAppComponent

WhatsAppComponent(type: WhatsAppComponentType, subType: WhatsAppComponentSubType? = null, index: Int? = null, parameters: List<WhatsAppParameter>)
val index: Int?
val parameters: List<WhatsAppParameter>
val subType: WhatsAppComponentSubType?
val type: WhatsAppComponentType

enum class WhatsAppComponentSubType

quick_reply
url

enum class WhatsAppComponentType

body
button
header

data class WhatsAppContact

WhatsAppContact(profile: WhatsAppProfile?, waId: String?)
val profile: WhatsAppProfile?
val waId: String?

data class WhatsAppContext

WhatsAppContext(from: String, id: String)
val from: String
val id: String

data class WhatsAppCurrencyParameter

WhatsAppCurrencyParameter(fallbackValue: String, code: String, amount: Int)
val amount: Int
val code: String
val fallbackValue: String

data class WhatsAppDateTimeParameter

WhatsAppDateTimeParameter(fallbackValue: String, dayOfWeek: Int? = null, dayOfMonth: Int? = null, year: Int? = null, month: Int? = null, hour: Int? = null, minute: Int? = null, timestamp: Int? = null)
val dayOfMonth: Int?
val dayOfWeek: Int?
val fallbackValue: String
val hour: Int?
val minute: Int?
val month: Int?
val timestamp: Int?
val year: Int?

data class WhatsAppDocumentMessage : WhatsAppMessage

WhatsAppDocumentMessage(document: WhatsAppAttachment, id: String, from: String, timestamp: String, context: WhatsAppContext? = null, groupId: String? = null)
val context: WhatsAppContext?
val document: WhatsAppAttachment
val from: String
val groupId: String?
val id: String
val timestamp: String

data class WhatsAppImageMessage : WhatsAppMessage

WhatsAppImageMessage(image: WhatsAppAttachment, id: String, from: String, timestamp: String, context: WhatsAppContext? = null, groupId: String? = null)
val context: WhatsAppContext?
val from: String
val groupId: String?
val id: String
val image: WhatsAppAttachment
val timestamp: String

data class WhatsAppImageParameter

WhatsAppImageParameter(link: String)
val link: String

data class WhatsAppInteractiveMessage

WhatsAppInteractiveMessage(to: String, ttl: String?, type: String?, template: WhatsAppTemplate)
val template: WhatsAppTemplate
val to: String
val ttl: String?
val type: String?

data class WhatsAppLanguage

WhatsAppLanguage(policy: String, code: String)
val code: String
val policy: String

data class WhatsAppLocation

WhatsAppLocation(latitude: Double, longitude: Double, address: String?, name: String?, url: String?)
val address: String?
val latitude: Double
val longitude: Double
val name: String?
val url: String?

data class WhatsAppLocationMessage : WhatsAppMessage

WhatsAppLocationMessage(location: WhatsAppLocation, id: String, from: String, timestamp: String, context: WhatsAppContext? = null, groupId: String? = null)
val context: WhatsAppContext?
val from: String
val groupId: String?
val id: String
val location: WhatsAppLocation
val timestamp: String

abstract class WhatsAppMessage

WhatsAppMessage(type: WhatsAppMessageType)
abstract val context: WhatsAppContext?
abstract val from: String
abstract val groupId: String?
abstract val id: String
abstract val timestamp: String
val type: WhatsAppMessageType

data class WhatsAppMessages : ConnectorMessage

WhatsAppMessages(messages: List<WhatsAppMessage> = emptyList(), statuses: List<WhatsAppStatus> = emptyList(), errors: List<WhatsAppError> = emptyList(), contacts: List<WhatsAppContact> = emptyList())
val connectorType: ConnectorType
val contacts: List<WhatsAppContact>
val errors: List<WhatsAppError>
val messages: List<WhatsAppMessage>
val statuses: List<WhatsAppStatus>

enum class WhatsAppMessageStatus

deleted
delivered
failed
read
sent

enum class WhatsAppMessageType

audio
button
contacts
document
image
location
system
text
unknown
video
voice

data class WhatsAppParameter

WhatsAppParameter(type: WhatsAppParameterType, text: String? = null, image: WhatsAppImageParameter? = null, currency: String? = null, payload: String? = null)
val currency: String?
val image: WhatsAppImageParameter?
val payload: String?
val text: String?
val type: WhatsAppParameterType

enum class WhatsAppParameterType

currency
date_time
image
payload
text

data class WhatsAppProfile

WhatsAppProfile(name: String)
val name: String

data class WhatsAppStatus

WhatsAppStatus(id: String, recipientId: String, status: WhatsAppMessageStatus, timestamp: String, errors: List<WhatsAppError> = emptyList())
val errors: List<WhatsAppError>
val id: String
val recipientId: String
val status: WhatsAppMessageStatus
val timestamp: String

data class WhatsAppSystemMessage : WhatsAppMessage

WhatsAppSystemMessage(system: WhatsAppTextBody, id: String, from: String, timestamp: String, context: WhatsAppContext? = null, groupId: String? = null)
val context: WhatsAppContext?
val from: String
val groupId: String?
val id: String
val system: WhatsAppTextBody
val timestamp: String

data class WhatsAppTemplate

WhatsAppTemplate(namespace: String, language: WhatsAppLanguage, name: String, components: List<WhatsAppComponent>?)
val components: List<WhatsAppComponent>?
val language: WhatsAppLanguage
val name: String
val namespace: String

data class WhatsAppTextMessage : WhatsAppMessage

WhatsAppTextMessage(text: WhatsAppTextBody, id: String, from: String, timestamp: String, context: WhatsAppContext? = null, groupId: String? = null)
val context: WhatsAppContext?
val from: String
val groupId: String?
val id: String
val text: WhatsAppTextBody
val timestamp: String

data class WhatsAppUnknownMessage : WhatsAppMessage

WhatsAppUnknownMessage(errors: List<WhatsAppError> = emptyList(), id: String, from: String, timestamp: String, context: WhatsAppContext? = null, groupId: String? = null)
val context: WhatsAppContext?
val errors: List<WhatsAppError>
val from: String
val groupId: String?
val id: String
val timestamp: String

data class WhatsAppVoiceMessage : WhatsAppMessage

WhatsAppVoiceMessage(voice: WhatsAppAttachment, id: String, from: String, timestamp: String, context: WhatsAppContext? = null, groupId: String? = null)
val context: WhatsAppContext?
val from: String
val groupId: String?
val id: String
val timestamp: String
val voice: WhatsAppAttachment

package ai.tock.bot.definition

fun bot(botId: String, stories: List<StoryDefinition>, namespace: String = "app", nlpModelName: String = botId, unknownStory: StoryDefinition = defaultUnknownStory, hello: IntentAware? = null, goodbye: IntentAware? = null, noInput: IntentAware? = null, botDisabled: IntentAware? = null, botEnabled: IntentAware? = null, userLocation: IntentAware? = null, handleAttachment: IntentAware? = null, eventListener: EventListener = EventListenerBase(), keywordStory: StoryDefinition = defaultKeywordStory, conversation: DialogFlowDefinition? = null): SimpleBotDefinition
interface BotAnswerInterceptor

open fun handle(action: Action, bus: BotBus): Action

interface BotDefinition : I18nKeyProvider

open val botDisabledStories: List<StoryDefinition>
abstract val botDisabledStory: StoryDefinition?
open val botEnabledListener: (Action) -> Unit
open val botEnabledStories: List<StoryDefinition>
abstract val botEnabledStory: StoryDefinition?
abstract val botId: String
var defaultBreath: Long
open fun defaultDelay(answerIndex: Int): Long
open val defaultStory: StoryDefinition
abstract val defaultUnknownAnswer: I18nLabelValue
open fun disableBot(timeline: UserTimeline, dialog: Dialog, action: Action): Boolean
open fun enableBot(timeline: UserTimeline, dialog: Dialog, action: Action): Boolean
open fun entity(name: String, role: String? = null): Entity
open fun errorAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId): Action
abstract val eventListener: EventListener
open fun findIntent(intent: String, applicationId: String): Intent
open fun findStoryByStoryHandler(storyHandler: StoryHandler, applicationId: String): StoryDefinition?
open fun findStoryDefinition(intent: IntentAware?, applicationId: String): StoryDefinition
open fun findStoryDefinition(intent: String?, applicationId: String): StoryDefinition
open fun findStoryDefinitionById(storyId: String, applicationId: String): StoryDefinition
open val flowDefinition: DialogFlowDefinition?
abstract val goodbyeStory: StoryDefinition?
abstract val handleAttachmentStory: StoryDefinition?
open fun hasDisableTagIntent(dialog: Dialog): Boolean
open fun hasToPersistAction(timeline: UserTimeline, action: Action): Boolean
abstract val helloStory: StoryDefinition?
open fun i18n(defaultLabel: CharSequence, args: List<Any?>): I18nLabelValue
open fun i18nTranslator(userLocale: Locale, connectorType: ConnectorType, userInterfaceType: UserInterfaceType = connectorType.userInterfaceType, contextId: String? = null): I18nTranslator
abstract val keywordStory: StoryDefinition
abstract val namespace: String
abstract val nlpModelName: String
abstract val noInputStory: StoryDefinition?
abstract val stories: List<StoryDefinition>
open val testBehaviour: TestBehaviour
abstract val unknownStory: StoryDefinition
abstract val userLocationStory: StoryDefinition?

open class BotDefinitionBase : BotDefinition

BotDefinitionBase(botId: String, stories: Array<out StoryDefinition>)
BotDefinitionBase(botId: String, namespace: String, stories: List<StoryDefinition>, nlpModelName: String = botId, unknownStory: StoryDefinition = defaultUnknownStory, helloStory: StoryDefinition? = null, goodbyeStory: StoryDefinition? = null, noInputStory: StoryDefinition? = null, botDisabledStory: StoryDefinition? = null, botEnabledStory: StoryDefinition? = null, userLocationStory: StoryDefinition? = null, handleAttachmentStory: StoryDefinition? = null, eventListener: EventListener = EventListenerBase(), keywordStory: StoryDefinition = defaultKeywordStory, flowDefinition: DialogFlowDefinition? = null)
open val botDisabledStory: StoryDefinition?
open val botEnabledStory: StoryDefinition?
open val botId: String
val defaultKeywordStory: SimpleStoryDefinition
open val defaultUnknownAnswer: I18nLabelValue
val defaultUnknownStory: SimpleStoryDefinition
fun deleteKeywordHandler(bus: BotBus, sendEnd: Boolean = true): Unit
fun endTestContextKeywordHandler(bus: BotBus, sendEnd: Boolean = true): Unit
open val eventListener: EventListener
open val flowDefinition: DialogFlowDefinition?
fun getKeyword(bus: BotBus): String?
open val goodbyeStory: StoryDefinition?
open val handleAttachmentStory: StoryDefinition?
fun handleWithKeywordListeners(bus: BotBus, keyword: String?): Boolean
open val helloStory: StoryDefinition?
open val keywordStory: StoryDefinition
open val namespace: String
open val nlpModelName: String
open val noInputStory: StoryDefinition?
open val stories: List<StoryDefinition>
fun testContextKeywordHandler(bus: BotBus, sendEnd: Boolean = true): Unit
open fun toString(): String
open val unknownStory: StoryDefinition
open val userLocationStory: StoryDefinition?

interface BotProvider

abstract fun botDefinition(): BotDefinition
open val botProviderId: BotProviderId
open var configurationUpdated: Boolean

open class BotProviderBase : BotProvider

BotProviderBase(botDefinition: BotDefinition)
open fun botDefinition(): BotDefinition
val botDefinition: BotDefinition
open fun equals(other: Any?): Boolean
open fun hashCode(): Int

data class BotProviderId

BotProviderId(botId: String, namespace: String, configurationName: String? = null)
val botId: String
val configurationName: String?
val namespace: String

open class ConfigurableStoryHandler<out T : StoryHandlerDefinition> : StoryHandlerBase<T>

ConfigurableStoryHandler(mainIntentName: String? = null, handlerDefCreator: HandlerStoryDefinitionCreator<T>, preconditionsChecker: BotBus.() -> Any?, i18nNamespace: String = defaultNamespace, breath: Long = BotDefinition.defaultBreath)
open fun checkPreconditions(): BotBus.() -> Any?
open fun newHandlerDefinition(bus: BotBus, data: Any?): T

typealias ConnectorDef<T> = ConnectorStoryHandlerBase<T>
interface ConnectorHandlerProvider

open fun provide(storyDef: StoryHandlerDefinition, connectorType: ConnectorType): ConnectorStoryHandlerBase<*>?
open fun provide(storyDef: StoryHandlerDefinition, connectorId: String): ConnectorStoryHandlerBase<*>?

interface ConnectorStoryHandler<out T : StoryHandlerDefinition> : BotBus

abstract val context: T

abstract class ConnectorStoryHandlerBase<out T : StoryHandlerDefinition> : BotBus, ConnectorStoryHandler<T>

ConnectorStoryHandlerBase(context: T)
open val context: T

fun <reified T : StoryHandlerDefinition> defaultHandlerStoryDefinitionCreator(): HandlerStoryDefinitionCreator<T>
data class DialogFlowDefinition

DialogFlowDefinition(states: Set<DialogFlowState>, transitions: Set<DialogFlowStateTransition>)
val states: Set<DialogFlowState>
val transitions: Set<DialogFlowStateTransition>

data class DialogFlowState

DialogFlowState(storyDefinition: StoryDefinition, intent: IntentAware = storyDefinition.mainIntent(), step: StoryStep<*>? = null)
val intent: IntentAware
val step: StoryStep<*>?
val storyDefinition: StoryDefinition

data class DialogFlowStateTransition

DialogFlowStateTransition(previousState: DialogFlowState?, nextState: DialogFlowState, intent: IntentAware?, step: StoryStep<*>?, type: DialogFlowStateTransitionType = DialogFlowStateTransitionType.nlp)
val intent: IntentAware?
val nextState: DialogFlowState
val previousState: DialogFlowState?
val step: StoryStep<*>?
val type: DialogFlowStateTransitionType

enum class DialogFlowStateTransitionType

attachment
choice
location
nlp
other

object EmptyData
data class EntityStepSelection

EntityStepSelection(value: String?, entityRole: String, entityType: String = entityRole)
val entityRole: String
val entityType: String
val value: String?

interface EventListener

abstract fun listenEvent(controller: ConnectorController, connectorData: ConnectorData, event: Event): Boolean

open class EventListenerBase : EventListener

EventListenerBase()
open fun listenEvent(controller: ConnectorController, connectorData: ConnectorData, event: Event): Boolean
protected open fun passThreadControlEventListener(controller: ConnectorController, connectorData: ConnectorData, event: PassThreadControlEvent): Boolean
protected fun sendChoice(event: OneToOneEvent, intent: IntentAware, controller: ConnectorController, connectorData: ConnectorData): Unit

typealias Handler<T> = StoryHandlerBase<T>
typealias HandlerDef<T> = StoryHandlerDefinitionBase<T>
interface HandlerStoryDefinitionCreator<T : StoryHandlerDefinition>

abstract fun create(bus: BotBus, data: Any? = null): T

data class Intent : IntentAware

Intent(name: String)
val keyword: Intent
val name: String
val unknown: Intent
fun wrappedIntent(): Intent

interface IntentAware

open fun intentWithoutNamespace(): IntentWithoutNamespace
open infix fun wrap(intent: Intent?): Boolean
abstract fun wrappedIntent(): Intent

interface IntentAwareBase : IntentAware

abstract val name: String
open fun wrappedIntent(): Intent

typealias IntentDef = IntentAwareBase
data class IntentWithoutNamespace

IntentWithoutNamespace(name: String)
fun intent(namespace: String): Intent
val name: String

val noStep: SimpleStoryStep
fun notify(applicationId: String, namespace: String, botId: String, recipientId: PlayerId, intent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Parameters = Parameters.EMPTY, stateModifier: NotifyBotStateModifier = NotifyBotStateModifier.KEEP_CURRENT_STATE, notificationType: ActionNotificationType? = null, errorListener: (Throwable) -> Unit = {}): Unit
interface ParameterKey

open operator fun get(value: Any): Parameters
open operator fun invoke(value: Any): Parameters
open val key: String
abstract val name: String

data class Parameters

Parameters(vararg entries: Pair<String, String>)
Parameters(entries: Map<String, String>)
val EMPTY: Parameters
operator fun plus(param: Parameters): Parameters
fun toArray(): Array<Pair<String, String>>
fun toMap(): Map<String, String>

class SimpleBotDefinition : BotDefinitionBase

SimpleBotDefinition(botId: String, namespace: String, stories: List<StoryDefinition>, nlpModelName: String = botId, unknownStory: StoryDefinition = defaultUnknownStory, helloStory: StoryDefinition? = null, goodbyeStory: StoryDefinition? = null, noInputStory: StoryDefinition? = null, botDisabledStory: StoryDefinition? = null, botEnabledStory: StoryDefinition? = null, userLocationStory: StoryDefinition? = null, handleAttachmentStory: StoryDefinition? = null, eventListener: EventListener = EventListenerBase(), keywordStory: StoryDefinition = defaultKeywordStory, conversation: DialogFlowDefinition? = null)

typealias SimpleHandler = SimpleStoryHandlerBase
open class SimpleStoryDefinition : StoryDefinition

SimpleStoryDefinition(id: String, storyHandler: StoryHandler, steps: Array<out StoryStep<StoryHandlerDefinition>> = emptyArray(), starterIntents: Set<IntentAware>, intents: Set<IntentAware> = starterIntents, unsupportedUserInterfaces: Set<UserInterfaceType> = emptySet())
SimpleStoryDefinition(id: String, storyHandler: StoryHandler, starterIntents: Set<Intent>, intents: Set<Intent> = starterIntents, steps: Set<StoryStep<StoryHandlerDefinition>> = emptySet(), unsupportedUserInterfaces: Set<UserInterfaceType> = emptySet(), tags: Set<StoryTag> = emptySet())
open val id: String
open val intents: Set<Intent>
open val starterIntents: Set<Intent>
open val steps: Set<StoryStep<StoryHandlerDefinition>>
open val storyHandler: StoryHandler
open val tags: Set<StoryTag>
open val unsupportedUserInterfaces: Set<UserInterfaceType>

abstract class SimpleStoryHandlerBase : StoryHandlerBase<StoryHandlerDefinition>

SimpleStoryHandlerBase(mainIntentName: String? = null)
abstract fun action(bus: BotBus): Unit
open fun newHandlerDefinition(bus: BotBus, data: Any?): StoryHandlerDefinition

interface SimpleStoryStep : StoryStep<StoryHandlerDefinition>
fun story(handler: SimpleStoryHandlerBase, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), steps: List<StoryStep<out StoryHandlerDefinition>> = emptyList(), unsupportedUserInterface: UserInterfaceType? = null): StoryDefinitionBase
fun story(intentName: String, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), steps: List<StoryStep<out StoryHandlerDefinition>> = emptyList(), unsupportedUserInterface: UserInterfaceType? = null, handler: BotBus.() -> Unit): StoryDefinitionBase
fun <reified T : StoryHandlerDefinition> story(handler: StoryHandlerBase<T>, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), steps: List<StoryStep<out StoryHandlerDefinition>> = emptyList(), unsupportedUserInterface: UserInterfaceType? = null): StoryDefinitionBase
fun story(intent: IntentAware, storyHandler: StoryHandler, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), steps: List<StoryStep<out StoryHandlerDefinition>> = emptyList(), unsupportedUserInterface: UserInterfaceType? = null): StoryDefinitionBase
interface StoryDataStep<T : StoryHandlerDefinition, TD, D> : StoryStep<T>

open fun answer(): T.() -> Any?
open fun checkPreconditions(): T.(TD?) -> D?
open fun handler(): T.(D?) -> Any?
open fun selectFromBusAndData(): T.(TD?) -> Boolean

abstract class StoryDataStepBase<T : StoryHandlerDefinition, TD, D> : StoryDataStep<T, TD, D>

StoryDataStepBase(select: TD.(T) -> Boolean = { false }, setup: T.(TD) -> D = { @Suppress("UNCHECKED_CAST") EmptyData as D }, reply: T.(D) -> Any?)
fun checkPreconditions(): T.(TD?) -> D?
fun execute(storyDef: T, configuration: TD): Any?
fun handler(): T.(D?) -> Any?
open val name: String
fun reply(): T.(D) -> Any?
fun select(): TD.(T) -> Boolean
fun selectFromBusAndData(): T.(TD?) -> Boolean
fun setup(): T.(TD) -> D

@JvmName("storyDataDefWithSteps") inline fun <reified T : StoryHandlerDefinition, D> storyDef(intentName: String, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), steps: List<StoryStep<out StoryHandlerDefinition>> = emptyList(), unsupportedUserInterface: UserInterfaceType? = null, handlerDefCreator: HandlerStoryDefinitionCreator<T> = defaultHandlerStoryDefinitionCreator(), noinline preconditionsChecker: BotBus.() -> D): StoryDefinitionBase
inline fun <reified T : StoryHandlerDefinition> storyDef(intentName: String, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), steps: List<StoryStep<out StoryHandlerDefinition>> = emptyList(), unsupportedUserInterface: UserInterfaceType? = null, handlerDefCreator: HandlerStoryDefinitionCreator<T> = defaultHandlerStoryDefinitionCreator(), noinline preconditionsChecker: BotBus.() -> Unit): StoryDefinitionBase
interface StoryDefinition : IntentAware

open fun allSteps(): Set<StoryStep<*>>
open fun hasTag(tag: StoryTag): Boolean
abstract val id: String
abstract val intents: Set<Intent>
open fun isStarterIntent(intent: Intent): Boolean
open fun mainIntent(): Intent
abstract val starterIntents: Set<Intent>
abstract val steps: Set<StoryStep<*>>
abstract val storyHandler: StoryHandler
open fun supportIntent(intent: Intent): Boolean
open val tags: Set<StoryTag>
abstract val unsupportedUserInterfaces: Set<UserInterfaceType>
open fun wrappedIntent(): Intent

open class StoryDefinitionBase : StoryDefinition

StoryDefinitionBase(name: String, storyHandler: StoryHandler = {} as SimpleStoryHandlerBase, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), stepsList: List<StoryStep<out StoryHandlerDefinition>> = emptyList(), unsupportedUserInterface: UserInterfaceType? = null, tags: Set<StoryTag> = emptySet())
open fun handle(bus: BotBus): Unit
open val id: String
open val intents: Set<Intent>
val name: String
open val starterIntents: Set<Intent>
open val steps: Set<StoryStep<out StoryHandlerDefinition>>
open val storyHandler: StoryHandler
open val tags: Set<StoryTag>
open fun toString(): String
open val unsupportedUserInterfaces: Set<UserInterfaceType>

interface StoryDefinitionExtended : StoryDefinition

open val id: String
open val intents: Set<Intent>
abstract val name: String
open val otherStarterIntents: Set<IntentAware>
open val secondaryIntents: Set<IntentAware>
open val starterIntents: Set<Intent>
open val steps: Set<StoryStep<out StoryHandlerDefinition>>
open val stepsArray: Array<out StoryStep<out StoryHandlerDefinition>>
open val unsupportedUserInterface: UserInterfaceType?
open val unsupportedUserInterfaces: Set<UserInterfaceType>

@JvmName("storyDataDefWithSteps") inline fun <reified T : StoryHandlerDefinition, reified S, D> storyDefWithSteps(intentName: String, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), unsupportedUserInterface: UserInterfaceType? = null, handlerDefCreator: HandlerStoryDefinitionCreator<T> = defaultHandlerStoryDefinitionCreator(), noinline preconditionsChecker: BotBus.() -> D): StoryDefinitionBase where S : Enum<S>, S : StoryStep<out StoryHandlerDefinition>
inline fun <reified T : StoryHandlerDefinition, reified S> storyDefWithSteps(intentName: String, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), unsupportedUserInterface: UserInterfaceType? = null, handlerDefCreator: HandlerStoryDefinitionCreator<T> = defaultHandlerStoryDefinitionCreator(), noinline preconditionsChecker: BotBus.() -> Unit): StoryDefinitionBase where S : Enum<S>, S : StoryStep<out StoryHandlerDefinition>
interface StoryHandler

abstract fun handle(bus: BotBus): Unit
open fun support(bus: BotBus): Double

abstract class StoryHandlerBase<out T : StoryHandlerDefinition> : StoryHandler, I18nKeyProvider, IntentAware

StoryHandlerBase(mainIntentName: String? = null, i18nNamespace: String = defaultNamespace, breath: Long = defaultBreath)
val breath: Long
open fun checkPreconditions(): BotBus.() -> Any?
open fun findStoryDefinition(bus: BotBus): StoryDefinition?
fun handle(bus: BotBus): Unit
fun handleAndSwitchStory(bus: BotBus): Unit
open fun i18n(defaultLabel: CharSequence, args: List<Any?>): I18nLabelValue
fun i18nKey(key: String, defaultLabel: CharSequence, vararg args: Any?): I18nLabelValue
abstract fun newHandlerDefinition(bus: BotBus, data: Any? = null): T
fun <T : StoryHandlerDefinition> selectStepFromStoryHandlerAndData(def: T, data: Any?, storyDefinition: StoryDefinition?): StoryStep<*>?
open fun support(bus: BotBus): Double
open fun wrappedIntent(): Intent

interface StoryHandlerDefinition : BotBus

open fun answerWith(default: CharSequence? = null, messageProvider: () -> Any?): Unit
open val connector: ConnectorStoryHandler<*>?
abstract fun handle(): Unit

abstract class StoryHandlerDefinitionBase<T : ConnectorStoryHandlerBase<*>> : BotBus, StoryHandlerDefinition

StoryHandlerDefinitionBase(bus: BotBus)
open fun answer(): Unit
val bus: BotBus
val c: T
open val connector: T?
val connectorType: ConnectorType
open fun findConnector(connectorType: ConnectorType): T?
open fun findConnector(connectorId: String): T?
open fun handle(): Unit

interface StoryHandlerListener

open fun endAction(botBus: BotBus, handler: StoryHandler): Unit
open fun startAction(botBus: BotBus, handler: StoryHandler): Boolean

interface StoryStep<T : StoryHandlerDefinition>

open fun answer(): T.() -> Any?
open val baseIntent: IntentAware
open val children: Set<StoryStep<T>>
open val entityStepSelection: EntityStepSelection?
open val hasNoChildren: Boolean
open val intent: IntentAware?
abstract val name: String
open val otherStarterIntents: Set<IntentAware>
open val secondaryIntents: Set<IntentAware>
open fun selectFromAction(userTimeline: UserTimeline, dialog: Dialog, action: Action, intent: Intent?): Boolean
open fun selectFromActionAndEntityStepSelection(action: Action, intent: Intent? = null): Boolean?
open fun selectFromBus(): BotBus.() -> Boolean
open fun selectFromDialog(userTimeline: UserTimeline, dialog: Dialog, intent: Intent?): Boolean
open fun selectFromDialogAndEntityStepSelection(dialog: Dialog, intent: Intent? = null): Boolean?
open fun supportIntent(i: Intent): Boolean
open fun supportStarterIntent(i: Intent): Boolean

enum class StoryTag

CHECK_ONLY_SUB_STEPS
CHECK_ONLY_SUB_STEPS_WITH_STORY_INTENT
DISABLE
ENABLE

fun <reified T> storyWithSteps(handler: StoryHandlerBase<*>, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), unsupportedUserInterface: UserInterfaceType? = null): StoryDefinitionBase where T : Enum<T>, T : StoryStep<out StoryHandlerDefinition>
fun <reified T> storyWithSteps(intent: IntentAware, storyHandler: StoryHandler, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), unsupportedUserInterface: UserInterfaceType? = null): StoryDefinitionBase where T : Enum<T>, T : StoryStep<out StoryHandlerDefinition>
inline fun <reified T> storyWithSteps(intentName: String, otherStarterIntents: Set<IntentAware> = emptySet(), secondaryIntents: Set<IntentAware> = emptySet(), unsupportedUserInterface: UserInterfaceType? = null, noinline handler: BotBus.() -> Unit): StoryDefinitionBase where T : Enum<T>, T : StoryStep<out StoryHandlerDefinition>
interface TestBehaviour

open fun cleanup(bus: BotBus): Unit
abstract val firstName: String
abstract val lastName: String
open fun setup(bus: BotBus): Unit
open fun setup(userPreferences: UserPreferences, connectorType: ConnectorType, locale: Locale): Unit

open class TestBehaviourBase : TestBehaviour

TestBehaviourBase()
open val firstName: String
open val lastName: String

package ai.tock.bot.engine

interface BotBus : Bus<BotBus>

abstract val action: Action
open fun booleanChoice(key: ParameterKey): Boolean
abstract val botDefinition: BotDefinition
open fun changeContextValue(name: String, value: Any?): Unit
open fun changeContextValue(key: ParameterKey, value: Any?): Unit
open fun changeEntityText(entity: Entity, textContent: String?): Unit
open fun changeEntityValue(role: String, newValue: EntityValue?): Unit
open fun changeEntityValue(entity: Entity, newValue: Value?): Unit
open fun changeEntityValue(entity: Entity, newValue: EntityValue): Unit
open fun choice(key: ParameterKey): String?
abstract val connectorData: ConnectorData
open val contextId: String?
open fun <T : Any> contextValue(name: String): T?
open fun <T : Any> contextValue(key: ParameterKey): T?
abstract val currentDialog: Dialog
open val currentIntent: IntentAware?
open fun defaultDelay(answerIndex: Int): Long
abstract val dialog: Dialog
open fun end(message: Message, delay: Long = defaultDelay(currentAnswerIndex)): BotBus
abstract fun end(action: Action, delay: Long = defaultDelay(currentAnswerIndex)): BotBus
open fun end(messages: MessagesList, initialDelay: Long = 0): BotBus
open fun end(delay: Long, messageProvider: BotBus.() -> Any?): BotBus
open fun end(i18nText: CharSequence, delay: Long, vararg i18nArgs: Any?): BotBus
open fun end(i18nText: CharSequence, vararg i18nArgs: Any?): BotBus
open fun end(delay: Long): BotBus
open fun endRawText(plainText: CharSequence?, delay: Long): BotBus
abstract val entities: Map<String, EntityStateValue>
open fun entityText(entity: Entity): String?
open fun entityText(role: String): String?
open fun <T : Value> entityValue(role: String, valueTransformer: (EntityValue) -> T? = @Suppress("UNCHECKED_CAST") { it.value as? T? }): T?
open fun <T : Value> entityValue(entity: Entity, valueTransformer: (EntityValue) -> T? = @Suppress("UNCHECKED_CAST") { it.value as? T? }): T?
open fun entityValueDetails(entity: Entity): EntityValue?
open fun entityValueDetails(role: String): EntityValue?
abstract fun <T> getBusContextValue(name: String): T?
open fun <T> getBusContextValue(key: ParameterKey): T?
open fun handleAndSwitchStory(storyDefinition: StoryDefinition, starterIntent: Intent = storyDefinition.mainIntent()): Unit
open fun hasActionEntity(role: String): Boolean
open fun hasActionEntity(entity: Entity): Boolean
open fun hasChoiceValue(param: ParameterKey, value: ParameterKey): Boolean
open fun i18n(defaultLabel: CharSequence, args: List<Any?>): I18nLabelValue
open fun i18nKey(key: String, defaultLabel: CharSequence, vararg args: Any?): I18nLabelValue
abstract var i18nProvider: I18nKeyProvider
open fun isChoiceAction(): Boolean
open fun isFeatureEnabled(feature: FeatureType, default: Boolean = false): Boolean
open fun isIntent(intentOwner: IntentAware): Boolean
abstract fun markAsUnknown(): Unit
abstract var nextUserActionState: NextUserActionState?
open fun nlpStats(): NlpCallStats?
abstract fun reloadProfile(): Unit
open fun removeAllEntityValues(): Unit
open fun removeEntityValue(role: String): Unit
open fun removeEntityValue(entity: Entity): Unit
open fun resetDialogState(): Unit
fun retrieveCurrentBus(): BotBus?
open fun send(message: Message, delay: Long = defaultDelay(currentAnswerIndex)): BotBus
open fun send(messages: MessagesList, initialDelay: Long = 0): BotBus
abstract fun send(action: Action, delay: Long = defaultDelay(currentAnswerIndex)): BotBus
open fun send(delay: Long, messageProvider: BotBus.() -> Any?): BotBus
open fun send(delay: Long): BotBus
open fun send(i18nText: CharSequence, delay: Long, vararg i18nArgs: Any?): BotBus
open fun send(i18nText: CharSequence, vararg i18nArgs: Any?): BotBus
abstract fun setBusContextValue(key: String, value: Any?): Unit
open fun setBusContextValue(key: ParameterKey, value: Any?): Unit
open fun skipAnswer(): Unit
open var step: StoryStep<out StoryHandlerDefinition>?
open val stepName: String?
abstract var story: Story
open fun switchStory(storyDefinition: StoryDefinition, starterIntent: Intent = storyDefinition.mainIntent()): Unit
open val test: Boolean
abstract val underlyingConnector: Connector
abstract val userPreferences: UserPreferences
open val userText: String?
abstract val userTimeline: UserTimeline
open fun withMessage(message: ConnectorMessage): BotBus
abstract fun withNotificationType(notificationType: ActionNotificationType): BotBus
abstract fun withPriority(priority: ActionPriority): BotBus
abstract fun withVisibility(visibility: ActionVisibility): BotBus

val botModule: Module
object BotRepository

@Synchronized fun checkBotConfigurations(startup: Boolean = false, botConfigurationChanged: Boolean = false): Unit
fun findConnectorProvider(connectorType: ConnectorType): ConnectorProvider?
fun forEachNlpListener(action: (NlpListener) -> Unit): Unit
fun getController(predicate: (BotApplicationConfiguration) -> Boolean): ConnectorController?
var healthcheckHandler: (RoutingContext) -> Unit
fun installBots(routerHandlers: List<(Router) -> Any?>, createApplicationIfNotExists: Boolean = true, startupLock: Lock? = null): Unit
fun notify(applicationId: String, recipientId: PlayerId, intent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Map<String, String> = emptyMap(), stateModifier: NotifyBotStateModifier = NotifyBotStateModifier.KEEP_CURRENT_STATE, notificationType: ActionNotificationType? = null, namespace: String? = null, botId: String? = null, errorListener: (Throwable) -> Unit = {}): Unit
fun registerBotAnswerInterceptor(botAnswerInterceptor: BotAnswerInterceptor): Unit
fun registerBotProvider(bot: BotProvider): Unit
fun registerBuiltInStoryDefinitions(botProvider: BotProvider): Unit
fun registerConnectorService(service: ConnectorService): Unit
fun registerNlpListener(listener: NlpListener): Unit
fun registerStoryHandlerListener(listener: StoryHandlerListener): Unit
var requestTimer: RequestTimer

interface Bus<T : Bus<T>> : I18nTranslator

abstract val applicationId: String
abstract val botId: PlayerId
abstract val currentAnswerIndex: Int
open val currentIntent: IntentAware?
abstract fun defaultDelay(answerIndex: Int): Long
open fun end(i18nText: CharSequence, delay: Long = defaultDelay(currentAnswerIndex), vararg i18nArgs: Any?): T
open fun end(i18nText: CharSequence, vararg i18nArgs: Any?): T
open fun end(delay: Long = defaultDelay(currentAnswerIndex)): T
open fun end(delay: Long = defaultDelay(currentAnswerIndex), messageProvider: T.() -> Any?): T
abstract fun endRawText(plainText: CharSequence?, delay: Long = defaultDelay(currentAnswerIndex)): T
abstract val intent: IntentAware?
open fun send(delay: Long = defaultDelay(currentAnswerIndex)): T
open fun send(i18nText: CharSequence, delay: Long = defaultDelay(currentAnswerIndex), vararg i18nArgs: Any?): T
open fun send(i18nText: CharSequence, vararg i18nArgs: Any?): T
open fun send(delay: Long = defaultDelay(currentAnswerIndex), messageProvider: T.() -> Any?): T
abstract fun sendRawText(plainText: CharSequence?, delay: Long = defaultDelay(currentAnswerIndex)): T
abstract val stepName: String?
abstract val test: Boolean
abstract val userId: PlayerId
open fun withMessage(message: ConnectorMessage): T
abstract fun withMessage(connectorType: ConnectorType, messageProvider: () -> ConnectorMessage): T
abstract fun withMessage(connectorType: ConnectorType, connectorId: String, messageProvider: () -> ConnectorMessage): T

interface ConnectorController

abstract val botDefinition: BotDefinition
abstract val connector: Connector
open val connectorType: ConnectorType
open fun errorMessage(playerId: PlayerId, applicationId: String, recipientId: PlayerId): Action
abstract fun handle(event: Event, data: ConnectorData = ConnectorData(ConnectorCallbackBase(event.applicationId, connector.connectorType))): Unit
open fun notify(recipientId: PlayerId, intent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Map<String, String> = emptyMap(), notificationType: ActionNotificationType?, errorListener: (Throwable) -> Unit = {}): Unit
abstract fun registerServices(serviceIdentifier: String, installer: (Router) -> Unit): Unit
open fun storyDefinitionLoader(applicationId: String): (String) -> StoryDefinition
abstract fun support(action: Action, data: ConnectorData = ConnectorData(ConnectorCallbackBase(action.applicationId, connector.connectorType))): Double
abstract fun unregisterServices(): Unit

interface I18nTranslator : I18nKeyProvider

abstract val contextId: String?
abstract val targetConnectorType: ConnectorType
open fun translate(text: CharSequence?, vararg args: Any?): TranslatedSequence
open fun translate(text: CharSequence?, args: List<Any?>): TranslatedSequence
open fun translate(key: I18nLabelValue?): TranslatedSequence
open fun translateAndReturnBlankAsNull(s: CharSequence?): TranslatedSequence?
abstract val userInterfaceType: UserInterfaceType
abstract val userLocale: Locale

object WebSocketController

fun getPushHandler(id: String): ((String) -> Unit)?
fun getReceiveHandler(id: String): ((String) -> Unit)?
fun registerAuthorizedKey(key: String): Unit
fun setReceiveHandler(id: String, handler: (String) -> Unit): Unit
val websocketEnabled: Boolean

package ai.tock.bot.engine.action

abstract class Action : Event

Action(playerId: PlayerId, recipientId: PlayerId, applicationId: String, id: Id<Action>, date: Instant, state: EventState, metadata: ActionMetadata = ActionMetadata())
fun booleanChoice(key: ParameterKey): Boolean
fun choice(key: ParameterKey): String?
fun <reified T : Any> jsonChoice(key: ParameterKey): T?
val metadata: ActionMetadata
val playerId: PlayerId
val recipientId: PlayerId
fun toActionId(): Id<Action>
abstract fun toMessage(): Message

data class ActionMetadata

ActionMetadata(lastAnswer: Boolean = false, priority: ActionPriority = ActionPriority.normal, notificationType: ActionNotificationType? = null, visibility: ActionVisibility = ActionVisibility.UNKNOWN, replyMessage: ActionReply = ActionReply.UNKNOWN, quoteMessage: ActionQuote = ActionQuote.UNKNOWN, orchestrationLock: Boolean = false, orchestratedBy: String? = null)
var lastAnswer: Boolean
var notificationType: ActionNotificationType?
val orchestratedBy: String?
var orchestrationLock: Boolean
var priority: ActionPriority
var quoteMessage: ActionQuote
var replyMessage: ActionReply
var visibility: ActionVisibility

enum class ActionNotificationType

accountUpdate
confirmedEventUpdate
humanAgent
postPurchaseUpdate

enum class ActionPriority

high
normal
urgent

enum class ActionQuote

ISQUOTE
NOQUOTE
UNKNOWN

enum class ActionReply

ISREPLY
NOREPLY
UNKNOWN

enum class ActionVisibility

PRIVATE
PUBLIC
UNKNOWN

enum class Metadata

REPLY
VISIBILITY

open class SendAttachment : Action

SendAttachment(playerId: PlayerId, applicationId: String, recipientId: PlayerId, url: String, type: AttachmentType, id: Id<Action> = newId(), date: Instant = Instant.now(), state: EventState = EventState(), metadata: ActionMetadata = ActionMetadata())
enum class AttachmentType

audio
file
image
video

open fun toMessage(): Message
val type: AttachmentType
val url: String

class SendChoice : Action

SendChoice(playerId: PlayerId, applicationId: String, recipientId: PlayerId, intentName: String, step: StoryStep<out StoryHandlerDefinition>?, parameters: Map<String, String> = emptyMap(), id: Id<Action> = newId(), date: Instant = Instant.now(), state: EventState = EventState(), metadata: ActionMetadata = ActionMetadata())
SendChoice(playerId: PlayerId, applicationId: String, recipientId: PlayerId, intentName: String, parameters: Map<String, String> = emptyMap(), id: Id<Action> = newId(), date: Instant = Instant.now(), state: EventState = EventState(), metadata: ActionMetadata = ActionMetadata())
fun decodeChoice(id: String, senderId: PlayerId, applicationId: String, recipientId: PlayerId, referralParameter: String? = null): Action
fun decodeChoiceId(id: String): Pair<String, Map<String, String>>
fun encodeChoiceId(bus: Bus<*>, intent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Map<String, String> = emptyMap()): String
fun encodeChoiceId(bus: Bus<*>, intent: IntentAware, step: String? = null, parameters: Map<String, String> = emptyMap()): String
fun encodeChoiceId(intent: IntentAware, step: StoryStep<out StoryHandlerDefinition>? = null, parameters: Map<String, String> = emptyMap(), busStep: StoryStep<out StoryHandlerDefinition>? = null, currentIntent: Intent? = null, sourceAppId: String? = null): String
fun encodeChoiceId(intent: IntentAware, step: String?, parameters: Map<String, String>, busStep: String?, currentIntent: Intent?, sourceAppId: String? = null): String
fun encodeNlpChoiceId(text: String): String
const val EXIT_INTENT: String
const val IMAGE_PARAMETER: String
val intentName: String
const val LOGIN_INTENT: String
const val LOGOUT_INTENT: String
const val NLP: String
val parameters: Map<String, String>
const val PHONE_CALL_INTENT: String
const val PREVIOUS_INTENT_PARAMETER: String
const val REFERRAL_PARAMETER: String
val referralParameter: String?
const val SOURCE_APP_ID: String
fun sourceAppId(): String?
fun step(): String?
const val STEP_PARAMETER: String
const val TITLE_PARAMETER: String
fun toEncodedId(): String
fun toMessage(): Message
fun toString(): String
const val URL_PARAMETER: String

class SendLocation : Action

SendLocation(playerId: PlayerId, applicationId: String, recipientId: PlayerId, location: UserLocation?, id: Id<Action> = newId(), date: Instant = Instant.now(), state: EventState = EventState(), metadata: ActionMetadata = ActionMetadata())
val location: UserLocation?
fun toMessage(): Message

open class SendSentence : Action

SendSentence(playerId: PlayerId, applicationId: String, recipientId: PlayerId, text: CharSequence?, messages: MutableList<ConnectorMessage> = mutableListOf(), id: Id<Action> = newId(), date: Instant = Instant.now(), state: EventState = EventState(), metadata: ActionMetadata = ActionMetadata(), nlpStats: NlpCallStats? = null, precomputedNlp: NlpResult? = null)
fun changeConnectorMessage(message: ConnectorMessage): SendSentence
fun hasEmptyText(): Boolean
fun hasMessage(type: ConnectorType): Boolean
fun message(type: ConnectorType): ConnectorMessage?
open val messages: MutableList<ConnectorMessage>
open var nlpStats: NlpCallStats?
val precomputedNlp: NlpResult?
val stringText: String?
val text: CharSequence?
open fun toMessage(): Message
open fun toString(): String

package ai.tock.bot.engine.config

object UploadedFilesService

fun attachmentType(url: String): AttachmentType
fun downloadFile(context: RoutingContext, id: String, suffix: String): Unit
fun getFileContentFromUrl(url: String): ByteArray?
fun guessContentType(fileName: String): String
fun uploadFile(namespace: String, fileName: String, bytes: ByteArray): MediaFileDescriptor?

package ai.tock.bot.engine.dialog

ai.tock.nlp.api.client.model.Entity

infix fun Entity.setTo(value: Value?): EntityValue
infix fun Entity.setTo(text: String): EntityValue

data class ArchivedEntityValue

ArchivedEntityValue(entityValue: EntityValue?, action: Action?, date: Instant = action?.date ?: Instant.now())
val action: Action?
val date: Instant
val entityValue: EntityValue?
fun toString(): String

data class Dialog

Dialog(playerIds: Set<PlayerId>, id: Id<Dialog> = newId(), state: DialogState = DialogState(), stories: MutableList<Story> = mutableListOf(), groupId: String? = null)
val actionsSize: Int
fun allActions(): List<Action>
val currentStory: Story?
val groupId: String?
var id: Id<Dialog>
fun initFromDialog(dialog: Dialog): Dialog
val lastAction: Action?
val lastDateUpdate: Instant
val lastUserAction: Action?
val playerIds: Set<PlayerId>
val snapshots: List<Snapshot>
val state: DialogState
val stories: MutableList<Story>

interface DialogFlowDAO

abstract fun loadApplicationData(namespace: String, botId: String, applicationIds: Set<Id<BotApplicationConfiguration>>, from: ZonedDateTime?, to: ZonedDateTime?, intent: String? = null): ApplicationDialogFlowData
abstract fun saveFlow(bot: BotDefinition, flow: DialogFlowDefinition): Unit
abstract fun search(namespace: String, botId: String, applicationIds: Set<Id<BotApplicationConfiguration>>, from: ZonedDateTime?, to: ZonedDateTime?, intent: String? = null): List<DialogFlowTransitionStatsData>
abstract fun searchByDateWithActionType(namespace: String, botId: String, applicationIds: Set<Id<BotApplicationConfiguration>>, from: ZonedDateTime?, to: ZonedDateTime?, intent: String? = null): Pair<List<DialogFlowTransitionStatsData>, List<String>>
abstract fun searchByDateWithIntent(namespace: String, botId: String, applicationIds: Set<Id<BotApplicationConfiguration>>, from: ZonedDateTime?, to: ZonedDateTime?, intent: String? = null): Pair<List<DialogFlowTransitionStatsData>, List<String>>
abstract fun searchByDateWithStory(namespace: String, botId: String, applicationIds: Set<Id<BotApplicationConfiguration>>, from: ZonedDateTime?, to: ZonedDateTime?, intent: String? = null): Pair<List<DialogFlowTransitionStatsData>, List<String>>

data class DialogState

DialogState(currentIntent: Intent? = null, entityValues: MutableMap<String, EntityStateValue> = mutableMapOf(), context: MutableMap<String, Any> = mutableMapOf(), userLocation: UserLocation? = null, nextActionState: NextUserActionState? = null)
fun changeValue(entity: Entity, newValue: Value?): Unit
fun changeValue(newValue: EntityValue): Unit
fun changeValue(role: String, newValue: EntityValue?): Unit
fun cleanupState(): Unit
val context: MutableMap<String, Any>
var currentIntent: Intent?
val entityValues: MutableMap<String, EntityStateValue>
fun hasEntity(role: String): Boolean
fun hasEntityPredefinedValue(role: String, value: String): Boolean
fun initFromDialogState(dialog: DialogState): DialogState
var nextActionState: NextUserActionState?
fun resetAllEntityValues(): Unit
fun resetState(): Unit
fun resetValue(role: String): Unit
fun setContextValue(name: String, value: Any?): Unit
fun setValue(role: String, value: EntityValue): Unit
fun setValue(entity: Entity, value: Value): Unit
var userLocation: UserLocation?

data class EntityStateValue

EntityStateValue(action: Action, entityValue: EntityValue)
EntityStateValue(entity: Entity, value: Value)
EntityStateValue(currentValue: EntityValue?, currentHistory: MutableList<ArchivedEntityValue> = mutableListOf(), initialUpdate: Instant = now(), stateValueId: Id<EntityStateValue>? = null, oldActionsMap: Map<Id<Action>, Action> = emptyMap())
val hasBeanUpdatedInBus: Boolean
val history: List<ArchivedEntityValue>
val lastUpdate: Instant
val newValues: List<EntityValue>
val penultimateValue: ArchivedEntityValue?
val previousValues: List<ArchivedEntityValue>
val stateValueId: Id<EntityStateValue>?
fun toString(): String
val value: EntityValue?

data class EntityValue

EntityValue(nlpResult: NlpResult, value: NlpEntityValue)
EntityValue(sentence: String, value: NlpEntityValue)
EntityValue(entity: Entity, value: Value?, content: String? = null)
EntityValue(start: Int?, end: Int?, entity: Entity, content: String?, value: Value? = null, evaluated: Boolean = false, subEntities: List<EntityValue> = emptyList(), probability: Double = 1.0, mergeSupport: Boolean = false)
val content: String?
val end: Int?
val entity: Entity
val evaluated: Boolean
val mergeSupport: Boolean
val probability: Double
val start: Int?
val subEntities: List<EntityValue>
fun toString(): String
val value: Value?

data class EventState

EventState(entityValues: MutableList<EntityValue> = mutableListOf(), testEvent: Boolean = false, targetConnectorType: ConnectorType? = null, userInterface: UserInterfaceType? = null, userVerified: Boolean = true, intent: String? = null, step: String? = null, notification: Boolean = false, sourceApplicationId: String? = null)
val entityValues: MutableList<EntityValue>
fun getEntity(role: String): List<EntityValue>
var intent: String?
var notification: Boolean
var sourceApplicationId: String?
var step: String?
var targetConnectorType: ConnectorType?
var testEvent: Boolean
var userInterface: UserInterfaceType?
var userVerified: Boolean

class FlowAnalyticsQuery

FlowAnalyticsQuery(namespace: String, applicationName: String = "", nlpModel: String = "", from: LocalDateTime = LocalDateTime.now().minusDays(7), to: LocalDateTime = LocalDateTime.now())
val applicationName: String
fun formatQuery(): FlowAnalyticsQuery
val from: LocalDateTime
val namespace: String
val nlpModel: String
val to: LocalDateTime

class FlowAnalyticsQueryResult

FlowAnalyticsQueryResult()

data class NextUserActionState

NextUserActionState(intentsQualifiers: Map<out IntentAware, Double>, referenceDate: ZonedDateTime? = null, referenceTimezone: ZoneId? = null, states: Set<String>? = null)
NextUserActionState(vararg intentsQualifiers: Pair<IntentAware, Double>)
NextUserActionState(vararg states: String)
NextUserActionState(intentsQualifiers: List<NlpIntentQualifier>? = null, referenceDate: ZonedDateTime? = null, referenceTimezone: ZoneId? = null, states: Set<String>? = null)
var intentsQualifiers: List<NlpIntentQualifier>?
var referenceDate: ZonedDateTime?
var referenceTimezone: ZoneId?
var states: Set<String>?

data class Snapshot

Snapshot(dialog: Dialog)
Snapshot(storyDefinitionId: String?, intentName: String?, step: String?, entityValues: List<EntityValue>, storyType: AnswerConfigurationType?, storyName: String? = storyDefinitionId, date: Instant = now())
val date: Instant
val entityValues: List<EntityValue>
fun getValue(entity: Entity): EntityValue?
fun hasValue(entity: Entity): Boolean
val intentName: String?
val step: String?
val storyDefinitionId: String?
val storyName: String?
val storyType: AnswerConfigurationType?

data class Story

Story(definition: StoryDefinition, starterIntent: Intent, step: String? = null, actions: MutableList<Action> = mutableListOf())
val actions: MutableList<Action>
fun computeCurrentStep(userTimeline: UserTimeline, dialog: Dialog, action: Action, newIntent: Intent?): Unit
val currentStep: StoryStep<*>?
val definition: StoryDefinition
fun handle(bus: BotBus): Unit
val lastAction: Action?
val lastUserAction: Action?
val starterIntent: Intent
fun support(bus: BotBus): Double
fun supportAction(userTimeline: UserTimeline, dialog: Dialog, action: Action, intent: Intent): Boolean
fun supportIntent(intent: Intent): Boolean

package ai.tock.bot.engine.event

enum class AppRole

primaryReceiver
secondaryReceiver

class ContinuePublicConversationInPrivateEvent : OneToOneEvent

ContinuePublicConversationInPrivateEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String)

class EndConversationEvent : OneToOneEvent

EndConversationEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String)

class EndSessionEvent : Event

EndSessionEvent(userId: PlayerId, applicationId: String)
val userId: PlayerId

abstract class Event

Event(applicationId: String, id: Id<out Event> = newId(), date: Instant = Instant.now(), state: EventState = EventState())
val applicationId: String
val date: Instant
fun hasEntity(role: String): Boolean
fun hasEntityPredefinedValue(role: String, value: String): Boolean
val id: Id<out Event>
val state: EventState

enum class EventType

val action: Boolean
attachment
choice
endConversation
endSession
getAppRoles
location
markSeen
noInput
passThreadControl
referralParamters
requestThreadControl
sentence
startConversation
startSession
subscribing
takeThreadControl
typingOff
typingOn

class GetAppRolesEvent : Event

GetAppRolesEvent(recipientId: PlayerId, applicationId: String, appRoles: Map<String, Set<AppRole>>)
val appRoles: Map<String, Set<AppRole>>
val recipientId: PlayerId
fun toString(): String

class LoginEvent : OneToOneEvent

LoginEvent(userId: PlayerId, recipientId: PlayerId, userToken: String, applicationId: String, previousUserId: PlayerId = userId, checkLogin: Boolean = false)
var checkLogin: Boolean
val previousUserId: PlayerId
val userToken: String

class LogoutEvent : OneToOneEvent

LogoutEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String)

class MarkSeenEvent : Event

MarkSeenEvent(recipientId: PlayerId, applicationId: String)
val recipientId: PlayerId

class MediaStatusEvent : OneToOneEvent

MediaStatusEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String, status: String)
val status: String

class NewDeviceEvent : OneToOneEvent

NewDeviceEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String, status: String)
val status: String

class NoInputEvent : OneToOneEvent

NoInputEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String)

abstract class OneToOneEvent : Event

OneToOneEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String)
val recipientId: PlayerId
val userId: PlayerId

class PassThreadControlEvent : OneToOneEvent

PassThreadControlEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String, newOwnerAppId: String, metadata: String? = null)
val metadata: String?
val newOwnerAppId: String
fun toString(): String

class ReferralParametersEvent : OneToOneEvent

ReferralParametersEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String, ref: String)
val ref: String

class RequestThreadControlEvent : OneToOneEvent

RequestThreadControlEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String, requestOwnerAppId: String, metadata: String? = null)
val metadata: String?
val requestOwnerAppId: String
fun toString(): String

class StartConversationEvent : OneToOneEvent

StartConversationEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String)

class StartSessionEvent : Event

StartSessionEvent(userId: PlayerId, applicationId: String)
val userId: PlayerId

class SubscribingEvent : OneToOneEvent

SubscribingEvent(userId: PlayerId, recipientId: PlayerId, payload: String? = null, applicationId: String)
val payload: String?

class TakeThreadControlEvent : OneToOneEvent

TakeThreadControlEvent(userId: PlayerId, recipientId: PlayerId, applicationId: String, previousOwnerAppId: String, metadata: String? = null)
val metadata: String?
val previousOwnerAppId: String
fun toString(): String

class TypingOffEvent : Event

TypingOffEvent(recipientId: PlayerId, applicationId: String)
val recipientId: PlayerId

class TypingOnEvent : Event

TypingOnEvent(recipientId: PlayerId, applicationId: String)
val recipientId: PlayerId

package ai.tock.bot.engine.feature

enum class DefaultFeatureType : FeatureType

val category: String
DISABLE_BOT

interface FeatureDAO

open fun addFeature(botId: String, namespace: String, enabled: Boolean, type: FeatureType, startDate: ZonedDateTime?, endDate: ZonedDateTime?, applicationId: String? = null): Unit
abstract fun addFeature(botId: String, namespace: String, enabled: Boolean, category: String, name: String, startDate: ZonedDateTime?, endDate: ZonedDateTime?, applicationId: String? = null): Unit
open fun deleteFeature(botId: String, namespace: String, type: FeatureType, applicationId: String? = null): Unit
abstract fun deleteFeature(botId: String, namespace: String, category: String, name: String, applicationId: String? = null): Unit
abstract fun disable(botId: String, namespace: String, category: String, name: String, applicationId: String? = null): Unit
open fun disable(botId: String, namespace: String, type: FeatureType, applicationId: String? = null): Unit
abstract fun enable(botId: String, namespace: String, category: String, name: String, startDate: ZonedDateTime?, endDate: ZonedDateTime?, applicationId: String? = null): Unit
open fun enable(botId: String, namespace: String, type: FeatureType, startDate: ZonedDateTime? = null, endDate: ZonedDateTime? = null, applicationId: String? = null): Unit
abstract fun getFeatures(botId: String, namespace: String): List<FeatureState>
open fun isEnabled(botId: String, namespace: String, type: FeatureType, default: Boolean = false): Boolean
open fun isEnabled(botId: String, namespace: String, category: String, name: String, default: Boolean = false): Boolean
open fun isEnabled(botId: String, namespace: String, type: FeatureType, applicationId: String? = null, default: Boolean = false): Boolean
abstract fun isEnabled(botId: String, namespace: String, category: String, name: String, applicationId: String? = null, default: Boolean = false): Boolean

data class FeatureState

FeatureState(category: String, name: String, enabled: Boolean, startDate: ZonedDateTime?, endDate: ZonedDateTime?, applicationId: String?)
val applicationId: String?
val category: String
val enabled: Boolean
val endDate: ZonedDateTime?
val name: String
val startDate: ZonedDateTime?

interface FeatureType

open val category: String
abstract val name: String

package ai.tock.bot.engine.message

data class ActionWrappedMessage : Message

ActionWrappedMessage(action: Action, delay: Long)
val action: Action
val delay: Long
val eventType: EventType
fun isSimpleMessage(): Boolean
fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId): Action
fun toPrettyString(): String

data class Attachment : Message

Attachment(url: String, type: AttachmentType, delay: Long = 0)
val delay: Long
val eventType: EventType
fun isSimpleMessage(): Boolean
fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId): Action
fun toPrettyString(): String
val type: AttachmentType
val url: String

data class Choice : Message

Choice(intentName: String, step: StoryStep<out StoryHandlerDefinition>, parameters: Map<String, String> = emptyMap(), delay: Long = 0)
Choice(intentName: String, parameters: Map<String, String> = emptyMap(), delay: Long = 0)
val delay: Long
val eventType: EventType
fun fromText(text: String, nlpText: String? = null, imageUrl: String? = null): Choice
val intentName: String
fun isSimpleMessage(): Boolean
val parameters: Map<String, String>
fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId): Action
fun toPrettyString(): String

data class GenericElement

GenericElement(message: GenericMessage)
GenericElement(attachments: List<Attachment> = emptyList(), choices: List<Choice> = emptyList(), texts: Map<String, String> = emptyMap(), locations: List<Location> = emptyList(), metadata: Map<String, String> = emptyMap())
val attachments: List<Attachment>
val choices: List<Choice>
val locations: List<Location>
val metadata: Map<String, String>
val texts: Map<String, String>

data class GenericMessage

GenericMessage(connectorMessage: ConnectorMessage, attachments: List<Attachment> = emptyList(), choices: List<Choice> = emptyList(), texts: Map<String, String> = emptyMap(), locations: List<Location> = emptyList(), metadata: Map<String, String> = emptyMap(), subElements: List<GenericElement> = emptyList())
GenericMessage(connectorType: ConnectorType = ConnectorType.none, attachments: List<Attachment> = emptyList(), choices: List<Choice> = emptyList(), texts: Map<String, String> = emptyMap(), locations: List<Location> = emptyList(), metadata: Map<String, String> = emptyMap(), subElements: List<GenericElement> = emptyList(), connectorMessage: ConnectorMessage? = null)
val attachments: List<Attachment>
val choices: List<Choice>
val connectorType: ConnectorType
fun equals(other: Any?): Boolean
fun hashCode(): Int
val locations: List<Location>
val metadata: Map<String, String>
val subElements: List<GenericElement>
const val SUBTITLE_PARAM: String
const val TEXT_PARAM: String
val texts: Map<String, String>
const val TITLE_PARAM: String

data class Location : Message

Location(location: UserLocation?, delay: Long = 0)
val delay: Long
val eventType: EventType
fun isSimpleMessage(): Boolean
val location: UserLocation?
fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId): Action
fun toPrettyString(): String

interface Message

abstract val delay: Long
abstract val eventType: EventType
open fun isSimpleMessage(): Boolean
open fun obfuscate(): Message
open fun toAction(bus: BotBus): Action
abstract fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId): Action
open fun toPrettyString(): String

data class MessagesList

MessagesList(vararg messages: Message)
MessagesList(messages: List<Message>)
val messages: List<Message>
fun toMessageList(default: CharSequence? = null, bus: BotBus, messageProvider: BotBus.() -> Any?): MessagesList

data class Sentence : Message

Sentence(text: String?, messages: MutableList<ConnectorMessage> = mutableListOf(), userInterface: UserInterfaceType? = null, nlpStatsProvider: (() -> NlpCallStats?)? = null)
Sentence(text: String?, messages: MutableList<GenericMessage> = mutableListOf(), userInterface: UserInterfaceType? = null, delay: Long = 0, nlpStatsProvider: (() -> NlpCallStats?)? = null)
val delay: Long
fun equals(other: Any?): Boolean
val eventType: EventType
fun hashCode(): Int
fun isSimpleMessage(): Boolean
val messages: MutableList<GenericMessage>
fun obfuscate(): Sentence
val text: String?
fun toAction(playerId: PlayerId, applicationId: String, recipientId: PlayerId): Action
fun toPrettyString(): String
val userInterface: UserInterfaceType?

data class Suggestion

Suggestion(title: CharSequence, intent: IntentAware, step: StoryStep<*>? = null, parameters: Parameters = Parameters())
Suggestion(title: CharSequence, intent: IntentAware? = null, parameters: Parameters = Parameters(), step: StoryStep<*>? = null, attributes: Map<String, String> = emptyMap())
val attributes: Map<String, String>
val intent: IntentAware?
val parameters: Parameters
val step: StoryStep<*>?
val title: CharSequence

data class TextWithSuggestions

TextWithSuggestions(text: CharSequence, vararg suggestions: Suggestion?)
TextWithSuggestions(text: CharSequence, suggestions: List<Suggestion> = emptyList(), attributes: Map<String, String> = emptyMap())
val attributes: Map<String, String>
val suggestions: List<Suggestion>
val text: CharSequence

package ai.tock.bot.engine.message.parser

object MessageParser

fun parse(content: String): List<Message>

package ai.tock.bot.engine.monitoring

mu.KLogger

fun KLogger.logError(throwable: Throwable, data: RequestTimerData): Unit
fun KLogger.logError(message: String, data: RequestTimerData): Unit

interface RequestTimer

open fun end(data: RequestTimerData): Unit
open fun error(errorMessage: String, data: RequestTimerData): Unit
open fun start(type: String): RequestTimerData
open fun throwable(throwable: Throwable, data: RequestTimerData): Unit

open class RequestTimerData

RequestTimerData(type: String, start: Long = System.currentTimeMillis(), error: Boolean = false, message: String? = null, throwable: Throwable? = null)
var error: Boolean
var message: String?
val start: Long
var throwable: Throwable?
open fun toString(): String
val type: String

package ai.tock.bot.engine.nlp

object BuiltInKeywordListener : NlpListener

val deleteKeyword: String
val disableKeyword: String
val enableKeyword: String
val endTestContextKeyword: String
fun handleKeyword(sentence: String): Intent?
var keywordRegexp: Regex?
val keywords: MutableSet<String>
val testContextKeyword: String

interface KeywordService

open fun detectKeywordIntent(sentence: String): Intent?
open fun keywordHandler(keyword: String): ((bus: BotBus) -> Unit)?

data class NlpCallStats

NlpCallStats(locale: Locale, intentResult: Intent = Intent.unknown, entityResult: List<EntityValue> = emptyList(), entityResultAfterMerge: List<EntityValue> = emptyList(), nlpQuery: NlpQuery, nlpResult: NlpResult)
val entityResult: List<EntityValue>
val entityResultAfterMerge: List<EntityValue>
val intentResult: Intent
val locale: Locale
val nlpQuery: NlpQuery
val nlpResult: NlpResult
fun obfuscatedRanges(): List<IntRange>

interface NlpController

abstract fun getIntentsByNamespaceAndName(namespace: String, name: String): List<IntentDefinition>?
abstract fun importNlpDump(stream: InputStream): Boolean
abstract fun importNlpPlainDump(dump: ApplicationDump): Boolean
abstract fun importNlpPlainSentencesDump(dump: SentencesDump): Boolean
abstract fun importNlpSentencesDump(stream: InputStream): Boolean
abstract fun markAsUnknown(sentence: SendSentence, userTimeline: UserTimeline, botDefinition: BotDefinition): Unit
abstract fun parseSentence(sentence: SendSentence, userTimeline: UserTimeline, dialog: Dialog, connector: ConnectorController, botDefinition: BotDefinition): Unit
abstract fun waitAvailability(timeToWaitInMs: Long = longProperty("tock_bot_wait_nlp_availability_in_ms", 5000L)): Unit

data class NlpEntityMergeContext

NlpEntityMergeContext(entityRole: String, initialValue: EntityStateValue?, newValues: List<EntityValue>)
val entityRole: String
val initialValue: EntityStateValue?
val newValues: List<EntityValue>

data class NlpIntentStat

NlpIntentStat(intent: Intent, probability: Double)
val intent: Intent
val probability: Double

interface NlpListener

open fun error(query: NlpQuery, dialog: Dialog, throwable: Throwable?): Unit
open fun evaluateEntities(userTimeline: UserTimeline, dialog: Dialog, event: Event, nlpResult: NlpResult): List<EntityValue>
open fun findIntent(userTimeline: UserTimeline, dialog: Dialog, event: Event, nlpResult: NlpResult): IntentAware?
open fun handleKeyword(sentence: String): Intent?
open fun mergeEntityValues(dialogState: DialogState, action: Action, entityToMerge: NlpEntityMergeContext): NlpEntityMergeContext
open fun sortEntitiesToMerge(entities: List<NlpEntityMergeContext>): List<NlpEntityMergeContext>
open fun success(query: NlpQuery, result: NlpResult): Unit

package ai.tock.bot.engine.stt

interface SttListener

abstract fun transform(stt: String, locale: Locale): String

object SttService

fun addListener(listener: SttListener): Unit
fun removeListener(listener: SttListener): Unit
fun transform(stt: String, locale: Locale): String

package ai.tock.bot.engine.user

data class PlayerId

PlayerId(id: String, type: PlayerType = PlayerType.user, clientId: String? = null)
val clientId: String?
fun equals(other: Any?): Boolean
fun hashCode(): Int
val id: String
val type: PlayerType

enum class PlayerType

bot
temporary
user

data class TimeBoxedFlag

TimeBoxedFlag(value: String, expirationDate: Instant? = Instant.now())
val expirationDate: Instant?
fun isValid(): Boolean
val value: String

data class UserLocation

UserLocation(lat: Double, lng: Double)
val lat: Double
val lng: Double

interface UserLock

abstract fun lock(userId: String): Boolean
abstract fun releaseLock(userId: String): Unit

data class UserPreferences

UserPreferences(firstName: String? = null, lastName: String? = null, email: String? = null, timezone: ZoneId = defaultZoneId, locale: Locale = defaultLocale, picture: String? = null, gender: String? = null, test: Boolean = false, initialLocale: Locale = locale)
var email: String?
fun fillWith(userPref: UserPreferences): Unit
var firstName: String?
var gender: String?
var initialLocale: Locale
var lastName: String?
var locale: Locale
var picture: String?
fun refreshWith(userPref: UserPreferences): Unit
var test: Boolean
var timezone: ZoneId

data class UserState

UserState(creationDate: Instant = now(), flags: MutableMap<String, TimeBoxedFlag> = mutableMapOf())
var botDisabled: Boolean
fun cleanup(): Unit
val creationDate: Instant
val flags: MutableMap<String, TimeBoxedFlag>
fun getFlag(flag: String): String?
fun hasFlag(flag: String): Boolean
var profileLoaded: Boolean
fun removeFlag(flag: String): Unit
fun setFlag(flag: String, timeoutInMinutes: Long, value: String): Unit
fun setFlag(flag: String, timeoutDuration: Duration, value: String): Unit
fun setUnlimitedFlag(flag: String, value: String): Unit

class UserTimeline

UserTimeline(playerId: PlayerId, userPreferences: UserPreferences = UserPreferences(), userState: UserState = UserState(), dialogs: MutableList<Dialog> = mutableListOf(), temporaryIds: MutableSet<String> = mutableSetOf())
fun containsBotAction(): Boolean
val currentDialog: Dialog?
val currentStory: Story?
val dialogs: MutableList<Dialog>
val lastAction: Action?
val lastUserAction: Action?
val playerId: PlayerId
val temporaryIds: MutableSet<String>
fun toString(): String
val userPreferences: UserPreferences
val userState: UserState

interface UserTimelineDAO

abstract fun getArchivedEntityValues(stateValueId: Id<EntityStateValue>, oldActionsMap: Map<Id<Action>, Action> = emptyMap()): List<ArchivedEntityValue>
abstract fun getClientDialogs(namespace: String, clientId: String, storyDefinitionProvider: (String) -> StoryDefinition): List<Dialog>
abstract fun getDialogsUpdatedFrom(namespace: String, from: Instant, storyDefinitionProvider: (String) -> StoryDefinition): List<Dialog>
abstract fun getLastStoryId(namespace: String, playerId: PlayerId): String?
abstract fun getSnapshots(dialogId: Id<Dialog>): List<Snapshot>
abstract fun loadByTemporaryIdsWithoutDialogs(namespace: String, temporaryIds: List<String>): List<UserTimeline>
abstract fun loadWithLastValidDialog(namespace: String, userId: PlayerId, priorUserId: PlayerId? = null, groupId: String? = null, storyDefinitionProvider: (String) -> StoryDefinition): UserTimeline
abstract fun loadWithoutDialogs(namespace: String, userId: PlayerId): UserTimeline
abstract fun remove(namespace: String, playerId: PlayerId): Unit
abstract fun removeClient(namespace: String, clientId: String): Unit
abstract fun save(userTimeline: UserTimeline, botDefinition: BotDefinition): Unit
abstract fun save(userTimeline: UserTimeline, namespace: String): Unit
abstract fun updatePlayerId(namespace: String, oldPlayerId: PlayerId, newPlayerId: PlayerId): Unit

package ai.tock.bot.test

fun BotBusMockLog.alexa(): AlexaMessage?
fun ConnectorMessage.asGenericMessage(assertionCreator: Assert<GenericMessage>.() -> Unit): Unit
open class BotBusMock : BotBus

BotBusMock(context: BotBusMockContext, action: Action = context.firstAction)
open val action: Action
fun addActionEntity(contextValue: EntityValue): BotBusMock
fun addActionEntity(entity: Entity, newValue: Value?): BotBusMock
fun addActionEntity(entity: Entity, textContent: String): BotBusMock
val answers: List<BotBusMockLog>
open val applicationId: String
fun applyBotAnswerInterceptor(a: Action): Action
fun assert(vararg messages: ConnectorMessageProvider): Unit
open var botDefinition: BotDefinition
open val botId: PlayerId
val busAnswers: List<BotBusMockLog>
fun checkEndCalled(): BotBusMock
open var connectorData: ConnectorData
var connectorType: ConnectorType
val context: BotBusMockContext
fun createBotSentence(plainText: CharSequence?): SendSentence
open val currentAnswerIndex: Int
open val currentDialog: Dialog
open var dialog: Dialog
open fun end(action: Action, delay: Long): BotBus
open val entities: Map<String, EntityStateValue>
val firstAnswer: BotBusMockLog
val firstBusAnswer: BotBusMockLog
open fun <T> getBusContextValue(name: String): T?
open var i18nProvider: I18nKeyProvider
open var intent: IntentAware?
val lastAnswer: BotBusMockLog
val lastBusAnswer: BotBusMockLog
open fun markAsUnknown(): Unit
open var nextUserActionState: NextUserActionState?
open fun reloadProfile(): Unit
fun run(): BotBusMock
val secondAnswer: BotBusMockLog
val secondBusAnswer: BotBusMockLog
open fun send(action: Action, delay: Long): BotBus
open fun sendAction(action: Action, delay: Long): Unit
open fun sendRawText(plainText: CharSequence?, delay: Long): BotBus
open fun setBusContextValue(key: String, value: Any?): Unit
open var story: Story
open var targetConnectorType: ConnectorType
val thirdAnswer: BotBusMockLog
val thirdBusAnswer: BotBusMockLog
open fun translate(key: I18nLabelValue?): TranslatedSequence
val translator: TranslatorEngine
open val underlyingConnector: Connector
open val userId: PlayerId
open var userInterfaceType: UserInterfaceType
open val userLocale: Locale
open val userPreferences: UserPreferences
open var userTimeline: UserTimeline
open fun withMessage(connectorType: ConnectorType, messageProvider: () -> ConnectorMessage): BotBus
open fun withMessage(connectorType: ConnectorType, connectorId: String, messageProvider: () -> ConnectorMessage): BotBus
open fun withNotificationType(notificationType: ActionNotificationType): BotBus
open fun withPriority(priority: ActionPriority): BotBus
open fun withVisibility(visibility: ActionVisibility): BotBus

data class BotBusMockContext

BotBusMockContext(applicationId: String, userId: PlayerId, botId: PlayerId, botDefinition: BotDefinition, storyDefinition: StoryDefinition, action: Action = SendSentence(userId, applicationId, botId, ""), userInterfaceType: UserInterfaceType = UserInterfaceType.textChat, userPreferences: UserPreferences = UserPreferences(), connectorType: ConnectorType = defaultTestConnectorType, testContext: TestContext = currentTestContext)
BotBusMockContext(botDefinition: BotDefinition, storyDefinition: StoryDefinition, applicationId: String = botDefinition.botId, userId: PlayerId = PlayerId("user"), botId: PlayerId = PlayerId("bot", PlayerType.bot), action: Action = SendSentence(userId, applicationId, botId, ""), userInterfaceType: UserInterfaceType = UserInterfaceType.textChat, userPreferences: UserPreferences = UserPreferences(), connectorType: ConnectorType = defaultTestConnectorType, testContext: TestContext = currentTestContext)
BotBusMockContext(userTimeline: UserTimeline, dialog: Dialog, story: Story, firstAction: Action, botDefinition: BotDefinition, i18nProvider: I18nKeyProvider, userInterfaceType: UserInterfaceType = UserInterfaceType.textChat, connectorType: ConnectorType = defaultTestConnectorType, testContext: TestContext = currentTestContext, snapshots: MutableList<Snapshot> = mutableListOf())
val answers: List<BotBusMockLog>
val applicationId: String
var botDefinition: BotDefinition
val botId: PlayerId
fun choice(intentName: String, vararg parameters: Pair<String, String>): SendChoice
fun choice(intentName: String, step: StoryStep<out StoryHandlerDefinition>, vararg parameters: Pair<String, String>): SendChoice
fun choice(intent: IntentAware, step: StoryStep<out StoryHandlerDefinition>, parameters: Parameters): SendChoice
fun choice(intent: IntentAware, parameters: Parameters = Parameters()): SendChoice
fun choiceOfId(choiceId: String): SendChoice
var connectorType: ConnectorType
var dialog: Dialog
var firstAction: Action
val firstAnswer: BotBusMockLog
var i18nProvider: I18nKeyProvider
val initialUserPreferences: UserPreferences
val lastAnswer: BotBusMockLog
fun resetUserPreferences(userPreferences: UserPreferences): Unit
val secondAnswer: BotBusMockLog
fun sentence(text: String, vararg entityValues: EntityValue): SendSentence
fun sentence(text: String, entityValues: List<EntityValue> = emptyList()): SendSentence
fun sentence(text: String, intent: IntentAware? = null, vararg entityValues: EntityValue): SendSentence
fun sentence(text: String, intent: IntentAware? = null, entityValues: List<EntityValue> = emptyList()): SendSentence
fun sentence(message: ConnectorMessage, vararg entityValues: EntityValue): SendSentence
fun sentence(message: ConnectorMessage, entityValues: List<EntityValue> = emptyList()): SendSentence
fun sentence(message: ConnectorMessage, intent: IntentAware? = null, vararg entityValues: EntityValue): SendSentence
fun sentence(message: ConnectorMessage, intent: IntentAware? = null, entityValues: List<EntityValue> = emptyList()): SendSentence
val snapshots: MutableList<Snapshot>
var story: Story
val testContext: TestContext
val thirdAnswer: BotBusMockLog
val userId: PlayerId
var userInterfaceType: UserInterfaceType
val userPreferences: UserPreferences
var userTimeline: UserTimeline

data class BotBusMockLog

BotBusMockLog(action: Action, delay: Long)
val action: Action
infix fun assert(text: String): <ERROR CLASS>
infix fun assert(message: ConnectorMessageProvider): <ERROR CLASS>
fun assertMessage(message: ConnectorMessage, errorMessage: String? = null): <ERROR CLASS>
fun assertText(text: String, errorMessage: String? = null): <ERROR CLASS>
fun choice(title: String): Choice?
val delay: Long
fun elementChoice(elementIndex: Int, title: String): Choice?
fun genericMessage(): GenericMessage?
fun message(connectorType: ConnectorType): ConnectorMessage?
fun text(): String?

fun busMock(testContext: TestContext = currentTestContext): BotBusMock
ch.tutteli.atrium.creating.AssertionPlant

fun Assert<BotBusMockLog>.asGenericMessage(assertionCreator: Assert<GenericMessage>.() -> Unit): Unit
fun Assert<Attachment>.toBeImage(): AssertionPlant<AttachmentType>
fun Assert<BotBusMockLog>.toBeSimpleTextMessage(expectedText: String): Unit
fun Assert<GenericElement>.toHaveAttachment(assertionCreator: Assert<Attachment>.() -> Unit): AssertionPlant<List<Attachment>>
fun Assert<GenericMessage>.toHaveChoice(title: String, assertionCreator: Assert<Choice>.() -> Unit): AssertionPlant<List<Choice>>
fun Assert<GenericElement>.toHaveChoices(expectedChoice: String, vararg otherExpectedChoices: String): AssertionPlant<List<Choice>>
fun Assert<GenericMessage>.toHaveElement(index: Int, assertionCreator: Assert<GenericElement>.() -> Unit): AssertionPlant<List<GenericElement>>
fun Assert<GenericElement>.toHaveExactlyChoices(expectedChoice: String, vararg otherExpectedChoices: String): AssertionPlant<List<Choice>>
fun Assert<GenericMessage>.toHaveExactlyGlobalChoices(expectedChoice: String, vararg otherExpectedChoices: String): AssertionPlant<List<Choice>>
fun Assert<GenericMessage>.toHaveGlobalChoices(expectedChoice: String, vararg otherExpectedChoices: String): AssertionPlant<List<Choice>>
fun Assert<GenericMessage>.toHaveGlobalText(expectedText: String, textName: String = "text"): AssertionPlant<Map<String, String>>
fun Assert<Choice>.toHaveIntent(intentName: String): Unit
fun Assert<GenericElement>.toHaveNotChoices(unexpectedChoice: String, vararg otherUnexpectedChoices: String): AssertionPlant<List<Choice>>
fun Assert<GenericMessage>.toHaveNotGlobalChoices(unexpectedChoice: String, vararg otherUnexpectedChoices: String): AssertionPlant<List<Choice>>
fun Assert<Choice>.toHaveParameter(key: ParameterKey, value: String): Unit
fun Assert<Choice>.toHaveParameter(key: String, value: String): Unit
fun Assert<GenericElement>.toHaveSubtitle(expectedSubtitle: String): AssertionPlant<Map<String, String>>
fun Assert<GenericElement>.toHaveText(expectedText: String, textName: String): AssertionPlant<Map<String, String>>
fun Assert<GenericElement>.toHaveTitle(expectedTitle: String): AssertionPlant<Map<String, String>>
fun Assert<Choice>.toHaveTitle(title: String): Unit
fun Assert<Attachment>.toHaveUrl(url: String): AssertionPlant<String>

var currentTestContext: TestContext
var defaultTestConnectorType: ConnectorType
fun BotBusMockLog.ga(): GAResponseConnectorMessage?
fun BotBusMockLog.messenger(): MessengerConnectorMessage?
fun BotDefinition.newBusMock(testContext: TestContext = currentTestContext, story: StoryDefinition = testContext.defaultStoryDefinition(this), connectorType: ConnectorType = testContext.defaultConnectorType(), locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId()): BotBusMock
fun BotDefinition.newBusMockContext(testContext: TestContext = currentTestContext, story: StoryDefinition = testContext.defaultStoryDefinition(this), connectorType: ConnectorType = testContext.defaultConnectorType(), locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId(), botId: PlayerId = PlayerId("bot", PlayerType.bot), action: Action = SendSentence(userId, this.botId, botId, ""), userInterfaceType: UserInterfaceType = UserInterfaceType.textChat, userPreferences: UserPreferences = UserPreferences(locale = locale)): BotBusMockContext
fun BotBusMockLog.slack(): SlackConnectorMessage?
fun startBusMock(testContext: TestContext = currentTestContext): BotBusMock
fun BotDefinition.startNewBusMock(testContext: TestContext = currentTestContext, story: StoryDefinition = testContext.defaultStoryDefinition(this), connectorType: ConnectorType = testContext.defaultConnectorType(), locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId()): BotBusMock
open class TestContext

TestContext()
val botAnswerInterceptors: MutableList<BotAnswerInterceptor>
lateinit var botBusMockContext: BotBusMockContext
open fun createTestInjector(): KodeinInjector
open fun defaultConnectorType(): ConnectorType
open fun defaultLocale(): Locale
open fun defaultPlayerId(): PlayerId
open fun defaultStoryDefinition(botDefinition: BotDefinition): StoryDefinition
open fun importModule(): Builder.() -> Unit
var mockedBotApplicationConfigurationDAO: BotApplicationConfigurationDAO
var mockedDialogFlowDAO: DialogFlowDAO
var mockedDialogReportDAO: DialogReportDAO
var mockedFeatureDAO: FeatureDAO
var mockedI18nDAO: I18nDAO
var mockedNlpClient: NlpClient
var mockedNlpController: NlpController
var mockedStoryDefinitionConfigurationDAO: StoryDefinitionConfigurationDAO
var mockedTestPlanDAO: TestPlanDAO
var mockedUserLock: UserLock
var mockedUserReportDAO: UserReportDAO
var mockedUserTimelineDAO: UserTimelineDAO
fun <reified T : Any> newMock(): T
open fun <T : Any> newMock(kClass: KClass<T>): T
val storyHandlerListeners: MutableList<StoryHandlerListener>
val testInjector: KodeinInjector
val testKodein: Kodein

open class TestLifecycle<out T : TestContext>

TestLifecycle(testContext: T)
open fun configureTestIoc(): Unit
open fun end(): Unit
open fun resetInjectors(): Unit
open fun start(): Unit
val testContext: T

val testModules: MutableList<Module>
var testTranslatorModule: Module
fun BotBusMockLog.whatsapp(): WhatsAppBotMessage?

package ai.tock.bot.test.junit

open class TockJUnit4Rule<out T : TestContext>

TockJUnit4Rule(botDefinition: BotDefinition, lifecycle: TestLifecycle<T> = TestLifecycle(TestContext() as T))
open fun apply(base: <ERROR CLASS>, description: <ERROR CLASS>): <ERROR CLASS>
val botDefinition: BotDefinition
fun busMock(): BotBusMock
val lifecycle: TestLifecycle<T>
fun newBusMock(story: StoryDefinition = testContext.defaultStoryDefinition(botDefinition), connectorType: ConnectorType = testContext.defaultConnectorType(), locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId()): BotBusMock
fun newBusMockContext(story: StoryDefinition = testContext.defaultStoryDefinition(botDefinition), connectorType: ConnectorType = testContext.defaultConnectorType(), locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId()): BotBusMockContext
fun startBusMock(): BotBusMock
fun startNewBusMock(story: StoryDefinition = testContext.defaultStoryDefinition(botDefinition), connectorType: ConnectorType = testContext.defaultConnectorType(), locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId()): BotBusMock
val testContext: T

open class TockJUnit5Extension : TockJUnit5ExtensionBase<TestContext>

TockJUnit5Extension(botDefinition: BotDefinition)

open class TockJUnit5ExtensionBase<out T : TestContext>

TockJUnit5ExtensionBase(botDefinition: BotDefinition, lifecycle: TestLifecycle<T> = TestLifecycle(TestContext() as T))
open fun afterEach(context: <ERROR CLASS>): Unit
open fun beforeEach(context: <ERROR CLASS>): Unit
val botDefinition: BotDefinition
fun busMock(): BotBusMock
val lifecycle: TestLifecycle<T>
fun newBusMock(story: StoryDefinition = testContext.defaultStoryDefinition(botDefinition), connectorType: ConnectorType = testContext.defaultConnectorType(), locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId()): BotBusMock
fun newBusMockContext(story: StoryDefinition = testContext.defaultStoryDefinition(botDefinition), connectorType: ConnectorType = testContext.defaultConnectorType(), locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId(), botId: PlayerId = PlayerId("bot", PlayerType.bot), action: Action = SendSentence(userId, botDefinition.botId, botId, ""), userInterfaceType: UserInterfaceType = UserInterfaceType.textChat, userPreferences: UserPreferences = UserPreferences(locale = locale)): BotBusMockContext
fun newChoiceRequest(intent: IntentAware = testContext.defaultStoryDefinition(botDefinition), parameters: Parameters, connectorType: ConnectorType = testContext.defaultConnectorType(), userInterfaceType: UserInterfaceType = connectorType.userInterfaceType, locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId(), botId: PlayerId = PlayerId("bot", PlayerType.bot), userPreferences: UserPreferences = UserPreferences(locale = locale), tests: BotBusMock.() -> Unit): Unit
fun newRequest(text: String = "", intent: IntentAware = testContext.defaultStoryDefinition(botDefinition), vararg entities: EntityValue, connectorType: ConnectorType = testContext.defaultConnectorType(), userInterfaceType: UserInterfaceType = connectorType.userInterfaceType, locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId(), botId: PlayerId = PlayerId("bot", PlayerType.bot), userPreferences: UserPreferences = UserPreferences(locale = locale), tests: BotBusMock.() -> Unit): Unit
fun newRequest(intent: IntentAware = testContext.defaultStoryDefinition(botDefinition), connectorType: ConnectorType = testContext.defaultConnectorType(), userInterfaceType: UserInterfaceType = connectorType.userInterfaceType, locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId(), botId: PlayerId = PlayerId("bot", PlayerType.bot), userPreferences: UserPreferences = UserPreferences(locale = locale), actionProvider: () -> Action, tests: BotBusMock.() -> Unit): Unit
fun selectChoice(busMockLog: BotBusMockLog, buttonTitle: String, tests: BotBusMock.() -> Unit): BotBusMock
fun selectElementChoice(busMockLog: BotBusMockLog, elementIndex: Int, buttonTitle: String, tests: BotBusMock.() -> Unit): BotBusMock
fun send(text: String = "", intent: IntentAware = testContext.defaultStoryDefinition(botDefinition), vararg entities: EntityValue, connectorType: ConnectorType = testContext.defaultConnectorType(), userInterfaceType: UserInterfaceType = connectorType.userInterfaceType, locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId(), botId: PlayerId = PlayerId("bot", PlayerType.bot), userPreferences: UserPreferences = UserPreferences(locale = locale), metadata: ActionMetadata = ActionMetadata(), tests: BotBusMock.() -> Unit): BotBusMock
fun send(intent: IntentAware = testContext.defaultStoryDefinition(botDefinition), connectorType: ConnectorType = testContext.defaultConnectorType(), userInterfaceType: UserInterfaceType = connectorType.userInterfaceType, locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId(), botId: PlayerId = PlayerId("bot", PlayerType.bot), userPreferences: UserPreferences = UserPreferences(locale = locale), actionProvider: () -> Action, tests: BotBusMock.() -> Unit): BotBusMock
fun sendChoice(intent: IntentAware = testContext.defaultStoryDefinition(botDefinition), parameters: Parameters = Parameters(), connectorType: ConnectorType = testContext.defaultConnectorType(), userInterfaceType: UserInterfaceType = connectorType.userInterfaceType, locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId(), botId: PlayerId = PlayerId("bot", PlayerType.bot), userPreferences: UserPreferences = UserPreferences(locale = locale), tests: BotBusMock.() -> Unit): BotBusMock
fun sendMessage(intent: IntentAware = testContext.defaultStoryDefinition(botDefinition), message: Message, connectorType: ConnectorType = testContext.defaultConnectorType(), userInterfaceType: UserInterfaceType = connectorType.userInterfaceType, locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId(), botId: PlayerId = PlayerId("bot", PlayerType.bot), userPreferences: UserPreferences = UserPreferences(locale = locale), tests: BotBusMock.() -> Unit): BotBusMock
fun startBusMock(): BotBusMock
fun startNewBusMock(story: StoryDefinition = testContext.defaultStoryDefinition(botDefinition), connectorType: ConnectorType = testContext.defaultConnectorType(), locale: Locale = testContext.defaultLocale(), userId: PlayerId = testContext.defaultPlayerId()): BotBusMock
val testContext: T

package ai.tock.bot.test.mock

fun StoryDefinitionBase.checkPreconditions(bus: BotBus): Any?
fun mockBus(bus: BotBus = mockk(), test: (BotBus) -> Any?): Unit
inline fun <reified T> mockConnector(connector: T = mockk(relaxed = true), bus: BotBus = mockk(relaxed = true), test: (BotBus) -> Any?): T
fun mockMessenger(bus: BotBus = mockk(), test: (BotBus) -> Any?): Unit
fun mockTwitter(bus: BotBus, test: (BotBus) -> Any?): Unit
fun provideMockedBusCommon(bus: BotBus = mockk()): BotBus
fun provideMockedMessengerBus(bus: BotBus = mockk()): BotBus
fun provideMockedTwitterBus(bus: BotBus): BotBus
fun StoryDefinitionBase.selectStepFromData(def: HandlerDef<*>, data: Any?): StoryStep<*>?
fun StoryDefinitionBase.test(bus: BotBus): Unit

package ai.tock.shared

fun basicAuthInterceptor(login: String, password: String): Interceptor
fun basicCredentialsHeader(login: String, password: String): String
fun booleanProperty(name: String, defaultValue: Boolean): Boolean
fun checkMaxLengthAllowed(text: String): String
com.github.salomonbrys.kodein.KodeinInjector

fun <reified T : Any> KodeinInjector.provide(tag: Any? = null): T
inline fun <reified T : Any> KodeinInjector.provideOrDefault(tag: Any? = null, defaultValueProvider: () -> T): T

com.mongodb.client.FindIterable

fun <T> FindIterable<T>.safeCollation(collation: Collation): FindIterable<T>

com.mongodb.client.MongoCollection

fun <T> MongoCollection<T>.ensureIndex(vararg properties: KProperty<*>, indexOptions: IndexOptions = IndexOptions()): String
fun <T> MongoCollection<T>.ensureIndex(keys: Bson, indexOptions: IndexOptions = IndexOptions()): String
fun <T> MongoCollection<T>.ensureIndex(keys: String, indexOptions: IndexOptions = IndexOptions()): String
fun <T> MongoCollection<T>.ensureUniqueIndex(vararg properties: KProperty<*>, indexOptions: IndexOptions = IndexOptions()): String

com.mongodb.reactivestreams.client.MongoCollection

inline fun <reified T : Any> MongoCollection<T>.watch(fullDocument: FullDocument = FullDocument.DEFAULT, noinline listener: (ChangeStreamDocument<T>) -> Unit): Unit

fun concat(s1: String?, s2: String?): String
const val DEFAULT_APP_NAMESPACE: String
val defaultLocale: Locale
val defaultNamespace: String
val defaultZoneId: ZoneId
val devEnvironment: Boolean
object Dice

fun <T> choose(list: List<T>): T
fun index(col: Collection<*>): Int
fun newId(): String
fun newInt(max: Int): Int

interface Executor

abstract fun executeBlocking(delay: Duration, runnable: () -> Unit): Unit
abstract fun executeBlocking(runnable: () -> Unit): Unit
abstract fun <T> executeBlocking(blocking: Callable<T>, result: (T?) -> Unit): Unit
open fun setPeriodic(delay: Duration, runnable: () -> Unit): Long
abstract fun setPeriodic(initialDelay: Duration, delay: Duration, runnable: () -> Unit): Long

object FontLoader

fun register(fontFilesNames: List<String>, fontFilesPath: String = "/generation/fonts/"): Unit

fun getAsyncDatabase(databaseNameProperty: String): MongoDatabase
fun getDatabase(databaseNameProperty: String): MongoDatabase
enum class ImageFormat

val contentType: String
fun findByCode(code: String): ImageFormat?
PNG
SVG

class ImageGenerator<T : Any>

ImageGenerator(svgToPngConverter: SvgToPngConverter, svgGenerator: SvgGenerator<T>)
fun generate(params: T, format: ImageFormat): ByteArray

interface ImageParametersExtractor<T : Any>

abstract fun extract(params: MultiMap): T?

val injector: KodeinInjector
var internalDefaultZoneId: ZoneId
fun intProperty(name: String, defaultValue: Int): Int
fun isDocumentDB(): Boolean
java.util.Enumeration

fun <T> Enumeration<T>.toSet(): Set<T>

kotlin.collections.Iterable

fun <T, K, V> Iterable<T>.mapNotNullValues(transform: (T) -> Pair<K, V?>): List<Pair<K, V>>
inline fun <T> Iterable<T>.sumByLong(selector: (T) -> Long): Long

kotlin.collections.Iterator

fun <T> Iterator<T>.toList(): List<T>
fun <T> Iterator<T>.toSafeList(): List<T>

kotlin.String

fun String.changeNamespace(newNamespace: String): String
fun String.name(): String
fun String.namespace(): String
fun String.namespaceAndName(): Pair<String, String>
fun String.withNamespace(namespace: String): String
fun String.withoutNamespace(namespace: String? = null): String

enum class Level

BASIC
BODY
HEADERS
NONE

fun listProperty(name: String, defaultValue: List<String>, separator: String = ","): List<String>
object Loader

fun <reified T : Any> loadServices(): List<T>

fun loadProperties(fileInClasspath: String): Properties
fun longProperty(name: String, defaultValue: Long): Long
fun mapListProperty(name: String, defaultValue: Map<String, List<String>>, entrySeparator: String = "|", keyValueSeparator: String = "=", listSeparator: String = ","): Map<String, List<String>>
fun <K, V> mapNotNullValues(vararg pairs: Pair<K, V?>): Map<K, V>
fun mapProperty(name: String, defaultValue: Map<String, String>, entrySeparator: String = "|", keyValueSeparator: String = "="): Map<String, String>
mu.KLogger

fun KLogger.debug(throwable: Throwable): Unit
fun KLogger.error(throwable: Throwable): Unit
fun KLogger.info(throwable: Throwable): Unit
fun KLogger.trace(throwable: Throwable): Unit
fun KLogger.warn(throwable: Throwable): Unit

fun pingMongoDatabase(databaseName: String): Boolean
fun property(name: String, defaultValue: String): String
fun propertyExists(name: String): Boolean
fun propertyOrNull(name: String): String?
fun resource(path: String): URL
fun resourceAsStream(path: String): InputStream
fun resourceAsString(path: String): String
retrofit2.Retrofit

fun <reified T : Any> Retrofit.create(): T

retrofit2.Retrofit.Builder

fun Builder.addJacksonConverter(objectMapper: ObjectMapper = mapper): Builder

fun retrofitBuilderWithTimeoutAndLogger(ms: Long, logger: KLogger = KotlinLogging.logger {}, level: Level = Level.BODY, interceptors: List<Interceptor> = emptyList(), requestGZipEncoding: Boolean = false, circuitBreaker: Boolean = false, proxy: Proxy? = null): Builder
val sharedModule: Module
val supportedLanguages: Map<String, Locale>
abstract class SvgGenerator<T : Any>

SvgGenerator(resourceName: String, resourcePath: String = "/generation/")
abstract fun applyParamsToDocument(doc: Document, params: T): Unit
fun generate(params: T): Document

class SvgToPngConverter

SvgToPngConverter()
fun documentToPngByteArray(doc: Document): ByteArray

@Target([AnnotationTarget.CLASS]) annotation class ThreadSafe

ThreadSafe()

const val TOCK_BOT_DATABASE: String
const val TOCK_CACHE_DATABASE: String
const val TOCK_FRONT_DATABASE: String
const val TOCK_MODEL_DATABASE: String
const val TOCK_NAMESPACE: String
var tockAppDefaultNamespace: String
var tockInternalInjector: KodeinInjector
fun tokenAuthenticationInterceptor(token: String): Interceptor
fun tryToFindLocalIp(): String

package ai.tock.shared.cache

fun <T> getCachedValuesForType(type: String): Map<Id<T>, Any>
fun <T : Any> getFromCache(id: Id<T>, type: String): T?
fun <T : Any> getOrCache(id: Id<T>, type: String, valueProvider: () -> T?): T?
fun <T : Any> putInCache(id: Id<T>, type: String, value: T): Unit
fun <T : Any> removeFromCache(id: Id<T>, type: String): Unit

package ai.tock.shared.jackson

fun addConstrainedTypes(types: Set<KClass<*>>): Unit
data class AnyValueWrapper

AnyValueWrapper(klass: KClass<*>, value: Any?)
AnyValueWrapper(value: Any)
AnyValueWrapper(klass: String, value: Any?)
val klass: String
val value: Any?

com.fasterxml.jackson.core.JsonParser

fun JsonParser.fieldNameWithValueReady(): String?
inline fun <reified FIELDS : Any> JsonParser.read(readValue: (FIELDS, String) -> Unit): FIELDS
fun <reified T : Any> JsonParser.readListValues(): List<T>
fun <reified T : Any> JsonParser.readValue(): T!

com.fasterxml.jackson.databind.module.SimpleModule

fun <T : Any> SimpleModule.addDeserializer(type: KClass<T>, deser: JsonDeserializer<out T>): SimpleModule!
fun <T : Any> SimpleModule.addSerializer(type: KClass<T>, ser: JsonSerializer<in T>): SimpleModule!

data class ConstrainedValueWrapper<T : Any>

ConstrainedValueWrapper(klass: KClass<*>, value: T?)
ConstrainedValueWrapper(value: T)
ConstrainedValueWrapper(klass: String, value: T?)
val klass: String
val value: T?

abstract class JacksonDeserializer<T> : JsonDeserializer<T>

JacksonDeserializer()
object EmptyJson
protected fun JsonParser.readUnknownValue(): EmptyJson

val mapper: ObjectMapper

package ai.tock.shared.security

fun createRequestFilter(allowedIps: Set<String>?, xAuthToken: String?): RequestFilter
fun decrypt(s: String): String
fun encrypt(s: String): String
val encryptionEnabled: Boolean
fun initEncryptor(): Unit
interface MapObfuscator

abstract fun obfuscate(map: Map<String, String>): Map<String, String>

class NoEncryptionPassException : IllegalStateException

NoEncryptionPassException()

interface ObfuscatorService

abstract fun parameterObfuscators(): List<MapObfuscator>
abstract fun stringObfuscators(): List<StringObfuscator>

interface RequestFilter

abstract fun accept(request: HttpServerRequest): Boolean

fun shaS256(s: String): String
data class SimpleObfuscator : StringObfuscator

SimpleObfuscator(regex: Regex, replacement: String)
val regex: Regex
val replacement: String

interface StringObfuscator

open fun obfuscate(text: String): String
abstract val regex: Regex
abstract val replacement: String

object TockObfuscatorService

fun deregisterObfuscators(): Unit
fun obfuscate(texts: List<String>, obfuscatedRanges: Map<Int, List<IntRange>> = emptyMap()): List<String>
fun obfuscate(text: String?, obfuscatedRanges: List<IntRange> = emptyList()): String?
fun obfuscate(map: Map<String, String>): Map<String, String>
fun registerMapObfuscator(vararg newObfuscators: MapObfuscator): Unit
fun registerStringObfuscator(vararg newObfuscators: StringObfuscator): Unit

data class TockUser : AbstractUser

TockUser(user: UserLogin, namespace: String, roles: Set<String>, registered: Boolean = false)
protected fun doIsPermitted(permissionOrRole: String, handler: Handler<AsyncResult<Boolean>>): Unit
val namespace: String
fun principal(): JsonObject
val registered: Boolean
val roles: Set<String>
fun setAuthProvider(authProvider: AuthProvider): Unit
val user: UserLogin

interface TockUserListener

abstract fun registerUser(user: TockUser, joinNamespace: Boolean = false): TockUser

enum class TockUserRole

admin
botUser
nlpUser
technicalAdmin
fun toRole(role: String): TockUserRole?

const val UNKNOWN_USER_LOGIN: String
typealias UserLogin = String

package ai.tock.shared.security.auth

interface TockAuthProvider : AuthProvider

open fun excludedPaths(verticle: WebVerticle): Set<Regex>
abstract fun protectPaths(verticle: WebVerticle, pathsToProtect: Set<String>, sessionHandler: SessionHandler): AuthHandler
open val sessionCookieName: String
open fun toTockUser(context: RoutingContext): TockUser?

package ai.tock.shared.security.mongo

interface MongoCredentialsProvider

abstract fun getCredentials(): MongoCredential?

package ai.tock.shared.vertx

class BadRequestException : RestException

BadRequestException(message: String)

var defaultVertxOptions: VertxOptions
fun detailedHealthcheck(tasks: List<Pair<String, () -> Boolean>> = listOf(), selfCheck: () -> Boolean = { true }): (RoutingContext) -> Unit
data class DetailedHealthcheckResults

DetailedHealthcheckResults(results: List<TaskResult>)
val results: List<TaskResult>

class ImageGeneratorHandler<T : Any> : Handler<RoutingContext>

ImageGeneratorHandler(imageGenerator: ImageGenerator<T>, paramExtractor: ImageParametersExtractor<T>, executor: Executor = injector.provide())
fun handle(context: RoutingContext): Unit

io.vertx.core.Vertx

fun <T> Vertx.blocking(blockingHandler: (Promise<T>) -> Unit, resultHandler: (AsyncResult<T>) -> Unit): Unit

io.vertx.ext.web.Route

fun Route.blocking(handler: (RoutingContext) -> Unit): Route

class NotFoundException : RestException

NotFoundException()

interface RequestLogger

abstract fun log(context: RoutingContext, data: Any?, error: Boolean = false): Unit

open class RestException : Exception

RestException(message: String, code: Int = 500)
val code: Int

data class TaskResult

TaskResult(id: String, status: String)
val id: String
val status: String

class UnauthorizedException : RestException

UnauthorizedException()

val vertx: Vertx
abstract class WebVerticle : AbstractVerticle

WebVerticle()
fun addAuth(authProvider: TockAuthProvider = defaultAuthProvider(), pathsToProtect: Set<String> = protectedPaths().map { "$it/*" }.toSet()): Unit
protected open fun addDevCorsHandler(): Unit
open val authenticatePath: String
protected open fun authProvider(): TockAuthProvider?
fun badRequest(message: String): Nothing
open val basePath: String
fun blocking(method: HttpMethod, path: String, role: TockUserRole? = defaultRole(), basePath: String = rootPath, handler: (RoutingContext) -> Unit): Unit
fun blockingDelete(path: String, role: TockUserRole? = defaultRole(), logger: RequestLogger = defaultRequestLogger, handler: (RoutingContext) -> Unit): Unit
protected fun blockingGet(path: String, role: TockUserRole? = defaultRole(), basePath: String = rootPath, handler: (RoutingContext) -> String): Unit
protected fun blockingJsonDelete(path: String, role: TockUserRole? = defaultRole(), logger: RequestLogger = defaultRequestLogger, handler: (RoutingContext) -> Boolean): Unit
fun <O> blockingJsonGet(path: String, role: TockUserRole? = defaultRole(), handler: (RoutingContext) -> O): Unit
inline fun <reified I : Any, O> blockingJsonPost(path: String, role: TockUserRole? = defaultRole(), logger: RequestLogger = defaultRequestLogger, crossinline handler: (RoutingContext, I) -> O): Unit
protected inline fun <reified I : Any, O> blockingJsonPut(path: String, role: TockUserRole? = defaultRole(), logger: RequestLogger = defaultRequestLogger, crossinline handler: (RoutingContext, I) -> O): Unit
protected fun blockingPost(path: String, role: TockUserRole? = defaultRole(), logger: RequestLogger = defaultRequestLogger, handler: (RoutingContext) -> Unit): Unit
protected inline fun <O> blockingUploadBinaryPost(path: String, role: TockUserRole? = defaultRole(), crossinline handler: (RoutingContext, Pair<String, ByteArray>) -> O): Unit
protected inline fun <reified F : Any, O> blockingUploadJsonPost(path: String, role: TockUserRole? = defaultRole(), logger: RequestLogger = defaultRequestLogger, crossinline handler: (RoutingContext, F) -> O): Unit
protected inline fun <O> blockingUploadPost(path: String, role: TockUserRole? = defaultRole(), logger: RequestLogger = defaultRequestLogger, crossinline handler: (RoutingContext, String) -> O): Unit
inline fun <reified I : Any, O> blockingWithBodyJson(method: HttpMethod, path: String, role: TockUserRole?, logger: RequestLogger = defaultRequestLogger, crossinline handler: (RoutingContext, I) -> O): Unit
protected fun bodyHandler(): BodyHandler
abstract fun configure(): Unit
fun corsHandler(origin: String = "*", allowCredentials: Boolean = false, allowedMethods: Set<HttpMethod> = EnumSet.of(GET, POST, PUT, DELETE), allowedHeaders: Set<String> = listOfNotNull( "X-Requested-With", "Access-Control-Allow-Origin", if (allowCredentials) "Authorization" else null, "Content-Type" ).toSet()): CorsHandler
protected open fun defaultAuthProvider(): TockAuthProvider
protected open val defaultCorsOrigin: String
protected open val defaultCorsWithCredentials: Boolean
open fun defaultErrorHandler(statusCode: Int): Handler<RoutingContext>
open fun defaultHealthcheck(): (RoutingContext) -> Unit
protected open val defaultPort: Int
val defaultRequestLogger: RequestLogger
open fun defaultRole(): TockUserRole?
open fun detailedHealthcheck(): (RoutingContext) -> Unit
fun RoutingContext.endJson(success: Boolean): Unit
fun RoutingContext.endJson(result: Any?): Unit
fun HttpServerResponse.endJson(result: Any?): Unit
protected fun RoutingContext.executeBlocking(handler: (RoutingContext) -> Unit): Unit
fun RoutingContext.firstQueryParam(name: String): String?
open fun healthcheck(): (RoutingContext) -> Unit
open val healthcheckPath: String?
fun RoutingContext.isAuthorized(role: TockUserRole, resultHandler: (AsyncResult<Boolean>) -> Unit): Any
protected inline fun <reified I : Any, O> jsonPost(path: String, role: TockUserRole? = defaultRole(), crossinline handler: (RoutingContext, I, Handler<O>) -> Unit): Unit
open fun livenesscheck(): (RoutingContext) -> Unit
open val livenesscheckPath: String?
open val logger: KLogger
open val logoutPath: String
fun notFound(): Nothing
val RoutingContext.organization: String
fun RoutingContext.path(name: String): String
fun <T> RoutingContext.pathId(name: String): Id<T>
fun RoutingContext.pathToLocale(name: String): Locale
protected open fun protectedPaths(): Set<String>
fun <T> RoutingContext.queryId(name: String): Id<T>?
fun readBytes(upload: FileUpload): ByteArray
open fun readinesscheck(): (RoutingContext) -> Unit
open val readinesscheckPath: String?
fun <reified T : Any> RoutingContext.readJson(): T
fun <reified T : Any> readJson(upload: FileUpload): T
fun readString(upload: FileUpload): String
protected fun register(method: HttpMethod, path: String, role: TockUserRole? = defaultRole(), basePath: String = rootPath, handler: (RoutingContext) -> Unit): Unit
protected open val rootPath: String
val router: Router
protected val server: HttpServer
open fun start(promise: Promise<Void>): Unit
protected open fun startServer(promise: Promise<Void>): Unit
protected open fun startServer(promise: Promise<Void>, port: Int): Unit
open fun stop(stopFuture: Future<Void>?): Unit
fun RoutingContext.success(): Unit
fun unauthorized(): Nothing
val RoutingContext.user: TockUser?
val RoutingContext.userLogin: String
protected fun verticleBooleanProperty(propertyName: String, defaultValue: Boolean): Boolean
protected fun verticleIntProperty(propertyName: String, defaultValue: Int): Int
protected fun verticleLongProperty(propertyName: String, defaultValue: Long): Long
protected fun verticleProperty(propertyName: String, defaultValue: String): String
protected inline fun <reified I : Any, O> withBodyJson(method: HttpMethod, path: String, role: TockUserRole?, crossinline handler: (RoutingContext, I, Handler<O>) -> Unit): Unit