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