@cognigy/rest-api-client 0.12.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (277) hide show
  1. package/.eslintignore +15 -0
  2. package/.eslintrc.json +28 -0
  3. package/.prettierrc.json +7 -0
  4. package/build/GenericAPIFn.js +3 -3
  5. package/build/GenericUploadFn.js +8 -5
  6. package/build/PluginBase.js +1 -1
  7. package/build/RestAPIClient.js +1 -1
  8. package/build/apigroups/AdministrationAPIGroup_2_0.js +53 -47
  9. package/build/apigroups/AnalyticsAPIGroup_2_0.js +1 -1
  10. package/build/apigroups/ExternalAPIGroup_2_0.js +5 -5
  11. package/build/apigroups/InsightsAPIGroup_2_0.js +17 -12
  12. package/build/apigroups/ManagementAPIGroup_2_0.js +19 -15
  13. package/build/apigroups/MetricsAPIGroup_2_0.js +29 -29
  14. package/build/apigroups/ResourcesAPIGroup_2_0.js +238 -186
  15. package/build/apigroups/SessionsAPIGroup_2_0.js +7 -7
  16. package/build/authentication/ApiKey/ApiKeyAuthentication.js +1 -1
  17. package/build/authentication/AuthenticationAPI.js +2 -2
  18. package/build/authentication/BasicAuthentication/BasicAuthentication.js +2 -2
  19. package/build/authentication/OAuth2/IOAuth2ErrorResponse.js +1 -1
  20. package/build/authentication/OAuth2/OAuth2Authentication.js +34 -27
  21. package/build/connector/AxiosAdapter.js +28 -24
  22. package/build/connector/isRetryAllowed.js +0 -1
  23. package/build/connector/retryAfterDelay.js +3 -3
  24. package/build/shared/{interfaces/debugEvents/TSessionStateEmitParams.js → api/liveAgent/liveAgentInterfaces.js} +1 -1
  25. package/build/shared/charts/descriptors/allFields.js +1 -1
  26. package/build/shared/charts/descriptors/{profile → analytics}/activateProfile.js +2 -2
  27. package/build/shared/charts/descriptors/{profile → analytics}/blindMode.js +11 -4
  28. package/build/shared/charts/descriptors/{profile → analytics}/completeGoal.js +2 -2
  29. package/build/shared/charts/descriptors/{profile → analytics}/deactivateProfile.js +2 -2
  30. package/build/shared/charts/descriptors/{profile → analytics}/deleteProfile.js +2 -2
  31. package/build/shared/charts/descriptors/{profile → analytics}/index.js +0 -0
  32. package/build/shared/charts/descriptors/{profile → analytics}/mergeProfile.js +2 -2
  33. package/build/shared/charts/descriptors/{profile → analytics}/overwriteAnalytics.js +6 -3
  34. package/build/shared/charts/descriptors/{profile → analytics}/requestRating.js +2 -2
  35. package/build/shared/charts/descriptors/{profile → analytics}/setRating.js +2 -2
  36. package/build/shared/charts/descriptors/{profile → analytics}/updateProfile.js +2 -2
  37. package/build/shared/charts/descriptors/apps/getAppSessionPin.js +46 -0
  38. package/build/shared/charts/descriptors/apps/index.js +7 -1
  39. package/build/shared/charts/descriptors/apps/initAppSession.js +467 -12
  40. package/build/shared/charts/descriptors/apps/setAdaptiveCardAppState.js +79 -0
  41. package/build/shared/charts/descriptors/apps/setAppState.js +13 -15
  42. package/build/shared/charts/descriptors/apps/setHtmlAppState.js +108 -0
  43. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/amazonStorageProviderConnection.js +14 -0
  44. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/azureBlobStorageProviderConnection.js +13 -0
  45. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/googleCloudStorageProviderConnection.js +13 -0
  46. package/build/shared/charts/descriptors/connectionNodes/internalStorageProviders/index.js +23 -0
  47. package/build/shared/charts/descriptors/connectionNodes/mongoDB/aggregate.js +1 -1
  48. package/build/shared/charts/descriptors/connectionNodes/mongoDB/find.js +1 -1
  49. package/build/shared/charts/descriptors/connectionNodes/mongoDB/findOne.js +1 -1
  50. package/build/shared/charts/descriptors/connectionNodes/mongoDB/index.js +1 -1
  51. package/build/shared/charts/descriptors/connectionNodes/mongoDB/insert.js +1 -1
  52. package/build/shared/charts/descriptors/connectionNodes/mongoDB/remove.js +1 -1
  53. package/build/shared/charts/descriptors/connectionNodes/mongoDB/updateMany.js +1 -1
  54. package/build/shared/charts/descriptors/connectionNodes/mongoDB/updateOne.js +1 -1
  55. package/build/shared/charts/descriptors/connectionNodes/smtp/emailNotification.js +2 -2
  56. package/build/shared/charts/descriptors/connectionNodes/smtp/index.js +1 -1
  57. package/build/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js +2 -2
  58. package/build/shared/charts/descriptors/connectionNodes/sql/index.js +1 -1
  59. package/build/shared/charts/descriptors/connectionNodes/sql/runQuery.js +1 -1
  60. package/build/shared/charts/descriptors/connectionNodes/sql/runStoredProcedure.js +1 -1
  61. package/build/shared/charts/descriptors/connectionNodes/sql/runTransaction.js +1 -1
  62. package/build/shared/charts/descriptors/data/addToContext.js +1 -1
  63. package/build/shared/charts/descriptors/data/code.js +1 -1
  64. package/build/shared/charts/descriptors/data/copyDataToContext.js +1 -1
  65. package/build/shared/charts/descriptors/data/copySlotsToContext.js +1 -1
  66. package/build/shared/charts/descriptors/data/log.js +1 -1
  67. package/build/shared/charts/descriptors/data/removeFromContext.js +1 -1
  68. package/build/shared/charts/descriptors/data/resetContext.js +1 -1
  69. package/build/shared/charts/descriptors/end.js +1 -1
  70. package/build/shared/charts/descriptors/index.js +25 -16
  71. package/build/shared/charts/descriptors/liveAgent/assistInfo.js +195 -0
  72. package/build/shared/charts/descriptors/liveAgent/index.js +6 -0
  73. package/build/shared/charts/descriptors/liveAgent/utils/buildCognigyWhisperAssistResponse.js +135 -0
  74. package/build/shared/charts/descriptors/liveAgent/utils/index.js +6 -0
  75. package/build/shared/charts/descriptors/logic/disableSlotFillers.js +1 -1
  76. package/build/shared/charts/descriptors/logic/enableSlotFillers.js +1 -1
  77. package/build/shared/charts/descriptors/logic/executeFlow.js +1 -1
  78. package/build/shared/charts/descriptors/logic/goTo.js +1 -1
  79. package/build/shared/charts/descriptors/logic/if/else.js +1 -1
  80. package/build/shared/charts/descriptors/logic/if/if.js +1 -1
  81. package/build/shared/charts/descriptors/logic/if/then.js +1 -1
  82. package/build/shared/charts/descriptors/logic/interval/elseInterval.js +1 -1
  83. package/build/shared/charts/descriptors/logic/interval/interval.js +1 -1
  84. package/build/shared/charts/descriptors/logic/interval/onInterval.js +1 -1
  85. package/build/shared/charts/descriptors/logic/once/afterwards.js +1 -1
  86. package/build/shared/charts/descriptors/logic/once/onFirstExecution.js +1 -1
  87. package/build/shared/charts/descriptors/logic/once/once.js +1 -1
  88. package/build/shared/charts/descriptors/logic/resetState.js +1 -1
  89. package/build/shared/charts/descriptors/logic/setState.js +1 -1
  90. package/build/shared/charts/descriptors/logic/setTranslation.js +1 -1
  91. package/build/shared/charts/descriptors/logic/sleep.js +1 -1
  92. package/build/shared/charts/descriptors/logic/stop.js +1 -1
  93. package/build/shared/charts/descriptors/logic/switch/case.js +1 -1
  94. package/build/shared/charts/descriptors/logic/switch/default.js +1 -1
  95. package/build/shared/charts/descriptors/logic/switch/switch.js +22 -8
  96. package/build/shared/charts/descriptors/logic/switchLocale.js +1 -1
  97. package/build/shared/charts/descriptors/logic/think.js +1 -1
  98. package/build/shared/charts/descriptors/logic/thinkV2.js +1 -1
  99. package/build/shared/charts/descriptors/logic/wait.js +1 -1
  100. package/build/shared/charts/descriptors/message/checkChannelChange/checkChannelChange.js +1 -1
  101. package/build/shared/charts/descriptors/message/checkChannelChange/onNo.js +1 -1
  102. package/build/shared/charts/descriptors/message/checkChannelChange/onYes.js +1 -1
  103. package/build/shared/charts/descriptors/message/checkChannelChange/unchanged.js +1 -1
  104. package/build/shared/charts/descriptors/message/datePicker.js +5 -5
  105. package/build/shared/charts/descriptors/message/question/onAnswer.js +1 -1
  106. package/build/shared/charts/descriptors/message/question/onQuestion.js +1 -1
  107. package/build/shared/charts/descriptors/message/question/optionalQuestion.js +2 -2
  108. package/build/shared/charts/descriptors/message/question/question.js +201 -24
  109. package/build/shared/charts/descriptors/message/question/utils/datepickerUtils.js +31 -2
  110. package/build/shared/charts/descriptors/message/question/utils/evaluateQuestionAnswer.js +4 -1
  111. package/build/shared/charts/descriptors/message/question/utils/questionHandover.js +13 -0
  112. package/build/shared/charts/descriptors/message/say.js +10 -4
  113. package/build/shared/charts/descriptors/message/sendImage.js +1 -1
  114. package/build/shared/charts/descriptors/message/sendText.js +1 -1
  115. package/build/shared/charts/descriptors/microsoft/getToken.js +1 -1
  116. package/build/shared/charts/descriptors/microsoft/index.js +1 -1
  117. package/build/shared/charts/descriptors/microsoft/invalidateToken.js +1 -1
  118. package/build/shared/charts/descriptors/microsoft/tokenStatus/index.js +1 -1
  119. package/build/shared/charts/descriptors/microsoft/tokenStatus/tokenGranted.js +1 -1
  120. package/build/shared/charts/descriptors/microsoft/tokenStatus/tokenNotGranted.js +1 -1
  121. package/build/shared/charts/descriptors/nlu/addLexiconKeyphrase.js +1 -1
  122. package/build/shared/charts/descriptors/nlu/executeCognigyNLU.js +18 -3
  123. package/build/shared/charts/descriptors/nlu/extractAnswer.js +1 -1
  124. package/build/shared/charts/descriptors/nlu/fuzzySearch.js +2 -2
  125. package/build/shared/charts/descriptors/nlu/matchPattern.js +13 -4
  126. package/build/shared/charts/descriptors/nlu/regexSlotFiller.js +1 -1
  127. package/build/shared/charts/descriptors/nlu/utils/patternMatcher.js +129 -61
  128. package/build/shared/charts/descriptors/placeholder.js +1 -1
  129. package/build/shared/charts/descriptors/requiredFields.js +1 -1
  130. package/build/shared/charts/descriptors/service/checkAgentAvailability.js +203 -0
  131. package/build/shared/charts/descriptors/service/handover.js +1 -1
  132. package/build/shared/charts/descriptors/service/handoverV2.js +66 -3
  133. package/build/shared/charts/descriptors/service/httpRequest.js +16 -5
  134. package/build/shared/charts/descriptors/service/index.js +3 -1
  135. package/build/shared/charts/descriptors/service/triggerFunction/onScheduled.js +1 -1
  136. package/build/shared/charts/descriptors/service/triggerFunction/onSchedulingError.js +1 -1
  137. package/build/shared/charts/descriptors/service/triggerFunction/triggerFunction.js +1 -1
  138. package/build/shared/charts/descriptors/start.js +1 -1
  139. package/build/shared/charts/descriptors/voice/index.js +20 -0
  140. package/build/shared/charts/descriptors/voice/interface/IAudioCodes.js +3 -0
  141. package/build/shared/charts/descriptors/voice/interface/IVoiceGateway2.js +3 -0
  142. package/build/shared/charts/descriptors/voice/mappers/hangup.mapper.js +59 -0
  143. package/build/shared/charts/descriptors/voice/mappers/play.mapper.js +99 -0
  144. package/build/shared/charts/descriptors/voice/mappers/setSessionConfig.mapper.js +296 -0
  145. package/build/shared/charts/descriptors/voice/mappers/transfer.mapper.js +86 -0
  146. package/build/shared/charts/descriptors/voice/nodes/bargeIn.js +60 -0
  147. package/build/shared/charts/descriptors/voice/nodes/continuousAsr.js +72 -0
  148. package/build/shared/charts/descriptors/voice/nodes/dtmf.js +86 -0
  149. package/build/shared/charts/descriptors/voice/nodes/hangup.js +48 -0
  150. package/build/shared/charts/descriptors/voice/nodes/noUserInput.js +105 -0
  151. package/build/shared/charts/descriptors/voice/nodes/play.js +95 -0
  152. package/build/shared/charts/descriptors/voice/nodes/sessionSpeechParameters.js +105 -0
  153. package/build/shared/charts/descriptors/voice/nodes/transfer.js +114 -0
  154. package/build/shared/charts/descriptors/voice/utils/constants.js +8 -0
  155. package/build/shared/charts/descriptors/voice/utils/design.js +5 -0
  156. package/build/shared/charts/descriptors/voice/utils/helper.js +11 -0
  157. package/build/shared/charts/descriptors/voicegateway/index.js +1 -1
  158. package/build/shared/charts/descriptors/voicegateway/nodes/agentAssist.js +1 -1
  159. package/build/shared/charts/descriptors/voicegateway/nodes/callRecording.js +1 -1
  160. package/build/shared/charts/descriptors/voicegateway/nodes/handover.js +18 -32
  161. package/build/shared/charts/descriptors/voicegateway/nodes/hangup.js +11 -20
  162. package/build/shared/charts/descriptors/voicegateway/nodes/playURL.js +14 -29
  163. package/build/shared/charts/descriptors/voicegateway/nodes/sendMessage.js +4 -4
  164. package/build/shared/charts/descriptors/voicegateway/nodes/sendMetaData.js +1 -1
  165. package/build/shared/charts/descriptors/voicegateway/nodes/setSessionParams.js +4 -4
  166. package/build/shared/charts/descriptors/voicegateway/utils/paramUtils.js +25 -5
  167. package/build/shared/charts/descriptors/voicegateway2/index.js +6 -2
  168. package/build/shared/charts/descriptors/voicegateway2/nodes/dtmf.js +9 -5
  169. package/build/shared/charts/descriptors/voicegateway2/nodes/hangup.js +17 -19
  170. package/build/shared/charts/descriptors/voicegateway2/nodes/play.js +19 -105
  171. package/build/shared/charts/descriptors/voicegateway2/nodes/refer.js +73 -14
  172. package/build/shared/charts/descriptors/voicegateway2/nodes/sendMetadata.js +64 -0
  173. package/build/shared/charts/descriptors/voicegateway2/nodes/setSessionConfig.js +95 -325
  174. package/build/shared/charts/descriptors/voicegateway2/nodes/transfer.js +99 -0
  175. package/build/shared/charts/descriptors/voicegateway2/utils/constants.js +7 -0
  176. package/build/shared/charts/descriptors/voicegateway2/utils/helper.js +39 -0
  177. package/build/shared/constants.js +3 -1
  178. package/build/shared/errors/baseError.js +2 -2
  179. package/build/shared/handoverClients/interfaces/TAnyProviderResponse.js +3 -0
  180. package/build/shared/handoverClients/interfaces/THandoverEventType.js +12 -0
  181. package/build/shared/helper/BaseContext.js +1 -1
  182. package/build/shared/helper/defaultDatepickerFunction.js +13 -0
  183. package/build/shared/helper/rest/query-string/index.js +5 -5
  184. package/build/shared/helper/rest/query.js +0 -0
  185. package/build/shared/interfaces/IApiKey.js +1 -1
  186. package/build/shared/interfaces/IOrganisation.js +21 -2
  187. package/build/shared/interfaces/IProfile.js +1 -1
  188. package/build/shared/interfaces/ISayNodeSettings.js +3 -0
  189. package/build/shared/interfaces/ai.js +0 -1
  190. package/build/shared/interfaces/amazonLexV2Interface.js +3 -0
  191. package/build/shared/interfaces/amqpInterface.js +1 -1
  192. package/build/shared/interfaces/analytics/IAnalyticsRating.js +13 -0
  193. package/build/shared/interfaces/analytics/IStepEvent.js +2 -0
  194. package/build/shared/interfaces/fileStorage.js +23 -0
  195. package/build/shared/interfaces/handover.js +74 -4
  196. package/build/shared/interfaces/journeys/IJourney.js +1 -1
  197. package/build/shared/interfaces/management/deleteOrganisation/deleteOrganisationTypes.js +3 -0
  198. package/build/shared/interfaces/messageAPI/analytics.js +3 -0
  199. package/build/shared/interfaces/messageAPI/endpoints.js +89 -3
  200. package/build/shared/interfaces/messageAPI/handover.js +270 -0
  201. package/build/shared/interfaces/resources/IAppTemplate.js +24 -0
  202. package/build/shared/interfaces/resources/IAuditEvent.js +25 -2
  203. package/build/shared/interfaces/resources/IChart.js +2 -1
  204. package/build/shared/interfaces/resources/IChartNode.js +3 -2
  205. package/build/shared/interfaces/resources/IConnection.js +1 -1
  206. package/build/shared/interfaces/resources/IConnectionSchema.js +1 -1
  207. package/build/shared/interfaces/resources/IEndpoint.js +2 -0
  208. package/build/shared/interfaces/resources/IExtension.js +17 -0
  209. package/build/shared/interfaces/resources/IFile.js +1 -1
  210. package/build/shared/interfaces/resources/IFlow.js +10 -2
  211. package/build/shared/interfaces/resources/IFlowState.js +1 -1
  212. package/build/shared/interfaces/resources/IFunctionInstance.js +1 -1
  213. package/build/shared/interfaces/resources/IHandoverConfiguration.js +13 -0
  214. package/build/shared/interfaces/resources/ILexicon.js +1 -1
  215. package/build/shared/interfaces/resources/ILexiconEntry.js +1 -1
  216. package/build/shared/interfaces/resources/INodeDescriptorSet.js +5 -1
  217. package/build/shared/interfaces/resources/IOrganisationDeletion.js +10 -0
  218. package/build/shared/interfaces/resources/IPlaybookRun.js +7 -7
  219. package/build/shared/interfaces/resources/IProject.js +14 -1
  220. package/build/shared/interfaces/resources/IRemoveDuplicatedSlotsAndUpdateLexionEntries.js +3 -0
  221. package/build/shared/interfaces/resources/TNLUConnectorType.js +1 -0
  222. package/build/shared/interfaces/resources/TRestChannelType.js +5 -0
  223. package/build/shared/interfaces/resources/TSocketChannelType.js +5 -5
  224. package/build/shared/interfaces/resources/TWebhookChannelType.js +10 -0
  225. package/build/shared/interfaces/resources/intent/IIntent.js +26 -8
  226. package/build/shared/interfaces/resources/intent/IIntentTrainGroup.js +19 -1
  227. package/build/shared/interfaces/resources/settings/IAgentSettings.js +47 -6
  228. package/build/shared/interfaces/resources/settings/IFlowSettings.js +20 -2
  229. package/build/shared/interfaces/resources/settings/ISharedSettings.js +5 -1
  230. package/build/shared/interfaces/resources/yesNoIntent/IYesNoItem.js +9 -0
  231. package/build/shared/interfaces/resources/yesNoIntent/index.js +3 -0
  232. package/build/shared/interfaces/restAPI/administration/liveAgent/v2.0/IUpdateCognigyLiveAgentInboxRest_2_0.js +3 -0
  233. package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IReadCollectionsToBeDeletedRest_2_0.js +21 -0
  234. package/build/shared/interfaces/restAPI/administration/organisations/v2.0/IRequestOrganisationDeletionRest_2_0.js +3 -0
  235. package/build/shared/interfaces/restAPI/administration/organisations/v2.0/index.js +3 -0
  236. package/build/shared/interfaces/restAPI/audio/v2.0/IAudioPreviewLanguages_2_0.js +3 -0
  237. package/build/shared/interfaces/restAPI/audio/v2.0/IAudioPreviewRest_2_0.js +3 -0
  238. package/build/shared/interfaces/restAPI/audio/v2.0/IIndexAudioPreviewLanguages_2_0.js +4 -0
  239. package/build/shared/interfaces/restAPI/audio/v2.0/ITestVoiceProviderRest_2_0.js +3 -0
  240. package/build/shared/interfaces/restAPI/audio/v2.0/ITestVoiceProvider_2_0.js +3 -0
  241. package/build/shared/interfaces/restAPI/audio/v2.0/IVGCallSettings_2_0.js +4 -0
  242. package/build/shared/interfaces/restAPI/audio/v2.0/IVoicePrepareCallRest_2_0.js +3 -0
  243. package/build/shared/interfaces/restAPI/audio/v2.0/IVoicePrepareCall_2_0.js +4 -0
  244. package/build/shared/interfaces/restAPI/audio/v2.0/index.js +3 -0
  245. package/build/shared/interfaces/restAPI/insights/publish/IPublishAnalyticsRestDataBody.js +4 -0
  246. package/build/shared/interfaces/restAPI/management/organisations/v2.0/IDeleteOrganisationRest_2_0.js +4 -0
  247. package/build/shared/interfaces/restAPI/resources/file/v2.0/IUploadFileRest_2_0.js +3 -0
  248. package/build/shared/interfaces/restAPI/resources/file/v2.0/index.js +3 -0
  249. package/build/shared/interfaces/restAPI/resources/flow/v2.0/ICloneFlowRest_2_0.js +4 -0
  250. package/build/shared/interfaces/restAPI/resources/flow/v2.0/sentence/IYesNoSentence_2_0.js +3 -0
  251. package/build/shared/interfaces/restAPI/resources/flow/v2.0/settings/ILocaleSettings_2_0.js +16 -0
  252. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoIntents/IDeleteYesNoIntentRest_2_0.js +3 -0
  253. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoIntents/IReadYesNoIntentsRest_2_0.js +3 -0
  254. package/build/shared/interfaces/restAPI/resources/{flow/v2.0/intent → locales/v2.0/yesNoIntents}/ITrainYesNoIntentsRest_2_0.js +0 -0
  255. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoIntents/IUpdateYesNoIntentRest_2_0.js +3 -0
  256. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoIntents/IYesNoIntentItem_2_0.js +3 -0
  257. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoIntents/IYesNoIntentMetaData_2_0.js +4 -0
  258. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoIntents/IYesNoIntents_2_0.js +8 -0
  259. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoIntents/index.js +3 -0
  260. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoSentence/ICreateYesNoSentenceRest_2_0.js +3 -0
  261. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoSentence/IDeleteYesNoSentenceRest_2_0.js +3 -0
  262. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoSentence/IIndexYesNoSentencesRest_2_0.js +3 -0
  263. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoSentence/IReadYesNoSentenceRest_2_0.js +3 -0
  264. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoSentence/IUpdateYesNoSentenceRest_2_0.js +3 -0
  265. package/build/shared/interfaces/restAPI/resources/locales/v2.0/yesNoSentence/index.js +3 -0
  266. package/build/shared/interfaces/restAPI/resources/nluconnector/v2.0/TNLUConnectorType_2_0.js +2 -0
  267. package/build/shared/interfaces/restAPI/resources/project/v2.0/ICreateProjectRest_2_0.js +1 -0
  268. package/build/shared/interfaces/restAPI/resources/project/v2.0/ITrainAllProjectFlowsRest_2_0.js +3 -0
  269. package/build/shared/interfaces/restAPI/resources/project/v2.0/settings/ITestTranslationSettingsRest_2_0.js +3 -0
  270. package/build/shared/interfaces/restAPI/resources/project/v2.0/settings/ITestTranslationSettings_2_0.js +3 -0
  271. package/build/shared/interfaces/security/IACL.js +1 -1
  272. package/build/shared/interfaces/security/IPermission.js +4 -0
  273. package/build/shared/interfaces/security/IRole.js +13 -1
  274. package/build/shared/interfaces/trainer/ITrainerRecord.js +1 -1
  275. package/build/shared/interfaces/user.js +1 -1
  276. package/package.json +40 -31
  277. package/types/index.d.ts +1734 -501
package/types/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- // Generated by dts-bundle-generator v5.9.0
1
+ // Generated by dts-bundle-generator v6.12.0
2
2
 
3
- /// <reference types="node" />
3
+ import { AxiosResponseHeaders } from 'axios';
4
4
 
5
5
  export declare type Options = {
6
6
  [key: string]: unknown;
@@ -16,6 +16,7 @@ export declare type Constructor<T> = new (...args: any[]) => T;
16
16
  */
17
17
  export declare type UnionToIntersection<Union> = (Union extends any ? (argument: Union) => void : never) extends (argument: infer Intersection) => void ? Intersection : never;
18
18
  export declare type AnyFunction = (...args: any) => any;
19
+ export declare type ReturnTypeOf<T extends AnyFunction | AnyFunction[]> = T extends AnyFunction ? ReturnType<T> : T extends AnyFunction[] ? UnionToIntersection<ReturnType<T[number]>> : never;
19
20
  declare class Base {
20
21
  static plugins: TestPlugin[];
21
22
  static plugin<S extends Constructor<any> & {
@@ -25,7 +26,7 @@ declare class Base {
25
26
  [x: string]: any;
26
27
  };
27
28
  plugins: any[];
28
- } & S & Constructor<T extends AnyFunction ? ReturnType<T> : T extends AnyFunction[] ? UnionToIntersection<ReturnType<T[number]>> : never>;
29
+ } & S & Constructor<ReturnTypeOf<T>>;
29
30
  static defaults<S extends Constructor<any>>(this: S, defaults: Options): {
30
31
  new (...args: any[]): {
31
32
  [x: string]: any;
@@ -364,6 +365,11 @@ export interface ILoginByAuthorizationCodeParameters {
364
365
  * @see https://tools.ietf.org/html/rfc6749#section-10.12
365
366
  */
366
367
  state?: string;
368
+ /**
369
+ * Required for client "cognigy-live-agent".
370
+ * The code verifier for authentication using authorization code with PKCE
371
+ */
372
+ codeVerifier?: string;
367
373
  }
368
374
  export interface IGetAuthorizationCodeParameters {
369
375
  /**
@@ -392,6 +398,18 @@ export interface IGetAuthorizationCodeParameters {
392
398
  * This is passed in the request header
393
399
  */
394
400
  organisationId?: string;
401
+ /**
402
+ * Required for client "cognigy-live-agent".
403
+ * The code challenge for authentication using
404
+ * authorization code with PKCE
405
+ */
406
+ codeChallenge?: string;
407
+ /**
408
+ * Required for client "cognigy-live-agent".
409
+ * The code challenge method to be used for authentication using
410
+ * authorization code with PKCE
411
+ */
412
+ codeChallengeMethod?: string;
395
413
  }
396
414
  declare const organisationWidePermissions: readonly [
397
415
  "analyticsOdata",
@@ -431,7 +449,9 @@ declare const projectWidePermissions: readonly [
431
449
  "snapshots",
432
450
  "states",
433
451
  "tasks",
434
- "tokens"
452
+ "tokens",
453
+ "yesNoIntents",
454
+ "dataPrivacySettings"
435
455
  ];
436
456
  export declare type TProjectWidePermissions = typeof projectWidePermissions[number];
437
457
  export declare type TMongoId = string;
@@ -886,6 +906,7 @@ declare const organisationWideRoles: readonly [
886
906
  "base_role",
887
907
  "liveAgentAdmin",
888
908
  "liveAgentAgent",
909
+ "liveAgentSupervisor",
889
910
  "livechat",
890
911
  "odata",
891
912
  "projectManager",
@@ -924,7 +945,10 @@ declare const projectWideRoles: readonly [
924
945
  "projectAdmin",
925
946
  "snapshot_admin",
926
947
  "tokenAdmin",
927
- "tokenEditor"
948
+ "tokenEditor",
949
+ "data_privacy_admin",
950
+ "data_privacy_editor",
951
+ "data_privacy_viewer"
928
952
  ];
929
953
  export declare type TProjectWideRole = typeof projectWideRoles[number];
930
954
  export interface IOrganisationScope {
@@ -1469,11 +1493,7 @@ export declare function isRetryableStatus(status: number): boolean;
1469
1493
  *
1470
1494
  * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
1471
1495
  */
1472
- export declare function retryAfterDelay(response: {
1473
- headers?: {
1474
- "retry-after": string;
1475
- };
1476
- }, lastRequestTime: number): number;
1496
+ export declare function retryAfterDelay(headers: AxiosResponseHeaders, lastRequestTime: number): number;
1477
1497
  export interface IRestAPIClientConfig {
1478
1498
  baseUrl?: string;
1479
1499
  /**
@@ -1549,6 +1569,7 @@ declare const arrayNLUConnectorType: readonly [
1549
1569
  "alexa",
1550
1570
  "dialogflow",
1551
1571
  "dialogflowBuiltIn",
1572
+ "amazonLexBuiltIn",
1552
1573
  "twilioAutopilotBuiltIn",
1553
1574
  "luis",
1554
1575
  "watson",
@@ -1763,7 +1784,9 @@ declare const webhookChannelTypes: readonly [
1763
1784
  "microsoftBotFramework",
1764
1785
  "sunshineConversations",
1765
1786
  "ringCentralEngage",
1766
- "intercom"
1787
+ "intercom",
1788
+ "whatsapp",
1789
+ "eightByEight"
1767
1790
  ];
1768
1791
  export declare type TWebhookChannelType = typeof webhookChannelTypes[number];
1769
1792
  declare const restChannelTypes: readonly [
@@ -1779,16 +1802,17 @@ declare const restChannelTypes: readonly [
1779
1802
  "twilio-sms",
1780
1803
  "twilio",
1781
1804
  "userlike",
1782
- "nonConversational"
1805
+ "nonConversational",
1806
+ "amazonLex"
1783
1807
  ];
1784
1808
  export declare type TRestChannelType = typeof restChannelTypes[number];
1785
1809
  declare const socketChannelTypes: readonly [
1786
1810
  "realtime",
1787
- "webchat",
1788
1811
  "webchat2",
1789
1812
  "admin-webchat",
1790
1813
  "socket",
1791
- "voiceGateway2"
1814
+ "voiceGateway2",
1815
+ "liveAgentAssist"
1792
1816
  ];
1793
1817
  export declare type TSocketChannelType = typeof socketChannelTypes[number];
1794
1818
  /**
@@ -1812,7 +1836,6 @@ export declare type TSocketChannelType = typeof socketChannelTypes[number];
1812
1836
  * - realtime
1813
1837
  * - socket
1814
1838
  * - adminconsole
1815
- * - webchat
1816
1839
  * - webchat2
1817
1840
  * - dialogflow
1818
1841
  * - twilio
@@ -1827,8 +1850,41 @@ export declare type TSocketChannelType = typeof socketChannelTypes[number];
1827
1850
  * - avaya
1828
1851
  * - nonConversational
1829
1852
  * - voiceGateway2
1853
+ * - amazonLex
1830
1854
  */
1831
1855
  export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | "inject" | "abstract-rest" | "adminconsole" | "voiceGateway2";
1856
+ declare const endpointTypes: readonly [
1857
+ "facebook",
1858
+ "workplace",
1859
+ "alexa",
1860
+ "slack",
1861
+ "google",
1862
+ "webhook",
1863
+ "rest",
1864
+ "abstractRest",
1865
+ "socket",
1866
+ "adminconsole",
1867
+ "webchat2",
1868
+ "dialogflow",
1869
+ "twilio",
1870
+ "twilioSms",
1871
+ "twilioAutopilot",
1872
+ "line",
1873
+ "intercom",
1874
+ "microsoftBotFramework",
1875
+ "microsoftTeams",
1876
+ "sunshineConversations",
1877
+ "userlike",
1878
+ "ringCentralEngage",
1879
+ "audioCodes",
1880
+ "avaya",
1881
+ "nonConversational",
1882
+ "voiceGateway2",
1883
+ "whatsapp",
1884
+ "amazonLex",
1885
+ "eightByEight"
1886
+ ];
1887
+ export declare type TEndpointType = typeof endpointTypes[number];
1832
1888
  export interface IWebchatPersistentMenu {
1833
1889
  /**
1834
1890
  * The title of the persistent menu
@@ -1851,7 +1907,7 @@ export interface IWebchatPersistentMenu {
1851
1907
  payload: string;
1852
1908
  }[];
1853
1909
  }
1854
- export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchatEndpointSettings | IWebchat2EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IAudioCodesEndpointSettings | {};
1910
+ export declare type AnyEndpointSettings = IFacebookEndpointSettings | IWorkplaceEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchat2EndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISunshineConversationsEndpointSettings | IAvayaEndpointSettings | IUserlikeEndpointSettings | IAudioCodesEndpointSettings | IWhatsAppEndpointSettings | IAmazonLexEndpointSettings | IEightByEightEndpointSettings | {};
1855
1911
  export declare type TAvayaVoice = "man" | "woman" | string;
1856
1912
  declare const avayaSttTtsLanguages: readonly [
1857
1913
  "cy-GB",
@@ -2004,12 +2060,14 @@ declare const avayaGatherLanguages: readonly [
2004
2060
  export declare type TAvayaGatherLanguages = typeof avayaGatherLanguages[number];
2005
2061
  declare const dashbotPlatform: readonly [
2006
2062
  "facebook",
2063
+ "whatsapp",
2007
2064
  "alexa",
2008
2065
  "google",
2009
2066
  "slack",
2010
2067
  "microsoftBotFramework",
2011
2068
  "webchat",
2012
- "universal"
2069
+ "universal",
2070
+ "eightByEight"
2013
2071
  ];
2014
2072
  export declare type TDashbotPlatform = typeof dashbotPlatform[number];
2015
2073
  export interface IFacebookEndpointSettings extends IEndpointSessionSettings {
@@ -2213,12 +2271,14 @@ export interface IWebchatEndpointSharedSettings extends ITypingIndicatorSettings
2213
2271
  * This setting is used to overwrite all options with a JSON
2214
2272
  */
2215
2273
  customJSON?: string;
2216
- }
2217
- export interface IWebchatEndpointSettings extends IWebchatEndpointSharedSettings {
2218
2274
  /**
2219
- * Whether to display the get started button.
2275
+ * Whether to overwrite the webchat bundle URL for demo webchat
2276
+ */
2277
+ shouldOverwriteWebchatBundleUrl: boolean;
2278
+ /**
2279
+ * The overwrite the webchat bundle URL for demo webchat
2220
2280
  */
2221
- displayGetStartedButton: boolean;
2281
+ overwriteWebchatBundleUrl: string;
2222
2282
  }
2223
2283
  export interface IWebchat2EndpointSettings extends IWebchatEndpointSharedSettings {
2224
2284
  /**
@@ -2335,6 +2395,10 @@ export interface IWebchat2EndpointSettings extends IWebchatEndpointSharedSetting
2335
2395
  * This setting is used to enable or disable the "integrated demo webchat" for this endpoint. If this is "off", the Demo Webchat will not be publically accessible.
2336
2396
  */
2337
2397
  enableDemoWebchat: boolean;
2398
+ /**
2399
+ * This setting is used to enable or disable branding in webchat.If true, hides "Powered by Cognigy" link.
2400
+ */
2401
+ disableBranding?: boolean;
2338
2402
  }
2339
2403
  /**
2340
2404
  * Setting to enable rating for the Webchat.
@@ -2354,6 +2418,13 @@ export declare type TWebchatEnableRating = "always" | "once" | "onRequest";
2354
2418
  * Flow when the Webchat connects
2355
2419
  */
2356
2420
  export declare type TWebchat2StartBehavior = "none" | "button" | "injection";
2421
+ export interface IAmazonLexEndpointSettings {
2422
+ /**
2423
+ * Whether to reparse slots found
2424
+ * by Amazon Lex with COGNIGY.AI NLU
2425
+ */
2426
+ reparseAmazonLexSlots: boolean;
2427
+ }
2357
2428
  export interface IIntercomEndpointSettings {
2358
2429
  /**
2359
2430
  * The access token used to authenticate
@@ -2405,10 +2476,130 @@ export interface IAudioCodesEndpointSettings {
2405
2476
  */
2406
2477
  enableAsyncCommunication: boolean;
2407
2478
  }
2479
+ export interface IWhatsAppEndpointSettings extends IEndpointSessionSettings {
2480
+ bearerToken: string;
2481
+ phoneNumberId: string;
2482
+ /** The application id of the WhatsApp business account which we use to identify the associated account of the configured endpoint */
2483
+ appId: string;
2484
+ /** The secret which we use to validate that the request was from whatsapp */
2485
+ appSecret?: string;
2486
+ /**
2487
+ * The verify-token which is used to verify that a certain request is
2488
+ * from WhatsApp and not from some other source.
2489
+ */
2490
+ verifyToken: string;
2491
+ /**
2492
+ * The amount of delay there should be between
2493
+ * messages. Used to make the conversation seem
2494
+ * more human
2495
+ */
2496
+ messageDelay: number;
2497
+ /** Settings to store attachments at a cloud provider */
2498
+ fileStorageSettings?: IFileStorageSettings;
2499
+ }
2500
+ export interface IFileStorageSettings {
2501
+ storageProvider: "none" | "aws" | "azure" | "googleCloud";
2502
+ awsConnection?: string;
2503
+ azureConnection?: string;
2504
+ googleCloudConnection?: string;
2505
+ }
2506
+ export interface IFileAttachment {
2507
+ type: "file" | "document";
2508
+ name: string;
2509
+ url: string;
2510
+ }
2511
+ export interface IImageAttachment {
2512
+ type: "image";
2513
+ name: string;
2514
+ url: string;
2515
+ }
2516
+ export interface IStickerAttachment {
2517
+ type: "sticker";
2518
+ name: string;
2519
+ url: string;
2520
+ }
2521
+ export interface IVideoAttachment {
2522
+ type: "video";
2523
+ name: string;
2524
+ url: string;
2525
+ }
2526
+ export interface IAudioAttachment {
2527
+ type: "audio";
2528
+ name: string;
2529
+ url: string;
2530
+ }
2531
+ export interface IContactAttachment {
2532
+ type: "contact";
2533
+ addresses?: {
2534
+ city?: string;
2535
+ country?: string;
2536
+ countryCode?: string;
2537
+ state?: string;
2538
+ street?: string;
2539
+ type?: "HOME" | "WORK";
2540
+ zip?: string;
2541
+ postOfficeBox?: string;
2542
+ extendedAddress?: string;
2543
+ latitude?: number;
2544
+ longitude?: number;
2545
+ }[];
2546
+ birthday?: string;
2547
+ emails?: {
2548
+ email?: string;
2549
+ type?: "HOME" | "WORK";
2550
+ }[];
2551
+ name?: {
2552
+ formattedName?: string;
2553
+ firstName?: string;
2554
+ lastName?: string;
2555
+ middleName?: string;
2556
+ suffix?: string;
2557
+ prefix?: string;
2558
+ nickName?: string[];
2559
+ };
2560
+ org?: {
2561
+ company?: string;
2562
+ department?: string;
2563
+ subDepartment?: string;
2564
+ title?: string;
2565
+ roles?: string[];
2566
+ };
2567
+ phones?: {
2568
+ phone?: string;
2569
+ type?: "HOME" | "WORK";
2570
+ }[];
2571
+ urls?: {
2572
+ url?: string;
2573
+ type?: "HOME" | "WORK";
2574
+ }[];
2575
+ photos?: string[];
2576
+ gender?: string;
2577
+ languages?: string[];
2578
+ timeZone?: string;
2579
+ notes?: string[];
2580
+ }
2581
+ export interface ILocationAttachment {
2582
+ type: "location";
2583
+ latitude: number;
2584
+ longitude: number;
2585
+ name?: string;
2586
+ title?: string;
2587
+ address?: string;
2588
+ }
2589
+ export declare type TAttachments = IFileAttachment | IImageAttachment | IStickerAttachment | IVideoAttachment | IAudioAttachment | IContactAttachment | ILocationAttachment;
2590
+ export interface IEightByEightEndpointSettings extends IEndpointSessionSettings {
2591
+ /** The base 8x8 server url */
2592
+ baseUrl: string;
2593
+ /** The API Key which we use to access/authorize the 8x8 API calls */
2594
+ apiKey: string;
2595
+ /** Settings to store attachments at a cloud provider */
2596
+ fileStorageSettings?: IFileStorageSettings;
2597
+ }
2408
2598
  declare const arrayNLUConnectorType_2_0: readonly [
2409
2599
  "alexa",
2410
2600
  "dialogflow",
2411
2601
  "dialogflowBuiltIn",
2602
+ "amazonLexBuiltIn",
2412
2603
  "twilioAutopilotBuiltIn",
2413
2604
  "luis",
2414
2605
  "watson",
@@ -2908,6 +3099,29 @@ declare const trainGroupFeedbackFindingArrayType: readonly [
2908
3099
  "goodAccuracy"
2909
3100
  ];
2910
3101
  export declare type TTrainGroupFeedbackFindingType = typeof trainGroupFeedbackFindingArrayType[number];
3102
+ export interface IIntentTrainGroupInDB {
3103
+ _id: TMongoId;
3104
+ referenceId: string;
3105
+ lastRelevantChangeAt: number;
3106
+ lastRelevantChangeBy: TMongoId;
3107
+ lastTrainedAt: number;
3108
+ lastTrainedBy: TMongoId;
3109
+ lastChanged: number;
3110
+ lastChangedBy: TMongoId;
3111
+ flowReference: TMongoId;
3112
+ localeReference: TMongoId;
3113
+ projectReference: TMongoId;
3114
+ organisationReference: TMongoId;
3115
+ lexiconsInServiceMatcher: boolean;
3116
+ nluOptions: {
3117
+ intentModelVersion?: TIntentModelVersion;
3118
+ };
3119
+ }
3120
+ export declare type TIntentModelVersion = "1" | "2";
3121
+ export interface IIntentTrainGroup extends IIntentTrainGroupInDB {
3122
+ feedbackReport: Pick<ITrainGroupFeedbackReport, "info" | "findings">;
3123
+ isTrainingOutOfDate: boolean;
3124
+ }
2911
3125
  export interface ILocalizedFlowData {
2912
3126
  attachedLexiconReferences: TMongoId[];
2913
3127
  localeReference: TMongoId;
@@ -2937,6 +3151,7 @@ export interface IFlow extends Omit<IFlowInDB, "localizedData">, Omit<ILocalized
2937
3151
  feedbackReport: Pick<ITrainGroupFeedbackReport, "info" | "findings">;
2938
3152
  isTrainingOutOfDate: boolean;
2939
3153
  lastTrainedAt: number;
3154
+ nluOptions: IIntentTrainGroup["nluOptions"];
2940
3155
  }
2941
3156
  export interface IGraphFlow {
2942
3157
  type: "flow";
@@ -2970,6 +3185,13 @@ export interface ICreateFlowFromChildrenRestData_2_0 extends ICreateFlowFromChil
2970
3185
  }
2971
3186
  export interface ICreateFlowFromChildrenRestReturnValue_2_0 extends IFlow_2_0 {
2972
3187
  }
3188
+ export interface ICloneFlowRestDataParams_2_0 {
3189
+ flowId: string;
3190
+ }
3191
+ export interface ICloneFlowRestData_2_0 extends ICloneFlowRestDataParams_2_0 {
3192
+ }
3193
+ export interface ICloneFlowRestReturnValue_2_0 extends IFlow_2_0 {
3194
+ }
2973
3195
  /**
2974
3196
  * @openapi
2975
3197
  *
@@ -3628,6 +3850,7 @@ export interface ILexiconKeyphraseIndexItem_2_0 {
3628
3850
  }
3629
3851
  export interface IIndexLexiconEntryKeyphrasesRestDataParams_2_0 {
3630
3852
  lexiconId: TMongoId;
3853
+ entryId: TMongoId;
3631
3854
  }
3632
3855
  export interface IIndexLexiconEntryKeyphrasesRestData_2_0 extends IRestPagination<ILexiconKeyphraseIndexItem_2_0>, IIndexLexiconEntryKeyphrasesRestDataParams_2_0 {
3633
3856
  entryId: TMongoId;
@@ -3843,13 +4066,154 @@ export interface IIndexEndpointsRestData_2_0 extends IRestPagination<IEndpointIn
3843
4066
  }
3844
4067
  export interface IIndexEndpointsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IEndpointIndexItem_2_0> {
3845
4068
  }
4069
+ export interface IBaseAnalyticsData {
4070
+ projectId: string;
4071
+ projectName: string;
4072
+ contactId: string;
4073
+ sessionId: string;
4074
+ inputId: string;
4075
+ mode: "TextOnly" | "DataOnly" | "TextData" | "Empty";
4076
+ state: string;
4077
+ organisation: string;
4078
+ userType: string;
4079
+ channel: string;
4080
+ endpointType: TEndpointType;
4081
+ flowLanguage: string;
4082
+ flowReferenceId: string;
4083
+ flowName: string;
4084
+ entrypoint: string;
4085
+ localeReferenceId: string;
4086
+ intent: string;
4087
+ ip: string;
4088
+ slots: any;
4089
+ timestamp: Date;
4090
+ executionTime: number;
4091
+ execution?: number;
4092
+ nodesVisited: Array<string>;
4093
+ completedGoals: Array<string>;
4094
+ }
4095
+ declare const analyticsType: readonly [
4096
+ "input",
4097
+ "output"
4098
+ ];
4099
+ export declare type TAnalyticsType = typeof analyticsType[number];
4100
+ export declare type TAnalyticsSource = typeof analyticsSourceTypes[number];
4101
+ declare const analyticsSourceTypes: readonly [
4102
+ "user",
4103
+ "bot",
4104
+ "agent",
4105
+ "suggestion"
4106
+ ];
4107
+ export interface IBaseAnalyticsSourceData extends IBaseAnalyticsData {
4108
+ intentScore: number;
4109
+ intentFlow: string;
4110
+ understood: boolean;
4111
+ type: TAnalyticsType;
4112
+ source: TAnalyticsSource;
4113
+ schemaVersion: number;
4114
+ rating?: number;
4115
+ ratingComment?: string;
4116
+ inHandoverRequest?: boolean;
4117
+ inHandoverConversation?: boolean;
4118
+ chatbase?: string;
4119
+ dashbot?: string;
4120
+ dashbotPlatform?: TDashbotPlatform;
4121
+ }
4122
+ export interface IAnalyticsUserInputData {
4123
+ inputText: string;
4124
+ inputData: any;
4125
+ inputAttachments: TAttachments[];
4126
+ userLanguageText: string;
4127
+ outputId?: string;
4128
+ }
4129
+ export interface IAnalyticsFlowMeta {
4130
+ flowName: string;
4131
+ flowReferenceId: string;
4132
+ }
4133
+ export interface IAnalyticsSnapshotMeta {
4134
+ snapshotName: string;
4135
+ snapshotId: TMongoId | any;
4136
+ }
4137
+ export interface IAnalytiscEndpointMeta {
4138
+ endpointUrlToken: string;
4139
+ endpointName: string;
4140
+ endpointType: TEndpointType;
4141
+ /** We can't use the TEndpointType as the channel can be overwritten by customer */
4142
+ channel: string;
4143
+ }
4144
+ export interface IAnalyticsLocaleMeta {
4145
+ localeName: string;
4146
+ localeReferenceId: string;
4147
+ }
4148
+ export interface IStepEvent extends IAnalyticsFlowMeta, IAnalytiscEndpointMeta, IAnalyticsLocaleMeta, Partial<IAnalyticsSnapshotMeta> {
4149
+ _id: TMongoId;
4150
+ userId: string;
4151
+ sessionId: string;
4152
+ inputId: string;
4153
+ timestamp: Date;
4154
+ stepLabel: string;
4155
+ /**
4156
+ * The entityReferenceId
4157
+ * of the step that came before this step
4158
+ */
4159
+ parentStep: string;
4160
+ type: "intent" | "node";
4161
+ entityReferenceId: string;
4162
+ projectName: string;
4163
+ projectId: TMongoId;
4164
+ organisationId: TMongoId;
4165
+ }
4166
+ export interface IAnalyticsStepData {
4167
+ steps: (Pick<IStepEvent, "entityReferenceId" | "flowName" | "flowReferenceId" | "parentStep" | "stepLabel" | "timestamp" | "type">)[];
4168
+ trackedSteps: Pick<IStepEvent, "entityReferenceId" | "stepLabel">[];
4169
+ }
4170
+ declare const entrypointType: readonly [
4171
+ "project",
4172
+ "snapshot"
4173
+ ];
4174
+ export declare type TEntrypointType = typeof entrypointType[number];
4175
+ export interface IAnalyticsFlowHistoryData extends IAnalyticsFlowMeta {
4176
+ }
4177
+ export interface IAnalyticsSourceData extends IBaseAnalyticsSourceData, IAnalyticsUserInputData, IAnalyticsStepData {
4178
+ entrypointType: TEntrypointType;
4179
+ trackedGoals: string[];
4180
+ localeName: string;
4181
+ endpointName: string;
4182
+ endpointUrlToken: string;
4183
+ handoverEscalations: number;
4184
+ snapshotName?: string;
4185
+ flowHistory?: IAnalyticsFlowHistoryData[];
4186
+ custom1?: string;
4187
+ custom2?: string;
4188
+ custom3?: string;
4189
+ custom4?: string;
4190
+ custom5?: string;
4191
+ custom6?: string;
4192
+ custom7?: string;
4193
+ custom8?: string;
4194
+ custom9?: string;
4195
+ custom10?: string;
4196
+ previousInputText: string;
4197
+ previousInputData: {};
4198
+ previousInputAttachments: TAttachments[];
4199
+ previousSource: TAnalyticsSource;
4200
+ }
4201
+ export interface IEditableAnalyticsData extends Pick<IAnalyticsSourceData, "state" | "mode" | "userType" | "channel" | "flowLanguage" | "intent" | "intentScore" | "intentFlow" | "flowName" | "inHandoverRequest" | "inHandoverConversation" | "localeName" | "rating" | "ratingComment" | "entrypointType" | "endpointName" | "endpointUrlToken" | "handoverEscalations" | "snapshotName" | "slots" | "custom1" | "custom2" | "custom3" | "custom4" | "custom5" | "custom6" | "custom7" | "custom8" | "custom9" | "custom10"> {
4202
+ }
4203
+ export interface ISayNodeSettings {
4204
+ liveAgentSettings: ILiveAgentSettings;
4205
+ }
4206
+ export interface ILiveAgentSettings {
4207
+ forwardable: boolean;
4208
+ }
3846
4209
  declare const handoverProviders: readonly [
3847
4210
  "cognigy",
3848
4211
  "none",
3849
4212
  "rce",
3850
4213
  "chatwoot",
3851
4214
  "salesforce",
3852
- "liveAgent"
4215
+ "liveAgent",
4216
+ "genesysCloud"
3853
4217
  ];
3854
4218
  export declare type THandoverProvider = typeof handoverProviders[number];
3855
4219
  export interface IHandoverSettings {
@@ -3857,7 +4221,13 @@ export interface IHandoverSettings {
3857
4221
  providerSettings?: TProviderSettings;
3858
4222
  agentAssistSettings?: IAgentAssistSettings;
3859
4223
  }
3860
- export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings;
4224
+ declare const whisperAssistConfigurations: readonly [
4225
+ "none",
4226
+ "basic",
4227
+ "template"
4228
+ ];
4229
+ export declare type TWhisperAssistConfiguration = typeof whisperAssistConfigurations[number];
4230
+ export declare type TProviderSettings = IRCEHandoverSettings | IChatwootHandoverSettings | ICognigyHandoverSettings | ISalesForceHandoverSettings | ILiveAgentHandoverSettings | IGenesysCloudHandoverSettings;
3861
4231
  export interface IRCEHandoverSettings {
3862
4232
  /**
3863
4233
  * Whether to forward all conversations
@@ -3951,10 +4321,32 @@ export interface ISalesForceHandoverSettings {
3951
4321
  * and is therefore set to 'true'
3952
4322
  */
3953
4323
  forwardOnlyHandoverConversations: true;
4324
+ /**
4325
+ * Whether to forward any unknown event to the flow as an
4326
+ * agentInject message
4327
+ */
4328
+ forwardUnknownEventsToFlow: boolean;
3954
4329
  }
3955
4330
  export interface IAgentAssistSettings {
3956
4331
  agentAssistFlowId: string;
3957
4332
  }
4333
+ export interface IGenesysCloudHandoverSettings {
4334
+ host: string;
4335
+ organizationId: string;
4336
+ deploymentId: string;
4337
+ queue: string;
4338
+ queueId: string;
4339
+ sessionDuration: number;
4340
+ sendProfile: boolean;
4341
+ oAuth2Connection: string;
4342
+ /**
4343
+ * This setting cannot be changed,
4344
+ * since the cognigy client only supports
4345
+ * forwarding handover conversations. The value
4346
+ * is therefore set to 'true'
4347
+ */
4348
+ forwardOnlyHandoverConversations: true;
4349
+ }
3958
4350
  export interface IHandoverStatusInputObject {
3959
4351
  status: THandoverStatus;
3960
4352
  error?: {
@@ -4130,6 +4522,8 @@ export declare type THandoverStatus = "completed" | "cancelled" | "error" | "age
4130
4522
  * type: integer
4131
4523
  * messageLogoUrl:
4132
4524
  * type: string
4525
+ * overwriteWebchatBundleUrl:
4526
+ * type: string
4133
4527
  * ratingTitleText:
4134
4528
  * type: string
4135
4529
  * ratingCommentText:
@@ -4144,6 +4538,8 @@ export declare type THandoverStatus = "completed" | "cancelled" | "error" | "age
4144
4538
  * type: boolean
4145
4539
  * sessionExpiration:
4146
4540
  * type: integer
4541
+ * shouldOverwriteWebchatBundleUrl:
4542
+ * type: boolean
4147
4543
  * showEngagementMessagesInChat:
4148
4544
  * type: boolean
4149
4545
  * slackOAuthAccessToken:
@@ -4258,6 +4654,8 @@ export declare type THandoverStatus = "completed" | "cancelled" | "error" | "age
4258
4654
  * agentAssistFlowId:
4259
4655
  * type: string
4260
4656
  * description: Agent assist flow ID
4657
+ * orgDataPrivacySettings:
4658
+ * $ref: '#/components/schemas/IEndpoitOrgDataPrivacySettings_2_0'
4261
4659
  * IEndpoint_2_0:
4262
4660
  * allOf:
4263
4661
  * - $ref: '#/components/schemas/IEndpointData_2_0'
@@ -4326,6 +4724,8 @@ export interface IEndpoint_2_0 {
4326
4724
  /** Whether to override the connections in the Snapshot
4327
4725
  * with those of the Agent */
4328
4726
  overrideSnapshotConnections: boolean;
4727
+ fileStorageSettings: IEndpointFileStorageSettings_2_0;
4728
+ orgDataPrivacySettings?: IEndpoitOrgDataPrivacySettings_2_0;
4329
4729
  }
4330
4730
  export interface ITransformerFunction_2_0 {
4331
4731
  /**
@@ -4401,20 +4801,57 @@ export interface IEndpointTranslationSettings_2_0 {
4401
4801
  alwaysRemoveNoTranslateMarker: boolean;
4402
4802
  setInputLanguageOnExecutionCount: number;
4403
4803
  }
4404
- export declare type IBatchEndpointsRestOperationSet = (IBatchActionOperation<"create", Omit<IEndpoint_2_0, keyof IEntityMeta | "URLToken">> | IBatchActionOperation<"update", Omit<IEndpoint_2_0, keyof IEntityMeta | "URLToken">> | IBatchActionOperation<"delete">)[];
4405
- export interface IBatchEndpointsRestDataBody_2_0 {
4406
- operations: IBatchEndpointsRestOperationSet;
4407
- }
4408
- export interface IBatchEndpointsRestDataQuery_2_0 extends IProjectScope {
4409
- }
4410
- export interface IBatchEndpointsRestData_2_0 extends IBatchEndpointsRestDataBody_2_0, IBatchEndpointsRestDataQuery_2_0 {
4411
- }
4412
- export interface IBatchEndpointsRestReturnValue_2_0 {
4413
- }
4414
- export interface ICreateEndpointRestDataBody_2_0 extends IProjectScope, Partial<Omit<IEndpoint_2_0, keyof IEntityMeta | "URLToken">> {
4804
+ export interface IEndpointFileStorageSettings_2_0 {
4805
+ storageProvider: "aws" | "azure" | "googleCloud" | "none";
4806
+ awsConnection?: string;
4807
+ azureConnection?: string;
4808
+ googleCloudConnection?: string;
4415
4809
  }
4416
- export interface ICreateEndpointRestDataQuery_2_0 {
4417
- resourceId?: string;
4810
+ /**
4811
+ * @openapi
4812
+ *
4813
+ * components:
4814
+ * schemas:
4815
+ * IEndpoitOrgDataPrivacySettings_2_0:
4816
+ * description: Organisation data privacy settings overwrite the ones defined on endpoint-level
4817
+ * type: object
4818
+ * properties:
4819
+ * enabled:
4820
+ * type: boolean
4821
+ * description: Whether or not organisation data privacy settings are enabled
4822
+ * useAnalytics:
4823
+ * type: boolean
4824
+ * useContactProfiles:
4825
+ * type: boolean
4826
+ * useConversations:
4827
+ * type: boolean
4828
+ * maskAnalytics:
4829
+ * type: boolean
4830
+ * maskLogging:
4831
+ * type: boolean
4832
+ */
4833
+ export interface IEndpoitOrgDataPrivacySettings_2_0 {
4834
+ enabled: boolean;
4835
+ useAnalytics: boolean;
4836
+ useContactProfiles: boolean;
4837
+ useConversations: boolean;
4838
+ maskAnalytics: boolean;
4839
+ maskLogging: boolean;
4840
+ }
4841
+ export declare type IBatchEndpointsRestOperationSet = (IBatchActionOperation<"create", Omit<IEndpoint_2_0, keyof IEntityMeta | "URLToken">> | IBatchActionOperation<"update", Omit<IEndpoint_2_0, keyof IEntityMeta | "URLToken">> | IBatchActionOperation<"delete">)[];
4842
+ export interface IBatchEndpointsRestDataBody_2_0 {
4843
+ operations: IBatchEndpointsRestOperationSet;
4844
+ }
4845
+ export interface IBatchEndpointsRestDataQuery_2_0 extends IProjectScope {
4846
+ }
4847
+ export interface IBatchEndpointsRestData_2_0 extends IBatchEndpointsRestDataBody_2_0, IBatchEndpointsRestDataQuery_2_0 {
4848
+ }
4849
+ export interface IBatchEndpointsRestReturnValue_2_0 {
4850
+ }
4851
+ export interface ICreateEndpointRestDataBody_2_0 extends IProjectScope, Partial<Omit<IEndpoint_2_0, keyof IEntityMeta | "URLToken">> {
4852
+ }
4853
+ export interface ICreateEndpointRestDataQuery_2_0 {
4854
+ resourceId?: string;
4418
4855
  }
4419
4856
  export interface ICreateEndpointRestData_2_0 extends ICreateEndpointRestDataBody_2_0, ICreateEndpointRestDataQuery_2_0 {
4420
4857
  }
@@ -4731,6 +5168,7 @@ declare const playbookRunStatus: readonly [
4731
5168
  "failed"
4732
5169
  ];
4733
5170
  export declare type TPlaybookRunStatus = typeof playbookRunStatus[number];
5171
+ export declare type TPlaybookAssertStatus = typeof playbookRunStatus[number];
4734
5172
  /**
4735
5173
  * @openapi
4736
5174
  *
@@ -4743,6 +5181,13 @@ export declare type TPlaybookRunStatus = typeof playbookRunStatus[number];
4743
5181
  * type: string
4744
5182
  * description: Type of the assert
4745
5183
  * example: assertText
5184
+ * status:
5185
+ * type: string
5186
+ * enum:
5187
+ * - successful
5188
+ * - failed
5189
+ * description: Whether this playbook step was successful or failed
5190
+ * example: failed
4746
5191
  * params:
4747
5192
  * type: object
4748
5193
  * description: Parameters for the assert
@@ -4765,6 +5210,7 @@ export declare type TPlaybookRunStatus = typeof playbookRunStatus[number];
4765
5210
  export interface IPlaybookRunStepResultAssert_2_0 {
4766
5211
  _id: TMongoId;
4767
5212
  type: string;
5213
+ status: TPlaybookAssertStatus;
4768
5214
  params: {
4769
5215
  [key: string]: any;
4770
5216
  };
@@ -4841,6 +5287,18 @@ export interface IPlaybookRunStepResult_2_0 {
4841
5287
  * type: array
4842
5288
  * items:
4843
5289
  * $ref: '#/components/schemas/IPlaybookRunStepResult_2_0'
5290
+ * flowId:
5291
+ * type: string
5292
+ * description: Reference Id of the flow
5293
+ * example: uuid
5294
+ * localeId:
5295
+ * type: string
5296
+ * description: Reference Id of the locale
5297
+ * example: uuid
5298
+ * entrypoint:
5299
+ * type: string
5300
+ * description: snapshot or project ID
5301
+ * example: ^[a-z0-9]{24}$
4844
5302
  */
4845
5303
  export interface IPlaybookRun_2_0 {
4846
5304
  _id: TMongoId;
@@ -4849,7 +5307,9 @@ export interface IPlaybookRun_2_0 {
4849
5307
  createdAt: number;
4850
5308
  lastChanged: number;
4851
5309
  createdBy: TMongoId;
4852
- lastChangedBy: TMongoId;
5310
+ flowId: TMongoId;
5311
+ localeId: TMongoId;
5312
+ entrypoint: TMongoId;
4853
5313
  }
4854
5314
  export interface IReadPlaybookRunRestDataParams_2_0 {
4855
5315
  playbookId: string;
@@ -5191,38 +5651,6 @@ declare const cognigyColorName: readonly [
5191
5651
  "lightGreen"
5192
5652
  ];
5193
5653
  export declare type TCognigyColorName = typeof cognigyColorName[number];
5194
- /**
5195
- * @openapi
5196
- *
5197
- * components:
5198
- * schemas:
5199
- * IProjectIndexItem_2_0:
5200
- * allOf:
5201
- * - $ref: '#/components/schemas/IProjectData_2_0'
5202
- * - type: object
5203
- * properties:
5204
- * liveAgentDefaultInbox:
5205
- * type: number
5206
- * description: Live agent default inbox Id for the project
5207
- * - $ref: '#/components/schemas/IEntityMeta'
5208
- */
5209
- export interface IProjectIndexItem_2_0 {
5210
- /** The Mongo id of the entity */
5211
- _id: string;
5212
- color: TCSSColorName | TCognigyColorName;
5213
- name: string;
5214
- primaryLocaleReference: TMongoId;
5215
- createdAt: number;
5216
- lastChanged: number;
5217
- createdBy: TMongoId;
5218
- lastChangedBy: TMongoId;
5219
- liveAgentDefaultInbox: number;
5220
- }
5221
- export interface IIndexProjectsRestData_2_0 extends IRestPagination<IProjectIndexItem_2_0> {
5222
- ignoreOwnership?: boolean;
5223
- }
5224
- export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IProjectIndexItem_2_0> {
5225
- }
5226
5654
  /**
5227
5655
  * @openapi
5228
5656
  *
@@ -5241,6 +5669,8 @@ export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginatio
5241
5669
  * oneOf:
5242
5670
  * - $ref: '#/components/schemas/TCSSColorName'
5243
5671
  * - $ref: '#/components/schemas/TCognigyColorName'
5672
+ * handoverConfiguration:
5673
+ * $ref: '#/components/schemas/IHandoverConfiguration_2_0'
5244
5674
  *
5245
5675
  * IProjectGeneratedData_2_0:
5246
5676
  * type: object
@@ -5248,6 +5678,15 @@ export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginatio
5248
5678
  * primaryLocaleReference:
5249
5679
  * $ref: '#/components/schemas/TMongoId'
5250
5680
  *
5681
+ * IHandoverConfiguration_2_0:
5682
+ * type: object
5683
+ * properties:
5684
+ * setupLiveAgentInbox:
5685
+ * type: boolean
5686
+ * whisperAssistConfiguration:
5687
+ * type: string
5688
+ * enum: [none, basic, template]
5689
+ *
5251
5690
  * IProjectCreateData_2_0:
5252
5691
  * allOf:
5253
5692
  * - $ref: '#/components/schemas/IProjectData_2_0'
@@ -5255,6 +5694,8 @@ export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginatio
5255
5694
  * properties:
5256
5695
  * locale:
5257
5696
  * $ref: '#/components/schemas/TNLULanguage_2_0'
5697
+ * handoverConfiguration:
5698
+ * $ref: '#/components/schemas/IHandoverConfiguration_2_0'
5258
5699
  *
5259
5700
  * IProject_2_0:
5260
5701
  * allOf:
@@ -5264,6 +5705,8 @@ export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginatio
5264
5705
  * liveAgentDefaultInbox:
5265
5706
  * type: number
5266
5707
  * description: Live agent default inbox Id for the project
5708
+ * handoverConfiguration:
5709
+ * $ref: '#/components/schemas/IHandoverConfiguration_2_0'
5267
5710
  * - $ref: '#/components/schemas/IProjectGeneratedData_2_0'
5268
5711
  * - $ref: '#/components/schemas/IEntityMeta'
5269
5712
  */
@@ -5278,6 +5721,7 @@ export interface IProject_2_0 {
5278
5721
  createdBy: TMongoId;
5279
5722
  lastChangedBy: TMongoId;
5280
5723
  liveAgentDefaultInbox: number;
5724
+ handoverConfiguration?: IHandoverConfiguration_2_0;
5281
5725
  }
5282
5726
  declare const nluLanguages_2_0: readonly [
5283
5727
  "ge-GE",
@@ -5425,13 +5869,51 @@ export interface IDeleteLocaleRestData_2_0 extends IDeleteLocaleRestDataParams_2
5425
5869
  }
5426
5870
  export interface IDeleteLocaleRestReturnValue_2_0 {
5427
5871
  }
5872
+ export interface IHandoverConfiguration_2_0 {
5873
+ setupLiveAgentInbox: boolean;
5874
+ whisperAssistConfiguration: TWhisperAssistConfiguration;
5875
+ }
5428
5876
  export interface ICreateProjectRestDataBody_2_0 extends Partial<Omit<IProject_2_0, TReferenceAndEntityMetaKeys>> {
5429
5877
  locale: TNLULanguage_2_0;
5878
+ handoverConfiguration?: IHandoverConfiguration_2_0;
5430
5879
  }
5431
5880
  export interface ICreateProjectRestData_2_0 extends ICreateProjectRestDataBody_2_0 {
5432
5881
  }
5433
5882
  export interface ICreateProjectRestReturnValue_2_0 extends IProject_2_0 {
5434
5883
  }
5884
+ /**
5885
+ * @openapi
5886
+ *
5887
+ * components:
5888
+ * schemas:
5889
+ * IProjectIndexItem_2_0:
5890
+ * allOf:
5891
+ * - $ref: '#/components/schemas/IProjectData_2_0'
5892
+ * - type: object
5893
+ * properties:
5894
+ * liveAgentDefaultInbox:
5895
+ * type: number
5896
+ * description: Live agent default inbox Id for the project
5897
+ * - $ref: '#/components/schemas/IEntityMeta'
5898
+ */
5899
+ export interface IProjectIndexItem_2_0 {
5900
+ /** The Mongo id of the entity */
5901
+ _id: string;
5902
+ color: TCSSColorName | TCognigyColorName;
5903
+ name: string;
5904
+ primaryLocaleReference: TMongoId;
5905
+ createdAt: number;
5906
+ lastChanged: number;
5907
+ createdBy: TMongoId;
5908
+ lastChangedBy: TMongoId;
5909
+ liveAgentDefaultInbox: number;
5910
+ handoverConfiguration?: IHandoverConfiguration_2_0;
5911
+ }
5912
+ export interface IIndexProjectsRestData_2_0 extends IRestPagination<IProjectIndexItem_2_0> {
5913
+ ignoreOwnership?: boolean;
5914
+ }
5915
+ export interface IIndexProjectsRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<IProjectIndexItem_2_0> {
5916
+ }
5435
5917
  export declare const nluLanguages: readonly [
5436
5918
  "ar-AE",
5437
5919
  "bn-IN",
@@ -5492,6 +5974,17 @@ export declare type TNluLanguage = typeof nluLanguages[number];
5492
5974
  * type: string
5493
5975
  * template:
5494
5976
  * type: string
5977
+ * handoverConfiguration:
5978
+ * type: object
5979
+ * properties:
5980
+ * setupLiveAgentInbox:
5981
+ * type: boolean
5982
+ * whisperAssistConfiguration:
5983
+ * type: string
5984
+ * enum:
5985
+ * - none
5986
+ * - basic
5987
+ * - template
5495
5988
  */
5496
5989
  export interface ICreateProjectByTemplateRestDataBody_2_0 extends Partial<Omit<IProject_2_0, keyof IEntityMeta>> {
5497
5990
  locale: TNluLanguage;
@@ -5502,6 +5995,10 @@ export interface ICreateProjectByTemplateRestDataBody_2_0 extends Partial<Omit<I
5502
5995
  skills: string[];
5503
5996
  template: string | null;
5504
5997
  };
5998
+ handoverConfiguration?: {
5999
+ setupLiveAgentInbox: boolean;
6000
+ whisperAssistConfiguration: TWhisperAssistConfiguration;
6001
+ };
5505
6002
  }
5506
6003
  export interface ICreateProjectByTemplateRestData_2_0 extends ICreateProjectByTemplateRestDataBody_2_0 {
5507
6004
  }
@@ -5666,6 +6163,7 @@ export interface IEndpoint extends IEntityMeta {
5666
6163
  /** Whether to override the connections in the Snapshot
5667
6164
  * with those of the Agent */
5668
6165
  overrideSnapshotConnections: boolean;
6166
+ fileStorageSettings: IFileStorageSettings;
5669
6167
  }
5670
6168
  export interface IGraphEndpoint {
5671
6169
  type: "endpoint";
@@ -5781,136 +6279,6 @@ export interface IDistanceSlot extends IBaseSlot {
5781
6279
  value: number;
5782
6280
  };
5783
6281
  }
5784
- export interface IBaseAnalyticsData {
5785
- projectId: string;
5786
- projectName: string;
5787
- contactId: string;
5788
- sessionId: string;
5789
- inputId: string;
5790
- mode: "TextOnly" | "DataOnly" | "TextData" | "Empty";
5791
- state: string;
5792
- organisation: string;
5793
- userType: string;
5794
- channel: string;
5795
- flowLanguage: string;
5796
- flowReferenceId: string;
5797
- flowName: string;
5798
- entrypoint: string;
5799
- localeReferenceId: string;
5800
- intent: string;
5801
- ip: string;
5802
- slots: any;
5803
- timestamp: Date;
5804
- executionTime: number;
5805
- execution?: number;
5806
- nodesVisited: Array<string>;
5807
- completedGoals: Array<string>;
5808
- }
5809
- declare const analyticsType: readonly [
5810
- "input",
5811
- "output"
5812
- ];
5813
- export declare type TAnalyticsType = typeof analyticsType[number];
5814
- export declare type TAnalyticsSource = typeof analyticsSourceTypes[number];
5815
- declare const analyticsSourceTypes: readonly [
5816
- "user",
5817
- "bot",
5818
- "agent",
5819
- "suggestion"
5820
- ];
5821
- export interface IBaseAnalyticsSourceData extends IBaseAnalyticsData {
5822
- intentScore: number;
5823
- intentFlow: string;
5824
- understood: boolean;
5825
- type: TAnalyticsType;
5826
- source: TAnalyticsSource;
5827
- schemaVersion: number;
5828
- rating?: number;
5829
- ratingComment?: string;
5830
- inHandoverRequest?: boolean;
5831
- inHandoverConversation?: boolean;
5832
- chatbase?: string;
5833
- dashbot?: string;
5834
- dashbotPlatform?: TDashbotPlatform;
5835
- }
5836
- export interface IAnalyticsUserInputData {
5837
- inputText: string;
5838
- inputData: any;
5839
- userLanguageText: string;
5840
- outputId?: string;
5841
- }
5842
- export interface IAnalyticsFlowMeta {
5843
- flowName: string;
5844
- flowReferenceId: string;
5845
- }
5846
- export interface IAnalyticsSnapshotMeta {
5847
- snapshotName: string;
5848
- snapshotId: TMongoId | any;
5849
- }
5850
- export interface IAnalytiscEndpointMeta {
5851
- endpointUrlToken: string;
5852
- endpointName: string;
5853
- /** We can't use the TEndpointType as the channel can be overwritten by customer */
5854
- channel: string;
5855
- }
5856
- export interface IAnalyticsLocaleMeta {
5857
- localeName: string;
5858
- localeReferenceId: string;
5859
- }
5860
- export interface IStepEvent extends IAnalyticsFlowMeta, IAnalytiscEndpointMeta, IAnalyticsLocaleMeta, Partial<IAnalyticsSnapshotMeta> {
5861
- _id: TMongoId;
5862
- userId: string;
5863
- sessionId: string;
5864
- inputId: string;
5865
- timestamp: Date;
5866
- stepLabel: string;
5867
- /**
5868
- * The entityReferenceId
5869
- * of the step that came before this step
5870
- */
5871
- parentStep: string;
5872
- type: "intent" | "node";
5873
- entityReferenceId: string;
5874
- projectName: string;
5875
- projectId: TMongoId;
5876
- organisationId: TMongoId;
5877
- }
5878
- export interface IAnalyticsStepData {
5879
- steps: (Pick<IStepEvent, "entityReferenceId" | "flowName" | "flowReferenceId" | "parentStep" | "stepLabel" | "timestamp" | "type">)[];
5880
- trackedSteps: Pick<IStepEvent, "entityReferenceId" | "stepLabel">[];
5881
- }
5882
- declare const entrypointType: readonly [
5883
- "project",
5884
- "snapshot"
5885
- ];
5886
- export declare type TEntrypointType = typeof entrypointType[number];
5887
- export interface IAnalyticsFlowHistoryData extends IAnalyticsFlowMeta {
5888
- }
5889
- export interface IAnalyticsSourceData extends IBaseAnalyticsSourceData, IAnalyticsUserInputData, IAnalyticsStepData {
5890
- entrypointType: TEntrypointType;
5891
- trackedGoals: string[];
5892
- localeName: string;
5893
- endpointName: string;
5894
- endpointUrlToken: string;
5895
- handoverEscalations: number;
5896
- snapshotName?: string;
5897
- flowHistory?: IAnalyticsFlowHistoryData[];
5898
- custom1?: string;
5899
- custom2?: string;
5900
- custom3?: string;
5901
- custom4?: string;
5902
- custom5?: string;
5903
- custom6?: string;
5904
- custom7?: string;
5905
- custom8?: string;
5906
- custom9?: string;
5907
- custom10?: string;
5908
- previousInputText: string;
5909
- previousInputData: {};
5910
- previousSource: TAnalyticsSource;
5911
- }
5912
- export interface IEditableAnalyticsData extends Pick<IAnalyticsSourceData, "state" | "mode" | "userType" | "channel" | "flowLanguage" | "intent" | "intentScore" | "intentFlow" | "flowName" | "inHandoverRequest" | "inHandoverConversation" | "localeName" | "rating" | "ratingComment" | "entrypointType" | "endpointName" | "endpointUrlToken" | "handoverEscalations" | "snapshotName" | "slots" | "custom1" | "custom2" | "custom3" | "custom4" | "custom5" | "custom6" | "custom7" | "custom8" | "custom9" | "custom10"> {
5913
- }
5914
6282
  export interface IHandoverNodeParams extends INodeFunctionBaseParams {
5915
6283
  config: {
5916
6284
  text: string;
@@ -6082,134 +6450,117 @@ export interface IActiveEntrypoint {
6082
6450
  export interface INluWarningEventPayload {
6083
6451
  errorMessage: string;
6084
6452
  }
6085
- export interface INodeToExecute {
6086
- nodeId: string;
6087
- flowId: string;
6088
- cognigyScriptInput?: IExecutionObjects["input"];
6089
- inputObjectToRestore?: IExecutionObjects["input"];
6090
- nextMainFlowNodeInputObject?: IExecutionObjects["input"];
6091
- ignoreSlotScope?: boolean;
6092
- trackAnalyticsStepOptions?: {
6093
- entityReferenceId: string;
6453
+ export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload;
6454
+ export interface IGenericIntentFeedbackFinding {
6455
+ type: IGenericIntentFeedbackFindingType;
6456
+ }
6457
+ export interface IOverlapIntentFeedbackFinding {
6458
+ type: IOverlapIntentFeedbackFindingType;
6459
+ overlappingIntentReferenceId: string;
6460
+ overlappingIntentName: string;
6461
+ overlappingIntentId: TMongoId;
6462
+ overlappingFlowName: string;
6463
+ overlappingFlowId: TMongoId;
6464
+ }
6465
+ export interface ILowDataIntentFeedbackFinding {
6466
+ type: "lowDataIntents";
6467
+ intents: {
6468
+ intentReferenceId: string;
6469
+ intentName: string;
6470
+ intentId: string;
6471
+ flowId: string;
6094
6472
  flowName: string;
6095
- flowReferenceId: string;
6096
- type: "intent" | "node";
6097
- stepLabel: string;
6473
+ }[];
6474
+ }
6475
+ declare const overlapIntentFeedbackFindingArrayType: readonly [
6476
+ "strongOverlap",
6477
+ "someOverlap"
6478
+ ];
6479
+ export declare type IOverlapIntentFeedbackFindingType = typeof overlapIntentFeedbackFindingArrayType[number];
6480
+ declare const genericIntentFeedbackFindingArrayType: readonly [
6481
+ "poorFScore",
6482
+ "fairFScore",
6483
+ "goodFScore",
6484
+ "fewSentences",
6485
+ "unclearIntent",
6486
+ "noSiblings"
6487
+ ];
6488
+ export declare type IGenericIntentFeedbackFindingType = typeof genericIntentFeedbackFindingArrayType[number];
6489
+ export declare type IntentFeedbackFinding = IGenericIntentFeedbackFinding | IOverlapIntentFeedbackFinding | ILowDataIntentFeedbackFinding;
6490
+ export interface IIntentFeedbackInDBReport {
6491
+ findings: IntentFeedbackFinding[];
6492
+ info: {
6493
+ fScore: number;
6098
6494
  };
6099
- type?: "stopExecution" | "resetCognigyScriptInput" | "trackAnalyticsStep";
6100
6495
  }
6101
- export interface IHandoverRequestStatus {
6102
- requested: boolean;
6103
- activeConversation: boolean;
6104
- text: string;
6105
- cancelIntent: string;
6106
- quickreplyTitle: string;
6107
- handoverVersion: "v1" | "v2";
6108
- sessionId: string;
6109
- userId: string;
6110
- provider: THandoverProvider;
6111
- repeatHandoverMessage: boolean;
6496
+ declare const intentTypes: readonly [
6497
+ "yesNoIntent",
6498
+ "default"
6499
+ ];
6500
+ export declare type TIntentTypes = typeof intentTypes[number];
6501
+ export interface ILocalizedIntentData {
6502
+ rules: string[];
6503
+ condition: string;
6504
+ confirmationSentences: string[];
6505
+ disambiguationSentence: string;
6506
+ localeReference: TMongoId;
6112
6507
  }
6113
- export interface ISessionState extends ISessionStateWithoutMeta {
6114
- /**
6115
- * The Mongo ObjectId. Typed as any due
6116
- * to extending the mongoose document below.
6117
- */
6118
- _id: any;
6119
- /**
6120
- * The id of the user.
6121
- */
6122
- userId: string;
6508
+ export interface IIntentInDB extends Omit<IIntent, keyof ILocalizedIntentData> {
6509
+ localizedData: ILocalizedIntentData[];
6123
6510
  /**
6124
- * The unique identifier of the
6125
- * current session (conversation) the
6126
- * user is having.
6511
+ * A list of all of the locales
6512
+ * that are not disabled. Used to return
6513
+ * the correct isDisabled value for the
6514
+ * given locale
6127
6515
  */
6128
- sessionId: string;
6129
- /**
6130
- * The 'epoch' is a value which we will increase whenever
6131
- * we dispatch a change for the session state. We use it
6132
- * to avoid that we apply outdated updates to the session state
6133
- */
6134
- epoch: number;
6135
- /**
6136
- * Date when this object will expire in the database. We utilize a
6137
- * time-based index in MongoDB.
6138
- */
6139
- expiresAt: Date;
6516
+ enabledLocaleReferences: TMongoId[];
6140
6517
  }
6141
- export interface ISessionStateWithoutMeta {
6142
- /**
6143
- * The context object that the user
6144
- * can manipulate in the Flow.
6145
- * Moves from string at storage to object in memory
6146
- */
6147
- context: {
6148
- [key: string]: any;
6149
- } | string;
6150
- /**
6151
- * The system context stores information
6152
- * like execution number and Flow paths.
6153
- */
6154
- systemContext: {
6155
- [key: string]: any;
6156
- };
6157
- /**
6158
- * The current Flow state.
6159
- */
6160
- state: string;
6161
- flowId: string;
6162
- thinkFlowReferenceIdMarker: string;
6163
- localeReferenceId: string;
6518
+ export interface IIntent extends IEntityMeta, ILocalizedIntentData {
6519
+ name: string;
6520
+ referenceId: string;
6521
+ isRejectIntent: boolean;
6522
+ isDisabled: boolean;
6523
+ tags: string[];
6524
+ data: any;
6525
+ nodeReferenceId: string;
6526
+ childFeatures?: boolean | string[];
6527
+ parentIntentId?: string;
6528
+ feedbackReport: IIntentFeedbackInDBReport;
6529
+ intentRelationReferences: TMongoId[];
6530
+ flowReference?: TMongoId;
6531
+ projectReference: TMongoId;
6532
+ organisationReference: TMongoId;
6533
+ flowReferenceId?: string;
6164
6534
  /**
6165
- * The snapshot / project
6166
- * the user is using
6535
+ * A label we use in analytics
6536
+ * to track when an intent was triggered
6167
6537
  */
6168
- entrypoint: string;
6169
- entrypointType: "project" | "snapshot";
6170
- projectId: string;
6171
- timezoneOffset: number | string;
6172
- /**
6173
- * Forms/Processes need the any slots of the calling flow to map injected any slots
6174
- */
6175
- injectedAnySlots: {
6176
- [key: string]: string;
6177
- };
6178
- reconfirmedSentences: {
6179
- [key: string]: string[];
6180
- };
6181
- endpointClientInstanceId?: string;
6182
- endpointId?: string;
6183
- previousInputId: string | null;
6184
- previousInputMessageAmount: number;
6185
- sensitiveLoggingSettings: ISensitiveLoggingSettings;
6186
- sentWelcomeMessage?: boolean;
6187
- nodesToExecuteStack?: INodeToExecute[];
6188
- trackedSteps?: IAnalyticsStepData["trackedSteps"];
6189
- trackedGoals?: IAnalyticsSourceData["trackedGoals"];
6190
- handoverEscalations?: IAnalyticsSourceData["handoverEscalations"];
6191
- previousInputText?: IAnalyticsSourceData["previousInputText"];
6192
- previousInputData?: IAnalyticsSourceData["previousInputData"];
6193
- previousSource?: IAnalyticsSourceData["previousSource"];
6194
- handoverRequest?: IHandoverRequestStatus;
6195
- appSessionToken?: string;
6196
- frustration?: number;
6538
+ analyticsLabel?: string;
6197
6539
  /**
6198
- * The list of nodes that were visited in the last
6199
- * Flow execution
6540
+ * Enable the usage of default replies as example sentences
6200
6541
  */
6201
- lastFlowPath?: string;
6542
+ overrideIntentDefaultRepliesAsExamples?: string;
6543
+ intentType: TIntentTypes;
6202
6544
  }
6203
- export declare type TSessionStateEmitParams = {
6204
- userId: string;
6205
- sessionId: string;
6206
- epoch: number;
6207
- traceId: string;
6208
- disableSensitiveLogging: boolean;
6209
- valuesToUpdate: Partial<ISessionState>;
6210
- };
6211
- export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload | INluWarningEventPayload | TSessionStateEmitParams;
6212
- export declare type TVoiceGateway2TTSVendor = "google" | "aws" | "polly" | "microsoft" | "default";
6545
+ export interface IYesNoData {
6546
+ _id: string;
6547
+ rules: string[];
6548
+ name: string;
6549
+ isDisabled: boolean;
6550
+ }
6551
+ export interface IYesNoItem {
6552
+ yesIntent: IYesNoData | IIntentInDB;
6553
+ noIntent: IYesNoData | IIntentInDB;
6554
+ rejectIntent: IYesNoData | IIntentInDB;
6555
+ }
6556
+ declare const arrayAudioPreviewProviders: readonly [
6557
+ "none",
6558
+ "microsoft",
6559
+ "google",
6560
+ "aws"
6561
+ ];
6562
+ export declare type TAudioPreviewProvider = typeof arrayAudioPreviewProviders[number];
6563
+ export declare type TVoiceGateway2TTSVendor = "google" | "aws" | "microsoft" | "default";
6213
6564
  export declare type TVoiceGateway2UserNoInputMode = "event" | "speech" | "play";
6214
6565
  export interface IGetNluPipelineParams {
6215
6566
  parseIntents?: boolean;
@@ -6222,6 +6573,33 @@ export interface ITrackAnalyticsStepsArguments {
6222
6573
  flowReferenceId: string;
6223
6574
  flowName: string;
6224
6575
  }
6576
+ export declare type TAnyProviderResponse = ISalesforceProviderResponse;
6577
+ export interface ISalesforceProviderResponse {
6578
+ session: {
6579
+ affinityToken: string;
6580
+ key: string;
6581
+ id: string;
6582
+ };
6583
+ }
6584
+ export interface IHandoverRequestStatus {
6585
+ requested: boolean;
6586
+ activeConversation: boolean;
6587
+ text: string;
6588
+ cancelIntent: string;
6589
+ quickreplyTitle: string;
6590
+ handoverVersion: "v1" | "v2";
6591
+ sessionId: string;
6592
+ userId: string;
6593
+ provider: THandoverProvider;
6594
+ repeatHandoverMessage: boolean;
6595
+ sendResolveEventToBot: boolean;
6596
+ resolveBehavior: "resetEntrypoint" | "continueEntrypoint";
6597
+ nodeType: "question" | "handoverToAgent";
6598
+ agentAssistInitMessage: string;
6599
+ processedInitMessage?: boolean;
6600
+ agentAssistConfigured: boolean;
6601
+ providerResponse: TAnyProviderResponse;
6602
+ }
6225
6603
  export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
6226
6604
  config: {
6227
6605
  text: string;
@@ -6229,9 +6607,30 @@ export interface IHandoverNodeV2Params extends INodeFunctionBaseParams {
6229
6607
  quickReply: string;
6230
6608
  chatwootInboxId: string;
6231
6609
  liveAgentInboxId: string;
6610
+ sendTranscriptAsFirstMessage: boolean;
6232
6611
  salesforcePrechatDetails: object[];
6233
6612
  salesforcePrechatEntities: object[];
6234
6613
  repeatHandoverMessage: boolean;
6614
+ sendResolveEvent: boolean;
6615
+ resolveBehavior: "resetEntrypoint" | "continueEntrypoint";
6616
+ allowAgentInject: boolean;
6617
+ agentAssistInitMessage: string;
6618
+ };
6619
+ nodeType?: "question" | "handoverToAgent";
6620
+ }
6621
+ export interface ICheckAgentAvailabilityNodeParams extends INodeFunctionBaseParams {
6622
+ config: {
6623
+ chatwootInboxId: string;
6624
+ liveAgentInboxId: string;
6625
+ genesysCloudSkills: Array<string>;
6626
+ genesysCloudProfileSkills: Array<string>;
6627
+ genesysCloudLanguageSkills: Array<string>;
6628
+ storeLocation: "input" | "context";
6629
+ inputKey: string;
6630
+ contextKey: string;
6631
+ abortOnError: boolean;
6632
+ errorLogging: "none" | "basic" | "full";
6633
+ logWarning: string;
6235
6634
  };
6236
6635
  }
6237
6636
  export interface ITriggerFunctionNodeParams extends INodeFunctionBaseParams {
@@ -6265,6 +6664,7 @@ export interface IExecuteCognigyNLUNodeParams extends INodeFunctionBaseParams {
6265
6664
  parseSlots: boolean;
6266
6665
  parseSystemSlots: boolean;
6267
6666
  findType: boolean;
6667
+ processDefaultReply: boolean;
6268
6668
  };
6269
6669
  }
6270
6670
  export interface IExtractAnswerNodeParams extends INodeFunctionBaseParams {
@@ -6292,6 +6692,7 @@ export interface IMatchPatternParams extends INodeFunctionBaseParams {
6292
6692
  detailedCompoundSlots: boolean;
6293
6693
  createNewSlots: boolean;
6294
6694
  tagExistingSlots: boolean;
6695
+ useFullSystemslotText: boolean;
6295
6696
  };
6296
6697
  }
6297
6698
  export interface IFuzzySearchParams extends INodeFunctionBaseParams {
@@ -6317,6 +6718,7 @@ export interface ISensitiveLoggingSettings {
6317
6718
  maskLogging: boolean;
6318
6719
  maskAnalytics: boolean;
6319
6720
  disableConversations: boolean;
6721
+ disableIntentTrainer: boolean;
6320
6722
  }
6321
6723
  export interface INLProperties extends ICognigyNLPProperties {
6322
6724
  timeReference?: any;
@@ -6343,6 +6745,7 @@ export interface IActions {
6343
6745
  activateProfile?: () => Promise<any>;
6344
6746
  addLexiconKeyphrase?: (lexicon: string, keyphrase: string, slots: Array<string>, synonyms: Array<string>, data?: Object) => void;
6345
6747
  addToContext?: (key: string, value: any, mode: string) => void;
6748
+ checkAgentAvailability?: (params: ICheckAgentAvailabilityNodeParams) => void;
6346
6749
  checkFrustration?: (nodeId: string, input: any) => void;
6347
6750
  checkThink?: (id: string) => boolean;
6348
6751
  completeGoal?: (key: string) => void;
@@ -6357,7 +6760,8 @@ export interface IActions {
6357
6760
  getSystemContext?: (key: string) => any;
6358
6761
  emitEvent?: TEmitter;
6359
6762
  executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => void;
6360
- executeCognigyNLU?: (text: string, data: any, inputId: string, pipeline: IGetNluPipelineParams) => Promise<INLProperties>;
6763
+ executeCognigyNLU?: (params: IExecuteCognigyNLUParams) => Promise<INLProperties>;
6764
+ handleIntentDefaultReply?: (params: INLProperties) => Promise<any>;
6361
6765
  extractAnswer?: (extractAnswerParams: IExtractAnswerNodeParams) => Promise<void>;
6362
6766
  getAnalyticsData?: () => IAnalyticsSourceData;
6363
6767
  setAnalyticsData?: (key: string, value: any) => void;
@@ -6371,7 +6775,9 @@ export interface IActions {
6371
6775
  };
6372
6776
  getSystemContextObject?: () => any;
6373
6777
  handover?: (handoverParams: IHandoverNodeParams) => Promise<void>;
6374
- handoverV2?: (handoverParams: IHandoverNodeV2Params) => Promise<IHandoverStatusInputObject>;
6778
+ handoverV2?: (handoverParams: IHandoverNodeV2Params & {
6779
+ nodeType?: "question" | "handoverToAgent";
6780
+ }) => Promise<IHandoverStatusInputObject>;
6375
6781
  isCompatibleRuntimeVersion?: (params: {
6376
6782
  targetRuntimeVersion: number;
6377
6783
  }) => boolean;
@@ -6380,15 +6786,15 @@ export interface IActions {
6380
6786
  parseCognigyScriptText?: (executionObjects: IExecutionObjects) => (text: string) => string;
6381
6787
  parseCognigyScriptCondition?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => string;
6382
6788
  parseCognigyScriptResultLocation?: (executionObjects: IExecutionObjects, nodeId: string) => (condition: string) => any;
6383
- output?: (text: string, data: any) => void;
6384
- outputWithMeta?: (text: string, data: any, metadata?: IOutputEventMetadata) => void;
6789
+ output?: (text: string, data: any, settings?: ISayNodeSettings) => void;
6790
+ outputWithMeta?: (text: string, data: any, metadata?: IOutputEventMetadata, settings?: ISayNodeSettings) => void;
6385
6791
  reloadBrainFlow?: (flowReferenceId: string) => Promise<void>;
6386
6792
  removeFromContext?: (key: string, value: string, mode: string) => void;
6387
- requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean) => void;
6793
+ requestHandover?: (text: string, cancel: string, userId: string, sessionId: string, requestHandover: string, inputAnalyticsData: IAnalyticsSourceData, handoverVersion?: IHandoverRequestStatus["handoverVersion"], repeatHandoverMessage?: boolean, sendResolveEvent?: boolean, resolveBehavior?: IHandoverRequestStatus["resolveBehavior"], nodeType?: IHandoverRequestStatus["nodeType"], agentAssistInitMessage?: string, providerResponse?: any) => void;
6388
6794
  resetContext?: () => Promise<object>;
6389
6795
  resetFormBrain?: () => Promise<void>;
6390
6796
  resetState?: () => Promise<string>;
6391
- say?: (text: string, data?: any) => void;
6797
+ say?: (text: string, data?: any, settings?: ISayNodeSettings) => void;
6392
6798
  sendHttpRequest?: (httpRequestParams: IHttpRequestNodeParams) => Promise<void>;
6393
6799
  setCache?: (key: string, val: any) => void;
6394
6800
  setContext?: (key: string, value: any) => void;
@@ -6423,6 +6829,7 @@ export interface ICognigyNLPProperties {
6423
6829
  data?: {
6424
6830
  [key: string]: any;
6425
6831
  };
6832
+ attachments?: any[];
6426
6833
  processText?: string;
6427
6834
  keyphraseText?: string;
6428
6835
  synonymText?: string;
@@ -6487,8 +6894,10 @@ export interface ICognigyNLPProperties {
6487
6894
  /** The full results of our intent mapper */
6488
6895
  intentMapperResults?: any;
6489
6896
  tokens?: string[];
6897
+ intentId?: string;
6490
6898
  intentFlow?: string;
6491
6899
  };
6900
+ entrypoint?: string;
6492
6901
  /**
6493
6902
  * DEPRECATED!!!!
6494
6903
  */
@@ -6507,7 +6916,7 @@ export declare type ICognigyNLPSlots = {
6507
6916
  /** Numbers found in the text of the user */
6508
6917
  NUMBER?: number[] | null;
6509
6918
  /** Durations found in the text of the user */
6510
- DURATION?: INLPDurationSlot | null;
6919
+ DURATION?: INLPDurationSlot[] | null;
6511
6920
  /** Temperate(s) found in the text of the user */
6512
6921
  TEMPERATURE?: number[] | null;
6513
6922
  /** Contains found age */
@@ -6561,6 +6970,10 @@ export interface INLPDateSlot {
6561
6970
  * The duration slot
6562
6971
  */
6563
6972
  export interface INLPDurationSlot {
6973
+ year?: number;
6974
+ month?: number;
6975
+ week?: number;
6976
+ day?: number;
6564
6977
  hour?: number;
6565
6978
  minute?: number;
6566
6979
  second?: number;
@@ -6611,6 +7024,15 @@ export interface IAddConditionalEntrypointParams {
6611
7024
  condition: string;
6612
7025
  cognigyScriptInput?: IExecutionObjects["input"];
6613
7026
  }
7027
+ export interface IExecuteCognigyNLUParams {
7028
+ text: string;
7029
+ data: any;
7030
+ inputId: string;
7031
+ pipeline: IGetNluPipelineParams;
7032
+ input?: {
7033
+ [key: string]: any;
7034
+ };
7035
+ }
6614
7036
  export interface IExecuteFlowNodeConfig {
6615
7037
  flowNode: {
6616
7038
  flow: string;
@@ -6810,6 +7232,7 @@ export interface ISwitchNodeParams extends INodeFunctionBaseParams {
6810
7232
  switch: {
6811
7233
  operator: string;
6812
7234
  type: TSwitchType;
7235
+ originalOperator?: string;
6813
7236
  };
6814
7237
  intentLevel: string;
6815
7238
  useStrict: boolean;
@@ -6890,7 +7313,7 @@ export interface ISetTranslationNodeParams extends INodeFunctionBaseParams {
6890
7313
  setInputLanguageOnExecutionCount: number;
6891
7314
  };
6892
7315
  }
6893
- export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep"> {
7316
+ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCondition" | "parseCognigyScriptText" | "parseCognigyScriptResultLocation" | "think" | "thinkV2" | "addConditionalEntrypoint" | "addToInput" | "resetCognigyScriptInput" | "trackAnalyticsStep" | "executeCognigyNLU" | "handleIntentDefaultReply"> {
6894
7317
  setNextNode: (nodeId: string, newFlowId?: string) => void;
6895
7318
  resetNextNodes: () => void;
6896
7319
  stopExecution: () => void;
@@ -6909,6 +7332,8 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
6909
7332
  setExecutionAmount: (nodeId: string, value: number) => void;
6910
7333
  getLastExecutionMarker?: (nodeId: string) => number;
6911
7334
  setLastExecutionMarker?: (nodeId: string, lastExecutionMarker: number) => void;
7335
+ executeCognigyNLU?: (text: string, data: any, inputId: string, pipeline: IGetNluPipelineParams) => Promise<INLProperties>;
7336
+ handleIntentDefaultReply?: (nlProperties: INLProperties) => Promise<any>;
6912
7337
  executeFlow: (config: IExecuteFlowNodeConfig) => Promise<void>;
6913
7338
  goToNode?: (config: IGoToNodeParams["config"]["flowNode"]) => Promise<void>;
6914
7339
  addConditionalEntrypoint: (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
@@ -6962,11 +7387,16 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
6962
7387
  addToInput: (key: string, value: any) => void;
6963
7388
  resetCognigyScriptInput?: () => void;
6964
7389
  setForwardDatesOnly?: () => void;
6965
- parseCognigyScript?: (text: string, condition?: boolean) => void;
7390
+ parseCognigyScript?: (text: string, condition?: boolean) => string;
6966
7391
  trackAnalyticsStep?: (step: string) => void;
6967
7392
  triggerFunction?: (config: ITriggerFunctionNodeParams["config"]) => Promise<boolean>;
6968
- initAppSession?: () => Promise<any>;
6969
- setAppState?: (appTemplateId: string, appTemplateData: string) => void;
7393
+ initAppSession?: (params?: {
7394
+ appInterimScreenOverride?: string;
7395
+ appConnectScreenOverride?: string;
7396
+ }) => Promise<any>;
7397
+ setAppState?: (appTemplateId: string, appTemplateData: unknown) => void;
7398
+ getAppSessionPin?: () => Promise<string>;
7399
+ validateDatepickerFunctionInSecureContext?: (codeToValidate: string) => string | null;
6970
7400
  }
6971
7401
  export interface INodeExecutionCognigyObject extends IExecutionObjects {
6972
7402
  api: INodeExecutionAPI;
@@ -7123,6 +7553,7 @@ declare const nodeFieldTypes: readonly [
7123
7553
  "typescript",
7124
7554
  "xml",
7125
7555
  "textArray",
7556
+ "cognigyTextArray",
7126
7557
  "keyValuePairs",
7127
7558
  "chipInput",
7128
7559
  "cognigyText",
@@ -7221,7 +7652,7 @@ export interface INodeFieldAndSectionFormElement {
7221
7652
  /** The type of the pointer, either 'field' or 'section' */
7222
7653
  type: "field" | "section";
7223
7654
  }
7224
- export declare type TCognigyNodeTagType = "basic" | "logic" | "message" | "profile" | "service" | "nlu" | "data";
7655
+ export declare type TCognigyNodeTagType = "basic" | "logic" | "message" | "analytics" | "service" | "nlu" | "data";
7225
7656
  export declare type TNodeTagType = TCognigyNodeTagType | string;
7226
7657
  export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U extends string = string> {
7227
7658
  _id?: TMongoId;
@@ -7246,7 +7677,7 @@ export interface INodeDescriptor<T extends INodeFunctionBaseParams = any, U exte
7246
7677
  * - basic
7247
7678
  * - logic
7248
7679
  * - message
7249
- * - profile
7680
+ * - analytics
7250
7681
  * - service
7251
7682
  * - nlu
7252
7683
  * - data
@@ -7277,6 +7708,22 @@ export interface IConnectionSchema extends IEntityMeta {
7277
7708
  projectReference: TMongoId;
7278
7709
  organisationReference: TMongoId;
7279
7710
  }
7711
+ export interface IAppTemplate extends IEntityMeta {
7712
+ /** The object id of this app template */
7713
+ _id: TMongoId;
7714
+ /** The technical type of the app template, e.g. 'flightSeatPicker' */
7715
+ type: string;
7716
+ /** The name of the app template, e.g. 'flightBooking' */
7717
+ extension: string;
7718
+ /** Human readable label of the app template, e.g. 'Flight Seat Picker' */
7719
+ label: string;
7720
+ /** Whether this is an internal Cognigy resource or one defined from the customer */
7721
+ isCognigy: boolean;
7722
+ /** Path to the app template relative to the root of the extension, e.g. './templates/flightSeatPicker' */
7723
+ path: string;
7724
+ projectReference: TMongoId;
7725
+ organisationReference: TMongoId;
7726
+ }
7280
7727
  export declare type IExtensionType = "nodes";
7281
7728
  export interface IExtension extends IExtensionNodePackage, IEntityMeta {
7282
7729
  /** The name of the extension */
@@ -7309,6 +7756,7 @@ export interface IExtension extends IExtensionNodePackage, IEntityMeta {
7309
7756
  export interface IExtensionNodePackage {
7310
7757
  nodes: INodeDescriptor[];
7311
7758
  connections: Pick<IConnectionSchema, "label" | "type" | "fields">[];
7759
+ appTemplates: Pick<IAppTemplate, "label" | "type" | "path">[];
7312
7760
  }
7313
7761
  export interface IGraphExtension {
7314
7762
  type: "extension";
@@ -7318,7 +7766,8 @@ export interface IGraphExtension {
7318
7766
  }
7319
7767
  declare const allowedMimeTypes: readonly [
7320
7768
  "image/png",
7321
- "image/jpeg"
7769
+ "image/jpeg",
7770
+ "application/json"
7322
7771
  ];
7323
7772
  export declare type TAllowedMimeTypes = typeof allowedMimeTypes[number];
7324
7773
  export interface IFile extends IEntityMeta {
@@ -7551,6 +8000,12 @@ export interface IValidateProjectNameRestData_2_0 extends IValidateProjectNameRe
7551
8000
  }
7552
8001
  export interface IValidateProjectNameRestReturnValue_2_0 {
7553
8002
  }
8003
+ export interface ITrainAllProjectFlowsRestDataParams_2_0 extends IProjectScope {
8004
+ }
8005
+ export interface ITrainAllProjectFlowsRestData_2_0 extends ITrainAllProjectFlowsRestDataParams_2_0 {
8006
+ }
8007
+ export interface ITrainAllProjectFlowsRestReturnValue_2_0 extends ICreatedTask_2_0 {
8008
+ }
7554
8009
  declare const overlapIntentFeedbackFindingArrayType_2_0: readonly [
7555
8010
  "strongOverlap",
7556
8011
  "someOverlap"
@@ -8280,6 +8735,9 @@ export interface IBatchSentencesRestReturnValue_2_0 {
8280
8735
  * label:
8281
8736
  * type: string
8282
8737
  * example: "A new Node"
8738
+ * analyticsLabel:
8739
+ * type: string
8740
+ * example: "Step name"
8283
8741
  * comment:
8284
8742
  * type: string
8285
8743
  * example: "this is a very important node"
@@ -8313,6 +8771,7 @@ export interface IChartNodeIndexItem_2_0 {
8313
8771
  referenceId: string;
8314
8772
  type: string;
8315
8773
  label: string;
8774
+ analyticsLabel: string;
8316
8775
  comment: string;
8317
8776
  commentColor: string;
8318
8777
  isEntryPoint: boolean;
@@ -9258,6 +9717,76 @@ export interface IDeleteLearningSentenceRestData_2_0 extends IDeleteLearningSent
9258
9717
  }
9259
9718
  export interface IDeleteLearningSentenceRestReturnValue_2_0 {
9260
9719
  }
9720
+ /**
9721
+ * @openapi
9722
+ *
9723
+ * components:
9724
+ * schemas:
9725
+ * IYesNoIntentData_2_0:
9726
+ * type: object
9727
+ * properties:
9728
+ * isDisabled:
9729
+ * type: boolean
9730
+ * name:
9731
+ * type: string
9732
+ * example: pizza
9733
+ * _id:
9734
+ * $ref: '#/components/schemas/TMongoId'
9735
+ * rules:
9736
+ * type: array
9737
+ * items:
9738
+ * type: string
9739
+ *
9740
+ * IYesNoIntentItem_2_0:
9741
+ * type: object
9742
+ * properties:
9743
+ * yesIntent:
9744
+ * $ref: '#/components/schemas/IYesNoIntentData_2_0'
9745
+ * noIntent:
9746
+ * $ref: '#/components/schemas/IYesNoIntentData_2_0'
9747
+ * rejectIntent:
9748
+ * $ref: '#/components/schemas/IYesNoIntentData_2_0'
9749
+ */
9750
+ export interface IYesNoIntentItem_2_0 extends IYesNoItem {
9751
+ }
9752
+ export interface IReadYesNoIntentsRestDataParams_2_0 {
9753
+ localeId: string;
9754
+ }
9755
+ export interface IReadYesNoIntentsRestReturnValue_2_0 extends IYesNoIntentItem_2_0 {
9756
+ }
9757
+ declare const arrayYesNoIntentsMode: readonly [
9758
+ "smartDetectYesNoIntents",
9759
+ "enableYesNoIntents",
9760
+ "disableYesNoIntents"
9761
+ ];
9762
+ export declare type TYesNoIntentsMode_2_0 = typeof arrayYesNoIntentsMode[number];
9763
+ export interface IUpdateYesNoIntentsRestDataParams_2_0 {
9764
+ localeId: string;
9765
+ intentId: string;
9766
+ }
9767
+ export interface IUpdateYesNoIntentRestBody_2_0 extends Pick<IIntent_2_0, "rules" | "isDisabled"> {
9768
+ }
9769
+ export interface IUpdateYesNoIntentRestData_2_0 extends IUpdateYesNoIntentRestBody_2_0, IUpdateYesNoIntentsRestDataParams_2_0 {
9770
+ }
9771
+ export interface IUpdateNoIntentsRestReturnValue_2_0 extends IYesNoIntentItem_2_0 {
9772
+ }
9773
+ export interface IDeleteYesNoIntentRestDataParams_2_0 {
9774
+ localeId: string;
9775
+ intentId: string;
9776
+ }
9777
+ export interface IDeleteYesNoIntentRestData_2_0 extends IDeleteYesNoIntentRestDataParams_2_0 {
9778
+ }
9779
+ export interface IDeleteYesNoIntentRestReturnValue_2_0 {
9780
+ }
9781
+ export interface ITrainYesNoIntentsRestDataParams_2_0 {
9782
+ localeId?: string;
9783
+ }
9784
+ export interface ITrainYesNoIntentsRestDataBody_2_0 {
9785
+ }
9786
+ export interface ITrainYesNoIntentsRestData_2_0 extends ITrainYesNoIntentsRestDataParams_2_0, ITrainYesNoIntentsRestDataBody_2_0 {
9787
+ }
9788
+ export interface ITrainYesNoIntentsRestReturnValue_2_0 extends ICreatedTask_2_0 {
9789
+ }
9261
9790
  /**
9262
9791
  * @openapi
9263
9792
  *
@@ -9310,6 +9839,11 @@ export interface IDeleteLearningSentenceRestReturnValue_2_0 {
9310
9839
  * type: boolean
9311
9840
  * useURLSlots:
9312
9841
  * type: boolean
9842
+ * yesNoIntentsMode:
9843
+ * type: string
9844
+ * enum: [smartDetectYesNoIntents, enableYesNoIntents, disableYesNoIntents]
9845
+ * yesNoIntentThreshold:
9846
+ * type: integer
9313
9847
  */
9314
9848
  export interface ISharedSettings_2_0 {
9315
9849
  positiveConfirmationWords: string[];
@@ -9338,6 +9872,8 @@ export interface ISharedSettings_2_0 {
9338
9872
  learnNewExampleSentences: boolean;
9339
9873
  /** The threshold after which a 'learning sentence' is a learned sentence */
9340
9874
  learnNewExampleSentencesThreshold: number;
9875
+ yesNoIntentsMode: TYesNoIntentsMode_2_0;
9876
+ yesNoIntentThreshold: number;
9341
9877
  }
9342
9878
  /**
9343
9879
  * @openapi
@@ -9435,31 +9971,119 @@ export declare type TTranslationProvider_2_0 = "none" | "microsoft" | "google" |
9435
9971
  * description: How long to keep translated sentences in the cache (in seconds)
9436
9972
  * translationRegion:
9437
9973
  * type: string
9438
- * maxLength: 255
9439
- * description: Optional translation region, e.g. Ocp-Apim-Subscription-Region for Microsoft Translator
9974
+ * maxLength: 255
9975
+ * description: Optional translation region, e.g. Ocp-Apim-Subscription-Region for Microsoft Translator
9976
+ */
9977
+ export interface IAgentTranslationSettings_2_0 {
9978
+ translationProvider: TTranslationProvider_2_0;
9979
+ translationAPIKey: string;
9980
+ translationProviderCustomBaseUrl?: string;
9981
+ translationRetries: number;
9982
+ translationTimeout: number;
9983
+ translationCacheExpiry: number;
9984
+ translationRegion?: string;
9985
+ }
9986
+ /**
9987
+ * @openapi
9988
+ *
9989
+ * components:
9990
+ * schemas:
9991
+ * TAudioPreviewProvider_2_0:
9992
+ * type: string
9993
+ * description: Supported AudioPreview Providers
9994
+ * enum:
9995
+ * - none
9996
+ * - microsoft
9997
+ */
9998
+ export declare type TAudioPreviewProvider_2_0 = "none" | "microsoft" | "google" | "aws";
9999
+ /**
10000
+ * @openapi
10001
+ *
10002
+ * components:
10003
+ * schemas:
10004
+ * IAudioPreviewMicrosoftSettings_2_0:
10005
+ * type: object
10006
+ * properties:
10007
+ * apiKey:
10008
+ * type: string
10009
+ * maxLength: 30
10010
+ * description: MS API Key
10011
+ * region:
10012
+ * type: string
10013
+ * maxLength: 30
10014
+ * description: MS region
10015
+ */
10016
+ export interface IAudioPreviewMicrosoftSettings_2_0 {
10017
+ apiKey: string;
10018
+ region?: string;
10019
+ }
10020
+ /**
10021
+ * @openapi
10022
+ *
10023
+ * components:
10024
+ * schemas:
10025
+ * IAudioPreviewAWSSettings_2_0:
10026
+ * type: object
10027
+ * properties:
10028
+ * accessKeyId:
10029
+ * type: string
10030
+ * maxLength: 100
10031
+ * description: AWS API Id
10032
+ * secretAccessKey:
10033
+ * type: string
10034
+ * maxLength: 150
10035
+ * description: AWS API accesss Key
10036
+ * sessionToken:
10037
+ * type: string
10038
+ * maxLength: 300
10039
+ * description: AWS API session token
10040
+ * region:
10041
+ * type: string
10042
+ * maxLength: 30
10043
+ * description: AWS region
9440
10044
  */
9441
- export interface IAgentTranslationSettings_2_0 {
9442
- translationProvider: TTranslationProvider_2_0;
9443
- translationAPIKey: string;
9444
- translationProviderCustomBaseUrl?: string;
9445
- translationRetries: number;
9446
- translationTimeout: number;
9447
- translationCacheExpiry: number;
9448
- translationRegion?: string;
10045
+ export interface IAudioPreviewAWSSettings_2_0 {
10046
+ accessKeyId: string;
10047
+ secretAccessKey: string;
10048
+ sessionToken?: string;
10049
+ region?: string;
9449
10050
  }
9450
10051
  /**
9451
10052
  * @openapi
9452
10053
  *
9453
10054
  * components:
9454
10055
  * schemas:
9455
- * TAudioPreviewProvider_2_0:
9456
- * type: string
9457
- * description: Supported AudioPreview Providers
9458
- * enum:
9459
- * - none
9460
- * - microsoft
10056
+ * IAudioPreviewGoogleSettings_2_0:
10057
+ * type: object
10058
+ * properties:
10059
+ * googleCredentialsFileName:
10060
+ * type: string
10061
+ * maxLength: 100
10062
+ * description: Google Cloud credentials .json file
10063
+ * fileToken:
10064
+ * type: string
10065
+ * maxLength: 500
10066
+ * description: Credentials file token
10067
+ * credentialsStringified:
10068
+ * type: string
10069
+ * maxLength: 300
10070
+ * description: Credentials file stringified
10071
+ * clientEmail:
10072
+ * type: string
10073
+ * maxLength: 300
10074
+ * description: Client Email from the Google Cloud credentials .json file
10075
+ * privateKey:
10076
+ * type: string
10077
+ * maxLength: 150
10078
+ * description: Client private key from Google credentials file name
9461
10079
  */
9462
- export declare type TAudioPreviewProvider_2_0 = "none" | "microsoft";
10080
+ export interface IAudioPreviewGoogleSettings_2_0 {
10081
+ googleCredentialsFileName: string;
10082
+ fileToken: string;
10083
+ credentialsStringified: string;
10084
+ clientEmail: string;
10085
+ privateKey: string;
10086
+ }
9463
10087
  /**
9464
10088
  * @openapi
9465
10089
  *
@@ -9470,14 +10094,12 @@ export declare type TAudioPreviewProvider_2_0 = "none" | "microsoft";
9470
10094
  * properties:
9471
10095
  * audioPreviewProvider:
9472
10096
  * $ref: '#/components/schemas/TAudioPreviewProvider_2_0'
9473
- * audioPreviewAPIKey:
9474
- * type: string
9475
- * maxLength: 30
9476
- * description: Audio preview Provider API Key
9477
- * audioPreviewRegion:
9478
- * type: string
9479
- * maxLength: 255
9480
- * description: Optional region corresponding to the API key
10097
+ * microsoft:
10098
+ * $ref: '#/components/schemas/IAudioPreviewMicrosoftSettings_2_0'
10099
+ * aws:
10100
+ * $ref: '#/components/schemas/IAudioPreviewAWSSettings_2_0'
10101
+ * google:
10102
+ * $ref: '#/components/schemas/IAudioPreviewGoogleSettings_2_0'
9481
10103
  */
9482
10104
  /**
9483
10105
  * The supporting optional fields are not shown in Open API documentation
@@ -9485,12 +10107,13 @@ export declare type TAudioPreviewProvider_2_0 = "none" | "microsoft";
9485
10107
  */
9486
10108
  export interface IAgentAudioPreviewSettings_2_0 {
9487
10109
  audioPreviewProvider: TAudioPreviewProvider_2_0;
9488
- audioPreviewAPIKey?: string;
10110
+ microsoft?: IAudioPreviewMicrosoftSettings_2_0;
10111
+ aws?: IAudioPreviewAWSSettings_2_0;
10112
+ google?: IAudioPreviewGoogleSettings_2_0;
9489
10113
  audioPreviewProviderCustomBaseUrl?: string;
9490
10114
  audioPreviewRetries?: number;
9491
10115
  audioPreviewTimeout?: number;
9492
10116
  audioPreviewCacheExpiry?: number;
9493
- audioPreviewRegion?: string;
9494
10117
  }
9495
10118
  export interface IReadAgentSettingsRestDataParams_2_0 extends IProjectScope {
9496
10119
  }
@@ -9506,6 +10129,23 @@ export interface IUpdateAgentSettingsRestData_2_0 extends IUpdateAgentSettingsRe
9506
10129
  }
9507
10130
  export interface IUpdateAgentSettingsRestReturnValue_2_0 {
9508
10131
  }
10132
+ /**
10133
+ * @openapi
10134
+ *
10135
+ * components:
10136
+ * schemas:
10137
+ * ILocaleSettings_2_0:
10138
+ * type: object
10139
+ * properties:
10140
+ * localeReference:
10141
+ * $ref: '#/components/schemas/TMongoId'
10142
+ * inheritFallbackLocaleModel:
10143
+ * type: boolean
10144
+ */
10145
+ export interface ILocaleSettings_2_0 {
10146
+ localeReference: string;
10147
+ inheritFallbackLocaleModel: boolean;
10148
+ }
9509
10149
  /**
9510
10150
  * @openapi
9511
10151
  *
@@ -9541,10 +10181,50 @@ export interface IUpdateAgentSettingsRestReturnValue_2_0 {
9541
10181
  * useIntentDefaultRepliesAsExamples:
9542
10182
  * description: 'Enable/Disable using default replies as training examples.'
9543
10183
  * type: boolean
10184
+ * localeSettings:
10185
+ * $ref: '#/components/schemas/ILocaleSettings_2_0'
10186
+ *
10187
+ * IFlowSettingsResponse_2_0:
10188
+ * type: object
10189
+ * properties:
10190
+ * continueExecutionAfterAttachedFlow:
10191
+ * type: boolean
10192
+ * continueExecutionAterDefaultReply:
10193
+ * type: boolean
10194
+ * continueExecutionAfterNegativeConfirmation:
10195
+ * type: boolean
10196
+ * passDefaultRepliesIntoFlow:
10197
+ * type: boolean
10198
+ * flowIntentMappingOrder:
10199
+ * type: string
10200
+ * enum: ["joint", "main", "attached"]
10201
+ * useAttachedFlowThresholds:
10202
+ * type: boolean
10203
+ * useAttachedFlowContinueAfterDefaultReply:
10204
+ * type: boolean
10205
+ * useAttachedFlowPassDefaultRepliesIntoFlow:
10206
+ * type: boolean
10207
+ * implicitSlotParsing:
10208
+ * type: string
10209
+ * enum: ["disabled", "full", "system", "lexicon"]
10210
+ * useAttachedFlowImplicitSlotParsing:
10211
+ * type: boolean
10212
+ * lexiconSlotsWithSubMatches:
10213
+ * type: boolean
10214
+ * useIntentDefaultRepliesAsExamples:
10215
+ * description: 'Enable/Disable using default replies as training examples.'
10216
+ * type: boolean
10217
+ * localeSettings:
10218
+ * type: array
10219
+ * items:
10220
+ * type: object
10221
+ * properties:
10222
+ * type:
10223
+ * $ref: '#/components/schemas/ILocaleSettings_2_0'
9544
10224
  *
9545
10225
  * IFlowSettings_2_0:
9546
10226
  * allOf:
9547
- * - $ref: '#/components/schemas/IFlowSettingsData_2_0'
10227
+ * - $ref: '#/components/schemas/IFlowSettingsResponse_2_0'
9548
10228
  * - $ref: '#/components/schemas/ISharedSettings_2_0'
9549
10229
  * - $ref: '#/components/schemas/IEntityMeta'
9550
10230
  */
@@ -9562,13 +10242,17 @@ export interface IFlowSettings_2_0 extends ISharedSettings_2_0 {
9562
10242
  useAttachedFlowImplicitSlotParsing: boolean;
9563
10243
  lexiconSlotsWithSubMatches: boolean;
9564
10244
  useIntentDefaultRepliesAsExamples: boolean;
10245
+ localeSettings: ILocaleSettings_2_0;
10246
+ }
10247
+ export interface IFlowSettingsResponse_2_0 extends Omit<IFlowSettings_2_0, "localeSettings"> {
10248
+ localeSettings: ILocaleSettings_2_0[];
9565
10249
  }
9566
10250
  export interface IReadFlowSettingsRestDataParams_2_0 {
9567
10251
  flowId: string;
9568
10252
  }
9569
10253
  export interface IReadFlowSettingsRestData_2_0 extends IReadFlowSettingsRestDataParams_2_0 {
9570
10254
  }
9571
- export interface IReadFlowSettingsRestReturnValue_2_0 extends IFlowSettings_2_0 {
10255
+ export interface IReadFlowSettingsRestReturnValue_2_0 extends IFlowSettingsResponse_2_0 {
9572
10256
  }
9573
10257
  export interface IUpdateFlowSettingsRestDataBody_2_0 extends Partial<Omit<IFlowSettings_2_0, keyof IEntityMeta>> {
9574
10258
  }
@@ -10077,6 +10761,7 @@ export interface IIndexExtensionsRestReturnValue_2_0 extends ICursorBasedPaginat
10077
10761
  export interface IUploadExtensionRestDataBody_2_0 extends IProjectScope {
10078
10762
  file?: File | Buffer;
10079
10763
  url?: string;
10764
+ name?: string;
10080
10765
  }
10081
10766
  export interface IUploadExtensionRestData_2_0 extends IUploadExtensionRestDataBody_2_0 {
10082
10767
  }
@@ -10588,15 +11273,30 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
10588
11273
  *
10589
11274
  * components:
10590
11275
  * schemas:
10591
- * IConnectionDataUpdate_2_0:
11276
+ * IConnectionDataFields_2_0:
10592
11277
  * type: object
10593
11278
  * properties:
10594
11279
  * fields:
10595
11280
  * type: object
10596
- * description: The fields of the Connection. Key-Value pairs.
11281
+ * description: The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.
10597
11282
  * minProperties: 1
10598
11283
  * maxProperties: 10
10599
- * example: { "apiKey": "x123sdfu12312" }
11284
+ * example: { "some-key-from-connection-schema": "x123sdfu12312" }
11285
+ *
11286
+ * IConnectionDataCreate_2_0:
11287
+ * allOf:
11288
+ * - type: object
11289
+ * properties:
11290
+ * name:
11291
+ * type: string
11292
+ * example: "some name"
11293
+ * type:
11294
+ * type: string
11295
+ * example: "http_basic"
11296
+ * extension:
11297
+ * type: string
11298
+ * example: "@cognigy/basic-nodes"
11299
+ * - $ref: '#/components/schemas/IConnectionDataFields_2_0'
10600
11300
  *
10601
11301
  * IConnectionData:
10602
11302
  * allOf:
@@ -10610,12 +11310,6 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
10610
11310
  * type: string
10611
11311
  * description: The name of the Connection
10612
11312
  * example: Azure API
10613
- * fields:
10614
- * type: object
10615
- * description: The fields of the Connection. Key-Value pairs.
10616
- * minProperties: 1
10617
- * maxProperties: 10
10618
- * example: { "apiKey": "x123sdfu12312" }
10619
11313
  * connectionSchema:
10620
11314
  * type: object
10621
11315
  * description: Identifies the schema which should be used to validate the connection fields.
@@ -10628,7 +11322,7 @@ export interface IIndexConnectionsRestReturnValue_2_0 extends ICursorBasedPagina
10628
11322
  * type: string
10629
11323
  * description: The type of the connection defined in the extension.
10630
11324
  * example: 'oauth2'
10631
- * - $ref: '#/components/schemas/IConnectionDataUpdate_2_0'
11325
+ * - $ref: '#/components/schemas/IConnectionDataFields_2_0'
10632
11326
  *
10633
11327
  * IConnection_2_0:
10634
11328
  * allOf:
@@ -10696,8 +11390,8 @@ export interface IDeleteConnectionRestReturnValue_2_0 {
10696
11390
  * properties:
10697
11391
  * key:
10698
11392
  * type: string
10699
- * description: The key of the connection field
10700
- * example: client_id
11393
+ * description: The key of the connection field. The key should match the connection schema of the specific connection type.
11394
+ * example: some-key-from-connection-schema
10701
11395
  * value:
10702
11396
  * type: string
10703
11397
  * description: The value of the connection field
@@ -11807,6 +12501,8 @@ export interface IDatePickerConfig {
11807
12501
  datepicker_noCalendar: boolean;
11808
12502
  datepicker_weekNumbers: boolean;
11809
12503
  datepicker_hidePicker: boolean;
12504
+ datepicker_functionEnable: string;
12505
+ datepicker_functionDisable: string;
11810
12506
  }
11811
12507
  export interface IDatePickerNodeParams extends INodeFunctionBaseParams {
11812
12508
  config: IDatePickerConfig;
@@ -11816,6 +12512,7 @@ export interface ISayNodeConfigParams {
11816
12512
  data: any;
11817
12513
  loop: boolean;
11818
12514
  linear: boolean;
12515
+ liveAgentSettings?: ILiveAgentSettings;
11819
12516
  type: "text" | "quickReplies" | "gallery" | "buttons" | "image" | "list" | "adaptiveCard";
11820
12517
  _cognigy: {
11821
12518
  [key: string]: unknown;
@@ -11866,8 +12563,13 @@ export interface IQuestionNodeSharedConfig {
11866
12563
  escalateAnswersHandoverQuickReply: string;
11867
12564
  escalateAnswersHandoverChatwootInboxId: string;
11868
12565
  escalateAnswersHandoverLiveAgentInboxId: string;
12566
+ escalateAnswersHandoverSendTranscriptAsFirstMessage: boolean;
11869
12567
  escalateAnswersHandoverSalesforcePrechatEntities: object[];
11870
12568
  escalateAnswersHandoverSalesforcePrechatDetails: object[];
12569
+ escalateAnswersHandoverSendResolveEvent: boolean;
12570
+ escalateAnswersHandoverResolveBehavior: "resetEntrypoint" | "continueEntrypoint";
12571
+ escalateAnswersAgentAssistInitMessage: string;
12572
+ escalateAnswersAllowAgentInject: boolean;
11871
12573
  escalateIntentsAction: "none" | "goto" | "execute" | "skip" | "text" | "handover";
11872
12574
  escalateIntentsValidIntents: string[];
11873
12575
  escalateIntentsThreshold: number;
@@ -11884,8 +12586,13 @@ export interface IQuestionNodeSharedConfig {
11884
12586
  escalateIntentsHandoverQuickReply: string;
11885
12587
  escalateIntentsHandoverChatwootInboxId: string;
11886
12588
  escalateIntentsHandoverLiveAgentInboxId: string;
12589
+ escalateIntentHandoverSendTranscriptAsFirstMessage: boolean;
11887
12590
  escalateIntentsHandoverSalesforcePrechatEntities: object[];
11888
12591
  escalateIntentsHandoverSalesforcePrechatDetails: object[];
12592
+ escalateIntentsHandoverSendResolveEvent: boolean;
12593
+ escalateIntentsHandoverResolveBehavior: "resetEntrypoint" | "continueEntrypoint";
12594
+ escalateIntentsAgentAssistInitMessage: string;
12595
+ escalateIntentsAllowAgentInject: boolean;
11889
12596
  reconfirmationBehaviour: "none" | "reconfirm";
11890
12597
  reconfirmationQuestion: string;
11891
12598
  reconfirmationQuestionReprompt: string;
@@ -11916,6 +12623,8 @@ export interface IQuestionNodeDatepickerConfig extends IQuestionNodeSharedConfig
11916
12623
  datepicker_noCalendar: boolean;
11917
12624
  datepicker_weekNumbers: boolean;
11918
12625
  datepicker_hidePicker: boolean;
12626
+ datepicker_functionEnable: string;
12627
+ datepicker_functionDisable: string;
11919
12628
  }
11920
12629
  export interface IQuestionNodeKeyphraseConfig extends IQuestionNodeSharedConfig {
11921
12630
  type: "keyphrase";
@@ -11953,6 +12662,118 @@ export interface IOptionalQuestionNodeRegexConfig extends IOptionalQuestionNodeS
11953
12662
  export interface IOptionalQuestionNodeOtherConfig extends IOptionalQuestionNodeSharedConfig {
11954
12663
  type: "email" | "number" | "temperature" | "age" | "date" | "duration" | "yesNo" | "money" | "percentage" | "intent" | "data" | "url";
11955
12664
  }
12665
+ export interface IContinuousASRParams extends INodeFunctionBaseParams {
12666
+ config: {
12667
+ asrEnabled: boolean;
12668
+ asrDigit: string;
12669
+ asrTimeout: number;
12670
+ };
12671
+ }
12672
+ export interface IDTMFParams extends INodeFunctionBaseParams {
12673
+ config: {
12674
+ dtmfEnable: boolean;
12675
+ dtmfInterDigitTimeout: number;
12676
+ dtmfMaxDigits: number;
12677
+ dtmfSubmitDigit: string;
12678
+ };
12679
+ }
12680
+ export interface IHangupParams extends INodeFunctionBaseParams {
12681
+ config: {
12682
+ hangupReason: string;
12683
+ };
12684
+ }
12685
+ export interface IUserNoInputParams extends INodeFunctionBaseParams {
12686
+ config: {
12687
+ userNoInputMode: TVoiceGateway2UserNoInputMode;
12688
+ userNoInputTimeout: number;
12689
+ userNoInputRetries: number;
12690
+ userNoInputSpeech: string;
12691
+ userNoInputUrl: string;
12692
+ };
12693
+ }
12694
+ export interface IVoiceConfigParams {
12695
+ bargeInMinWordCount: number;
12696
+ bargeInOnSpeech: boolean;
12697
+ bargeInOnDtmf: boolean;
12698
+ sttLanguage: string;
12699
+ sttVendor: string;
12700
+ sttHints: string[];
12701
+ sttDisablePunctuation: boolean;
12702
+ sttVadEnabled: boolean;
12703
+ sttVadMode: number;
12704
+ sttVadVoiceMs: number;
12705
+ ttsDisableCache: boolean;
12706
+ ttsVoice: string;
12707
+ ttsLanguage: string;
12708
+ ttsVendor: TVoiceGateway2TTSVendor;
12709
+ azureTtsDeploymentId: string;
12710
+ azureSttDeploymentId: string;
12711
+ azureSpeechRecognitionMode: string;
12712
+ azureEnableAudioLogging: boolean;
12713
+ azureHintsBoost: number;
12714
+ googleDisablePunctuation: boolean;
12715
+ googleInteractionType: string;
12716
+ googleHintsBoost: number;
12717
+ userNoInputMode: TVoiceGateway2UserNoInputMode;
12718
+ userNoInputTimeout: number;
12719
+ userNoInputRetries: number;
12720
+ userNoInputSpeech: string;
12721
+ userNoInputUrl: string;
12722
+ botFailOnError: boolean;
12723
+ botNoOutputGiveupTimeout: number;
12724
+ botNoOutputTimeout: number;
12725
+ botNoOutputRetries: number;
12726
+ botNoOutputSpeech: string;
12727
+ botNoOutputUrl: string;
12728
+ dtmfEnable: boolean;
12729
+ dtmfInterDigitTimeout: number;
12730
+ dtmfMaxDigits: number;
12731
+ dtmfMinDigits: number;
12732
+ dtmfSubmitDigit: string;
12733
+ asrDigit: string;
12734
+ asrEnabled: boolean;
12735
+ asrTimeout: number;
12736
+ }
12737
+ export interface ISetSessionConfigParams extends INodeFunctionBaseParams {
12738
+ config: IVoiceConfigParams;
12739
+ }
12740
+ export interface IPlayParamsConfig extends IVoiceConfigParams {
12741
+ url: string;
12742
+ loop: number;
12743
+ urlCaching: boolean;
12744
+ activityParams: any;
12745
+ setActivityParams: boolean;
12746
+ }
12747
+ export interface IPlayParams extends INodeFunctionBaseParams {
12748
+ config: IPlayParamsConfig;
12749
+ }
12750
+ export interface ITransferParams extends INodeFunctionBaseParams {
12751
+ config: {
12752
+ transferReason: string;
12753
+ referTo: string;
12754
+ useTransferSipHeaders: boolean;
12755
+ transferSipHeaders: any;
12756
+ };
12757
+ }
12758
+ export interface IBargeInParams extends INodeFunctionBaseParams {
12759
+ config: {
12760
+ bargeInMinWordCount: number;
12761
+ bargeInOnSpeech: boolean;
12762
+ bargeInOnDtmf: boolean;
12763
+ };
12764
+ }
12765
+ export interface IVoiceConfigParams {
12766
+ sttLanguage: string;
12767
+ sttVendor: string;
12768
+ sttHints: string[];
12769
+ ttsVoice: string;
12770
+ ttsLanguage: string;
12771
+ ttsVendor: TVoiceGateway2TTSVendor;
12772
+ sttDisablePunctuation: boolean;
12773
+ }
12774
+ export interface ISessionSpeechParams extends INodeFunctionBaseParams {
12775
+ config: IVoiceConfigParams;
12776
+ }
11956
12777
  export interface IActivateProfileNodeParams extends INodeFunctionBaseParams {
11957
12778
  config: never;
11958
12779
  }
@@ -11984,6 +12805,7 @@ export interface IBlindModeNodeParams extends INodeFunctionBaseParams {
11984
12805
  config: {
11985
12806
  maskLogging: boolean;
11986
12807
  maskAnalytics: boolean;
12808
+ disableIntentTrainer: boolean;
11987
12809
  disableConversations: boolean;
11988
12810
  };
11989
12811
  }
@@ -12025,6 +12847,8 @@ export interface IRequestRatingNodeParams extends INodeFunctionBaseParams {
12025
12847
  };
12026
12848
  }
12027
12849
  export interface IInitAppSessionNodeParams extends INodeFunctionBaseParams {
12850
+ appInterimScreenOverride?: string;
12851
+ appConnectScreenOverride?: string;
12028
12852
  }
12029
12853
  export interface ISetAppStateNodeParams extends INodeFunctionBaseParams {
12030
12854
  config: {
@@ -12032,6 +12856,23 @@ export interface ISetAppStateNodeParams extends INodeFunctionBaseParams {
12032
12856
  appTemplateData: string;
12033
12857
  };
12034
12858
  }
12859
+ export interface IGetAppSessionPinNodeParams extends INodeFunctionBaseParams {
12860
+ }
12861
+ export declare type TCardType = "basic" | "suggested" | "table" | "custom";
12862
+ export interface IAssistInfoNodeParams extends INodeFunctionBaseParams {
12863
+ config: {
12864
+ cardType: TCardType;
12865
+ title: string;
12866
+ subtitle: string;
12867
+ body: string;
12868
+ basicImage?: string;
12869
+ basicActionTitle?: string;
12870
+ basicActionUrl?: string;
12871
+ suggestedActionTitles: string[];
12872
+ tableFacts: JSON;
12873
+ customJson: JSON;
12874
+ };
12875
+ }
12035
12876
  export interface ICognigyMongoNodes {
12036
12877
  "mongoFind": ICreateChartNodeBasicNodesData<"mongoFind", IMongoFindNodeParams, TMONGO_DB_EXTENSION>;
12037
12878
  "mongoFindOne": ICreateChartNodeBasicNodesData<"mongoFindOne", IMongoFindOneNodeParams, TMONGO_DB_EXTENSION>;
@@ -12145,6 +12986,7 @@ export interface ISetSessionParamsParams extends INodeFunctionBaseParams {
12145
12986
  userNoInputTimeoutMS: number;
12146
12987
  userNoInputRetries: number;
12147
12988
  userNoInputSendEvent: boolean;
12989
+ userNoInputAutoHangup: boolean;
12148
12990
  userNoInputSpeech: string;
12149
12991
  userNoInputUrl: string;
12150
12992
  continuousASR: boolean;
@@ -12260,71 +13102,27 @@ export interface ICognigyVoiceGatewayNodes {
12260
13102
  export interface IMicrosoftTokenStatusParams extends INodeFunctionBaseParams {
12261
13103
  config: null;
12262
13104
  }
12263
- export interface IMicrosoftGetTokenParams extends INodeFunctionBaseParams {
12264
- config: never;
12265
- }
12266
- export interface IMicrosoftInvalidateTokenParams extends INodeFunctionBaseParams {
12267
- config: never;
12268
- }
12269
- export interface ICognigyMicrosoftNodes {
12270
- "microsoftTokenStatus": ICreateChartNodeBasicNodesData<"microsoftTokenStatus", IMicrosoftTokenStatusParams, TMICROSOFT_EXTENSION>;
12271
- "microsoftGetToken": ICreateChartNodeBasicNodesData<"getTmicrosoftGetTokenoken", IMicrosoftGetTokenParams, TMICROSOFT_EXTENSION>;
12272
- "microsoftInvalidateToken": ICreateChartNodeBasicNodesData<"microsoftInvalidateToken", IMicrosoftInvalidateTokenParams, TMICROSOFT_EXTENSION>;
12273
- }
12274
- export interface IDtmfParams extends INodeFunctionBaseParams {
12275
- config: {
12276
- dtmf: string;
12277
- duration?: number;
12278
- };
12279
- }
12280
- export interface IHangupParams extends INodeFunctionBaseParams {
12281
- config: {
12282
- hangupReason: string;
12283
- };
12284
- }
12285
- export interface IVoiceConfigParams {
12286
- bargeInMinWordCount: number;
12287
- bargeInOnSpeech: number;
12288
- bargeInOnDtmf: number;
12289
- sttLanguage: string;
12290
- sttVendor: string;
12291
- sttHints: string[];
12292
- sttVadEnabled: boolean;
12293
- sttVadMode: number;
12294
- sttVadVoiceMs: number;
12295
- ttsDisableCache: boolean;
12296
- ttsVoice: string;
12297
- ttsLanguage: string;
12298
- ttsVendor: TVoiceGateway2TTSVendor;
12299
- azureTtsDeploymentId: string;
12300
- azureSttDeploymentId: string;
12301
- azureSpeechRecognitionMode: string;
12302
- azureEnableAudioLogging: boolean;
12303
- azureHintsBoost: number;
12304
- googleDisablePunctuation: boolean;
12305
- googleInteractionType: string;
12306
- googleHintsBoost: number;
12307
- userNoInputMode: TVoiceGateway2UserNoInputMode;
12308
- userNoInputTimeout: number;
12309
- userNoInputRetries: number;
12310
- userNoInputSpeech: string;
12311
- userNoInputUrl: string;
12312
- botFailOnError: boolean;
12313
- botNoOutputGiveupTimeout: number;
12314
- botNoOutputTimeout: number;
12315
- botNoOutputRetries: number;
12316
- botNoOutputSpeech: string;
12317
- botNoOutputUrl: string;
12318
- dtmfEnable: string;
12319
- dtmfInterDigitTimeout: number;
12320
- dtmfMaxDigits: number;
12321
- dtmfMinDigits: number;
12322
- dtmfSubmitDigit: string;
12323
- asrDigits: number;
12324
- asrTimeout: number;
13105
+ export interface IMicrosoftGetTokenParams extends INodeFunctionBaseParams {
13106
+ config: never;
12325
13107
  }
12326
- export interface ISetSessionConfigParams extends INodeFunctionBaseParams {
12327
- config: IVoiceConfigParams;
13108
+ export interface IMicrosoftInvalidateTokenParams extends INodeFunctionBaseParams {
13109
+ config: never;
13110
+ }
13111
+ export interface ICognigyMicrosoftNodes {
13112
+ "microsoftTokenStatus": ICreateChartNodeBasicNodesData<"microsoftTokenStatus", IMicrosoftTokenStatusParams, TMICROSOFT_EXTENSION>;
13113
+ "microsoftGetToken": ICreateChartNodeBasicNodesData<"getTmicrosoftGetTokenoken", IMicrosoftGetTokenParams, TMICROSOFT_EXTENSION>;
13114
+ "microsoftInvalidateToken": ICreateChartNodeBasicNodesData<"microsoftInvalidateToken", IMicrosoftInvalidateTokenParams, TMICROSOFT_EXTENSION>;
13115
+ }
13116
+ export interface IDtmfParams extends INodeFunctionBaseParams {
13117
+ config: {
13118
+ dtmf: string;
13119
+ duration?: number;
13120
+ };
13121
+ }
13122
+ export interface IHangupParams extends INodeFunctionBaseParams {
13123
+ config: {
13124
+ hangupReason: string;
13125
+ };
12328
13126
  }
12329
13127
  export interface IPlayParamsConfig extends IVoiceConfigParams {
12330
13128
  url: string;
@@ -12339,6 +13137,15 @@ export interface IPlayParams extends INodeFunctionBaseParams {
12339
13137
  export interface IReferParams extends INodeFunctionBaseParams {
12340
13138
  config: {
12341
13139
  referTo: string;
13140
+ useTransferSipHeaders: boolean;
13141
+ transferSipHeaders: any;
13142
+ };
13143
+ }
13144
+ export interface ISendMetadataParams extends INodeFunctionBaseParams {
13145
+ config: {
13146
+ metadata: {
13147
+ [key: string]: string;
13148
+ };
12342
13149
  };
12343
13150
  }
12344
13151
  export interface ICognigyVoiceGateway2Nodes {
@@ -12347,58 +13154,71 @@ export interface ICognigyVoiceGateway2Nodes {
12347
13154
  "hangup": ICreateChartNodeBasicNodesData<"hangup", IHangupParams, TVOICE_GATEWAY_2_EXTENSION>;
12348
13155
  "play": ICreateChartNodeBasicNodesData<"play", IPlayParams, TVOICE_GATEWAY_2_EXTENSION>;
12349
13156
  "refer": ICreateChartNodeBasicNodesData<"refer", IReferParams, TVOICE_GATEWAY_2_EXTENSION>;
13157
+ "transfer": ICreateChartNodeBasicNodesData<"transfer", IReferParams, TVOICE_GATEWAY_2_EXTENSION>;
13158
+ "sendMetadata": ICreateChartNodeBasicNodesData<"sendMetadata", ISendMetadataParams, TVOICE_GATEWAY_2_EXTENSION>;
12350
13159
  }
12351
13160
  export interface ICognigyBasicNodes {
12352
- "addToContext": ICreateChartNodeBasicNodesData<"addToContext", IAddToContextNodeParams, TBASIC_EXTENSION>;
12353
- "copyDataToContext": ICreateChartNodeBasicNodesData<"copyDataToContext", ICopyDataToContextNodeParams, TBASIC_EXTENSION>;
12354
- "copySlotsToContext": ICreateChartNodeBasicNodesData<"copySlotsToContext", ICopySlotsToContextNodeParams, TBASIC_EXTENSION>;
12355
- "removeFromContext": ICreateChartNodeBasicNodesData<"removeFromContext", IRemoveFromContextNodeParams, TBASIC_EXTENSION>;
12356
- "resetContext": ICreateChartNodeBasicNodesData<"resetContext", IResetContextNodeParams, TBASIC_EXTENSION>;
12357
- "code": ICreateChartNodeBasicNodesData<"code", ICodeNodeBasicParams, TBASIC_EXTENSION>;
12358
- "log": ICreateChartNodeBasicNodesData<"log", ILogNodeParams, TBASIC_EXTENSION>;
12359
- "activateProfile": ICreateChartNodeBasicNodesData<"activateProfile", IActivateProfileNodeParams, TBASIC_EXTENSION>;
12360
- "blindMode": ICreateChartNodeBasicNodesData<"blindMode", IBlindModeNodeParams, TBASIC_EXTENSION>;
12361
- "completeGoal": ICreateChartNodeBasicNodesData<"completeGoal", ICompleteGoalNodeParams, TBASIC_EXTENSION>;
12362
- "deactivateProfile": ICreateChartNodeBasicNodesData<"deactivateProfile", IDeactivateProfileNodeParams, TBASIC_EXTENSION>;
12363
- "deleteProfile": ICreateChartNodeBasicNodesData<"deleteProfile", IDeleteProfileNodeParams, TBASIC_EXTENSION>;
12364
- "mergeProfile": ICreateChartNodeBasicNodesData<"mergeProfile", IMergeProfileNodeParams, TBASIC_EXTENSION>;
12365
- "updateProfile": ICreateChartNodeBasicNodesData<"updateProfile", IUpdateProfileNodeParams, TBASIC_EXTENSION>;
12366
- "overwriteAnalytics": ICreateChartNodeBasicNodesData<"overwriteAnalytics", IOverwriteAnalyticsParams, TBASIC_EXTENSION>;
12367
- "setRating": ICreateChartNodeBasicNodesData<"setRating", ISetRatingParams, TBASIC_EXTENSION>;
12368
- "requestRating": ICreateChartNodeBasicNodesData<"requestRating", IRequestRatingNodeParams, TBASIC_EXTENSION>;
12369
- "executeFlow": ICreateChartNodeBasicNodesData<"executeFlow", IExecuteFlowNodeParams, TBASIC_EXTENSION>;
12370
- "goTo": ICreateChartNodeBasicNodesData<"goTo", IGoToNodeParams, TBASIC_EXTENSION>;
12371
- "if": ICreateChartNodeBasicNodesData<"if", IIfNodeParams, TBASIC_EXTENSION>;
12372
- "interval": ICreateChartNodeBasicNodesData<"interval", IIntervalNodeParams, TBASIC_EXTENSION>;
12373
- "once": ICreateChartNodeBasicNodesData<"once", IOnceNodeParams, TBASIC_EXTENSION>;
12374
- "resetState": ICreateChartNodeBasicNodesData<"resetState", IResetStateNodeParams, TBASIC_EXTENSION>;
12375
- "setState": ICreateChartNodeBasicNodesData<"setState", ISetStateNodeParams, TBASIC_EXTENSION>;
12376
- "sleep": ICreateChartNodeBasicNodesData<"sleep", ISleepNodeParams, TBASIC_EXTENSION>;
12377
- "stop": ICreateChartNodeBasicNodesData<"stop", IStopNodeParams, TBASIC_EXTENSION>;
12378
- "switch": ICreateChartNodeBasicNodesData<"switch", ISwitchNodeParams, TBASIC_EXTENSION>;
12379
- "think": ICreateChartNodeBasicNodesData<"think", IThinkNodeParams, TBASIC_EXTENSION>;
12380
- "switchLocale": ICreateChartNodeBasicNodesData<"switchLocale", ISwitchLocaleNodeParams, TBASIC_EXTENSION>;
12381
- "setTranslation": ICreateChartNodeBasicNodesData<"setTranslation", ISetTranslationNodeParams, TBASIC_EXTENSION>;
12382
- "wait": ICreateChartNodeBasicNodesData<"wait", IWaitNodeParams, TBASIC_EXTENSION>;
12383
- "datePicker": ICreateChartNodeBasicNodesData<"datePicker", IDatePickerNodeParams, TBASIC_EXTENSION>;
12384
- "say": ICreateChartNodeBasicNodesData<"say", ISayNodeParams, TBASIC_EXTENSION>;
12385
- "addLexiconKeyphrase": ICreateChartNodeBasicNodesData<"addLexiconKeyphrase", IAddLexiconKeyphraseNodeParams, TBASIC_EXTENSION>;
12386
- "executeCognigyNLU": ICreateChartNodeBasicNodesData<"executeCognigyNLU", IExecuteCognigyNLUNodeParams, TBASIC_EXTENSION>;
12387
- "extractAnswer": ICreateChartNodeBasicNodesData<"extractAnswer", IExtractAnswerNodeParams, TBASIC_EXTENSION>;
12388
- "regexSlotFiller": ICreateChartNodeBasicNodesData<"regexSlotFiller", IRegexSlotFillerParams, TBASIC_EXTENSION>;
12389
- "matchPattern": ICreateChartNodeBasicNodesData<"matchPattern", IMatchPatternParams, TBASIC_EXTENSION>;
12390
- "fuzzySearch": ICreateChartNodeBasicNodesData<"fuzzySearch", IFuzzySearchParams, TBASIC_EXTENSION>;
12391
- "handover": ICreateChartNodeBasicNodesData<"handover", IHandoverNodeParams, TBASIC_EXTENSION>;
12392
- "handoverV2": ICreateChartNodeBasicNodesData<"handoverV2", IHandoverNodeV2Params, TBASIC_EXTENSION>;
12393
- "httpRequest": ICreateChartNodeBasicNodesData<"httpRequest", IHttpRequestNodeParams, TBASIC_EXTENSION>;
12394
- "triggerFunction": ICreateChartNodeBasicNodesData<"triggerFunction", ITriggerFunctionNodeParams, TBASIC_EXTENSION>;
12395
- "onScheduled": ICreateChartNodeBasicNodesData<"onScheduled", IScheduledNodeParams, TBASIC_EXTENSION>;
12396
- "onSchedulingError": ICreateChartNodeBasicNodesData<"onSchedulingError", ISchedulingErrorNodeParams, TBASIC_EXTENSION>;
12397
- "placeholder": ICreateChartNodeBasicNodesData<"placeholder", IPlaceholderNodeParams, TBASIC_EXTENSION>;
12398
- "question": ICreateChartNodeBasicNodesData<"question", IQuestionNodeParams, TBASIC_EXTENSION>;
12399
- "optionalQuestion": ICreateChartNodeBasicNodesData<"optionalQuestion", IOptionalQuestionNodeParams, TBASIC_EXTENSION>;
12400
- "initAppSession": ICreateChartNodeBasicNodesData<"initAppSession", IInitAppSessionNodeParams, TBASIC_EXTENSION>;
12401
- "setAppState": ICreateChartNodeBasicNodesData<"setAppState", ISetAppStateNodeParams, TBASIC_EXTENSION>;
13161
+ addToContext: ICreateChartNodeBasicNodesData<"addToContext", IAddToContextNodeParams, TBASIC_EXTENSION>;
13162
+ copyDataToContext: ICreateChartNodeBasicNodesData<"copyDataToContext", ICopyDataToContextNodeParams, TBASIC_EXTENSION>;
13163
+ copySlotsToContext: ICreateChartNodeBasicNodesData<"copySlotsToContext", ICopySlotsToContextNodeParams, TBASIC_EXTENSION>;
13164
+ removeFromContext: ICreateChartNodeBasicNodesData<"removeFromContext", IRemoveFromContextNodeParams, TBASIC_EXTENSION>;
13165
+ resetContext: ICreateChartNodeBasicNodesData<"resetContext", IResetContextNodeParams, TBASIC_EXTENSION>;
13166
+ code: ICreateChartNodeBasicNodesData<"code", ICodeNodeBasicParams, TBASIC_EXTENSION>;
13167
+ log: ICreateChartNodeBasicNodesData<"log", ILogNodeParams, TBASIC_EXTENSION>;
13168
+ activateProfile: ICreateChartNodeBasicNodesData<"activateProfile", IActivateProfileNodeParams, TBASIC_EXTENSION>;
13169
+ blindMode: ICreateChartNodeBasicNodesData<"blindMode", IBlindModeNodeParams, TBASIC_EXTENSION>;
13170
+ completeGoal: ICreateChartNodeBasicNodesData<"completeGoal", ICompleteGoalNodeParams, TBASIC_EXTENSION>;
13171
+ deactivateProfile: ICreateChartNodeBasicNodesData<"deactivateProfile", IDeactivateProfileNodeParams, TBASIC_EXTENSION>;
13172
+ deleteProfile: ICreateChartNodeBasicNodesData<"deleteProfile", IDeleteProfileNodeParams, TBASIC_EXTENSION>;
13173
+ mergeProfile: ICreateChartNodeBasicNodesData<"mergeProfile", IMergeProfileNodeParams, TBASIC_EXTENSION>;
13174
+ updateProfile: ICreateChartNodeBasicNodesData<"updateProfile", IUpdateProfileNodeParams, TBASIC_EXTENSION>;
13175
+ overwriteAnalytics: ICreateChartNodeBasicNodesData<"overwriteAnalytics", IOverwriteAnalyticsParams, TBASIC_EXTENSION>;
13176
+ setRating: ICreateChartNodeBasicNodesData<"setRating", ISetRatingParams, TBASIC_EXTENSION>;
13177
+ requestRating: ICreateChartNodeBasicNodesData<"requestRating", IRequestRatingNodeParams, TBASIC_EXTENSION>;
13178
+ executeFlow: ICreateChartNodeBasicNodesData<"executeFlow", IExecuteFlowNodeParams, TBASIC_EXTENSION>;
13179
+ goTo: ICreateChartNodeBasicNodesData<"goTo", IGoToNodeParams, TBASIC_EXTENSION>;
13180
+ if: ICreateChartNodeBasicNodesData<"if", IIfNodeParams, TBASIC_EXTENSION>;
13181
+ interval: ICreateChartNodeBasicNodesData<"interval", IIntervalNodeParams, TBASIC_EXTENSION>;
13182
+ once: ICreateChartNodeBasicNodesData<"once", IOnceNodeParams, TBASIC_EXTENSION>;
13183
+ resetState: ICreateChartNodeBasicNodesData<"resetState", IResetStateNodeParams, TBASIC_EXTENSION>;
13184
+ setState: ICreateChartNodeBasicNodesData<"setState", ISetStateNodeParams, TBASIC_EXTENSION>;
13185
+ sleep: ICreateChartNodeBasicNodesData<"sleep", ISleepNodeParams, TBASIC_EXTENSION>;
13186
+ stop: ICreateChartNodeBasicNodesData<"stop", IStopNodeParams, TBASIC_EXTENSION>;
13187
+ switch: ICreateChartNodeBasicNodesData<"switch", ISwitchNodeParams, TBASIC_EXTENSION>;
13188
+ think: ICreateChartNodeBasicNodesData<"think", IThinkNodeParams, TBASIC_EXTENSION>;
13189
+ switchLocale: ICreateChartNodeBasicNodesData<"switchLocale", ISwitchLocaleNodeParams, TBASIC_EXTENSION>;
13190
+ setTranslation: ICreateChartNodeBasicNodesData<"setTranslation", ISetTranslationNodeParams, TBASIC_EXTENSION>;
13191
+ wait: ICreateChartNodeBasicNodesData<"wait", IWaitNodeParams, TBASIC_EXTENSION>;
13192
+ datePicker: ICreateChartNodeBasicNodesData<"datePicker", IDatePickerNodeParams, TBASIC_EXTENSION>;
13193
+ say: ICreateChartNodeBasicNodesData<"say", ISayNodeParams, TBASIC_EXTENSION>;
13194
+ addLexiconKeyphrase: ICreateChartNodeBasicNodesData<"addLexiconKeyphrase", IAddLexiconKeyphraseNodeParams, TBASIC_EXTENSION>;
13195
+ executeCognigyNLU: ICreateChartNodeBasicNodesData<"executeCognigyNLU", IExecuteCognigyNLUNodeParams, TBASIC_EXTENSION>;
13196
+ extractAnswer: ICreateChartNodeBasicNodesData<"extractAnswer", IExtractAnswerNodeParams, TBASIC_EXTENSION>;
13197
+ regexSlotFiller: ICreateChartNodeBasicNodesData<"regexSlotFiller", IRegexSlotFillerParams, TBASIC_EXTENSION>;
13198
+ matchPattern: ICreateChartNodeBasicNodesData<"matchPattern", IMatchPatternParams, TBASIC_EXTENSION>;
13199
+ fuzzySearch: ICreateChartNodeBasicNodesData<"fuzzySearch", IFuzzySearchParams, TBASIC_EXTENSION>;
13200
+ handover: ICreateChartNodeBasicNodesData<"handover", IHandoverNodeParams, TBASIC_EXTENSION>;
13201
+ handoverV2: ICreateChartNodeBasicNodesData<"handoverV2", IHandoverNodeV2Params, TBASIC_EXTENSION>;
13202
+ checkAgentAvailability: ICreateChartNodeBasicNodesData<"checkAgentAvailability", ICheckAgentAvailabilityNodeParams, TBASIC_EXTENSION>;
13203
+ httpRequest: ICreateChartNodeBasicNodesData<"httpRequest", IHttpRequestNodeParams, TBASIC_EXTENSION>;
13204
+ triggerFunction: ICreateChartNodeBasicNodesData<"triggerFunction", ITriggerFunctionNodeParams, TBASIC_EXTENSION>;
13205
+ onScheduled: ICreateChartNodeBasicNodesData<"onScheduled", IScheduledNodeParams, TBASIC_EXTENSION>;
13206
+ onSchedulingError: ICreateChartNodeBasicNodesData<"onSchedulingError", ISchedulingErrorNodeParams, TBASIC_EXTENSION>;
13207
+ placeholder: ICreateChartNodeBasicNodesData<"placeholder", IPlaceholderNodeParams, TBASIC_EXTENSION>;
13208
+ question: ICreateChartNodeBasicNodesData<"question", IQuestionNodeParams, TBASIC_EXTENSION>;
13209
+ optionalQuestion: ICreateChartNodeBasicNodesData<"optionalQuestion", IOptionalQuestionNodeParams, TBASIC_EXTENSION>;
13210
+ initAppSession: ICreateChartNodeBasicNodesData<"initAppSession", IInitAppSessionNodeParams, TBASIC_EXTENSION>;
13211
+ setAppState: ICreateChartNodeBasicNodesData<"setAppState", ISetAppStateNodeParams, TBASIC_EXTENSION>;
13212
+ getAppSessionPin: ICreateChartNodeBasicNodesData<"getAppSessionPin", IGetAppSessionPinNodeParams, TBASIC_EXTENSION>;
13213
+ hangup: ICreateChartNodeBasicNodesData<"hangup", IHangupParams, TBASIC_EXTENSION>;
13214
+ play: ICreateChartNodeBasicNodesData<"play", IPlayParams, TBASIC_EXTENSION>;
13215
+ transfer: ICreateChartNodeBasicNodesData<"transfer", ITransferParams, TBASIC_EXTENSION>;
13216
+ bargeIn: ICreateChartNodeBasicNodesData<"bargeIn", IBargeInParams, TBASIC_EXTENSION>;
13217
+ continuousASR: ICreateChartNodeBasicNodesData<"continuousASR", IContinuousASRParams, TBASIC_EXTENSION>;
13218
+ dtmf: ICreateChartNodeBasicNodesData<"dtmf", IDTMFParams, TBASIC_EXTENSION>;
13219
+ noUserInput: ICreateChartNodeBasicNodesData<"noUserInput", IUserNoInputParams, TBASIC_EXTENSION>;
13220
+ sessionSpeechParameters: ICreateChartNodeBasicNodesData<"sessionSpeechParameters", ISessionSpeechParams, TBASIC_EXTENSION>;
13221
+ assistInfo: ICreateChartNodeBasicNodesData<"assistInfo", IAssistInfoNodeParams, TBASIC_EXTENSION>;
12402
13222
  }
12403
13223
  export interface ICognigyNodes {
12404
13224
  "@cognigy/basic-nodes": ICognigyBasicNodes;
@@ -12409,6 +13229,214 @@ export interface ICognigyNodes {
12409
13229
  "@cognigy/microsoft": ICognigyMicrosoftNodes;
12410
13230
  "@cognigy/voiceGateway2": ICognigyVoiceGateway2Nodes;
12411
13231
  }
13232
+ export interface IUploadFileRestDataQuery_2_0 extends IProjectScope {
13233
+ }
13234
+ export interface IUploadFileRestDataBody_2_0 {
13235
+ file: File | Buffer;
13236
+ }
13237
+ export interface IUploadFileRestData_2_0 extends IUploadFileRestDataBody_2_0, IUploadFileRestDataQuery_2_0 {
13238
+ }
13239
+ export interface IUploadFileRestReturnValue_2_0 {
13240
+ /** The uuid of the file within the system */
13241
+ fileId: string;
13242
+ /** The name of the created file */
13243
+ name: string;
13244
+ /** The mimetype of the created file */
13245
+ mimetype: string;
13246
+ /** The file token which can be used to retrieve the file later on */
13247
+ fileToken: string;
13248
+ }
13249
+ /**
13250
+ * @openapi
13251
+ *
13252
+ * components:
13253
+ * schemas:
13254
+ * IAudioPreviewLanguages_2_0:
13255
+ * type: object
13256
+ * properties:
13257
+ * audioPreviewLanguages:
13258
+ * type: array
13259
+ * items:
13260
+ * type: object
13261
+ * properties:
13262
+ * voiceId:
13263
+ * type: string
13264
+ * maxLength: 50
13265
+ * description: Audio preview provided voice Id. This is the ID that you specify when calling the SynthesizeSpeech operation.
13266
+ * languageCode:
13267
+ * type: string
13268
+ * maxLength: 10
13269
+ * description: Language code of the voice.
13270
+ */
13271
+ export interface IAudioPreviewLanguages_2_0 {
13272
+ audioPreviewLanguages: {
13273
+ voiceId: string;
13274
+ languageCode: string;
13275
+ }[];
13276
+ }
13277
+ export interface IIndexAudioPreviewLanguagesRestDataQuery_2_0 {
13278
+ projectId: string;
13279
+ }
13280
+ export interface IIndexAudioPreviewLanguagesRestData_2_0 extends IIndexAudioPreviewLanguagesRestDataQuery_2_0 {
13281
+ }
13282
+ export interface IIndexAudioPreviewLanguagesRestReturnValue_2_0 {
13283
+ audioPreviewLanguages: IAudioPreviewLanguages_2_0;
13284
+ }
13285
+ /**
13286
+ * @openapi
13287
+ *
13288
+ * components:
13289
+ * schemas:
13290
+ * IVGCallSettings_2_0:
13291
+ * type: object
13292
+ * properties:
13293
+ * sipRealm:
13294
+ * type: string
13295
+ * username:
13296
+ * type: string
13297
+ * password:
13298
+ * type: string
13299
+ * userId:
13300
+ * description: temporary user id
13301
+ * type: string
13302
+ *
13303
+ */
13304
+ export interface IVGCallSettings_2_0 {
13305
+ sipRealm: string;
13306
+ username: string;
13307
+ password: string;
13308
+ userId: string;
13309
+ }
13310
+ /**
13311
+ * @openapi
13312
+ *
13313
+ * components:
13314
+ * schemas:
13315
+ * IVoicePrepareCall_2_0:
13316
+ * type: object
13317
+ * properties:
13318
+ * entrypoint:
13319
+ * $ref: '#/components/schemas/TMongoId'
13320
+ * flowId:
13321
+ * $ref: '#/components/schemas/TMongoId'
13322
+ * localeId:
13323
+ * $ref: '#/components/schemas/TMongoId'
13324
+ * nluConnectorId:
13325
+ * $ref: '#/components/schemas/TMongoId'
13326
+ * language:
13327
+ * type: string
13328
+ * voice:
13329
+ * type: string
13330
+ */
13331
+ export interface IVoicePrepareCall_2_0 {
13332
+ entrypoint: string;
13333
+ flowId: string;
13334
+ localeId: string;
13335
+ nluConnectorId: string;
13336
+ language: string;
13337
+ voice: string;
13338
+ }
13339
+ export interface IVoicePrepareCallRestDataBody_2_0 extends IProjectScope, IVoicePrepareCall_2_0 {
13340
+ }
13341
+ export interface IVoicePrepareCallRestData_2_0 extends IVoicePrepareCallRestDataBody_2_0 {
13342
+ }
13343
+ export interface IVoicePrepareCallRestReturnValue_2_0 extends IVGCallSettings_2_0 {
13344
+ }
13345
+ /**
13346
+ * @openapi
13347
+ *
13348
+ * components:
13349
+ * schemas:
13350
+ * ITestVoiceProvider_2_0:
13351
+ * type: object
13352
+ * properties:
13353
+ * voiceProvider:
13354
+ * type: string
13355
+ * isCredentialsValid:
13356
+ * type: boolean
13357
+ * msg:
13358
+ * type: string
13359
+ * msgErr:
13360
+ * type: string
13361
+ *
13362
+ */
13363
+ export interface ITestVoiceProvider_2_0 {
13364
+ voiceProvider: TAudioPreviewProvider;
13365
+ isCredentialsValid: boolean;
13366
+ msg: string;
13367
+ msgErr?: string;
13368
+ }
13369
+ export interface ITestVoiceProviderRestDataBody_2_0 extends Partial<IProjectScope> {
13370
+ }
13371
+ export interface ITestVoiceProviderRestData_2_0 extends ITestVoiceProviderRestDataBody_2_0 {
13372
+ }
13373
+ export interface ITestVoiceProviderRestReturnValue_2_0 extends ITestVoiceProvider_2_0 {
13374
+ }
13375
+ /**
13376
+ * @openapi
13377
+ *
13378
+ * components:
13379
+ * schemas:
13380
+ * ITestTranslationSettings_2_0:
13381
+ * type: object
13382
+ * properties:
13383
+ * language:
13384
+ * type: string
13385
+ * error:
13386
+ * type: object
13387
+ * msg:
13388
+ * type: string
13389
+ *
13390
+ */
13391
+ export interface ITestTranslationSettings_2_0 {
13392
+ language: string;
13393
+ error?: InternalServerError;
13394
+ msg: string;
13395
+ }
13396
+ export interface ITestTranslationSettingsRestDataBody_2_0 extends Partial<IProjectScope> {
13397
+ }
13398
+ export interface ITestTranslationSettingsRestData_2_0 extends ITestTranslationSettingsRestDataBody_2_0 {
13399
+ }
13400
+ export interface ITestTranslationSettingsRestReturnValue_2_0 extends ITestTranslationSettings_2_0 {
13401
+ }
13402
+ export interface ICreateYesNoSentenceRestDataBody_2_0 extends Partial<Omit<ISentence_2_0, TReferenceAndEntityMetaKeys | "feedbackReport" | "slots">> {
13403
+ }
13404
+ export interface ICreateYesNoSentenceRestDataParams_2_0 {
13405
+ localeId: string;
13406
+ intentId: string;
13407
+ }
13408
+ export interface ICreateYesNoSentenceRestData_2_0 extends ICreateYesNoSentenceRestDataBody_2_0, ICreateYesNoSentenceRestDataParams_2_0 {
13409
+ }
13410
+ export interface ICreateYesNoSentenceRestReturnValue_2_0 extends Omit<ISentence_2_0, "feedbackReport"> {
13411
+ }
13412
+ export interface IDeleteYesNoSentenceRestDataParams_2_0 {
13413
+ localeId: string;
13414
+ intentId: string;
13415
+ sentenceId: string;
13416
+ }
13417
+ export interface IDeleteYesNoSentenceRestData_2_0 extends IDeleteYesNoSentenceRestDataParams_2_0 {
13418
+ }
13419
+ export interface IDeleteYesNoSentenceRestReturnValue_2_0 {
13420
+ }
13421
+ export interface IUpdateYesNoSentenceRestBody_2_0 extends Omit<ISentence_2_0, TReferenceAndEntityMetaKeys | "feedbackReport"> {
13422
+ }
13423
+ export interface IUpdateYesNoSentenceRestParams_2_0 {
13424
+ localeId: string;
13425
+ intentId: string;
13426
+ sentenceId: string;
13427
+ }
13428
+ export interface IUpdateYesNoSentenceRestData_2_0 extends IUpdateYesNoSentenceRestParams_2_0, IUpdateYesNoSentenceRestBody_2_0 {
13429
+ }
13430
+ export interface IUpdateYesNoSentenceRestReturnValue_2_0 {
13431
+ }
13432
+ export interface IIndexYesNoSentencesRestDataParams_2_0 {
13433
+ localeId: string;
13434
+ intentId: string;
13435
+ }
13436
+ export interface IIndexYesNoSentencesRestData_2_0 extends IRestPagination<ISentenceIndexItem_2_0>, IIndexYesNoSentencesRestDataParams_2_0 {
13437
+ }
13438
+ export interface IIndexYesNoSentencesRestReturnValue_2_0 extends ICursorBasedPaginationReturnValue<ISentenceIndexItem_2_0> {
13439
+ }
12412
13440
  export interface ResourcesAPIGroup_2_0 {
12413
13441
  searchResources: TRestAPIOperation<ISearchResourcesRestData_2_0, ISearchResourcesRestReturnValue_2_0>;
12414
13442
  indexFlows: TRestAPIOperation<TRestAPIOptionalParameter<IIndexFlowsRestData_2_0>, IIndexFlowsRestReturnValue_2_0>;
@@ -12417,6 +13445,7 @@ export interface ResourcesAPIGroup_2_0 {
12417
13445
  readFlow: TRestAPIOperation<IReadFlowRestData_2_0, IReadFlowRestReturnValue_2_0>;
12418
13446
  updateFlow: TRestAPIOperation<IUpdateFlowRestData_2_0, IUpdateFlowRestReturnValue_2_0>;
12419
13447
  deleteFlow: TRestAPIOperation<IDeleteFlowRestData_2_0, IDeleteFlowRestReturnValue_2_0>;
13448
+ cloneFlow: TRestAPIOperation<ICloneFlowRestData_2_0, ICloneFlowRestReturnValue_2_0>;
12420
13449
  addFlowLocalization: TRestAPIOperation<IAddFlowLocalizationRestData_2_0, IAddFlowLocalizationRestReturnValue_2_0>;
12421
13450
  removeFlowLocalization: TRestAPIOperation<IRemoveFlowLocalizationRestData_2_0, IRemoveFlowLocalizationRestReturnValue_2_0>;
12422
13451
  createChildFlow: TRestAPIOperation<TRestAPIOptionalParameter<ICreateFlowFromChildrenRestData_2_0>, ICreateFlowFromChildrenRestReturnValue_2_0>;
@@ -12438,6 +13467,7 @@ export interface ResourcesAPIGroup_2_0 {
12438
13467
  deleteProject: TRestAPIOperation<IDeleteProjectRestData_2_0, IDeleteProjectRestReturnValue_2_0>;
12439
13468
  validateProjectName: TRestAPIOperation<IValidateProjectNameRestData_2_0, IValidateProjectNameRestReturnValue_2_0>;
12440
13469
  graphProject: TRestAPIOperation<IGraphProjectRestData_2_0, IGraphProjectRestReturnValue_2_0>;
13470
+ trainAllProjectFlows: TRestAPIOperation<ITrainAllProjectFlowsRestData_2_0, ITrainAllProjectFlowsRestReturnValue_2_0>;
12441
13471
  readProjectSettings: TRestAPIOperation<IReadAgentSettingsRestData_2_0, IReadAgentSettingsRestReturnValue_2_0>;
12442
13472
  updateProjectSettings: TRestAPIOperation<IUpdateAgentSettingsRestData_2_0, IUpdateAgentSettingsRestReturnValue_2_0>;
12443
13473
  indexLexicons: TRestAPIOperation<TRestAPIOptionalParameter<IIndexLexiconsRestData_2_0>, IIndexLexiconsRestReturnValue_2_0>;
@@ -12494,7 +13524,7 @@ export interface ResourcesAPIGroup_2_0 {
12494
13524
  deleteSnippet: TRestAPIOperation<IDeleteSnippetRestData_2_0, IDeleteSnippetRestReturnValue_2_0>;
12495
13525
  readChart: TRestAPIOperation<IReadChartRestData_2_0, IReadChartRestReturnValue_2_0>;
12496
13526
  indexChartNodes: TRestAPIOperation<IIndexChartNodesRestData_2_0, IIndexChartNodesRestReturnValue_2_0>;
12497
- createChartNode: <T extends string, U extends (T extends keyof ICognigyNodes ? keyof ICognigyNodes[T] : string)>(data: {
13527
+ createChartNode: <T extends string, U extends T extends keyof ICognigyNodes ? keyof ICognigyNodes[T] : string>(data: {
12498
13528
  extension: T;
12499
13529
  type: U;
12500
13530
  } & (T extends keyof ICognigyNodes ? U extends keyof ICognigyNodes[T] ? ICognigyNodes[T][U] & ICreateChartNodeRestDataBase_2_0 : ICreateChartNodeRestDataGenericBody_2_0 : ICreateChartNodeRestDataGenericBody_2_0), options?: any) => Promise<ICreateChartNodeRestReturnValue_2_0>;
@@ -12595,6 +13625,19 @@ export interface ResourcesAPIGroup_2_0 {
12595
13625
  composePackageDownloadLink: TRestAPIOperation<IComposePackageDownloadLinkRestData_2_0, IComposePackageDownloadLinkRestReturnValue_2_0>;
12596
13626
  uploadPackage: TRestAPIOperation<IUploadPackageRestData_2_0, IUploadPackageRestReturnValue_2_0>;
12597
13627
  optionsResolver: TRestAPIOperation<IOptionsResolverRestDataBody_2_0, IOptionsResolverRestReturnValue_2_0>;
13628
+ uploadFile: TRestAPIOperation<IUploadFileRestData_2_0, IUploadFileRestReturnValue_2_0>;
13629
+ indexAudioPreviewLanguages: TRestAPIOperation<IIndexAudioPreviewLanguagesRestData_2_0, IIndexAudioPreviewLanguagesRestReturnValue_2_0>;
13630
+ voicePrepareCall: TRestAPIOperation<IVoicePrepareCallRestData_2_0, IVoicePrepareCallRestReturnValue_2_0>;
13631
+ readYesNoIntents: TRestAPIOperation<IReadYesNoIntentsRestDataParams_2_0, IReadYesNoIntentsRestReturnValue_2_0>;
13632
+ updateYesNoIntents: TRestAPIOperation<IUpdateYesNoIntentRestData_2_0, IUpdateNoIntentsRestReturnValue_2_0>;
13633
+ deleteYesNoIntents: TRestAPIOperation<IDeleteYesNoIntentRestData_2_0, IDeleteYesNoIntentRestReturnValue_2_0>;
13634
+ trainYesNoIntents: TRestAPIOperation<ITrainYesNoIntentsRestData_2_0, ITrainYesNoIntentsRestReturnValue_2_0>;
13635
+ indexYesNoSentences: TRestAPIOperation<IIndexYesNoSentencesRestData_2_0, IIndexYesNoSentencesRestReturnValue_2_0>;
13636
+ createYesNoSentence: TRestAPIOperation<ICreateYesNoSentenceRestData_2_0, ICreateYesNoSentenceRestReturnValue_2_0>;
13637
+ updateYesNoSentence: TRestAPIOperation<IUpdateYesNoSentenceRestData_2_0, IUpdateYesNoSentenceRestReturnValue_2_0>;
13638
+ deleteYesNoSentence: TRestAPIOperation<IDeleteYesNoSentenceRestData_2_0, IDeleteYesNoSentenceRestReturnValue_2_0>;
13639
+ testVoiceProvider: TRestAPIOperation<ITestVoiceProviderRestData_2_0, ITestVoiceProviderRestReturnValue_2_0>;
13640
+ testTranslationSettings: TRestAPIOperation<ITestTranslationSettingsRestData_2_0, ITestTranslationSettingsRestReturnValue_2_0>;
12598
13641
  }
12599
13642
  declare const ResourcesAPIGroup_2_0: (instance: Base) => ResourcesAPIGroup_2_0;
12600
13643
  /**
@@ -12911,6 +13954,8 @@ export interface ILoadMessagesReportByQueryHashRestReturnValue_2_0 extends ILoad
12911
13954
  * type: array
12912
13955
  * items:
12913
13956
  * type: string
13957
+ * endpointName:
13958
+ * type: string
12914
13959
  */
12915
13960
  export interface IConversationSession_2_0 {
12916
13961
  _id: string;
@@ -12926,6 +13971,7 @@ export interface IConversationSession_2_0 {
12926
13971
  sessionId: string;
12927
13972
  ratings?: number[];
12928
13973
  ratingComments?: string[];
13974
+ endpointName: string;
12929
13975
  }
12930
13976
  export declare type TGenerateTranscriptsFilterFields = "localeReferenceId" | "endpointUrlToken" | "source" | "timestamp" | "rating" | "userMessageCount" | "flowReferenceId";
12931
13977
  export interface IGenerateTranscriptsRestDataBody_2_0 extends IProjectScope, Partial<IAnalyticsQueryFilter_2_0<TGenerateTranscriptsFilterFields>> {
@@ -13118,6 +14164,36 @@ export interface ILoadStepReportByQueryHashRestData_2_0 extends ILoadStepReportB
13118
14164
  }
13119
14165
  export interface ILoadStepReportByQueryHashRestReturnValue_2_0 extends ILoadStepReportByQueryHashResponse_2_0 {
13120
14166
  }
14167
+ /**
14168
+ * @openapi
14169
+ *
14170
+ * components:
14171
+ * schemas:
14172
+ * IDeleteAnalyticsRecordsRestDataBody_2_0:
14173
+ * type: object
14174
+ * properties:
14175
+ * contactIds:
14176
+ * type: array
14177
+ * nullable: true
14178
+ * items:
14179
+ * type: string
14180
+ * timestampStart:
14181
+ * type: string
14182
+ * example: "2020-01-01T00:00:00Z"
14183
+ * timestampEnd:
14184
+ * type: string
14185
+ * example: "2020-01-31T23:59:00Z"
14186
+ */
14187
+ export interface IDeleteAnalyticsRecordsRestDataBody_2_0 {
14188
+ contactIds: string[];
14189
+ timestampStart?: string;
14190
+ timestampEnd?: string;
14191
+ }
14192
+ export interface IDeleteAnalyticsRecordsRestDataParams_2_0 {
14193
+ projectId: TMongoId;
14194
+ }
14195
+ export interface IDeleteAnalyticsRecordsRestData_2_0 extends IDeleteAnalyticsRecordsRestDataParams_2_0, IDeleteAnalyticsRecordsRestDataBody_2_0 {
14196
+ }
13121
14197
  export interface InsightsAPIGroup_2_0 {
13122
14198
  indexSteps: TRestAPIOperation<IIndexStepsRestData_2_0, IIndexStepsRestReturnValue_2_0>;
13123
14199
  generateReport: TRestAPIOperation<IGenerateReportRestData_2_0, IGenerateReportRestReturnValue_2_0>;
@@ -13128,6 +14204,10 @@ export interface InsightsAPIGroup_2_0 {
13128
14204
  loadTranscriptsReportByQueryHash: TRestAPIOperation<ILoadTranscriptsReportByQueryHashRestData_2_0, ILoadTranscriptsReportByQueryHashRestReturnValue_2_0>;
13129
14205
  generateStepReport: TRestAPIOperation<IGenerateStepReportRestData_2_0, IGenerateStepReportRestReturnValue_2_0>;
13130
14206
  loadStepReportByQueryHash: TRestAPIOperation<ILoadStepReportByQueryHashRestData_2_0, ILoadStepReportByQueryHashRestReturnValue_2_0>;
14207
+ deleteAnalyticsRecords: TRestAPIOperation<IDeleteAnalyticsRecordsRestData_2_0, {}>;
14208
+ insightsJWT: TRestAPIOperation<void, {
14209
+ token: string;
14210
+ }>;
13131
14211
  }
13132
14212
  declare function InsightsAPIGroup_2_0(instance: Base): InsightsAPIGroup_2_0;
13133
14213
  /**
@@ -13617,8 +14697,8 @@ export interface ITrainerRecord_2_0 {
13617
14697
  detailedSlots?: ISystemSlots_2_0;
13618
14698
  /** The full results of our intent mapper */
13619
14699
  intentMapperResults?: {
13620
- finalIntentName: string;
13621
- finalIntentScore: number;
14700
+ finalIntentName?: string;
14701
+ finalIntentScore?: number;
13622
14702
  };
13623
14703
  tokens?: string[];
13624
14704
  intentFlow?: string;
@@ -13690,8 +14770,8 @@ export interface ITrainerRecordIndexItem_2_0 {
13690
14770
  detailedSlots?: ISystemSlots_2_0;
13691
14771
  /** The full results of our intent mapper */
13692
14772
  intentMapperResults?: {
13693
- finalIntentName: string;
13694
- finalIntentScore: number;
14773
+ finalIntentName?: string;
14774
+ finalIntentScore?: number;
13695
14775
  };
13696
14776
  tokens?: string[];
13697
14777
  intentFlow?: string;
@@ -13895,6 +14975,7 @@ export interface IConversationData_2_0 {
13895
14975
  source: TAnalyticsSource_2_0;
13896
14976
  previousInputText: string;
13897
14977
  previousInputData: any;
14978
+ previousInputAttachments: any[];
13898
14979
  previousSource: TAnalyticsSource_2_0;
13899
14980
  flowName: string;
13900
14981
  flowReferenceId: string;
@@ -14287,6 +15368,7 @@ declare const actionTypes: readonly [
14287
15368
  "batchTrainerRecords",
14288
15369
  "cancelTask",
14289
15370
  "changePlaybookStepOrder",
15371
+ "cloneFlow",
14290
15372
  "configureIdentityProvider",
14291
15373
  "createPackage",
14292
15374
  "createProjectByTemplate",
@@ -14301,6 +15383,7 @@ declare const actionTypes: readonly [
14301
15383
  "moveChartNode",
14302
15384
  "packageSnapshot",
14303
15385
  "packageTrainerRecords",
15386
+ "prepareCall",
14304
15387
  "redoChart",
14305
15388
  "removeContactIdFromProfile",
14306
15389
  "removeFlowLocalization",
@@ -14312,22 +15395,43 @@ declare const actionTypes: readonly [
14312
15395
  "removeProjectMember",
14313
15396
  "removeRoleFromUser",
14314
15397
  "removeSlotFromLexiconEntry",
14315
- "updateExtensionPackage",
15398
+ "requestOrganisationDeletion",
14316
15399
  "resetFailedLoginAttempts",
14317
15400
  "resetIdentityProvider",
14318
15401
  "restoreSnapshot",
14319
15402
  "stopFunctionInstance",
14320
15403
  "setupCognigyLiveAgent",
14321
15404
  "setupCognigyLiveAgentInbox",
15405
+ "updateCognigyLiveAgentInbox",
15406
+ "trainAllProjectFlows",
14322
15407
  "trainIntents",
15408
+ "trainYesNoIntents",
14323
15409
  "triggerFunction",
14324
15410
  "undoChart",
15411
+ "updateExtensionPackage",
14325
15412
  "updateProjectMember",
14326
15413
  "uploadExtension",
14327
15414
  "uploadFile",
14328
15415
  "uploadPackage",
14329
15416
  "uploadSnapshotPackage",
14330
- "uploadTrainerRecordsPackage"
15417
+ "uploadTrainerRecordsPackage",
15418
+ "createAuthenticatedAmazonUser",
15419
+ "deleteAmazonAccount",
15420
+ "deployAlexaEndpoint",
15421
+ "deleteOrganisation",
15422
+ "enforcePasswordPolicy",
15423
+ "createApiKey",
15424
+ "updateOrganisation",
15425
+ "createUser",
15426
+ "deleteUser",
15427
+ "updateUser",
15428
+ "changePassword",
15429
+ "resetPassword",
15430
+ "exportProfileData",
15431
+ "mergeProfiles",
15432
+ "unmergeProfiles",
15433
+ "updateFlowSettings",
15434
+ "optionsResolver"
14331
15435
  ];
14332
15436
  export declare type TActionType = typeof actionTypes[number];
14333
15437
  /**
@@ -14359,16 +15463,16 @@ export declare type TActionType = typeof actionTypes[number];
14359
15463
  * - profileSchema
14360
15464
  * - project
14361
15465
  * - projectsettings
15466
+ * - slotFiller
14362
15467
  * - snippet
14363
15468
  * - synonym
14364
15469
  * - tag
14365
15470
  * - task
14366
- * - user
14367
15471
  * - trainerRecord
14368
- * - task
14369
- * - slotFiller
15472
+ * - user
15473
+ * - yesNoIntent
14370
15474
  */
14371
- export declare type TResourceTypeAdditional = "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "user";
15475
+ export declare type TResourceTypeAdditional = "apiKey" | "analytics" | "connectionField" | "conversation" | "examplesentence" | "flowState" | "functionInstance" | "intent" | "keyphrase" | "learningsentence" | "lexiconEntry" | "lexiconKeyphrase" | "lexiconSlot" | "mergePackage" | "node" | "playbookStep" | "playbookStepAssert" | "profile" | "profileSchema" | "project" | "projectsettings" | "snippet" | "synonym" | "slotFiller" | "tag" | "task" | "trainerRecord" | "yesNoIntent" | "user";
14372
15476
  /**
14373
15477
  * @openapi
14374
15478
  * components:
@@ -14584,6 +15688,7 @@ export interface ISetSystemLicenseRestReturnValue_2_0 {
14584
15688
  export interface IGetSystemMessageRestReturnValue_2_0 {
14585
15689
  message: string;
14586
15690
  until: number;
15691
+ showOnLogin: boolean;
14587
15692
  }
14588
15693
  /**
14589
15694
  * @openapi
@@ -15177,6 +16282,16 @@ export interface ISetupCognigyLiveAgentInboxRestData_2_0 extends ISetupCognigyLi
15177
16282
  export interface ISetupCognigyLiveAgentInboxRestReturnValue_2_0 {
15178
16283
  liveAgentDefaultInbox: Number;
15179
16284
  }
16285
+ export interface IUpdateCognigyLiveAgentInboxRestDataParams_2_0 extends IProjectScope {
16286
+ }
16287
+ export interface IUpdateCognigyLiveAgentInboxRestDataBody_2_0 {
16288
+ inboxId: number;
16289
+ }
16290
+ export interface IUpdateCognigyLiveAgentInboxRestData_2_0 extends IUpdateCognigyLiveAgentInboxRestDataParams_2_0, IUpdateCognigyLiveAgentInboxRestDataBody_2_0 {
16291
+ }
16292
+ export interface IUpdateCognigyLiveAgentInboxRestReturnValue_2_0 {
16293
+ liveAgentDefaultInbox: Number;
16294
+ }
15180
16295
  export interface IReadProjectInboxRestDataParams_2_0 extends IProjectScope {
15181
16296
  }
15182
16297
  export interface IReadProjectInboxRestData_2_0 extends IReadProjectInboxRestDataParams_2_0 {
@@ -15187,6 +16302,48 @@ export interface IReadProjectInboxRestReturnValue_2_0 {
15187
16302
  export interface IReadLiveAgentAccountRestReturnValue_2_0 {
15188
16303
  liveAgentAccount: Number;
15189
16304
  }
16305
+ declare enum EOrganisationDeletionStatus {
16306
+ TOKEN_REQUESTED = "TOKEN_REQUESTED",
16307
+ IN_PROGRESS = "IN_PROGRESS",
16308
+ COMPLETED = "COMPLETED"
16309
+ }
16310
+ export declare type TDataToBeDeleted = {
16311
+ service: string;
16312
+ collectionName: string;
16313
+ isDeleted: boolean;
16314
+ lastUpdatedAt: number | null;
16315
+ };
16316
+ export interface IOrganisationDeletion {
16317
+ organisationId: string;
16318
+ organisationName: string;
16319
+ verificationTokenChachedKey: string;
16320
+ createdAt: Date;
16321
+ updatedAt: Date;
16322
+ status: EOrganisationDeletionStatus;
16323
+ dataToBeDeleted: TDataToBeDeleted[];
16324
+ }
16325
+ export interface IRequestOrganisationDeletionRestReturnValue_2_0 extends Omit<IOrganisationDeletion, "verificationTokenChachedKey"> {
16326
+ }
16327
+ declare const servicesNames: readonly [
16328
+ "service-api",
16329
+ "service-resources",
16330
+ "service-journeys",
16331
+ "service-logs",
16332
+ "service-profiles",
16333
+ "service-security",
16334
+ "service-trainer",
16335
+ "service-handover",
16336
+ "service-task-manager",
16337
+ "service-app-session-manager",
16338
+ "service-session-state-manager",
16339
+ "service-function-scheduler",
16340
+ "service-alexa-management",
16341
+ "service-runtime-file-manager"
16342
+ ];
16343
+ export declare type TServicesNames = typeof servicesNames[number];
16344
+ export declare type TReadCollectionsToBeDeletedRestReturnValue_2_0 = {
16345
+ [key in keyof TServicesNames]: string[];
16346
+ };
15190
16347
  export interface AdministrationAPIGroup_2_0 {
15191
16348
  requestPasswordReset: TRestAPIOperation<IRequestPasswordResetRestData_2_0, IRequestPasswordResetRestReturnValue_2_0>;
15192
16349
  validatePasswordResetToken: TRestAPIOperation<IValidatePasswordResetTokenRestData_2_0, IValidatePasswordResetTokenRestReturnValue_2_0>;
@@ -15230,8 +16387,11 @@ export interface AdministrationAPIGroup_2_0 {
15230
16387
  resetIdentityProvider: TRestAPIOperation<IResetIdentityProviderRestData_2_0, IResetIdentityProviderRestReturnValue>;
15231
16388
  setupCognigyLiveAgent: TRestAPIOperation<void, ISetupCognigyLiveAgentRestReturnValue_2_0>;
15232
16389
  setupCognigyLiveAgentInbox: TRestAPIOperation<ISetupCognigyLiveAgentInboxRestData_2_0, ISetupCognigyLiveAgentInboxRestReturnValue_2_0>;
16390
+ updateCognigyLiveAgentInbox: TRestAPIOperation<IUpdateCognigyLiveAgentInboxRestData_2_0, IUpdateCognigyLiveAgentInboxRestReturnValue_2_0>;
15233
16391
  readProjectInbox: TRestAPIOperation<IReadProjectInboxRestData_2_0, IReadProjectInboxRestReturnValue_2_0>;
15234
16392
  readLiveAgentAccount: TRestAPIOperation<void, IReadLiveAgentAccountRestReturnValue_2_0>;
16393
+ requestOrganisationDeletion: TRestAPIOperation<void, IRequestOrganisationDeletionRestReturnValue_2_0>;
16394
+ readCollectionsToBeDeleted: TRestAPIOperation<void, TReadCollectionsToBeDeletedRestReturnValue_2_0>;
15235
16395
  }
15236
16396
  declare function AdministrationAPIGroup_2_0(instance: Base): AdministrationAPIGroup_2_0;
15237
16397
  /**
@@ -15301,13 +16461,13 @@ export interface IReadVendorRestReturnValue_2_0 extends IVendor_2_0 {
15301
16461
  * type: number
15302
16462
  * conversationTTLInMinutes:
15303
16463
  * type: number
16464
+ * billingTimezone:
16465
+ * $ref: '#/components/schemas/TTimezone'
16466
+ * dataPrivacySettings:
16467
+ * $ref: '#/components/schemas/IOrganisationDataPrivacySettings_2_0'
15304
16468
  * IOrganisation_2_0:
15305
16469
  * allOf:
15306
16470
  * - $ref: '#/components/schemas/IOrganisationData_2_0'
15307
- * - type: object
15308
- * properties:
15309
- * _id:
15310
- * $ref: '#/components/schemas/TMongoId'
15311
16471
  */
15312
16472
  export interface IOrganisation_2_0 {
15313
16473
  /** The mongo object id of this organisation */
@@ -15325,6 +16485,11 @@ export interface IOrganisation_2_0 {
15325
16485
  sessionStateTTLInMinutes: number;
15326
16486
  contactProfileTTLInMinutes: number;
15327
16487
  conversationTTLInMinutes: number;
16488
+ analyticsTTLInMinutes: number;
16489
+ sessionsTTLInMinutes: number;
16490
+ stepEventsTTLInMinutes: number;
16491
+ billingTimezone: string;
16492
+ dataPrivacySettings: IOrganisationDataPrivacySettings_2_0;
15328
16493
  }
15329
16494
  /**
15330
16495
  * @openapi
@@ -15361,6 +16526,40 @@ export interface IOrganisationPasswordPolicy_2_0 {
15361
16526
  maxAmountIdenticalCharacters: number;
15362
16527
  minAmountFailedAttemptsAutoDisable: number;
15363
16528
  }
16529
+ /**
16530
+ * @openapi
16531
+ *
16532
+ * components:
16533
+ * schemas:
16534
+ * IOrganisationDataPrivacySettings_2_0:
16535
+ * type: object
16536
+ * properties:
16537
+ * enabled:
16538
+ * type: boolean
16539
+ * useAnalytics:
16540
+ * type: boolean
16541
+ * useContactProfiles:
16542
+ * type: boolean
16543
+ * useConversations:
16544
+ * type: boolean
16545
+ * maskAnalytics:
16546
+ * type: boolean
16547
+ * maskLogging:
16548
+ * type: boolean
16549
+ * ignoreList:
16550
+ * type: array
16551
+ * items:
16552
+ * $ref: '#/components/schemas/TMongoId'
16553
+ */
16554
+ export interface IOrganisationDataPrivacySettings_2_0 {
16555
+ enabled: boolean;
16556
+ useAnalytics: boolean;
16557
+ useContactProfiles: boolean;
16558
+ useConversations: boolean;
16559
+ maskAnalytics: boolean;
16560
+ maskLogging: boolean;
16561
+ ignoreList: string[];
16562
+ }
15364
16563
  /**
15365
16564
  * @openapi
15366
16565
  *
@@ -15395,6 +16594,10 @@ export interface IOrganisationPasswordPolicy_2_0 {
15395
16594
  * type: number
15396
16595
  * liveAgentAccount:
15397
16596
  * type: number
16597
+ * billingTimezone:
16598
+ * $ref: '#/components/schemas/TTimezone'
16599
+ * dataPrivacySettings:
16600
+ * $ref: '#/components/schemas/IOrganisationDataPrivacySettings_2_0'
15398
16601
  */
15399
16602
  export interface IOrganisationIndexItem_2_0 {
15400
16603
  /** The mongo object id of this organisation */
@@ -15409,10 +16612,12 @@ export interface IOrganisationIndexItem_2_0 {
15409
16612
  quotaMaxChannelsPerProject: number;
15410
16613
  quotaMaxMessagesPerDay: number;
15411
16614
  passwordPolicy: IOrganisationPasswordPolicy_2_0;
16615
+ billingTimezone: string;
15412
16616
  sessionStateTTLInMinutes: number;
15413
16617
  contactProfileTTLInMinutes: number;
15414
16618
  conversationTTLInMinutes: number;
15415
16619
  liveAgentAccount: number;
16620
+ dataPrivacySettings: IOrganisationDataPrivacySettings_2_0;
15416
16621
  }
15417
16622
  export interface IIndexOrganisationsRestData_2_0 extends IRestPagination<IOrganisationIndexItem_2_0> {
15418
16623
  }
@@ -15454,6 +16659,27 @@ export interface ICreateApiKeyRestManagementData_2_0 extends ICreateApiKeyRestMa
15454
16659
  }
15455
16660
  export interface ICreateApiKeyRestManagementReturnValue_2_0 extends IApiKey_2_0 {
15456
16661
  }
16662
+ /**
16663
+ * @openapi
16664
+ * components:
16665
+ * parameters:
16666
+ * organisationDeletionTokenParam:
16667
+ * in: query
16668
+ * name: verificationToken
16669
+ * required: true
16670
+ * schema:
16671
+ * type: string
16672
+ */
16673
+ export interface IDeleteOrganisationRestQuery_2_0 {
16674
+ verificationToken: string;
16675
+ }
16676
+ export interface IDeleteOrganisationRestParams_2_0 {
16677
+ organisationId: string;
16678
+ }
16679
+ export interface IDeleteOrganisationRestData_2_0 extends IDeleteOrganisationRestParams_2_0, IDeleteOrganisationRestQuery_2_0 {
16680
+ }
16681
+ export interface IDeleteOrganisationRestReturnValue_2_0 {
16682
+ }
15457
16683
  export interface IGetBillingInformationRestData_2_0 extends IRestPagination<{
15458
16684
  name: string;
15459
16685
  isDisabled: boolean;
@@ -15472,6 +16698,7 @@ export interface IGetBillingInformationRestReturnValue_2_0 extends ICursorBasedP
15472
16698
  export interface ICreateSystemMessageRestDataBody_2_0 {
15473
16699
  until: number;
15474
16700
  message: string;
16701
+ showOnLogin?: boolean;
15475
16702
  }
15476
16703
  export interface ICreateSystemMessageRestData_2_0 extends ICreateSystemMessageRestDataBody_2_0 {
15477
16704
  }
@@ -15489,6 +16716,8 @@ export interface ICreateSystemMessageRestReturnValue_2_0 {
15489
16716
  * type: string
15490
16717
  * name:
15491
16718
  * type: string
16719
+ * password:
16720
+ * type: string
15492
16721
  * organisation:
15493
16722
  * $ref: '#/components/schemas/TMongoId'
15494
16723
  * roles:
@@ -15607,6 +16836,7 @@ export interface ManagementAPIGroup_2_0 {
15607
16836
  createOrganisation: TRestAPIOperation<ICreateOrganisationRestData_2_0, ICreateOrganisationRestReturnValue_2_0>;
15608
16837
  readOrganisation: TRestAPIOperation<IReadOrganisationRestData_2_0, IReadOrganisationRestReturnValue_2_0>;
15609
16838
  updateOrganisation: TRestAPIOperation<IUpdateOrganisationRestData_2_0, IUpdateOrganisationRestReturnValue_2_0>;
16839
+ deleteOrganisation: TRestAPIOperation<IDeleteOrganisationRestData_2_0, IDeleteOrganisationRestReturnValue_2_0>;
15610
16840
  enforcePasswordPolicy: TRestAPIOperation<IEnforcePasswordPolicyRestData_2_0, IEnforcePasswordPolicyRestReturnValue_2_0>;
15611
16841
  indexUsersManagement: TRestAPIOperation<TRestAPIOptionalParameter<IIndexUsersRestManagementData_2_0>, IIndexUsersRestManagementReturnValue_2_0>;
15612
16842
  createUserManagement: TRestAPIOperation<ICreateUserRestManagementData_2_0, ICreateUserRestManagementReturnValue_2_0>;
@@ -15665,7 +16895,7 @@ declare function ManagementAPIGroup_2_0(instance: Base): ManagementAPIGroup_2_0;
15665
16895
  * endpointUrlToken:
15666
16896
  * type: string
15667
16897
  * handoverEscalations:
15668
- * type: string
16898
+ * type: number
15669
16899
  * snapshotName:
15670
16900
  * type: string
15671
16901
  * slots:
@@ -16144,6 +17374,9 @@ export declare enum HttpStatusCode {
16144
17374
  */
16145
17375
  NETWORK_AUTHENTICATION_REQUIRED = 511
16146
17376
  }
16147
- export default RestAPIClient;
17377
+
17378
+ export {
17379
+ RestAPIClient as default,
17380
+ };
16148
17381
 
16149
17382
  export {};