@iblai/iblai-api 4.115.1-test-ai → 4.116.0-core

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (895) hide show
  1. package/dist/index.cjs.js +3200 -25675
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +3201 -25667
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +3200 -25675
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +1 -437
  8. package/dist/types/models/{StripeCheckoutSessionRequestModeEnum.d.ts → ModeEnum.d.ts} +1 -1
  9. package/dist/types/models/Pagination.d.ts +11 -16
  10. package/dist/types/models/StripeCheckoutSessionRequest.d.ts +2 -2
  11. package/dist/types/services/AiAnalyticsService.d.ts +28 -4700
  12. package/dist/types/services/AnalyticsService.d.ts +4 -709
  13. package/dist/types/services/SearchService.d.ts +0 -738
  14. package/package.json +1 -1
  15. package/sdk_schema.yml +24840 -74078
  16. package/src/core/OpenAPI.ts +1 -1
  17. package/src/index.ts +1 -437
  18. package/src/models/{StripeCheckoutSessionRequestModeEnum.ts → ModeEnum.ts} +1 -1
  19. package/src/models/Pagination.ts +11 -16
  20. package/src/models/StripeCheckoutSessionRequest.ts +2 -2
  21. package/src/services/AiAnalyticsService.ts +5272 -12938
  22. package/src/services/AnalyticsService.ts +183 -1240
  23. package/src/services/SearchService.ts +398 -1459
  24. package/dist/types/models/AIGeneratedImage.d.ts +0 -13
  25. package/dist/types/models/AIUserProfileMemoryRelation.d.ts +0 -4
  26. package/dist/types/models/AIUserProfileRequest.d.ts +0 -4
  27. package/dist/types/models/AccessEnum.d.ts +0 -8
  28. package/dist/types/models/AccessTimesHeatmap.d.ts +0 -5
  29. package/dist/types/models/AccessibleMentorsByEmailRequest.d.ts +0 -13
  30. package/dist/types/models/AccessibleMentorsByEmailResponse.d.ts +0 -13
  31. package/dist/types/models/ActionBreakdown.d.ts +0 -10
  32. package/dist/types/models/AddMentorToDisclaimer.d.ts +0 -12
  33. package/dist/types/models/AlignMentorBubbleEnum.d.ts +0 -8
  34. package/dist/types/models/AnalyticsOverview.d.ts +0 -7
  35. package/dist/types/models/Answer.d.ts +0 -11
  36. package/dist/types/models/Artifact.d.ts +0 -60
  37. package/dist/types/models/ArtifactList.d.ts +0 -42
  38. package/dist/types/models/ArtifactVersion.d.ts +0 -55
  39. package/dist/types/models/AssumedKnowledge.d.ts +0 -4
  40. package/dist/types/models/AssumedKnowledgeLevel.d.ts +0 -4
  41. package/dist/types/models/AudioToTextRequest.d.ts +0 -3
  42. package/dist/types/models/AudioToTextResponse.d.ts +0 -3
  43. package/dist/types/models/AuthTypeEnum.d.ts +0 -10
  44. package/dist/types/models/AutoMemoryPrompt.d.ts +0 -4
  45. package/dist/types/models/BaseFinanceResponse.d.ts +0 -37
  46. package/dist/types/models/BillingPeriod.d.ts +0 -8
  47. package/dist/types/models/Bot.d.ts +0 -15
  48. package/dist/types/models/BotCommand.d.ts +0 -6
  49. package/dist/types/models/BotCreate.d.ts +0 -12
  50. package/dist/types/models/Breakdown.d.ts +0 -11
  51. package/dist/types/models/CallAuthenticationRequest.d.ts +0 -17
  52. package/dist/types/models/CallAuthenticationResponse.d.ts +0 -21
  53. package/dist/types/models/CallConfiguration.d.ts +0 -30
  54. package/dist/types/models/CallConfigurationModeEnum.d.ts +0 -8
  55. package/dist/types/models/ChatHistory.d.ts +0 -11
  56. package/dist/types/models/ChatHistoryFilterData.d.ts +0 -9
  57. package/dist/types/models/ChatHistoryFilterUser.d.ts +0 -5
  58. package/dist/types/models/ChatHistoryItem.d.ts +0 -5
  59. package/dist/types/models/ChatHistorySessionId.d.ts +0 -3
  60. package/dist/types/models/ChatSessionRequest.d.ts +0 -15
  61. package/dist/types/models/ChatSessionResponse.d.ts +0 -8
  62. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +0 -10
  63. package/dist/types/models/ComparisonInfo.d.ts +0 -29
  64. package/dist/types/models/ComponentBlock.d.ts +0 -9
  65. package/dist/types/models/ComponentBlockTypeEnum.d.ts +0 -8
  66. package/dist/types/models/ConnectedService.d.ts +0 -24
  67. package/dist/types/models/ConversationChartPoint.d.ts +0 -4
  68. package/dist/types/models/ConversationDetailResponse.d.ts +0 -4
  69. package/dist/types/models/ConversationListItem.d.ts +0 -24
  70. package/dist/types/models/ConversationListResponse.d.ts +0 -6
  71. package/dist/types/models/ConversationMessage.d.ts +0 -11
  72. package/dist/types/models/ConversationRating.d.ts +0 -6
  73. package/dist/types/models/ConversationSummary.d.ts +0 -5
  74. package/dist/types/models/ConversationVolume.d.ts +0 -4
  75. package/dist/types/models/Conversations.d.ts +0 -42
  76. package/dist/types/models/ConversationsChart.d.ts +0 -5
  77. package/dist/types/models/Cost.d.ts +0 -3
  78. package/dist/types/models/CostPerTenant.d.ts +0 -6
  79. package/dist/types/models/CourseCreationTask.d.ts +0 -31
  80. package/dist/types/models/CourseCreationTaskFile.d.ts +0 -7
  81. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +0 -16
  82. package/dist/types/models/CourseRecommendation.d.ts +0 -49
  83. package/dist/types/models/CrawlerPatternTypeEnum.d.ts +0 -8
  84. package/dist/types/models/CredentialRequest.d.ts +0 -14
  85. package/dist/types/models/CrontabSchedule.d.ts +0 -22
  86. package/dist/types/models/CurrentUsersResponse.d.ts +0 -8
  87. package/dist/types/models/CustomInstructionResponse.d.ts +0 -13
  88. package/dist/types/models/DataSet.d.ts +0 -21
  89. package/dist/types/models/DataSetCreate.d.ts +0 -12
  90. package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
  91. package/dist/types/models/DateRange.d.ts +0 -4
  92. package/dist/types/models/Disclaimer.d.ts +0 -17
  93. package/dist/types/models/DisclaimerAgreement.d.ts +0 -11
  94. package/dist/types/models/DisclaimerScopeEnum.d.ts +0 -8
  95. package/dist/types/models/DiscordConfig.d.ts +0 -7
  96. package/dist/types/models/DiscordUserConfig.d.ts +0 -10
  97. package/dist/types/models/DiscordWebhook.d.ts +0 -6
  98. package/dist/types/models/Document.d.ts +0 -41
  99. package/dist/types/models/DocumentFacet.d.ts +0 -17
  100. package/dist/types/models/DocumentFromPoolRequest.d.ts +0 -10
  101. package/dist/types/models/DocumentSearchResponse.d.ts +0 -35
  102. package/dist/types/models/DocumentSettingsResponse.d.ts +0 -3
  103. package/dist/types/models/EdxCourse.d.ts +0 -11
  104. package/dist/types/models/ElevenlabsCustomVoice.d.ts +0 -4
  105. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +0 -8
  106. package/dist/types/models/EmailPromptDetail.d.ts +0 -13
  107. package/dist/types/models/EmailPromptList.d.ts +0 -11
  108. package/dist/types/models/EmailPromptSummary.d.ts +0 -5
  109. package/dist/types/models/Entity.d.ts +0 -11
  110. package/dist/types/models/EntityTypeEnum.d.ts +0 -10
  111. package/dist/types/models/Error.d.ts +0 -3
  112. package/dist/types/models/ExternalServiceInfo.d.ts +0 -6
  113. package/dist/types/models/FileUploadURLRequest.d.ts +0 -21
  114. package/dist/types/models/FileUploadURLResponse.d.ts +0 -25
  115. package/dist/types/models/FinanceDetailsResponse.d.ts +0 -13
  116. package/dist/types/models/FinanceFilters.d.ts +0 -15
  117. package/dist/types/models/FreeUsageCount.d.ts +0 -3
  118. package/dist/types/models/FullCourse.d.ts +0 -13
  119. package/dist/types/models/GoogleAgentDetail.d.ts +0 -17
  120. package/dist/types/models/GrantMentorAccessRequest.d.ts +0 -9
  121. package/dist/types/models/GreetingMethodEnum.d.ts +0 -8
  122. package/dist/types/models/GuidedPrompt.d.ts +0 -4
  123. package/dist/types/models/GuidedPromptsResponse.d.ts +0 -5
  124. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +0 -8
  125. package/dist/types/models/HeygenMarketingVideoList.d.ts +0 -6
  126. package/dist/types/models/HeygenTemplateRequest.d.ts +0 -5
  127. package/dist/types/models/HeygenTemplateResponseSingle.d.ts +0 -6
  128. package/dist/types/models/HeygenVideoDetail.d.ts +0 -8
  129. package/dist/types/models/HeygenVideoRequest.d.ts +0 -5
  130. package/dist/types/models/HumanSupportTicket.d.ts +0 -23
  131. package/dist/types/models/HumanSupportTicketStatusEnum.d.ts +0 -10
  132. package/dist/types/models/InputQuestion.d.ts +0 -6
  133. package/dist/types/models/IntegrationCredential.d.ts +0 -10
  134. package/dist/types/models/IntegrationCredentialSchema.d.ts +0 -6
  135. package/dist/types/models/InterfaceEnum.d.ts +0 -8
  136. package/dist/types/models/IntialQuestionAnswer.d.ts +0 -3
  137. package/dist/types/models/InvoiceReportResponse.d.ts +0 -13
  138. package/dist/types/models/JobRun.d.ts +0 -11
  139. package/dist/types/models/KindEnum.d.ts +0 -10
  140. package/dist/types/models/LLMCredentialRequest.d.ts +0 -14
  141. package/dist/types/models/LLMCredentialResponse.d.ts +0 -10
  142. package/dist/types/models/LLMCredentialSchema.d.ts +0 -6
  143. package/dist/types/models/LLMModelForTenant.d.ts +0 -6
  144. package/dist/types/models/LLMQuestion.d.ts +0 -15
  145. package/dist/types/models/LLMResponse.d.ts +0 -18
  146. package/dist/types/models/LLMTracesListResponse.d.ts +0 -5
  147. package/dist/types/models/LanguagesView.d.ts +0 -5
  148. package/dist/types/models/LinkCourseRequest.d.ts +0 -3
  149. package/dist/types/models/LinkCourseResponse.d.ts +0 -5
  150. package/dist/types/models/LlmProviderEnum.d.ts +0 -10
  151. package/dist/types/models/MCPServer.d.ts +0 -50
  152. package/dist/types/models/MCPServerConnection.d.ts +0 -47
  153. package/dist/types/models/MCPServerConnectionScopeEnum.d.ts +0 -10
  154. package/dist/types/models/MCPServerOauthFind.d.ts +0 -3
  155. package/dist/types/models/MaskedIntegrationCredential.d.ts +0 -10
  156. package/dist/types/models/MaskedLLMCredential.d.ts +0 -10
  157. package/dist/types/models/MemoryComponentData.d.ts +0 -5
  158. package/dist/types/models/MemoryComponentMemory.d.ts +0 -4
  159. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +0 -8
  160. package/dist/types/models/MemoryComponentResponse.d.ts +0 -5
  161. package/dist/types/models/MemoryProgress.d.ts +0 -8
  162. package/dist/types/models/MemoryStatusRequestView.d.ts +0 -6
  163. package/dist/types/models/MemoryStatusView.d.ts +0 -6
  164. package/dist/types/models/Mentor.d.ts +0 -147
  165. package/dist/types/models/MentorAudience.d.ts +0 -5
  166. package/dist/types/models/MentorBreakdown.d.ts +0 -9
  167. package/dist/types/models/MentorCategory.d.ts +0 -9
  168. package/dist/types/models/MentorCategoryCreate.d.ts +0 -11
  169. package/dist/types/models/MentorCategoryGroup.d.ts +0 -11
  170. package/dist/types/models/MentorCategoryGroupCreate.d.ts +0 -11
  171. package/dist/types/models/MentorCreate.d.ts +0 -137
  172. package/dist/types/models/MentorCustomVoice.d.ts +0 -4
  173. package/dist/types/models/MentorCustomVoiceResponse.d.ts +0 -4
  174. package/dist/types/models/MentorData.d.ts +0 -7
  175. package/dist/types/models/MentorDetailAnalytics.d.ts +0 -6
  176. package/dist/types/models/MentorEval.d.ts +0 -11
  177. package/dist/types/models/MentorEvalQuestion.d.ts +0 -5
  178. package/dist/types/models/MentorEvalQuestionRequest.d.ts +0 -4
  179. package/dist/types/models/MentorEvalReport.d.ts +0 -10
  180. package/dist/types/models/MentorEvalRequest.d.ts +0 -8
  181. package/dist/types/models/MentorFacet.d.ts +0 -17
  182. package/dist/types/models/MentorFork.d.ts +0 -5
  183. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +0 -65
  184. package/dist/types/models/MentorMemorySettingsRequest.d.ts +0 -6
  185. package/dist/types/models/MentorMemorySettingsResponse.d.ts +0 -6
  186. package/dist/types/models/MentorMetadata.d.ts +0 -5
  187. package/dist/types/models/MentorScenario.d.ts +0 -6
  188. package/dist/types/models/MentorScenarioPrompt.d.ts +0 -5
  189. package/dist/types/models/MentorSearchResponse.d.ts +0 -35
  190. package/dist/types/models/MentorSession.d.ts +0 -4
  191. package/dist/types/models/MentorSettings.d.ts +0 -104
  192. package/dist/types/models/MentorSettingsPublic.d.ts +0 -77
  193. package/dist/types/models/MentorSettingsRequest.d.ts +0 -79
  194. package/dist/types/models/MentorSummary.d.ts +0 -5
  195. package/dist/types/models/MentorType.d.ts +0 -5
  196. package/dist/types/models/MentorUserSetting.d.ts +0 -4
  197. package/dist/types/models/MentorVisibilityEnum.d.ts +0 -10
  198. package/dist/types/models/MentorWizard.d.ts +0 -4
  199. package/dist/types/models/MessageStatistics.d.ts +0 -5
  200. package/dist/types/models/MessageView.d.ts +0 -11
  201. package/dist/types/models/MessageViewRequest.d.ts +0 -9
  202. package/dist/types/models/MessageViewUpdatResponse.d.ts +0 -3
  203. package/dist/types/models/Metadata.d.ts +0 -5
  204. package/dist/types/models/MetricChange.d.ts +0 -4
  205. package/dist/types/models/MetricInfo.d.ts +0 -5
  206. package/dist/types/models/ModelCost.d.ts +0 -4
  207. package/dist/types/models/ModerationLog.d.ts +0 -12
  208. package/dist/types/models/NoChatMessagesFound.d.ts +0 -3
  209. package/dist/types/models/OAuthProvider.d.ts +0 -24
  210. package/dist/types/models/OAuthService.d.ts +0 -18
  211. package/dist/types/models/OAuthStartResponse.d.ts +0 -3
  212. package/dist/types/models/OauthCredentialsMasked.d.ts +0 -10
  213. package/dist/types/models/Observation.d.ts +0 -31
  214. package/dist/types/models/OvertimeData.d.ts +0 -13
  215. package/dist/types/models/PageContent.d.ts +0 -6
  216. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +0 -7
  217. package/dist/types/models/PaginatedArtifactListList.d.ts +0 -7
  218. package/dist/types/models/PaginatedArtifactVersionList.d.ts +0 -7
  219. package/dist/types/models/PaginatedConversationsList.d.ts +0 -7
  220. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +0 -7
  221. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +0 -7
  222. package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
  223. package/dist/types/models/PaginatedDisclaimerAgreementList.d.ts +0 -7
  224. package/dist/types/models/PaginatedDisclaimerList.d.ts +0 -7
  225. package/dist/types/models/PaginatedEdxCourseList.d.ts +0 -7
  226. package/dist/types/models/PaginatedEmailPromptListList.d.ts +0 -7
  227. package/dist/types/models/PaginatedGoogleAgentDetailList.d.ts +0 -7
  228. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +0 -7
  229. package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +0 -7
  230. package/dist/types/models/PaginatedHumanSupportTicketList.d.ts +0 -7
  231. package/dist/types/models/PaginatedJobRunList.d.ts +0 -7
  232. package/dist/types/models/PaginatedMCPServerConnectionList.d.ts +0 -7
  233. package/dist/types/models/PaginatedMCPServerList.d.ts +0 -7
  234. package/dist/types/models/PaginatedMentorList.d.ts +0 -7
  235. package/dist/types/models/PaginatedModerationLogList.d.ts +0 -7
  236. package/dist/types/models/PaginatedObservationList.d.ts +0 -7
  237. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +0 -7
  238. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +0 -7
  239. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +0 -7
  240. package/dist/types/models/PaginatedProjectList.d.ts +0 -7
  241. package/dist/types/models/PaginatedRetrieverDocumentEmbeddingList.d.ts +0 -7
  242. package/dist/types/models/PaginatedSectionList.d.ts +0 -7
  243. package/dist/types/models/PaginatedSubSectionList.d.ts +0 -7
  244. package/dist/types/models/PaginatedTicketMessageList.d.ts +0 -7
  245. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +0 -7
  246. package/dist/types/models/PaginatedTraceList.d.ts +0 -7
  247. package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
  248. package/dist/types/models/PaginatedUnitList.d.ts +0 -7
  249. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +0 -7
  250. package/dist/types/models/PaginatedUserMemoryList.d.ts +0 -7
  251. package/dist/types/models/PaginatedVeoVideoListList.d.ts +0 -7
  252. package/dist/types/models/PaginatedVoiceList.d.ts +0 -7
  253. package/dist/types/models/PatchedArtifact.d.ts +0 -60
  254. package/dist/types/models/PatchedBotCommand.d.ts +0 -6
  255. package/dist/types/models/PatchedBotCreate.d.ts +0 -12
  256. package/dist/types/models/PatchedCallConfiguration.d.ts +0 -30
  257. package/dist/types/models/PatchedConversations.d.ts +0 -42
  258. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +0 -7
  259. package/dist/types/models/PatchedCredentialRequest.d.ts +0 -14
  260. package/dist/types/models/PatchedDataSet.d.ts +0 -21
  261. package/dist/types/models/PatchedDisclaimer.d.ts +0 -17
  262. package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
  263. package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
  264. package/dist/types/models/PatchedGoogleAgentDetail.d.ts +0 -17
  265. package/dist/types/models/PatchedHumanSupportTicket.d.ts +0 -23
  266. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +0 -14
  267. package/dist/types/models/PatchedMCPServer.d.ts +0 -50
  268. package/dist/types/models/PatchedMCPServerConnection.d.ts +0 -47
  269. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +0 -11
  270. package/dist/types/models/PatchedMentorCreate.d.ts +0 -137
  271. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +0 -41
  272. package/dist/types/models/PatchedPlayWrightScript.d.ts +0 -12
  273. package/dist/types/models/PatchedProject.d.ts +0 -51
  274. package/dist/types/models/PatchedPrompt.d.ts +0 -22
  275. package/dist/types/models/PatchedSection.d.ts +0 -9
  276. package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
  277. package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
  278. package/dist/types/models/PatchedSubSection.d.ts +0 -9
  279. package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
  280. package/dist/types/models/PatchedTicketMessage.d.ts +0 -10
  281. package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
  282. package/dist/types/models/PatchedUnit.d.ts +0 -11
  283. package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
  284. package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
  285. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
  286. package/dist/types/models/PeriodInfo.d.ts +0 -21
  287. package/dist/types/models/PeriodicAgent.d.ts +0 -42
  288. package/dist/types/models/PeriodicAgentCreate.d.ts +0 -41
  289. package/dist/types/models/PeriodicAgentLog.d.ts +0 -11
  290. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +0 -10
  291. package/dist/types/models/PeriodicAgentStatistics.d.ts +0 -7
  292. package/dist/types/models/PeriodicTask.d.ts +0 -21
  293. package/dist/types/models/PieChartData.d.ts +0 -5
  294. package/dist/types/models/PieChartSegment.d.ts +0 -4
  295. package/dist/types/models/PinnedMessageCreate.d.ts +0 -9
  296. package/dist/types/models/PinnedMessageGet.d.ts +0 -7
  297. package/dist/types/models/PinnedMessageRequest.d.ts +0 -6
  298. package/dist/types/models/PlatformPrompt.d.ts +0 -34
  299. package/dist/types/models/PlatformPromptResponse.d.ts +0 -16
  300. package/dist/types/models/PlayWrightScript.d.ts +0 -12
  301. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +0 -4
  302. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +0 -4
  303. package/dist/types/models/PreviousAgentStatusEnum.d.ts +0 -12
  304. package/dist/types/models/Project.d.ts +0 -51
  305. package/dist/types/models/ProjectMentor.d.ts +0 -11
  306. package/dist/types/models/Prompt.d.ts +0 -22
  307. package/dist/types/models/PromptCategory.d.ts +0 -7
  308. package/dist/types/models/PromptFacet.d.ts +0 -17
  309. package/dist/types/models/PromptSearchResponse.d.ts +0 -35
  310. package/dist/types/models/PromptVisibilityEnum.d.ts +0 -10
  311. package/dist/types/models/Provider05cEnum.d.ts +0 -14
  312. package/dist/types/models/Provider63aEnum.d.ts +0 -6
  313. package/dist/types/models/ProviderBreakdown.d.ts +0 -8
  314. package/dist/types/models/QuestionCardTag.d.ts +0 -8
  315. package/dist/types/models/QuestionRequest.d.ts +0 -15
  316. package/dist/types/models/QuestionResponse.d.ts +0 -10
  317. package/dist/types/models/RatingAverageRecord.d.ts +0 -10
  318. package/dist/types/models/RatingEnum.d.ts +0 -8
  319. package/dist/types/models/RatingRecord.d.ts +0 -4
  320. package/dist/types/models/RatingsOvertime.d.ts +0 -5
  321. package/dist/types/models/RecentlyAccessedMentor.d.ts +0 -11
  322. package/dist/types/models/RecommendCourseBlock.d.ts +0 -3
  323. package/dist/types/models/RecommendCourseResponse.d.ts +0 -3
  324. package/dist/types/models/RecommendationTypeEnum.d.ts +0 -8
  325. package/dist/types/models/RecommendedCoursesResponse.d.ts +0 -33
  326. package/dist/types/models/RelatedText.d.ts +0 -3
  327. package/dist/types/models/RemoveMentorFromDisclaimer.d.ts +0 -12
  328. package/dist/types/models/RequestDataVariable.d.ts +0 -14
  329. package/dist/types/models/ResourceScrappedData.d.ts +0 -13
  330. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +0 -12
  331. package/dist/types/models/ResponseDataVariable.d.ts +0 -14
  332. package/dist/types/models/RetreiverTrainViewRequest.d.ts +0 -10
  333. package/dist/types/models/RetreiverTrainViewResponse.d.ts +0 -6
  334. package/dist/types/models/RetrieveTask.d.ts +0 -3
  335. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +0 -30
  336. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +0 -66
  337. package/dist/types/models/RetrieverRequestSearch.d.ts +0 -10
  338. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +0 -10
  339. package/dist/types/models/RetrieverResponseSearch.d.ts +0 -7
  340. package/dist/types/models/ReuestDataVariableList.d.ts +0 -4
  341. package/dist/types/models/RunMentorEval.d.ts +0 -3
  342. package/dist/types/models/ScanWebhookRequest.d.ts +0 -6
  343. package/dist/types/models/ScanWebhookResponse.d.ts +0 -3
  344. package/dist/types/models/Section.d.ts +0 -9
  345. package/dist/types/models/SectionWithChildren.d.ts +0 -11
  346. package/dist/types/models/SeedMentorsView.d.ts +0 -3
  347. package/dist/types/models/SentimentSummary.d.ts +0 -4
  348. package/dist/types/models/SessionBrowserScreenshot.d.ts +0 -8
  349. package/dist/types/models/SessionChartPoint.d.ts +0 -4
  350. package/dist/types/models/SessionDetail.d.ts +0 -6
  351. package/dist/types/models/SessionMemoryAttachment.d.ts +0 -3
  352. package/dist/types/models/SessionMemoryStorage.d.ts +0 -6
  353. package/dist/types/models/SessionsChart.d.ts +0 -5
  354. package/dist/types/models/SetCurrentVersionRequest.d.ts +0 -3
  355. package/dist/types/models/ShareableMentorLink.d.ts +0 -8
  356. package/dist/types/models/ShellLogs.d.ts +0 -3
  357. package/dist/types/models/SlackConfig.d.ts +0 -8
  358. package/dist/types/models/SlackUserConfig.d.ts +0 -17
  359. package/dist/types/models/SlackWebhook.d.ts +0 -6
  360. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +0 -3
  361. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +0 -5
  362. package/dist/types/models/StarMentor.d.ts +0 -7
  363. package/dist/types/models/Status6eeEnum.d.ts +0 -12
  364. package/dist/types/models/Step.d.ts +0 -9
  365. package/dist/types/models/StepStatusEnum.d.ts +0 -10
  366. package/dist/types/models/SttProviderEnum.d.ts +0 -14
  367. package/dist/types/models/StudentChatMessage.d.ts +0 -4
  368. package/dist/types/models/StylesView.d.ts +0 -4
  369. package/dist/types/models/SubSection.d.ts +0 -9
  370. package/dist/types/models/SubSectionWithChildren.d.ts +0 -11
  371. package/dist/types/models/Subject.d.ts +0 -5
  372. package/dist/types/models/Summary.d.ts +0 -9
  373. package/dist/types/models/TagsView.d.ts +0 -5
  374. package/dist/types/models/TargetSystemEnum.d.ts +0 -8
  375. package/dist/types/models/TaskView.d.ts +0 -3
  376. package/dist/types/models/TeamsConfig.d.ts +0 -7
  377. package/dist/types/models/TeamsWebhook.d.ts +0 -17
  378. package/dist/types/models/TemplateMentor.d.ts +0 -9
  379. package/dist/types/models/TenantMentorTraces.d.ts +0 -6
  380. package/dist/types/models/TenantSetting.d.ts +0 -5
  381. package/dist/types/models/ThemeEnum.d.ts +0 -8
  382. package/dist/types/models/TicketMessage.d.ts +0 -10
  383. package/dist/types/models/TonesView.d.ts +0 -4
  384. package/dist/types/models/ToolCategory.d.ts +0 -5
  385. package/dist/types/models/ToolResponse.d.ts +0 -15
  386. package/dist/types/models/TopicDetail.d.ts +0 -8
  387. package/dist/types/models/TopicDetails.d.ts +0 -5
  388. package/dist/types/models/TopicModel.d.ts +0 -3
  389. package/dist/types/models/TopicRecord.d.ts +0 -4
  390. package/dist/types/models/TopicStatistics.d.ts +0 -7
  391. package/dist/types/models/TopicStatisticsResponse.d.ts +0 -6
  392. package/dist/types/models/TopicSummaryView.d.ts +0 -4
  393. package/dist/types/models/TopicsOverview.d.ts +0 -22
  394. package/dist/types/models/TopicsOverviewMetric.d.ts +0 -21
  395. package/dist/types/models/Trace.d.ts +0 -17
  396. package/dist/types/models/TrainChatSessionDocumentView.d.ts +0 -6
  397. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +0 -6
  398. package/dist/types/models/TrainDocumentViewRequest.d.ts +0 -82
  399. package/dist/types/models/TrainDocumentViewResponse.d.ts +0 -15
  400. package/dist/types/models/Training.d.ts +0 -41
  401. package/dist/types/models/TrainingCreate.d.ts +0 -31
  402. package/dist/types/models/TrainingStatusEnum.d.ts +0 -12
  403. package/dist/types/models/TransportEnum.d.ts +0 -10
  404. package/dist/types/models/TrendEntry.d.ts +0 -4
  405. package/dist/types/models/TriggerRequest.d.ts +0 -5
  406. package/dist/types/models/TriggerResponse.d.ts +0 -6
  407. package/dist/types/models/TtsProviderEnum.d.ts +0 -12
  408. package/dist/types/models/TypeC42Enum.d.ts +0 -8
  409. package/dist/types/models/Unit.d.ts +0 -11
  410. package/dist/types/models/UnitWithChildren.d.ts +0 -13
  411. package/dist/types/models/UseMainCreds.d.ts +0 -3
  412. package/dist/types/models/UserAllChatMemoryView.d.ts +0 -7
  413. package/dist/types/models/UserCatalogItemMemoryView.d.ts +0 -14
  414. package/dist/types/models/UserChatByPeriod.d.ts +0 -4
  415. package/dist/types/models/UserChatFeedback.d.ts +0 -15
  416. package/dist/types/models/UserChatFeedbackCount.d.ts +0 -4
  417. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +0 -6
  418. package/dist/types/models/UserChatMemoryStatusView.d.ts +0 -6
  419. package/dist/types/models/UserChatMemoryUpdateView.d.ts +0 -10
  420. package/dist/types/models/UserCountRecord.d.ts +0 -4
  421. package/dist/types/models/UserDetail.d.ts +0 -7
  422. package/dist/types/models/UserEdxMemory.d.ts +0 -15
  423. package/dist/types/models/UserMemory.d.ts +0 -19
  424. package/dist/types/models/UserMemoryContextRequest.d.ts +0 -13
  425. package/dist/types/models/UserMemoryContextResponse.d.ts +0 -12
  426. package/dist/types/models/UserMemoryEntry.d.ts +0 -9
  427. package/dist/types/models/UserMemoryEntryRequest.d.ts +0 -5
  428. package/dist/types/models/UserMemoryRequest.d.ts +0 -12
  429. package/dist/types/models/UserMetric.d.ts +0 -4
  430. package/dist/types/models/UserMetricsResponse.d.ts +0 -7
  431. package/dist/types/models/UserSentimentCountView.d.ts +0 -4
  432. package/dist/types/models/UserTrendByPeriod.d.ts +0 -5
  433. package/dist/types/models/V2GlobalMentorSearchResponse.d.ts +0 -29
  434. package/dist/types/models/V2PersonalizedMentorsResponse.d.ts +0 -29
  435. package/dist/types/models/V2RecommendationResponse.d.ts +0 -65
  436. package/dist/types/models/VectorResult.d.ts +0 -10
  437. package/dist/types/models/VeoVideoDetail.d.ts +0 -10
  438. package/dist/types/models/VeoVideoList.d.ts +0 -6
  439. package/dist/types/models/VeoVideoRequest.d.ts +0 -5
  440. package/dist/types/models/VideoCaption.d.ts +0 -3
  441. package/dist/types/models/Voice.d.ts +0 -9
  442. package/dist/types/models/VoiceProviderEnum.d.ts +0 -10
  443. package/dist/types/models/WebResource.d.ts +0 -9
  444. package/dist/types/models/WebResourceCard.d.ts +0 -7
  445. package/dist/types/models/WebResourcesQuery.d.ts +0 -3
  446. package/dist/types/models/WebexConfig.d.ts +0 -10
  447. package/dist/types/models/WebexWebhook.d.ts +0 -4
  448. package/dist/types/models/WhatAppWebHook.d.ts +0 -3
  449. package/dist/types/models/WhatsappConfig.d.ts +0 -11
  450. package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
  451. package/dist/types/services/AiAccountService.d.ts +0 -567
  452. package/dist/types/services/AiBotService.d.ts +0 -650
  453. package/dist/types/services/AiFinetuningService.d.ts +0 -232
  454. package/dist/types/services/AiIndexService.d.ts +0 -399
  455. package/dist/types/services/AiMarketingService.d.ts +0 -38
  456. package/dist/types/services/AiMediaService.d.ts +0 -247
  457. package/dist/types/services/AiMentorService.d.ts +0 -6914
  458. package/dist/types/services/AiPromptService.d.ts +0 -1035
  459. package/dist/types/services/AiSearchService.d.ts +0 -467
  460. package/src/models/AIGeneratedImage.ts +0 -18
  461. package/src/models/AIUserProfileMemoryRelation.ts +0 -9
  462. package/src/models/AIUserProfileRequest.ts +0 -9
  463. package/src/models/AccessEnum.ts +0 -12
  464. package/src/models/AccessTimesHeatmap.ts +0 -10
  465. package/src/models/AccessibleMentorsByEmailRequest.ts +0 -18
  466. package/src/models/AccessibleMentorsByEmailResponse.ts +0 -18
  467. package/src/models/ActionBreakdown.ts +0 -15
  468. package/src/models/AddMentorToDisclaimer.ts +0 -17
  469. package/src/models/AlignMentorBubbleEnum.ts +0 -12
  470. package/src/models/AnalyticsOverview.ts +0 -12
  471. package/src/models/Answer.ts +0 -16
  472. package/src/models/Artifact.ts +0 -65
  473. package/src/models/ArtifactList.ts +0 -47
  474. package/src/models/ArtifactVersion.ts +0 -60
  475. package/src/models/AssumedKnowledge.ts +0 -9
  476. package/src/models/AssumedKnowledgeLevel.ts +0 -9
  477. package/src/models/AudioToTextRequest.ts +0 -8
  478. package/src/models/AudioToTextResponse.ts +0 -8
  479. package/src/models/AuthTypeEnum.ts +0 -14
  480. package/src/models/AutoMemoryPrompt.ts +0 -9
  481. package/src/models/BaseFinanceResponse.ts +0 -42
  482. package/src/models/BillingPeriod.ts +0 -13
  483. package/src/models/Bot.ts +0 -20
  484. package/src/models/BotCommand.ts +0 -11
  485. package/src/models/BotCreate.ts +0 -17
  486. package/src/models/Breakdown.ts +0 -16
  487. package/src/models/CallAuthenticationRequest.ts +0 -22
  488. package/src/models/CallAuthenticationResponse.ts +0 -26
  489. package/src/models/CallConfiguration.ts +0 -35
  490. package/src/models/CallConfigurationModeEnum.ts +0 -12
  491. package/src/models/ChatHistory.ts +0 -16
  492. package/src/models/ChatHistoryFilterData.ts +0 -14
  493. package/src/models/ChatHistoryFilterUser.ts +0 -10
  494. package/src/models/ChatHistoryItem.ts +0 -10
  495. package/src/models/ChatHistorySessionId.ts +0 -8
  496. package/src/models/ChatSessionRequest.ts +0 -20
  497. package/src/models/ChatSessionResponse.ts +0 -13
  498. package/src/models/CheckDocumentTrainingStatus.ts +0 -15
  499. package/src/models/ComparisonInfo.ts +0 -34
  500. package/src/models/ComponentBlock.ts +0 -14
  501. package/src/models/ComponentBlockTypeEnum.ts +0 -12
  502. package/src/models/ConnectedService.ts +0 -29
  503. package/src/models/ConversationChartPoint.ts +0 -9
  504. package/src/models/ConversationDetailResponse.ts +0 -9
  505. package/src/models/ConversationListItem.ts +0 -29
  506. package/src/models/ConversationListResponse.ts +0 -11
  507. package/src/models/ConversationMessage.ts +0 -16
  508. package/src/models/ConversationRating.ts +0 -11
  509. package/src/models/ConversationSummary.ts +0 -10
  510. package/src/models/ConversationVolume.ts +0 -9
  511. package/src/models/Conversations.ts +0 -47
  512. package/src/models/ConversationsChart.ts +0 -10
  513. package/src/models/Cost.ts +0 -8
  514. package/src/models/CostPerTenant.ts +0 -11
  515. package/src/models/CourseCreationTask.ts +0 -36
  516. package/src/models/CourseCreationTaskFile.ts +0 -12
  517. package/src/models/CourseCreationTaskStatusEnum.ts +0 -20
  518. package/src/models/CourseRecommendation.ts +0 -54
  519. package/src/models/CrawlerPatternTypeEnum.ts +0 -12
  520. package/src/models/CredentialRequest.ts +0 -19
  521. package/src/models/CrontabSchedule.ts +0 -27
  522. package/src/models/CurrentUsersResponse.ts +0 -13
  523. package/src/models/CustomInstructionResponse.ts +0 -18
  524. package/src/models/DataSet.ts +0 -26
  525. package/src/models/DataSetCreate.ts +0 -17
  526. package/src/models/DataSetStatusEnum.ts +0 -16
  527. package/src/models/DateRange.ts +0 -9
  528. package/src/models/Disclaimer.ts +0 -22
  529. package/src/models/DisclaimerAgreement.ts +0 -16
  530. package/src/models/DisclaimerScopeEnum.ts +0 -12
  531. package/src/models/DiscordConfig.ts +0 -12
  532. package/src/models/DiscordUserConfig.ts +0 -15
  533. package/src/models/DiscordWebhook.ts +0 -11
  534. package/src/models/Document.ts +0 -46
  535. package/src/models/DocumentFacet.ts +0 -22
  536. package/src/models/DocumentFromPoolRequest.ts +0 -15
  537. package/src/models/DocumentSearchResponse.ts +0 -40
  538. package/src/models/DocumentSettingsResponse.ts +0 -8
  539. package/src/models/EdxCourse.ts +0 -16
  540. package/src/models/ElevenlabsCustomVoice.ts +0 -9
  541. package/src/models/ElevenlabsCustomVoiceResponse.ts +0 -13
  542. package/src/models/EmailPromptDetail.ts +0 -18
  543. package/src/models/EmailPromptList.ts +0 -16
  544. package/src/models/EmailPromptSummary.ts +0 -10
  545. package/src/models/Entity.ts +0 -16
  546. package/src/models/EntityTypeEnum.ts +0 -14
  547. package/src/models/Error.ts +0 -8
  548. package/src/models/ExternalServiceInfo.ts +0 -11
  549. package/src/models/FileUploadURLRequest.ts +0 -26
  550. package/src/models/FileUploadURLResponse.ts +0 -30
  551. package/src/models/FinanceDetailsResponse.ts +0 -18
  552. package/src/models/FinanceFilters.ts +0 -20
  553. package/src/models/FreeUsageCount.ts +0 -8
  554. package/src/models/FullCourse.ts +0 -18
  555. package/src/models/GoogleAgentDetail.ts +0 -22
  556. package/src/models/GrantMentorAccessRequest.ts +0 -14
  557. package/src/models/GreetingMethodEnum.ts +0 -12
  558. package/src/models/GuidedPrompt.ts +0 -9
  559. package/src/models/GuidedPromptsResponse.ts +0 -10
  560. package/src/models/HeygenMarketingVideoDetail.ts +0 -13
  561. package/src/models/HeygenMarketingVideoList.ts +0 -11
  562. package/src/models/HeygenTemplateRequest.ts +0 -10
  563. package/src/models/HeygenTemplateResponseSingle.ts +0 -11
  564. package/src/models/HeygenVideoDetail.ts +0 -13
  565. package/src/models/HeygenVideoRequest.ts +0 -10
  566. package/src/models/HumanSupportTicket.ts +0 -28
  567. package/src/models/HumanSupportTicketStatusEnum.ts +0 -14
  568. package/src/models/InputQuestion.ts +0 -11
  569. package/src/models/IntegrationCredential.ts +0 -15
  570. package/src/models/IntegrationCredentialSchema.ts +0 -11
  571. package/src/models/InterfaceEnum.ts +0 -12
  572. package/src/models/IntialQuestionAnswer.ts +0 -8
  573. package/src/models/InvoiceReportResponse.ts +0 -18
  574. package/src/models/JobRun.ts +0 -16
  575. package/src/models/KindEnum.ts +0 -14
  576. package/src/models/LLMCredentialRequest.ts +0 -19
  577. package/src/models/LLMCredentialResponse.ts +0 -15
  578. package/src/models/LLMCredentialSchema.ts +0 -11
  579. package/src/models/LLMModelForTenant.ts +0 -11
  580. package/src/models/LLMQuestion.ts +0 -20
  581. package/src/models/LLMResponse.ts +0 -23
  582. package/src/models/LLMTracesListResponse.ts +0 -10
  583. package/src/models/LanguagesView.ts +0 -10
  584. package/src/models/LinkCourseRequest.ts +0 -8
  585. package/src/models/LinkCourseResponse.ts +0 -10
  586. package/src/models/LlmProviderEnum.ts +0 -14
  587. package/src/models/MCPServer.ts +0 -55
  588. package/src/models/MCPServerConnection.ts +0 -52
  589. package/src/models/MCPServerConnectionScopeEnum.ts +0 -14
  590. package/src/models/MCPServerOauthFind.ts +0 -8
  591. package/src/models/MaskedIntegrationCredential.ts +0 -15
  592. package/src/models/MaskedLLMCredential.ts +0 -15
  593. package/src/models/MemoryComponentData.ts +0 -10
  594. package/src/models/MemoryComponentMemory.ts +0 -9
  595. package/src/models/MemoryComponentMemoryDetail.ts +0 -13
  596. package/src/models/MemoryComponentResponse.ts +0 -10
  597. package/src/models/MemoryProgress.ts +0 -13
  598. package/src/models/MemoryStatusRequestView.ts +0 -11
  599. package/src/models/MemoryStatusView.ts +0 -11
  600. package/src/models/Mentor.ts +0 -152
  601. package/src/models/MentorAudience.ts +0 -10
  602. package/src/models/MentorBreakdown.ts +0 -14
  603. package/src/models/MentorCategory.ts +0 -14
  604. package/src/models/MentorCategoryCreate.ts +0 -16
  605. package/src/models/MentorCategoryGroup.ts +0 -16
  606. package/src/models/MentorCategoryGroupCreate.ts +0 -16
  607. package/src/models/MentorCreate.ts +0 -142
  608. package/src/models/MentorCustomVoice.ts +0 -9
  609. package/src/models/MentorCustomVoiceResponse.ts +0 -9
  610. package/src/models/MentorData.ts +0 -12
  611. package/src/models/MentorDetailAnalytics.ts +0 -11
  612. package/src/models/MentorEval.ts +0 -16
  613. package/src/models/MentorEvalQuestion.ts +0 -10
  614. package/src/models/MentorEvalQuestionRequest.ts +0 -9
  615. package/src/models/MentorEvalReport.ts +0 -15
  616. package/src/models/MentorEvalRequest.ts +0 -13
  617. package/src/models/MentorFacet.ts +0 -22
  618. package/src/models/MentorFork.ts +0 -10
  619. package/src/models/MentorFromTemplateWithSettingRequest.ts +0 -70
  620. package/src/models/MentorMemorySettingsRequest.ts +0 -11
  621. package/src/models/MentorMemorySettingsResponse.ts +0 -11
  622. package/src/models/MentorMetadata.ts +0 -10
  623. package/src/models/MentorScenario.ts +0 -11
  624. package/src/models/MentorScenarioPrompt.ts +0 -10
  625. package/src/models/MentorSearchResponse.ts +0 -40
  626. package/src/models/MentorSession.ts +0 -9
  627. package/src/models/MentorSettings.ts +0 -109
  628. package/src/models/MentorSettingsPublic.ts +0 -82
  629. package/src/models/MentorSettingsRequest.ts +0 -84
  630. package/src/models/MentorSummary.ts +0 -10
  631. package/src/models/MentorType.ts +0 -10
  632. package/src/models/MentorUserSetting.ts +0 -9
  633. package/src/models/MentorVisibilityEnum.ts +0 -14
  634. package/src/models/MentorWizard.ts +0 -9
  635. package/src/models/MessageStatistics.ts +0 -10
  636. package/src/models/MessageView.ts +0 -16
  637. package/src/models/MessageViewRequest.ts +0 -14
  638. package/src/models/MessageViewUpdatResponse.ts +0 -8
  639. package/src/models/Metadata.ts +0 -10
  640. package/src/models/MetricChange.ts +0 -9
  641. package/src/models/MetricInfo.ts +0 -10
  642. package/src/models/ModelCost.ts +0 -9
  643. package/src/models/ModerationLog.ts +0 -17
  644. package/src/models/NoChatMessagesFound.ts +0 -8
  645. package/src/models/OAuthProvider.ts +0 -29
  646. package/src/models/OAuthService.ts +0 -23
  647. package/src/models/OAuthStartResponse.ts +0 -8
  648. package/src/models/OauthCredentialsMasked.ts +0 -15
  649. package/src/models/Observation.ts +0 -36
  650. package/src/models/OvertimeData.ts +0 -18
  651. package/src/models/PageContent.ts +0 -11
  652. package/src/models/PaginatedAIGeneratedImageList.ts +0 -12
  653. package/src/models/PaginatedArtifactListList.ts +0 -12
  654. package/src/models/PaginatedArtifactVersionList.ts +0 -12
  655. package/src/models/PaginatedConversationsList.ts +0 -12
  656. package/src/models/PaginatedCourseCreationTaskFileList.ts +0 -12
  657. package/src/models/PaginatedCourseCreationTaskList.ts +0 -12
  658. package/src/models/PaginatedDataSetList.ts +0 -12
  659. package/src/models/PaginatedDisclaimerAgreementList.ts +0 -12
  660. package/src/models/PaginatedDisclaimerList.ts +0 -12
  661. package/src/models/PaginatedEdxCourseList.ts +0 -12
  662. package/src/models/PaginatedEmailPromptListList.ts +0 -12
  663. package/src/models/PaginatedGoogleAgentDetailList.ts +0 -12
  664. package/src/models/PaginatedHeygenMarketingVideoListList.ts +0 -12
  665. package/src/models/PaginatedHeygenTemplateResponseSingleList.ts +0 -12
  666. package/src/models/PaginatedHumanSupportTicketList.ts +0 -12
  667. package/src/models/PaginatedJobRunList.ts +0 -12
  668. package/src/models/PaginatedMCPServerConnectionList.ts +0 -12
  669. package/src/models/PaginatedMCPServerList.ts +0 -12
  670. package/src/models/PaginatedMentorList.ts +0 -12
  671. package/src/models/PaginatedModerationLogList.ts +0 -12
  672. package/src/models/PaginatedObservationList.ts +0 -12
  673. package/src/models/PaginatedPeriodicAgentList.ts +0 -12
  674. package/src/models/PaginatedPeriodicAgentLogList.ts +0 -12
  675. package/src/models/PaginatedPlayWrightScriptList.ts +0 -12
  676. package/src/models/PaginatedProjectList.ts +0 -12
  677. package/src/models/PaginatedRetrieverDocumentEmbeddingList.ts +0 -12
  678. package/src/models/PaginatedSectionList.ts +0 -12
  679. package/src/models/PaginatedSubSectionList.ts +0 -12
  680. package/src/models/PaginatedTicketMessageList.ts +0 -12
  681. package/src/models/PaginatedTopicStatisticsResponse.ts +0 -12
  682. package/src/models/PaginatedTraceList.ts +0 -12
  683. package/src/models/PaginatedTrainingList.ts +0 -12
  684. package/src/models/PaginatedUnitList.ts +0 -12
  685. package/src/models/PaginatedUserEdxMemoryList.ts +0 -12
  686. package/src/models/PaginatedUserMemoryList.ts +0 -12
  687. package/src/models/PaginatedVeoVideoListList.ts +0 -12
  688. package/src/models/PaginatedVoiceList.ts +0 -12
  689. package/src/models/PatchedArtifact.ts +0 -65
  690. package/src/models/PatchedBotCommand.ts +0 -11
  691. package/src/models/PatchedBotCreate.ts +0 -17
  692. package/src/models/PatchedCallConfiguration.ts +0 -35
  693. package/src/models/PatchedConversations.ts +0 -47
  694. package/src/models/PatchedCourseCreationTaskFile.ts +0 -12
  695. package/src/models/PatchedCredentialRequest.ts +0 -19
  696. package/src/models/PatchedDataSet.ts +0 -26
  697. package/src/models/PatchedDisclaimer.ts +0 -22
  698. package/src/models/PatchedDiscordConfig.ts +0 -12
  699. package/src/models/PatchedDiscordUserConfig.ts +0 -15
  700. package/src/models/PatchedGoogleAgentDetail.ts +0 -22
  701. package/src/models/PatchedHumanSupportTicket.ts +0 -28
  702. package/src/models/PatchedLLMCredentialRequest.ts +0 -19
  703. package/src/models/PatchedMCPServer.ts +0 -55
  704. package/src/models/PatchedMCPServerConnection.ts +0 -52
  705. package/src/models/PatchedMentorCategoryGroupCreate.ts +0 -16
  706. package/src/models/PatchedMentorCreate.ts +0 -142
  707. package/src/models/PatchedPeriodicAgentCreate.ts +0 -46
  708. package/src/models/PatchedPlayWrightScript.ts +0 -17
  709. package/src/models/PatchedProject.ts +0 -56
  710. package/src/models/PatchedPrompt.ts +0 -27
  711. package/src/models/PatchedSection.ts +0 -14
  712. package/src/models/PatchedSlackConfig.ts +0 -13
  713. package/src/models/PatchedSlackUserConfig.ts +0 -22
  714. package/src/models/PatchedSubSection.ts +0 -14
  715. package/src/models/PatchedTeamsConfig.ts +0 -12
  716. package/src/models/PatchedTicketMessage.ts +0 -15
  717. package/src/models/PatchedTrainingCreate.ts +0 -36
  718. package/src/models/PatchedUnit.ts +0 -16
  719. package/src/models/PatchedWebexConfig.ts +0 -15
  720. package/src/models/PatchedWhatsappConfig.ts +0 -16
  721. package/src/models/PatchedWhatsappUserConfig.ts +0 -15
  722. package/src/models/PeriodInfo.ts +0 -26
  723. package/src/models/PeriodicAgent.ts +0 -47
  724. package/src/models/PeriodicAgentCreate.ts +0 -46
  725. package/src/models/PeriodicAgentLog.ts +0 -16
  726. package/src/models/PeriodicAgentLogStatusEnum.ts +0 -14
  727. package/src/models/PeriodicAgentStatistics.ts +0 -12
  728. package/src/models/PeriodicTask.ts +0 -26
  729. package/src/models/PieChartData.ts +0 -10
  730. package/src/models/PieChartSegment.ts +0 -9
  731. package/src/models/PinnedMessageCreate.ts +0 -14
  732. package/src/models/PinnedMessageGet.ts +0 -12
  733. package/src/models/PinnedMessageRequest.ts +0 -11
  734. package/src/models/PlatformPrompt.ts +0 -39
  735. package/src/models/PlatformPromptResponse.ts +0 -21
  736. package/src/models/PlayWrightScript.ts +0 -17
  737. package/src/models/PredictiveAnalyticsRequest.ts +0 -9
  738. package/src/models/PredictiveAnalyticsResponse.ts +0 -9
  739. package/src/models/PreviousAgentStatusEnum.ts +0 -16
  740. package/src/models/Project.ts +0 -56
  741. package/src/models/ProjectMentor.ts +0 -16
  742. package/src/models/Prompt.ts +0 -27
  743. package/src/models/PromptCategory.ts +0 -12
  744. package/src/models/PromptFacet.ts +0 -22
  745. package/src/models/PromptSearchResponse.ts +0 -40
  746. package/src/models/PromptVisibilityEnum.ts +0 -14
  747. package/src/models/Provider05cEnum.ts +0 -18
  748. package/src/models/Provider63aEnum.ts +0 -10
  749. package/src/models/ProviderBreakdown.ts +0 -13
  750. package/src/models/QuestionCardTag.ts +0 -13
  751. package/src/models/QuestionRequest.ts +0 -20
  752. package/src/models/QuestionResponse.ts +0 -15
  753. package/src/models/RatingAverageRecord.ts +0 -15
  754. package/src/models/RatingEnum.ts +0 -12
  755. package/src/models/RatingRecord.ts +0 -9
  756. package/src/models/RatingsOvertime.ts +0 -10
  757. package/src/models/RecentlyAccessedMentor.ts +0 -16
  758. package/src/models/RecommendCourseBlock.ts +0 -8
  759. package/src/models/RecommendCourseResponse.ts +0 -8
  760. package/src/models/RecommendationTypeEnum.ts +0 -12
  761. package/src/models/RecommendedCoursesResponse.ts +0 -38
  762. package/src/models/RelatedText.ts +0 -8
  763. package/src/models/RemoveMentorFromDisclaimer.ts +0 -17
  764. package/src/models/RequestDataVariable.ts +0 -19
  765. package/src/models/ResourceScrappedData.ts +0 -18
  766. package/src/models/ResourceScrappedDataStatusEnum.ts +0 -16
  767. package/src/models/ResponseDataVariable.ts +0 -19
  768. package/src/models/RetreiverTrainViewRequest.ts +0 -15
  769. package/src/models/RetreiverTrainViewResponse.ts +0 -11
  770. package/src/models/RetrieveTask.ts +0 -8
  771. package/src/models/RetrieverDocumentEmbedding.ts +0 -35
  772. package/src/models/RetrieverDocumentEmbeddingRequest.ts +0 -71
  773. package/src/models/RetrieverRequestSearch.ts +0 -15
  774. package/src/models/RetrieverRequestSearchDocument.ts +0 -15
  775. package/src/models/RetrieverResponseSearch.ts +0 -12
  776. package/src/models/ReuestDataVariableList.ts +0 -9
  777. package/src/models/RunMentorEval.ts +0 -8
  778. package/src/models/ScanWebhookRequest.ts +0 -11
  779. package/src/models/ScanWebhookResponse.ts +0 -8
  780. package/src/models/Section.ts +0 -14
  781. package/src/models/SectionWithChildren.ts +0 -16
  782. package/src/models/SeedMentorsView.ts +0 -8
  783. package/src/models/SentimentSummary.ts +0 -9
  784. package/src/models/SessionBrowserScreenshot.ts +0 -13
  785. package/src/models/SessionChartPoint.ts +0 -9
  786. package/src/models/SessionDetail.ts +0 -11
  787. package/src/models/SessionMemoryAttachment.ts +0 -8
  788. package/src/models/SessionMemoryStorage.ts +0 -11
  789. package/src/models/SessionsChart.ts +0 -10
  790. package/src/models/SetCurrentVersionRequest.ts +0 -8
  791. package/src/models/ShareableMentorLink.ts +0 -13
  792. package/src/models/ShellLogs.ts +0 -8
  793. package/src/models/SlackConfig.ts +0 -13
  794. package/src/models/SlackUserConfig.ts +0 -22
  795. package/src/models/SlackWebhook.ts +0 -11
  796. package/src/models/SpacedRepetitionLearningPath.ts +0 -8
  797. package/src/models/SpacedRepetitionQuestionStats.ts +0 -10
  798. package/src/models/StarMentor.ts +0 -12
  799. package/src/models/Status6eeEnum.ts +0 -16
  800. package/src/models/Step.ts +0 -14
  801. package/src/models/StepStatusEnum.ts +0 -14
  802. package/src/models/SttProviderEnum.ts +0 -18
  803. package/src/models/StudentChatMessage.ts +0 -9
  804. package/src/models/StylesView.ts +0 -9
  805. package/src/models/SubSection.ts +0 -14
  806. package/src/models/SubSectionWithChildren.ts +0 -16
  807. package/src/models/Subject.ts +0 -10
  808. package/src/models/Summary.ts +0 -14
  809. package/src/models/TagsView.ts +0 -10
  810. package/src/models/TargetSystemEnum.ts +0 -12
  811. package/src/models/TaskView.ts +0 -8
  812. package/src/models/TeamsConfig.ts +0 -12
  813. package/src/models/TeamsWebhook.ts +0 -22
  814. package/src/models/TemplateMentor.ts +0 -14
  815. package/src/models/TenantMentorTraces.ts +0 -11
  816. package/src/models/TenantSetting.ts +0 -10
  817. package/src/models/ThemeEnum.ts +0 -12
  818. package/src/models/TicketMessage.ts +0 -15
  819. package/src/models/TonesView.ts +0 -9
  820. package/src/models/ToolCategory.ts +0 -10
  821. package/src/models/ToolResponse.ts +0 -20
  822. package/src/models/TopicDetail.ts +0 -13
  823. package/src/models/TopicDetails.ts +0 -10
  824. package/src/models/TopicModel.ts +0 -8
  825. package/src/models/TopicRecord.ts +0 -9
  826. package/src/models/TopicStatistics.ts +0 -12
  827. package/src/models/TopicStatisticsResponse.ts +0 -11
  828. package/src/models/TopicSummaryView.ts +0 -9
  829. package/src/models/TopicsOverview.ts +0 -27
  830. package/src/models/TopicsOverviewMetric.ts +0 -26
  831. package/src/models/Trace.ts +0 -22
  832. package/src/models/TrainChatSessionDocumentView.ts +0 -11
  833. package/src/models/TrainChatSessionDocumentViewRequest.ts +0 -11
  834. package/src/models/TrainDocumentViewRequest.ts +0 -87
  835. package/src/models/TrainDocumentViewResponse.ts +0 -20
  836. package/src/models/Training.ts +0 -46
  837. package/src/models/TrainingCreate.ts +0 -36
  838. package/src/models/TrainingStatusEnum.ts +0 -16
  839. package/src/models/TransportEnum.ts +0 -14
  840. package/src/models/TrendEntry.ts +0 -9
  841. package/src/models/TriggerRequest.ts +0 -10
  842. package/src/models/TriggerResponse.ts +0 -11
  843. package/src/models/TtsProviderEnum.ts +0 -16
  844. package/src/models/TypeC42Enum.ts +0 -12
  845. package/src/models/Unit.ts +0 -16
  846. package/src/models/UnitWithChildren.ts +0 -18
  847. package/src/models/UseMainCreds.ts +0 -8
  848. package/src/models/UserAllChatMemoryView.ts +0 -12
  849. package/src/models/UserCatalogItemMemoryView.ts +0 -19
  850. package/src/models/UserChatByPeriod.ts +0 -9
  851. package/src/models/UserChatFeedback.ts +0 -20
  852. package/src/models/UserChatFeedbackCount.ts +0 -9
  853. package/src/models/UserChatMemoryStatusRequestView.ts +0 -11
  854. package/src/models/UserChatMemoryStatusView.ts +0 -11
  855. package/src/models/UserChatMemoryUpdateView.ts +0 -15
  856. package/src/models/UserCountRecord.ts +0 -9
  857. package/src/models/UserDetail.ts +0 -12
  858. package/src/models/UserEdxMemory.ts +0 -20
  859. package/src/models/UserMemory.ts +0 -24
  860. package/src/models/UserMemoryContextRequest.ts +0 -18
  861. package/src/models/UserMemoryContextResponse.ts +0 -17
  862. package/src/models/UserMemoryEntry.ts +0 -14
  863. package/src/models/UserMemoryEntryRequest.ts +0 -10
  864. package/src/models/UserMemoryRequest.ts +0 -17
  865. package/src/models/UserMetric.ts +0 -9
  866. package/src/models/UserMetricsResponse.ts +0 -12
  867. package/src/models/UserSentimentCountView.ts +0 -9
  868. package/src/models/UserTrendByPeriod.ts +0 -10
  869. package/src/models/V2GlobalMentorSearchResponse.ts +0 -34
  870. package/src/models/V2PersonalizedMentorsResponse.ts +0 -34
  871. package/src/models/V2RecommendationResponse.ts +0 -70
  872. package/src/models/VectorResult.ts +0 -15
  873. package/src/models/VeoVideoDetail.ts +0 -15
  874. package/src/models/VeoVideoList.ts +0 -11
  875. package/src/models/VeoVideoRequest.ts +0 -10
  876. package/src/models/VideoCaption.ts +0 -8
  877. package/src/models/Voice.ts +0 -14
  878. package/src/models/VoiceProviderEnum.ts +0 -14
  879. package/src/models/WebResource.ts +0 -14
  880. package/src/models/WebResourceCard.ts +0 -12
  881. package/src/models/WebResourcesQuery.ts +0 -8
  882. package/src/models/WebexConfig.ts +0 -15
  883. package/src/models/WebexWebhook.ts +0 -9
  884. package/src/models/WhatAppWebHook.ts +0 -8
  885. package/src/models/WhatsappConfig.ts +0 -16
  886. package/src/models/WhatsappUserConfig.ts +0 -15
  887. package/src/services/AiAccountService.ts +0 -955
  888. package/src/services/AiBotService.ts +0 -1350
  889. package/src/services/AiFinetuningService.ts +0 -472
  890. package/src/services/AiIndexService.ts +0 -710
  891. package/src/services/AiMarketingService.ts +0 -96
  892. package/src/services/AiMediaService.ts +0 -532
  893. package/src/services/AiMentorService.ts +0 -12797
  894. package/src/services/AiPromptService.ts +0 -1985
  895. package/src/services/AiSearchService.ts +0 -766
@@ -2,22 +2,10 @@
2
2
  /* istanbul ignore file */
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
- import type { AccessTimesHeatmap } from '../models/AccessTimesHeatmap';
6
- import type { BaseFinanceResponse } from '../models/BaseFinanceResponse';
7
5
  import type { ContentDetailsResponse } from '../models/ContentDetailsResponse';
8
6
  import type { ContentResponse } from '../models/ContentResponse';
9
- import type { ConversationDetailResponse } from '../models/ConversationDetailResponse';
10
- import type { ConversationListResponse } from '../models/ConversationListResponse';
11
- import type { CurrentUsersResponse } from '../models/CurrentUsersResponse';
12
- import type { FinanceDetailsResponse } from '../models/FinanceDetailsResponse';
13
- import type { InvoiceReportResponse } from '../models/InvoiceReportResponse';
14
7
  import type { LearnerAnalyticsResponse } from '../models/LearnerAnalyticsResponse';
15
8
  import type { LearnerListResponse } from '../models/LearnerListResponse';
16
- import type { RatingsOvertime } from '../models/RatingsOvertime';
17
- import type { SessionsChart } from '../models/SessionsChart';
18
- import type { TopicDetails } from '../models/TopicDetails';
19
- import type { TopicsOverview } from '../models/TopicsOverview';
20
- import type { UserDetail } from '../models/UserDetail';
21
9
  import type { CancelablePromise } from '../core/CancelablePromise';
22
10
  import { OpenAPI } from '../core/OpenAPI';
23
11
  import { request as __request } from '../core/request';
@@ -64,7 +52,6 @@ export class AnalyticsService {
64
52
  granularity = 'hour',
65
53
  includeOvertime = false,
66
54
  limit = 20,
67
- mentorUniqueId,
68
55
  page = 1,
69
56
  platformKey,
70
57
  startDate,
@@ -108,7 +95,6 @@ export class AnalyticsService {
108
95
  * Number of items per page (max 100)
109
96
  */
110
97
  limit?: number,
111
- mentorUniqueId?: string,
112
98
  /**
113
99
  * Page number for pagination
114
100
  */
@@ -132,7 +118,6 @@ export class AnalyticsService {
132
118
  'granularity': granularity,
133
119
  'include_overtime': includeOvertime,
134
120
  'limit': limit,
135
- 'mentor_unique_id': mentorUniqueId,
136
121
  'metric': metric,
137
122
  'page': page,
138
123
  'platform_key': platformKey,
@@ -153,7 +138,6 @@ export class AnalyticsService {
153
138
  dateFilter = 'today',
154
139
  endDate,
155
140
  limit = 10,
156
- mentorUniqueId,
157
141
  page = 1,
158
142
  platformKey,
159
143
  search,
@@ -189,7 +173,6 @@ export class AnalyticsService {
189
173
  * Number of learner records per page
190
174
  */
191
175
  limit?: number,
192
- mentorUniqueId?: string,
193
176
  page?: number,
194
177
  platformKey?: string,
195
178
  search?: string,
@@ -213,7 +196,6 @@ export class AnalyticsService {
213
196
  'date_filter': dateFilter,
214
197
  'end_date': endDate,
215
198
  'limit': limit,
216
- 'mentor_unique_id': mentorUniqueId,
217
199
  'metric': metric,
218
200
  'page': page,
219
201
  'platform_key': platformKey,
@@ -225,1230 +207,191 @@ export class AnalyticsService {
225
207
  });
226
208
  }
227
209
  /**
228
- * Financial Analytics API - Get comprehensive cost metrics with comparison analysis.
210
+ * Unified API endpoint for learner analytics.
229
211
  *
230
- * This endpoint provides period-based cost analysis (not cumulative) with support for:
231
- * - Multiple time granularities and metrics
232
- * - Cross-dimensional filtering
233
- * - Percentage change vs comparison periods
234
- * - Forward-filled time series
212
+ * This endpoint provides either:
213
+ * 1. Cross-platform summary (when only username is provided)
214
+ * 2. Platform-specific detailed data (when username + platform_key are provided)
235
215
  *
236
- * **Examples:**
216
+ * Query params:
217
+ * - username (required): Username of the learner
218
+ * - platform_key (optional): Platform key for platform-specific data
219
+ * - page (optional): Page number (default: 1)
220
+ * - limit (optional): Records per page (default: 20, max: 100)
237
221
  *
238
- * **Basic Weekly Costs:**
239
- * ```
240
- * GET /api/analytics/financial/?metric=weekly_costs&comparison_days=10
241
- * ```
242
- *
243
- * **Platform & Mentor Filtered:**
244
- * ```
245
- * # Get total costs for a specific platform and mentor
246
- * GET /api/analytics/financial/?metric=total_costs&platform_key=web-app&mentor_unique_id=mentor-123&comparison_days=14
247
- * ```
248
- *
249
- * **Monthly Costs by Provider:**
250
- * ```
251
- * GET /api/analytics/financial/?metric=monthly_costs&provider=openai&granularity=month&comparison_days=30
252
- * ```
253
- *
254
- * **Daily Costs for Specific User:**
255
- * ```
256
- * GET /api/analytics/financial/?metric=total_costs&username=user-456&granularity=day&start_date=2025-01-15&end_date=2025-01-21&comparison_days=7
257
- * ```
222
+ * Returns:
223
+ * - If platform_key provided: Detailed platform metrics
224
+ * - If no platform_key: Cross-platform summary with pagination
225
+ * @returns LearnerAnalyticsResponse
226
+ * @throws ApiError
227
+ */
228
+ public static analyticsLearnersRetrieve({
229
+ dateFilter = 'today',
230
+ endDate,
231
+ granularity = 'hour',
232
+ limit = 20,
233
+ overtime = false,
234
+ page = 1,
235
+ platformKey,
236
+ startDate,
237
+ username,
238
+ }: {
239
+ /**
240
+ * * `today` - Today only
241
+ * * `7d` - Last 7 days
242
+ * * `30d` - Last 30 days
243
+ * * `90d` - Last 90 days
244
+ * * `all_time` - All time
245
+ * * `custom` - Custom date range
246
+ */
247
+ dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
248
+ endDate?: string,
249
+ /**
250
+ * * `day` - day
251
+ * * `hour` - hour
252
+ * * `week` - week
253
+ * * `month` - month
254
+ */
255
+ granularity?: 'day' | 'hour' | 'week' | 'month',
256
+ /**
257
+ * Number of records per page (default: 20, max: 100)
258
+ */
259
+ limit?: number,
260
+ /**
261
+ * Include overtime metrics for the user in the platform (default: false)
262
+ */
263
+ overtime?: boolean,
264
+ /**
265
+ * Page number (default: 1)
266
+ */
267
+ page?: number,
268
+ /**
269
+ * Optional platform key - if provided, returns platform-specific detailed data
270
+ */
271
+ platformKey?: string,
272
+ startDate?: string,
273
+ /**
274
+ * Username of the learner to get analytics for. Defaults to self if not provided.
275
+ */
276
+ username?: string,
277
+ }): CancelablePromise<LearnerAnalyticsResponse> {
278
+ return __request(OpenAPI, {
279
+ method: 'GET',
280
+ url: '/api/analytics/learners/',
281
+ query: {
282
+ 'date_filter': dateFilter,
283
+ 'end_date': endDate,
284
+ 'granularity': granularity,
285
+ 'limit': limit,
286
+ 'overtime': overtime,
287
+ 'page': page,
288
+ 'platform_key': platformKey,
289
+ 'start_date': startDate,
290
+ 'username': username,
291
+ },
292
+ });
293
+ }
294
+ /**
258
295
  *
296
+ * Retrieve a paginated list of learners for a specific platform with their comprehensive
297
+ * metrics from the UserPlatformSummary materialized view. This endpoint is accessible only
298
+ * to platform administrators and supports search, sorting, and pagination.
259
299
  *
260
- * **Response Structure:**
261
- * ```json
262
- * {
263
- * "metric": "weekly_costs",
264
- * "value": 12.47,
265
- * "percentage_change": 8.5,
266
- * "overtime": [
267
- * {"date": "2025-01-06", "value": 2.89},
268
- * {"date": "2025-01-13", "value": 3.12}
269
- * ],
270
- * "period_info": {
271
- * "start_date": "2025-01-01",
272
- * "end_date": "2025-01-31",
273
- * "period_days": 31
274
- * },
275
- * "comparison_info": {
276
- * "previous_period_value": 11.50,
277
- * ...
278
- * }
279
- * }
280
- * ```
281
- * @returns BaseFinanceResponse Successful financial metrics response with period-based cost data
282
- * @throws ApiError
283
- */
284
- public static analyticsFinancialRetrieve({
285
- metric,
286
- comparisonDays,
287
- dateFilter = 'today',
288
- endDate,
289
- fillMethod = 'zero',
290
- granularity = 'day',
291
- llmModel,
292
- mentorUniqueId,
293
- platformKey,
294
- provider,
295
- showOvertime = true,
296
- startDate,
297
- username,
298
- }: {
299
- /**
300
- * Type of financial metric to retrieve
301
- *
302
- * * `total_costs` - Total costs for selected timeframe
303
- * * `weekly_costs` - Costs for current/selected week
304
- * * `monthly_costs` - Costs for current/selected month
305
- */
306
- metric: 'total_costs' | 'weekly_costs' | 'monthly_costs',
307
- /**
308
- * Number of days for comparison period to calculate percentage change (e.g., 10 for 10-day comparison)
309
- */
310
- comparisonDays?: number,
311
- /**
312
- * * `today` - Today only
313
- * * `7d` - Last 7 days
314
- * * `30d` - Last 30 days
315
- * * `90d` - Last 90 days
316
- * * `all_time` - All time
317
- * * `custom` - Custom date range
318
- */
319
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
320
- endDate?: string,
321
- /**
322
- * Method for filling missing time periods in overtime data
323
- *
324
- * * `zero` - Fill missing periods with zero
325
- * * `previous` - Fill missing periods with previous value
326
- */
327
- fillMethod?: 'zero' | 'previous',
328
- /**
329
- * Time granularity for overtime series data
330
- *
331
- * * `day` - Daily data points
332
- * * `week` - Weekly data points
333
- * * `month` - Monthly data points
334
- */
335
- granularity?: 'day' | 'week' | 'month',
336
- /**
337
- * Filter by specific LLM model (e.g., gpt-4o, claude-3-5-sonnet)
338
- */
339
- llmModel?: string,
340
- mentorUniqueId?: string,
341
- platformKey?: string,
342
- /**
343
- * Filter by AI provider
344
- *
345
- * * `openai` - OpenAI
346
- * * `anthropic` - Anthropic
347
- * * `azure` - Azure
348
- * * `google` - Google
349
- * * `meta` - Meta
350
- * * `other` - Other
351
- */
352
- provider?: 'openai' | 'anthropic' | 'azure' | 'google' | 'meta' | 'other',
353
- /**
354
- * Whether to include overtime series data in response
355
- */
356
- showOvertime?: boolean,
357
- startDate?: string,
358
- /**
359
- * Filter by specific username - returns costs for this user only
360
- */
361
- username?: string,
362
- }): CancelablePromise<BaseFinanceResponse> {
363
- return __request(OpenAPI, {
364
- method: 'GET',
365
- url: '/api/analytics/financial/',
366
- query: {
367
- 'comparison_days': comparisonDays,
368
- 'date_filter': dateFilter,
369
- 'end_date': endDate,
370
- 'fill_method': fillMethod,
371
- 'granularity': granularity,
372
- 'llm_model': llmModel,
373
- 'mentor_unique_id': mentorUniqueId,
374
- 'metric': metric,
375
- 'platform_key': platformKey,
376
- 'provider': provider,
377
- 'show_overtime': showOvertime,
378
- 'start_date': startDate,
379
- 'username': username,
380
- },
381
- errors: {
382
- 400: `Bad Request - Invalid query parameters`,
383
- 403: `Forbidden - Insufficient permissions`,
384
- 500: `Internal Server Error`,
385
- },
386
- });
387
- }
388
- /**
389
- * Financial Details Analytics API – paginated cost tables with flexible grouping.
390
- *
391
- * This endpoint returns tabular cost metrics aggregated by the dimension
392
- * specified via the `group_by` query parameter. One or more KPI columns
393
- * can be requested through the comma-separated `metrics` list while
394
- * typical filters (date range, provider, platform_key, user, etc.) narrow the
395
- * dataset. Results are paginated with `page` / `limit`.
396
- *
397
- * **Required query parameters**
398
- * - group_by – provider | llm_model | username | mentor | platform
399
- * - metrics – csv list of KPI names, e.g. total_cost, sessions
400
- *
401
- * **Shared optional filters**
402
- * - start_date, end_date – ISO yyyy-mm-dd (ignored when all_time=true)
403
- * - platform_key – tenant isolation
404
- * - mentor_unique_id – filter to one mentor
405
- * - username – filter to a learner
406
- * - provider / llm_model – filter to LLM provider / model
407
- * - all_time – true → lifetime totals
408
- * - page (default 1), limit (default 50)
409
- *
410
- * **Examples**
411
- * --------
412
- * 1. Cost by provider for the last week
413
- * ```
414
- * GET /api/v2/analytics/financial/details?
415
- * group_by=provider&
416
- * metrics=total_cost&
417
- * start_date=2025-01-01&
418
- * end_date=2025-01-07&
419
- * page=1&limit=10
420
- * ```
421
- *
422
- * 2. Lifetime cost per user with extra KPIs
423
- * ```
424
- * GET /api/v2/analytics/financial/details?
425
- * group_by=username&
426
- * metrics=total_cost,sessions&
427
- * all_time=true&page=1&limit=50
428
- * ```
429
- * 3. Cost by LLM model with tenant filter
430
- * ```
431
- * GET /api/v2/analytics/financial/details?
432
- * group_by=llm_model&
433
- * metrics=total_cost&
434
- * platform_key=web-app&
435
- * start_date=2025-01-01&end_date=2025-01-31
436
- * ```
437
- * Response structure
438
- * -------------------
439
- * ```
440
- * {
441
- * "page": 1,
442
- * "limit": 10,
443
- * "total_pages": 1,
444
- * "total_records": 3,
445
- * "rows": [
446
- * {"provider": "openai", "total_cost": "2.50000"},
447
- * {"provider": "anthropic", "total_cost": "1.00000"},
448
- * {"provider": "azure", "total_cost": "0.50000"}
449
- * ],
450
- * "metrics": [
451
- * {
452
- * "name": "total_cost",
453
- * "unit": "$",
454
- * "description": "Cost for this entity in period"
455
- * }
456
- * ],
457
- * "total_cost": "4.00000" // optional grand-total when available
458
- * }
459
- * ``
460
- * @returns FinanceDetailsResponse
461
- * @throws ApiError
462
- */
463
- public static analyticsFinancialDetailsRetrieve({
464
- groupBy,
465
- dateFilter = 'today',
466
- endDate,
467
- limit = 20,
468
- llmModel,
469
- mentorUniqueId,
470
- metrics = 'total_cost',
471
- page = 1,
472
- platformKey,
473
- provider,
474
- search,
475
- startDate,
476
- username,
477
- }: {
478
- /**
479
- * Dimension to group by
480
- *
481
- * * `provider` - Group by provider
482
- * * `llm_model` - Group by LLM model
483
- * * `username` - Group by username
484
- * * `mentor` - Group by mentor
485
- * * `platform` - Group by platform
486
- * * `action` - Group by actions
487
- */
488
- groupBy: 'provider' | 'llm_model' | 'username' | 'mentor' | 'platform' | 'action',
489
- /**
490
- * * `today` - Today only
491
- * * `7d` - Last 7 days
492
- * * `30d` - Last 30 days
493
- * * `90d` - Last 90 days
494
- * * `all_time` - All time
495
- * * `custom` - Custom date range
496
- */
497
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
498
- endDate?: string,
499
- limit?: number,
500
- llmModel?: string,
501
- mentorUniqueId?: string,
502
- /**
503
- * Comma-separated list of metrics (e.g. total_cost,sessions, last_active)
504
- */
505
- metrics?: string,
506
- page?: number,
507
- platformKey?: string,
508
- provider?: string,
509
- search?: string,
510
- startDate?: string,
511
- username?: string,
512
- }): CancelablePromise<FinanceDetailsResponse> {
513
- return __request(OpenAPI, {
514
- method: 'GET',
515
- url: '/api/analytics/financial/details/',
516
- query: {
517
- 'date_filter': dateFilter,
518
- 'end_date': endDate,
519
- 'group_by': groupBy,
520
- 'limit': limit,
521
- 'llm_model': llmModel,
522
- 'mentor_unique_id': mentorUniqueId,
523
- 'metrics': metrics,
524
- 'page': page,
525
- 'platform_key': platformKey,
526
- 'provider': provider,
527
- 'search': search,
528
- 'start_date': startDate,
529
- 'username': username,
530
- },
531
- errors: {
532
- 400: `Bad Request – invalid query params`,
533
- 500: `Internal Server Error`,
534
- },
535
- });
536
- }
537
- /**
538
- * Flexible Invoice Report API – Billing summary with username and platform filtering.
539
- *
540
- * This endpoint generates invoice reports with flexible filtering options:
541
- * - Platform admins can view their platform's data and filter by username within their platform
542
- * - Super admins can view any combination of username/platform or global summaries
543
- *
544
- * **Key Features:**
545
- * - Flexible filtering by username and/or platform_key
546
- * - Essential metrics: total cost, sessions, usage period
547
- * - Provider breakdown (OpenAI, Anthropic, etc.)
548
- * - Top mentors/actions by cost
549
- * - Clean, invoice-ready format
550
- *
551
- * **Query Parameters:**
552
- * - username: Filter by specific username (optional)
553
- * - platform_key: Filter by platform (optional, but required for platform admins)
554
- * - start_date, end_date: billing period (defaults to last 30 days)
555
- * - include_breakdown: show provider/mentor details (default: true)
556
- *
557
- * **Permission Logic:**
558
- * - Platform admins: Must include platform_key matching their permission scope
559
- * - Super admins: Can use any combination of filters or none (global summary)
560
- *
561
- * **Examples:**
562
- * ```
563
- * # Platform admin viewing their platform
564
- * GET /api/analytics/financial/invoice?platform_key=web-app
565
- *
566
- * # Platform admin viewing specific user in their platform
567
- * GET /api/analytics/financial/invoice?platform_key=web-app&username=john.doe
568
- *
569
- * # Super admin viewing specific user across all platforms
570
- * GET /api/analytics/financial/invoice?username=john.doe
571
- *
572
- * # Super admin viewing global summary
573
- * GET /api/analytics/financial/invoice
574
- * ```
575
- *
576
- * **Response Structure:**
577
- * ```json
578
- * {
579
- * "entity": {
580
- * "type": "user|platform|global",
581
- * "username": "john.doe",
582
- * "platform_key": "web-app",
583
- * "platform_name": "Web Application",
584
- * "display_name": "John Doe on Web Application"
585
- * },
586
- * "billing_period": {
587
- * "start_date": "2025-01-01",
588
- * "end_date": "2025-01-31",
589
- * "days": 31
590
- * },
591
- * "summary": {
592
- * "total_cost": 245.750,
593
- * "total_sessions": 1250,
594
- * "active_users": 85,
595
- * "cost_per_session": 0.196
596
- * },
597
- * "breakdown": {
598
- * "by_provider": [...],
599
- * "by_mentor": [...],
600
- * "by_action": [...]
601
- * }
602
- * }
603
- * ```
604
- * @returns InvoiceReportResponse
605
- * @throws ApiError
606
- */
607
- public static analyticsFinancialInvoiceRetrieve({
608
- endDate,
609
- includeBreakdown = true,
610
- platformKey,
611
- startDate,
612
- username,
613
- }: {
614
- /**
615
- * End date for billing period (defaults to today)
616
- */
617
- endDate?: string,
618
- /**
619
- * Whether to include provider and mentor breakdown
620
- */
621
- includeBreakdown?: boolean,
622
- /**
623
- * Platform key to filter by (optional, required for platform admins)
624
- */
625
- platformKey?: string,
626
- /**
627
- * Start date for billing period (defaults to 30 days ago)
628
- */
629
- startDate?: string,
630
- /**
631
- * Username to generate invoice for (optional)
632
- */
633
- username?: string,
634
- }): CancelablePromise<InvoiceReportResponse> {
635
- return __request(OpenAPI, {
636
- method: 'GET',
637
- url: '/api/analytics/financial/invoice/',
638
- query: {
639
- 'end_date': endDate,
640
- 'include_breakdown': includeBreakdown,
641
- 'platform_key': platformKey,
642
- 'start_date': startDate,
643
- 'username': username,
644
- },
645
- errors: {
646
- 400: `Bad Request – invalid parameters`,
647
- 403: `Forbidden – insufficient permissions`,
648
- 404: `No data found`,
649
- 500: `Internal Server Error`,
650
- },
651
- });
652
- }
653
- /**
654
- * Unified API endpoint for learner analytics.
655
- *
656
- * This endpoint provides either:
657
- * 1. Cross-platform summary (when only username is provided)
658
- * 2. Platform-specific detailed data (when username + platform_key are provided)
659
- *
660
- * Query params:
661
- * - username (required): Username of the learner
662
- * - platform_key (optional): Platform key for platform-specific data
663
- * - page (optional): Page number (default: 1)
664
- * - limit (optional): Records per page (default: 20, max: 100)
665
- *
666
- * Returns:
667
- * - If platform_key provided: Detailed platform metrics
668
- * - If no platform_key: Cross-platform summary with pagination
669
- * @returns LearnerAnalyticsResponse
670
- * @throws ApiError
671
- */
672
- public static analyticsLearnersRetrieve({
673
- dateFilter = 'today',
674
- endDate,
675
- granularity = 'hour',
676
- limit = 20,
677
- mentorUniqueId,
678
- overtime = false,
679
- page = 1,
680
- platformKey,
681
- startDate,
682
- username,
683
- }: {
684
- /**
685
- * * `today` - Today only
686
- * * `7d` - Last 7 days
687
- * * `30d` - Last 30 days
688
- * * `90d` - Last 90 days
689
- * * `all_time` - All time
690
- * * `custom` - Custom date range
691
- */
692
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
693
- endDate?: string,
694
- /**
695
- * * `day` - day
696
- * * `hour` - hour
697
- * * `week` - week
698
- * * `month` - month
699
- */
700
- granularity?: 'day' | 'hour' | 'week' | 'month',
701
- /**
702
- * Number of records per page (default: 20, max: 100)
703
- */
704
- limit?: number,
705
- mentorUniqueId?: string,
706
- /**
707
- * Include overtime metrics for the user in the platform (default: false)
708
- */
709
- overtime?: boolean,
710
- /**
711
- * Page number (default: 1)
712
- */
713
- page?: number,
714
- /**
715
- * Optional platform key - if provided, returns platform-specific detailed data
716
- */
717
- platformKey?: string,
718
- startDate?: string,
719
- /**
720
- * Username of the learner to get analytics for. Defaults to self if not provided.
721
- */
722
- username?: string,
723
- }): CancelablePromise<LearnerAnalyticsResponse> {
724
- return __request(OpenAPI, {
725
- method: 'GET',
726
- url: '/api/analytics/learners/',
727
- query: {
728
- 'date_filter': dateFilter,
729
- 'end_date': endDate,
730
- 'granularity': granularity,
731
- 'limit': limit,
732
- 'mentor_unique_id': mentorUniqueId,
733
- 'overtime': overtime,
734
- 'page': page,
735
- 'platform_key': platformKey,
736
- 'start_date': startDate,
737
- 'username': username,
738
- },
739
- });
740
- }
741
- /**
742
- *
743
- * Retrieve a paginated list of learners for a specific platform with their comprehensive
744
- * metrics from the UserPlatformSummary materialized view. This endpoint is accessible only
745
- * to platform administrators and supports search, sorting, and pagination.
746
- *
747
- * @returns LearnerListResponse Paginated list of learners with their metrics
748
- * @throws ApiError
749
- */
750
- public static analyticsLearnersListRetrieve({
751
- platformKey,
752
- dateFilter = 'today',
753
- endDate,
754
- granularity = 'hour',
755
- limit = 20,
756
- mentorUniqueId,
757
- page = 1,
758
- search,
759
- sortBy = 'last_activity',
760
- sortOrder = 'desc',
761
- startDate,
762
- usergroupIds,
763
- }: {
764
- /**
765
- * Platform key to filter learners by platform
766
- */
767
- platformKey: string,
768
- /**
769
- * * `today` - Today only
770
- * * `7d` - Last 7 days
771
- * * `30d` - Last 30 days
772
- * * `90d` - Last 90 days
773
- * * `all_time` - All time
774
- * * `custom` - Custom date range
775
- */
776
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
777
- endDate?: string,
778
- /**
779
- * * `day` - day
780
- * * `hour` - hour
781
- * * `week` - week
782
- * * `month` - month
783
- */
784
- granularity?: 'day' | 'hour' | 'week' | 'month',
785
- /**
786
- * Number of learners per page (default: 20, max: 100)
787
- */
788
- limit?: number,
789
- mentorUniqueId?: string,
790
- /**
791
- * Page number for pagination (default: 1)
792
- */
793
- page?: number,
794
- /**
795
- * Search term to filter learners by username, email, or name
796
- */
797
- search?: string,
798
- /**
799
- * Field to sort learners by (default: last_activity)
800
- *
801
- * * `username` - Username
802
- * * `name` - Name
803
- * * `last_activity` - Last Activity
804
- * * `total_points` - Total Points
805
- * * `total_time_spent_seconds` - Time Spent
806
- * * `total_enrollments` - Enrollments
807
- * * `total_skills_count` - Skills Count
808
- */
809
- sortBy?: 'username' | 'name' | 'last_activity' | 'total_points' | 'total_time_spent_seconds' | 'total_enrollments' | 'total_skills_count',
810
- /**
811
- * Sort order (default: desc)
812
- *
813
- * * `asc` - Ascending
814
- * * `desc` - Descending
815
- */
816
- sortOrder?: 'asc' | 'desc',
817
- startDate?: string,
818
- /**
819
- * Optional list of usergroup IDs to filter results
820
- */
821
- usergroupIds?: Array<number> | null,
822
- }): CancelablePromise<LearnerListResponse> {
823
- return __request(OpenAPI, {
824
- method: 'GET',
825
- url: '/api/analytics/learners/list/',
826
- query: {
827
- 'date_filter': dateFilter,
828
- 'end_date': endDate,
829
- 'granularity': granularity,
830
- 'limit': limit,
831
- 'mentor_unique_id': mentorUniqueId,
832
- 'page': page,
833
- 'platform_key': platformKey,
834
- 'search': search,
835
- 'sort_by': sortBy,
836
- 'sort_order': sortOrder,
837
- 'start_date': startDate,
838
- 'usergroup_ids': usergroupIds,
839
- },
840
- errors: {
841
- 400: `Bad Request - Invalid parameters supplied`,
842
- 403: `Forbidden - Platform admin access required`,
843
- 500: `Unexpected error`,
844
- },
845
- });
846
- }
847
- /**
848
- * Conversation list endpoint for analytics.
849
- *
850
- * Query params (all optional unless specified by permissions):
851
- * - platform_key: filter by platform
852
- * - mentor_unique_id: filter by mentor
853
- * - page: page number (default 1)
854
- * - limit: page size (default 20, max 100)
855
- * - search: search in user name and first user message
856
- * - min_messages, max_messages: message_count range
857
- * - sentiment: positive|negative|neutral
858
- * - topic: topic name contains
859
- * - start_date, end_date: date filter on conversation date
860
- *
861
- * Returns: summary totals, results list (paginated), and pagination metadata.
862
- * @returns ConversationListResponse
863
- * @throws ApiError
864
- */
865
- public static analyticsMessagesRetrieve({
866
- endDate,
867
- limit = 20,
868
- maxMessages,
869
- mentorUniqueId,
870
- minMessages,
871
- page = 1,
872
- platformKey,
873
- search,
874
- sentiment,
875
- startDate,
876
- topic,
877
- }: {
878
- endDate?: string,
879
- limit?: number,
880
- maxMessages?: number,
881
- mentorUniqueId?: string,
882
- minMessages?: number,
883
- page?: number,
884
- platformKey?: string,
885
- search?: string,
886
- /**
887
- * * `positive` - positive
888
- * * `negative` - negative
889
- * * `neutral` - neutral
890
- */
891
- sentiment?: 'positive' | 'negative' | 'neutral',
892
- startDate?: string,
893
- topic?: string,
894
- }): CancelablePromise<ConversationListResponse> {
895
- return __request(OpenAPI, {
896
- method: 'GET',
897
- url: '/api/analytics/messages/',
898
- query: {
899
- 'end_date': endDate,
900
- 'limit': limit,
901
- 'max_messages': maxMessages,
902
- 'mentor_unique_id': mentorUniqueId,
903
- 'min_messages': minMessages,
904
- 'page': page,
905
- 'platform_key': platformKey,
906
- 'search': search,
907
- 'sentiment': sentiment,
908
- 'start_date': startDate,
909
- 'topic': topic,
910
- },
911
- });
912
- }
913
- /**
914
- * Conversation detail endpoint for analytics.
915
- *
916
- * Query params:
917
- * - session_id (required): UUID of the session to fetch
918
- * - platform_key, mentor_unique_id (optional): further scope
919
- * - start_date, end_date (optional): date filter on message timestamps
920
- *
921
- * Returns: summary metadata from conversation_list MV, and a list of
922
- * human/ai message pairs in chronological order.
923
- * @returns ConversationDetailResponse
924
- * @throws ApiError
925
- */
926
- public static analyticsMessagesDetailsRetrieve({
927
- sessionId,
928
- endDate,
929
- mentorUniqueId,
930
- platformKey,
931
- startDate,
932
- }: {
933
- sessionId: string,
934
- endDate?: string,
935
- mentorUniqueId?: string,
936
- platformKey?: string,
937
- startDate?: string,
938
- }): CancelablePromise<ConversationDetailResponse> {
939
- return __request(OpenAPI, {
940
- method: 'GET',
941
- url: '/api/analytics/messages/details/',
942
- query: {
943
- 'end_date': endDate,
944
- 'mentor_unique_id': mentorUniqueId,
945
- 'platform_key': platformKey,
946
- 'session_id': sessionId,
947
- 'start_date': startDate,
948
- },
949
- });
950
- }
951
- /**
952
- * Ratings overtime endpoint.
953
- *
954
- * Query params:
955
- * - metric: only 'ratings' is supported (default)
956
- * - platform_key, mentor_unique_id: optional filters
957
- * - granularity: 'day' (default) or 'hour' (hour only for today)
958
- * - start_date, end_date: optional date range; defaults applied if not provided
959
- *
960
- * Returns: { metric: 'ratings', points: [{date, value}, ...] }
961
- * @returns RatingsOvertime
962
- * @throws ApiError
963
- */
964
- public static analyticsRatingsRetrieve({
965
- dateFilter = 'today',
966
- endDate,
967
- granularity = 'hour',
968
- mentorUniqueId,
969
- metric = 'ratings',
970
- platformKey,
971
- startDate,
972
- }: {
973
- /**
974
- * * `today` - Today only
975
- * * `7d` - Last 7 days
976
- * * `30d` - Last 30 days
977
- * * `90d` - Last 90 days
978
- * * `all_time` - All time
979
- * * `custom` - Custom date range
980
- */
981
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
982
- endDate?: string,
983
- /**
984
- * * `day` - day
985
- * * `hour` - hour
986
- * * `week` - week
987
- * * `month` - month
988
- */
989
- granularity?: 'day' | 'hour' | 'week' | 'month',
990
- mentorUniqueId?: string,
991
- /**
992
- * * `ratings` - Ratings over time
993
- */
994
- metric?: 'ratings',
995
- platformKey?: string,
996
- startDate?: string,
997
- }): CancelablePromise<RatingsOvertime> {
998
- return __request(OpenAPI, {
999
- method: 'GET',
1000
- url: '/api/analytics/ratings/',
1001
- query: {
1002
- 'date_filter': dateFilter,
1003
- 'end_date': endDate,
1004
- 'granularity': granularity,
1005
- 'mentor_unique_id': mentorUniqueId,
1006
- 'metric': metric,
1007
- 'platform_key': platformKey,
1008
- 'start_date': startDate,
1009
- },
1010
- });
1011
- }
1012
- /**
1013
- * @returns SessionsChart
1014
- * @throws ApiError
1015
- */
1016
- public static analyticsSessionsRetrieve({
1017
- dateFilter = 'today',
1018
- endDate,
1019
- granularity = 'hour',
1020
- mentorUniqueId,
1021
- metric = 'sessions',
1022
- platformKey,
1023
- startDate,
1024
- }: {
1025
- /**
1026
- * * `today` - Today only
1027
- * * `7d` - Last 7 days
1028
- * * `30d` - Last 30 days
1029
- * * `90d` - Last 90 days
1030
- * * `all_time` - All time
1031
- * * `custom` - Custom date range
1032
- */
1033
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
1034
- endDate?: string,
1035
- /**
1036
- * * `day` - day
1037
- * * `hour` - hour
1038
- * * `week` - week
1039
- * * `month` - month
1040
- */
1041
- granularity?: 'day' | 'hour' | 'week' | 'month',
1042
- mentorUniqueId?: string,
1043
- /**
1044
- * * `sessions` - Sessions over time
1045
- * * `headline` - Headline metrics for sessions (avg messages per session, avg rating)
1046
- */
1047
- metric?: 'sessions' | 'headline',
1048
- platformKey?: string,
1049
- startDate?: string,
1050
- }): CancelablePromise<SessionsChart> {
1051
- return __request(OpenAPI, {
1052
- method: 'GET',
1053
- url: '/api/analytics/sessions/',
1054
- query: {
1055
- 'date_filter': dateFilter,
1056
- 'end_date': endDate,
1057
- 'granularity': granularity,
1058
- 'mentor_unique_id': mentorUniqueId,
1059
- 'metric': metric,
1060
- 'platform_key': platformKey,
1061
- 'start_date': startDate,
1062
- },
1063
- });
1064
- }
1065
- /**
1066
- * @returns TopicDetails
1067
- * @throws ApiError
1068
- */
1069
- public static analyticsSessionsDetailsRetrieve({
1070
- dateFilter = 'today',
1071
- endDate,
1072
- limit = 20,
1073
- mentorUniqueId,
1074
- page = 1,
1075
- platformKey,
1076
- search,
1077
- startDate,
1078
- }: {
1079
- /**
1080
- * * `today` - Today only
1081
- * * `7d` - Last 7 days
1082
- * * `30d` - Last 30 days
1083
- * * `90d` - Last 90 days
1084
- * * `all_time` - All time
1085
- * * `custom` - Custom date range
1086
- */
1087
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
1088
- endDate?: string,
1089
- limit?: number,
1090
- mentorUniqueId?: string,
1091
- page?: number,
1092
- platformKey?: string,
1093
- /**
1094
- * Search by topic name
1095
- */
1096
- search?: string,
1097
- startDate?: string,
1098
- }): CancelablePromise<TopicDetails> {
1099
- return __request(OpenAPI, {
1100
- method: 'GET',
1101
- url: '/api/analytics/sessions/details/',
1102
- query: {
1103
- 'date_filter': dateFilter,
1104
- 'end_date': endDate,
1105
- 'limit': limit,
1106
- 'mentor_unique_id': mentorUniqueId,
1107
- 'page': page,
1108
- 'platform_key': platformKey,
1109
- 'search': search,
1110
- 'start_date': startDate,
1111
- },
1112
- });
1113
- }
1114
- /**
1115
- *
1116
- * Time Analytics API - User activity patterns by time of day and day of week.
1117
- *
1118
- * Provides heatmap data showing when users are most active, useful for:
1119
- * - Understanding peak usage times
1120
- * - Capacity planning and resource allocation
1121
- * - User behavior analysis
1122
- * - Support scheduling optimization
1123
- *
1124
- * **Key Features:**
1125
- * - Day of week patterns (0=Sunday through 6=Saturday)
1126
- * - Hour of day activity levels (0-23)
1127
- * - Flexible date range filtering
1128
- * - Platform and mentor-specific filtering
1129
- * - Message count aggregation
1130
- *
1131
- * **Data Structure:**
1132
- * - `day_of_week`: 0-6 (Sunday-Saturday)
1133
- * - `hour`: 0-23 (24-hour format)
1134
- * - `value`: Message count for that time slot
1135
- *
1136
- * @returns AccessTimesHeatmap Access times heatmap data with day/hour patterns
1137
- * @throws ApiError
1138
- */
1139
- public static analyticsTimeRetrieve({
1140
- dateFilter = 'today',
1141
- endDate,
1142
- granularity = 'hour',
1143
- mentorUniqueId,
1144
- platformKey,
1145
- startDate,
1146
- }: {
1147
- /**
1148
- * * `today` - Today only
1149
- * * `7d` - Last 7 days
1150
- * * `30d` - Last 30 days
1151
- * * `90d` - Last 90 days
1152
- * * `all_time` - All time
1153
- * * `custom` - Custom date range
1154
- */
1155
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
1156
- endDate?: string,
1157
- /**
1158
- * * `day` - day
1159
- * * `hour` - hour
1160
- * * `week` - week
1161
- * * `month` - month
1162
- */
1163
- granularity?: 'day' | 'hour' | 'week' | 'month',
1164
- mentorUniqueId?: string,
1165
- platformKey?: string,
1166
- startDate?: string,
1167
- }): CancelablePromise<AccessTimesHeatmap> {
1168
- return __request(OpenAPI, {
1169
- method: 'GET',
1170
- url: '/api/analytics/time/',
1171
- query: {
1172
- 'date_filter': dateFilter,
1173
- 'end_date': endDate,
1174
- 'granularity': granularity,
1175
- 'mentor_unique_id': mentorUniqueId,
1176
- 'platform_key': platformKey,
1177
- 'start_date': startDate,
1178
- },
1179
- errors: {
1180
- 400: `Bad Request - Invalid parameters`,
1181
- 403: `Forbidden - Insufficient permissions`,
1182
- 500: `Internal Server Error`,
1183
- },
1184
- });
1185
- }
1186
- /**
1187
- * @returns TopicsOverview
1188
- * @throws ApiError
1189
- */
1190
- public static analyticsTopicsRetrieve({
1191
- dateFilter = 'today',
1192
- endDate,
1193
- granularity = 'hour',
1194
- mentorUniqueId,
1195
- metric = 'overview',
1196
- platformKey,
1197
- startDate,
1198
- }: {
1199
- /**
1200
- * * `today` - Today only
1201
- * * `7d` - Last 7 days
1202
- * * `30d` - Last 30 days
1203
- * * `90d` - Last 90 days
1204
- * * `all_time` - All time
1205
- * * `custom` - Custom date range
1206
- */
1207
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
1208
- endDate?: string,
1209
- /**
1210
- * * `day` - day
1211
- * * `hour` - hour
1212
- * * `week` - week
1213
- * * `month` - month
1214
- */
1215
- granularity?: 'day' | 'hour' | 'week' | 'month',
1216
- mentorUniqueId?: string,
1217
- /**
1218
- * * `overview` - Overall topic metrics
1219
- * * `sessions` - Sessions over time
1220
- * * `ratings` - Ratings over time
1221
- * * `highlighted` - Highlighted topics
1222
- */
1223
- metric?: 'overview' | 'sessions' | 'ratings' | 'highlighted',
1224
- platformKey?: string,
1225
- startDate?: string,
1226
- }): CancelablePromise<TopicsOverview> {
1227
- return __request(OpenAPI, {
1228
- method: 'GET',
1229
- url: '/api/analytics/topics/',
1230
- query: {
1231
- 'date_filter': dateFilter,
1232
- 'end_date': endDate,
1233
- 'granularity': granularity,
1234
- 'mentor_unique_id': mentorUniqueId,
1235
- 'metric': metric,
1236
- 'platform_key': platformKey,
1237
- 'start_date': startDate,
1238
- },
1239
- });
1240
- }
1241
- /**
1242
- * @returns TopicDetails
1243
- * @throws ApiError
1244
- */
1245
- public static analyticsTopicsDetailsRetrieve({
1246
- dateFilter = 'today',
1247
- endDate,
1248
- limit = 20,
1249
- mentorUniqueId,
1250
- page = 1,
1251
- platformKey,
1252
- search,
1253
- startDate,
1254
- }: {
1255
- /**
1256
- * * `today` - Today only
1257
- * * `7d` - Last 7 days
1258
- * * `30d` - Last 30 days
1259
- * * `90d` - Last 90 days
1260
- * * `all_time` - All time
1261
- * * `custom` - Custom date range
1262
- */
1263
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
1264
- endDate?: string,
1265
- limit?: number,
1266
- mentorUniqueId?: string,
1267
- page?: number,
1268
- platformKey?: string,
1269
- /**
1270
- * Search by topic name
1271
- */
1272
- search?: string,
1273
- startDate?: string,
1274
- }): CancelablePromise<TopicDetails> {
1275
- return __request(OpenAPI, {
1276
- method: 'GET',
1277
- url: '/api/analytics/topics/details/',
1278
- query: {
1279
- 'date_filter': dateFilter,
1280
- 'end_date': endDate,
1281
- 'limit': limit,
1282
- 'mentor_unique_id': mentorUniqueId,
1283
- 'page': page,
1284
- 'platform_key': platformKey,
1285
- 'search': search,
1286
- 'start_date': startDate,
1287
- },
1288
- });
1289
- }
1290
- /**
1291
- *
1292
- * User Analytics API - Comprehensive user activity metrics and trends.
1293
- *
1294
- * Provides real-time and historical user analytics including:
1295
- * - Currently active users (last hour)
1296
- * - Active users over time periods (7d, 30d, 90d)
1297
- * - Registered user counts and growth
1298
- * - Time series charts with customizable granularity
1299
- *
1300
- * **Key Features:**
1301
- * - Real-time active user counting
1302
- * - Percentage change calculations vs previous periods
1303
- * - Flexible date filtering and granularity
1304
- * - Platform and mentor-specific filtering
1305
- * - Forward-filled time series data
1306
- *
1307
- * **Supported Metrics:**
1308
- * - `currently_active`: Users active in last hour
1309
- * - `active_users`: Unique users in specified period
1310
- * - `registered_users`: Total and new user counts
1311
- *
1312
- * @returns CurrentUsersResponse User analytics metrics with comparison data
1313
- * @throws ApiError
1314
- */
1315
- public static analyticsUsersRetrieve({
1316
- metric,
1317
- dateFilter = 'today',
1318
- endDate,
1319
- granularity = 'hour',
1320
- mentorUniqueId,
1321
- platformKey,
1322
- startDate,
1323
- }: {
1324
- /**
1325
- * * `currently_active` - Users logged in right now
1326
- * * `active_users` - Active users in a period
1327
- * * `registered_users` - Registered users
1328
- * * `active_users_last_30d` - Active users in the last 30 days
1329
- */
1330
- metric: 'currently_active' | 'active_users' | 'registered_users' | 'active_users_last_30d',
1331
- /**
1332
- * * `today` - Today only
1333
- * * `7d` - Last 7 days
1334
- * * `30d` - Last 30 days
1335
- * * `90d` - Last 90 days
1336
- * * `all_time` - All time
1337
- * * `custom` - Custom date range
1338
- */
1339
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
1340
- endDate?: string,
1341
- /**
1342
- * * `day` - day
1343
- * * `hour` - hour
1344
- * * `week` - week
1345
- * * `month` - month
1346
- */
1347
- granularity?: 'day' | 'hour' | 'week' | 'month',
1348
- mentorUniqueId?: string,
1349
- platformKey?: string,
1350
- startDate?: string,
1351
- }): CancelablePromise<CurrentUsersResponse> {
1352
- return __request(OpenAPI, {
1353
- method: 'GET',
1354
- url: '/api/analytics/users/',
1355
- query: {
1356
- 'date_filter': dateFilter,
1357
- 'end_date': endDate,
1358
- 'granularity': granularity,
1359
- 'mentor_unique_id': mentorUniqueId,
1360
- 'metric': metric,
1361
- 'platform_key': platformKey,
1362
- 'start_date': startDate,
1363
- },
1364
- errors: {
1365
- 400: `Bad Request - Invalid parameters`,
1366
- 403: `Forbidden - Insufficient permissions`,
1367
- 500: `Internal Server Error`,
1368
- },
1369
- });
1370
- }
1371
- /**
1372
- *
1373
- * User Details API - Comprehensive user activity details with search and filtering.
1374
- *
1375
- * Provides detailed user information including:
1376
- * - User contact information (email, full name)
1377
- * - Activity metrics (message count, last activity)
1378
- * - Search functionality across multiple fields
1379
- * - Flexible date range filtering
1380
- * - CSV export capability
1381
- *
1382
- * **Key Features:**
1383
- * - Full-text search across email, name, and user ID
1384
- * - Date range filtering for activity periods
1385
- * - Platform and mentor-specific filtering
1386
- * - Comprehensive pagination with metadata
1387
- * - CSV export for data analysis
1388
- * - User aggregation across platforms/mentors
1389
- *
1390
- * **Search Capabilities:**
1391
- * - Email address matching
1392
- * - Full name search
1393
- * - User ID lookup
1394
- * - Partial string matching (case-insensitive)
1395
- *
1396
- * **Export Options:**
1397
- * - JSON response (default)
1398
- * - CSV export (?export=csv)
1399
- * - Includes all user fields in export
1400
- *
1401
- * @returns UserDetail Paginated user details with activity metrics
1402
- * @throws ApiError
1403
- */
1404
- public static analyticsUsersDetailsRetrieve({
1405
- dateFilter = 'today',
1406
- endDate,
1407
- limit = 20,
1408
- mentorUniqueId,
1409
- page = 1,
1410
- platformKey,
1411
- search,
1412
- startDate,
1413
- }: {
1414
- /**
1415
- * * `today` - Today only
1416
- * * `7d` - Last 7 days
1417
- * * `30d` - Last 30 days
1418
- * * `90d` - Last 90 days
1419
- * * `all_time` - All time
1420
- * * `custom` - Custom date range
1421
- */
1422
- dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
1423
- endDate?: string,
1424
- limit?: number,
1425
- mentorUniqueId?: string,
1426
- page?: number,
1427
- platformKey?: string,
1428
- /**
1429
- * Search by email, full name, or user ID
1430
- */
1431
- search?: string,
1432
- startDate?: string,
1433
- }): CancelablePromise<UserDetail> {
1434
- return __request(OpenAPI, {
1435
- method: 'GET',
1436
- url: '/api/analytics/users/details/',
1437
- query: {
1438
- 'date_filter': dateFilter,
1439
- 'end_date': endDate,
1440
- 'limit': limit,
1441
- 'mentor_unique_id': mentorUniqueId,
1442
- 'page': page,
1443
- 'platform_key': platformKey,
1444
- 'search': search,
1445
- 'start_date': startDate,
1446
- },
1447
- errors: {
1448
- 400: `Bad Request - Invalid parameters`,
1449
- 403: `Forbidden - Insufficient permissions`,
1450
- 500: `Internal Server Error`,
1451
- },
1452
- });
1453
- }
1454
- }
300
+ * @returns LearnerListResponse Paginated list of learners with their metrics
301
+ * @throws ApiError
302
+ */
303
+ public static analyticsLearnersListRetrieve({
304
+ platformKey,
305
+ dateFilter = 'today',
306
+ endDate,
307
+ granularity = 'hour',
308
+ limit = 20,
309
+ page = 1,
310
+ search,
311
+ sortBy = 'last_activity',
312
+ sortOrder = 'desc',
313
+ startDate,
314
+ usergroupIds,
315
+ }: {
316
+ /**
317
+ * Platform key to filter learners by platform
318
+ */
319
+ platformKey: string,
320
+ /**
321
+ * * `today` - Today only
322
+ * * `7d` - Last 7 days
323
+ * * `30d` - Last 30 days
324
+ * * `90d` - Last 90 days
325
+ * * `all_time` - All time
326
+ * * `custom` - Custom date range
327
+ */
328
+ dateFilter?: 'today' | '7d' | '30d' | '90d' | 'all_time' | 'custom',
329
+ endDate?: string,
330
+ /**
331
+ * * `day` - day
332
+ * * `hour` - hour
333
+ * * `week` - week
334
+ * * `month` - month
335
+ */
336
+ granularity?: 'day' | 'hour' | 'week' | 'month',
337
+ /**
338
+ * Number of learners per page (default: 20, max: 100)
339
+ */
340
+ limit?: number,
341
+ /**
342
+ * Page number for pagination (default: 1)
343
+ */
344
+ page?: number,
345
+ /**
346
+ * Search term to filter learners by username, email, or name
347
+ */
348
+ search?: string,
349
+ /**
350
+ * Field to sort learners by (default: last_activity)
351
+ *
352
+ * * `username` - Username
353
+ * * `name` - Name
354
+ * * `last_activity` - Last Activity
355
+ * * `total_points` - Total Points
356
+ * * `total_time_spent_seconds` - Time Spent
357
+ * * `total_enrollments` - Enrollments
358
+ * * `total_skills_count` - Skills Count
359
+ */
360
+ sortBy?: 'username' | 'name' | 'last_activity' | 'total_points' | 'total_time_spent_seconds' | 'total_enrollments' | 'total_skills_count',
361
+ /**
362
+ * Sort order (default: desc)
363
+ *
364
+ * * `asc` - Ascending
365
+ * * `desc` - Descending
366
+ */
367
+ sortOrder?: 'asc' | 'desc',
368
+ startDate?: string,
369
+ /**
370
+ * Optional list of usergroup IDs to filter results
371
+ */
372
+ usergroupIds?: Array<number> | null,
373
+ }): CancelablePromise<LearnerListResponse> {
374
+ return __request(OpenAPI, {
375
+ method: 'GET',
376
+ url: '/api/analytics/learners/list/',
377
+ query: {
378
+ 'date_filter': dateFilter,
379
+ 'end_date': endDate,
380
+ 'granularity': granularity,
381
+ 'limit': limit,
382
+ 'page': page,
383
+ 'platform_key': platformKey,
384
+ 'search': search,
385
+ 'sort_by': sortBy,
386
+ 'sort_order': sortOrder,
387
+ 'start_date': startDate,
388
+ 'usergroup_ids': usergroupIds,
389
+ },
390
+ errors: {
391
+ 400: `Bad Request - Invalid parameters supplied`,
392
+ 403: `Forbidden - Platform admin access required`,
393
+ 500: `Unexpected error`,
394
+ },
395
+ });
396
+ }
397
+ }