@iblai/iblai-api 3.53.0-ai-plus → 3.53.0-core

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 (670) hide show
  1. package/dist/index.cjs.js +10908 -27777
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +10909 -27769
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +10908 -27777
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +2 -327
  8. package/dist/types/models/{StripeCheckoutSessionRequestModeEnum.d.ts → ModeEnum.d.ts} +1 -1
  9. package/dist/types/models/NotificationSource.d.ts +2 -2
  10. package/dist/types/models/StripeCheckoutSessionRequest.d.ts +2 -2
  11. package/dist/types/models/{NotificationSourceTypeEnum.d.ts → TypeEnum.d.ts} +1 -1
  12. package/dist/types/services/SearchService.d.ts +0 -718
  13. package/package.json +1 -1
  14. package/src/core/OpenAPI.ts +1 -1
  15. package/src/index.ts +2 -327
  16. package/src/models/{StripeCheckoutSessionRequestModeEnum.ts → ModeEnum.ts} +1 -1
  17. package/src/models/NotificationSource.ts +2 -2
  18. package/src/models/StripeCheckoutSessionRequest.ts +2 -2
  19. package/src/models/{NotificationSourceTypeEnum.ts → TypeEnum.ts} +1 -1
  20. package/src/services/SearchService.ts +398 -1428
  21. package/dist/types/models/AIGeneratedImage.d.ts +0 -13
  22. package/dist/types/models/AIUserProfileMemoryRelation.d.ts +0 -4
  23. package/dist/types/models/AIUserProfileRequest.d.ts +0 -4
  24. package/dist/types/models/APITokenCost.d.ts +0 -14
  25. package/dist/types/models/AccessEnum.d.ts +0 -8
  26. package/dist/types/models/AlignMentorBubbleEnum.d.ts +0 -8
  27. package/dist/types/models/AnalyticsOverview.d.ts +0 -7
  28. package/dist/types/models/Answer.d.ts +0 -11
  29. package/dist/types/models/AssumedKnowledge.d.ts +0 -4
  30. package/dist/types/models/AssumedKnowledgeLevel.d.ts +0 -4
  31. package/dist/types/models/AudioToTextRequest.d.ts +0 -3
  32. package/dist/types/models/AudioToTextResponse.d.ts +0 -3
  33. package/dist/types/models/Bot.d.ts +0 -15
  34. package/dist/types/models/BotCommand.d.ts +0 -6
  35. package/dist/types/models/BotCreate.d.ts +0 -12
  36. package/dist/types/models/CallAuthenticationRequest.d.ts +0 -13
  37. package/dist/types/models/CallAuthenticationResponse.d.ts +0 -21
  38. package/dist/types/models/CallConfiguration.d.ts +0 -26
  39. package/dist/types/models/CallConfigurationModeEnum.d.ts +0 -8
  40. package/dist/types/models/ChatHistory.d.ts +0 -8
  41. package/dist/types/models/ChatHistoryFilterData.d.ts +0 -9
  42. package/dist/types/models/ChatHistoryFilterUser.d.ts +0 -5
  43. package/dist/types/models/ChatHistoryItem.d.ts +0 -5
  44. package/dist/types/models/ChatHistorySessionId.d.ts +0 -3
  45. package/dist/types/models/ChatSessionRequest.d.ts +0 -10
  46. package/dist/types/models/ChatSessionResponse.d.ts +0 -5
  47. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +0 -10
  48. package/dist/types/models/ComponentBlock.d.ts +0 -9
  49. package/dist/types/models/ComponentBlockTypeEnum.d.ts +0 -8
  50. package/dist/types/models/ConversationMessage.d.ts +0 -11
  51. package/dist/types/models/ConversationRating.d.ts +0 -6
  52. package/dist/types/models/ConversationSummary.d.ts +0 -5
  53. package/dist/types/models/ConversationVolume.d.ts +0 -4
  54. package/dist/types/models/Conversations.d.ts +0 -28
  55. package/dist/types/models/Cost.d.ts +0 -3
  56. package/dist/types/models/CostPerTenant.d.ts +0 -6
  57. package/dist/types/models/CourseCreationTask.d.ts +0 -31
  58. package/dist/types/models/CourseCreationTaskFile.d.ts +0 -7
  59. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +0 -16
  60. package/dist/types/models/CredentialRequest.d.ts +0 -14
  61. package/dist/types/models/CrontabSchedule.d.ts +0 -22
  62. package/dist/types/models/CustomInstructionResponse.d.ts +0 -13
  63. package/dist/types/models/DataSet.d.ts +0 -21
  64. package/dist/types/models/DataSetCreate.d.ts +0 -12
  65. package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
  66. package/dist/types/models/DateRange.d.ts +0 -4
  67. package/dist/types/models/DiscordConfig.d.ts +0 -7
  68. package/dist/types/models/DiscordUserConfig.d.ts +0 -10
  69. package/dist/types/models/DiscordWebhook.d.ts +0 -6
  70. package/dist/types/models/Document.d.ts +0 -41
  71. package/dist/types/models/DocumentFacet.d.ts +0 -17
  72. package/dist/types/models/DocumentSearchResponse.d.ts +0 -35
  73. package/dist/types/models/DocumentSettingsResponse.d.ts +0 -3
  74. package/dist/types/models/EdxCourse.d.ts +0 -11
  75. package/dist/types/models/ElevenlabsCustomVoice.d.ts +0 -4
  76. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +0 -8
  77. package/dist/types/models/EmailPromptDetail.d.ts +0 -13
  78. package/dist/types/models/EmailPromptList.d.ts +0 -11
  79. package/dist/types/models/EmailPromptSummary.d.ts +0 -5
  80. package/dist/types/models/FreeUsageCount.d.ts +0 -3
  81. package/dist/types/models/FullCourse.d.ts +0 -13
  82. package/dist/types/models/GreetingMethodEnum.d.ts +0 -8
  83. package/dist/types/models/GuidedPromptsResponse.d.ts +0 -3
  84. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +0 -8
  85. package/dist/types/models/HeygenMarketingVideoList.d.ts +0 -6
  86. package/dist/types/models/HeygenTemplateRequest.d.ts +0 -5
  87. package/dist/types/models/HeygenTemplateResponseSingle.d.ts +0 -6
  88. package/dist/types/models/HeygenVideoDetail.d.ts +0 -8
  89. package/dist/types/models/HeygenVideoRequest.d.ts +0 -5
  90. package/dist/types/models/IBLAIPlatformMeta.d.ts +0 -3
  91. package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +0 -6
  92. package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +0 -10
  93. package/dist/types/models/InputQuestion.d.ts +0 -6
  94. package/dist/types/models/IntegrationCredential.d.ts +0 -8
  95. package/dist/types/models/IntialQuestionAnswer.d.ts +0 -3
  96. package/dist/types/models/JobRun.d.ts +0 -11
  97. package/dist/types/models/KindEnum.d.ts +0 -10
  98. package/dist/types/models/LLMCredentialRequest.d.ts +0 -14
  99. package/dist/types/models/LLMCredentialResponse.d.ts +0 -8
  100. package/dist/types/models/LLMModelForTenant.d.ts +0 -6
  101. package/dist/types/models/LLMQuestion.d.ts +0 -15
  102. package/dist/types/models/LLMResponse.d.ts +0 -14
  103. package/dist/types/models/LLMTracesListResponse.d.ts +0 -5
  104. package/dist/types/models/LanguagesView.d.ts +0 -5
  105. package/dist/types/models/LinkCourseRequest.d.ts +0 -3
  106. package/dist/types/models/LinkCourseResponse.d.ts +0 -5
  107. package/dist/types/models/LlmProviderEnum.d.ts +0 -8
  108. package/dist/types/models/MCPServer.d.ts +0 -21
  109. package/dist/types/models/MemoryComponentData.d.ts +0 -5
  110. package/dist/types/models/MemoryComponentMemory.d.ts +0 -4
  111. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +0 -8
  112. package/dist/types/models/MemoryComponentResponse.d.ts +0 -5
  113. package/dist/types/models/MemoryProgress.d.ts +0 -8
  114. package/dist/types/models/MemoryStatusRequestView.d.ts +0 -6
  115. package/dist/types/models/MemoryStatusView.d.ts +0 -6
  116. package/dist/types/models/Mentor.d.ts +0 -87
  117. package/dist/types/models/MentorAudience.d.ts +0 -5
  118. package/dist/types/models/MentorCategory.d.ts +0 -9
  119. package/dist/types/models/MentorCategoryCreate.d.ts +0 -11
  120. package/dist/types/models/MentorCategoryGroup.d.ts +0 -11
  121. package/dist/types/models/MentorCategoryGroupCreate.d.ts +0 -11
  122. package/dist/types/models/MentorCreate.d.ts +0 -84
  123. package/dist/types/models/MentorCustomVoice.d.ts +0 -4
  124. package/dist/types/models/MentorCustomVoiceResponse.d.ts +0 -4
  125. package/dist/types/models/MentorData.d.ts +0 -7
  126. package/dist/types/models/MentorDetailAnalytics.d.ts +0 -6
  127. package/dist/types/models/MentorEval.d.ts +0 -11
  128. package/dist/types/models/MentorEvalQuestion.d.ts +0 -5
  129. package/dist/types/models/MentorEvalQuestionRequest.d.ts +0 -4
  130. package/dist/types/models/MentorEvalReport.d.ts +0 -10
  131. package/dist/types/models/MentorEvalRequest.d.ts +0 -8
  132. package/dist/types/models/MentorFacet.d.ts +0 -17
  133. package/dist/types/models/MentorFork.d.ts +0 -5
  134. package/dist/types/models/MentorFromTemplateRequest.d.ts +0 -4
  135. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +0 -47
  136. package/dist/types/models/MentorMemorySettingsRequest.d.ts +0 -6
  137. package/dist/types/models/MentorMemorySettingsResponse.d.ts +0 -6
  138. package/dist/types/models/MentorMetadata.d.ts +0 -5
  139. package/dist/types/models/MentorScenario.d.ts +0 -6
  140. package/dist/types/models/MentorScenarioPrompt.d.ts +0 -5
  141. package/dist/types/models/MentorSearchResponse.d.ts +0 -35
  142. package/dist/types/models/MentorSession.d.ts +0 -4
  143. package/dist/types/models/MentorSettings.d.ts +0 -60
  144. package/dist/types/models/MentorSettingsPublic.d.ts +0 -46
  145. package/dist/types/models/MentorSettingsRequest.d.ts +0 -62
  146. package/dist/types/models/MentorVisibilityEnum.d.ts +0 -10
  147. package/dist/types/models/MentorWizard.d.ts +0 -4
  148. package/dist/types/models/MessageStatistics.d.ts +0 -5
  149. package/dist/types/models/MessageView.d.ts +0 -10
  150. package/dist/types/models/MessageViewRequest.d.ts +0 -7
  151. package/dist/types/models/MessageViewUpdatResponse.d.ts +0 -3
  152. package/dist/types/models/Metadata.d.ts +0 -5
  153. package/dist/types/models/MetricChange.d.ts +0 -4
  154. package/dist/types/models/ModelCost.d.ts +0 -4
  155. package/dist/types/models/ModerationLog.d.ts +0 -11
  156. package/dist/types/models/NoChatMessagesFound.d.ts +0 -3
  157. package/dist/types/models/NullEnum.d.ts +0 -1
  158. package/dist/types/models/PageContent.d.ts +0 -6
  159. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +0 -7
  160. package/dist/types/models/PaginatedConversationsList.d.ts +0 -7
  161. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +0 -7
  162. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +0 -7
  163. package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
  164. package/dist/types/models/PaginatedEdxCourseList.d.ts +0 -7
  165. package/dist/types/models/PaginatedEmailPromptListList.d.ts +0 -7
  166. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +0 -7
  167. package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +0 -7
  168. package/dist/types/models/PaginatedJobRunList.d.ts +0 -7
  169. package/dist/types/models/PaginatedMCPServerList.d.ts +0 -7
  170. package/dist/types/models/PaginatedMentorList.d.ts +0 -7
  171. package/dist/types/models/PaginatedModerationLogList.d.ts +0 -7
  172. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +0 -7
  173. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +0 -7
  174. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +0 -7
  175. package/dist/types/models/PaginatedRetrieverDocumentEmbeddingList.d.ts +0 -7
  176. package/dist/types/models/PaginatedSectionList.d.ts +0 -7
  177. package/dist/types/models/PaginatedSubSectionList.d.ts +0 -7
  178. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +0 -7
  179. package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
  180. package/dist/types/models/PaginatedUnitList.d.ts +0 -7
  181. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +0 -7
  182. package/dist/types/models/PaginatedVoiceList.d.ts +0 -7
  183. package/dist/types/models/PatchedBotCommand.d.ts +0 -6
  184. package/dist/types/models/PatchedBotCreate.d.ts +0 -12
  185. package/dist/types/models/PatchedCallConfiguration.d.ts +0 -26
  186. package/dist/types/models/PatchedConversations.d.ts +0 -28
  187. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +0 -7
  188. package/dist/types/models/PatchedCredentialRequest.d.ts +0 -14
  189. package/dist/types/models/PatchedDataSet.d.ts +0 -21
  190. package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
  191. package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
  192. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +0 -14
  193. package/dist/types/models/PatchedMCPServer.d.ts +0 -21
  194. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +0 -11
  195. package/dist/types/models/PatchedMentorCreate.d.ts +0 -84
  196. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +0 -41
  197. package/dist/types/models/PatchedPlayWrightScript.d.ts +0 -12
  198. package/dist/types/models/PatchedPrompt.d.ts +0 -22
  199. package/dist/types/models/PatchedSection.d.ts +0 -9
  200. package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
  201. package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
  202. package/dist/types/models/PatchedSubSection.d.ts +0 -9
  203. package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
  204. package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
  205. package/dist/types/models/PatchedUnit.d.ts +0 -11
  206. package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
  207. package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
  208. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
  209. package/dist/types/models/PeriodicAgent.d.ts +0 -42
  210. package/dist/types/models/PeriodicAgentCreate.d.ts +0 -41
  211. package/dist/types/models/PeriodicAgentLog.d.ts +0 -11
  212. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +0 -10
  213. package/dist/types/models/PeriodicTask.d.ts +0 -21
  214. package/dist/types/models/PieChartData.d.ts +0 -5
  215. package/dist/types/models/PieChartSegment.d.ts +0 -4
  216. package/dist/types/models/PinnedMessageCreate.d.ts +0 -9
  217. package/dist/types/models/PinnedMessageGet.d.ts +0 -7
  218. package/dist/types/models/PinnedMessageRequest.d.ts +0 -6
  219. package/dist/types/models/PlayWrightScript.d.ts +0 -12
  220. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +0 -4
  221. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +0 -4
  222. package/dist/types/models/PreviousAgentStatusEnum.d.ts +0 -12
  223. package/dist/types/models/Prompt.d.ts +0 -22
  224. package/dist/types/models/PromptCategory.d.ts +0 -7
  225. package/dist/types/models/PromptFacet.d.ts +0 -17
  226. package/dist/types/models/PromptSearchResponse.d.ts +0 -35
  227. package/dist/types/models/PromptVisibilityEnum.d.ts +0 -10
  228. package/dist/types/models/Provider05cEnum.d.ts +0 -14
  229. package/dist/types/models/Provider637Enum.d.ts +0 -10
  230. package/dist/types/models/Provider63aEnum.d.ts +0 -6
  231. package/dist/types/models/QuestionCardTag.d.ts +0 -8
  232. package/dist/types/models/QuestionRequest.d.ts +0 -15
  233. package/dist/types/models/QuestionResponse.d.ts +0 -10
  234. package/dist/types/models/RatingEnum.d.ts +0 -8
  235. package/dist/types/models/RatingRecord.d.ts +0 -4
  236. package/dist/types/models/RecentlyAccessedMentor.d.ts +0 -8
  237. package/dist/types/models/RecommendCourseBlock.d.ts +0 -3
  238. package/dist/types/models/RecommendCourseResponse.d.ts +0 -3
  239. package/dist/types/models/RecommendedCoursesResponse.d.ts +0 -33
  240. package/dist/types/models/RelatedText.d.ts +0 -3
  241. package/dist/types/models/RequestDataVariable.d.ts +0 -14
  242. package/dist/types/models/ResourceScrappedData.d.ts +0 -13
  243. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +0 -12
  244. package/dist/types/models/ResponseDataVariable.d.ts +0 -14
  245. package/dist/types/models/RetreiverTrainViewRequest.d.ts +0 -10
  246. package/dist/types/models/RetreiverTrainViewResponse.d.ts +0 -6
  247. package/dist/types/models/RetrieveTask.d.ts +0 -3
  248. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +0 -17
  249. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +0 -30
  250. package/dist/types/models/RetrieverRequestSearch.d.ts +0 -10
  251. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +0 -10
  252. package/dist/types/models/RetrieverResponseSearch.d.ts +0 -7
  253. package/dist/types/models/ReuestDataVariableList.d.ts +0 -4
  254. package/dist/types/models/RunMentorEval.d.ts +0 -3
  255. package/dist/types/models/ScanWebhookRequest.d.ts +0 -6
  256. package/dist/types/models/ScanWebhookResponse.d.ts +0 -3
  257. package/dist/types/models/Section.d.ts +0 -9
  258. package/dist/types/models/SectionWithChildren.d.ts +0 -11
  259. package/dist/types/models/SeedMentorsView.d.ts +0 -3
  260. package/dist/types/models/SentimentSummary.d.ts +0 -4
  261. package/dist/types/models/SessionBrowserScreenshot.d.ts +0 -8
  262. package/dist/types/models/SessionDetail.d.ts +0 -6
  263. package/dist/types/models/SessionMemoryStorage.d.ts +0 -6
  264. package/dist/types/models/ShellLogs.d.ts +0 -3
  265. package/dist/types/models/SlackConfig.d.ts +0 -8
  266. package/dist/types/models/SlackUserConfig.d.ts +0 -17
  267. package/dist/types/models/SlackWebhook.d.ts +0 -6
  268. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +0 -3
  269. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +0 -5
  270. package/dist/types/models/StarMentor.d.ts +0 -7
  271. package/dist/types/models/Status6eeEnum.d.ts +0 -12
  272. package/dist/types/models/Step.d.ts +0 -9
  273. package/dist/types/models/StepStatusEnum.d.ts +0 -10
  274. package/dist/types/models/SttProviderEnum.d.ts +0 -12
  275. package/dist/types/models/StudentChatMessage.d.ts +0 -4
  276. package/dist/types/models/StylesView.d.ts +0 -4
  277. package/dist/types/models/SubSection.d.ts +0 -9
  278. package/dist/types/models/SubSectionWithChildren.d.ts +0 -11
  279. package/dist/types/models/TagsView.d.ts +0 -5
  280. package/dist/types/models/TargetSystemEnum.d.ts +0 -8
  281. package/dist/types/models/TaskView.d.ts +0 -3
  282. package/dist/types/models/TeamsConfig.d.ts +0 -7
  283. package/dist/types/models/TeamsWebhook.d.ts +0 -17
  284. package/dist/types/models/TemplateMentor.d.ts +0 -9
  285. package/dist/types/models/TenantMentorTraces.d.ts +0 -6
  286. package/dist/types/models/ThemeEnum.d.ts +0 -8
  287. package/dist/types/models/TonesView.d.ts +0 -4
  288. package/dist/types/models/ToolResponse.d.ts +0 -11
  289. package/dist/types/models/TopicModel.d.ts +0 -3
  290. package/dist/types/models/TopicRecord.d.ts +0 -4
  291. package/dist/types/models/TopicStatistics.d.ts +0 -7
  292. package/dist/types/models/TopicStatisticsResponse.d.ts +0 -6
  293. package/dist/types/models/TopicSummaryView.d.ts +0 -4
  294. package/dist/types/models/TrainChatSessionDocumentView.d.ts +0 -6
  295. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +0 -6
  296. package/dist/types/models/TrainDocumentViewRequest.d.ts +0 -42
  297. package/dist/types/models/TrainDocumentViewResponse.d.ts +0 -15
  298. package/dist/types/models/Training.d.ts +0 -41
  299. package/dist/types/models/TrainingCreate.d.ts +0 -31
  300. package/dist/types/models/TrainingStatusEnum.d.ts +0 -12
  301. package/dist/types/models/TransportEnum.d.ts +0 -8
  302. package/dist/types/models/TrendEntry.d.ts +0 -4
  303. package/dist/types/models/TriggerRequest.d.ts +0 -5
  304. package/dist/types/models/TriggerResponse.d.ts +0 -6
  305. package/dist/types/models/TtsProviderEnum.d.ts +0 -10
  306. package/dist/types/models/TypeC42Enum.d.ts +0 -8
  307. package/dist/types/models/Unit.d.ts +0 -11
  308. package/dist/types/models/UnitWithChildren.d.ts +0 -13
  309. package/dist/types/models/UseMainCreds.d.ts +0 -3
  310. package/dist/types/models/UserAllChatMemoryView.d.ts +0 -7
  311. package/dist/types/models/UserCatalogItemMemoryView.d.ts +0 -14
  312. package/dist/types/models/UserChatByPeriod.d.ts +0 -4
  313. package/dist/types/models/UserChatFeedback.d.ts +0 -14
  314. package/dist/types/models/UserChatFeedbackCount.d.ts +0 -4
  315. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +0 -6
  316. package/dist/types/models/UserChatMemoryStatusView.d.ts +0 -6
  317. package/dist/types/models/UserChatMemoryUpdateView.d.ts +0 -10
  318. package/dist/types/models/UserCountRecord.d.ts +0 -4
  319. package/dist/types/models/UserEdxMemory.d.ts +0 -15
  320. package/dist/types/models/UserMemoryContextRequest.d.ts +0 -13
  321. package/dist/types/models/UserMemoryContextResponse.d.ts +0 -12
  322. package/dist/types/models/UserMetric.d.ts +0 -4
  323. package/dist/types/models/UserMetricsResponse.d.ts +0 -7
  324. package/dist/types/models/UserSentimentCountView.d.ts +0 -4
  325. package/dist/types/models/UserTrendByPeriod.d.ts +0 -5
  326. package/dist/types/models/VectorResult.d.ts +0 -8
  327. package/dist/types/models/VideoCaption.d.ts +0 -3
  328. package/dist/types/models/Voice.d.ts +0 -9
  329. package/dist/types/models/WebResource.d.ts +0 -9
  330. package/dist/types/models/WebResourceCard.d.ts +0 -7
  331. package/dist/types/models/WebResourcesQuery.d.ts +0 -3
  332. package/dist/types/models/WebexConfig.d.ts +0 -10
  333. package/dist/types/models/WebexWebhook.d.ts +0 -4
  334. package/dist/types/models/WhatAppWebHook.d.ts +0 -3
  335. package/dist/types/models/WhatsappConfig.d.ts +0 -11
  336. package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
  337. package/dist/types/services/AiAccountService.d.ts +0 -319
  338. package/dist/types/services/AiAnalyticsService.d.ts +0 -3887
  339. package/dist/types/services/AiBotService.d.ts +0 -642
  340. package/dist/types/services/AiFinetuningService.d.ts +0 -232
  341. package/dist/types/services/AiIndexService.d.ts +0 -408
  342. package/dist/types/services/AiMarketingService.d.ts +0 -38
  343. package/dist/types/services/AiMediaService.d.ts +0 -122
  344. package/dist/types/services/AiMentorService.d.ts +0 -4937
  345. package/dist/types/services/AiPromptService.d.ts +0 -1034
  346. package/src/models/AIGeneratedImage.ts +0 -18
  347. package/src/models/AIUserProfileMemoryRelation.ts +0 -9
  348. package/src/models/AIUserProfileRequest.ts +0 -9
  349. package/src/models/APITokenCost.ts +0 -19
  350. package/src/models/AccessEnum.ts +0 -12
  351. package/src/models/AlignMentorBubbleEnum.ts +0 -12
  352. package/src/models/AnalyticsOverview.ts +0 -12
  353. package/src/models/Answer.ts +0 -16
  354. package/src/models/AssumedKnowledge.ts +0 -9
  355. package/src/models/AssumedKnowledgeLevel.ts +0 -9
  356. package/src/models/AudioToTextRequest.ts +0 -8
  357. package/src/models/AudioToTextResponse.ts +0 -8
  358. package/src/models/Bot.ts +0 -20
  359. package/src/models/BotCommand.ts +0 -11
  360. package/src/models/BotCreate.ts +0 -17
  361. package/src/models/CallAuthenticationRequest.ts +0 -18
  362. package/src/models/CallAuthenticationResponse.ts +0 -26
  363. package/src/models/CallConfiguration.ts +0 -31
  364. package/src/models/CallConfigurationModeEnum.ts +0 -12
  365. package/src/models/ChatHistory.ts +0 -13
  366. package/src/models/ChatHistoryFilterData.ts +0 -14
  367. package/src/models/ChatHistoryFilterUser.ts +0 -10
  368. package/src/models/ChatHistoryItem.ts +0 -10
  369. package/src/models/ChatHistorySessionId.ts +0 -8
  370. package/src/models/ChatSessionRequest.ts +0 -15
  371. package/src/models/ChatSessionResponse.ts +0 -10
  372. package/src/models/CheckDocumentTrainingStatus.ts +0 -15
  373. package/src/models/ComponentBlock.ts +0 -14
  374. package/src/models/ComponentBlockTypeEnum.ts +0 -12
  375. package/src/models/ConversationMessage.ts +0 -16
  376. package/src/models/ConversationRating.ts +0 -11
  377. package/src/models/ConversationSummary.ts +0 -10
  378. package/src/models/ConversationVolume.ts +0 -9
  379. package/src/models/Conversations.ts +0 -33
  380. package/src/models/Cost.ts +0 -8
  381. package/src/models/CostPerTenant.ts +0 -11
  382. package/src/models/CourseCreationTask.ts +0 -36
  383. package/src/models/CourseCreationTaskFile.ts +0 -12
  384. package/src/models/CourseCreationTaskStatusEnum.ts +0 -20
  385. package/src/models/CredentialRequest.ts +0 -19
  386. package/src/models/CrontabSchedule.ts +0 -27
  387. package/src/models/CustomInstructionResponse.ts +0 -18
  388. package/src/models/DataSet.ts +0 -26
  389. package/src/models/DataSetCreate.ts +0 -17
  390. package/src/models/DataSetStatusEnum.ts +0 -16
  391. package/src/models/DateRange.ts +0 -9
  392. package/src/models/DiscordConfig.ts +0 -12
  393. package/src/models/DiscordUserConfig.ts +0 -15
  394. package/src/models/DiscordWebhook.ts +0 -11
  395. package/src/models/Document.ts +0 -46
  396. package/src/models/DocumentFacet.ts +0 -22
  397. package/src/models/DocumentSearchResponse.ts +0 -40
  398. package/src/models/DocumentSettingsResponse.ts +0 -8
  399. package/src/models/EdxCourse.ts +0 -16
  400. package/src/models/ElevenlabsCustomVoice.ts +0 -9
  401. package/src/models/ElevenlabsCustomVoiceResponse.ts +0 -13
  402. package/src/models/EmailPromptDetail.ts +0 -18
  403. package/src/models/EmailPromptList.ts +0 -16
  404. package/src/models/EmailPromptSummary.ts +0 -10
  405. package/src/models/FreeUsageCount.ts +0 -8
  406. package/src/models/FullCourse.ts +0 -18
  407. package/src/models/GreetingMethodEnum.ts +0 -12
  408. package/src/models/GuidedPromptsResponse.ts +0 -8
  409. package/src/models/HeygenMarketingVideoDetail.ts +0 -13
  410. package/src/models/HeygenMarketingVideoList.ts +0 -11
  411. package/src/models/HeygenTemplateRequest.ts +0 -10
  412. package/src/models/HeygenTemplateResponseSingle.ts +0 -11
  413. package/src/models/HeygenVideoDetail.ts +0 -13
  414. package/src/models/HeygenVideoRequest.ts +0 -10
  415. package/src/models/IBLAIPlatformMeta.ts +0 -8
  416. package/src/models/IBLAIPlatformMetaRequest.ts +0 -11
  417. package/src/models/IBLAIPlatformMetaUpdateRequest.ts +0 -15
  418. package/src/models/InputQuestion.ts +0 -11
  419. package/src/models/IntegrationCredential.ts +0 -13
  420. package/src/models/IntialQuestionAnswer.ts +0 -8
  421. package/src/models/JobRun.ts +0 -16
  422. package/src/models/KindEnum.ts +0 -14
  423. package/src/models/LLMCredentialRequest.ts +0 -19
  424. package/src/models/LLMCredentialResponse.ts +0 -13
  425. package/src/models/LLMModelForTenant.ts +0 -11
  426. package/src/models/LLMQuestion.ts +0 -20
  427. package/src/models/LLMResponse.ts +0 -19
  428. package/src/models/LLMTracesListResponse.ts +0 -10
  429. package/src/models/LanguagesView.ts +0 -10
  430. package/src/models/LinkCourseRequest.ts +0 -8
  431. package/src/models/LinkCourseResponse.ts +0 -10
  432. package/src/models/LlmProviderEnum.ts +0 -12
  433. package/src/models/MCPServer.ts +0 -26
  434. package/src/models/MemoryComponentData.ts +0 -10
  435. package/src/models/MemoryComponentMemory.ts +0 -9
  436. package/src/models/MemoryComponentMemoryDetail.ts +0 -13
  437. package/src/models/MemoryComponentResponse.ts +0 -10
  438. package/src/models/MemoryProgress.ts +0 -13
  439. package/src/models/MemoryStatusRequestView.ts +0 -11
  440. package/src/models/MemoryStatusView.ts +0 -11
  441. package/src/models/Mentor.ts +0 -92
  442. package/src/models/MentorAudience.ts +0 -10
  443. package/src/models/MentorCategory.ts +0 -14
  444. package/src/models/MentorCategoryCreate.ts +0 -16
  445. package/src/models/MentorCategoryGroup.ts +0 -16
  446. package/src/models/MentorCategoryGroupCreate.ts +0 -16
  447. package/src/models/MentorCreate.ts +0 -89
  448. package/src/models/MentorCustomVoice.ts +0 -9
  449. package/src/models/MentorCustomVoiceResponse.ts +0 -9
  450. package/src/models/MentorData.ts +0 -12
  451. package/src/models/MentorDetailAnalytics.ts +0 -11
  452. package/src/models/MentorEval.ts +0 -16
  453. package/src/models/MentorEvalQuestion.ts +0 -10
  454. package/src/models/MentorEvalQuestionRequest.ts +0 -9
  455. package/src/models/MentorEvalReport.ts +0 -15
  456. package/src/models/MentorEvalRequest.ts +0 -13
  457. package/src/models/MentorFacet.ts +0 -22
  458. package/src/models/MentorFork.ts +0 -10
  459. package/src/models/MentorFromTemplateRequest.ts +0 -9
  460. package/src/models/MentorFromTemplateWithSettingRequest.ts +0 -52
  461. package/src/models/MentorMemorySettingsRequest.ts +0 -11
  462. package/src/models/MentorMemorySettingsResponse.ts +0 -11
  463. package/src/models/MentorMetadata.ts +0 -10
  464. package/src/models/MentorScenario.ts +0 -11
  465. package/src/models/MentorScenarioPrompt.ts +0 -10
  466. package/src/models/MentorSearchResponse.ts +0 -40
  467. package/src/models/MentorSession.ts +0 -9
  468. package/src/models/MentorSettings.ts +0 -65
  469. package/src/models/MentorSettingsPublic.ts +0 -51
  470. package/src/models/MentorSettingsRequest.ts +0 -67
  471. package/src/models/MentorVisibilityEnum.ts +0 -14
  472. package/src/models/MentorWizard.ts +0 -9
  473. package/src/models/MessageStatistics.ts +0 -10
  474. package/src/models/MessageView.ts +0 -15
  475. package/src/models/MessageViewRequest.ts +0 -12
  476. package/src/models/MessageViewUpdatResponse.ts +0 -8
  477. package/src/models/Metadata.ts +0 -10
  478. package/src/models/MetricChange.ts +0 -9
  479. package/src/models/ModelCost.ts +0 -9
  480. package/src/models/ModerationLog.ts +0 -16
  481. package/src/models/NoChatMessagesFound.ts +0 -8
  482. package/src/models/NullEnum.ts +0 -7
  483. package/src/models/PageContent.ts +0 -11
  484. package/src/models/PaginatedAIGeneratedImageList.ts +0 -12
  485. package/src/models/PaginatedConversationsList.ts +0 -12
  486. package/src/models/PaginatedCourseCreationTaskFileList.ts +0 -12
  487. package/src/models/PaginatedCourseCreationTaskList.ts +0 -12
  488. package/src/models/PaginatedDataSetList.ts +0 -12
  489. package/src/models/PaginatedEdxCourseList.ts +0 -12
  490. package/src/models/PaginatedEmailPromptListList.ts +0 -12
  491. package/src/models/PaginatedHeygenMarketingVideoListList.ts +0 -12
  492. package/src/models/PaginatedHeygenTemplateResponseSingleList.ts +0 -12
  493. package/src/models/PaginatedJobRunList.ts +0 -12
  494. package/src/models/PaginatedMCPServerList.ts +0 -12
  495. package/src/models/PaginatedMentorList.ts +0 -12
  496. package/src/models/PaginatedModerationLogList.ts +0 -12
  497. package/src/models/PaginatedPeriodicAgentList.ts +0 -12
  498. package/src/models/PaginatedPeriodicAgentLogList.ts +0 -12
  499. package/src/models/PaginatedPlayWrightScriptList.ts +0 -12
  500. package/src/models/PaginatedRetrieverDocumentEmbeddingList.ts +0 -12
  501. package/src/models/PaginatedSectionList.ts +0 -12
  502. package/src/models/PaginatedSubSectionList.ts +0 -12
  503. package/src/models/PaginatedTopicStatisticsResponse.ts +0 -12
  504. package/src/models/PaginatedTrainingList.ts +0 -12
  505. package/src/models/PaginatedUnitList.ts +0 -12
  506. package/src/models/PaginatedUserEdxMemoryList.ts +0 -12
  507. package/src/models/PaginatedVoiceList.ts +0 -12
  508. package/src/models/PatchedBotCommand.ts +0 -11
  509. package/src/models/PatchedBotCreate.ts +0 -17
  510. package/src/models/PatchedCallConfiguration.ts +0 -31
  511. package/src/models/PatchedConversations.ts +0 -33
  512. package/src/models/PatchedCourseCreationTaskFile.ts +0 -12
  513. package/src/models/PatchedCredentialRequest.ts +0 -19
  514. package/src/models/PatchedDataSet.ts +0 -26
  515. package/src/models/PatchedDiscordConfig.ts +0 -12
  516. package/src/models/PatchedDiscordUserConfig.ts +0 -15
  517. package/src/models/PatchedLLMCredentialRequest.ts +0 -19
  518. package/src/models/PatchedMCPServer.ts +0 -26
  519. package/src/models/PatchedMentorCategoryGroupCreate.ts +0 -16
  520. package/src/models/PatchedMentorCreate.ts +0 -89
  521. package/src/models/PatchedPeriodicAgentCreate.ts +0 -46
  522. package/src/models/PatchedPlayWrightScript.ts +0 -17
  523. package/src/models/PatchedPrompt.ts +0 -27
  524. package/src/models/PatchedSection.ts +0 -14
  525. package/src/models/PatchedSlackConfig.ts +0 -13
  526. package/src/models/PatchedSlackUserConfig.ts +0 -22
  527. package/src/models/PatchedSubSection.ts +0 -14
  528. package/src/models/PatchedTeamsConfig.ts +0 -12
  529. package/src/models/PatchedTrainingCreate.ts +0 -36
  530. package/src/models/PatchedUnit.ts +0 -16
  531. package/src/models/PatchedWebexConfig.ts +0 -15
  532. package/src/models/PatchedWhatsappConfig.ts +0 -16
  533. package/src/models/PatchedWhatsappUserConfig.ts +0 -15
  534. package/src/models/PeriodicAgent.ts +0 -47
  535. package/src/models/PeriodicAgentCreate.ts +0 -46
  536. package/src/models/PeriodicAgentLog.ts +0 -16
  537. package/src/models/PeriodicAgentLogStatusEnum.ts +0 -14
  538. package/src/models/PeriodicTask.ts +0 -26
  539. package/src/models/PieChartData.ts +0 -10
  540. package/src/models/PieChartSegment.ts +0 -9
  541. package/src/models/PinnedMessageCreate.ts +0 -14
  542. package/src/models/PinnedMessageGet.ts +0 -12
  543. package/src/models/PinnedMessageRequest.ts +0 -11
  544. package/src/models/PlayWrightScript.ts +0 -17
  545. package/src/models/PredictiveAnalyticsRequest.ts +0 -9
  546. package/src/models/PredictiveAnalyticsResponse.ts +0 -9
  547. package/src/models/PreviousAgentStatusEnum.ts +0 -16
  548. package/src/models/Prompt.ts +0 -27
  549. package/src/models/PromptCategory.ts +0 -12
  550. package/src/models/PromptFacet.ts +0 -22
  551. package/src/models/PromptSearchResponse.ts +0 -40
  552. package/src/models/PromptVisibilityEnum.ts +0 -14
  553. package/src/models/Provider05cEnum.ts +0 -18
  554. package/src/models/Provider637Enum.ts +0 -14
  555. package/src/models/Provider63aEnum.ts +0 -10
  556. package/src/models/QuestionCardTag.ts +0 -13
  557. package/src/models/QuestionRequest.ts +0 -20
  558. package/src/models/QuestionResponse.ts +0 -15
  559. package/src/models/RatingEnum.ts +0 -12
  560. package/src/models/RatingRecord.ts +0 -9
  561. package/src/models/RecentlyAccessedMentor.ts +0 -13
  562. package/src/models/RecommendCourseBlock.ts +0 -8
  563. package/src/models/RecommendCourseResponse.ts +0 -8
  564. package/src/models/RecommendedCoursesResponse.ts +0 -38
  565. package/src/models/RelatedText.ts +0 -8
  566. package/src/models/RequestDataVariable.ts +0 -19
  567. package/src/models/ResourceScrappedData.ts +0 -18
  568. package/src/models/ResourceScrappedDataStatusEnum.ts +0 -16
  569. package/src/models/ResponseDataVariable.ts +0 -19
  570. package/src/models/RetreiverTrainViewRequest.ts +0 -15
  571. package/src/models/RetreiverTrainViewResponse.ts +0 -11
  572. package/src/models/RetrieveTask.ts +0 -8
  573. package/src/models/RetrieverDocumentEmbedding.ts +0 -22
  574. package/src/models/RetrieverDocumentEmbeddingRequest.ts +0 -35
  575. package/src/models/RetrieverRequestSearch.ts +0 -15
  576. package/src/models/RetrieverRequestSearchDocument.ts +0 -15
  577. package/src/models/RetrieverResponseSearch.ts +0 -12
  578. package/src/models/ReuestDataVariableList.ts +0 -9
  579. package/src/models/RunMentorEval.ts +0 -8
  580. package/src/models/ScanWebhookRequest.ts +0 -11
  581. package/src/models/ScanWebhookResponse.ts +0 -8
  582. package/src/models/Section.ts +0 -14
  583. package/src/models/SectionWithChildren.ts +0 -16
  584. package/src/models/SeedMentorsView.ts +0 -8
  585. package/src/models/SentimentSummary.ts +0 -9
  586. package/src/models/SessionBrowserScreenshot.ts +0 -13
  587. package/src/models/SessionDetail.ts +0 -11
  588. package/src/models/SessionMemoryStorage.ts +0 -11
  589. package/src/models/ShellLogs.ts +0 -8
  590. package/src/models/SlackConfig.ts +0 -13
  591. package/src/models/SlackUserConfig.ts +0 -22
  592. package/src/models/SlackWebhook.ts +0 -11
  593. package/src/models/SpacedRepetitionLearningPath.ts +0 -8
  594. package/src/models/SpacedRepetitionQuestionStats.ts +0 -10
  595. package/src/models/StarMentor.ts +0 -12
  596. package/src/models/Status6eeEnum.ts +0 -16
  597. package/src/models/Step.ts +0 -14
  598. package/src/models/StepStatusEnum.ts +0 -14
  599. package/src/models/SttProviderEnum.ts +0 -16
  600. package/src/models/StudentChatMessage.ts +0 -9
  601. package/src/models/StylesView.ts +0 -9
  602. package/src/models/SubSection.ts +0 -14
  603. package/src/models/SubSectionWithChildren.ts +0 -16
  604. package/src/models/TagsView.ts +0 -10
  605. package/src/models/TargetSystemEnum.ts +0 -12
  606. package/src/models/TaskView.ts +0 -8
  607. package/src/models/TeamsConfig.ts +0 -12
  608. package/src/models/TeamsWebhook.ts +0 -22
  609. package/src/models/TemplateMentor.ts +0 -14
  610. package/src/models/TenantMentorTraces.ts +0 -11
  611. package/src/models/ThemeEnum.ts +0 -12
  612. package/src/models/TonesView.ts +0 -9
  613. package/src/models/ToolResponse.ts +0 -16
  614. package/src/models/TopicModel.ts +0 -8
  615. package/src/models/TopicRecord.ts +0 -9
  616. package/src/models/TopicStatistics.ts +0 -12
  617. package/src/models/TopicStatisticsResponse.ts +0 -11
  618. package/src/models/TopicSummaryView.ts +0 -9
  619. package/src/models/TrainChatSessionDocumentView.ts +0 -11
  620. package/src/models/TrainChatSessionDocumentViewRequest.ts +0 -11
  621. package/src/models/TrainDocumentViewRequest.ts +0 -47
  622. package/src/models/TrainDocumentViewResponse.ts +0 -20
  623. package/src/models/Training.ts +0 -46
  624. package/src/models/TrainingCreate.ts +0 -36
  625. package/src/models/TrainingStatusEnum.ts +0 -16
  626. package/src/models/TransportEnum.ts +0 -12
  627. package/src/models/TrendEntry.ts +0 -9
  628. package/src/models/TriggerRequest.ts +0 -10
  629. package/src/models/TriggerResponse.ts +0 -11
  630. package/src/models/TtsProviderEnum.ts +0 -14
  631. package/src/models/TypeC42Enum.ts +0 -12
  632. package/src/models/Unit.ts +0 -16
  633. package/src/models/UnitWithChildren.ts +0 -18
  634. package/src/models/UseMainCreds.ts +0 -8
  635. package/src/models/UserAllChatMemoryView.ts +0 -12
  636. package/src/models/UserCatalogItemMemoryView.ts +0 -19
  637. package/src/models/UserChatByPeriod.ts +0 -9
  638. package/src/models/UserChatFeedback.ts +0 -19
  639. package/src/models/UserChatFeedbackCount.ts +0 -9
  640. package/src/models/UserChatMemoryStatusRequestView.ts +0 -11
  641. package/src/models/UserChatMemoryStatusView.ts +0 -11
  642. package/src/models/UserChatMemoryUpdateView.ts +0 -15
  643. package/src/models/UserCountRecord.ts +0 -9
  644. package/src/models/UserEdxMemory.ts +0 -20
  645. package/src/models/UserMemoryContextRequest.ts +0 -18
  646. package/src/models/UserMemoryContextResponse.ts +0 -17
  647. package/src/models/UserMetric.ts +0 -9
  648. package/src/models/UserMetricsResponse.ts +0 -12
  649. package/src/models/UserSentimentCountView.ts +0 -9
  650. package/src/models/UserTrendByPeriod.ts +0 -10
  651. package/src/models/VectorResult.ts +0 -13
  652. package/src/models/VideoCaption.ts +0 -8
  653. package/src/models/Voice.ts +0 -14
  654. package/src/models/WebResource.ts +0 -14
  655. package/src/models/WebResourceCard.ts +0 -12
  656. package/src/models/WebResourcesQuery.ts +0 -8
  657. package/src/models/WebexConfig.ts +0 -15
  658. package/src/models/WebexWebhook.ts +0 -9
  659. package/src/models/WhatAppWebHook.ts +0 -8
  660. package/src/models/WhatsappConfig.ts +0 -16
  661. package/src/models/WhatsappUserConfig.ts +0 -15
  662. package/src/services/AiAccountService.ts +0 -505
  663. package/src/services/AiAnalyticsService.ts +0 -6427
  664. package/src/services/AiBotService.ts +0 -1330
  665. package/src/services/AiFinetuningService.ts +0 -472
  666. package/src/services/AiIndexService.ts +0 -719
  667. package/src/services/AiMarketingService.ts +0 -96
  668. package/src/services/AiMediaService.ts +0 -289
  669. package/src/services/AiMentorService.ts +0 -9108
  670. package/src/services/AiPromptService.ts +0 -1980
@@ -1,3887 +0,0 @@
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
- * @returns OvertimeWithChangeInfo
88
- * @throws ApiError
89
- */
90
- static aiAnalyticsAudienceOrgsActiveUsersOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
91
- org: string;
92
- /**
93
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
94
- */
95
- departmentId?: number;
96
- /**
97
- * end date. ISO 8601
98
- */
99
- endDate?: string;
100
- /**
101
- * Format
102
- *
103
- * * `json` - json
104
- */
105
- format?: 'json';
106
- /**
107
- * Include main platform data
108
- */
109
- includeMainPlatform?: boolean;
110
- /**
111
- * start date. ISO 8601
112
- */
113
- startDate?: string;
114
- }): CancelablePromise<OvertimeWithChangeInfo>;
115
- /**
116
- * Get active user counts on a per-course basis.
117
- *
118
- * This endpoint provides counts of active users for each course within
119
- * the specified date range.
120
- *
121
- * Query Parameters:
122
- * start_date (str, optional): Start date for filtering (ISO format)
123
- * end_date (str, optional): End date for filtering (ISO format)
124
- *
125
- * Returns:
126
- * A list of courses with their active user counts.
127
- *
128
- * Default time range is the last 7 days if no dates are specified.
129
- * @returns ActiveUsersPerCourse
130
- * @throws ApiError
131
- */
132
- static aiAnalyticsAudienceOrgsActiveUsersPerCourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
133
- org: string;
134
- /**
135
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
136
- */
137
- departmentId?: number;
138
- /**
139
- * end date. ISO 8601
140
- */
141
- endDate?: string;
142
- /**
143
- * Format
144
- *
145
- * * `json` - json
146
- */
147
- format?: 'json';
148
- /**
149
- * Include main platform data
150
- */
151
- includeMainPlatform?: boolean;
152
- /**
153
- * start date. ISO 8601
154
- */
155
- startDate?: string;
156
- }): CancelablePromise<ActiveUsersPerCourse>;
157
- /**
158
- * Get a list of active users with activity metrics.
159
- *
160
- * This endpoint provides a paginated list of users who have had activity
161
- * within the specified date range.
162
- *
163
- * Query Parameters:
164
- * start_date (str, optional): Start date for filtering (ISO format)
165
- * end_date (str, optional): End date for filtering (ISO format)
166
- * course_id (str, optional): Filter by course ID
167
- * page (int, optional): Page number for pagination
168
- * length (int, optional): Number of items per page
169
- *
170
- * Returns:
171
- * A paginated list of active users with their activity metrics.
172
- *
173
- * Default time range is the last 7 days if no dates are specified.
174
- * @returns ActiveUsersList
175
- * @throws ApiError
176
- */
177
- static aiAnalyticsAudienceOrgsActiveUsersUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
178
- org: string;
179
- /**
180
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
181
- */
182
- departmentId?: number;
183
- /**
184
- * Format
185
- *
186
- * * `json` - json
187
- */
188
- format?: 'json';
189
- /**
190
- * Include main platform data
191
- */
192
- includeMainPlatform?: boolean;
193
- /**
194
- * Size of data to return
195
- */
196
- length?: number;
197
- /**
198
- * Page offset
199
- */
200
- page?: number;
201
- }): CancelablePromise<ActiveUsersList>;
202
- /**
203
- * Get enrollment or unenrollment counts over time.
204
- *
205
- * This endpoint provides daily counts of new enrollments or unenrollments
206
- * over a specified time period.
207
- *
208
- * Query Parameters:
209
- * start_date (str, optional): Start date for the time range (ISO format)
210
- * end_date (str, optional): End date for the time range (ISO format)
211
- * course_id (str, optional): Filter by course ID
212
- * active (bool): Get enrollments when true, unenrollments when false
213
- *
214
- * Returns:
215
- * Daily counts over the specified time period, with change metrics
216
- * compared to previous periods.
217
- *
218
- * Default time range is the last 7 days if no dates are specified.
219
- * @returns OvertimeWithChangeInfo
220
- * @throws ApiError
221
- */
222
- static aiAnalyticsAudienceOrgsEnrollmentsCoursesOverTimeRetrieve({ courseId, org, active, departmentId, endDate, format, includeMainPlatform, startDate, }: {
223
- courseId: string;
224
- org: string;
225
- /**
226
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
227
- *
228
- * * `y` - y
229
- * * `yes` - yes
230
- * * `true` - true
231
- * * `True` - True
232
- * * `n` - n
233
- * * `no` - no
234
- * * `false` - false
235
- * * `False` - False
236
- */
237
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
238
- /**
239
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
240
- */
241
- departmentId?: number;
242
- /**
243
- * end date. ISO 8601
244
- */
245
- endDate?: string;
246
- /**
247
- * Format
248
- *
249
- * * `json` - json
250
- */
251
- format?: 'json';
252
- /**
253
- * Include main platform data
254
- */
255
- includeMainPlatform?: boolean;
256
- /**
257
- * start date. ISO 8601
258
- */
259
- startDate?: string;
260
- }): CancelablePromise<OvertimeWithChangeInfo>;
261
- /**
262
- * List users enrolled in a specific course.
263
- *
264
- * This endpoint provides a list of users who are enrolled or unenrolled
265
- * in a specified course.
266
- *
267
- * Query Parameters:
268
- * course_id (str): The course ID to get enrollments for
269
- * active (bool): Filter for active enrollments when true, inactive when false
270
- * page (int, optional): Page number for pagination
271
- * length (int, optional): Number of items per page
272
- *
273
- * Returns:
274
- * A paginated list of users with:
275
- * - Username
276
- * - Full name
277
- * - Email
278
- * - Enrollment timestamp
279
- * @returns EnrollmentsPerUser
280
- * @throws ApiError
281
- */
282
- static aiAnalyticsAudienceOrgsEnrollmentsCoursesUsersRetrieve({ courseId, org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
283
- courseId: string;
284
- org: string;
285
- /**
286
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
287
- *
288
- * * `y` - y
289
- * * `yes` - yes
290
- * * `true` - true
291
- * * `True` - True
292
- * * `n` - n
293
- * * `no` - no
294
- * * `false` - false
295
- * * `False` - False
296
- */
297
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
298
- /**
299
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
300
- */
301
- departmentId?: number;
302
- /**
303
- * end date. ISO 8601
304
- */
305
- endDate?: string;
306
- /**
307
- * Format
308
- *
309
- * * `json` - json
310
- */
311
- format?: 'json';
312
- /**
313
- * Include main platform data
314
- */
315
- includeMainPlatform?: boolean;
316
- /**
317
- * Size of data to return
318
- */
319
- length?: number;
320
- /**
321
- * Page offset
322
- */
323
- page?: number;
324
- /**
325
- * start date. ISO 8601
326
- */
327
- startDate?: string;
328
- }): CancelablePromise<EnrollmentsPerUser>;
329
- /**
330
- * Get enrollment or unenrollment counts over time.
331
- *
332
- * This endpoint provides daily counts of new enrollments or unenrollments
333
- * over a specified time period.
334
- *
335
- * Query Parameters:
336
- * start_date (str, optional): Start date for the time range (ISO format)
337
- * end_date (str, optional): End date for the time range (ISO format)
338
- * course_id (str, optional): Filter by course ID
339
- * active (bool): Get enrollments when true, unenrollments when false
340
- *
341
- * Returns:
342
- * Daily counts over the specified time period, with change metrics
343
- * compared to previous periods.
344
- *
345
- * Default time range is the last 7 days if no dates are specified.
346
- * @returns OvertimeWithChangeInfo
347
- * @throws ApiError
348
- */
349
- static aiAnalyticsAudienceOrgsEnrollmentsOverTimeRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, startDate, }: {
350
- org: string;
351
- /**
352
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
353
- *
354
- * * `y` - y
355
- * * `yes` - yes
356
- * * `true` - true
357
- * * `True` - True
358
- * * `n` - n
359
- * * `no` - no
360
- * * `false` - false
361
- * * `False` - False
362
- */
363
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
364
- /**
365
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
366
- */
367
- departmentId?: number;
368
- /**
369
- * end date. ISO 8601
370
- */
371
- endDate?: string;
372
- /**
373
- * Format
374
- *
375
- * * `json` - json
376
- */
377
- format?: 'json';
378
- /**
379
- * Include main platform data
380
- */
381
- includeMainPlatform?: boolean;
382
- /**
383
- * start date. ISO 8601
384
- */
385
- startDate?: string;
386
- }): CancelablePromise<OvertimeWithChangeInfo>;
387
- /**
388
- * List enrollment statistics on a per-course basis.
389
- *
390
- * This endpoint provides enrollment counts for all courses, with options
391
- * to filter for active or inactive enrollments and to include time-based data.
392
- *
393
- * Query Parameters:
394
- * active (bool): Filter for active enrollments when true, inactive when false
395
- * start_date (str, optional): Start date for time-based filtering (ISO format)
396
- * end_date (str, optional): End date for time-based filtering (ISO format)
397
- * page (int, optional): Page number for pagination
398
- * length (int, optional): Number of items per page
399
- *
400
- * Returns:
401
- * A paginated list of courses with their enrollment counts and percentages.
402
- * @returns Enrollments
403
- * @throws ApiError
404
- */
405
- static aiAnalyticsAudienceOrgsEnrollmentsPerCourseRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
406
- org: string;
407
- /**
408
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
409
- *
410
- * * `y` - y
411
- * * `yes` - yes
412
- * * `true` - true
413
- * * `True` - True
414
- * * `n` - n
415
- * * `no` - no
416
- * * `false` - false
417
- * * `False` - False
418
- */
419
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
420
- /**
421
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
422
- */
423
- departmentId?: number;
424
- /**
425
- * end date. ISO 8601
426
- */
427
- endDate?: string;
428
- /**
429
- * Format
430
- *
431
- * * `json` - json
432
- */
433
- format?: 'json';
434
- /**
435
- * Include main platform data
436
- */
437
- includeMainPlatform?: boolean;
438
- /**
439
- * Size of data to return
440
- */
441
- length?: number;
442
- /**
443
- * Page offset
444
- */
445
- page?: number;
446
- /**
447
- * start date. ISO 8601
448
- */
449
- startDate?: string;
450
- }): CancelablePromise<Enrollments>;
451
- /**
452
- * List all learners on the platform with aggregated metrics.
453
- *
454
- * This endpoint returns a paginated list of all learners with key metrics including:
455
- * - Enrollment counts
456
- * - Completion counts
457
- * - Time spent on platform
458
- *
459
- * Query Parameters:
460
- * page (int): Page number for pagination
461
- * length (int): Number of items per page
462
- * search (str): Filter learners by username, email, or name
463
- *
464
- * Returns:
465
- * A paginated list of learners with their associated metrics.
466
- * @returns PerlearnerUserList
467
- * @throws ApiError
468
- */
469
- static aiAnalyticsAudienceOrgsRegisteredUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
470
- org: string;
471
- /**
472
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
473
- */
474
- departmentId?: number;
475
- /**
476
- * Format
477
- *
478
- * * `json` - json
479
- */
480
- format?: 'json';
481
- /**
482
- * Include main platform data
483
- */
484
- includeMainPlatform?: boolean;
485
- /**
486
- * Size of data to return
487
- */
488
- length?: number;
489
- /**
490
- * Page offset
491
- */
492
- page?: number;
493
- /**
494
- * Search string for learner
495
- */
496
- search?: string;
497
- }): CancelablePromise<PerlearnerUserList>;
498
- /**
499
- * Get registered user counts over time.
500
- *
501
- * This endpoint provides daily counts of new user registrations over a
502
- * specified time period.
503
- *
504
- * Query Parameters:
505
- * start_date (str, optional): Start date for the time range (ISO format)
506
- * end_date (str, optional): End date for the time range (ISO format)
507
- *
508
- * Returns:
509
- * Daily registration counts over the specified time period, with change metrics
510
- * compared to previous periods.
511
- *
512
- * Default time range is the last 7 days if no dates are specified.
513
- * @returns OvertimeWithChangeInfo
514
- * @throws ApiError
515
- */
516
- static aiAnalyticsAudienceOrgsRegisteredUsersOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
517
- org: string;
518
- /**
519
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
520
- */
521
- departmentId?: number;
522
- /**
523
- * end date. ISO 8601
524
- */
525
- endDate?: string;
526
- /**
527
- * Format
528
- *
529
- * * `json` - json
530
- */
531
- format?: 'json';
532
- /**
533
- * Include main platform data
534
- */
535
- includeMainPlatform?: boolean;
536
- /**
537
- * start date. ISO 8601
538
- */
539
- startDate?: string;
540
- }): CancelablePromise<OvertimeWithChangeInfo>;
541
- /**
542
- * List enrollment statistics on a per-course basis.
543
- *
544
- * This endpoint provides enrollment counts for all courses, with options
545
- * to filter for active or inactive enrollments and to include time-based data.
546
- *
547
- * Query Parameters:
548
- * active (bool): Filter for active enrollments when true, inactive when false
549
- * start_date (str, optional): Start date for time-based filtering (ISO format)
550
- * end_date (str, optional): End date for time-based filtering (ISO format)
551
- * page (int, optional): Page number for pagination
552
- * length (int, optional): Number of items per page
553
- *
554
- * Returns:
555
- * A paginated list of courses with their enrollment counts and percentages.
556
- * @returns Enrollments
557
- * @throws ApiError
558
- */
559
- static aiAnalyticsAudienceOrgsRegisteredUsersPerCourseRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
560
- org: string;
561
- /**
562
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
563
- *
564
- * * `y` - y
565
- * * `yes` - yes
566
- * * `true` - true
567
- * * `True` - True
568
- * * `n` - n
569
- * * `no` - no
570
- * * `false` - false
571
- * * `False` - False
572
- */
573
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
574
- /**
575
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
576
- */
577
- departmentId?: number;
578
- /**
579
- * end date. ISO 8601
580
- */
581
- endDate?: string;
582
- /**
583
- * Format
584
- *
585
- * * `json` - json
586
- */
587
- format?: 'json';
588
- /**
589
- * Include main platform data
590
- */
591
- includeMainPlatform?: boolean;
592
- /**
593
- * Size of data to return
594
- */
595
- length?: number;
596
- /**
597
- * Page offset
598
- */
599
- page?: number;
600
- /**
601
- * start date. ISO 8601
602
- */
603
- startDate?: string;
604
- }): CancelablePromise<Enrollments>;
605
- /**
606
- * Retrieve paginated LLM usage costs aggregated by tenant.
607
- * @returns CostPerTenant
608
- * @throws ApiError
609
- */
610
- static aiAnalyticsCostsPertenantList({ endDate, startDate, }: {
611
- endDate: string;
612
- startDate: string;
613
- }): CancelablePromise<Array<CostPerTenant>>;
614
- /**
615
- * Get a list of departments with metrics and filtering options.
616
- *
617
- * This endpoint provides a paginated list of departments with aggregated metrics
618
- * about learner performance, course completions, and skill acquisition.
619
- *
620
- * Query Parameters:
621
- * page (int, optional): Page number for pagination
622
- * length (int, optional): Number of items per page
623
- * program (str, optional): Filter by program
624
- * pathway (str, optional): Filter by pathway
625
- * departments (list, optional): Filter by department ids
626
- * department_id (str, optional): Filter by department id
627
- * location (str, optional): Filter by location
628
- * is_enrolled (bool, optional): Filter for departments with enrolled users
629
- * start_date (date, optional): Filter by learner join date (start range)
630
- * end_date (date, optional): Filter by learner join date (end range)
631
- *
632
- * Returns:
633
- * A paginated list of departments with comprehensive metrics.
634
- * @returns GroupList
635
- * @throws ApiError
636
- */
637
- static aiAnalyticsDepartmentsOrgsRetrieve({ org, departmentId, departments, endDate, format, includeMainPlatform, isEnrolled, length, location, page, pathway, program, startDate, }: {
638
- org: string;
639
- /**
640
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
641
- */
642
- departmentId?: number;
643
- /**
644
- * Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
645
- */
646
- departments?: Array<string>;
647
- /**
648
- * Filter by learners date_joined. Start date. ISO 8601
649
- */
650
- endDate?: string;
651
- /**
652
- * Format
653
- *
654
- * * `json` - json
655
- */
656
- format?: 'json';
657
- /**
658
- * Include main platform data
659
- */
660
- includeMainPlatform?: boolean;
661
- /**
662
- * Filter for users who have at least an enro;lment
663
- */
664
- isEnrolled?: boolean | null;
665
- /**
666
- * Size of data to return
667
- */
668
- length?: number;
669
- /**
670
- * Location search string
671
- */
672
- location?: string;
673
- /**
674
- * Page offset
675
- */
676
- page?: number;
677
- /**
678
- * Pathway string
679
- */
680
- pathway?: string;
681
- /**
682
- * Program search string
683
- */
684
- program?: string;
685
- /**
686
- * Filter by learners date_joined. Start date. ISO 8601
687
- */
688
- startDate?: string;
689
- }): CancelablePromise<GroupList>;
690
- /**
691
- * Get engagement metrics on a per-course basis.
692
- *
693
- * This endpoint provides a paginated list of courses with engagement metrics
694
- * including activity counts, time spent, and interaction data.
695
- *
696
- * Query Parameters:
697
- * page (int, optional): Page number for pagination
698
- * length (int, optional): Number of items per page
699
- *
700
- * Returns:
701
- * A paginated list of courses with their engagement metrics.
702
- * @returns EngagementPerCourse
703
- * @throws ApiError
704
- */
705
- static aiAnalyticsEngagementOrgsActivityRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
706
- org: string;
707
- /**
708
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
709
- */
710
- departmentId?: number;
711
- /**
712
- * Format
713
- *
714
- * * `json` - json
715
- */
716
- format?: 'json';
717
- /**
718
- * Include main platform data
719
- */
720
- includeMainPlatform?: boolean;
721
- /**
722
- * Size of data to return
723
- */
724
- length?: number;
725
- /**
726
- * Page offset
727
- */
728
- page?: number;
729
- }): CancelablePromise<EngagementPerCourse>;
730
- /**
731
- * Completion count per user per course across the platform
732
- *
733
- * Query Params
734
- * 1. start_date e.g 2020-10-01
735
- * 2. end_date e.g 2020-10-10
736
- *
737
- * Default result when no query param is added is last_7_days (today inclusive)
738
- * @returns OvertimeWithChangeInfo
739
- * @throws ApiError
740
- */
741
- static aiAnalyticsEngagementOrgsCourseCompletionOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
742
- org: string;
743
- /**
744
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
745
- */
746
- departmentId?: number;
747
- /**
748
- * end date. ISO 8601
749
- */
750
- endDate?: string;
751
- /**
752
- * Format
753
- *
754
- * * `json` - json
755
- */
756
- format?: 'json';
757
- /**
758
- * Include main platform data
759
- */
760
- includeMainPlatform?: boolean;
761
- /**
762
- * start date. ISO 8601
763
- */
764
- startDate?: string;
765
- }): CancelablePromise<OvertimeWithChangeInfo>;
766
- /**
767
- * List course completion metrics on a per-course basis.
768
- *
769
- * This endpoint provides a paginated table of courses with enrollment and
770
- * completion statistics for each course.
771
- *
772
- * Returns:
773
- * A paginated list of courses with:
774
- * - Course identification (ID and name)
775
- * - Enrollment count
776
- * - Completion count
777
- * - Average completion rate
778
- * @returns CourseCompletionPerCourse
779
- * @throws ApiError
780
- */
781
- static aiAnalyticsEngagementOrgsCourseCompletionPerCourseRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
782
- org: string;
783
- /**
784
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
785
- */
786
- departmentId?: number;
787
- /**
788
- * Format
789
- *
790
- * * `json` - json
791
- */
792
- format?: 'json';
793
- /**
794
- * Include main platform data
795
- */
796
- includeMainPlatform?: boolean;
797
- /**
798
- * Size of data to return
799
- */
800
- length?: number;
801
- /**
802
- * Page offset
803
- */
804
- page?: number;
805
- }): CancelablePromise<CourseCompletionPerCourse>;
806
- /**
807
- * Average time spent in secs on a per-day basis
808
- *
809
- * Query Params
810
- * 1. start_date e.g 2020-10-01
811
- * 2. end_date e.g 2020-10-10
812
- * 3. course_id <optional>
813
- *
814
- * Default result when no query param is added is last_7_days (today inclusive)
815
- * @returns AverageOvertime
816
- * @throws ApiError
817
- */
818
- static aiAnalyticsEngagementOrgsCoursesTimeAverageRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
819
- courseId: string;
820
- org: string;
821
- /**
822
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
823
- */
824
- departmentId?: number;
825
- /**
826
- * end date. ISO 8601
827
- */
828
- endDate?: string;
829
- /**
830
- * Format
831
- *
832
- * * `json` - json
833
- */
834
- format?: 'json';
835
- /**
836
- * Include main platform data
837
- */
838
- includeMainPlatform?: boolean;
839
- /**
840
- * start date. ISO 8601
841
- */
842
- startDate?: string;
843
- }): CancelablePromise<AverageOvertime>;
844
- /**
845
- * Time spent per course in secs in a tree like form
846
- *
847
- * Kwargs
848
- * course_id e.g course-v1:Org+Course4+Run
849
- *
850
- * Query Params
851
- * 1. start_date <optional> e.g 2020-10-01
852
- * 2. end_date <optional> e.g 2020-10-10
853
- * @returns TimeDetail
854
- * @throws ApiError
855
- */
856
- static aiAnalyticsEngagementOrgsCoursesTimeDetailRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
857
- courseId: string;
858
- org: string;
859
- /**
860
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
861
- */
862
- departmentId?: number;
863
- /**
864
- * Format
865
- *
866
- * * `json` - json
867
- */
868
- format?: 'json';
869
- /**
870
- * Include main platform data
871
- */
872
- includeMainPlatform?: boolean;
873
- }): CancelablePromise<TimeDetail>;
874
- /**
875
- * Time spent per course in secs on a per-day basis
876
- *
877
- * Query Params
878
- * 1. start_date e.g 2020-10-01
879
- * 2. end_date e.g 2020-10-10
880
- * Kwargs
881
- * 3. course_id
882
- *
883
- * Default result when no query param is added is last_7_days (today inclusive)
884
- * @returns OverTimeWithTotal
885
- * @throws ApiError
886
- */
887
- static aiAnalyticsEngagementOrgsCoursesTimeOverTimeRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
888
- courseId: string;
889
- org: string;
890
- /**
891
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
892
- */
893
- departmentId?: number;
894
- /**
895
- * end date. ISO 8601
896
- */
897
- endDate?: string;
898
- /**
899
- * Format
900
- *
901
- * * `json` - json
902
- */
903
- format?: 'json';
904
- /**
905
- * Include main platform data
906
- */
907
- includeMainPlatform?: boolean;
908
- /**
909
- * start date. ISO 8601
910
- */
911
- startDate?: string;
912
- }): CancelablePromise<OverTimeWithTotal>;
913
- /**
914
- * Time spent by users in a course
915
- *
916
- * Query Params
917
- * course_id e.g course-v1:Org+Course4+Run
918
- * @returns TimeSpentByUsersInCourse
919
- * @throws ApiError
920
- */
921
- static aiAnalyticsEngagementOrgsCoursesTimeUsersRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
922
- courseId: string;
923
- org: string;
924
- /**
925
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
926
- */
927
- departmentId?: number;
928
- /**
929
- * end date. ISO 8601
930
- */
931
- endDate?: string;
932
- /**
933
- * Format
934
- *
935
- * * `json` - json
936
- */
937
- format?: 'json';
938
- /**
939
- * Include main platform data
940
- */
941
- includeMainPlatform?: boolean;
942
- /**
943
- * Size of data to return
944
- */
945
- length?: number;
946
- /**
947
- * Page offset
948
- */
949
- page?: number;
950
- /**
951
- * start date. ISO 8601
952
- */
953
- startDate?: string;
954
- }): CancelablePromise<TimeSpentByUsersInCourse>;
955
- /**
956
- * Time spent within a course in ordered hierarchical format
957
- *
958
- * Kwargs
959
- * 1. course_id e.g course-v1:Org+Course4+Run
960
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
961
- * Query Params
962
- * 3. start_date <optional> e.g 2020-10-01
963
- * 4. end_date <optional> e.g 2020-10-10
964
- * @returns PerLearnerTimeSpentInCourseTree
965
- * @throws ApiError
966
- */
967
- static aiAnalyticsEngagementOrgsCoursesTimeUsersDetailRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
968
- courseId: string;
969
- org: string; /**
970
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
971
- */
972
- departmentId?: number; /**
973
- * end date. ISO 8601
974
- */
975
- endDate?: string; /**
976
- * Format
977
- *
978
- * * `json` - json
979
- */
980
- format?: 'json'; /**
981
- * Include main platform data
982
- */
983
- includeMainPlatform?: boolean; /**
984
- * start date. ISO 8601
985
- */
986
- startDate?: string;
987
- }): CancelablePromise<PerLearnerTimeSpentInCourseTree>;
988
- /**
989
- * Time spent in secs on a per-day basis
990
- *
991
- * Query Params
992
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
993
- * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
994
- * 3. start_date e.g 2020-10-01
995
- * 4. end_date e.g 2020-10-10
996
- *
997
- * Default result when no query param is added is last_7_days (today inclusive)
998
- * @returns OverTimeWithTotal
999
- * @throws ApiError
1000
- */
1001
- static aiAnalyticsEngagementOrgsCoursesTimeUsersOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1002
- courseId: string;
1003
- org: string; /**
1004
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1005
- */
1006
- departmentId?: number; /**
1007
- * end date. ISO 8601
1008
- */
1009
- endDate?: string; /**
1010
- * Format
1011
- *
1012
- * * `json` - json
1013
- */
1014
- format?: 'json'; /**
1015
- * Include main platform data
1016
- */
1017
- includeMainPlatform?: boolean; /**
1018
- * start date. ISO 8601
1019
- */
1020
- startDate?: string;
1021
- }): CancelablePromise<OverTimeWithTotal>;
1022
- /**
1023
- * Get video engagement metrics for a specific course.
1024
- *
1025
- * This endpoint provides detailed video engagement statistics for a single course,
1026
- * including view counts, completion rates, and time spent on videos.
1027
- *
1028
- * Query Parameters:
1029
- * course_id (str): The course ID to get video engagement data for
1030
- *
1031
- * Returns:
1032
- * Detailed video engagement metrics for the specified course.
1033
- * @returns VideosSpecificCourse
1034
- * @throws ApiError
1035
- */
1036
- static aiAnalyticsEngagementOrgsCoursesVideosRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
1037
- courseId: string;
1038
- org: string;
1039
- /**
1040
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1041
- */
1042
- departmentId?: number;
1043
- /**
1044
- * Format
1045
- *
1046
- * * `json` - json
1047
- */
1048
- format?: 'json';
1049
- /**
1050
- * Include main platform data
1051
- */
1052
- includeMainPlatform?: boolean;
1053
- }): CancelablePromise<VideosSpecificCourse>;
1054
- /**
1055
- * Get video watch counts over time.
1056
- *
1057
- * This endpoint provides daily counts of videos watched over a specified time period,
1058
- * with options to filter by course or user.
1059
- *
1060
- * Query Parameters:
1061
- * start_date (str, optional): Start date for the time range (ISO format)
1062
- * end_date (str, optional): End date for the time range (ISO format)
1063
- * course_id (str, optional): Filter by course ID
1064
- * user_id (str, optional): Filter by username or email
1065
- *
1066
- * Returns:
1067
- * Daily video watch counts over the specified time period.
1068
- *
1069
- * Default time range is the last 7 days if no dates are specified.
1070
- *
1071
- * Access Control:
1072
- * - Platform admins can access any video watch data
1073
- * - Learners can access their own video watch data
1074
- * @returns OverTimeWithTotal
1075
- * @throws ApiError
1076
- */
1077
- static aiAnalyticsEngagementOrgsCoursesVideosOverTimeRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1078
- courseId: string;
1079
- org: string;
1080
- /**
1081
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1082
- */
1083
- departmentId?: number;
1084
- /**
1085
- * end date. ISO 8601
1086
- */
1087
- endDate?: string;
1088
- /**
1089
- * Format
1090
- *
1091
- * * `json` - json
1092
- */
1093
- format?: 'json';
1094
- /**
1095
- * Include main platform data
1096
- */
1097
- includeMainPlatform?: boolean;
1098
- /**
1099
- * start date. ISO 8601
1100
- */
1101
- startDate?: string;
1102
- }): CancelablePromise<OverTimeWithTotal>;
1103
- /**
1104
- * Get a summary of video watch statistics for a specific course.
1105
- *
1106
- * This endpoint provides a structured summary of video watch data for a course,
1107
- * organized in a tree-like format by course sections and subsections.
1108
- *
1109
- * Query Parameters:
1110
- * course_id (str): The course ID to get video summary for
1111
- *
1112
- * Returns:
1113
- * A hierarchical structure of video watch data for the course, including:
1114
- * - Section and subsection organization
1115
- * - Video identification and metadata
1116
- * - Watch counts and completion rates
1117
- * @returns VideosInCourseSummary
1118
- * @throws ApiError
1119
- */
1120
- static aiAnalyticsEngagementOrgsCoursesVideosSummaryRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
1121
- courseId: string;
1122
- org: string;
1123
- /**
1124
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1125
- */
1126
- departmentId?: number;
1127
- /**
1128
- * Format
1129
- *
1130
- * * `json` - json
1131
- */
1132
- format?: 'json';
1133
- /**
1134
- * Include main platform data
1135
- */
1136
- includeMainPlatform?: boolean;
1137
- }): CancelablePromise<VideosInCourseSummary>;
1138
- /**
1139
- * List of users' videos completed records for a specific course
1140
- *
1141
- * Kwargs
1142
- * course_id e.g course-v1:Org+Course4+Run
1143
- * @returns WatchedVideosPerUser
1144
- * @throws ApiError
1145
- */
1146
- static aiAnalyticsEngagementOrgsCoursesVideosUsersRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
1147
- courseId: string;
1148
- org: string;
1149
- /**
1150
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1151
- */
1152
- departmentId?: number;
1153
- /**
1154
- * Format
1155
- *
1156
- * * `json` - json
1157
- */
1158
- format?: 'json';
1159
- /**
1160
- * Include main platform data
1161
- */
1162
- includeMainPlatform?: boolean;
1163
- }): CancelablePromise<WatchedVideosPerUser>;
1164
- /**
1165
- * Average time spent by a learner in enrolled courses. Gives a rough estimate of whats the average time
1166
- * that would be spent by a learner in a course
1167
- *
1168
- * Query Params
1169
- * 1. start_date e.g 2020-10-01
1170
- * 2. end_date e.g 2020-10-10
1171
- * @returns AverageOvertime
1172
- * @throws ApiError
1173
- */
1174
- static aiAnalyticsEngagementOrgsTimeAveragePerlearnerPercourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1175
- org: string;
1176
- /**
1177
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1178
- */
1179
- departmentId?: number;
1180
- /**
1181
- * end date. ISO 8601
1182
- */
1183
- endDate?: string;
1184
- /**
1185
- * Format
1186
- *
1187
- * * `json` - json
1188
- */
1189
- format?: 'json';
1190
- /**
1191
- * Include main platform data
1192
- */
1193
- includeMainPlatform?: boolean;
1194
- /**
1195
- * start date. ISO 8601
1196
- */
1197
- startDate?: string;
1198
- }): CancelablePromise<AverageOvertime>;
1199
- /**
1200
- * Average time spent in secs on a per-day basis
1201
- *
1202
- * Query Params
1203
- * 1. start_date e.g 2020-10-01
1204
- * 2. end_date e.g 2020-10-10
1205
- * 3. course_id <optional>
1206
- *
1207
- * Default result when no query param is added is last_7_days (today inclusive)
1208
- * @returns AverageOvertime
1209
- * @throws ApiError
1210
- */
1211
- static aiAnalyticsEngagementOrgsTimeAverageWithOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1212
- org: string;
1213
- /**
1214
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1215
- */
1216
- departmentId?: number;
1217
- /**
1218
- * end date. ISO 8601
1219
- */
1220
- endDate?: string;
1221
- /**
1222
- * Format
1223
- *
1224
- * * `json` - json
1225
- */
1226
- format?: 'json';
1227
- /**
1228
- * Include main platform data
1229
- */
1230
- includeMainPlatform?: boolean;
1231
- /**
1232
- * start date. ISO 8601
1233
- */
1234
- startDate?: string;
1235
- }): CancelablePromise<AverageOvertime>;
1236
- /**
1237
- * Get time spent on the platform over time.
1238
- *
1239
- * This endpoint provides daily time spent values (in seconds) across the
1240
- * platform over a specified time period.
1241
- *
1242
- * Query Parameters:
1243
- * start_date (str, optional): Start date for the time range (ISO format)
1244
- * end_date (str, optional): End date for the time range (ISO format)
1245
- *
1246
- * Returns:
1247
- * Daily time spent values over the specified time period, with change metrics
1248
- * compared to previous periods.
1249
- *
1250
- * Default time range is the last 7 days if no dates are specified.
1251
- * @returns OvertimeWithChangeInfo
1252
- * @throws ApiError
1253
- */
1254
- static aiAnalyticsEngagementOrgsTimeOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1255
- org: string;
1256
- /**
1257
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1258
- */
1259
- departmentId?: number;
1260
- /**
1261
- * end date. ISO 8601
1262
- */
1263
- endDate?: string;
1264
- /**
1265
- * Format
1266
- *
1267
- * * `json` - json
1268
- */
1269
- format?: 'json';
1270
- /**
1271
- * Include main platform data
1272
- */
1273
- includeMainPlatform?: boolean;
1274
- /**
1275
- * start date. ISO 8601
1276
- */
1277
- startDate?: string;
1278
- }): CancelablePromise<OvertimeWithChangeInfo>;
1279
- /**
1280
- * Get time spent statistics on a per-course basis.
1281
- *
1282
- * This endpoint provides a paginated list of courses with the total time
1283
- * spent by users in each course.
1284
- *
1285
- * Query Parameters:
1286
- * start_date (str, optional): Start date for filtering (ISO format)
1287
- * end_date (str, optional): End date for filtering (ISO format)
1288
- * page (int, optional): Page number for pagination
1289
- * length (int, optional): Number of items per page
1290
- *
1291
- * Returns:
1292
- * A paginated list of courses with:
1293
- * - Course identification (ID and name)
1294
- * - Total time spent (in seconds)
1295
- * - Formatted time spent (human-readable)
1296
- * - Percentage of total platform time
1297
- * @returns TimeSpentPerCourse
1298
- * @throws ApiError
1299
- */
1300
- static aiAnalyticsEngagementOrgsTimePerCourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
1301
- org: string;
1302
- /**
1303
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1304
- */
1305
- departmentId?: number;
1306
- /**
1307
- * end date. ISO 8601
1308
- */
1309
- endDate?: string;
1310
- /**
1311
- * Format
1312
- *
1313
- * * `json` - json
1314
- */
1315
- format?: 'json';
1316
- /**
1317
- * Include main platform data
1318
- */
1319
- includeMainPlatform?: boolean;
1320
- /**
1321
- * Size of data to return
1322
- */
1323
- length?: number;
1324
- /**
1325
- * Page offset
1326
- */
1327
- page?: number;
1328
- /**
1329
- * start date. ISO 8601
1330
- */
1331
- startDate?: string;
1332
- }): CancelablePromise<TimeSpentPerCourse>;
1333
- /**
1334
- * Get video engagement metrics on a per-course basis.
1335
- *
1336
- * This endpoint provides a paginated list of courses with video engagement metrics
1337
- * including view counts, completion rates, and time spent on videos.
1338
- *
1339
- * Query Parameters:
1340
- * page (int, optional): Page number for pagination
1341
- * length (int, optional): Number of items per page
1342
- *
1343
- * Returns:
1344
- * A paginated list of courses with their video engagement metrics.
1345
- * @returns VideoEngagementPerCourse
1346
- * @throws ApiError
1347
- */
1348
- static aiAnalyticsEngagementOrgsVideosRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
1349
- org: string;
1350
- /**
1351
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1352
- */
1353
- departmentId?: number;
1354
- /**
1355
- * Format
1356
- *
1357
- * * `json` - json
1358
- */
1359
- format?: 'json';
1360
- /**
1361
- * Include main platform data
1362
- */
1363
- includeMainPlatform?: boolean;
1364
- /**
1365
- * Size of data to return
1366
- */
1367
- length?: number;
1368
- /**
1369
- * Page offset
1370
- */
1371
- page?: number;
1372
- }): CancelablePromise<VideoEngagementPerCourse>;
1373
- /**
1374
- * Get video watch counts over time.
1375
- *
1376
- * This endpoint provides daily counts of videos watched over a specified time period,
1377
- * with options to filter by course or user.
1378
- *
1379
- * Query Parameters:
1380
- * start_date (str, optional): Start date for the time range (ISO format)
1381
- * end_date (str, optional): End date for the time range (ISO format)
1382
- * course_id (str, optional): Filter by course ID
1383
- * user_id (str, optional): Filter by username or email
1384
- *
1385
- * Returns:
1386
- * Daily video watch counts over the specified time period.
1387
- *
1388
- * Default time range is the last 7 days if no dates are specified.
1389
- *
1390
- * Access Control:
1391
- * - Platform admins can access any video watch data
1392
- * - Learners can access their own video watch data
1393
- * @returns OverTimeWithTotal
1394
- * @throws ApiError
1395
- */
1396
- static aiAnalyticsEngagementOrgsVideosOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1397
- org: string;
1398
- /**
1399
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1400
- */
1401
- departmentId?: number;
1402
- /**
1403
- * end date. ISO 8601
1404
- */
1405
- endDate?: string;
1406
- /**
1407
- * Format
1408
- *
1409
- * * `json` - json
1410
- */
1411
- format?: 'json';
1412
- /**
1413
- * Include main platform data
1414
- */
1415
- includeMainPlatform?: boolean;
1416
- /**
1417
- * start date. ISO 8601
1418
- */
1419
- startDate?: string;
1420
- }): CancelablePromise<OverTimeWithTotal>;
1421
- /**
1422
- * Retrieve average message counts per session over time.
1423
- *
1424
- * This endpoint returns data on the average number of messages exchanged in each
1425
- * conversation session within a specified date range, with options for filtering
1426
- * by mentor and aggregating by different time periods (hourly, daily, weekly).
1427
- *
1428
- * Args:
1429
- * request: The HTTP request containing filter query parameters.
1430
- * org: Organization key identifier.
1431
- *
1432
- * Returns:
1433
- * Response: Time series of average message counts and session totals.
1434
- *
1435
- * Raises:
1436
- * NotFound: If the specified organization does not exist.
1437
- * BadRequest: If the provided parameters are invalid.
1438
- *
1439
- * Query Parameters:
1440
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1441
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1442
- * mentor_id (str): Filter by mentor unique ID.
1443
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1444
- * @returns MessageStatistics
1445
- * @throws ApiError
1446
- */
1447
- static aiAnalyticsOrgsUsersAverageMessagesPerSessionList({ endDate, org, startDate, userId, aggregation, groupBy, mentorId, }: {
1448
- /**
1449
- * End date for filtering (YYYY-MM-DD)
1450
- */
1451
- endDate: string;
1452
- org: string;
1453
- /**
1454
- * Start date for filtering (YYYY-MM-DD)
1455
- */
1456
- startDate: string;
1457
- userId: string;
1458
- /**
1459
- * Time aggregation level (hourly, daily, weekly)
1460
- */
1461
- aggregation?: 'daily' | 'hourly' | 'weekly';
1462
- groupBy?: string;
1463
- /**
1464
- * Filter by mentor unique ID
1465
- */
1466
- mentorId?: string;
1467
- }): CancelablePromise<Array<MessageStatistics>>;
1468
- /**
1469
- * API viewset for retrieving and filtering chat message history.
1470
- *
1471
- * This viewset provides endpoints for retrieving chat message history
1472
- * within an organization, with extensive filtering options by date range,
1473
- * user, topic, mentor, and sentiment.
1474
- *
1475
- * Permissions:
1476
- * - Restricted to platform administrators only
1477
- * @returns PaginatedConversationsList
1478
- * @throws ApiError
1479
- */
1480
- static aiAnalyticsOrgsUsersChatHistoryList({ org, userId, endDate, filterUserId, mentor, page, pageSize, sentiment, startDate, topics, }: {
1481
- org: string;
1482
- endDate?: string;
1483
- filterUserId?: string;
1484
- mentor?: string; /**
1485
- * A page number within the paginated result set.
1486
- */
1487
- page?: number; /**
1488
- * Number of results to return per page.
1489
- */
1490
- pageSize?: number;
1491
- sentiment?: string;
1492
- startDate?: string;
1493
- topics?: string;
1494
- }): CancelablePromise<PaginatedConversationsList>;
1495
- /**
1496
- * API viewset for retrieving and filtering chat message history.
1497
- *
1498
- * This viewset provides endpoints for retrieving chat message history
1499
- * within an organization, with extensive filtering options by date range,
1500
- * user, topic, mentor, and sentiment.
1501
- *
1502
- * Permissions:
1503
- * - Restricted to platform administrators only
1504
- * @returns Conversations
1505
- * @throws ApiError
1506
- */
1507
- static aiAnalyticsOrgsUsersChatHistoryCreate({ org, userId, requestBody, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
1508
- org: string;
1509
- requestBody: Conversations;
1510
- endDate?: string;
1511
- filterUserId?: string;
1512
- mentor?: string;
1513
- sentiment?: string;
1514
- startDate?: string;
1515
- topics?: string;
1516
- }): CancelablePromise<Conversations>;
1517
- /**
1518
- * Retrieve filter options for chat message history.
1519
- *
1520
- * This endpoint returns data on available filter options for the chat message
1521
- * history endpoint, including topics, date ranges (weekly or monthly),
1522
- * sentiments, and users who have chat history.
1523
- *
1524
- * Args:
1525
- * request: The HTTP request containing query parameters.
1526
- * org: Organization key identifier.
1527
- *
1528
- * Returns:
1529
- * Response: Available filter options for chat message history.
1530
- *
1531
- * Raises:
1532
- * NotFound: If the specified organization does not exist.
1533
- *
1534
- * Query Parameters:
1535
- * monthly_range (bool): Whether to return monthly or weekly date ranges.
1536
- * mentor_id (str): Filter users by those who have chatted with a specific mentor.
1537
- * @returns ChatHistoryFilterData
1538
- * @throws ApiError
1539
- */
1540
- static aiAnalyticsOrgsUsersChatHistoryFilterRetrieve({ org, userId, endDate, mentorId, monthlyRange, startDate, }: {
1541
- org: string;
1542
- endDate?: string;
1543
- mentorId?: string;
1544
- monthlyRange?: boolean;
1545
- startDate?: string;
1546
- }): CancelablePromise<ChatHistoryFilterData>;
1547
- /**
1548
- * API viewset for retrieving and filtering chat message history.
1549
- *
1550
- * This viewset provides endpoints for retrieving chat message history
1551
- * within an organization, with extensive filtering options by date range,
1552
- * user, topic, mentor, and sentiment.
1553
- *
1554
- * Permissions:
1555
- * - Restricted to platform administrators only
1556
- * @returns Conversations
1557
- * @throws ApiError
1558
- */
1559
- static aiAnalyticsOrgsUsersChatHistoryRetrieve({ id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
1560
- id: string;
1561
- org: string;
1562
- endDate?: string;
1563
- filterUserId?: string;
1564
- mentor?: string;
1565
- sentiment?: string;
1566
- startDate?: string;
1567
- topics?: string;
1568
- }): CancelablePromise<Conversations>;
1569
- /**
1570
- * API viewset for retrieving and filtering chat message history.
1571
- *
1572
- * This viewset provides endpoints for retrieving chat message history
1573
- * within an organization, with extensive filtering options by date range,
1574
- * user, topic, mentor, and sentiment.
1575
- *
1576
- * Permissions:
1577
- * - Restricted to platform administrators only
1578
- * @returns Conversations
1579
- * @throws ApiError
1580
- */
1581
- static aiAnalyticsOrgsUsersChatHistoryUpdate({ id, org, userId, requestBody, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
1582
- id: string;
1583
- org: string;
1584
- requestBody: Conversations;
1585
- endDate?: string;
1586
- filterUserId?: string;
1587
- mentor?: string;
1588
- sentiment?: string;
1589
- startDate?: string;
1590
- topics?: string;
1591
- }): CancelablePromise<Conversations>;
1592
- /**
1593
- * API viewset for retrieving and filtering chat message history.
1594
- *
1595
- * This viewset provides endpoints for retrieving chat message history
1596
- * within an organization, with extensive filtering options by date range,
1597
- * user, topic, mentor, and sentiment.
1598
- *
1599
- * Permissions:
1600
- * - Restricted to platform administrators only
1601
- * @returns Conversations
1602
- * @throws ApiError
1603
- */
1604
- static aiAnalyticsOrgsUsersChatHistoryPartialUpdate({ id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, requestBody, }: {
1605
- id: string;
1606
- org: string;
1607
- endDate?: string;
1608
- filterUserId?: string;
1609
- mentor?: string;
1610
- sentiment?: string;
1611
- startDate?: string;
1612
- topics?: string;
1613
- requestBody?: PatchedConversations;
1614
- }): CancelablePromise<Conversations>;
1615
- /**
1616
- * API viewset for retrieving and filtering chat message history.
1617
- *
1618
- * This viewset provides endpoints for retrieving chat message history
1619
- * within an organization, with extensive filtering options by date range,
1620
- * user, topic, mentor, and sentiment.
1621
- *
1622
- * Permissions:
1623
- * - Restricted to platform administrators only
1624
- * @returns void
1625
- * @throws ApiError
1626
- */
1627
- static aiAnalyticsOrgsUsersChatHistoryDestroy({ id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
1628
- id: string;
1629
- org: string;
1630
- endDate?: string;
1631
- filterUserId?: string;
1632
- mentor?: string;
1633
- sentiment?: string;
1634
- startDate?: string;
1635
- topics?: string;
1636
- }): CancelablePromise<void>;
1637
- /**
1638
- * Retrieve conversation volume data over time.
1639
- *
1640
- * This endpoint returns data on the number of conversations that occurred
1641
- * within a specified date range, with options for different time aggregations
1642
- * (hourly, daily, weekly). Results can be filtered by mentor.
1643
- *
1644
- * Args:
1645
- * request: The HTTP request containing filter query parameters.
1646
- * org: Organization key identifier.
1647
- * user_id: User identifier (not used in the implementation).
1648
- *
1649
- * Returns:
1650
- * Response: Time series data of conversation counts.
1651
- *
1652
- * Raises:
1653
- * NotFound: If the specified organization does not exist.
1654
- * BadRequest: If the provided parameters are invalid.
1655
- *
1656
- * Query Parameters:
1657
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1658
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1659
- * mentor_id (str): Filter by mentor unique ID.
1660
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1661
- * @returns ConversationVolume
1662
- * @throws ApiError
1663
- */
1664
- static aiAnalyticsOrgsUsersConversationList({ endDate, org, startDate, userId, aggregation, mentorId, }: {
1665
- /**
1666
- * End date for filtering (YYYY-MM-DD)
1667
- */
1668
- endDate: string;
1669
- org: string;
1670
- /**
1671
- * Start date for filtering (YYYY-MM-DD)
1672
- */
1673
- startDate: string;
1674
- userId: string;
1675
- /**
1676
- * Time aggregation level (hourly, daily, weekly)
1677
- */
1678
- aggregation?: 'daily' | 'hourly' | 'weekly';
1679
- /**
1680
- * Filter by mentor unique ID
1681
- */
1682
- mentorId?: string;
1683
- }): CancelablePromise<Array<ConversationVolume>>;
1684
- /**
1685
- * Retrieve a summary of conversation metrics.
1686
- *
1687
- * This endpoint returns aggregated metrics about conversations within an organization,
1688
- * including:
1689
- * - Total number of conversations
1690
- * - Total number of human messages
1691
- * - Total number of AI messages
1692
- *
1693
- * Results can be filtered by mentor.
1694
- *
1695
- * Args:
1696
- * request: The HTTP request containing filter query parameters.
1697
- * org: Organization key identifier.
1698
- *
1699
- * Returns:
1700
- * Response: Summary of conversation metrics.
1701
- *
1702
- * Raises:
1703
- * NotFound: If the specified organization does not exist.
1704
- *
1705
- * Query Parameters:
1706
- * mentor_id (str): Filter by mentor unique ID.
1707
- * @returns ConversationSummary
1708
- * @throws ApiError
1709
- */
1710
- static aiAnalyticsOrgsUsersConversationSummaryRetrieve({ org, userId, groupBy, mentorId, }: {
1711
- org: string;
1712
- groupBy?: string; /**
1713
- * Filter by mentor unique ID
1714
- */
1715
- mentorId?: string;
1716
- }): CancelablePromise<ConversationSummary>;
1717
- /**
1718
- * Retrieve the model costs for a tenant
1719
- *
1720
- * Filter parameters for period are start_date and enddate
1721
- *
1722
- * Accessible to tenant Admins only.
1723
- * @returns ModelCost
1724
- * @throws ApiError
1725
- */
1726
- static aiAnalyticsOrgsUsersCostsModelRetrieve({ endDate, org, startDate, userId, }: {
1727
- endDate: string;
1728
- org: string;
1729
- startDate: string;
1730
- }): CancelablePromise<ModelCost>;
1731
- /**
1732
- * Retrieve LLM usage costs aggregated by mentor.
1733
- *
1734
- * This endpoint returns data on the total cost of LLM usage for each mentor
1735
- * within a specified date range, with pagination support. The costs are
1736
- * calculated by summing the costs of all observations associated with
1737
- * traces from the mentor's sessions.
1738
- *
1739
- * Args:
1740
- * request: The HTTP request containing filter query parameters.
1741
- * org: Organization key identifier.
1742
- *
1743
- * Returns:
1744
- * Response: Paginated list of mentors with their total LLM usage costs.
1745
- *
1746
- * Raises:
1747
- * NotFound: If the specified organization does not exist.
1748
- * BadRequest: If the provided parameters are invalid.
1749
- *
1750
- * Query Parameters:
1751
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1752
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1753
- * limit (int): Number of results per page - default: 5.
1754
- * offset (int): Offset for pagination - default: 0.
1755
- * @returns TenantMentorTraces
1756
- * @throws ApiError
1757
- */
1758
- static aiAnalyticsOrgsUsersCostsPermentorRetrieve({ endDate, org, startDate, userId, }: {
1759
- endDate: string;
1760
- org: string;
1761
- startDate: string;
1762
- }): CancelablePromise<TenantMentorTraces>;
1763
- /**
1764
- * Retrieve LLM usage costs aggregated by user.
1765
- *
1766
- * This endpoint returns data on the total cost of LLM usage for each user
1767
- * within a specified date range, with pagination support. The costs are
1768
- * calculated by summing the costs of all observations associated with
1769
- * traces from the user's sessions.
1770
- *
1771
- * Args:
1772
- * request: The HTTP request containing filter query parameters.
1773
- * org: Organization key identifier.
1774
- *
1775
- * Returns:
1776
- * Response: Paginated list of users with their total LLM usage costs.
1777
- *
1778
- * Raises:
1779
- * NotFound: If the specified organization does not exist.
1780
- * BadRequest: If the provided parameters are invalid.
1781
- *
1782
- * Query Parameters:
1783
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1784
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1785
- * limit (int): Number of results per page - default: 10.
1786
- * offset (int): Offset for pagination - default: 0.
1787
- * @returns LLMTracesListResponse
1788
- * @throws ApiError
1789
- */
1790
- static aiAnalyticsOrgsUsersCostsPeruserRetrieve({ endDate, org, startDate, userId, }: {
1791
- endDate: string;
1792
- org: string;
1793
- startDate: string;
1794
- }): CancelablePromise<LLMTracesListResponse>;
1795
- /**
1796
- * Retrieve summary statistics about mentors.
1797
- *
1798
- * This endpoint returns aggregated statistics about mentors within an organization,
1799
- * including total mentors, active mentors (mentors with at least one session),
1800
- * questions answered, and ratings.
1801
- *
1802
- * Args:
1803
- * request: The HTTP request.
1804
- * org: Organization key identifier.
1805
- *
1806
- * Returns:
1807
- * Response: Summary statistics about mentors.
1808
- *
1809
- * Raises:
1810
- * NotFound: If the specified organization does not exist.
1811
- * @returns MentorDetailAnalytics
1812
- * @throws ApiError
1813
- */
1814
- static aiAnalyticsOrgsUsersMentorDetailRetrieve({ org, userId, }: {
1815
- org: string;
1816
- }): CancelablePromise<MentorDetailAnalytics>;
1817
- /**
1818
- * Retrieve summary statistics about mentors.
1819
- *
1820
- * This endpoint returns aggregated statistics about mentors within an organization,
1821
- * including total mentors, active mentors (mentors with at least one session),
1822
- * questions answered, and ratings.
1823
- *
1824
- * Args:
1825
- * request: The HTTP request.
1826
- * org: Organization key identifier.
1827
- *
1828
- * Returns:
1829
- * Response: Summary statistics about mentors.
1830
- *
1831
- * Raises:
1832
- * NotFound: If the specified organization does not exist.
1833
- * @returns MentorDetailAnalytics
1834
- * @throws ApiError
1835
- */
1836
- static aiAnalyticsOrgsUsersMentorSummaryRetrieve({ org, userId, }: {
1837
- org: string;
1838
- }): CancelablePromise<MentorDetailAnalytics>;
1839
- /**
1840
- * Retrieve LLM usage costs for a specific mentor.
1841
- *
1842
- * This endpoint returns data on the total cost of LLM usage for a specific mentor
1843
- * within a specified date range. The cost is calculated by summing the costs
1844
- * of all observations associated with traces from the tenant's sessions.
1845
- *
1846
- * Args:
1847
- * request: The HTTP request containing filter query parameters.
1848
- * org: Organization key identifier.
1849
- * mentor_unique_id: User key identifier.
1850
- *
1851
- * Returns:
1852
- * Response: Total LLM usage cost for the specified tenant.
1853
- *
1854
- * Raises:
1855
- * NotFound: If the specified organization does not exist.
1856
- * BadRequest: If the provided parameters are invalid.
1857
- *
1858
- * Query Parameters:
1859
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1860
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1861
- * @returns Cost
1862
- * @throws ApiError
1863
- */
1864
- static aiAnalyticsOrgsUsersMentorsCostRetrieve({ endDate, mentorUniqueId, org, startDate, userId, }: {
1865
- endDate: string;
1866
- mentorUniqueId: string;
1867
- org: string;
1868
- startDate: string;
1869
- }): CancelablePromise<Cost>;
1870
- /**
1871
- * Retrieve the most discussed topics over time.
1872
- *
1873
- * This endpoint returns data on the frequency of topics discussed in conversations
1874
- * within a specified date range, with options for filtering by mentor and
1875
- * aggregating by different time periods (hourly, daily, weekly).
1876
- *
1877
- * Args:
1878
- * request: The HTTP request containing filter query parameters.
1879
- * org: Organization key identifier.
1880
- *
1881
- * Returns:
1882
- * Response: List of topics with their conversation counts, ordered by frequency.
1883
- *
1884
- * Raises:
1885
- * NotFound: If the specified organization does not exist.
1886
- * BadRequest: If the provided parameters are invalid.
1887
- *
1888
- * Query Parameters:
1889
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1890
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1891
- * mentor_id (str): Filter by mentor unique ID.
1892
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1893
- * @returns TopicRecord
1894
- * @throws ApiError
1895
- */
1896
- static aiAnalyticsOrgsUsersMostDiscussedTopicsList({ endDate, org, startDate, userId, aggregation, groupBy, mentorId, }: {
1897
- /**
1898
- * End date for filtering (YYYY-MM-DD)
1899
- */
1900
- endDate: string;
1901
- org: string;
1902
- /**
1903
- * Start date for filtering (YYYY-MM-DD)
1904
- */
1905
- startDate: string;
1906
- userId: string;
1907
- /**
1908
- * Time aggregation level (hourly, daily, weekly)
1909
- */
1910
- aggregation?: 'daily' | 'hourly' | 'weekly';
1911
- groupBy?: string;
1912
- /**
1913
- * Filter by mentor unique ID
1914
- */
1915
- mentorId?: string;
1916
- }): CancelablePromise<Array<TopicRecord>>;
1917
- /**
1918
- * Retrieve an overview of key analytics metrics.
1919
- *
1920
- * This endpoint returns a comprehensive overview of key analytics metrics
1921
- * for an organization, including:
1922
- * - Conversation volume: Total sessions and month-over-month change
1923
- * - Users: Total unique users and month-over-month change
1924
- * - Topics: Total unique topics and month-over-month change
1925
- * - User ratings: Total ratings and month-over-month change
1926
- *
1927
- * Results can be filtered by mentor.
1928
- *
1929
- * Args:
1930
- * request: The HTTP request containing filter query parameters.
1931
- * org: Organization key identifier.
1932
- * user_id: User identifier (not used in the implementation).
1933
- *
1934
- * Returns:
1935
- * Response: Overview of key analytics metrics with month-over-month changes.
1936
- *
1937
- * Raises:
1938
- * NotFound: If the specified organization does not exist.
1939
- *
1940
- * Query Parameters:
1941
- * mentor_id (str): Filter analytics by mentor unique ID.
1942
- * @returns AnalyticsOverview
1943
- * @throws ApiError
1944
- */
1945
- static aiAnalyticsOrgsUsersOverviewSummaryRetrieve({ org, userId, groupBy, mentorId, }: {
1946
- org: string;
1947
- groupBy?: string; /**
1948
- * Filter analytics by mentor unique ID
1949
- */
1950
- mentorId?: string;
1951
- }): CancelablePromise<AnalyticsOverview>;
1952
- /**
1953
- * Retrieve user rating metrics over time.
1954
- *
1955
- * This endpoint returns data on the number of user ratings submitted
1956
- * within a specified date range, aggregated by day or hour.
1957
- *
1958
- * Args:
1959
- * request: The HTTP request containing filter query parameters.
1960
- * org: Organization key identifier.
1961
- *
1962
- * Returns:
1963
- * Response: Time series of rating counts aggregated by day or hour.
1964
- *
1965
- * Raises:
1966
- * NotFound: If the specified organization does not exist.
1967
- * BadRequest: If the provided parameters are invalid.
1968
- *
1969
- * Query Parameters:
1970
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1971
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1972
- * group_by (str): Aggregation level (day or hour) - default: day.
1973
- * @returns RatingRecord
1974
- * @throws ApiError
1975
- */
1976
- static aiAnalyticsOrgsUsersRatingSummaryList({ endDate, org, startDate, userId, groupBy, }: {
1977
- /**
1978
- * End date for filtering (YYYY-MM-DD)
1979
- */
1980
- endDate: string;
1981
- org: string;
1982
- /**
1983
- * Start date for filtering (YYYY-MM-DD)
1984
- */
1985
- startDate: string;
1986
- userId: string;
1987
- /**
1988
- * Aggregation level (day or hour)
1989
- */
1990
- groupBy?: 'day' | 'hour';
1991
- }): CancelablePromise<Array<RatingRecord>>;
1992
- /**
1993
- * Retrieve trends of registered users over time.
1994
- *
1995
- * This endpoint returns data on the number of new user registrations
1996
- * within a specified date range, with options for different time aggregations
1997
- * (hourly, daily, weekly, monthly). The data is backfilled to ensure
1998
- * continuous time series even for periods with zero registrations.
1999
- *
2000
- * Args:
2001
- * request: The HTTP request containing filter query parameters.
2002
- * org: Organization key identifier.
2003
- *
2004
- * Returns:
2005
- * Response: Time series of user registration counts.
2006
- *
2007
- * Raises:
2008
- * NotFound: If the specified organization does not exist.
2009
- * BadRequest: If the provided parameters are invalid.
2010
- *
2011
- * Query Parameters:
2012
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2013
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2014
- * aggregation (str): Time aggregation level (hourly, daily, weekly, monthly) - default: daily.
2015
- * @returns TrendEntry
2016
- * @throws ApiError
2017
- */
2018
- static aiAnalyticsOrgsUsersRegisteredUsersTrendList({ endDate, org, startDate, userId, aggregation, groupBy, }: {
2019
- /**
2020
- * End date for filtering (YYYY-MM-DD)
2021
- */
2022
- endDate: string;
2023
- org: string;
2024
- /**
2025
- * Start date for filtering (YYYY-MM-DD)
2026
- */
2027
- startDate: string;
2028
- userId: string;
2029
- /**
2030
- * Time aggregation level (hourly, daily, weekly, monthly)
2031
- */
2032
- aggregation?: 'daily' | 'hourly' | 'monthly' | 'weekly';
2033
- groupBy?: string;
2034
- }): CancelablePromise<Array<TrendEntry>>;
2035
- /**
2036
- * Retrieve user sentiment counts over time.
2037
- *
2038
- * This endpoint returns data on the number of user sentiment entries
2039
- * within a specified time period, aggregated by date.
2040
- *
2041
- * Args:
2042
- * request: The HTTP request containing filter query parameters.
2043
- * org: Organization key identifier.
2044
- * user_id: User identifier.
2045
- *
2046
- * Returns:
2047
- * Response: Time series data of sentiment counts.
2048
- *
2049
- * Raises:
2050
- * NotFound: If the specified organization does not exist.
2051
- * ValidationError: If the provided query parameters are invalid.
2052
- *
2053
- * Query Parameters:
2054
- * period (str): Time period filter (today, yesterday, 7d, 30d, 90d) - default: 7d.
2055
- * @returns UserSentimentCountView
2056
- * @throws ApiError
2057
- */
2058
- static aiAnalyticsOrgsUsersSentimentCountList({ org, userId, period, }: {
2059
- org: string;
2060
- period?: string;
2061
- }): CancelablePromise<Array<UserSentimentCountView>>;
2062
- /**
2063
- * Retrieve LLM usage costs for a specific tenant.
2064
- *
2065
- * This endpoint returns data on the total cost of LLM usage for a specific tenant
2066
- * within a specified date range. The cost is calculated by summing the costs
2067
- * of all observations associated with traces from the tenant's sessions.
2068
- *
2069
- * Args:
2070
- * request: The HTTP request containing filter query parameters.
2071
- * org: Organization key identifier.
2072
- *
2073
- * Returns:
2074
- * Response: Total LLM usage cost for the specified tenant.
2075
- *
2076
- * Raises:
2077
- * NotFound: If the specified organization does not exist.
2078
- * BadRequest: If the provided parameters are invalid.
2079
- *
2080
- * Query Parameters:
2081
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2082
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2083
- * @returns Cost
2084
- * @throws ApiError
2085
- */
2086
- static aiAnalyticsOrgsUsersTenantCostRetrieve({ endDate, org, startDate, userId, }: {
2087
- endDate: string;
2088
- org: string;
2089
- startDate: string;
2090
- }): CancelablePromise<Cost>;
2091
- /**
2092
- * Retrieve the most engaged students based on chat message count.
2093
- *
2094
- * This endpoint returns data on the top 20 students with the highest number of
2095
- * chat messages, with optional filtering by mentor and date range.
2096
- *
2097
- * Args:
2098
- * request: The HTTP request containing filter query parameters.
2099
- * org: Organization key identifier.
2100
- * user_id: User identifier (not used in the implementation).
2101
- *
2102
- * Returns:
2103
- * Response: List of top students with their chat message counts.
2104
- *
2105
- * Raises:
2106
- * NotFound: If the specified organization does not exist.
2107
- * BadRequest: If the provided parameters are invalid.
2108
- *
2109
- * Query Parameters:
2110
- * mentor_id (str): Filter by mentor unique ID.
2111
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2112
- * end_date (str): End date for filtering (YYYY-MM-DD).
2113
- * @returns StudentChatMessage
2114
- * @throws ApiError
2115
- */
2116
- static aiAnalyticsOrgsUsersTopStudentsByChatMessagesList({ org, userId, groupBy, }: {
2117
- org: string;
2118
- groupBy?: string;
2119
- }): CancelablePromise<Array<StudentChatMessage>>;
2120
- /**
2121
- * Retrieve aggregated topic statistics.
2122
- *
2123
- * This endpoint returns statistical information about topics within an organization,
2124
- * including total topics, new topics, and percentage changes compared to the
2125
- * previous month. Results can be filtered by mentor.
2126
- *
2127
- * Args:
2128
- * request: The HTTP request containing filter query parameters.
2129
- * org: Organization key identifier.
2130
- *
2131
- * Returns:
2132
- * Response: Statistical information about topics.
2133
- *
2134
- * Raises:
2135
- * NotFound: If the specified organization or mentor does not exist.
2136
- *
2137
- * Query Parameters:
2138
- * mentor_id (str): Filter statistics by mentor unique ID.
2139
- * @returns TopicStatisticsResponse
2140
- * @throws ApiError
2141
- */
2142
- static aiAnalyticsOrgsUsersTopicOverviewRetrieve({ org, userId, mentorId, }: {
2143
- org: string; /**
2144
- * Filter statistics by mentor unique ID
2145
- */
2146
- mentorId?: string;
2147
- }): CancelablePromise<TopicStatisticsResponse>;
2148
- /**
2149
- * Retrieve paginated statistics about topics.
2150
- *
2151
- * This endpoint returns detailed statistics about topics, including:
2152
- * - Number of conversations related to each topic
2153
- * - Total message count for each topic
2154
- * - Average sentiment of conversations about each topic
2155
- * - Average user rating for conversations about each topic
2156
- *
2157
- * Results can be filtered by mentor and date range, and are paginated.
2158
- *
2159
- * Args:
2160
- * request: The HTTP request containing filter query parameters.
2161
- * org: Organization key identifier.
2162
- *
2163
- * Returns:
2164
- * Response: Paginated list of topic statistics.
2165
- *
2166
- * Raises:
2167
- * NotFound: If the specified organization or mentor does not exist.
2168
- * BadRequest: If the provided parameters are invalid.
2169
- *
2170
- * Query Parameters:
2171
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2172
- * end_date (str): End date for filtering (YYYY-MM-DD).
2173
- * mentor_id (str): Filter by mentor unique ID.
2174
- * page (int): Page number for pagination - default: 1.
2175
- * page_size (int): Number of results per page - default: 20.
2176
- * @returns PaginatedTopicStatisticsResponse
2177
- * @throws ApiError
2178
- */
2179
- static aiAnalyticsOrgsUsersTopicStatisticsRetrieve({ org, userId, endDate, groupBy, mentorId, page, pageSize, startDate, }: {
2180
- org: string; /**
2181
- * End date for filtering (YYYY-MM-DD)
2182
- */
2183
- endDate?: string;
2184
- groupBy?: string;
2185
- /**
2186
- * Filter by mentor unique ID
2187
- */
2188
- mentorId?: string;
2189
- /**
2190
- * Page number for pagination
2191
- */
2192
- page?: number;
2193
- /**
2194
- * Number of results per page
2195
- */
2196
- pageSize?: number;
2197
- /**
2198
- * Start date for filtering (YYYY-MM-DD)
2199
- */
2200
- startDate?: string;
2201
- }): CancelablePromise<PaginatedTopicStatisticsResponse>;
2202
- /**
2203
- * Retrieve a summary of the most frequent topics.
2204
- *
2205
- * This endpoint returns a summary of the top 10 topics discussed in chat sessions,
2206
- * ordered by conversation count. Results can be filtered by mentor and date range.
2207
- *
2208
- * Args:
2209
- * request: The HTTP request containing filter query parameters.
2210
- * org: Organization key identifier.
2211
- *
2212
- * Returns:
2213
- * Response: A list of the top 10 topics with their conversation counts.
2214
- *
2215
- * Raises:
2216
- * NotFound: If the specified organization does not exist.
2217
- * BadRequest: If the provided date format is invalid.
2218
- *
2219
- * Query Parameters:
2220
- * mentor_id (str): Filter by mentor unique ID.
2221
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2222
- * end_date (str): End date for filtering (YYYY-MM-DD).
2223
- * @returns TopicSummaryView
2224
- * @throws ApiError
2225
- */
2226
- static aiAnalyticsOrgsUsersTopicsSummaryList({ org, userId, endDate, startDate, }: {
2227
- org: string;
2228
- endDate?: string;
2229
- startDate?: string;
2230
- }): CancelablePromise<Array<TopicSummaryView>>;
2231
- /**
2232
- * Retrieve the total number of users interacting with mentors over time.
2233
- *
2234
- * This endpoint returns data on the number of unique users who interacted with
2235
- * mentors each day or hour within a specified date range, with optional
2236
- * filtering by specific mentor. If no date range is provided, the last 30 days
2237
- * are used by default.
2238
- *
2239
- * Args:
2240
- * request: The HTTP request containing filter query parameters.
2241
- * org: Organization key identifier.
2242
- *
2243
- * Returns:
2244
- * Response: Time series of unique user counts.
2245
- *
2246
- * Raises:
2247
- * NotFound: If the specified organization or mentor does not exist.
2248
- * BadRequest: If the provided parameters are invalid.
2249
- *
2250
- * Query Parameters:
2251
- * start_date (str): Start date for filtering (YYYY-MM-DD) - defaults to 30 days ago.
2252
- * end_date (str): End date for filtering (YYYY-MM-DD) - defaults to today.
2253
- * aggregation (str): Time aggregation level (hourly, daily) - default: daily.
2254
- * mentor_id (str): Filter by mentor unique ID.
2255
- * @returns UserChatByPeriod
2256
- * @throws ApiError
2257
- */
2258
- static aiAnalyticsOrgsUsersTotalUsersByMentorList({ org, userId, aggregation, endDate, groupBy, mentorId, startDate, }: {
2259
- org: string; /**
2260
- * Time aggregation level (hourly, daily)
2261
- */
2262
- aggregation?: 'daily' | 'hourly';
2263
- /**
2264
- * End date for filtering (YYYY-MM-DD)
2265
- */
2266
- endDate?: string;
2267
- groupBy?: string;
2268
- /**
2269
- * Filter by mentor unique ID
2270
- */
2271
- mentorId?: string;
2272
- /**
2273
- * Start date for filtering (YYYY-MM-DD)
2274
- */
2275
- startDate?: string;
2276
- }): CancelablePromise<Array<UserChatByPeriod>>;
2277
- /**
2278
- * Retrieve message data from conversations.
2279
- *
2280
- * This endpoint returns data on messages within conversations, with options
2281
- * for filtering by date range, topics, and mentor.
2282
- *
2283
- * Args:
2284
- * request: The HTTP request containing filter query parameters.
2285
- * org: Organization key identifier.
2286
- * user_id: User identifier (not used in the implementation).
2287
- *
2288
- * Returns:
2289
- * Response: A list of conversation message data.
2290
- *
2291
- * Raises:
2292
- * NotFound: If the specified organization does not exist.
2293
- * ValidationError: If the provided query parameters are invalid.
2294
- *
2295
- * Query Parameters:
2296
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2297
- * end_date (str): End date for filtering (YYYY-MM-DD).
2298
- * topics (str): Comma-separated list of topics to filter by.
2299
- * mentor (str): Filter by mentor unique ID.
2300
- * @returns ConversationMessage
2301
- * @throws ApiError
2302
- */
2303
- static aiAnalyticsOrgsUsersTranscriptsList({ org, userId, endDate, mentor, startDate, topics, }: {
2304
- org: string;
2305
- endDate?: string;
2306
- mentor?: string;
2307
- startDate?: string;
2308
- topics?: string;
2309
- }): CancelablePromise<Array<ConversationMessage>>;
2310
- /**
2311
- * Retrieve daily user engagement metrics with mentors.
2312
- *
2313
- * This endpoint returns data on the number of unique users who interact with
2314
- * mentors each day within a specified date range.
2315
- *
2316
- * Args:
2317
- * request: The HTTP request containing filter query parameters.
2318
- * org: Organization key identifier.
2319
- *
2320
- * Returns:
2321
- * Response: Daily time series of unique user counts.
2322
- *
2323
- * Raises:
2324
- * NotFound: If the specified organization does not exist.
2325
- * BadRequest: If the provided parameters are invalid.
2326
- *
2327
- * Query Parameters:
2328
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2329
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2330
- * @returns UserCountRecord
2331
- * @throws ApiError
2332
- */
2333
- static aiAnalyticsOrgsUsersUsageSummaryList({ endDate, org, startDate, userId, groupBy, }: {
2334
- /**
2335
- * End date for filtering (YYYY-MM-DD)
2336
- */
2337
- endDate: string;
2338
- org: string;
2339
- /**
2340
- * Start date for filtering (YYYY-MM-DD)
2341
- */
2342
- startDate: string;
2343
- userId: string;
2344
- groupBy?: string;
2345
- }): CancelablePromise<Array<UserCountRecord>>;
2346
- /**
2347
- * Retrieve user cohort trends over time.
2348
- *
2349
- * This endpoint returns data on the distribution of new versus veteran users
2350
- * over time, with options for different time aggregations and filtering by mentor.
2351
- * New users are those who registered within the specified date range, while
2352
- * veteran users are those who registered before the date range but were active
2353
- * during it.
2354
- *
2355
- * Args:
2356
- * request: The HTTP request containing filter query parameters.
2357
- * org: Organization key identifier.
2358
- *
2359
- * Returns:
2360
- * Response: Time series of new and veteran user counts.
2361
- *
2362
- * Raises:
2363
- * NotFound: If the specified organization does not exist.
2364
- * BadRequest: If the provided parameters are invalid.
2365
- *
2366
- * Query Parameters:
2367
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2368
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2369
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
2370
- * mentor_id (str): Filter by mentor unique ID.
2371
- * @returns UserTrendByPeriod
2372
- * @throws ApiError
2373
- */
2374
- static aiAnalyticsOrgsUsersUserCohortsOverTimeRetrieve({ endDate, org, startDate, userId, aggregation, mentorId, }: {
2375
- /**
2376
- * End date for filtering (YYYY-MM-DD)
2377
- */
2378
- endDate: string;
2379
- org: string;
2380
- /**
2381
- * Start date for filtering (YYYY-MM-DD)
2382
- */
2383
- startDate: string;
2384
- userId: string;
2385
- /**
2386
- * Time aggregation level (hourly, daily, weekly)
2387
- */
2388
- aggregation?: 'daily' | 'hourly' | 'weekly';
2389
- /**
2390
- * Filter by mentor unique ID
2391
- */
2392
- mentorId?: string;
2393
- }): CancelablePromise<UserTrendByPeriod>;
2394
- /**
2395
- * Retrieve LLM usage costs for a specific user.
2396
- *
2397
- * This endpoint returns data on the total cost of LLM usage for a specific user
2398
- * within a specified date range. The cost is calculated by summing the costs
2399
- * of all observations associated with traces from the tenant's sessions.
2400
- *
2401
- * Args:
2402
- * request: The HTTP request containing filter query parameters.
2403
- * org: Organization key identifier.
2404
- * user_id: User key identifier.
2405
- *
2406
- * Returns:
2407
- * Response: Total LLM usage cost for the specified tenant.
2408
- *
2409
- * Raises:
2410
- * NotFound: If the specified organization does not exist.
2411
- * BadRequest: If the provided parameters are invalid.
2412
- *
2413
- * Query Parameters:
2414
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2415
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2416
- * @returns Cost
2417
- * @throws ApiError
2418
- */
2419
- static aiAnalyticsOrgsUsersUserCostRetrieve({ endDate, org, startDate, userId, username, }: {
2420
- endDate: string;
2421
- org: string;
2422
- startDate: string;
2423
- username: string;
2424
- }): CancelablePromise<Cost>;
2425
- /**
2426
- * Retrieve aggregated user chat feedback counts.
2427
- *
2428
- * This endpoint returns data on the number of user chat feedback entries
2429
- * within a specified date range, with options for different time aggregations
2430
- * (hourly, daily, weekly). Results can be filtered by mentor.
2431
- *
2432
- * Args:
2433
- * request: The HTTP request containing filter query parameters.
2434
- * org: Organization key identifier.
2435
- *
2436
- * Returns:
2437
- * Response: Time series data of feedback counts.
2438
- *
2439
- * Raises:
2440
- * NotFound: If the specified organization does not exist.
2441
- * BadRequest: If the provided parameters are invalid.
2442
- *
2443
- * Query Parameters:
2444
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2445
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2446
- * mentor_id (str): Filter by mentor unique ID.
2447
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
2448
- * @returns UserChatFeedbackCount
2449
- * @throws ApiError
2450
- */
2451
- static aiAnalyticsOrgsUsersUserFeedbackList({ endDate, org, startDate, userId, aggregation, mentorId, }: {
2452
- /**
2453
- * End date for filtering (YYYY-MM-DD)
2454
- */
2455
- endDate: string;
2456
- org: string;
2457
- /**
2458
- * Start date for filtering (YYYY-MM-DD)
2459
- */
2460
- startDate: string;
2461
- userId: string;
2462
- /**
2463
- * Time aggregation level (hourly, daily, weekly)
2464
- */
2465
- aggregation?: 'daily' | 'hourly' | 'weekly';
2466
- /**
2467
- * Filter by mentor unique ID
2468
- */
2469
- mentorId?: string;
2470
- }): CancelablePromise<Array<UserChatFeedbackCount>>;
2471
- /**
2472
- * Retrieve comprehensive user metrics.
2473
- *
2474
- * This endpoint returns data on various user metrics with month-over-month
2475
- * change calculations:
2476
- * - Registered users: Total users registered on the platform
2477
- * - New users: Users who joined in the current month
2478
- * - Unique users: Distinct users who have had sessions
2479
- * - Veteran users: Users who have been active for at least 6 months
2480
- *
2481
- * Results can be filtered by mentor.
2482
- *
2483
- * Args:
2484
- * request: The HTTP request containing filter query parameters.
2485
- * org: Organization key identifier.
2486
- *
2487
- * Returns:
2488
- * Response: Comprehensive user metrics with month-over-month changes.
2489
- *
2490
- * Raises:
2491
- * NotFound: If the specified organization does not exist.
2492
- *
2493
- * Query Parameters:
2494
- * mentor_id (str): Filter metrics by mentor unique ID.
2495
- * @returns UserMetricsResponse
2496
- * @throws ApiError
2497
- */
2498
- static aiAnalyticsOrgsUsersUserMetricsRetrieve({ org, userId, groupBy, mentorId, }: {
2499
- org: string;
2500
- groupBy?: string; /**
2501
- * Filter metrics by mentor unique ID
2502
- */
2503
- mentorId?: string;
2504
- }): CancelablePromise<UserMetricsResponse>;
2505
- /**
2506
- * Retrieve user distribution data for pie charts.
2507
- *
2508
- * This endpoint returns data on the distribution of new versus returning users
2509
- * within a specified date range, including both counts and percentages,
2510
- * suitable for pie chart visualization.
2511
- *
2512
- * Args:
2513
- * request: The HTTP request containing filter query parameters.
2514
- * org: Organization key identifier.
2515
- *
2516
- * Returns:
2517
- * Response: Distribution of new versus returning users with counts and percentages.
2518
- *
2519
- * Raises:
2520
- * NotFound: If the specified organization does not exist.
2521
- * BadRequest: If the provided parameters are invalid.
2522
- *
2523
- * Query Parameters:
2524
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2525
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2526
- * mentor_id (str): Filter by mentor unique ID.
2527
- * @returns PieChartData
2528
- * @throws ApiError
2529
- */
2530
- static aiAnalyticsOrgsUsersUserMetricsPieChartRetrieve({ endDate, org, startDate, userId, mentorId, }: {
2531
- /**
2532
- * End date for filtering (YYYY-MM-DD)
2533
- */
2534
- endDate: string;
2535
- org: string;
2536
- /**
2537
- * Start date for filtering (YYYY-MM-DD)
2538
- */
2539
- startDate: string;
2540
- userId: string;
2541
- /**
2542
- * Filter by mentor unique ID
2543
- */
2544
- mentorId?: string;
2545
- }): CancelablePromise<PieChartData>;
2546
- /**
2547
- * Retrieve user sentiment distribution.
2548
- *
2549
- * This endpoint returns data on the distribution of user sentiments (positive,
2550
- * negative, neutral) within a specified date range, expressed as percentages.
2551
- *
2552
- * Args:
2553
- * request: The HTTP request containing filter query parameters.
2554
- * org: Organization key identifier.
2555
- *
2556
- * Returns:
2557
- * Response: Sentiment distribution percentages and total sentiment count.
2558
- *
2559
- * Raises:
2560
- * NotFound: If the specified organization does not exist.
2561
- * BadRequest: If the provided parameters are invalid.
2562
- *
2563
- * Query Parameters:
2564
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2565
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2566
- * @returns SentimentSummary
2567
- * @throws ApiError
2568
- */
2569
- static aiAnalyticsOrgsUsersUserSentimentRetrieve({ endDate, org, startDate, userId, groupBy, }: {
2570
- /**
2571
- * End date for filtering (YYYY-MM-DD)
2572
- */
2573
- endDate: string;
2574
- org: string;
2575
- /**
2576
- * Start date for filtering (YYYY-MM-DD)
2577
- */
2578
- startDate: string;
2579
- userId: string;
2580
- groupBy?: string;
2581
- }): CancelablePromise<SentimentSummary>;
2582
- /**
2583
- * Get active user counts over time.
2584
- *
2585
- * This endpoint provides daily counts of active users (users with known activity)
2586
- * over a specified time period.
2587
- *
2588
- * Query Parameters:
2589
- * start_date (str, optional): Start date for the time range (ISO format)
2590
- * end_date (str, optional): End date for the time range (ISO format)
2591
- *
2592
- * Returns:
2593
- * Daily active user counts over the specified time period, with change metrics
2594
- * compared to previous periods.
2595
- *
2596
- * Default time range is the last 7 days if no dates are specified.
2597
- *
2598
- * An active user is defined as a user with any activity within the past 30 days.
2599
- * @returns OvertimeWithChangeInfo
2600
- * @throws ApiError
2601
- */
2602
- static aiAnalyticsOverviewOrgsActiveUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
2603
- org: string;
2604
- /**
2605
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2606
- */
2607
- departmentId?: number;
2608
- /**
2609
- * end date. ISO 8601
2610
- */
2611
- endDate?: string;
2612
- /**
2613
- * Format
2614
- *
2615
- * * `json` - json
2616
- */
2617
- format?: 'json';
2618
- /**
2619
- * Include main platform data
2620
- */
2621
- includeMainPlatform?: boolean;
2622
- /**
2623
- * start date. ISO 8601
2624
- */
2625
- startDate?: string;
2626
- }): CancelablePromise<OvertimeWithChangeInfo>;
2627
- /**
2628
- * Get average grade value for platform, course, or user.
2629
- *
2630
- * This endpoint returns the average grade at different levels:
2631
- * - Platform level: Average grade across all courses
2632
- * - Course level: Average grade for a specific course
2633
- * - Learner level: Average grade for a specific learner
2634
- * - Course-learner level: Grade for a specific learner in a specific course
2635
- *
2636
- * Query Parameters:
2637
- * course_id (str, optional): Filter by course ID
2638
- * learner_id (str, optional): Filter by username or email
2639
- *
2640
- * Returns:
2641
- * The average grade value based on the specified filters.
2642
- *
2643
- * Access Control:
2644
- * - Platform admins can access any grade data
2645
- * - Learners can access their own grade data
2646
- * @returns Average
2647
- * @throws ApiError
2648
- */
2649
- static aiAnalyticsOverviewOrgsAverageGradeRetrieve({ org, departmentId, format, includeMainPlatform, }: {
2650
- org: string;
2651
- /**
2652
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2653
- */
2654
- departmentId?: number;
2655
- /**
2656
- * Format
2657
- *
2658
- * * `json` - json
2659
- */
2660
- format?: 'json';
2661
- /**
2662
- * Include main platform data
2663
- */
2664
- includeMainPlatform?: boolean;
2665
- }): CancelablePromise<Average>;
2666
- /**
2667
- * Get course completion summary metrics over time.
2668
- *
2669
- * This endpoint provides completion statistics across the platform over a
2670
- * specified time period, including daily completion counts and overall metrics.
2671
- *
2672
- * Query Parameters:
2673
- * start_date (str): Start date for the time range (ISO format)
2674
- * end_date (str): End date for the time range (ISO format)
2675
- *
2676
- * Returns:
2677
- * Completion data including:
2678
- * - Daily completion counts over time
2679
- * - Total unique user count
2680
- * - Total completion count
2681
- * - Completion percentage
2682
- * - Change metrics compared to previous periods
2683
- *
2684
- * Default time range is the last 7 days if no dates are specified.
2685
- * @returns CourseCompletionSummaryOvertime
2686
- * @throws ApiError
2687
- */
2688
- static aiAnalyticsOverviewOrgsCoursesCompletionsRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
2689
- org: string;
2690
- /**
2691
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2692
- */
2693
- departmentId?: number;
2694
- /**
2695
- * end date. ISO 8601
2696
- */
2697
- endDate?: string;
2698
- /**
2699
- * Format
2700
- *
2701
- * * `json` - json
2702
- */
2703
- format?: 'json';
2704
- /**
2705
- * Include main platform data
2706
- */
2707
- includeMainPlatform?: boolean;
2708
- /**
2709
- * start date. ISO 8601
2710
- */
2711
- startDate?: string;
2712
- }): CancelablePromise<CourseCompletionSummaryOvertime>;
2713
- /**
2714
- * List all learners on the platform with aggregated metrics.
2715
- *
2716
- * This endpoint returns a paginated list of all learners with key metrics including:
2717
- * - Enrollment counts
2718
- * - Completion counts
2719
- * - Time spent on platform
2720
- *
2721
- * Query Parameters:
2722
- * page (int): Page number for pagination
2723
- * length (int): Number of items per page
2724
- * search (str): Filter learners by username, email, or name
2725
- *
2726
- * Returns:
2727
- * A paginated list of learners with their associated metrics.
2728
- * @returns PerlearnerUserList
2729
- * @throws ApiError
2730
- */
2731
- static aiAnalyticsOverviewOrgsLearnersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
2732
- org: string;
2733
- /**
2734
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2735
- */
2736
- departmentId?: number;
2737
- /**
2738
- * Format
2739
- *
2740
- * * `json` - json
2741
- */
2742
- format?: 'json';
2743
- /**
2744
- * Include main platform data
2745
- */
2746
- includeMainPlatform?: boolean;
2747
- /**
2748
- * Size of data to return
2749
- */
2750
- length?: number;
2751
- /**
2752
- * Page offset
2753
- */
2754
- page?: number;
2755
- /**
2756
- * Search string for learner
2757
- */
2758
- search?: string;
2759
- }): CancelablePromise<PerlearnerUserList>;
2760
- /**
2761
- * Get time spent statistics on a per-course basis.
2762
- *
2763
- * This endpoint provides a paginated list of courses with the total time
2764
- * spent by users in each course.
2765
- *
2766
- * Query Parameters:
2767
- * start_date (str, optional): Start date for filtering (ISO format)
2768
- * end_date (str, optional): End date for filtering (ISO format)
2769
- * page (int, optional): Page number for pagination
2770
- * length (int, optional): Number of items per page
2771
- *
2772
- * Returns:
2773
- * A paginated list of courses with:
2774
- * - Course identification (ID and name)
2775
- * - Total time spent (in seconds)
2776
- * - Formatted time spent (human-readable)
2777
- * - Percentage of total platform time
2778
- * @returns TimeSpentPerCourse
2779
- * @throws ApiError
2780
- */
2781
- static aiAnalyticsOverviewOrgsMostActiveCoursesRetrieve({ org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
2782
- org: string;
2783
- /**
2784
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2785
- */
2786
- departmentId?: number;
2787
- /**
2788
- * end date. ISO 8601
2789
- */
2790
- endDate?: string;
2791
- /**
2792
- * Format
2793
- *
2794
- * * `json` - json
2795
- */
2796
- format?: 'json';
2797
- /**
2798
- * Include main platform data
2799
- */
2800
- includeMainPlatform?: boolean;
2801
- /**
2802
- * Size of data to return
2803
- */
2804
- length?: number;
2805
- /**
2806
- * Page offset
2807
- */
2808
- page?: number;
2809
- /**
2810
- * start date. ISO 8601
2811
- */
2812
- startDate?: string;
2813
- }): CancelablePromise<TimeSpentPerCourse>;
2814
- /**
2815
- * Get registered user counts over time.
2816
- *
2817
- * This endpoint provides daily counts of new user registrations over a
2818
- * specified time period.
2819
- *
2820
- * Query Parameters:
2821
- * start_date (str, optional): Start date for the time range (ISO format)
2822
- * end_date (str, optional): End date for the time range (ISO format)
2823
- *
2824
- * Returns:
2825
- * Daily registration counts over the specified time period, with change metrics
2826
- * compared to previous periods.
2827
- *
2828
- * Default time range is the last 7 days if no dates are specified.
2829
- * @returns OvertimeWithChangeInfo
2830
- * @throws ApiError
2831
- */
2832
- static aiAnalyticsOverviewOrgsRegisteredUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
2833
- org: string;
2834
- /**
2835
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2836
- */
2837
- departmentId?: number;
2838
- /**
2839
- * end date. ISO 8601
2840
- */
2841
- endDate?: string;
2842
- /**
2843
- * Format
2844
- *
2845
- * * `json` - json
2846
- */
2847
- format?: 'json';
2848
- /**
2849
- * Include main platform data
2850
- */
2851
- includeMainPlatform?: boolean;
2852
- /**
2853
- * start date. ISO 8601
2854
- */
2855
- startDate?: string;
2856
- }): CancelablePromise<OvertimeWithChangeInfo>;
2857
- /**
2858
- * Get average grade value for platform, course, or user.
2859
- *
2860
- * This endpoint returns the average grade at different levels:
2861
- * - Platform level: Average grade across all courses
2862
- * - Course level: Average grade for a specific course
2863
- * - Learner level: Average grade for a specific learner
2864
- * - Course-learner level: Grade for a specific learner in a specific course
2865
- *
2866
- * Query Parameters:
2867
- * course_id (str, optional): Filter by course ID
2868
- * learner_id (str, optional): Filter by username or email
2869
- *
2870
- * Returns:
2871
- * The average grade value based on the specified filters.
2872
- *
2873
- * Access Control:
2874
- * - Platform admins can access any grade data
2875
- * - Learners can access their own grade data
2876
- * @returns Average
2877
- * @throws ApiError
2878
- */
2879
- static aiAnalyticsPerformanceOrgsCoursesGradingAverageRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
2880
- courseId: string;
2881
- org: string;
2882
- /**
2883
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2884
- */
2885
- departmentId?: number;
2886
- /**
2887
- * Format
2888
- *
2889
- * * `json` - json
2890
- */
2891
- format?: 'json';
2892
- /**
2893
- * Include main platform data
2894
- */
2895
- includeMainPlatform?: boolean;
2896
- }): CancelablePromise<Average>;
2897
- /**
2898
- * Returns average course grade and grade cuttoff
2899
- *
2900
- * e.g
2901
- * ```
2902
- * {
2903
- * "data": {
2904
- * "grade_cutoffs": {
2905
- * "A": 90,
2906
- * "B": 80,
2907
- * "C": 70,
2908
- * },
2909
- * "average_grade": 50.0,
2910
- * }
2911
- * }
2912
- * ```
2913
- *
2914
- * Kwargs
2915
- * course_id
2916
- * @returns AvgCourseGradeWithCutoff
2917
- * @throws ApiError
2918
- */
2919
- static aiAnalyticsPerformanceOrgsCoursesGradingAverageWithCutoffRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
2920
- courseId: string;
2921
- org: string;
2922
- /**
2923
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2924
- */
2925
- departmentId?: number;
2926
- /**
2927
- * Format
2928
- *
2929
- * * `json` - json
2930
- */
2931
- format?: 'json';
2932
- /**
2933
- * Include main platform data
2934
- */
2935
- includeMainPlatform?: boolean;
2936
- }): CancelablePromise<AvgCourseGradeWithCutoff>;
2937
- /**
2938
- * Grading summary for the entire course overview in a tree-like format
2939
- *
2940
- * Kwargs
2941
- * course_id <required>
2942
- * @returns CourseGradingDetail
2943
- * @throws ApiError
2944
- */
2945
- static aiAnalyticsPerformanceOrgsCoursesGradingDetailRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
2946
- courseId: string;
2947
- org: string;
2948
- /**
2949
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2950
- */
2951
- departmentId?: number;
2952
- /**
2953
- * Format
2954
- *
2955
- * * `json` - json
2956
- */
2957
- format?: 'json';
2958
- /**
2959
- * Include main platform data
2960
- */
2961
- includeMainPlatform?: boolean;
2962
- }): CancelablePromise<CourseGradingDetail>;
2963
- /**
2964
- * Grading information per enrolled user in a course
2965
- *
2966
- * Kwargs
2967
- * course_id <required>
2968
- * @returns GradingPerUser
2969
- * @throws ApiError
2970
- */
2971
- static aiAnalyticsPerformanceOrgsCoursesGradingPerLearnerRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
2972
- courseId: string;
2973
- org: string;
2974
- /**
2975
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2976
- */
2977
- departmentId?: number;
2978
- /**
2979
- * Format
2980
- *
2981
- * * `json` - json
2982
- */
2983
- format?: 'json';
2984
- /**
2985
- * Include main platform data
2986
- */
2987
- includeMainPlatform?: boolean;
2988
- }): CancelablePromise<GradingPerUser>;
2989
- /**
2990
- * Returns average grades across various assignment types in a course
2991
- *
2992
- * Query Params
2993
- * course_id
2994
- *
2995
- * Returns:
2996
- * dict
2997
- * {
2998
- * "data": [
2999
- * {
3000
- * "assignment_type': <str>,
3001
- * "weight": <float>,
3002
- * "average_weighted_grade": <float>,
3003
- * "average_section_grade": <float>
3004
- * }, ...
3005
- * ]
3006
- * }
3007
- * @returns CourseGradeSummary
3008
- * @throws ApiError
3009
- */
3010
- static aiAnalyticsPerformanceOrgsCoursesGradingSummaryRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
3011
- courseId: string;
3012
- org: string;
3013
- /**
3014
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3015
- */
3016
- departmentId?: number;
3017
- /**
3018
- * Format
3019
- *
3020
- * * `json` - json
3021
- */
3022
- format?: 'json';
3023
- /**
3024
- * Include main platform data
3025
- */
3026
- includeMainPlatform?: boolean;
3027
- }): CancelablePromise<CourseGradeSummary>;
3028
- /**
3029
- * Get average grade value for platform, course, or user.
3030
- *
3031
- * This endpoint returns the average grade at different levels:
3032
- * - Platform level: Average grade across all courses
3033
- * - Course level: Average grade for a specific course
3034
- * - Learner level: Average grade for a specific learner
3035
- * - Course-learner level: Grade for a specific learner in a specific course
3036
- *
3037
- * Query Parameters:
3038
- * course_id (str, optional): Filter by course ID
3039
- * learner_id (str, optional): Filter by username or email
3040
- *
3041
- * Returns:
3042
- * The average grade value based on the specified filters.
3043
- *
3044
- * Access Control:
3045
- * - Platform admins can access any grade data
3046
- * - Learners can access their own grade data
3047
- * @returns Average
3048
- * @throws ApiError
3049
- */
3050
- static aiAnalyticsPerformanceOrgsGradingAverageRetrieve({ org, departmentId, format, includeMainPlatform, }: {
3051
- org: string;
3052
- /**
3053
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3054
- */
3055
- departmentId?: number;
3056
- /**
3057
- * Format
3058
- *
3059
- * * `json` - json
3060
- */
3061
- format?: 'json';
3062
- /**
3063
- * Include main platform data
3064
- */
3065
- includeMainPlatform?: boolean;
3066
- }): CancelablePromise<Average>;
3067
- /**
3068
- * List grade-related performance data for all courses.
3069
- *
3070
- * This endpoint provides a comprehensive view of grade performance across
3071
- * courses, including enrollment counts, pass rates, and average grades.
3072
- *
3073
- * Returns:
3074
- * A paginated list of courses with:
3075
- * - Course identification (ID and name)
3076
- * - Enrollment count
3077
- * - Number of students who passed
3078
- * - Average grade
3079
- * @returns PerformanceGradesPerCourse
3080
- * @throws ApiError
3081
- */
3082
- static aiAnalyticsPerformanceOrgsGradingPerCourseRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
3083
- org: string;
3084
- /**
3085
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3086
- */
3087
- departmentId?: number;
3088
- /**
3089
- * Format
3090
- *
3091
- * * `json` - json
3092
- */
3093
- format?: 'json';
3094
- /**
3095
- * Include main platform data
3096
- */
3097
- includeMainPlatform?: boolean;
3098
- /**
3099
- * Size of data to return
3100
- */
3101
- length?: number;
3102
- /**
3103
- * Page offset
3104
- */
3105
- page?: number;
3106
- }): CancelablePromise<PerformanceGradesPerCourse>;
3107
- /**
3108
- * Enhanced API endpoint for listing learners with comprehensive filtering.
3109
- *
3110
- * This endpoint provides a paginated list of learners with detailed metrics
3111
- * and supports advanced filtering options. It uses DM token authentication
3112
- * and respects department-based access controls.
3113
- *
3114
- * Query Parameters:
3115
- * page (int): Page number for pagination
3116
- * length (int): Number of items per page
3117
- * search (str): Filter by username, email, or full name
3118
- * program (str): Filter by program
3119
- * location (str): Filter by location
3120
- * is_enrolled (bool): Filter for users with enrollments
3121
- * platform (str): Filter by platform
3122
- * start_date (date): Filter by join date (start range)
3123
- * end_date (date): Filter by join date (end range)
3124
- *
3125
- * Returns:
3126
- * A paginated list of learners with comprehensive metrics including:
3127
- * - Course enrollments and completions
3128
- * - Time spent on platform
3129
- * - Pathway progress
3130
- * - Certificate and skill information
3131
- * - Location data
3132
- *
3133
- * Access Control:
3134
- * - Platform admins can see all learners
3135
- * - Department admins can only see learners in their departments
3136
- * @returns NewPerLearnerList
3137
- * @throws ApiError
3138
- */
3139
- static aiAnalyticsPerlearnerOrgsLearnersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, isEnrolled, length, location, page, platform, program, search, startDate, }: {
3140
- org: string;
3141
- /**
3142
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3143
- */
3144
- departmentId?: number;
3145
- /**
3146
- * Learner date_joined end date. ISO 8601
3147
- */
3148
- endDate?: string;
3149
- /**
3150
- * Format
3151
- *
3152
- * * `json` - json
3153
- */
3154
- format?: 'json';
3155
- /**
3156
- * Include main platform data
3157
- */
3158
- includeMainPlatform?: boolean;
3159
- /**
3160
- * Filter for users who have at least an enrollment
3161
- */
3162
- isEnrolled?: boolean | null;
3163
- /**
3164
- * Size of data to return
3165
- */
3166
- length?: number;
3167
- /**
3168
- * Location search string
3169
- */
3170
- location?: string;
3171
- /**
3172
- * Page offset
3173
- */
3174
- page?: number;
3175
- /**
3176
- * Platform search string
3177
- */
3178
- platform?: string;
3179
- /**
3180
- * Program search string
3181
- */
3182
- program?: string;
3183
- /**
3184
- * Search string for learner. email, username or full name
3185
- */
3186
- search?: string;
3187
- /**
3188
- * Learner date_joined start date. ISO 8601
3189
- */
3190
- startDate?: string;
3191
- }): CancelablePromise<NewPerLearnerList>;
3192
- /**
3193
- * List all learners on the platform with aggregated metrics.
3194
- *
3195
- * This endpoint returns a paginated list of all learners with key metrics including:
3196
- * - Enrollment counts
3197
- * - Completion counts
3198
- * - Time spent on platform
3199
- *
3200
- * Query Parameters:
3201
- * page (int): Page number for pagination
3202
- * length (int): Number of items per page
3203
- * search (str): Filter learners by username, email, or name
3204
- *
3205
- * Returns:
3206
- * A paginated list of learners with their associated metrics.
3207
- * @returns PerlearnerUserList
3208
- * @throws ApiError
3209
- */
3210
- static aiAnalyticsPerlearnerOrgsUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
3211
- org: string;
3212
- /**
3213
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3214
- */
3215
- departmentId?: number;
3216
- /**
3217
- * Format
3218
- *
3219
- * * `json` - json
3220
- */
3221
- format?: 'json';
3222
- /**
3223
- * Include main platform data
3224
- */
3225
- includeMainPlatform?: boolean;
3226
- /**
3227
- * Size of data to return
3228
- */
3229
- length?: number;
3230
- /**
3231
- * Page offset
3232
- */
3233
- page?: number;
3234
- /**
3235
- * Search string for learner
3236
- */
3237
- search?: string;
3238
- }): CancelablePromise<PerlearnerUserList>;
3239
- /**
3240
- * Provides information on user enrollments
3241
- *
3242
- * Params
3243
- * user_id e.g developer@ibleducation.com| developer
3244
- * @returns ActivityAPI
3245
- * @throws ApiError
3246
- */
3247
- static aiAnalyticsPerlearnerOrgsUsersActivityRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
3248
- org: string; /**
3249
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3250
- */
3251
- departmentId?: number; /**
3252
- * Format
3253
- *
3254
- * * `json` - json
3255
- */
3256
- format?: 'json'; /**
3257
- * Include main platform data
3258
- */
3259
- includeMainPlatform?: boolean;
3260
- }): CancelablePromise<ActivityAPI>;
3261
- /**
3262
- * Provides about a learner current grade in a course with the course cut
3263
- * Kwargs
3264
- * 1. course_id e.g course-v1:Org+Course4+Run
3265
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3266
- * @returns PerlearnerGradeWithCutOff
3267
- * @throws ApiError
3268
- */
3269
- static aiAnalyticsPerlearnerOrgsUsersCoursesGradingCutoffsRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3270
- courseId: string;
3271
- org: string; /**
3272
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3273
- */
3274
- departmentId?: number; /**
3275
- * end date. ISO 8601
3276
- */
3277
- endDate?: string; /**
3278
- * Format
3279
- *
3280
- * * `json` - json
3281
- */
3282
- format?: 'json'; /**
3283
- * Include main platform data
3284
- */
3285
- includeMainPlatform?: boolean; /**
3286
- * start date. ISO 8601
3287
- */
3288
- startDate?: string;
3289
- }): CancelablePromise<PerlearnerGradeWithCutOff>;
3290
- /**
3291
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
3292
- * @returns DetailedGradeView
3293
- * @throws ApiError
3294
- */
3295
- static aiAnalyticsPerlearnerOrgsUsersCoursesGradingDetailRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3296
- courseId: string;
3297
- org: string; /**
3298
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3299
- */
3300
- departmentId?: number; /**
3301
- * end date. ISO 8601
3302
- */
3303
- endDate?: string; /**
3304
- * Format
3305
- *
3306
- * * `json` - json
3307
- */
3308
- format?: 'json'; /**
3309
- * Include main platform data
3310
- */
3311
- includeMainPlatform?: boolean; /**
3312
- * start date. ISO 8601
3313
- */
3314
- startDate?: string;
3315
- }): CancelablePromise<DetailedGradeView>;
3316
- /**
3317
- * Query Params
3318
- * 1. course_id e.g course-v1:Org+Course4+Run
3319
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3320
- * @returns PerlearnerGradeSummary
3321
- * @throws ApiError
3322
- */
3323
- static aiAnalyticsPerlearnerOrgsUsersCoursesGradingSummaryRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3324
- courseId: string;
3325
- org: string; /**
3326
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3327
- */
3328
- departmentId?: number; /**
3329
- * end date. ISO 8601
3330
- */
3331
- endDate?: string; /**
3332
- * Format
3333
- *
3334
- * * `json` - json
3335
- */
3336
- format?: 'json'; /**
3337
- * Include main platform data
3338
- */
3339
- includeMainPlatform?: boolean; /**
3340
- * start date. ISO 8601
3341
- */
3342
- startDate?: string;
3343
- }): CancelablePromise<PerlearnerGradeSummary>;
3344
- /**
3345
- * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
3346
- * @returns Value
3347
- * @throws ApiError
3348
- */
3349
- static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve({ courseId, org, userId, }: {
3350
- courseId: string;
3351
- org: string;
3352
- }): CancelablePromise<Value>;
3353
- /**
3354
- * Provides about a learner current grade in a course with the course cut
3355
- * Kwargs
3356
- * 1. course_id e.g course-v1:Org+Course4+Run
3357
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3358
- * @returns PerlearnerGradeWithCutOff
3359
- * @throws ApiError
3360
- */
3361
- static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewGradeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3362
- courseId: string;
3363
- org: string; /**
3364
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3365
- */
3366
- departmentId?: number; /**
3367
- * end date. ISO 8601
3368
- */
3369
- endDate?: string; /**
3370
- * Format
3371
- *
3372
- * * `json` - json
3373
- */
3374
- format?: 'json'; /**
3375
- * Include main platform data
3376
- */
3377
- includeMainPlatform?: boolean; /**
3378
- * start date. ISO 8601
3379
- */
3380
- startDate?: string;
3381
- }): CancelablePromise<PerlearnerGradeWithCutOff>;
3382
- /**
3383
- * Evaluates performance index for platform, per course, per user and per user-per course
3384
- *
3385
- * Query Params
3386
- * course_id <optional>
3387
- * learner_id <optional>
3388
- * @returns Value
3389
- * @throws ApiError
3390
- */
3391
- static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3392
- courseId: string;
3393
- org: string; /**
3394
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3395
- */
3396
- departmentId?: number; /**
3397
- * end date. ISO 8601
3398
- */
3399
- endDate?: string; /**
3400
- * Format
3401
- *
3402
- * * `json` - json
3403
- */
3404
- format?: 'json'; /**
3405
- * Include main platform data
3406
- */
3407
- includeMainPlatform?: boolean; /**
3408
- * start date. ISO 8601
3409
- */
3410
- startDate?: string;
3411
- }): CancelablePromise<Value>;
3412
- /**
3413
- * Time spent within a course in secs on a per-day basis
3414
- *
3415
- * Kwargs
3416
- * 1. course_id e.g course-v1:Org+Course4+Run
3417
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3418
- * Query Params
3419
- * 3. start_date e.g 2020-10-01
3420
- * 4. end_date e.g 2020-10-10
3421
- *
3422
- * Default result when no query param is added is last_7_days (today inclusive)
3423
- * @returns OverTimeWithTotal
3424
- * @throws ApiError
3425
- */
3426
- static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3427
- courseId: string;
3428
- org: string; /**
3429
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3430
- */
3431
- departmentId?: number; /**
3432
- * end date. ISO 8601
3433
- */
3434
- endDate?: string; /**
3435
- * Format
3436
- *
3437
- * * `json` - json
3438
- */
3439
- format?: 'json'; /**
3440
- * Include main platform data
3441
- */
3442
- includeMainPlatform?: boolean; /**
3443
- * start date. ISO 8601
3444
- */
3445
- startDate?: string;
3446
- }): CancelablePromise<OverTimeWithTotal>;
3447
- /**
3448
- * List of videos within a course a learner has watched
3449
- *
3450
- * Kwargs
3451
- * 1. course_id e.g course-v1:Org+Course4+Run
3452
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3453
- *
3454
- * Default result when no query param is added is [], 0
3455
- * @returns PerLearnerCourseVideosWatched
3456
- * @throws ApiError
3457
- */
3458
- static aiAnalyticsPerlearnerOrgsUsersCoursesVideosRetrieve({ courseId, org, userId, departmentId, format, includeMainPlatform, }: {
3459
- courseId: string;
3460
- org: string; /**
3461
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3462
- */
3463
- departmentId?: number; /**
3464
- * Format
3465
- *
3466
- * * `json` - json
3467
- */
3468
- format?: 'json'; /**
3469
- * Include main platform data
3470
- */
3471
- includeMainPlatform?: boolean;
3472
- }): CancelablePromise<PerLearnerCourseVideosWatched>;
3473
- /**
3474
- * Get video watch counts over time.
3475
- *
3476
- * This endpoint provides daily counts of videos watched over a specified time period,
3477
- * with options to filter by course or user.
3478
- *
3479
- * Query Parameters:
3480
- * start_date (str, optional): Start date for the time range (ISO format)
3481
- * end_date (str, optional): End date for the time range (ISO format)
3482
- * course_id (str, optional): Filter by course ID
3483
- * user_id (str, optional): Filter by username or email
3484
- *
3485
- * Returns:
3486
- * Daily video watch counts over the specified time period.
3487
- *
3488
- * Default time range is the last 7 days if no dates are specified.
3489
- *
3490
- * Access Control:
3491
- * - Platform admins can access any video watch data
3492
- * - Learners can access their own video watch data
3493
- * @returns OverTimeWithTotal
3494
- * @throws ApiError
3495
- */
3496
- static aiAnalyticsPerlearnerOrgsUsersCoursesVideosOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3497
- courseId: string;
3498
- org: string; /**
3499
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3500
- */
3501
- departmentId?: number; /**
3502
- * end date. ISO 8601
3503
- */
3504
- endDate?: string; /**
3505
- * Format
3506
- *
3507
- * * `json` - json
3508
- */
3509
- format?: 'json'; /**
3510
- * Include main platform data
3511
- */
3512
- includeMainPlatform?: boolean; /**
3513
- * start date. ISO 8601
3514
- */
3515
- startDate?: string;
3516
- }): CancelablePromise<OverTimeWithTotal>;
3517
- /**
3518
- * Summary Grading Information for a learner on a per-enrollment basis
3519
- *
3520
- * Query Params
3521
- * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
3522
- * @returns PerlearnerGradingPerCourseAPI
3523
- * @throws ApiError
3524
- */
3525
- static aiAnalyticsPerlearnerOrgsUsersGradesPerCourseRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
3526
- org: string; /**
3527
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3528
- */
3529
- departmentId?: number; /**
3530
- * Format
3531
- *
3532
- * * `json` - json
3533
- */
3534
- format?: 'json'; /**
3535
- * Include main platform data
3536
- */
3537
- includeMainPlatform?: boolean;
3538
- }): CancelablePromise<PerlearnerGradingPerCourseAPI>;
3539
- /**
3540
- * Retrieve detailed information about a specific learner.
3541
- *
3542
- * This endpoint returns personal and activity information about a learner,
3543
- * including profile data, activity metrics, and location information.
3544
- *
3545
- * Path Parameters:
3546
- * user_id (str): The username or email of the learner
3547
- *
3548
- * Query Parameters:
3549
- * meta (bool): Include additional analytics information when true
3550
- *
3551
- * Returns:
3552
- * Detailed learner information including:
3553
- * - Profile data (username, name, email)
3554
- * - Registration and activity dates
3555
- * - Activity metrics (assessments, time spent, videos watched)
3556
- * - Location and browser information (when available)
3557
- *
3558
- * Access Control:
3559
- * - Platform admins can access any learner
3560
- * - Learners can access their own information
3561
- * - Department admins can access learners in their departments
3562
- * @returns LearnerInformationAPI
3563
- * @throws ApiError
3564
- */
3565
- static aiAnalyticsPerlearnerOrgsUsersInfoRetrieve({ org, userId, departmentId, format, includeMainPlatform, meta, search, }: {
3566
- org: string; /**
3567
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3568
- */
3569
- departmentId?: number; /**
3570
- * Format
3571
- *
3572
- * * `json` - json
3573
- */
3574
- format?: 'json'; /**
3575
- * Include main platform data
3576
- */
3577
- includeMainPlatform?: boolean; /**
3578
- * Include extra analytics information?
3579
- *
3580
- * * `y` - y
3581
- * * `yes` - yes
3582
- * * `true` - true
3583
- * * `True` - True
3584
- * * `n` - n
3585
- * * `no` - no
3586
- * * `false` - false
3587
- * * `False` - False
3588
- */
3589
- meta?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
3590
- search?: string;
3591
- }): CancelablePromise<LearnerInformationAPI>;
3592
- /**
3593
- * Last course accessed by a learner, includes upto unit information as well
3594
- * @returns PerLearnerLastAccess
3595
- * @throws ApiError
3596
- */
3597
- static aiAnalyticsPerlearnerOrgsUsersLastAccessRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
3598
- org: string; /**
3599
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3600
- */
3601
- departmentId?: number; /**
3602
- * Format
3603
- *
3604
- * * `json` - json
3605
- */
3606
- format?: 'json'; /**
3607
- * Include main platform data
3608
- */
3609
- includeMainPlatform?: boolean;
3610
- }): CancelablePromise<PerLearnerLastAccess>;
3611
- /**
3612
- * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
3613
- * @returns Value
3614
- * @throws ApiError
3615
- */
3616
- static aiAnalyticsPerlearnerOrgsUsersOverviewEngagementIndexRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3617
- org: string; /**
3618
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3619
- */
3620
- departmentId?: number; /**
3621
- * end date. ISO 8601
3622
- */
3623
- endDate?: string; /**
3624
- * Format
3625
- *
3626
- * * `json` - json
3627
- */
3628
- format?: 'json'; /**
3629
- * Include main platform data
3630
- */
3631
- includeMainPlatform?: boolean; /**
3632
- * start date. ISO 8601
3633
- */
3634
- startDate?: string;
3635
- }): CancelablePromise<Value>;
3636
- /**
3637
- * Get average grade value for platform, course, or user.
3638
- *
3639
- * This endpoint returns the average grade at different levels:
3640
- * - Platform level: Average grade across all courses
3641
- * - Course level: Average grade for a specific course
3642
- * - Learner level: Average grade for a specific learner
3643
- * - Course-learner level: Grade for a specific learner in a specific course
3644
- *
3645
- * Query Parameters:
3646
- * course_id (str, optional): Filter by course ID
3647
- * learner_id (str, optional): Filter by username or email
3648
- *
3649
- * Returns:
3650
- * The average grade value based on the specified filters.
3651
- *
3652
- * Access Control:
3653
- * - Platform admins can access any grade data
3654
- * - Learners can access their own grade data
3655
- * @returns Average
3656
- * @throws ApiError
3657
- */
3658
- static aiAnalyticsPerlearnerOrgsUsersOverviewGradesAverageRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
3659
- org: string; /**
3660
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3661
- */
3662
- departmentId?: number; /**
3663
- * Format
3664
- *
3665
- * * `json` - json
3666
- */
3667
- format?: 'json'; /**
3668
- * Include main platform data
3669
- */
3670
- includeMainPlatform?: boolean;
3671
- }): CancelablePromise<Average>;
3672
- /**
3673
- * Evaluates performance index for platform, per course, per user and per user-per course
3674
- *
3675
- * Query Params
3676
- * course_id <optional>
3677
- * learner_id <optional>
3678
- * @returns Value
3679
- * @throws ApiError
3680
- */
3681
- static aiAnalyticsPerlearnerOrgsUsersOverviewPerformanceIndexRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3682
- org: string; /**
3683
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3684
- */
3685
- departmentId?: number; /**
3686
- * end date. ISO 8601
3687
- */
3688
- endDate?: string; /**
3689
- * Format
3690
- *
3691
- * * `json` - json
3692
- */
3693
- format?: 'json'; /**
3694
- * Include main platform data
3695
- */
3696
- includeMainPlatform?: boolean; /**
3697
- * start date. ISO 8601
3698
- */
3699
- startDate?: string;
3700
- }): CancelablePromise<Value>;
3701
- /**
3702
- * Time spent in secs on a per-day basis
3703
- *
3704
- * Query Params
3705
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
3706
- * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
3707
- * 3. start_date e.g 2020-10-01
3708
- * 4. end_date e.g 2020-10-10
3709
- *
3710
- * Default result when no query param is added is last_7_days (today inclusive)
3711
- * @returns OverTimeWithTotal
3712
- * @throws ApiError
3713
- */
3714
- static aiAnalyticsPerlearnerOrgsUsersOverviewTimeOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3715
- org: string; /**
3716
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3717
- */
3718
- departmentId?: number; /**
3719
- * end date. ISO 8601
3720
- */
3721
- endDate?: string; /**
3722
- * Format
3723
- *
3724
- * * `json` - json
3725
- */
3726
- format?: 'json'; /**
3727
- * Include main platform data
3728
- */
3729
- includeMainPlatform?: boolean; /**
3730
- * start date. ISO 8601
3731
- */
3732
- startDate?: string;
3733
- }): CancelablePromise<OverTimeWithTotal>;
3734
- /**
3735
- * Get video watch counts over time.
3736
- *
3737
- * This endpoint provides daily counts of videos watched over a specified time period,
3738
- * with options to filter by course or user.
3739
- *
3740
- * Query Parameters:
3741
- * start_date (str, optional): Start date for the time range (ISO format)
3742
- * end_date (str, optional): End date for the time range (ISO format)
3743
- * course_id (str, optional): Filter by course ID
3744
- * user_id (str, optional): Filter by username or email
3745
- *
3746
- * Returns:
3747
- * Daily video watch counts over the specified time period.
3748
- *
3749
- * Default time range is the last 7 days if no dates are specified.
3750
- *
3751
- * Access Control:
3752
- * - Platform admins can access any video watch data
3753
- * - Learners can access their own video watch data
3754
- * @returns OverTimeWithTotal
3755
- * @throws ApiError
3756
- */
3757
- static aiAnalyticsPerlearnerOrgsUsersVideosOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3758
- org: string; /**
3759
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3760
- */
3761
- departmentId?: number; /**
3762
- * end date. ISO 8601
3763
- */
3764
- endDate?: string; /**
3765
- * Format
3766
- *
3767
- * * `json` - json
3768
- */
3769
- format?: 'json'; /**
3770
- * Include main platform data
3771
- */
3772
- includeMainPlatform?: boolean; /**
3773
- * start date. ISO 8601
3774
- */
3775
- startDate?: string;
3776
- }): CancelablePromise<OverTimeWithTotal>;
3777
- /**
3778
- * Summary Videos watched data for a learner per enrollment
3779
- *
3780
- * Query Params
3781
- * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
3782
- * @returns PerlearnerEngagementVideosWatchedPerCourse
3783
- * @throws ApiError
3784
- */
3785
- static aiAnalyticsPerlearnerOrgsUsersVideosPerCourseRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3786
- org: string; /**
3787
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3788
- */
3789
- departmentId?: number; /**
3790
- * end date. ISO 8601
3791
- */
3792
- endDate?: string; /**
3793
- * Format
3794
- *
3795
- * * `json` - json
3796
- */
3797
- format?: 'json'; /**
3798
- * Include main platform data
3799
- */
3800
- includeMainPlatform?: boolean; /**
3801
- * start date. ISO 8601
3802
- */
3803
- startDate?: string;
3804
- }): CancelablePromise<PerlearnerEngagementVideosWatchedPerCourse>;
3805
- /**
3806
- * Get a list of user groups with metrics and filtering options.
3807
- *
3808
- * This endpoint provides a paginated list of user groups with aggregated metrics
3809
- * about learner performance, course completions, and skill acquisition.
3810
- *
3811
- * This endpoint uses DM token authentication and respects department-based
3812
- * access controls.
3813
- *
3814
- * Query Parameters:
3815
- * page (int, optional): Page number for pagination
3816
- * length (int, optional): Number of items per page
3817
- * program (str, optional): Filter by program
3818
- * pathway (str, optional): Filter by pathway
3819
- * groups (list, optional): Filter by group names
3820
- * location (str, optional): Filter by location
3821
- * is_enrolled (bool, optional): Filter for groups with enrolled users
3822
- * start_date (date, optional): Filter by learner join date (start range)
3823
- * end_date (date, optional): Filter by learner join date (end range)
3824
- *
3825
- * Returns:
3826
- * A paginated list of user groups with comprehensive metrics.
3827
- *
3828
- * Access Control:
3829
- * - Platform admins can see all groups
3830
- * - Department admins can only see groups in their departments
3831
- * @returns GroupList
3832
- * @throws ApiError
3833
- */
3834
- static aiAnalyticsUserGroupsOrgsRetrieve({ org, departmentId, endDate, format, groups, includeMainPlatform, isEnrolled, length, location, page, pathway, program, startDate, }: {
3835
- org: string;
3836
- /**
3837
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3838
- */
3839
- departmentId?: number;
3840
- /**
3841
- * Filter by learners date_joined. Start date. ISO 8601
3842
- */
3843
- endDate?: string;
3844
- /**
3845
- * Format
3846
- *
3847
- * * `json` - json
3848
- */
3849
- format?: 'json';
3850
- /**
3851
- * Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
3852
- */
3853
- groups?: Array<string>;
3854
- /**
3855
- * Include main platform data
3856
- */
3857
- includeMainPlatform?: boolean;
3858
- /**
3859
- * Filter for users who have at least an enrollment
3860
- */
3861
- isEnrolled?: boolean | null;
3862
- /**
3863
- * Size of data to return
3864
- */
3865
- length?: number;
3866
- /**
3867
- * Location search string
3868
- */
3869
- location?: string;
3870
- /**
3871
- * Page offset
3872
- */
3873
- page?: number;
3874
- /**
3875
- * Pathway string
3876
- */
3877
- pathway?: string;
3878
- /**
3879
- * Program search string
3880
- */
3881
- program?: string;
3882
- /**
3883
- * Filter by learners date_joined. Start date. ISO 8601
3884
- */
3885
- startDate?: string;
3886
- }): CancelablePromise<GroupList>;
3887
- }