@iblai/iblai-api 3.48.1-core → 3.48.2-ai-plus

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 (668) hide show
  1. package/dist/index.cjs.js +16420 -112
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +16412 -113
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +16420 -112
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +320 -1
  8. package/dist/types/models/AIGeneratedImage.d.ts +13 -0
  9. package/dist/types/models/AIUserProfileMemoryRelation.d.ts +4 -0
  10. package/dist/types/models/AIUserProfileRequest.d.ts +4 -0
  11. package/dist/types/models/APITokenCost.d.ts +14 -0
  12. package/dist/types/models/AccessEnum.d.ts +8 -0
  13. package/dist/types/models/AlignMentorBubbleEnum.d.ts +8 -0
  14. package/dist/types/models/AnalyticsOverview.d.ts +7 -0
  15. package/dist/types/models/Answer.d.ts +11 -0
  16. package/dist/types/models/AssumedKnowledge.d.ts +4 -0
  17. package/dist/types/models/AssumedKnowledgeLevel.d.ts +4 -0
  18. package/dist/types/models/AudioToTextRequest.d.ts +3 -0
  19. package/dist/types/models/AudioToTextResponse.d.ts +3 -0
  20. package/dist/types/models/Bot.d.ts +15 -0
  21. package/dist/types/models/BotCommand.d.ts +6 -0
  22. package/dist/types/models/BotCreate.d.ts +12 -0
  23. package/dist/types/models/CallAuthenticationRequest.d.ts +13 -0
  24. package/dist/types/models/CallAuthenticationResponse.d.ts +21 -0
  25. package/dist/types/models/ChatHistory.d.ts +8 -0
  26. package/dist/types/models/ChatHistoryFilterData.d.ts +9 -0
  27. package/dist/types/models/ChatHistoryFilterUser.d.ts +5 -0
  28. package/dist/types/models/ChatHistoryItem.d.ts +5 -0
  29. package/dist/types/models/ChatHistorySessionId.d.ts +3 -0
  30. package/dist/types/models/ChatSessionRequest.d.ts +10 -0
  31. package/dist/types/models/ChatSessionResponse.d.ts +5 -0
  32. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +10 -0
  33. package/dist/types/models/ComponentBlock.d.ts +9 -0
  34. package/dist/types/models/ComponentBlockTypeEnum.d.ts +8 -0
  35. package/dist/types/models/ConversationMessage.d.ts +11 -0
  36. package/dist/types/models/ConversationRating.d.ts +6 -0
  37. package/dist/types/models/ConversationSummary.d.ts +5 -0
  38. package/dist/types/models/ConversationVolume.d.ts +4 -0
  39. package/dist/types/models/Conversations.d.ts +28 -0
  40. package/dist/types/models/Cost.d.ts +3 -0
  41. package/dist/types/models/CostPerTenant.d.ts +6 -0
  42. package/dist/types/models/CourseCreationTask.d.ts +31 -0
  43. package/dist/types/models/CourseCreationTaskFile.d.ts +7 -0
  44. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +16 -0
  45. package/dist/types/models/CredentialRequest.d.ts +14 -0
  46. package/dist/types/models/CrontabSchedule.d.ts +22 -0
  47. package/dist/types/models/CustomInstructionResponse.d.ts +13 -0
  48. package/dist/types/models/DataSet.d.ts +21 -0
  49. package/dist/types/models/DataSetCreate.d.ts +12 -0
  50. package/dist/types/models/DataSetStatusEnum.d.ts +12 -0
  51. package/dist/types/models/DateRange.d.ts +4 -0
  52. package/dist/types/models/DiscordConfig.d.ts +7 -0
  53. package/dist/types/models/DiscordUserConfig.d.ts +10 -0
  54. package/dist/types/models/DiscordWebhook.d.ts +6 -0
  55. package/dist/types/models/Document.d.ts +41 -0
  56. package/dist/types/models/DocumentFacet.d.ts +17 -0
  57. package/dist/types/models/DocumentSearchResponse.d.ts +35 -0
  58. package/dist/types/models/DocumentSettingsResponse.d.ts +3 -0
  59. package/dist/types/models/EdxCourse.d.ts +11 -0
  60. package/dist/types/models/ElevenlabsCustomVoice.d.ts +4 -0
  61. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +8 -0
  62. package/dist/types/models/EmailPromptDetail.d.ts +13 -0
  63. package/dist/types/models/EmailPromptList.d.ts +11 -0
  64. package/dist/types/models/EmailPromptSummary.d.ts +5 -0
  65. package/dist/types/models/FreeUsageCount.d.ts +3 -0
  66. package/dist/types/models/FullCourse.d.ts +13 -0
  67. package/dist/types/models/GreetingMethodEnum.d.ts +8 -0
  68. package/dist/types/models/GuidedPromptsResponse.d.ts +3 -0
  69. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +8 -0
  70. package/dist/types/models/HeygenMarketingVideoList.d.ts +6 -0
  71. package/dist/types/models/HeygenTemplateRequest.d.ts +5 -0
  72. package/dist/types/models/HeygenTemplateResponseSingle.d.ts +6 -0
  73. package/dist/types/models/HeygenVideoDetail.d.ts +8 -0
  74. package/dist/types/models/HeygenVideoRequest.d.ts +5 -0
  75. package/dist/types/models/IBLAIPlatformMeta.d.ts +3 -0
  76. package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +6 -0
  77. package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +10 -0
  78. package/dist/types/models/InputQuestion.d.ts +6 -0
  79. package/dist/types/models/IntegrationCredential.d.ts +8 -0
  80. package/dist/types/models/IntialQuestionAnswer.d.ts +3 -0
  81. package/dist/types/models/JobRun.d.ts +11 -0
  82. package/dist/types/models/KindEnum.d.ts +10 -0
  83. package/dist/types/models/LLMCredentialRequest.d.ts +14 -0
  84. package/dist/types/models/LLMCredentialResponse.d.ts +8 -0
  85. package/dist/types/models/LLMModelForTenant.d.ts +6 -0
  86. package/dist/types/models/LLMQuestion.d.ts +15 -0
  87. package/dist/types/models/LLMResponse.d.ts +14 -0
  88. package/dist/types/models/LLMTracesListResponse.d.ts +5 -0
  89. package/dist/types/models/LanguagesView.d.ts +5 -0
  90. package/dist/types/models/LinkCourseRequest.d.ts +3 -0
  91. package/dist/types/models/LinkCourseResponse.d.ts +5 -0
  92. package/dist/types/models/MCPServer.d.ts +21 -0
  93. package/dist/types/models/MemoryComponentData.d.ts +5 -0
  94. package/dist/types/models/MemoryComponentMemory.d.ts +4 -0
  95. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +8 -0
  96. package/dist/types/models/MemoryComponentResponse.d.ts +5 -0
  97. package/dist/types/models/MemoryProgress.d.ts +8 -0
  98. package/dist/types/models/MemoryStatusRequestView.d.ts +6 -0
  99. package/dist/types/models/MemoryStatusView.d.ts +6 -0
  100. package/dist/types/models/Mentor.d.ts +85 -0
  101. package/dist/types/models/MentorAudience.d.ts +5 -0
  102. package/dist/types/models/MentorCategory.d.ts +9 -0
  103. package/dist/types/models/MentorCategoryCreate.d.ts +11 -0
  104. package/dist/types/models/MentorCategoryGroup.d.ts +11 -0
  105. package/dist/types/models/MentorCategoryGroupCreate.d.ts +11 -0
  106. package/dist/types/models/MentorCreate.d.ts +84 -0
  107. package/dist/types/models/MentorCustomVoice.d.ts +4 -0
  108. package/dist/types/models/MentorCustomVoiceResponse.d.ts +4 -0
  109. package/dist/types/models/MentorData.d.ts +7 -0
  110. package/dist/types/models/MentorDetailAnalytics.d.ts +6 -0
  111. package/dist/types/models/MentorEval.d.ts +11 -0
  112. package/dist/types/models/MentorEvalQuestion.d.ts +5 -0
  113. package/dist/types/models/MentorEvalQuestionRequest.d.ts +4 -0
  114. package/dist/types/models/MentorEvalReport.d.ts +10 -0
  115. package/dist/types/models/MentorEvalRequest.d.ts +8 -0
  116. package/dist/types/models/MentorFacet.d.ts +17 -0
  117. package/dist/types/models/MentorFork.d.ts +5 -0
  118. package/dist/types/models/MentorFromTemplateRequest.d.ts +4 -0
  119. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +47 -0
  120. package/dist/types/models/MentorMemorySettingsRequest.d.ts +6 -0
  121. package/dist/types/models/MentorMemorySettingsResponse.d.ts +6 -0
  122. package/dist/types/models/MentorMetadata.d.ts +5 -0
  123. package/dist/types/models/MentorScenario.d.ts +6 -0
  124. package/dist/types/models/MentorScenarioPrompt.d.ts +5 -0
  125. package/dist/types/models/MentorSearchResponse.d.ts +35 -0
  126. package/dist/types/models/MentorSession.d.ts +4 -0
  127. package/dist/types/models/MentorSettings.d.ts +58 -0
  128. package/dist/types/models/MentorSettingsPublic.d.ts +46 -0
  129. package/dist/types/models/MentorSettingsRequest.d.ts +62 -0
  130. package/dist/types/models/MentorVisibilityEnum.d.ts +10 -0
  131. package/dist/types/models/MentorWizard.d.ts +4 -0
  132. package/dist/types/models/MessageStatistics.d.ts +5 -0
  133. package/dist/types/models/MessageView.d.ts +10 -0
  134. package/dist/types/models/MessageViewRequest.d.ts +7 -0
  135. package/dist/types/models/MessageViewUpdatResponse.d.ts +3 -0
  136. package/dist/types/models/Metadata.d.ts +5 -0
  137. package/dist/types/models/MetricChange.d.ts +4 -0
  138. package/dist/types/models/ModelCost.d.ts +4 -0
  139. package/dist/types/models/ModerationLog.d.ts +11 -0
  140. package/dist/types/models/NoChatMessagesFound.d.ts +3 -0
  141. package/dist/types/models/NotificationSource.d.ts +2 -2
  142. package/dist/types/models/{TypeEnum.d.ts → NotificationSourceTypeEnum.d.ts} +1 -1
  143. package/dist/types/models/NullEnum.d.ts +1 -0
  144. package/dist/types/models/PageContent.d.ts +6 -0
  145. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +7 -0
  146. package/dist/types/models/PaginatedConversationsList.d.ts +7 -0
  147. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +7 -0
  148. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +7 -0
  149. package/dist/types/models/PaginatedDataSetList.d.ts +7 -0
  150. package/dist/types/models/PaginatedEdxCourseList.d.ts +7 -0
  151. package/dist/types/models/PaginatedEmailPromptListList.d.ts +7 -0
  152. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +7 -0
  153. package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +7 -0
  154. package/dist/types/models/PaginatedJobRunList.d.ts +7 -0
  155. package/dist/types/models/PaginatedMCPServerList.d.ts +7 -0
  156. package/dist/types/models/PaginatedMentorList.d.ts +7 -0
  157. package/dist/types/models/PaginatedModerationLogList.d.ts +7 -0
  158. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +7 -0
  159. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +7 -0
  160. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +7 -0
  161. package/dist/types/models/PaginatedSectionList.d.ts +7 -0
  162. package/dist/types/models/PaginatedSubSectionList.d.ts +7 -0
  163. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +7 -0
  164. package/dist/types/models/PaginatedTrainingList.d.ts +7 -0
  165. package/dist/types/models/PaginatedUnitList.d.ts +7 -0
  166. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +7 -0
  167. package/dist/types/models/PaginatedVoiceList.d.ts +7 -0
  168. package/dist/types/models/PatchedBotCommand.d.ts +6 -0
  169. package/dist/types/models/PatchedBotCreate.d.ts +12 -0
  170. package/dist/types/models/PatchedConversations.d.ts +28 -0
  171. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +7 -0
  172. package/dist/types/models/PatchedCredentialRequest.d.ts +14 -0
  173. package/dist/types/models/PatchedDataSet.d.ts +21 -0
  174. package/dist/types/models/PatchedDiscordConfig.d.ts +7 -0
  175. package/dist/types/models/PatchedDiscordUserConfig.d.ts +10 -0
  176. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +14 -0
  177. package/dist/types/models/PatchedMCPServer.d.ts +21 -0
  178. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +11 -0
  179. package/dist/types/models/PatchedMentorCreate.d.ts +84 -0
  180. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +41 -0
  181. package/dist/types/models/PatchedPlayWrightScript.d.ts +12 -0
  182. package/dist/types/models/PatchedPrompt.d.ts +22 -0
  183. package/dist/types/models/PatchedRbacGroupRole.d.ts +2 -2
  184. package/dist/types/models/PatchedRbacPolicy.d.ts +2 -2
  185. package/dist/types/models/PatchedRbacUserRole.d.ts +2 -2
  186. package/dist/types/models/PatchedSection.d.ts +9 -0
  187. package/dist/types/models/PatchedSlackConfig.d.ts +8 -0
  188. package/dist/types/models/PatchedSlackUserConfig.d.ts +17 -0
  189. package/dist/types/models/PatchedSubSection.d.ts +9 -0
  190. package/dist/types/models/PatchedTeamsConfig.d.ts +7 -0
  191. package/dist/types/models/PatchedTrainingCreate.d.ts +31 -0
  192. package/dist/types/models/PatchedUnit.d.ts +11 -0
  193. package/dist/types/models/PatchedWebexConfig.d.ts +10 -0
  194. package/dist/types/models/PatchedWhatsappConfig.d.ts +11 -0
  195. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +10 -0
  196. package/dist/types/models/PeriodicAgent.d.ts +42 -0
  197. package/dist/types/models/PeriodicAgentCreate.d.ts +41 -0
  198. package/dist/types/models/PeriodicAgentLog.d.ts +11 -0
  199. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +10 -0
  200. package/dist/types/models/PeriodicTask.d.ts +21 -0
  201. package/dist/types/models/PieChartData.d.ts +5 -0
  202. package/dist/types/models/PieChartSegment.d.ts +4 -0
  203. package/dist/types/models/PinnedMessageCreate.d.ts +9 -0
  204. package/dist/types/models/PinnedMessageGet.d.ts +7 -0
  205. package/dist/types/models/PinnedMessageRequest.d.ts +6 -0
  206. package/dist/types/models/PlayWrightScript.d.ts +12 -0
  207. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +4 -0
  208. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +4 -0
  209. package/dist/types/models/PreviousAgentStatusEnum.d.ts +12 -0
  210. package/dist/types/models/Prompt.d.ts +22 -0
  211. package/dist/types/models/PromptCategory.d.ts +7 -0
  212. package/dist/types/models/PromptFacet.d.ts +17 -0
  213. package/dist/types/models/PromptSearchResponse.d.ts +35 -0
  214. package/dist/types/models/PromptVisibilityEnum.d.ts +10 -0
  215. package/dist/types/models/Provider05cEnum.d.ts +14 -0
  216. package/dist/types/models/Provider63aEnum.d.ts +6 -0
  217. package/dist/types/models/QuestionCardTag.d.ts +8 -0
  218. package/dist/types/models/QuestionRequest.d.ts +15 -0
  219. package/dist/types/models/QuestionResponse.d.ts +10 -0
  220. package/dist/types/models/RatingEnum.d.ts +8 -0
  221. package/dist/types/models/RatingRecord.d.ts +4 -0
  222. package/dist/types/models/RbacBaseRole.d.ts +15 -0
  223. package/dist/types/models/RbacGroupRole.d.ts +2 -2
  224. package/dist/types/models/RbacPolicy.d.ts +2 -2
  225. package/dist/types/models/RbacUserRole.d.ts +2 -2
  226. package/dist/types/models/RecentlyAccessedMentor.d.ts +8 -0
  227. package/dist/types/models/RecommendCourseBlock.d.ts +3 -0
  228. package/dist/types/models/RecommendCourseResponse.d.ts +3 -0
  229. package/dist/types/models/RecommendedCoursesResponse.d.ts +33 -0
  230. package/dist/types/models/RelatedText.d.ts +3 -0
  231. package/dist/types/models/RequestDataVariable.d.ts +14 -0
  232. package/dist/types/models/ResourceScrappedData.d.ts +13 -0
  233. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +12 -0
  234. package/dist/types/models/ResponseDataVariable.d.ts +14 -0
  235. package/dist/types/models/RetreiverTrainViewRequest.d.ts +10 -0
  236. package/dist/types/models/RetreiverTrainViewResponse.d.ts +6 -0
  237. package/dist/types/models/RetrieveTask.d.ts +3 -0
  238. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +17 -0
  239. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +30 -0
  240. package/dist/types/models/RetrieverRequestSearch.d.ts +10 -0
  241. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +10 -0
  242. package/dist/types/models/RetrieverResponseSearch.d.ts +7 -0
  243. package/dist/types/models/ReuestDataVariableList.d.ts +4 -0
  244. package/dist/types/models/RunMentorEval.d.ts +3 -0
  245. package/dist/types/models/ScanWebhookRequest.d.ts +6 -0
  246. package/dist/types/models/ScanWebhookResponse.d.ts +3 -0
  247. package/dist/types/models/Section.d.ts +9 -0
  248. package/dist/types/models/SectionWithChildren.d.ts +11 -0
  249. package/dist/types/models/SeedMentorsView.d.ts +3 -0
  250. package/dist/types/models/SentimentSummary.d.ts +4 -0
  251. package/dist/types/models/SessionBrowserScreenshot.d.ts +8 -0
  252. package/dist/types/models/SessionDetail.d.ts +6 -0
  253. package/dist/types/models/SessionMemoryStorage.d.ts +6 -0
  254. package/dist/types/models/ShellLogs.d.ts +3 -0
  255. package/dist/types/models/SlackConfig.d.ts +8 -0
  256. package/dist/types/models/SlackUserConfig.d.ts +17 -0
  257. package/dist/types/models/SlackWebhook.d.ts +6 -0
  258. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +3 -0
  259. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +5 -0
  260. package/dist/types/models/StarMentor.d.ts +7 -0
  261. package/dist/types/models/Status6eeEnum.d.ts +12 -0
  262. package/dist/types/models/Step.d.ts +9 -0
  263. package/dist/types/models/StepStatusEnum.d.ts +10 -0
  264. package/dist/types/models/StudentChatMessage.d.ts +4 -0
  265. package/dist/types/models/StylesView.d.ts +4 -0
  266. package/dist/types/models/SubSection.d.ts +9 -0
  267. package/dist/types/models/SubSectionWithChildren.d.ts +11 -0
  268. package/dist/types/models/TagsView.d.ts +5 -0
  269. package/dist/types/models/TargetSystemEnum.d.ts +8 -0
  270. package/dist/types/models/TaskView.d.ts +3 -0
  271. package/dist/types/models/TeamsConfig.d.ts +7 -0
  272. package/dist/types/models/TeamsWebhook.d.ts +17 -0
  273. package/dist/types/models/TemplateMentor.d.ts +9 -0
  274. package/dist/types/models/TenantMentorTraces.d.ts +6 -0
  275. package/dist/types/models/ThemeEnum.d.ts +8 -0
  276. package/dist/types/models/TonesView.d.ts +4 -0
  277. package/dist/types/models/ToolResponse.d.ts +11 -0
  278. package/dist/types/models/TopicModel.d.ts +3 -0
  279. package/dist/types/models/TopicRecord.d.ts +4 -0
  280. package/dist/types/models/TopicStatistics.d.ts +7 -0
  281. package/dist/types/models/TopicStatisticsResponse.d.ts +6 -0
  282. package/dist/types/models/TopicSummaryView.d.ts +4 -0
  283. package/dist/types/models/TrainChatSessionDocumentView.d.ts +6 -0
  284. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +6 -0
  285. package/dist/types/models/TrainDocumentViewRequest.d.ts +42 -0
  286. package/dist/types/models/TrainDocumentViewResponse.d.ts +15 -0
  287. package/dist/types/models/Training.d.ts +41 -0
  288. package/dist/types/models/TrainingCreate.d.ts +31 -0
  289. package/dist/types/models/TrainingStatusEnum.d.ts +12 -0
  290. package/dist/types/models/TransportEnum.d.ts +8 -0
  291. package/dist/types/models/TrendEntry.d.ts +4 -0
  292. package/dist/types/models/TriggerRequest.d.ts +5 -0
  293. package/dist/types/models/TriggerResponse.d.ts +6 -0
  294. package/dist/types/models/TypeC42Enum.d.ts +8 -0
  295. package/dist/types/models/Unit.d.ts +11 -0
  296. package/dist/types/models/UnitWithChildren.d.ts +13 -0
  297. package/dist/types/models/UseMainCreds.d.ts +3 -0
  298. package/dist/types/models/UserAllChatMemoryView.d.ts +7 -0
  299. package/dist/types/models/UserCatalogItemMemoryView.d.ts +14 -0
  300. package/dist/types/models/UserChatByPeriod.d.ts +4 -0
  301. package/dist/types/models/UserChatFeedback.d.ts +14 -0
  302. package/dist/types/models/UserChatFeedbackCount.d.ts +4 -0
  303. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +6 -0
  304. package/dist/types/models/UserChatMemoryStatusView.d.ts +6 -0
  305. package/dist/types/models/UserChatMemoryUpdateView.d.ts +10 -0
  306. package/dist/types/models/UserCountRecord.d.ts +4 -0
  307. package/dist/types/models/UserEdxMemory.d.ts +15 -0
  308. package/dist/types/models/UserMemoryContextRequest.d.ts +13 -0
  309. package/dist/types/models/UserMemoryContextResponse.d.ts +12 -0
  310. package/dist/types/models/UserMetric.d.ts +4 -0
  311. package/dist/types/models/UserMetricsResponse.d.ts +7 -0
  312. package/dist/types/models/UserSentimentCountView.d.ts +4 -0
  313. package/dist/types/models/UserTrendByPeriod.d.ts +5 -0
  314. package/dist/types/models/VectorResult.d.ts +8 -0
  315. package/dist/types/models/VideoCaption.d.ts +3 -0
  316. package/dist/types/models/Voice.d.ts +9 -0
  317. package/dist/types/models/VoiceProviderEnum.d.ts +10 -0
  318. package/dist/types/models/WebResource.d.ts +9 -0
  319. package/dist/types/models/WebResourceCard.d.ts +7 -0
  320. package/dist/types/models/WebResourcesQuery.d.ts +3 -0
  321. package/dist/types/models/WebexConfig.d.ts +10 -0
  322. package/dist/types/models/WebexWebhook.d.ts +4 -0
  323. package/dist/types/models/WhatAppWebHook.d.ts +3 -0
  324. package/dist/types/models/WhatsappConfig.d.ts +11 -0
  325. package/dist/types/models/WhatsappUserConfig.d.ts +10 -0
  326. package/dist/types/services/AiAccountService.d.ts +294 -0
  327. package/dist/types/services/AiAnalyticsService.d.ts +2801 -0
  328. package/dist/types/services/AiBotService.d.ts +486 -0
  329. package/dist/types/services/AiFinetuningService.d.ts +162 -0
  330. package/dist/types/services/AiIndexService.d.ts +400 -0
  331. package/dist/types/services/AiMarketingService.d.ts +34 -0
  332. package/dist/types/services/AiMediaService.d.ts +118 -0
  333. package/dist/types/services/AiMentorService.d.ts +4235 -0
  334. package/dist/types/services/AiPromptService.d.ts +920 -0
  335. package/dist/types/services/CoreService.d.ts +10 -5
  336. package/dist/types/services/SearchService.d.ts +408 -0
  337. package/package.json +1 -1
  338. package/src/core/OpenAPI.ts +1 -1
  339. package/src/index.ts +320 -1
  340. package/src/models/AIGeneratedImage.ts +18 -0
  341. package/src/models/AIUserProfileMemoryRelation.ts +9 -0
  342. package/src/models/AIUserProfileRequest.ts +9 -0
  343. package/src/models/APITokenCost.ts +19 -0
  344. package/src/models/AccessEnum.ts +12 -0
  345. package/src/models/AlignMentorBubbleEnum.ts +12 -0
  346. package/src/models/AnalyticsOverview.ts +12 -0
  347. package/src/models/Answer.ts +16 -0
  348. package/src/models/AssumedKnowledge.ts +9 -0
  349. package/src/models/AssumedKnowledgeLevel.ts +9 -0
  350. package/src/models/AudioToTextRequest.ts +8 -0
  351. package/src/models/AudioToTextResponse.ts +8 -0
  352. package/src/models/Bot.ts +20 -0
  353. package/src/models/BotCommand.ts +11 -0
  354. package/src/models/BotCreate.ts +17 -0
  355. package/src/models/CallAuthenticationRequest.ts +18 -0
  356. package/src/models/CallAuthenticationResponse.ts +26 -0
  357. package/src/models/ChatHistory.ts +13 -0
  358. package/src/models/ChatHistoryFilterData.ts +14 -0
  359. package/src/models/ChatHistoryFilterUser.ts +10 -0
  360. package/src/models/ChatHistoryItem.ts +10 -0
  361. package/src/models/ChatHistorySessionId.ts +8 -0
  362. package/src/models/ChatSessionRequest.ts +15 -0
  363. package/src/models/ChatSessionResponse.ts +10 -0
  364. package/src/models/CheckDocumentTrainingStatus.ts +15 -0
  365. package/src/models/ComponentBlock.ts +14 -0
  366. package/src/models/ComponentBlockTypeEnum.ts +12 -0
  367. package/src/models/ConversationMessage.ts +16 -0
  368. package/src/models/ConversationRating.ts +11 -0
  369. package/src/models/ConversationSummary.ts +10 -0
  370. package/src/models/ConversationVolume.ts +9 -0
  371. package/src/models/Conversations.ts +33 -0
  372. package/src/models/Cost.ts +8 -0
  373. package/src/models/CostPerTenant.ts +11 -0
  374. package/src/models/CourseCreationTask.ts +36 -0
  375. package/src/models/CourseCreationTaskFile.ts +12 -0
  376. package/src/models/CourseCreationTaskStatusEnum.ts +20 -0
  377. package/src/models/CredentialRequest.ts +19 -0
  378. package/src/models/CrontabSchedule.ts +27 -0
  379. package/src/models/CustomInstructionResponse.ts +18 -0
  380. package/src/models/DataSet.ts +26 -0
  381. package/src/models/DataSetCreate.ts +17 -0
  382. package/src/models/DataSetStatusEnum.ts +16 -0
  383. package/src/models/DateRange.ts +9 -0
  384. package/src/models/DiscordConfig.ts +12 -0
  385. package/src/models/DiscordUserConfig.ts +15 -0
  386. package/src/models/DiscordWebhook.ts +11 -0
  387. package/src/models/Document.ts +46 -0
  388. package/src/models/DocumentFacet.ts +22 -0
  389. package/src/models/DocumentSearchResponse.ts +40 -0
  390. package/src/models/DocumentSettingsResponse.ts +8 -0
  391. package/src/models/EdxCourse.ts +16 -0
  392. package/src/models/ElevenlabsCustomVoice.ts +9 -0
  393. package/src/models/ElevenlabsCustomVoiceResponse.ts +13 -0
  394. package/src/models/EmailPromptDetail.ts +18 -0
  395. package/src/models/EmailPromptList.ts +16 -0
  396. package/src/models/EmailPromptSummary.ts +10 -0
  397. package/src/models/FreeUsageCount.ts +8 -0
  398. package/src/models/FullCourse.ts +18 -0
  399. package/src/models/GreetingMethodEnum.ts +12 -0
  400. package/src/models/GuidedPromptsResponse.ts +8 -0
  401. package/src/models/HeygenMarketingVideoDetail.ts +13 -0
  402. package/src/models/HeygenMarketingVideoList.ts +11 -0
  403. package/src/models/HeygenTemplateRequest.ts +10 -0
  404. package/src/models/HeygenTemplateResponseSingle.ts +11 -0
  405. package/src/models/HeygenVideoDetail.ts +13 -0
  406. package/src/models/HeygenVideoRequest.ts +10 -0
  407. package/src/models/IBLAIPlatformMeta.ts +8 -0
  408. package/src/models/IBLAIPlatformMetaRequest.ts +11 -0
  409. package/src/models/IBLAIPlatformMetaUpdateRequest.ts +15 -0
  410. package/src/models/InputQuestion.ts +11 -0
  411. package/src/models/IntegrationCredential.ts +13 -0
  412. package/src/models/IntialQuestionAnswer.ts +8 -0
  413. package/src/models/JobRun.ts +16 -0
  414. package/src/models/KindEnum.ts +14 -0
  415. package/src/models/LLMCredentialRequest.ts +19 -0
  416. package/src/models/LLMCredentialResponse.ts +13 -0
  417. package/src/models/LLMModelForTenant.ts +11 -0
  418. package/src/models/LLMQuestion.ts +20 -0
  419. package/src/models/LLMResponse.ts +19 -0
  420. package/src/models/LLMTracesListResponse.ts +10 -0
  421. package/src/models/LanguagesView.ts +10 -0
  422. package/src/models/LinkCourseRequest.ts +8 -0
  423. package/src/models/LinkCourseResponse.ts +10 -0
  424. package/src/models/MCPServer.ts +26 -0
  425. package/src/models/MemoryComponentData.ts +10 -0
  426. package/src/models/MemoryComponentMemory.ts +9 -0
  427. package/src/models/MemoryComponentMemoryDetail.ts +13 -0
  428. package/src/models/MemoryComponentResponse.ts +10 -0
  429. package/src/models/MemoryProgress.ts +13 -0
  430. package/src/models/MemoryStatusRequestView.ts +11 -0
  431. package/src/models/MemoryStatusView.ts +11 -0
  432. package/src/models/Mentor.ts +90 -0
  433. package/src/models/MentorAudience.ts +10 -0
  434. package/src/models/MentorCategory.ts +14 -0
  435. package/src/models/MentorCategoryCreate.ts +16 -0
  436. package/src/models/MentorCategoryGroup.ts +16 -0
  437. package/src/models/MentorCategoryGroupCreate.ts +16 -0
  438. package/src/models/MentorCreate.ts +89 -0
  439. package/src/models/MentorCustomVoice.ts +9 -0
  440. package/src/models/MentorCustomVoiceResponse.ts +9 -0
  441. package/src/models/MentorData.ts +12 -0
  442. package/src/models/MentorDetailAnalytics.ts +11 -0
  443. package/src/models/MentorEval.ts +16 -0
  444. package/src/models/MentorEvalQuestion.ts +10 -0
  445. package/src/models/MentorEvalQuestionRequest.ts +9 -0
  446. package/src/models/MentorEvalReport.ts +15 -0
  447. package/src/models/MentorEvalRequest.ts +13 -0
  448. package/src/models/MentorFacet.ts +22 -0
  449. package/src/models/MentorFork.ts +10 -0
  450. package/src/models/MentorFromTemplateRequest.ts +9 -0
  451. package/src/models/MentorFromTemplateWithSettingRequest.ts +52 -0
  452. package/src/models/MentorMemorySettingsRequest.ts +11 -0
  453. package/src/models/MentorMemorySettingsResponse.ts +11 -0
  454. package/src/models/MentorMetadata.ts +10 -0
  455. package/src/models/MentorScenario.ts +11 -0
  456. package/src/models/MentorScenarioPrompt.ts +10 -0
  457. package/src/models/MentorSearchResponse.ts +40 -0
  458. package/src/models/MentorSession.ts +9 -0
  459. package/src/models/MentorSettings.ts +63 -0
  460. package/src/models/MentorSettingsPublic.ts +51 -0
  461. package/src/models/MentorSettingsRequest.ts +67 -0
  462. package/src/models/MentorVisibilityEnum.ts +14 -0
  463. package/src/models/MentorWizard.ts +9 -0
  464. package/src/models/MessageStatistics.ts +10 -0
  465. package/src/models/MessageView.ts +15 -0
  466. package/src/models/MessageViewRequest.ts +12 -0
  467. package/src/models/MessageViewUpdatResponse.ts +8 -0
  468. package/src/models/Metadata.ts +10 -0
  469. package/src/models/MetricChange.ts +9 -0
  470. package/src/models/ModelCost.ts +9 -0
  471. package/src/models/ModerationLog.ts +16 -0
  472. package/src/models/NoChatMessagesFound.ts +8 -0
  473. package/src/models/NotificationSource.ts +2 -2
  474. package/src/models/{TypeEnum.ts → NotificationSourceTypeEnum.ts} +1 -1
  475. package/src/models/NullEnum.ts +7 -0
  476. package/src/models/PageContent.ts +11 -0
  477. package/src/models/PaginatedAIGeneratedImageList.ts +12 -0
  478. package/src/models/PaginatedConversationsList.ts +12 -0
  479. package/src/models/PaginatedCourseCreationTaskFileList.ts +12 -0
  480. package/src/models/PaginatedCourseCreationTaskList.ts +12 -0
  481. package/src/models/PaginatedDataSetList.ts +12 -0
  482. package/src/models/PaginatedEdxCourseList.ts +12 -0
  483. package/src/models/PaginatedEmailPromptListList.ts +12 -0
  484. package/src/models/PaginatedHeygenMarketingVideoListList.ts +12 -0
  485. package/src/models/PaginatedHeygenTemplateResponseSingleList.ts +12 -0
  486. package/src/models/PaginatedJobRunList.ts +12 -0
  487. package/src/models/PaginatedMCPServerList.ts +12 -0
  488. package/src/models/PaginatedMentorList.ts +12 -0
  489. package/src/models/PaginatedModerationLogList.ts +12 -0
  490. package/src/models/PaginatedPeriodicAgentList.ts +12 -0
  491. package/src/models/PaginatedPeriodicAgentLogList.ts +12 -0
  492. package/src/models/PaginatedPlayWrightScriptList.ts +12 -0
  493. package/src/models/PaginatedSectionList.ts +12 -0
  494. package/src/models/PaginatedSubSectionList.ts +12 -0
  495. package/src/models/PaginatedTopicStatisticsResponse.ts +12 -0
  496. package/src/models/PaginatedTrainingList.ts +12 -0
  497. package/src/models/PaginatedUnitList.ts +12 -0
  498. package/src/models/PaginatedUserEdxMemoryList.ts +12 -0
  499. package/src/models/PaginatedVoiceList.ts +12 -0
  500. package/src/models/PatchedBotCommand.ts +11 -0
  501. package/src/models/PatchedBotCreate.ts +17 -0
  502. package/src/models/PatchedConversations.ts +33 -0
  503. package/src/models/PatchedCourseCreationTaskFile.ts +12 -0
  504. package/src/models/PatchedCredentialRequest.ts +19 -0
  505. package/src/models/PatchedDataSet.ts +26 -0
  506. package/src/models/PatchedDiscordConfig.ts +12 -0
  507. package/src/models/PatchedDiscordUserConfig.ts +15 -0
  508. package/src/models/PatchedLLMCredentialRequest.ts +19 -0
  509. package/src/models/PatchedMCPServer.ts +26 -0
  510. package/src/models/PatchedMentorCategoryGroupCreate.ts +16 -0
  511. package/src/models/PatchedMentorCreate.ts +89 -0
  512. package/src/models/PatchedPeriodicAgentCreate.ts +46 -0
  513. package/src/models/PatchedPlayWrightScript.ts +17 -0
  514. package/src/models/PatchedPrompt.ts +27 -0
  515. package/src/models/PatchedRbacGroupRole.ts +2 -2
  516. package/src/models/PatchedRbacPolicy.ts +2 -2
  517. package/src/models/PatchedRbacUserRole.ts +2 -2
  518. package/src/models/PatchedSection.ts +14 -0
  519. package/src/models/PatchedSlackConfig.ts +13 -0
  520. package/src/models/PatchedSlackUserConfig.ts +22 -0
  521. package/src/models/PatchedSubSection.ts +14 -0
  522. package/src/models/PatchedTeamsConfig.ts +12 -0
  523. package/src/models/PatchedTrainingCreate.ts +36 -0
  524. package/src/models/PatchedUnit.ts +16 -0
  525. package/src/models/PatchedWebexConfig.ts +15 -0
  526. package/src/models/PatchedWhatsappConfig.ts +16 -0
  527. package/src/models/PatchedWhatsappUserConfig.ts +15 -0
  528. package/src/models/PeriodicAgent.ts +47 -0
  529. package/src/models/PeriodicAgentCreate.ts +46 -0
  530. package/src/models/PeriodicAgentLog.ts +16 -0
  531. package/src/models/PeriodicAgentLogStatusEnum.ts +14 -0
  532. package/src/models/PeriodicTask.ts +26 -0
  533. package/src/models/PieChartData.ts +10 -0
  534. package/src/models/PieChartSegment.ts +9 -0
  535. package/src/models/PinnedMessageCreate.ts +14 -0
  536. package/src/models/PinnedMessageGet.ts +12 -0
  537. package/src/models/PinnedMessageRequest.ts +11 -0
  538. package/src/models/PlayWrightScript.ts +17 -0
  539. package/src/models/PredictiveAnalyticsRequest.ts +9 -0
  540. package/src/models/PredictiveAnalyticsResponse.ts +9 -0
  541. package/src/models/PreviousAgentStatusEnum.ts +16 -0
  542. package/src/models/Prompt.ts +27 -0
  543. package/src/models/PromptCategory.ts +12 -0
  544. package/src/models/PromptFacet.ts +22 -0
  545. package/src/models/PromptSearchResponse.ts +40 -0
  546. package/src/models/PromptVisibilityEnum.ts +14 -0
  547. package/src/models/Provider05cEnum.ts +18 -0
  548. package/src/models/Provider63aEnum.ts +10 -0
  549. package/src/models/QuestionCardTag.ts +13 -0
  550. package/src/models/QuestionRequest.ts +20 -0
  551. package/src/models/QuestionResponse.ts +15 -0
  552. package/src/models/RatingEnum.ts +12 -0
  553. package/src/models/RatingRecord.ts +9 -0
  554. package/src/models/RbacBaseRole.ts +20 -0
  555. package/src/models/RbacGroupRole.ts +2 -2
  556. package/src/models/RbacPolicy.ts +2 -2
  557. package/src/models/RbacUserRole.ts +2 -2
  558. package/src/models/RecentlyAccessedMentor.ts +13 -0
  559. package/src/models/RecommendCourseBlock.ts +8 -0
  560. package/src/models/RecommendCourseResponse.ts +8 -0
  561. package/src/models/RecommendedCoursesResponse.ts +38 -0
  562. package/src/models/RelatedText.ts +8 -0
  563. package/src/models/RequestDataVariable.ts +19 -0
  564. package/src/models/ResourceScrappedData.ts +18 -0
  565. package/src/models/ResourceScrappedDataStatusEnum.ts +16 -0
  566. package/src/models/ResponseDataVariable.ts +19 -0
  567. package/src/models/RetreiverTrainViewRequest.ts +15 -0
  568. package/src/models/RetreiverTrainViewResponse.ts +11 -0
  569. package/src/models/RetrieveTask.ts +8 -0
  570. package/src/models/RetrieverDocumentEmbedding.ts +22 -0
  571. package/src/models/RetrieverDocumentEmbeddingRequest.ts +35 -0
  572. package/src/models/RetrieverRequestSearch.ts +15 -0
  573. package/src/models/RetrieverRequestSearchDocument.ts +15 -0
  574. package/src/models/RetrieverResponseSearch.ts +12 -0
  575. package/src/models/ReuestDataVariableList.ts +9 -0
  576. package/src/models/RunMentorEval.ts +8 -0
  577. package/src/models/ScanWebhookRequest.ts +11 -0
  578. package/src/models/ScanWebhookResponse.ts +8 -0
  579. package/src/models/Section.ts +14 -0
  580. package/src/models/SectionWithChildren.ts +16 -0
  581. package/src/models/SeedMentorsView.ts +8 -0
  582. package/src/models/SentimentSummary.ts +9 -0
  583. package/src/models/SessionBrowserScreenshot.ts +13 -0
  584. package/src/models/SessionDetail.ts +11 -0
  585. package/src/models/SessionMemoryStorage.ts +11 -0
  586. package/src/models/ShellLogs.ts +8 -0
  587. package/src/models/SlackConfig.ts +13 -0
  588. package/src/models/SlackUserConfig.ts +22 -0
  589. package/src/models/SlackWebhook.ts +11 -0
  590. package/src/models/SpacedRepetitionLearningPath.ts +8 -0
  591. package/src/models/SpacedRepetitionQuestionStats.ts +10 -0
  592. package/src/models/StarMentor.ts +12 -0
  593. package/src/models/Status6eeEnum.ts +16 -0
  594. package/src/models/Step.ts +14 -0
  595. package/src/models/StepStatusEnum.ts +14 -0
  596. package/src/models/StudentChatMessage.ts +9 -0
  597. package/src/models/StylesView.ts +9 -0
  598. package/src/models/SubSection.ts +14 -0
  599. package/src/models/SubSectionWithChildren.ts +16 -0
  600. package/src/models/TagsView.ts +10 -0
  601. package/src/models/TargetSystemEnum.ts +12 -0
  602. package/src/models/TaskView.ts +8 -0
  603. package/src/models/TeamsConfig.ts +12 -0
  604. package/src/models/TeamsWebhook.ts +22 -0
  605. package/src/models/TemplateMentor.ts +14 -0
  606. package/src/models/TenantMentorTraces.ts +11 -0
  607. package/src/models/ThemeEnum.ts +12 -0
  608. package/src/models/TonesView.ts +9 -0
  609. package/src/models/ToolResponse.ts +16 -0
  610. package/src/models/TopicModel.ts +8 -0
  611. package/src/models/TopicRecord.ts +9 -0
  612. package/src/models/TopicStatistics.ts +12 -0
  613. package/src/models/TopicStatisticsResponse.ts +11 -0
  614. package/src/models/TopicSummaryView.ts +9 -0
  615. package/src/models/TrainChatSessionDocumentView.ts +11 -0
  616. package/src/models/TrainChatSessionDocumentViewRequest.ts +11 -0
  617. package/src/models/TrainDocumentViewRequest.ts +47 -0
  618. package/src/models/TrainDocumentViewResponse.ts +20 -0
  619. package/src/models/Training.ts +46 -0
  620. package/src/models/TrainingCreate.ts +36 -0
  621. package/src/models/TrainingStatusEnum.ts +16 -0
  622. package/src/models/TransportEnum.ts +12 -0
  623. package/src/models/TrendEntry.ts +9 -0
  624. package/src/models/TriggerRequest.ts +10 -0
  625. package/src/models/TriggerResponse.ts +11 -0
  626. package/src/models/TypeC42Enum.ts +12 -0
  627. package/src/models/Unit.ts +16 -0
  628. package/src/models/UnitWithChildren.ts +18 -0
  629. package/src/models/UseMainCreds.ts +8 -0
  630. package/src/models/UserAllChatMemoryView.ts +12 -0
  631. package/src/models/UserCatalogItemMemoryView.ts +19 -0
  632. package/src/models/UserChatByPeriod.ts +9 -0
  633. package/src/models/UserChatFeedback.ts +19 -0
  634. package/src/models/UserChatFeedbackCount.ts +9 -0
  635. package/src/models/UserChatMemoryStatusRequestView.ts +11 -0
  636. package/src/models/UserChatMemoryStatusView.ts +11 -0
  637. package/src/models/UserChatMemoryUpdateView.ts +15 -0
  638. package/src/models/UserCountRecord.ts +9 -0
  639. package/src/models/UserEdxMemory.ts +20 -0
  640. package/src/models/UserMemoryContextRequest.ts +18 -0
  641. package/src/models/UserMemoryContextResponse.ts +17 -0
  642. package/src/models/UserMetric.ts +9 -0
  643. package/src/models/UserMetricsResponse.ts +12 -0
  644. package/src/models/UserSentimentCountView.ts +9 -0
  645. package/src/models/UserTrendByPeriod.ts +10 -0
  646. package/src/models/VectorResult.ts +13 -0
  647. package/src/models/VideoCaption.ts +8 -0
  648. package/src/models/Voice.ts +14 -0
  649. package/src/models/VoiceProviderEnum.ts +14 -0
  650. package/src/models/WebResource.ts +14 -0
  651. package/src/models/WebResourceCard.ts +12 -0
  652. package/src/models/WebResourcesQuery.ts +8 -0
  653. package/src/models/WebexConfig.ts +15 -0
  654. package/src/models/WebexWebhook.ts +9 -0
  655. package/src/models/WhatAppWebHook.ts +8 -0
  656. package/src/models/WhatsappConfig.ts +16 -0
  657. package/src/models/WhatsappUserConfig.ts +15 -0
  658. package/src/services/AiAccountService.ts +479 -0
  659. package/src/services/AiAnalyticsService.ts +5198 -0
  660. package/src/services/AiBotService.ts +1174 -0
  661. package/src/services/AiFinetuningService.ts +402 -0
  662. package/src/services/AiIndexService.ts +693 -0
  663. package/src/services/AiMarketingService.ts +87 -0
  664. package/src/services/AiMediaService.ts +273 -0
  665. package/src/services/AiMentorService.ts +7977 -0
  666. package/src/services/AiPromptService.ts +1771 -0
  667. package/src/services/CoreService.ts +25 -0
  668. package/src/services/SearchService.ts +981 -261
@@ -0,0 +1,2801 @@
1
+ import type { ActiveUsersList } from '../models/ActiveUsersList';
2
+ import type { ActiveUsersPerCourse } from '../models/ActiveUsersPerCourse';
3
+ import type { ActivityAPI } from '../models/ActivityAPI';
4
+ import type { AnalyticsOverview } from '../models/AnalyticsOverview';
5
+ import type { Average } from '../models/Average';
6
+ import type { AverageOvertime } from '../models/AverageOvertime';
7
+ import type { AvgCourseGradeWithCutoff } from '../models/AvgCourseGradeWithCutoff';
8
+ import type { ChatHistoryFilterData } from '../models/ChatHistoryFilterData';
9
+ import type { ConversationMessage } from '../models/ConversationMessage';
10
+ import type { Conversations } from '../models/Conversations';
11
+ import type { ConversationSummary } from '../models/ConversationSummary';
12
+ import type { ConversationVolume } from '../models/ConversationVolume';
13
+ import type { Cost } from '../models/Cost';
14
+ import type { CostPerTenant } from '../models/CostPerTenant';
15
+ import type { CourseCompletionPerCourse } from '../models/CourseCompletionPerCourse';
16
+ import type { CourseCompletionSummaryOvertime } from '../models/CourseCompletionSummaryOvertime';
17
+ import type { CourseGradeSummary } from '../models/CourseGradeSummary';
18
+ import type { CourseGradingDetail } from '../models/CourseGradingDetail';
19
+ import type { DetailedGradeView } from '../models/DetailedGradeView';
20
+ import type { EngagementPerCourse } from '../models/EngagementPerCourse';
21
+ import type { Enrollments } from '../models/Enrollments';
22
+ import type { EnrollmentsPerUser } from '../models/EnrollmentsPerUser';
23
+ import type { GradingPerUser } from '../models/GradingPerUser';
24
+ import type { GroupList } from '../models/GroupList';
25
+ import type { LearnerInformationAPI } from '../models/LearnerInformationAPI';
26
+ import type { LLMTracesListResponse } from '../models/LLMTracesListResponse';
27
+ import type { MentorDetailAnalytics } from '../models/MentorDetailAnalytics';
28
+ import type { MessageStatistics } from '../models/MessageStatistics';
29
+ import type { ModelCost } from '../models/ModelCost';
30
+ import type { NewPerLearnerList } from '../models/NewPerLearnerList';
31
+ import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
32
+ import type { OverTimeWithTotal } from '../models/OverTimeWithTotal';
33
+ import type { PaginatedConversationsList } from '../models/PaginatedConversationsList';
34
+ import type { PaginatedTopicStatisticsResponse } from '../models/PaginatedTopicStatisticsResponse';
35
+ import type { PatchedConversations } from '../models/PatchedConversations';
36
+ import type { PerformanceGradesPerCourse } from '../models/PerformanceGradesPerCourse';
37
+ import type { PerLearnerCourseVideosWatched } from '../models/PerLearnerCourseVideosWatched';
38
+ import type { PerlearnerEngagementVideosWatchedPerCourse } from '../models/PerlearnerEngagementVideosWatchedPerCourse';
39
+ import type { PerlearnerGradeSummary } from '../models/PerlearnerGradeSummary';
40
+ import type { PerlearnerGradeWithCutOff } from '../models/PerlearnerGradeWithCutOff';
41
+ import type { PerlearnerGradingPerCourseAPI } from '../models/PerlearnerGradingPerCourseAPI';
42
+ import type { PerLearnerLastAccess } from '../models/PerLearnerLastAccess';
43
+ import type { PerLearnerTimeSpentInCourseTree } from '../models/PerLearnerTimeSpentInCourseTree';
44
+ import type { PerlearnerUserList } from '../models/PerlearnerUserList';
45
+ import type { PieChartData } from '../models/PieChartData';
46
+ import type { RatingRecord } from '../models/RatingRecord';
47
+ import type { SentimentSummary } from '../models/SentimentSummary';
48
+ import type { StudentChatMessage } from '../models/StudentChatMessage';
49
+ import type { TenantMentorTraces } from '../models/TenantMentorTraces';
50
+ import type { TimeDetail } from '../models/TimeDetail';
51
+ import type { TimeSpentByUsersInCourse } from '../models/TimeSpentByUsersInCourse';
52
+ import type { TimeSpentPerCourse } from '../models/TimeSpentPerCourse';
53
+ import type { TopicRecord } from '../models/TopicRecord';
54
+ import type { TopicStatisticsResponse } from '../models/TopicStatisticsResponse';
55
+ import type { TopicSummaryView } from '../models/TopicSummaryView';
56
+ import type { TrendEntry } from '../models/TrendEntry';
57
+ import type { UserChatByPeriod } from '../models/UserChatByPeriod';
58
+ import type { UserChatFeedbackCount } from '../models/UserChatFeedbackCount';
59
+ import type { UserCountRecord } from '../models/UserCountRecord';
60
+ import type { UserMetricsResponse } from '../models/UserMetricsResponse';
61
+ import type { UserSentimentCountView } from '../models/UserSentimentCountView';
62
+ import type { UserTrendByPeriod } from '../models/UserTrendByPeriod';
63
+ import type { Value } from '../models/Value';
64
+ import type { VideoEngagementPerCourse } from '../models/VideoEngagementPerCourse';
65
+ import type { VideosInCourseSummary } from '../models/VideosInCourseSummary';
66
+ import type { VideosSpecificCourse } from '../models/VideosSpecificCourse';
67
+ import type { WatchedVideosPerUser } from '../models/WatchedVideosPerUser';
68
+ import type { CancelablePromise } from '../core/CancelablePromise';
69
+ export declare class AiAnalyticsService {
70
+ /**
71
+ * Get active user counts over time.
72
+ *
73
+ * This endpoint provides daily counts of active users (users with known activity)
74
+ * over a specified time period.
75
+ *
76
+ * Query Parameters:
77
+ * start_date (str, optional): Start date for the time range (ISO format)
78
+ * end_date (str, optional): End date for the time range (ISO format)
79
+ *
80
+ * Returns:
81
+ * Daily active user counts over the specified time period, with change metrics
82
+ * compared to previous periods.
83
+ *
84
+ * Default time range is the last 7 days if no dates are specified.
85
+ *
86
+ * An active user is defined as a user with any activity within the past 30 days.
87
+ * @param org
88
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
89
+ * @param endDate end date. ISO 8601
90
+ * @param format Format
91
+ *
92
+ * * `json` - json
93
+ * @param includeMainPlatform Include main platform data
94
+ * @param startDate start date. ISO 8601
95
+ * @returns OvertimeWithChangeInfo
96
+ * @throws ApiError
97
+ */
98
+ static aiAnalyticsAudienceOrgsActiveUsersOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
99
+ /**
100
+ * Get active user counts on a per-course basis.
101
+ *
102
+ * This endpoint provides counts of active users for each course within
103
+ * the specified date range.
104
+ *
105
+ * Query Parameters:
106
+ * start_date (str, optional): Start date for filtering (ISO format)
107
+ * end_date (str, optional): End date for filtering (ISO format)
108
+ *
109
+ * Returns:
110
+ * A list of courses with their active user counts.
111
+ *
112
+ * Default time range is the last 7 days if no dates are specified.
113
+ * @param org
114
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
115
+ * @param endDate end date. ISO 8601
116
+ * @param format Format
117
+ *
118
+ * * `json` - json
119
+ * @param includeMainPlatform Include main platform data
120
+ * @param startDate start date. ISO 8601
121
+ * @returns ActiveUsersPerCourse
122
+ * @throws ApiError
123
+ */
124
+ static aiAnalyticsAudienceOrgsActiveUsersPerCourseRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<ActiveUsersPerCourse>;
125
+ /**
126
+ * Get a list of active users with activity metrics.
127
+ *
128
+ * This endpoint provides a paginated list of users who have had activity
129
+ * within the specified date range.
130
+ *
131
+ * Query Parameters:
132
+ * start_date (str, optional): Start date for filtering (ISO format)
133
+ * end_date (str, optional): End date for filtering (ISO format)
134
+ * course_id (str, optional): Filter by course ID
135
+ * page (int, optional): Page number for pagination
136
+ * length (int, optional): Number of items per page
137
+ *
138
+ * Returns:
139
+ * A paginated list of active users with their activity metrics.
140
+ *
141
+ * Default time range is the last 7 days if no dates are specified.
142
+ * @param org
143
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
144
+ * @param format Format
145
+ *
146
+ * * `json` - json
147
+ * @param includeMainPlatform Include main platform data
148
+ * @param length Size of data to return
149
+ * @param page Page offset
150
+ * @returns ActiveUsersList
151
+ * @throws ApiError
152
+ */
153
+ static aiAnalyticsAudienceOrgsActiveUsersUsersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<ActiveUsersList>;
154
+ /**
155
+ * Get enrollment or unenrollment counts over time.
156
+ *
157
+ * This endpoint provides daily counts of new enrollments or unenrollments
158
+ * over a specified time period.
159
+ *
160
+ * Query Parameters:
161
+ * start_date (str, optional): Start date for the time range (ISO format)
162
+ * end_date (str, optional): End date for the time range (ISO format)
163
+ * course_id (str, optional): Filter by course ID
164
+ * active (bool): Get enrollments when true, unenrollments when false
165
+ *
166
+ * Returns:
167
+ * Daily counts over the specified time period, with change metrics
168
+ * compared to previous periods.
169
+ *
170
+ * Default time range is the last 7 days if no dates are specified.
171
+ * @param courseId
172
+ * @param org
173
+ * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
174
+ *
175
+ * * `y` - y
176
+ * * `yes` - yes
177
+ * * `true` - true
178
+ * * `True` - True
179
+ * * `n` - n
180
+ * * `no` - no
181
+ * * `false` - false
182
+ * * `False` - False
183
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
184
+ * @param endDate end date. ISO 8601
185
+ * @param format Format
186
+ *
187
+ * * `json` - json
188
+ * @param includeMainPlatform Include main platform data
189
+ * @param startDate start date. ISO 8601
190
+ * @returns OvertimeWithChangeInfo
191
+ * @throws ApiError
192
+ */
193
+ static aiAnalyticsAudienceOrgsEnrollmentsCoursesOverTimeRetrieve(courseId: string, org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
194
+ /**
195
+ * List users enrolled in a specific course.
196
+ *
197
+ * This endpoint provides a list of users who are enrolled or unenrolled
198
+ * in a specified course.
199
+ *
200
+ * Query Parameters:
201
+ * course_id (str): The course ID to get enrollments for
202
+ * active (bool): Filter for active enrollments when true, inactive when false
203
+ * page (int, optional): Page number for pagination
204
+ * length (int, optional): Number of items per page
205
+ *
206
+ * Returns:
207
+ * A paginated list of users with:
208
+ * - Username
209
+ * - Full name
210
+ * - Email
211
+ * - Enrollment timestamp
212
+ * @param courseId
213
+ * @param org
214
+ * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
215
+ *
216
+ * * `y` - y
217
+ * * `yes` - yes
218
+ * * `true` - true
219
+ * * `True` - True
220
+ * * `n` - n
221
+ * * `no` - no
222
+ * * `false` - false
223
+ * * `False` - False
224
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
225
+ * @param endDate end date. ISO 8601
226
+ * @param format Format
227
+ *
228
+ * * `json` - json
229
+ * @param includeMainPlatform Include main platform data
230
+ * @param length Size of data to return
231
+ * @param page Page offset
232
+ * @param startDate start date. ISO 8601
233
+ * @returns EnrollmentsPerUser
234
+ * @throws ApiError
235
+ */
236
+ static aiAnalyticsAudienceOrgsEnrollmentsCoursesUsersRetrieve(courseId: string, org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<EnrollmentsPerUser>;
237
+ /**
238
+ * Get enrollment or unenrollment counts over time.
239
+ *
240
+ * This endpoint provides daily counts of new enrollments or unenrollments
241
+ * over a specified time period.
242
+ *
243
+ * Query Parameters:
244
+ * start_date (str, optional): Start date for the time range (ISO format)
245
+ * end_date (str, optional): End date for the time range (ISO format)
246
+ * course_id (str, optional): Filter by course ID
247
+ * active (bool): Get enrollments when true, unenrollments when false
248
+ *
249
+ * Returns:
250
+ * Daily counts over the specified time period, with change metrics
251
+ * compared to previous periods.
252
+ *
253
+ * Default time range is the last 7 days if no dates are specified.
254
+ * @param org
255
+ * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
256
+ *
257
+ * * `y` - y
258
+ * * `yes` - yes
259
+ * * `true` - true
260
+ * * `True` - True
261
+ * * `n` - n
262
+ * * `no` - no
263
+ * * `false` - false
264
+ * * `False` - False
265
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
266
+ * @param endDate end date. ISO 8601
267
+ * @param format Format
268
+ *
269
+ * * `json` - json
270
+ * @param includeMainPlatform Include main platform data
271
+ * @param startDate start date. ISO 8601
272
+ * @returns OvertimeWithChangeInfo
273
+ * @throws ApiError
274
+ */
275
+ static aiAnalyticsAudienceOrgsEnrollmentsOverTimeRetrieve(org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
276
+ /**
277
+ * List enrollment statistics on a per-course basis.
278
+ *
279
+ * This endpoint provides enrollment counts for all courses, with options
280
+ * to filter for active or inactive enrollments and to include time-based data.
281
+ *
282
+ * Query Parameters:
283
+ * active (bool): Filter for active enrollments when true, inactive when false
284
+ * start_date (str, optional): Start date for time-based filtering (ISO format)
285
+ * end_date (str, optional): End date for time-based filtering (ISO format)
286
+ * page (int, optional): Page number for pagination
287
+ * length (int, optional): Number of items per page
288
+ *
289
+ * Returns:
290
+ * A paginated list of courses with their enrollment counts and percentages.
291
+ * @param org
292
+ * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
293
+ *
294
+ * * `y` - y
295
+ * * `yes` - yes
296
+ * * `true` - true
297
+ * * `True` - True
298
+ * * `n` - n
299
+ * * `no` - no
300
+ * * `false` - false
301
+ * * `False` - False
302
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
303
+ * @param endDate end date. ISO 8601
304
+ * @param format Format
305
+ *
306
+ * * `json` - json
307
+ * @param includeMainPlatform Include main platform data
308
+ * @param length Size of data to return
309
+ * @param page Page offset
310
+ * @param startDate start date. ISO 8601
311
+ * @returns Enrollments
312
+ * @throws ApiError
313
+ */
314
+ static aiAnalyticsAudienceOrgsEnrollmentsPerCourseRetrieve(org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<Enrollments>;
315
+ /**
316
+ * List all learners on the platform with aggregated metrics.
317
+ *
318
+ * This endpoint returns a paginated list of all learners with key metrics including:
319
+ * - Enrollment counts
320
+ * - Completion counts
321
+ * - Time spent on platform
322
+ *
323
+ * Query Parameters:
324
+ * page (int): Page number for pagination
325
+ * length (int): Number of items per page
326
+ * search (str): Filter learners by username, email, or name
327
+ *
328
+ * Returns:
329
+ * A paginated list of learners with their associated metrics.
330
+ * @param org
331
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
332
+ * @param format Format
333
+ *
334
+ * * `json` - json
335
+ * @param includeMainPlatform Include main platform data
336
+ * @param length Size of data to return
337
+ * @param page Page offset
338
+ * @param search Search string for learner
339
+ * @returns PerlearnerUserList
340
+ * @throws ApiError
341
+ */
342
+ static aiAnalyticsAudienceOrgsRegisteredUsersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, search?: string): CancelablePromise<PerlearnerUserList>;
343
+ /**
344
+ * Get registered user counts over time.
345
+ *
346
+ * This endpoint provides daily counts of new user registrations over a
347
+ * specified time period.
348
+ *
349
+ * Query Parameters:
350
+ * start_date (str, optional): Start date for the time range (ISO format)
351
+ * end_date (str, optional): End date for the time range (ISO format)
352
+ *
353
+ * Returns:
354
+ * Daily registration counts over the specified time period, with change metrics
355
+ * compared to previous periods.
356
+ *
357
+ * Default time range is the last 7 days if no dates are specified.
358
+ * @param org
359
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
360
+ * @param endDate end date. ISO 8601
361
+ * @param format Format
362
+ *
363
+ * * `json` - json
364
+ * @param includeMainPlatform Include main platform data
365
+ * @param startDate start date. ISO 8601
366
+ * @returns OvertimeWithChangeInfo
367
+ * @throws ApiError
368
+ */
369
+ static aiAnalyticsAudienceOrgsRegisteredUsersOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
370
+ /**
371
+ * List enrollment statistics on a per-course basis.
372
+ *
373
+ * This endpoint provides enrollment counts for all courses, with options
374
+ * to filter for active or inactive enrollments and to include time-based data.
375
+ *
376
+ * Query Parameters:
377
+ * active (bool): Filter for active enrollments when true, inactive when false
378
+ * start_date (str, optional): Start date for time-based filtering (ISO format)
379
+ * end_date (str, optional): End date for time-based filtering (ISO format)
380
+ * page (int, optional): Page number for pagination
381
+ * length (int, optional): Number of items per page
382
+ *
383
+ * Returns:
384
+ * A paginated list of courses with their enrollment counts and percentages.
385
+ * @param org
386
+ * @param active Any of `y`, `yes`, `true`. set to false or no for unenrollments
387
+ *
388
+ * * `y` - y
389
+ * * `yes` - yes
390
+ * * `true` - true
391
+ * * `True` - True
392
+ * * `n` - n
393
+ * * `no` - no
394
+ * * `false` - false
395
+ * * `False` - False
396
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
397
+ * @param endDate end date. ISO 8601
398
+ * @param format Format
399
+ *
400
+ * * `json` - json
401
+ * @param includeMainPlatform Include main platform data
402
+ * @param length Size of data to return
403
+ * @param page Page offset
404
+ * @param startDate start date. ISO 8601
405
+ * @returns Enrollments
406
+ * @throws ApiError
407
+ */
408
+ static aiAnalyticsAudienceOrgsRegisteredUsersPerCourseRetrieve(org: string, active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<Enrollments>;
409
+ /**
410
+ * Retrieve paginated LLM usage costs aggregated by tenant.
411
+ * @param endDate
412
+ * @param startDate
413
+ * @returns CostPerTenant
414
+ * @throws ApiError
415
+ */
416
+ static aiAnalyticsCostsPertenantList(endDate: string, startDate: string): CancelablePromise<Array<CostPerTenant>>;
417
+ /**
418
+ * Get a list of departments with metrics and filtering options.
419
+ *
420
+ * This endpoint provides a paginated list of departments with aggregated metrics
421
+ * about learner performance, course completions, and skill acquisition.
422
+ *
423
+ * Query Parameters:
424
+ * page (int, optional): Page number for pagination
425
+ * length (int, optional): Number of items per page
426
+ * program (str, optional): Filter by program
427
+ * pathway (str, optional): Filter by pathway
428
+ * departments (list, optional): Filter by department ids
429
+ * department_id (str, optional): Filter by department id
430
+ * location (str, optional): Filter by location
431
+ * is_enrolled (bool, optional): Filter for departments with enrolled users
432
+ * start_date (date, optional): Filter by learner join date (start range)
433
+ * end_date (date, optional): Filter by learner join date (end range)
434
+ *
435
+ * Returns:
436
+ * A paginated list of departments with comprehensive metrics.
437
+ * @param org
438
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
439
+ * @param departments Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
440
+ * @param endDate Filter by learners date_joined. Start date. ISO 8601
441
+ * @param format Format
442
+ *
443
+ * * `json` - json
444
+ * @param includeMainPlatform Include main platform data
445
+ * @param isEnrolled Filter for users who have at least an enro;lment
446
+ * @param length Size of data to return
447
+ * @param location Location search string
448
+ * @param page Page offset
449
+ * @param pathway Pathway string
450
+ * @param program Program search string
451
+ * @param startDate Filter by learners date_joined. Start date. ISO 8601
452
+ * @returns GroupList
453
+ * @throws ApiError
454
+ */
455
+ static aiAnalyticsDepartmentsOrgsRetrieve(org: string, departmentId?: number, departments?: Array<string>, endDate?: string, format?: 'json', includeMainPlatform?: boolean, isEnrolled?: boolean | null, length?: number, location?: string, page?: number, pathway?: string, program?: string, startDate?: string): CancelablePromise<GroupList>;
456
+ /**
457
+ * Get engagement metrics on a per-course basis.
458
+ *
459
+ * This endpoint provides a paginated list of courses with engagement metrics
460
+ * including activity counts, time spent, and interaction data.
461
+ *
462
+ * Query Parameters:
463
+ * page (int, optional): Page number for pagination
464
+ * length (int, optional): Number of items per page
465
+ *
466
+ * Returns:
467
+ * A paginated list of courses with their engagement metrics.
468
+ * @param org
469
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
470
+ * @param format Format
471
+ *
472
+ * * `json` - json
473
+ * @param includeMainPlatform Include main platform data
474
+ * @param length Size of data to return
475
+ * @param page Page offset
476
+ * @returns EngagementPerCourse
477
+ * @throws ApiError
478
+ */
479
+ static aiAnalyticsEngagementOrgsActivityRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<EngagementPerCourse>;
480
+ /**
481
+ * Completion count per user per course across the platform
482
+ *
483
+ * Query Params
484
+ * 1. start_date e.g 2020-10-01
485
+ * 2. end_date e.g 2020-10-10
486
+ *
487
+ * Default result when no query param is added is last_7_days (today inclusive)
488
+ * @param org
489
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
490
+ * @param endDate end date. ISO 8601
491
+ * @param format Format
492
+ *
493
+ * * `json` - json
494
+ * @param includeMainPlatform Include main platform data
495
+ * @param startDate start date. ISO 8601
496
+ * @returns OvertimeWithChangeInfo
497
+ * @throws ApiError
498
+ */
499
+ static aiAnalyticsEngagementOrgsCourseCompletionOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
500
+ /**
501
+ * List course completion metrics on a per-course basis.
502
+ *
503
+ * This endpoint provides a paginated table of courses with enrollment and
504
+ * completion statistics for each course.
505
+ *
506
+ * Returns:
507
+ * A paginated list of courses with:
508
+ * - Course identification (ID and name)
509
+ * - Enrollment count
510
+ * - Completion count
511
+ * - Average completion rate
512
+ * @param org
513
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
514
+ * @param format Format
515
+ *
516
+ * * `json` - json
517
+ * @param includeMainPlatform Include main platform data
518
+ * @param length Size of data to return
519
+ * @param page Page offset
520
+ * @returns CourseCompletionPerCourse
521
+ * @throws ApiError
522
+ */
523
+ static aiAnalyticsEngagementOrgsCourseCompletionPerCourseRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<CourseCompletionPerCourse>;
524
+ /**
525
+ * Average time spent in secs on a per-day basis
526
+ *
527
+ * Query Params
528
+ * 1. start_date e.g 2020-10-01
529
+ * 2. end_date e.g 2020-10-10
530
+ * 3. course_id <optional>
531
+ *
532
+ * Default result when no query param is added is last_7_days (today inclusive)
533
+ * @param courseId
534
+ * @param org
535
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
536
+ * @param endDate end date. ISO 8601
537
+ * @param format Format
538
+ *
539
+ * * `json` - json
540
+ * @param includeMainPlatform Include main platform data
541
+ * @param startDate start date. ISO 8601
542
+ * @returns AverageOvertime
543
+ * @throws ApiError
544
+ */
545
+ static aiAnalyticsEngagementOrgsCoursesTimeAverageRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<AverageOvertime>;
546
+ /**
547
+ * Time spent per course in secs in a tree like form
548
+ *
549
+ * Kwargs
550
+ * course_id e.g course-v1:Org+Course4+Run
551
+ *
552
+ * Query Params
553
+ * 1. start_date <optional> e.g 2020-10-01
554
+ * 2. end_date <optional> e.g 2020-10-10
555
+ * @param courseId
556
+ * @param org
557
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
558
+ * @param format Format
559
+ *
560
+ * * `json` - json
561
+ * @param includeMainPlatform Include main platform data
562
+ * @returns TimeDetail
563
+ * @throws ApiError
564
+ */
565
+ static aiAnalyticsEngagementOrgsCoursesTimeDetailRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<TimeDetail>;
566
+ /**
567
+ * Time spent per course in secs on a per-day basis
568
+ *
569
+ * Query Params
570
+ * 1. start_date e.g 2020-10-01
571
+ * 2. end_date e.g 2020-10-10
572
+ * Kwargs
573
+ * 3. course_id
574
+ *
575
+ * Default result when no query param is added is last_7_days (today inclusive)
576
+ * @param courseId
577
+ * @param org
578
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
579
+ * @param endDate end date. ISO 8601
580
+ * @param format Format
581
+ *
582
+ * * `json` - json
583
+ * @param includeMainPlatform Include main platform data
584
+ * @param startDate start date. ISO 8601
585
+ * @returns OverTimeWithTotal
586
+ * @throws ApiError
587
+ */
588
+ static aiAnalyticsEngagementOrgsCoursesTimeOverTimeRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
589
+ /**
590
+ * Time spent by users in a course
591
+ *
592
+ * Query Params
593
+ * course_id e.g course-v1:Org+Course4+Run
594
+ * @param courseId
595
+ * @param org
596
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
597
+ * @param endDate end date. ISO 8601
598
+ * @param format Format
599
+ *
600
+ * * `json` - json
601
+ * @param includeMainPlatform Include main platform data
602
+ * @param length Size of data to return
603
+ * @param page Page offset
604
+ * @param startDate start date. ISO 8601
605
+ * @returns TimeSpentByUsersInCourse
606
+ * @throws ApiError
607
+ */
608
+ static aiAnalyticsEngagementOrgsCoursesTimeUsersRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<TimeSpentByUsersInCourse>;
609
+ /**
610
+ * Time spent within a course in ordered hierarchical format
611
+ *
612
+ * Kwargs
613
+ * 1. course_id e.g course-v1:Org+Course4+Run
614
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
615
+ * Query Params
616
+ * 3. start_date <optional> e.g 2020-10-01
617
+ * 4. end_date <optional> e.g 2020-10-10
618
+ * @param courseId
619
+ * @param org
620
+ * @param userId
621
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
622
+ * @param endDate end date. ISO 8601
623
+ * @param format Format
624
+ *
625
+ * * `json` - json
626
+ * @param includeMainPlatform Include main platform data
627
+ * @param startDate start date. ISO 8601
628
+ * @returns PerLearnerTimeSpentInCourseTree
629
+ * @throws ApiError
630
+ */
631
+ static aiAnalyticsEngagementOrgsCoursesTimeUsersDetailRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerLearnerTimeSpentInCourseTree>;
632
+ /**
633
+ * Time spent in secs on a per-day basis
634
+ *
635
+ * Query Params
636
+ * 1. course_id <optional> e.g course-v1:Org+Course4+Run
637
+ * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
638
+ * 3. start_date e.g 2020-10-01
639
+ * 4. end_date e.g 2020-10-10
640
+ *
641
+ * Default result when no query param is added is last_7_days (today inclusive)
642
+ * @param courseId
643
+ * @param org
644
+ * @param userId
645
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
646
+ * @param endDate end date. ISO 8601
647
+ * @param format Format
648
+ *
649
+ * * `json` - json
650
+ * @param includeMainPlatform Include main platform data
651
+ * @param startDate start date. ISO 8601
652
+ * @returns OverTimeWithTotal
653
+ * @throws ApiError
654
+ */
655
+ static aiAnalyticsEngagementOrgsCoursesTimeUsersOverTimeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
656
+ /**
657
+ * Get video engagement metrics for a specific course.
658
+ *
659
+ * This endpoint provides detailed video engagement statistics for a single course,
660
+ * including view counts, completion rates, and time spent on videos.
661
+ *
662
+ * Query Parameters:
663
+ * course_id (str): The course ID to get video engagement data for
664
+ *
665
+ * Returns:
666
+ * Detailed video engagement metrics for the specified course.
667
+ * @param courseId
668
+ * @param org
669
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
670
+ * @param format Format
671
+ *
672
+ * * `json` - json
673
+ * @param includeMainPlatform Include main platform data
674
+ * @returns VideosSpecificCourse
675
+ * @throws ApiError
676
+ */
677
+ static aiAnalyticsEngagementOrgsCoursesVideosRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<VideosSpecificCourse>;
678
+ /**
679
+ * Get video watch counts over time.
680
+ *
681
+ * This endpoint provides daily counts of videos watched over a specified time period,
682
+ * with options to filter by course or user.
683
+ *
684
+ * Query Parameters:
685
+ * start_date (str, optional): Start date for the time range (ISO format)
686
+ * end_date (str, optional): End date for the time range (ISO format)
687
+ * course_id (str, optional): Filter by course ID
688
+ * user_id (str, optional): Filter by username or email
689
+ *
690
+ * Returns:
691
+ * Daily video watch counts over the specified time period.
692
+ *
693
+ * Default time range is the last 7 days if no dates are specified.
694
+ *
695
+ * Access Control:
696
+ * - Platform admins can access any video watch data
697
+ * - Learners can access their own video watch data
698
+ * @param courseId
699
+ * @param org
700
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
701
+ * @param endDate end date. ISO 8601
702
+ * @param format Format
703
+ *
704
+ * * `json` - json
705
+ * @param includeMainPlatform Include main platform data
706
+ * @param startDate start date. ISO 8601
707
+ * @returns OverTimeWithTotal
708
+ * @throws ApiError
709
+ */
710
+ static aiAnalyticsEngagementOrgsCoursesVideosOverTimeRetrieve(courseId: string, org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
711
+ /**
712
+ * Get a summary of video watch statistics for a specific course.
713
+ *
714
+ * This endpoint provides a structured summary of video watch data for a course,
715
+ * organized in a tree-like format by course sections and subsections.
716
+ *
717
+ * Query Parameters:
718
+ * course_id (str): The course ID to get video summary for
719
+ *
720
+ * Returns:
721
+ * A hierarchical structure of video watch data for the course, including:
722
+ * - Section and subsection organization
723
+ * - Video identification and metadata
724
+ * - Watch counts and completion rates
725
+ * @param courseId
726
+ * @param org
727
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
728
+ * @param format Format
729
+ *
730
+ * * `json` - json
731
+ * @param includeMainPlatform Include main platform data
732
+ * @returns VideosInCourseSummary
733
+ * @throws ApiError
734
+ */
735
+ static aiAnalyticsEngagementOrgsCoursesVideosSummaryRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<VideosInCourseSummary>;
736
+ /**
737
+ * List of users' videos completed records for a specific course
738
+ *
739
+ * Kwargs
740
+ * course_id e.g course-v1:Org+Course4+Run
741
+ * @param courseId
742
+ * @param org
743
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
744
+ * @param format Format
745
+ *
746
+ * * `json` - json
747
+ * @param includeMainPlatform Include main platform data
748
+ * @returns WatchedVideosPerUser
749
+ * @throws ApiError
750
+ */
751
+ static aiAnalyticsEngagementOrgsCoursesVideosUsersRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<WatchedVideosPerUser>;
752
+ /**
753
+ * Average time spent by a learner in enrolled courses. Gives a rough estimate of whats the average time
754
+ * that would be spent by a learner in a course
755
+ *
756
+ * Query Params
757
+ * 1. start_date e.g 2020-10-01
758
+ * 2. end_date e.g 2020-10-10
759
+ * @param org
760
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
761
+ * @param endDate end date. ISO 8601
762
+ * @param format Format
763
+ *
764
+ * * `json` - json
765
+ * @param includeMainPlatform Include main platform data
766
+ * @param startDate start date. ISO 8601
767
+ * @returns AverageOvertime
768
+ * @throws ApiError
769
+ */
770
+ static aiAnalyticsEngagementOrgsTimeAveragePerlearnerPercourseRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<AverageOvertime>;
771
+ /**
772
+ * Average time spent in secs on a per-day basis
773
+ *
774
+ * Query Params
775
+ * 1. start_date e.g 2020-10-01
776
+ * 2. end_date e.g 2020-10-10
777
+ * 3. course_id <optional>
778
+ *
779
+ * Default result when no query param is added is last_7_days (today inclusive)
780
+ * @param org
781
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
782
+ * @param endDate end date. ISO 8601
783
+ * @param format Format
784
+ *
785
+ * * `json` - json
786
+ * @param includeMainPlatform Include main platform data
787
+ * @param startDate start date. ISO 8601
788
+ * @returns AverageOvertime
789
+ * @throws ApiError
790
+ */
791
+ static aiAnalyticsEngagementOrgsTimeAverageWithOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<AverageOvertime>;
792
+ /**
793
+ * Get time spent on the platform over time.
794
+ *
795
+ * This endpoint provides daily time spent values (in seconds) across the
796
+ * platform over a specified time period.
797
+ *
798
+ * Query Parameters:
799
+ * start_date (str, optional): Start date for the time range (ISO format)
800
+ * end_date (str, optional): End date for the time range (ISO format)
801
+ *
802
+ * Returns:
803
+ * Daily time spent values over the specified time period, with change metrics
804
+ * compared to previous periods.
805
+ *
806
+ * Default time range is the last 7 days if no dates are specified.
807
+ * @param org
808
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
809
+ * @param endDate end date. ISO 8601
810
+ * @param format Format
811
+ *
812
+ * * `json` - json
813
+ * @param includeMainPlatform Include main platform data
814
+ * @param startDate start date. ISO 8601
815
+ * @returns OvertimeWithChangeInfo
816
+ * @throws ApiError
817
+ */
818
+ static aiAnalyticsEngagementOrgsTimeOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
819
+ /**
820
+ * Get time spent statistics on a per-course basis.
821
+ *
822
+ * This endpoint provides a paginated list of courses with the total time
823
+ * spent by users in each course.
824
+ *
825
+ * Query Parameters:
826
+ * start_date (str, optional): Start date for filtering (ISO format)
827
+ * end_date (str, optional): End date for filtering (ISO format)
828
+ * page (int, optional): Page number for pagination
829
+ * length (int, optional): Number of items per page
830
+ *
831
+ * Returns:
832
+ * A paginated list of courses with:
833
+ * - Course identification (ID and name)
834
+ * - Total time spent (in seconds)
835
+ * - Formatted time spent (human-readable)
836
+ * - Percentage of total platform time
837
+ * @param org
838
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
839
+ * @param endDate end date. ISO 8601
840
+ * @param format Format
841
+ *
842
+ * * `json` - json
843
+ * @param includeMainPlatform Include main platform data
844
+ * @param length Size of data to return
845
+ * @param page Page offset
846
+ * @param startDate start date. ISO 8601
847
+ * @returns TimeSpentPerCourse
848
+ * @throws ApiError
849
+ */
850
+ static aiAnalyticsEngagementOrgsTimePerCourseRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<TimeSpentPerCourse>;
851
+ /**
852
+ * Get video engagement metrics on a per-course basis.
853
+ *
854
+ * This endpoint provides a paginated list of courses with video engagement metrics
855
+ * including view counts, completion rates, and time spent on videos.
856
+ *
857
+ * Query Parameters:
858
+ * page (int, optional): Page number for pagination
859
+ * length (int, optional): Number of items per page
860
+ *
861
+ * Returns:
862
+ * A paginated list of courses with their video engagement metrics.
863
+ * @param org
864
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
865
+ * @param format Format
866
+ *
867
+ * * `json` - json
868
+ * @param includeMainPlatform Include main platform data
869
+ * @param length Size of data to return
870
+ * @param page Page offset
871
+ * @returns VideoEngagementPerCourse
872
+ * @throws ApiError
873
+ */
874
+ static aiAnalyticsEngagementOrgsVideosRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<VideoEngagementPerCourse>;
875
+ /**
876
+ * Get video watch counts over time.
877
+ *
878
+ * This endpoint provides daily counts of videos watched over a specified time period,
879
+ * with options to filter by course or user.
880
+ *
881
+ * Query Parameters:
882
+ * start_date (str, optional): Start date for the time range (ISO format)
883
+ * end_date (str, optional): End date for the time range (ISO format)
884
+ * course_id (str, optional): Filter by course ID
885
+ * user_id (str, optional): Filter by username or email
886
+ *
887
+ * Returns:
888
+ * Daily video watch counts over the specified time period.
889
+ *
890
+ * Default time range is the last 7 days if no dates are specified.
891
+ *
892
+ * Access Control:
893
+ * - Platform admins can access any video watch data
894
+ * - Learners can access their own video watch data
895
+ * @param org
896
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
897
+ * @param endDate end date. ISO 8601
898
+ * @param format Format
899
+ *
900
+ * * `json` - json
901
+ * @param includeMainPlatform Include main platform data
902
+ * @param startDate start date. ISO 8601
903
+ * @returns OverTimeWithTotal
904
+ * @throws ApiError
905
+ */
906
+ static aiAnalyticsEngagementOrgsVideosOverTimeRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
907
+ /**
908
+ * Retrieve average message counts per session over time.
909
+ *
910
+ * This endpoint returns data on the average number of messages exchanged in each
911
+ * conversation session within a specified date range, with options for filtering
912
+ * by mentor and aggregating by different time periods (hourly, daily, weekly).
913
+ *
914
+ * Args:
915
+ * request: The HTTP request containing filter query parameters.
916
+ * org: Organization key identifier.
917
+ *
918
+ * Returns:
919
+ * Response: Time series of average message counts and session totals.
920
+ *
921
+ * Raises:
922
+ * NotFound: If the specified organization does not exist.
923
+ * BadRequest: If the provided parameters are invalid.
924
+ *
925
+ * Query Parameters:
926
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
927
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
928
+ * mentor_id (str): Filter by mentor unique ID.
929
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
930
+ * @param endDate End date for filtering (YYYY-MM-DD)
931
+ * @param org
932
+ * @param startDate Start date for filtering (YYYY-MM-DD)
933
+ * @param userId
934
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
935
+ * @param groupBy
936
+ * @param mentorId Filter by mentor unique ID
937
+ * @returns MessageStatistics
938
+ * @throws ApiError
939
+ */
940
+ static aiAnalyticsOrgsUsersAverageMessagesPerSessionList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', groupBy?: string, mentorId?: string): CancelablePromise<Array<MessageStatistics>>;
941
+ /**
942
+ * API viewset for retrieving and filtering chat message history.
943
+ *
944
+ * This viewset provides endpoints for retrieving chat message history
945
+ * within an organization, with extensive filtering options by date range,
946
+ * user, topic, mentor, and sentiment.
947
+ *
948
+ * Permissions:
949
+ * - Restricted to platform administrators only
950
+ * @param org
951
+ * @param userId
952
+ * @param endDate
953
+ * @param filterUserId
954
+ * @param mentor
955
+ * @param page A page number within the paginated result set.
956
+ * @param pageSize Number of results to return per page.
957
+ * @param sentiment
958
+ * @param startDate
959
+ * @param topics
960
+ * @returns PaginatedConversationsList
961
+ * @throws ApiError
962
+ */
963
+ static aiAnalyticsOrgsUsersChatHistoryList(org: string, userId: string, endDate?: string, filterUserId?: string, mentor?: string, page?: number, pageSize?: number, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<PaginatedConversationsList>;
964
+ /**
965
+ * API viewset for retrieving and filtering chat message history.
966
+ *
967
+ * This viewset provides endpoints for retrieving chat message history
968
+ * within an organization, with extensive filtering options by date range,
969
+ * user, topic, mentor, and sentiment.
970
+ *
971
+ * Permissions:
972
+ * - Restricted to platform administrators only
973
+ * @param org
974
+ * @param userId
975
+ * @param requestBody
976
+ * @param endDate
977
+ * @param filterUserId
978
+ * @param mentor
979
+ * @param sentiment
980
+ * @param startDate
981
+ * @param topics
982
+ * @returns Conversations
983
+ * @throws ApiError
984
+ */
985
+ static aiAnalyticsOrgsUsersChatHistoryCreate(org: string, userId: string, requestBody: Conversations, endDate?: string, filterUserId?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<Conversations>;
986
+ /**
987
+ * Retrieve filter options for chat message history.
988
+ *
989
+ * This endpoint returns data on available filter options for the chat message
990
+ * history endpoint, including topics, date ranges (weekly or monthly),
991
+ * sentiments, and users who have chat history.
992
+ *
993
+ * Args:
994
+ * request: The HTTP request containing query parameters.
995
+ * org: Organization key identifier.
996
+ *
997
+ * Returns:
998
+ * Response: Available filter options for chat message history.
999
+ *
1000
+ * Raises:
1001
+ * NotFound: If the specified organization does not exist.
1002
+ *
1003
+ * Query Parameters:
1004
+ * monthly_range (bool): Whether to return monthly or weekly date ranges.
1005
+ * mentor_id (str): Filter users by those who have chatted with a specific mentor.
1006
+ * @param org
1007
+ * @param userId
1008
+ * @param endDate
1009
+ * @param mentorId
1010
+ * @param monthlyRange
1011
+ * @param startDate
1012
+ * @returns ChatHistoryFilterData
1013
+ * @throws ApiError
1014
+ */
1015
+ static aiAnalyticsOrgsUsersChatHistoryFilterRetrieve(org: string, userId: string, endDate?: string, mentorId?: string, monthlyRange?: boolean, startDate?: string): CancelablePromise<ChatHistoryFilterData>;
1016
+ /**
1017
+ * API viewset for retrieving and filtering chat message history.
1018
+ *
1019
+ * This viewset provides endpoints for retrieving chat message history
1020
+ * within an organization, with extensive filtering options by date range,
1021
+ * user, topic, mentor, and sentiment.
1022
+ *
1023
+ * Permissions:
1024
+ * - Restricted to platform administrators only
1025
+ * @param id A UUID string identifying this session.
1026
+ * @param org
1027
+ * @param userId
1028
+ * @param endDate
1029
+ * @param filterUserId
1030
+ * @param mentor
1031
+ * @param sentiment
1032
+ * @param startDate
1033
+ * @param topics
1034
+ * @returns Conversations
1035
+ * @throws ApiError
1036
+ */
1037
+ static aiAnalyticsOrgsUsersChatHistoryRetrieve(id: string, org: string, userId: string, endDate?: string, filterUserId?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<Conversations>;
1038
+ /**
1039
+ * API viewset for retrieving and filtering chat message history.
1040
+ *
1041
+ * This viewset provides endpoints for retrieving chat message history
1042
+ * within an organization, with extensive filtering options by date range,
1043
+ * user, topic, mentor, and sentiment.
1044
+ *
1045
+ * Permissions:
1046
+ * - Restricted to platform administrators only
1047
+ * @param id A UUID string identifying this session.
1048
+ * @param org
1049
+ * @param userId
1050
+ * @param requestBody
1051
+ * @param endDate
1052
+ * @param filterUserId
1053
+ * @param mentor
1054
+ * @param sentiment
1055
+ * @param startDate
1056
+ * @param topics
1057
+ * @returns Conversations
1058
+ * @throws ApiError
1059
+ */
1060
+ static aiAnalyticsOrgsUsersChatHistoryUpdate(id: string, org: string, userId: string, requestBody: Conversations, endDate?: string, filterUserId?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<Conversations>;
1061
+ /**
1062
+ * API viewset for retrieving and filtering chat message history.
1063
+ *
1064
+ * This viewset provides endpoints for retrieving chat message history
1065
+ * within an organization, with extensive filtering options by date range,
1066
+ * user, topic, mentor, and sentiment.
1067
+ *
1068
+ * Permissions:
1069
+ * - Restricted to platform administrators only
1070
+ * @param id A UUID string identifying this session.
1071
+ * @param org
1072
+ * @param userId
1073
+ * @param endDate
1074
+ * @param filterUserId
1075
+ * @param mentor
1076
+ * @param sentiment
1077
+ * @param startDate
1078
+ * @param topics
1079
+ * @param requestBody
1080
+ * @returns Conversations
1081
+ * @throws ApiError
1082
+ */
1083
+ static aiAnalyticsOrgsUsersChatHistoryPartialUpdate(id: string, org: string, userId: string, endDate?: string, filterUserId?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string, requestBody?: PatchedConversations): CancelablePromise<Conversations>;
1084
+ /**
1085
+ * API viewset for retrieving and filtering chat message history.
1086
+ *
1087
+ * This viewset provides endpoints for retrieving chat message history
1088
+ * within an organization, with extensive filtering options by date range,
1089
+ * user, topic, mentor, and sentiment.
1090
+ *
1091
+ * Permissions:
1092
+ * - Restricted to platform administrators only
1093
+ * @param id A UUID string identifying this session.
1094
+ * @param org
1095
+ * @param userId
1096
+ * @param endDate
1097
+ * @param filterUserId
1098
+ * @param mentor
1099
+ * @param sentiment
1100
+ * @param startDate
1101
+ * @param topics
1102
+ * @returns void
1103
+ * @throws ApiError
1104
+ */
1105
+ static aiAnalyticsOrgsUsersChatHistoryDestroy(id: string, org: string, userId: string, endDate?: string, filterUserId?: string, mentor?: string, sentiment?: string, startDate?: string, topics?: string): CancelablePromise<void>;
1106
+ /**
1107
+ * Retrieve conversation volume data over time.
1108
+ *
1109
+ * This endpoint returns data on the number of conversations that occurred
1110
+ * within a specified date range, with options for different time aggregations
1111
+ * (hourly, daily, weekly). Results can be filtered by mentor.
1112
+ *
1113
+ * Args:
1114
+ * request: The HTTP request containing filter query parameters.
1115
+ * org: Organization key identifier.
1116
+ * user_id: User identifier (not used in the implementation).
1117
+ *
1118
+ * Returns:
1119
+ * Response: Time series data of conversation counts.
1120
+ *
1121
+ * Raises:
1122
+ * NotFound: If the specified organization does not exist.
1123
+ * BadRequest: If the provided parameters are invalid.
1124
+ *
1125
+ * Query Parameters:
1126
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1127
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1128
+ * mentor_id (str): Filter by mentor unique ID.
1129
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1130
+ * @param endDate End date for filtering (YYYY-MM-DD)
1131
+ * @param org
1132
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1133
+ * @param userId
1134
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
1135
+ * @param mentorId Filter by mentor unique ID
1136
+ * @returns ConversationVolume
1137
+ * @throws ApiError
1138
+ */
1139
+ static aiAnalyticsOrgsUsersConversationList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', mentorId?: string): CancelablePromise<Array<ConversationVolume>>;
1140
+ /**
1141
+ * Retrieve a summary of conversation metrics.
1142
+ *
1143
+ * This endpoint returns aggregated metrics about conversations within an organization,
1144
+ * including:
1145
+ * - Total number of conversations
1146
+ * - Total number of human messages
1147
+ * - Total number of AI messages
1148
+ *
1149
+ * Results can be filtered by mentor.
1150
+ *
1151
+ * Args:
1152
+ * request: The HTTP request containing filter query parameters.
1153
+ * org: Organization key identifier.
1154
+ *
1155
+ * Returns:
1156
+ * Response: Summary of conversation metrics.
1157
+ *
1158
+ * Raises:
1159
+ * NotFound: If the specified organization does not exist.
1160
+ *
1161
+ * Query Parameters:
1162
+ * mentor_id (str): Filter by mentor unique ID.
1163
+ * @param org
1164
+ * @param userId
1165
+ * @param groupBy
1166
+ * @param mentorId Filter by mentor unique ID
1167
+ * @returns ConversationSummary
1168
+ * @throws ApiError
1169
+ */
1170
+ static aiAnalyticsOrgsUsersConversationSummaryRetrieve(org: string, userId: string, groupBy?: string, mentorId?: string): CancelablePromise<ConversationSummary>;
1171
+ /**
1172
+ * Retrieve the model costs for a tenant
1173
+ *
1174
+ * Filter parameters for period are start_date and enddate
1175
+ *
1176
+ * Accessible to tenant Admins only.
1177
+ * @param endDate
1178
+ * @param org
1179
+ * @param startDate
1180
+ * @param userId
1181
+ * @returns ModelCost
1182
+ * @throws ApiError
1183
+ */
1184
+ static aiAnalyticsOrgsUsersCostsModelRetrieve(endDate: string, org: string, startDate: string, userId: string): CancelablePromise<ModelCost>;
1185
+ /**
1186
+ * Retrieve LLM usage costs aggregated by mentor.
1187
+ *
1188
+ * This endpoint returns data on the total cost of LLM usage for each mentor
1189
+ * within a specified date range, with pagination support. The costs are
1190
+ * calculated by summing the costs of all observations associated with
1191
+ * traces from the mentor's sessions.
1192
+ *
1193
+ * Args:
1194
+ * request: The HTTP request containing filter query parameters.
1195
+ * org: Organization key identifier.
1196
+ *
1197
+ * Returns:
1198
+ * Response: Paginated list of mentors with their total LLM usage costs.
1199
+ *
1200
+ * Raises:
1201
+ * NotFound: If the specified organization does not exist.
1202
+ * BadRequest: If the provided parameters are invalid.
1203
+ *
1204
+ * Query Parameters:
1205
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1206
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1207
+ * limit (int): Number of results per page - default: 5.
1208
+ * offset (int): Offset for pagination - default: 0.
1209
+ * @param endDate
1210
+ * @param org
1211
+ * @param startDate
1212
+ * @param userId
1213
+ * @returns TenantMentorTraces
1214
+ * @throws ApiError
1215
+ */
1216
+ static aiAnalyticsOrgsUsersCostsPermentorRetrieve(endDate: string, org: string, startDate: string, userId: string): CancelablePromise<TenantMentorTraces>;
1217
+ /**
1218
+ * Retrieve LLM usage costs aggregated by user.
1219
+ *
1220
+ * This endpoint returns data on the total cost of LLM usage for each user
1221
+ * within a specified date range, with pagination support. The costs are
1222
+ * calculated by summing the costs of all observations associated with
1223
+ * traces from the user's sessions.
1224
+ *
1225
+ * Args:
1226
+ * request: The HTTP request containing filter query parameters.
1227
+ * org: Organization key identifier.
1228
+ *
1229
+ * Returns:
1230
+ * Response: Paginated list of users with their total LLM usage costs.
1231
+ *
1232
+ * Raises:
1233
+ * NotFound: If the specified organization does not exist.
1234
+ * BadRequest: If the provided parameters are invalid.
1235
+ *
1236
+ * Query Parameters:
1237
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1238
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1239
+ * limit (int): Number of results per page - default: 10.
1240
+ * offset (int): Offset for pagination - default: 0.
1241
+ * @param endDate
1242
+ * @param org
1243
+ * @param startDate
1244
+ * @param userId
1245
+ * @returns LLMTracesListResponse
1246
+ * @throws ApiError
1247
+ */
1248
+ static aiAnalyticsOrgsUsersCostsPeruserRetrieve(endDate: string, org: string, startDate: string, userId: string): CancelablePromise<LLMTracesListResponse>;
1249
+ /**
1250
+ * Retrieve summary statistics about mentors.
1251
+ *
1252
+ * This endpoint returns aggregated statistics about mentors within an organization,
1253
+ * including total mentors, active mentors (mentors with at least one session),
1254
+ * questions answered, and ratings.
1255
+ *
1256
+ * Args:
1257
+ * request: The HTTP request.
1258
+ * org: Organization key identifier.
1259
+ *
1260
+ * Returns:
1261
+ * Response: Summary statistics about mentors.
1262
+ *
1263
+ * Raises:
1264
+ * NotFound: If the specified organization does not exist.
1265
+ * @param org
1266
+ * @param userId
1267
+ * @returns MentorDetailAnalytics
1268
+ * @throws ApiError
1269
+ */
1270
+ static aiAnalyticsOrgsUsersMentorDetailRetrieve(org: string, userId: string): CancelablePromise<MentorDetailAnalytics>;
1271
+ /**
1272
+ * Retrieve summary statistics about mentors.
1273
+ *
1274
+ * This endpoint returns aggregated statistics about mentors within an organization,
1275
+ * including total mentors, active mentors (mentors with at least one session),
1276
+ * questions answered, and ratings.
1277
+ *
1278
+ * Args:
1279
+ * request: The HTTP request.
1280
+ * org: Organization key identifier.
1281
+ *
1282
+ * Returns:
1283
+ * Response: Summary statistics about mentors.
1284
+ *
1285
+ * Raises:
1286
+ * NotFound: If the specified organization does not exist.
1287
+ * @param org
1288
+ * @param userId
1289
+ * @returns MentorDetailAnalytics
1290
+ * @throws ApiError
1291
+ */
1292
+ static aiAnalyticsOrgsUsersMentorSummaryRetrieve(org: string, userId: string): CancelablePromise<MentorDetailAnalytics>;
1293
+ /**
1294
+ * Retrieve LLM usage costs for a specific mentor.
1295
+ *
1296
+ * This endpoint returns data on the total cost of LLM usage for a specific mentor
1297
+ * within a specified date range. The cost is calculated by summing the costs
1298
+ * of all observations associated with traces from the tenant's sessions.
1299
+ *
1300
+ * Args:
1301
+ * request: The HTTP request containing filter query parameters.
1302
+ * org: Organization key identifier.
1303
+ * mentor_unique_id: User key identifier.
1304
+ *
1305
+ * Returns:
1306
+ * Response: Total LLM usage cost for the specified tenant.
1307
+ *
1308
+ * Raises:
1309
+ * NotFound: If the specified organization does not exist.
1310
+ * BadRequest: If the provided parameters are invalid.
1311
+ *
1312
+ * Query Parameters:
1313
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1314
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1315
+ * @param endDate
1316
+ * @param mentorUniqueId
1317
+ * @param org
1318
+ * @param startDate
1319
+ * @param userId
1320
+ * @returns Cost
1321
+ * @throws ApiError
1322
+ */
1323
+ static aiAnalyticsOrgsUsersMentorsCostRetrieve(endDate: string, mentorUniqueId: string, org: string, startDate: string, userId: string): CancelablePromise<Cost>;
1324
+ /**
1325
+ * Retrieve the most discussed topics over time.
1326
+ *
1327
+ * This endpoint returns data on the frequency of topics discussed in conversations
1328
+ * within a specified date range, with options for filtering by mentor and
1329
+ * aggregating by different time periods (hourly, daily, weekly).
1330
+ *
1331
+ * Args:
1332
+ * request: The HTTP request containing filter query parameters.
1333
+ * org: Organization key identifier.
1334
+ *
1335
+ * Returns:
1336
+ * Response: List of topics with their conversation counts, ordered by frequency.
1337
+ *
1338
+ * Raises:
1339
+ * NotFound: If the specified organization does not exist.
1340
+ * BadRequest: If the provided parameters are invalid.
1341
+ *
1342
+ * Query Parameters:
1343
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1344
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1345
+ * mentor_id (str): Filter by mentor unique ID.
1346
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1347
+ * @param endDate End date for filtering (YYYY-MM-DD)
1348
+ * @param org
1349
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1350
+ * @param userId
1351
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
1352
+ * @param groupBy
1353
+ * @param mentorId Filter by mentor unique ID
1354
+ * @returns TopicRecord
1355
+ * @throws ApiError
1356
+ */
1357
+ static aiAnalyticsOrgsUsersMostDiscussedTopicsList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', groupBy?: string, mentorId?: string): CancelablePromise<Array<TopicRecord>>;
1358
+ /**
1359
+ * Retrieve an overview of key analytics metrics.
1360
+ *
1361
+ * This endpoint returns a comprehensive overview of key analytics metrics
1362
+ * for an organization, including:
1363
+ * - Conversation volume: Total sessions and month-over-month change
1364
+ * - Users: Total unique users and month-over-month change
1365
+ * - Topics: Total unique topics and month-over-month change
1366
+ * - User ratings: Total ratings and month-over-month change
1367
+ *
1368
+ * Results can be filtered by mentor.
1369
+ *
1370
+ * Args:
1371
+ * request: The HTTP request containing filter query parameters.
1372
+ * org: Organization key identifier.
1373
+ * user_id: User identifier (not used in the implementation).
1374
+ *
1375
+ * Returns:
1376
+ * Response: Overview of key analytics metrics with month-over-month changes.
1377
+ *
1378
+ * Raises:
1379
+ * NotFound: If the specified organization does not exist.
1380
+ *
1381
+ * Query Parameters:
1382
+ * mentor_id (str): Filter analytics by mentor unique ID.
1383
+ * @param org
1384
+ * @param userId
1385
+ * @param groupBy
1386
+ * @param mentorId Filter analytics by mentor unique ID
1387
+ * @returns AnalyticsOverview
1388
+ * @throws ApiError
1389
+ */
1390
+ static aiAnalyticsOrgsUsersOverviewSummaryRetrieve(org: string, userId: string, groupBy?: string, mentorId?: string): CancelablePromise<AnalyticsOverview>;
1391
+ /**
1392
+ * Retrieve user rating metrics over time.
1393
+ *
1394
+ * This endpoint returns data on the number of user ratings submitted
1395
+ * within a specified date range, aggregated by day or hour.
1396
+ *
1397
+ * Args:
1398
+ * request: The HTTP request containing filter query parameters.
1399
+ * org: Organization key identifier.
1400
+ *
1401
+ * Returns:
1402
+ * Response: Time series of rating counts aggregated by day or hour.
1403
+ *
1404
+ * Raises:
1405
+ * NotFound: If the specified organization does not exist.
1406
+ * BadRequest: If the provided parameters are invalid.
1407
+ *
1408
+ * Query Parameters:
1409
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1410
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1411
+ * group_by (str): Aggregation level (day or hour) - default: day.
1412
+ * @param endDate End date for filtering (YYYY-MM-DD)
1413
+ * @param org
1414
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1415
+ * @param userId
1416
+ * @param groupBy Aggregation level (day or hour)
1417
+ * @returns RatingRecord
1418
+ * @throws ApiError
1419
+ */
1420
+ static aiAnalyticsOrgsUsersRatingSummaryList(endDate: string, org: string, startDate: string, userId: string, groupBy?: 'day' | 'hour'): CancelablePromise<Array<RatingRecord>>;
1421
+ /**
1422
+ * Retrieve trends of registered users over time.
1423
+ *
1424
+ * This endpoint returns data on the number of new user registrations
1425
+ * within a specified date range, with options for different time aggregations
1426
+ * (hourly, daily, weekly, monthly). The data is backfilled to ensure
1427
+ * continuous time series even for periods with zero registrations.
1428
+ *
1429
+ * Args:
1430
+ * request: The HTTP request containing filter query parameters.
1431
+ * org: Organization key identifier.
1432
+ *
1433
+ * Returns:
1434
+ * Response: Time series of user registration counts.
1435
+ *
1436
+ * Raises:
1437
+ * NotFound: If the specified organization does not exist.
1438
+ * BadRequest: If the provided parameters are invalid.
1439
+ *
1440
+ * Query Parameters:
1441
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1442
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1443
+ * aggregation (str): Time aggregation level (hourly, daily, weekly, monthly) - default: daily.
1444
+ * @param endDate End date for filtering (YYYY-MM-DD)
1445
+ * @param org
1446
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1447
+ * @param userId
1448
+ * @param aggregation Time aggregation level (hourly, daily, weekly, monthly)
1449
+ * @param groupBy
1450
+ * @returns TrendEntry
1451
+ * @throws ApiError
1452
+ */
1453
+ static aiAnalyticsOrgsUsersRegisteredUsersTrendList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'monthly' | 'weekly', groupBy?: string): CancelablePromise<Array<TrendEntry>>;
1454
+ /**
1455
+ * Retrieve user sentiment counts over time.
1456
+ *
1457
+ * This endpoint returns data on the number of user sentiment entries
1458
+ * within a specified time period, aggregated by date.
1459
+ *
1460
+ * Args:
1461
+ * request: The HTTP request containing filter query parameters.
1462
+ * org: Organization key identifier.
1463
+ * user_id: User identifier.
1464
+ *
1465
+ * Returns:
1466
+ * Response: Time series data of sentiment counts.
1467
+ *
1468
+ * Raises:
1469
+ * NotFound: If the specified organization does not exist.
1470
+ * ValidationError: If the provided query parameters are invalid.
1471
+ *
1472
+ * Query Parameters:
1473
+ * period (str): Time period filter (today, yesterday, 7d, 30d, 90d) - default: 7d.
1474
+ * @param org
1475
+ * @param userId
1476
+ * @param period
1477
+ * @returns UserSentimentCountView
1478
+ * @throws ApiError
1479
+ */
1480
+ static aiAnalyticsOrgsUsersSentimentCountList(org: string, userId: string, period?: string): CancelablePromise<Array<UserSentimentCountView>>;
1481
+ /**
1482
+ * Retrieve LLM usage costs for a specific tenant.
1483
+ *
1484
+ * This endpoint returns data on the total cost of LLM usage for a specific tenant
1485
+ * within a specified date range. The cost is calculated by summing the costs
1486
+ * of all observations associated with traces from the tenant's sessions.
1487
+ *
1488
+ * Args:
1489
+ * request: The HTTP request containing filter query parameters.
1490
+ * org: Organization key identifier.
1491
+ *
1492
+ * Returns:
1493
+ * Response: Total LLM usage cost for the specified tenant.
1494
+ *
1495
+ * Raises:
1496
+ * NotFound: If the specified organization does not exist.
1497
+ * BadRequest: If the provided parameters are invalid.
1498
+ *
1499
+ * Query Parameters:
1500
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1501
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1502
+ * @param endDate
1503
+ * @param org
1504
+ * @param startDate
1505
+ * @param userId
1506
+ * @returns Cost
1507
+ * @throws ApiError
1508
+ */
1509
+ static aiAnalyticsOrgsUsersTenantCostRetrieve(endDate: string, org: string, startDate: string, userId: string): CancelablePromise<Cost>;
1510
+ /**
1511
+ * Retrieve the most engaged students based on chat message count.
1512
+ *
1513
+ * This endpoint returns data on the top 20 students with the highest number of
1514
+ * chat messages, with optional filtering by mentor and date range.
1515
+ *
1516
+ * Args:
1517
+ * request: The HTTP request containing filter query parameters.
1518
+ * org: Organization key identifier.
1519
+ * user_id: User identifier (not used in the implementation).
1520
+ *
1521
+ * Returns:
1522
+ * Response: List of top students with their chat message counts.
1523
+ *
1524
+ * Raises:
1525
+ * NotFound: If the specified organization does not exist.
1526
+ * BadRequest: If the provided parameters are invalid.
1527
+ *
1528
+ * Query Parameters:
1529
+ * mentor_id (str): Filter by mentor unique ID.
1530
+ * start_date (str): Start date for filtering (YYYY-MM-DD).
1531
+ * end_date (str): End date for filtering (YYYY-MM-DD).
1532
+ * @param org
1533
+ * @param userId
1534
+ * @param groupBy
1535
+ * @returns StudentChatMessage
1536
+ * @throws ApiError
1537
+ */
1538
+ static aiAnalyticsOrgsUsersTopStudentsByChatMessagesList(org: string, userId: string, groupBy?: string): CancelablePromise<Array<StudentChatMessage>>;
1539
+ /**
1540
+ * Retrieve aggregated topic statistics.
1541
+ *
1542
+ * This endpoint returns statistical information about topics within an organization,
1543
+ * including total topics, new topics, and percentage changes compared to the
1544
+ * previous month. Results can be filtered by mentor.
1545
+ *
1546
+ * Args:
1547
+ * request: The HTTP request containing filter query parameters.
1548
+ * org: Organization key identifier.
1549
+ *
1550
+ * Returns:
1551
+ * Response: Statistical information about topics.
1552
+ *
1553
+ * Raises:
1554
+ * NotFound: If the specified organization or mentor does not exist.
1555
+ *
1556
+ * Query Parameters:
1557
+ * mentor_id (str): Filter statistics by mentor unique ID.
1558
+ * @param org
1559
+ * @param userId
1560
+ * @param mentorId Filter statistics by mentor unique ID
1561
+ * @returns TopicStatisticsResponse
1562
+ * @throws ApiError
1563
+ */
1564
+ static aiAnalyticsOrgsUsersTopicOverviewRetrieve(org: string, userId: string, mentorId?: string): CancelablePromise<TopicStatisticsResponse>;
1565
+ /**
1566
+ * Retrieve paginated statistics about topics.
1567
+ *
1568
+ * This endpoint returns detailed statistics about topics, including:
1569
+ * - Number of conversations related to each topic
1570
+ * - Total message count for each topic
1571
+ * - Average sentiment of conversations about each topic
1572
+ * - Average user rating for conversations about each topic
1573
+ *
1574
+ * Results can be filtered by mentor and date range, and are paginated.
1575
+ *
1576
+ * Args:
1577
+ * request: The HTTP request containing filter query parameters.
1578
+ * org: Organization key identifier.
1579
+ *
1580
+ * Returns:
1581
+ * Response: Paginated list of topic statistics.
1582
+ *
1583
+ * Raises:
1584
+ * NotFound: If the specified organization or mentor does not exist.
1585
+ * BadRequest: If the provided parameters are invalid.
1586
+ *
1587
+ * Query Parameters:
1588
+ * start_date (str): Start date for filtering (YYYY-MM-DD).
1589
+ * end_date (str): End date for filtering (YYYY-MM-DD).
1590
+ * mentor_id (str): Filter by mentor unique ID.
1591
+ * page (int): Page number for pagination - default: 1.
1592
+ * page_size (int): Number of results per page - default: 20.
1593
+ * @param org
1594
+ * @param userId
1595
+ * @param endDate End date for filtering (YYYY-MM-DD)
1596
+ * @param groupBy
1597
+ * @param mentorId Filter by mentor unique ID
1598
+ * @param page Page number for pagination
1599
+ * @param pageSize Number of results per page
1600
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1601
+ * @returns PaginatedTopicStatisticsResponse
1602
+ * @throws ApiError
1603
+ */
1604
+ static aiAnalyticsOrgsUsersTopicStatisticsRetrieve(org: string, userId: string, endDate?: string, groupBy?: string, mentorId?: string, page?: number, pageSize?: number, startDate?: string): CancelablePromise<PaginatedTopicStatisticsResponse>;
1605
+ /**
1606
+ * Retrieve a summary of the most frequent topics.
1607
+ *
1608
+ * This endpoint returns a summary of the top 10 topics discussed in chat sessions,
1609
+ * ordered by conversation count. Results can be filtered by mentor and date range.
1610
+ *
1611
+ * Args:
1612
+ * request: The HTTP request containing filter query parameters.
1613
+ * org: Organization key identifier.
1614
+ *
1615
+ * Returns:
1616
+ * Response: A list of the top 10 topics with their conversation counts.
1617
+ *
1618
+ * Raises:
1619
+ * NotFound: If the specified organization does not exist.
1620
+ * BadRequest: If the provided date format is invalid.
1621
+ *
1622
+ * Query Parameters:
1623
+ * mentor_id (str): Filter by mentor unique ID.
1624
+ * start_date (str): Start date for filtering (YYYY-MM-DD).
1625
+ * end_date (str): End date for filtering (YYYY-MM-DD).
1626
+ * @param org
1627
+ * @param userId
1628
+ * @param endDate
1629
+ * @param startDate
1630
+ * @returns TopicSummaryView
1631
+ * @throws ApiError
1632
+ */
1633
+ static aiAnalyticsOrgsUsersTopicsSummaryList(org: string, userId: string, endDate?: string, startDate?: string): CancelablePromise<Array<TopicSummaryView>>;
1634
+ /**
1635
+ * Retrieve the total number of users interacting with mentors over time.
1636
+ *
1637
+ * This endpoint returns data on the number of unique users who interacted with
1638
+ * mentors each day or hour within a specified date range, with optional
1639
+ * filtering by specific mentor. If no date range is provided, the last 30 days
1640
+ * are used by default.
1641
+ *
1642
+ * Args:
1643
+ * request: The HTTP request containing filter query parameters.
1644
+ * org: Organization key identifier.
1645
+ *
1646
+ * Returns:
1647
+ * Response: Time series of unique user counts.
1648
+ *
1649
+ * Raises:
1650
+ * NotFound: If the specified organization or mentor does not exist.
1651
+ * BadRequest: If the provided parameters are invalid.
1652
+ *
1653
+ * Query Parameters:
1654
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - defaults to 30 days ago.
1655
+ * end_date (str): End date for filtering (YYYY-MM-DD) - defaults to today.
1656
+ * aggregation (str): Time aggregation level (hourly, daily) - default: daily.
1657
+ * mentor_id (str): Filter by mentor unique ID.
1658
+ * @param org
1659
+ * @param userId
1660
+ * @param aggregation Time aggregation level (hourly, daily)
1661
+ * @param endDate End date for filtering (YYYY-MM-DD)
1662
+ * @param groupBy
1663
+ * @param mentorId Filter by mentor unique ID
1664
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1665
+ * @returns UserChatByPeriod
1666
+ * @throws ApiError
1667
+ */
1668
+ static aiAnalyticsOrgsUsersTotalUsersByMentorList(org: string, userId: string, aggregation?: 'daily' | 'hourly', endDate?: string, groupBy?: string, mentorId?: string, startDate?: string): CancelablePromise<Array<UserChatByPeriod>>;
1669
+ /**
1670
+ * Retrieve message data from conversations.
1671
+ *
1672
+ * This endpoint returns data on messages within conversations, with options
1673
+ * for filtering by date range, topics, and mentor.
1674
+ *
1675
+ * Args:
1676
+ * request: The HTTP request containing filter query parameters.
1677
+ * org: Organization key identifier.
1678
+ * user_id: User identifier (not used in the implementation).
1679
+ *
1680
+ * Returns:
1681
+ * Response: A list of conversation message data.
1682
+ *
1683
+ * Raises:
1684
+ * NotFound: If the specified organization does not exist.
1685
+ * ValidationError: If the provided query parameters are invalid.
1686
+ *
1687
+ * Query Parameters:
1688
+ * start_date (str): Start date for filtering (YYYY-MM-DD).
1689
+ * end_date (str): End date for filtering (YYYY-MM-DD).
1690
+ * topics (str): Comma-separated list of topics to filter by.
1691
+ * mentor (str): Filter by mentor unique ID.
1692
+ * @param org
1693
+ * @param userId
1694
+ * @param endDate
1695
+ * @param mentor
1696
+ * @param startDate
1697
+ * @param topics
1698
+ * @returns ConversationMessage
1699
+ * @throws ApiError
1700
+ */
1701
+ static aiAnalyticsOrgsUsersTranscriptsList(org: string, userId: string, endDate?: string, mentor?: string, startDate?: string, topics?: string): CancelablePromise<Array<ConversationMessage>>;
1702
+ /**
1703
+ * Retrieve daily user engagement metrics with mentors.
1704
+ *
1705
+ * This endpoint returns data on the number of unique users who interact with
1706
+ * mentors each day within a specified date range.
1707
+ *
1708
+ * Args:
1709
+ * request: The HTTP request containing filter query parameters.
1710
+ * org: Organization key identifier.
1711
+ *
1712
+ * Returns:
1713
+ * Response: Daily time series of unique user counts.
1714
+ *
1715
+ * Raises:
1716
+ * NotFound: If the specified organization does not exist.
1717
+ * BadRequest: If the provided parameters are invalid.
1718
+ *
1719
+ * Query Parameters:
1720
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1721
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1722
+ * @param endDate End date for filtering (YYYY-MM-DD)
1723
+ * @param org
1724
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1725
+ * @param userId
1726
+ * @param groupBy
1727
+ * @returns UserCountRecord
1728
+ * @throws ApiError
1729
+ */
1730
+ static aiAnalyticsOrgsUsersUsageSummaryList(endDate: string, org: string, startDate: string, userId: string, groupBy?: string): CancelablePromise<Array<UserCountRecord>>;
1731
+ /**
1732
+ * Retrieve user cohort trends over time.
1733
+ *
1734
+ * This endpoint returns data on the distribution of new versus veteran users
1735
+ * over time, with options for different time aggregations and filtering by mentor.
1736
+ * New users are those who registered within the specified date range, while
1737
+ * veteran users are those who registered before the date range but were active
1738
+ * during it.
1739
+ *
1740
+ * Args:
1741
+ * request: The HTTP request containing filter query parameters.
1742
+ * org: Organization key identifier.
1743
+ *
1744
+ * Returns:
1745
+ * Response: Time series of new and veteran user counts.
1746
+ *
1747
+ * Raises:
1748
+ * NotFound: If the specified organization does not exist.
1749
+ * BadRequest: If the provided parameters are invalid.
1750
+ *
1751
+ * Query Parameters:
1752
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1753
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1754
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1755
+ * mentor_id (str): Filter by mentor unique ID.
1756
+ * @param endDate End date for filtering (YYYY-MM-DD)
1757
+ * @param org
1758
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1759
+ * @param userId
1760
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
1761
+ * @param mentorId Filter by mentor unique ID
1762
+ * @returns UserTrendByPeriod
1763
+ * @throws ApiError
1764
+ */
1765
+ static aiAnalyticsOrgsUsersUserCohortsOverTimeRetrieve(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', mentorId?: string): CancelablePromise<UserTrendByPeriod>;
1766
+ /**
1767
+ * Retrieve LLM usage costs for a specific user.
1768
+ *
1769
+ * This endpoint returns data on the total cost of LLM usage for a specific user
1770
+ * within a specified date range. The cost is calculated by summing the costs
1771
+ * of all observations associated with traces from the tenant's sessions.
1772
+ *
1773
+ * Args:
1774
+ * request: The HTTP request containing filter query parameters.
1775
+ * org: Organization key identifier.
1776
+ * user_id: User key identifier.
1777
+ *
1778
+ * Returns:
1779
+ * Response: Total LLM usage cost for the specified tenant.
1780
+ *
1781
+ * Raises:
1782
+ * NotFound: If the specified organization does not exist.
1783
+ * BadRequest: If the provided parameters are invalid.
1784
+ *
1785
+ * Query Parameters:
1786
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1787
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1788
+ * @param endDate
1789
+ * @param org
1790
+ * @param startDate
1791
+ * @param userId
1792
+ * @param username
1793
+ * @returns Cost
1794
+ * @throws ApiError
1795
+ */
1796
+ static aiAnalyticsOrgsUsersUserCostRetrieve(endDate: string, org: string, startDate: string, userId: string, username: string): CancelablePromise<Cost>;
1797
+ /**
1798
+ * Retrieve aggregated user chat feedback counts.
1799
+ *
1800
+ * This endpoint returns data on the number of user chat feedback entries
1801
+ * within a specified date range, with options for different time aggregations
1802
+ * (hourly, daily, weekly). Results can be filtered by mentor.
1803
+ *
1804
+ * Args:
1805
+ * request: The HTTP request containing filter query parameters.
1806
+ * org: Organization key identifier.
1807
+ *
1808
+ * Returns:
1809
+ * Response: Time series data of feedback counts.
1810
+ *
1811
+ * Raises:
1812
+ * NotFound: If the specified organization does not exist.
1813
+ * BadRequest: If the provided parameters are invalid.
1814
+ *
1815
+ * Query Parameters:
1816
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1817
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1818
+ * mentor_id (str): Filter by mentor unique ID.
1819
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1820
+ * @param endDate End date for filtering (YYYY-MM-DD)
1821
+ * @param org
1822
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1823
+ * @param userId
1824
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
1825
+ * @param mentorId Filter by mentor unique ID
1826
+ * @returns UserChatFeedbackCount
1827
+ * @throws ApiError
1828
+ */
1829
+ static aiAnalyticsOrgsUsersUserFeedbackList(endDate: string, org: string, startDate: string, userId: string, aggregation?: 'daily' | 'hourly' | 'weekly', mentorId?: string): CancelablePromise<Array<UserChatFeedbackCount>>;
1830
+ /**
1831
+ * Retrieve comprehensive user metrics.
1832
+ *
1833
+ * This endpoint returns data on various user metrics with month-over-month
1834
+ * change calculations:
1835
+ * - Registered users: Total users registered on the platform
1836
+ * - New users: Users who joined in the current month
1837
+ * - Unique users: Distinct users who have had sessions
1838
+ * - Veteran users: Users who have been active for at least 6 months
1839
+ *
1840
+ * Results can be filtered by mentor.
1841
+ *
1842
+ * Args:
1843
+ * request: The HTTP request containing filter query parameters.
1844
+ * org: Organization key identifier.
1845
+ *
1846
+ * Returns:
1847
+ * Response: Comprehensive user metrics with month-over-month changes.
1848
+ *
1849
+ * Raises:
1850
+ * NotFound: If the specified organization does not exist.
1851
+ *
1852
+ * Query Parameters:
1853
+ * mentor_id (str): Filter metrics by mentor unique ID.
1854
+ * @param org
1855
+ * @param userId
1856
+ * @param groupBy
1857
+ * @param mentorId Filter metrics by mentor unique ID
1858
+ * @returns UserMetricsResponse
1859
+ * @throws ApiError
1860
+ */
1861
+ static aiAnalyticsOrgsUsersUserMetricsRetrieve(org: string, userId: string, groupBy?: string, mentorId?: string): CancelablePromise<UserMetricsResponse>;
1862
+ /**
1863
+ * Retrieve user distribution data for pie charts.
1864
+ *
1865
+ * This endpoint returns data on the distribution of new versus returning users
1866
+ * within a specified date range, including both counts and percentages,
1867
+ * suitable for pie chart visualization.
1868
+ *
1869
+ * Args:
1870
+ * request: The HTTP request containing filter query parameters.
1871
+ * org: Organization key identifier.
1872
+ *
1873
+ * Returns:
1874
+ * Response: Distribution of new versus returning users with counts and percentages.
1875
+ *
1876
+ * Raises:
1877
+ * NotFound: If the specified organization does not exist.
1878
+ * BadRequest: If the provided parameters are invalid.
1879
+ *
1880
+ * Query Parameters:
1881
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1882
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1883
+ * mentor_id (str): Filter by mentor unique ID.
1884
+ * @param endDate End date for filtering (YYYY-MM-DD)
1885
+ * @param org
1886
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1887
+ * @param userId
1888
+ * @param mentorId Filter by mentor unique ID
1889
+ * @returns PieChartData
1890
+ * @throws ApiError
1891
+ */
1892
+ static aiAnalyticsOrgsUsersUserMetricsPieChartRetrieve(endDate: string, org: string, startDate: string, userId: string, mentorId?: string): CancelablePromise<PieChartData>;
1893
+ /**
1894
+ * Retrieve user sentiment distribution.
1895
+ *
1896
+ * This endpoint returns data on the distribution of user sentiments (positive,
1897
+ * negative, neutral) within a specified date range, expressed as percentages.
1898
+ *
1899
+ * Args:
1900
+ * request: The HTTP request containing filter query parameters.
1901
+ * org: Organization key identifier.
1902
+ *
1903
+ * Returns:
1904
+ * Response: Sentiment distribution percentages and total sentiment count.
1905
+ *
1906
+ * Raises:
1907
+ * NotFound: If the specified organization does not exist.
1908
+ * BadRequest: If the provided parameters are invalid.
1909
+ *
1910
+ * Query Parameters:
1911
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1912
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1913
+ * @param endDate End date for filtering (YYYY-MM-DD)
1914
+ * @param org
1915
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1916
+ * @param userId
1917
+ * @param groupBy
1918
+ * @returns SentimentSummary
1919
+ * @throws ApiError
1920
+ */
1921
+ static aiAnalyticsOrgsUsersUserSentimentRetrieve(endDate: string, org: string, startDate: string, userId: string, groupBy?: string): CancelablePromise<SentimentSummary>;
1922
+ /**
1923
+ * Get active user counts over time.
1924
+ *
1925
+ * This endpoint provides daily counts of active users (users with known activity)
1926
+ * over a specified time period.
1927
+ *
1928
+ * Query Parameters:
1929
+ * start_date (str, optional): Start date for the time range (ISO format)
1930
+ * end_date (str, optional): End date for the time range (ISO format)
1931
+ *
1932
+ * Returns:
1933
+ * Daily active user counts over the specified time period, with change metrics
1934
+ * compared to previous periods.
1935
+ *
1936
+ * Default time range is the last 7 days if no dates are specified.
1937
+ *
1938
+ * An active user is defined as a user with any activity within the past 30 days.
1939
+ * @param org
1940
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1941
+ * @param endDate end date. ISO 8601
1942
+ * @param format Format
1943
+ *
1944
+ * * `json` - json
1945
+ * @param includeMainPlatform Include main platform data
1946
+ * @param startDate start date. ISO 8601
1947
+ * @returns OvertimeWithChangeInfo
1948
+ * @throws ApiError
1949
+ */
1950
+ static aiAnalyticsOverviewOrgsActiveUsersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
1951
+ /**
1952
+ * Get average grade value for platform, course, or user.
1953
+ *
1954
+ * This endpoint returns the average grade at different levels:
1955
+ * - Platform level: Average grade across all courses
1956
+ * - Course level: Average grade for a specific course
1957
+ * - Learner level: Average grade for a specific learner
1958
+ * - Course-learner level: Grade for a specific learner in a specific course
1959
+ *
1960
+ * Query Parameters:
1961
+ * course_id (str, optional): Filter by course ID
1962
+ * learner_id (str, optional): Filter by username or email
1963
+ *
1964
+ * Returns:
1965
+ * The average grade value based on the specified filters.
1966
+ *
1967
+ * Access Control:
1968
+ * - Platform admins can access any grade data
1969
+ * - Learners can access their own grade data
1970
+ * @param org
1971
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1972
+ * @param format Format
1973
+ *
1974
+ * * `json` - json
1975
+ * @param includeMainPlatform Include main platform data
1976
+ * @returns Average
1977
+ * @throws ApiError
1978
+ */
1979
+ static aiAnalyticsOverviewOrgsAverageGradeRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
1980
+ /**
1981
+ * Get course completion summary metrics over time.
1982
+ *
1983
+ * This endpoint provides completion statistics across the platform over a
1984
+ * specified time period, including daily completion counts and overall metrics.
1985
+ *
1986
+ * Query Parameters:
1987
+ * start_date (str): Start date for the time range (ISO format)
1988
+ * end_date (str): End date for the time range (ISO format)
1989
+ *
1990
+ * Returns:
1991
+ * Completion data including:
1992
+ * - Daily completion counts over time
1993
+ * - Total unique user count
1994
+ * - Total completion count
1995
+ * - Completion percentage
1996
+ * - Change metrics compared to previous periods
1997
+ *
1998
+ * Default time range is the last 7 days if no dates are specified.
1999
+ * @param org
2000
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2001
+ * @param endDate end date. ISO 8601
2002
+ * @param format Format
2003
+ *
2004
+ * * `json` - json
2005
+ * @param includeMainPlatform Include main platform data
2006
+ * @param startDate start date. ISO 8601
2007
+ * @returns CourseCompletionSummaryOvertime
2008
+ * @throws ApiError
2009
+ */
2010
+ static aiAnalyticsOverviewOrgsCoursesCompletionsRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<CourseCompletionSummaryOvertime>;
2011
+ /**
2012
+ * List all learners on the platform with aggregated metrics.
2013
+ *
2014
+ * This endpoint returns a paginated list of all learners with key metrics including:
2015
+ * - Enrollment counts
2016
+ * - Completion counts
2017
+ * - Time spent on platform
2018
+ *
2019
+ * Query Parameters:
2020
+ * page (int): Page number for pagination
2021
+ * length (int): Number of items per page
2022
+ * search (str): Filter learners by username, email, or name
2023
+ *
2024
+ * Returns:
2025
+ * A paginated list of learners with their associated metrics.
2026
+ * @param org
2027
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2028
+ * @param format Format
2029
+ *
2030
+ * * `json` - json
2031
+ * @param includeMainPlatform Include main platform data
2032
+ * @param length Size of data to return
2033
+ * @param page Page offset
2034
+ * @param search Search string for learner
2035
+ * @returns PerlearnerUserList
2036
+ * @throws ApiError
2037
+ */
2038
+ static aiAnalyticsOverviewOrgsLearnersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, search?: string): CancelablePromise<PerlearnerUserList>;
2039
+ /**
2040
+ * Get time spent statistics on a per-course basis.
2041
+ *
2042
+ * This endpoint provides a paginated list of courses with the total time
2043
+ * spent by users in each course.
2044
+ *
2045
+ * Query Parameters:
2046
+ * start_date (str, optional): Start date for filtering (ISO format)
2047
+ * end_date (str, optional): End date for filtering (ISO format)
2048
+ * page (int, optional): Page number for pagination
2049
+ * length (int, optional): Number of items per page
2050
+ *
2051
+ * Returns:
2052
+ * A paginated list of courses with:
2053
+ * - Course identification (ID and name)
2054
+ * - Total time spent (in seconds)
2055
+ * - Formatted time spent (human-readable)
2056
+ * - Percentage of total platform time
2057
+ * @param org
2058
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2059
+ * @param endDate end date. ISO 8601
2060
+ * @param format Format
2061
+ *
2062
+ * * `json` - json
2063
+ * @param includeMainPlatform Include main platform data
2064
+ * @param length Size of data to return
2065
+ * @param page Page offset
2066
+ * @param startDate start date. ISO 8601
2067
+ * @returns TimeSpentPerCourse
2068
+ * @throws ApiError
2069
+ */
2070
+ static aiAnalyticsOverviewOrgsMostActiveCoursesRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, startDate?: string): CancelablePromise<TimeSpentPerCourse>;
2071
+ /**
2072
+ * Get registered user counts over time.
2073
+ *
2074
+ * This endpoint provides daily counts of new user registrations over a
2075
+ * specified time period.
2076
+ *
2077
+ * Query Parameters:
2078
+ * start_date (str, optional): Start date for the time range (ISO format)
2079
+ * end_date (str, optional): End date for the time range (ISO format)
2080
+ *
2081
+ * Returns:
2082
+ * Daily registration counts over the specified time period, with change metrics
2083
+ * compared to previous periods.
2084
+ *
2085
+ * Default time range is the last 7 days if no dates are specified.
2086
+ * @param org
2087
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2088
+ * @param endDate end date. ISO 8601
2089
+ * @param format Format
2090
+ *
2091
+ * * `json` - json
2092
+ * @param includeMainPlatform Include main platform data
2093
+ * @param startDate start date. ISO 8601
2094
+ * @returns OvertimeWithChangeInfo
2095
+ * @throws ApiError
2096
+ */
2097
+ static aiAnalyticsOverviewOrgsRegisteredUsersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OvertimeWithChangeInfo>;
2098
+ /**
2099
+ * Get average grade value for platform, course, or user.
2100
+ *
2101
+ * This endpoint returns the average grade at different levels:
2102
+ * - Platform level: Average grade across all courses
2103
+ * - Course level: Average grade for a specific course
2104
+ * - Learner level: Average grade for a specific learner
2105
+ * - Course-learner level: Grade for a specific learner in a specific course
2106
+ *
2107
+ * Query Parameters:
2108
+ * course_id (str, optional): Filter by course ID
2109
+ * learner_id (str, optional): Filter by username or email
2110
+ *
2111
+ * Returns:
2112
+ * The average grade value based on the specified filters.
2113
+ *
2114
+ * Access Control:
2115
+ * - Platform admins can access any grade data
2116
+ * - Learners can access their own grade data
2117
+ * @param courseId
2118
+ * @param org
2119
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2120
+ * @param format Format
2121
+ *
2122
+ * * `json` - json
2123
+ * @param includeMainPlatform Include main platform data
2124
+ * @returns Average
2125
+ * @throws ApiError
2126
+ */
2127
+ static aiAnalyticsPerformanceOrgsCoursesGradingAverageRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
2128
+ /**
2129
+ * Returns average course grade and grade cuttoff
2130
+ *
2131
+ * e.g
2132
+ * ```
2133
+ * {
2134
+ * "data": {
2135
+ * "grade_cutoffs": {
2136
+ * "A": 90,
2137
+ * "B": 80,
2138
+ * "C": 70,
2139
+ * },
2140
+ * "average_grade": 50.0,
2141
+ * }
2142
+ * }
2143
+ * ```
2144
+ *
2145
+ * Kwargs
2146
+ * course_id
2147
+ * @param courseId
2148
+ * @param org
2149
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2150
+ * @param format Format
2151
+ *
2152
+ * * `json` - json
2153
+ * @param includeMainPlatform Include main platform data
2154
+ * @returns AvgCourseGradeWithCutoff
2155
+ * @throws ApiError
2156
+ */
2157
+ static aiAnalyticsPerformanceOrgsCoursesGradingAverageWithCutoffRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<AvgCourseGradeWithCutoff>;
2158
+ /**
2159
+ * Grading summary for the entire course overview in a tree-like format
2160
+ *
2161
+ * Kwargs
2162
+ * course_id <required>
2163
+ * @param courseId
2164
+ * @param org
2165
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2166
+ * @param format Format
2167
+ *
2168
+ * * `json` - json
2169
+ * @param includeMainPlatform Include main platform data
2170
+ * @returns CourseGradingDetail
2171
+ * @throws ApiError
2172
+ */
2173
+ static aiAnalyticsPerformanceOrgsCoursesGradingDetailRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<CourseGradingDetail>;
2174
+ /**
2175
+ * Grading information per enrolled user in a course
2176
+ *
2177
+ * Kwargs
2178
+ * course_id <required>
2179
+ * @param courseId
2180
+ * @param org
2181
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2182
+ * @param format Format
2183
+ *
2184
+ * * `json` - json
2185
+ * @param includeMainPlatform Include main platform data
2186
+ * @returns GradingPerUser
2187
+ * @throws ApiError
2188
+ */
2189
+ static aiAnalyticsPerformanceOrgsCoursesGradingPerLearnerRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<GradingPerUser>;
2190
+ /**
2191
+ * Returns average grades across various assignment types in a course
2192
+ *
2193
+ * Query Params
2194
+ * course_id
2195
+ *
2196
+ * Returns:
2197
+ * dict
2198
+ * {
2199
+ * "data": [
2200
+ * {
2201
+ * "assignment_type': <str>,
2202
+ * "weight": <float>,
2203
+ * "average_weighted_grade": <float>,
2204
+ * "average_section_grade": <float>
2205
+ * }, ...
2206
+ * ]
2207
+ * }
2208
+ * @param courseId
2209
+ * @param org
2210
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2211
+ * @param format Format
2212
+ *
2213
+ * * `json` - json
2214
+ * @param includeMainPlatform Include main platform data
2215
+ * @returns CourseGradeSummary
2216
+ * @throws ApiError
2217
+ */
2218
+ static aiAnalyticsPerformanceOrgsCoursesGradingSummaryRetrieve(courseId: string, org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<CourseGradeSummary>;
2219
+ /**
2220
+ * Get average grade value for platform, course, or user.
2221
+ *
2222
+ * This endpoint returns the average grade at different levels:
2223
+ * - Platform level: Average grade across all courses
2224
+ * - Course level: Average grade for a specific course
2225
+ * - Learner level: Average grade for a specific learner
2226
+ * - Course-learner level: Grade for a specific learner in a specific course
2227
+ *
2228
+ * Query Parameters:
2229
+ * course_id (str, optional): Filter by course ID
2230
+ * learner_id (str, optional): Filter by username or email
2231
+ *
2232
+ * Returns:
2233
+ * The average grade value based on the specified filters.
2234
+ *
2235
+ * Access Control:
2236
+ * - Platform admins can access any grade data
2237
+ * - Learners can access their own grade data
2238
+ * @param org
2239
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2240
+ * @param format Format
2241
+ *
2242
+ * * `json` - json
2243
+ * @param includeMainPlatform Include main platform data
2244
+ * @returns Average
2245
+ * @throws ApiError
2246
+ */
2247
+ static aiAnalyticsPerformanceOrgsGradingAverageRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
2248
+ /**
2249
+ * List grade-related performance data for all courses.
2250
+ *
2251
+ * This endpoint provides a comprehensive view of grade performance across
2252
+ * courses, including enrollment counts, pass rates, and average grades.
2253
+ *
2254
+ * Returns:
2255
+ * A paginated list of courses with:
2256
+ * - Course identification (ID and name)
2257
+ * - Enrollment count
2258
+ * - Number of students who passed
2259
+ * - Average grade
2260
+ * @param org
2261
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2262
+ * @param format Format
2263
+ *
2264
+ * * `json` - json
2265
+ * @param includeMainPlatform Include main platform data
2266
+ * @param length Size of data to return
2267
+ * @param page Page offset
2268
+ * @returns PerformanceGradesPerCourse
2269
+ * @throws ApiError
2270
+ */
2271
+ static aiAnalyticsPerformanceOrgsGradingPerCourseRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number): CancelablePromise<PerformanceGradesPerCourse>;
2272
+ /**
2273
+ * Enhanced API endpoint for listing learners with comprehensive filtering.
2274
+ *
2275
+ * This endpoint provides a paginated list of learners with detailed metrics
2276
+ * and supports advanced filtering options. It uses DM token authentication
2277
+ * and respects department-based access controls.
2278
+ *
2279
+ * Query Parameters:
2280
+ * page (int): Page number for pagination
2281
+ * length (int): Number of items per page
2282
+ * search (str): Filter by username, email, or full name
2283
+ * program (str): Filter by program
2284
+ * location (str): Filter by location
2285
+ * is_enrolled (bool): Filter for users with enrollments
2286
+ * platform (str): Filter by platform
2287
+ * start_date (date): Filter by join date (start range)
2288
+ * end_date (date): Filter by join date (end range)
2289
+ *
2290
+ * Returns:
2291
+ * A paginated list of learners with comprehensive metrics including:
2292
+ * - Course enrollments and completions
2293
+ * - Time spent on platform
2294
+ * - Pathway progress
2295
+ * - Certificate and skill information
2296
+ * - Location data
2297
+ *
2298
+ * Access Control:
2299
+ * - Platform admins can see all learners
2300
+ * - Department admins can only see learners in their departments
2301
+ * @param org
2302
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2303
+ * @param endDate Learner date_joined end date. ISO 8601
2304
+ * @param format Format
2305
+ *
2306
+ * * `json` - json
2307
+ * @param includeMainPlatform Include main platform data
2308
+ * @param isEnrolled Filter for users who have at least an enrollment
2309
+ * @param length Size of data to return
2310
+ * @param location Location search string
2311
+ * @param page Page offset
2312
+ * @param platform Platform search string
2313
+ * @param program Program search string
2314
+ * @param search Search string for learner. email, username or full name
2315
+ * @param startDate Learner date_joined start date. ISO 8601
2316
+ * @returns NewPerLearnerList
2317
+ * @throws ApiError
2318
+ */
2319
+ static aiAnalyticsPerlearnerOrgsLearnersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, isEnrolled?: boolean | null, length?: number, location?: string, page?: number, platform?: string, program?: string, search?: string, startDate?: string): CancelablePromise<NewPerLearnerList>;
2320
+ /**
2321
+ * List all learners on the platform with aggregated metrics.
2322
+ *
2323
+ * This endpoint returns a paginated list of all learners with key metrics including:
2324
+ * - Enrollment counts
2325
+ * - Completion counts
2326
+ * - Time spent on platform
2327
+ *
2328
+ * Query Parameters:
2329
+ * page (int): Page number for pagination
2330
+ * length (int): Number of items per page
2331
+ * search (str): Filter learners by username, email, or name
2332
+ *
2333
+ * Returns:
2334
+ * A paginated list of learners with their associated metrics.
2335
+ * @param org
2336
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2337
+ * @param format Format
2338
+ *
2339
+ * * `json` - json
2340
+ * @param includeMainPlatform Include main platform data
2341
+ * @param length Size of data to return
2342
+ * @param page Page offset
2343
+ * @param search Search string for learner
2344
+ * @returns PerlearnerUserList
2345
+ * @throws ApiError
2346
+ */
2347
+ static aiAnalyticsPerlearnerOrgsUsersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, search?: string): CancelablePromise<PerlearnerUserList>;
2348
+ /**
2349
+ * Provides information on user enrollments
2350
+ *
2351
+ * Params
2352
+ * user_id e.g developer@ibleducation.com| developer
2353
+ * @param org
2354
+ * @param userId
2355
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2356
+ * @param format Format
2357
+ *
2358
+ * * `json` - json
2359
+ * @param includeMainPlatform Include main platform data
2360
+ * @returns ActivityAPI
2361
+ * @throws ApiError
2362
+ */
2363
+ static aiAnalyticsPerlearnerOrgsUsersActivityRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<ActivityAPI>;
2364
+ /**
2365
+ * Provides about a learner current grade in a course with the course cut
2366
+ * Kwargs
2367
+ * 1. course_id e.g course-v1:Org+Course4+Run
2368
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
2369
+ * @param courseId
2370
+ * @param org
2371
+ * @param userId
2372
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2373
+ * @param endDate end date. ISO 8601
2374
+ * @param format Format
2375
+ *
2376
+ * * `json` - json
2377
+ * @param includeMainPlatform Include main platform data
2378
+ * @param startDate start date. ISO 8601
2379
+ * @returns PerlearnerGradeWithCutOff
2380
+ * @throws ApiError
2381
+ */
2382
+ static aiAnalyticsPerlearnerOrgsUsersCoursesGradingCutoffsRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerGradeWithCutOff>;
2383
+ /**
2384
+ * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
2385
+ * @param courseId
2386
+ * @param org
2387
+ * @param userId
2388
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2389
+ * @param endDate end date. ISO 8601
2390
+ * @param format Format
2391
+ *
2392
+ * * `json` - json
2393
+ * @param includeMainPlatform Include main platform data
2394
+ * @param startDate start date. ISO 8601
2395
+ * @returns DetailedGradeView
2396
+ * @throws ApiError
2397
+ */
2398
+ static aiAnalyticsPerlearnerOrgsUsersCoursesGradingDetailRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<DetailedGradeView>;
2399
+ /**
2400
+ * Query Params
2401
+ * 1. course_id e.g course-v1:Org+Course4+Run
2402
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
2403
+ * @param courseId
2404
+ * @param org
2405
+ * @param userId
2406
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2407
+ * @param endDate end date. ISO 8601
2408
+ * @param format Format
2409
+ *
2410
+ * * `json` - json
2411
+ * @param includeMainPlatform Include main platform data
2412
+ * @param startDate start date. ISO 8601
2413
+ * @returns PerlearnerGradeSummary
2414
+ * @throws ApiError
2415
+ */
2416
+ static aiAnalyticsPerlearnerOrgsUsersCoursesGradingSummaryRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerGradeSummary>;
2417
+ /**
2418
+ * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
2419
+ * @param courseId
2420
+ * @param org
2421
+ * @param userId
2422
+ * @returns Value
2423
+ * @throws ApiError
2424
+ */
2425
+ static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve(courseId: string, org: string, userId: string): CancelablePromise<Value>;
2426
+ /**
2427
+ * Provides about a learner current grade in a course with the course cut
2428
+ * Kwargs
2429
+ * 1. course_id e.g course-v1:Org+Course4+Run
2430
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
2431
+ * @param courseId
2432
+ * @param org
2433
+ * @param userId
2434
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2435
+ * @param endDate end date. ISO 8601
2436
+ * @param format Format
2437
+ *
2438
+ * * `json` - json
2439
+ * @param includeMainPlatform Include main platform data
2440
+ * @param startDate start date. ISO 8601
2441
+ * @returns PerlearnerGradeWithCutOff
2442
+ * @throws ApiError
2443
+ */
2444
+ static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewGradeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerGradeWithCutOff>;
2445
+ /**
2446
+ * Evaluates performance index for platform, per course, per user and per user-per course
2447
+ *
2448
+ * Query Params
2449
+ * course_id <optional>
2450
+ * learner_id <optional>
2451
+ * @param courseId
2452
+ * @param org
2453
+ * @param userId
2454
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2455
+ * @param endDate end date. ISO 8601
2456
+ * @param format Format
2457
+ *
2458
+ * * `json` - json
2459
+ * @param includeMainPlatform Include main platform data
2460
+ * @param startDate start date. ISO 8601
2461
+ * @returns Value
2462
+ * @throws ApiError
2463
+ */
2464
+ static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Value>;
2465
+ /**
2466
+ * Time spent within a course in secs on a per-day basis
2467
+ *
2468
+ * Kwargs
2469
+ * 1. course_id e.g course-v1:Org+Course4+Run
2470
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
2471
+ * Query Params
2472
+ * 3. start_date e.g 2020-10-01
2473
+ * 4. end_date e.g 2020-10-10
2474
+ *
2475
+ * Default result when no query param is added is last_7_days (today inclusive)
2476
+ * @param courseId
2477
+ * @param org
2478
+ * @param userId
2479
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2480
+ * @param endDate end date. ISO 8601
2481
+ * @param format Format
2482
+ *
2483
+ * * `json` - json
2484
+ * @param includeMainPlatform Include main platform data
2485
+ * @param startDate start date. ISO 8601
2486
+ * @returns OverTimeWithTotal
2487
+ * @throws ApiError
2488
+ */
2489
+ static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
2490
+ /**
2491
+ * List of videos within a course a learner has watched
2492
+ *
2493
+ * Kwargs
2494
+ * 1. course_id e.g course-v1:Org+Course4+Run
2495
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
2496
+ *
2497
+ * Default result when no query param is added is [], 0
2498
+ * @param courseId
2499
+ * @param org
2500
+ * @param userId
2501
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2502
+ * @param format Format
2503
+ *
2504
+ * * `json` - json
2505
+ * @param includeMainPlatform Include main platform data
2506
+ * @returns PerLearnerCourseVideosWatched
2507
+ * @throws ApiError
2508
+ */
2509
+ static aiAnalyticsPerlearnerOrgsUsersCoursesVideosRetrieve(courseId: string, org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerLearnerCourseVideosWatched>;
2510
+ /**
2511
+ * Get video watch counts over time.
2512
+ *
2513
+ * This endpoint provides daily counts of videos watched over a specified time period,
2514
+ * with options to filter by course or user.
2515
+ *
2516
+ * Query Parameters:
2517
+ * start_date (str, optional): Start date for the time range (ISO format)
2518
+ * end_date (str, optional): End date for the time range (ISO format)
2519
+ * course_id (str, optional): Filter by course ID
2520
+ * user_id (str, optional): Filter by username or email
2521
+ *
2522
+ * Returns:
2523
+ * Daily video watch counts over the specified time period.
2524
+ *
2525
+ * Default time range is the last 7 days if no dates are specified.
2526
+ *
2527
+ * Access Control:
2528
+ * - Platform admins can access any video watch data
2529
+ * - Learners can access their own video watch data
2530
+ * @param courseId
2531
+ * @param org
2532
+ * @param userId
2533
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2534
+ * @param endDate end date. ISO 8601
2535
+ * @param format Format
2536
+ *
2537
+ * * `json` - json
2538
+ * @param includeMainPlatform Include main platform data
2539
+ * @param startDate start date. ISO 8601
2540
+ * @returns OverTimeWithTotal
2541
+ * @throws ApiError
2542
+ */
2543
+ static aiAnalyticsPerlearnerOrgsUsersCoursesVideosOverTimeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
2544
+ /**
2545
+ * Summary Grading Information for a learner on a per-enrollment basis
2546
+ *
2547
+ * Query Params
2548
+ * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
2549
+ * @param org
2550
+ * @param userId
2551
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2552
+ * @param format Format
2553
+ *
2554
+ * * `json` - json
2555
+ * @param includeMainPlatform Include main platform data
2556
+ * @returns PerlearnerGradingPerCourseAPI
2557
+ * @throws ApiError
2558
+ */
2559
+ static aiAnalyticsPerlearnerOrgsUsersGradesPerCourseRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerlearnerGradingPerCourseAPI>;
2560
+ /**
2561
+ * Retrieve detailed information about a specific learner.
2562
+ *
2563
+ * This endpoint returns personal and activity information about a learner,
2564
+ * including profile data, activity metrics, and location information.
2565
+ *
2566
+ * Path Parameters:
2567
+ * user_id (str): The username or email of the learner
2568
+ *
2569
+ * Query Parameters:
2570
+ * meta (bool): Include additional analytics information when true
2571
+ *
2572
+ * Returns:
2573
+ * Detailed learner information including:
2574
+ * - Profile data (username, name, email)
2575
+ * - Registration and activity dates
2576
+ * - Activity metrics (assessments, time spent, videos watched)
2577
+ * - Location and browser information (when available)
2578
+ *
2579
+ * Access Control:
2580
+ * - Platform admins can access any learner
2581
+ * - Learners can access their own information
2582
+ * - Department admins can access learners in their departments
2583
+ * @param org
2584
+ * @param userId
2585
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2586
+ * @param format Format
2587
+ *
2588
+ * * `json` - json
2589
+ * @param includeMainPlatform Include main platform data
2590
+ * @param meta Include extra analytics information?
2591
+ *
2592
+ * * `y` - y
2593
+ * * `yes` - yes
2594
+ * * `true` - true
2595
+ * * `True` - True
2596
+ * * `n` - n
2597
+ * * `no` - no
2598
+ * * `false` - false
2599
+ * * `False` - False
2600
+ * @param search
2601
+ * @returns LearnerInformationAPI
2602
+ * @throws ApiError
2603
+ */
2604
+ static aiAnalyticsPerlearnerOrgsUsersInfoRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, meta?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', search?: string): CancelablePromise<LearnerInformationAPI>;
2605
+ /**
2606
+ * Last course accessed by a learner, includes upto unit information as well
2607
+ * @param org
2608
+ * @param userId
2609
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2610
+ * @param format Format
2611
+ *
2612
+ * * `json` - json
2613
+ * @param includeMainPlatform Include main platform data
2614
+ * @returns PerLearnerLastAccess
2615
+ * @throws ApiError
2616
+ */
2617
+ static aiAnalyticsPerlearnerOrgsUsersLastAccessRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerLearnerLastAccess>;
2618
+ /**
2619
+ * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
2620
+ * @param org
2621
+ * @param userId
2622
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2623
+ * @param endDate end date. ISO 8601
2624
+ * @param format Format
2625
+ *
2626
+ * * `json` - json
2627
+ * @param includeMainPlatform Include main platform data
2628
+ * @param startDate start date. ISO 8601
2629
+ * @returns Value
2630
+ * @throws ApiError
2631
+ */
2632
+ static aiAnalyticsPerlearnerOrgsUsersOverviewEngagementIndexRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Value>;
2633
+ /**
2634
+ * Get average grade value for platform, course, or user.
2635
+ *
2636
+ * This endpoint returns the average grade at different levels:
2637
+ * - Platform level: Average grade across all courses
2638
+ * - Course level: Average grade for a specific course
2639
+ * - Learner level: Average grade for a specific learner
2640
+ * - Course-learner level: Grade for a specific learner in a specific course
2641
+ *
2642
+ * Query Parameters:
2643
+ * course_id (str, optional): Filter by course ID
2644
+ * learner_id (str, optional): Filter by username or email
2645
+ *
2646
+ * Returns:
2647
+ * The average grade value based on the specified filters.
2648
+ *
2649
+ * Access Control:
2650
+ * - Platform admins can access any grade data
2651
+ * - Learners can access their own grade data
2652
+ * @param org
2653
+ * @param userId
2654
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2655
+ * @param format Format
2656
+ *
2657
+ * * `json` - json
2658
+ * @param includeMainPlatform Include main platform data
2659
+ * @returns Average
2660
+ * @throws ApiError
2661
+ */
2662
+ static aiAnalyticsPerlearnerOrgsUsersOverviewGradesAverageRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
2663
+ /**
2664
+ * Evaluates performance index for platform, per course, per user and per user-per course
2665
+ *
2666
+ * Query Params
2667
+ * course_id <optional>
2668
+ * learner_id <optional>
2669
+ * @param org
2670
+ * @param userId
2671
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2672
+ * @param endDate end date. ISO 8601
2673
+ * @param format Format
2674
+ *
2675
+ * * `json` - json
2676
+ * @param includeMainPlatform Include main platform data
2677
+ * @param startDate start date. ISO 8601
2678
+ * @returns Value
2679
+ * @throws ApiError
2680
+ */
2681
+ static aiAnalyticsPerlearnerOrgsUsersOverviewPerformanceIndexRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Value>;
2682
+ /**
2683
+ * Time spent in secs on a per-day basis
2684
+ *
2685
+ * Query Params
2686
+ * 1. course_id <optional> e.g course-v1:Org+Course4+Run
2687
+ * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
2688
+ * 3. start_date e.g 2020-10-01
2689
+ * 4. end_date e.g 2020-10-10
2690
+ *
2691
+ * Default result when no query param is added is last_7_days (today inclusive)
2692
+ * @param org
2693
+ * @param userId
2694
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2695
+ * @param endDate end date. ISO 8601
2696
+ * @param format Format
2697
+ *
2698
+ * * `json` - json
2699
+ * @param includeMainPlatform Include main platform data
2700
+ * @param startDate start date. ISO 8601
2701
+ * @returns OverTimeWithTotal
2702
+ * @throws ApiError
2703
+ */
2704
+ static aiAnalyticsPerlearnerOrgsUsersOverviewTimeOverTimeRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
2705
+ /**
2706
+ * Get video watch counts over time.
2707
+ *
2708
+ * This endpoint provides daily counts of videos watched over a specified time period,
2709
+ * with options to filter by course or user.
2710
+ *
2711
+ * Query Parameters:
2712
+ * start_date (str, optional): Start date for the time range (ISO format)
2713
+ * end_date (str, optional): End date for the time range (ISO format)
2714
+ * course_id (str, optional): Filter by course ID
2715
+ * user_id (str, optional): Filter by username or email
2716
+ *
2717
+ * Returns:
2718
+ * Daily video watch counts over the specified time period.
2719
+ *
2720
+ * Default time range is the last 7 days if no dates are specified.
2721
+ *
2722
+ * Access Control:
2723
+ * - Platform admins can access any video watch data
2724
+ * - Learners can access their own video watch data
2725
+ * @param org
2726
+ * @param userId
2727
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2728
+ * @param endDate end date. ISO 8601
2729
+ * @param format Format
2730
+ *
2731
+ * * `json` - json
2732
+ * @param includeMainPlatform Include main platform data
2733
+ * @param startDate start date. ISO 8601
2734
+ * @returns OverTimeWithTotal
2735
+ * @throws ApiError
2736
+ */
2737
+ static aiAnalyticsPerlearnerOrgsUsersVideosOverTimeRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
2738
+ /**
2739
+ * Summary Videos watched data for a learner per enrollment
2740
+ *
2741
+ * Query Params
2742
+ * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
2743
+ * @param org
2744
+ * @param userId
2745
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2746
+ * @param endDate end date. ISO 8601
2747
+ * @param format Format
2748
+ *
2749
+ * * `json` - json
2750
+ * @param includeMainPlatform Include main platform data
2751
+ * @param startDate start date. ISO 8601
2752
+ * @returns PerlearnerEngagementVideosWatchedPerCourse
2753
+ * @throws ApiError
2754
+ */
2755
+ static aiAnalyticsPerlearnerOrgsUsersVideosPerCourseRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerEngagementVideosWatchedPerCourse>;
2756
+ /**
2757
+ * Get a list of user groups with metrics and filtering options.
2758
+ *
2759
+ * This endpoint provides a paginated list of user groups with aggregated metrics
2760
+ * about learner performance, course completions, and skill acquisition.
2761
+ *
2762
+ * This endpoint uses DM token authentication and respects department-based
2763
+ * access controls.
2764
+ *
2765
+ * Query Parameters:
2766
+ * page (int, optional): Page number for pagination
2767
+ * length (int, optional): Number of items per page
2768
+ * program (str, optional): Filter by program
2769
+ * pathway (str, optional): Filter by pathway
2770
+ * groups (list, optional): Filter by group names
2771
+ * location (str, optional): Filter by location
2772
+ * is_enrolled (bool, optional): Filter for groups with enrolled users
2773
+ * start_date (date, optional): Filter by learner join date (start range)
2774
+ * end_date (date, optional): Filter by learner join date (end range)
2775
+ *
2776
+ * Returns:
2777
+ * A paginated list of user groups with comprehensive metrics.
2778
+ *
2779
+ * Access Control:
2780
+ * - Platform admins can see all groups
2781
+ * - Department admins can only see groups in their departments
2782
+ * @param org
2783
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2784
+ * @param endDate Filter by learners date_joined. Start date. ISO 8601
2785
+ * @param format Format
2786
+ *
2787
+ * * `json` - json
2788
+ * @param groups Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
2789
+ * @param includeMainPlatform Include main platform data
2790
+ * @param isEnrolled Filter for users who have at least an enrollment
2791
+ * @param length Size of data to return
2792
+ * @param location Location search string
2793
+ * @param page Page offset
2794
+ * @param pathway Pathway string
2795
+ * @param program Program search string
2796
+ * @param startDate Filter by learners date_joined. Start date. ISO 8601
2797
+ * @returns GroupList
2798
+ * @throws ApiError
2799
+ */
2800
+ static aiAnalyticsUserGroupsOrgsRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', groups?: Array<string>, includeMainPlatform?: boolean, isEnrolled?: boolean | null, length?: number, location?: string, page?: number, pathway?: string, program?: string, startDate?: string): CancelablePromise<GroupList>;
2801
+ }