@iblai/iblai-api 4.14.5-loadtest2-core → 4.14.5-loadtest2-ai

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