@iblai/iblai-api 3.34.5-ai

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (896) hide show
  1. package/README.md +222 -0
  2. package/dist/index.cjs.js +18756 -0
  3. package/dist/index.cjs.js.map +1 -0
  4. package/dist/index.esm.js +18726 -0
  5. package/dist/index.esm.js.map +1 -0
  6. package/dist/index.umd.js +18762 -0
  7. package/dist/index.umd.js.map +1 -0
  8. package/dist/types/core/ApiError.d.ts +10 -0
  9. package/dist/types/core/ApiRequestOptions.d.ts +13 -0
  10. package/dist/types/core/ApiResult.d.ts +7 -0
  11. package/dist/types/core/CancelablePromise.d.ts +20 -0
  12. package/dist/types/core/OpenAPI.d.ts +16 -0
  13. package/dist/types/core/request.d.ts +30 -0
  14. package/dist/types/index.d.ts +440 -0
  15. package/dist/types/models/AIGeneratedImage.d.ts +13 -0
  16. package/dist/types/models/APITokenCost.d.ts +14 -0
  17. package/dist/types/models/AcceptanceEnum.d.ts +10 -0
  18. package/dist/types/models/AccessEnum.d.ts +8 -0
  19. package/dist/types/models/ActiveUsersData.d.ts +18 -0
  20. package/dist/types/models/ActiveUsersList.d.ts +6 -0
  21. package/dist/types/models/ActiveUsersPerCourse.d.ts +10 -0
  22. package/dist/types/models/ActiveUsersPerCourseData.d.ts +14 -0
  23. package/dist/types/models/ActivityAPI.d.ts +8 -0
  24. package/dist/types/models/ActivityData.d.ts +38 -0
  25. package/dist/types/models/AlignMentorBubbleEnum.d.ts +8 -0
  26. package/dist/types/models/AnalyticsOverview.d.ts +7 -0
  27. package/dist/types/models/Answer.d.ts +11 -0
  28. package/dist/types/models/Assertion.d.ts +15 -0
  29. package/dist/types/models/AssumedKnowledge.d.ts +4 -0
  30. package/dist/types/models/AssumedKnowledgeLevel.d.ts +4 -0
  31. package/dist/types/models/AudioToTextRequest.d.ts +3 -0
  32. package/dist/types/models/AudioToTextResponse.d.ts +3 -0
  33. package/dist/types/models/Average.d.ts +4 -0
  34. package/dist/types/models/AverageData.d.ts +6 -0
  35. package/dist/types/models/AverageOvertime.d.ts +22 -0
  36. package/dist/types/models/AvgCourseGradeWithCutoff.d.ts +4 -0
  37. package/dist/types/models/AvgCourseGradeWithCutoffData.d.ts +10 -0
  38. package/dist/types/models/BlankEnum.d.ts +2 -0
  39. package/dist/types/models/BulkCreateAssertion.d.ts +4 -0
  40. package/dist/types/models/CallAuthenticationRequest.d.ts +13 -0
  41. package/dist/types/models/CallAuthenticationResponse.d.ts +21 -0
  42. package/dist/types/models/CampaignEnablement.d.ts +8 -0
  43. package/dist/types/models/CampaignExclusion.d.ts +8 -0
  44. package/dist/types/models/ChatHistory.d.ts +8 -0
  45. package/dist/types/models/ChatHistoryFilterData.d.ts +9 -0
  46. package/dist/types/models/ChatHistoryFilterUser.d.ts +5 -0
  47. package/dist/types/models/ChatHistoryItem.d.ts +5 -0
  48. package/dist/types/models/ChatHistorySessionId.d.ts +3 -0
  49. package/dist/types/models/ChatSessionRequest.d.ts +10 -0
  50. package/dist/types/models/ChatSessionResponse.d.ts +5 -0
  51. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +10 -0
  52. package/dist/types/models/Company.d.ts +23 -0
  53. package/dist/types/models/ComponentBlock.d.ts +9 -0
  54. package/dist/types/models/ComponentBlockTypeEnum.d.ts +8 -0
  55. package/dist/types/models/ContextResponse.d.ts +7 -0
  56. package/dist/types/models/ConversationMessage.d.ts +11 -0
  57. package/dist/types/models/ConversationRating.d.ts +6 -0
  58. package/dist/types/models/ConversationSummary.d.ts +5 -0
  59. package/dist/types/models/ConversationVolume.d.ts +4 -0
  60. package/dist/types/models/Conversations.d.ts +28 -0
  61. package/dist/types/models/Cost.d.ts +3 -0
  62. package/dist/types/models/CostPerTenant.d.ts +6 -0
  63. package/dist/types/models/Count.d.ts +4 -0
  64. package/dist/types/models/CountData.d.ts +6 -0
  65. package/dist/types/models/CourseCompletionPerCourse.d.ts +6 -0
  66. package/dist/types/models/CourseCompletionPerCourseData.d.ts +22 -0
  67. package/dist/types/models/CourseCompletionSummaryDataOvertime.d.ts +18 -0
  68. package/dist/types/models/CourseCompletionSummaryOvertime.d.ts +6 -0
  69. package/dist/types/models/CourseCreationTask.d.ts +31 -0
  70. package/dist/types/models/CourseCreationTaskFile.d.ts +7 -0
  71. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +16 -0
  72. package/dist/types/models/CourseGradeDetailBlock.d.ts +18 -0
  73. package/dist/types/models/CourseGradeDetailSubSection.d.ts +23 -0
  74. package/dist/types/models/CourseGradeSummary.d.ts +4 -0
  75. package/dist/types/models/CourseGradeSummaryData.d.ts +18 -0
  76. package/dist/types/models/CourseGradingDetail.d.ts +4 -0
  77. package/dist/types/models/CourseGradingDetailData.d.ts +12 -0
  78. package/dist/types/models/CoursePoint.d.ts +7 -0
  79. package/dist/types/models/CourseSkill.d.ts +8 -0
  80. package/dist/types/models/Credential.d.ts +28 -0
  81. package/dist/types/models/CredentialRequest.d.ts +14 -0
  82. package/dist/types/models/CrontabSchedule.d.ts +22 -0
  83. package/dist/types/models/CustomInstructionResponse.d.ts +13 -0
  84. package/dist/types/models/DateRange.d.ts +4 -0
  85. package/dist/types/models/DesiredSkill.d.ts +4 -0
  86. package/dist/types/models/DetailedGradeSubsection.d.ts +22 -0
  87. package/dist/types/models/DetailedGradeView.d.ts +4 -0
  88. package/dist/types/models/DetailedGradeViewData.d.ts +12 -0
  89. package/dist/types/models/Education.d.ts +30 -0
  90. package/dist/types/models/EdxCourse.d.ts +11 -0
  91. package/dist/types/models/ElevenlabsCustomVoice.d.ts +4 -0
  92. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +8 -0
  93. package/dist/types/models/EmailPromptDetail.d.ts +13 -0
  94. package/dist/types/models/EmailPromptList.d.ts +11 -0
  95. package/dist/types/models/EmailPromptSummary.d.ts +5 -0
  96. package/dist/types/models/EngagementPerCourse.d.ts +6 -0
  97. package/dist/types/models/EngagementPerCourseData.d.ts +26 -0
  98. package/dist/types/models/Enrollments.d.ts +8 -0
  99. package/dist/types/models/EnrollmentsData.d.ts +18 -0
  100. package/dist/types/models/EnrollmentsPerUser.d.ts +6 -0
  101. package/dist/types/models/EnrollmentsPerUserData.d.ts +18 -0
  102. package/dist/types/models/ErrorResponse.d.ts +8 -0
  103. package/dist/types/models/Experience.d.ts +29 -0
  104. package/dist/types/models/FloatOverTime.d.ts +10 -0
  105. package/dist/types/models/FreeUsageCount.d.ts +3 -0
  106. package/dist/types/models/FullCourse.d.ts +13 -0
  107. package/dist/types/models/GradingPerUser.d.ts +8 -0
  108. package/dist/types/models/GradingPerUserData.d.ts +26 -0
  109. package/dist/types/models/GreetingMethodEnum.d.ts +8 -0
  110. package/dist/types/models/GroupList.d.ts +6 -0
  111. package/dist/types/models/GroupListData.d.ts +16 -0
  112. package/dist/types/models/GuidedPromptsResponse.d.ts +3 -0
  113. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +8 -0
  114. package/dist/types/models/HeygenMarketingVideoList.d.ts +6 -0
  115. package/dist/types/models/IBLAIPlatformMeta.d.ts +3 -0
  116. package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +6 -0
  117. package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +10 -0
  118. package/dist/types/models/ImageUpload.d.ts +3 -0
  119. package/dist/types/models/InputQuestion.d.ts +6 -0
  120. package/dist/types/models/Institution.d.ts +20 -0
  121. package/dist/types/models/InstitutionTypeEnum.d.ts +14 -0
  122. package/dist/types/models/IntegrationCredential.d.ts +8 -0
  123. package/dist/types/models/IntialQuestionAnswer.d.ts +3 -0
  124. package/dist/types/models/Issuer.d.ts +9 -0
  125. package/dist/types/models/IssuerAuthority.d.ts +5 -0
  126. package/dist/types/models/JobRun.d.ts +11 -0
  127. package/dist/types/models/KindEnum.d.ts +10 -0
  128. package/dist/types/models/LLMCredentialRequest.d.ts +14 -0
  129. package/dist/types/models/LLMCredentialResponse.d.ts +8 -0
  130. package/dist/types/models/LLMModelForTenant.d.ts +6 -0
  131. package/dist/types/models/LLMQuestion.d.ts +15 -0
  132. package/dist/types/models/LLMResponse.d.ts +14 -0
  133. package/dist/types/models/LLMTracesListResponse.d.ts +5 -0
  134. package/dist/types/models/LanguagesView.d.ts +5 -0
  135. package/dist/types/models/LearnerInformationAPI.d.ts +4 -0
  136. package/dist/types/models/LearnerInformationAPIData.d.ts +83 -0
  137. package/dist/types/models/LinkCourseRequest.d.ts +3 -0
  138. package/dist/types/models/LinkCourseResponse.d.ts +5 -0
  139. package/dist/types/models/LtiKey.d.ts +19 -0
  140. package/dist/types/models/LtiLaunchGate.d.ts +8 -0
  141. package/dist/types/models/LtiTool.d.ts +46 -0
  142. package/dist/types/models/MemoryComponentData.d.ts +5 -0
  143. package/dist/types/models/MemoryComponentMemory.d.ts +4 -0
  144. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +8 -0
  145. package/dist/types/models/MemoryComponentResponse.d.ts +5 -0
  146. package/dist/types/models/MemoryProgress.d.ts +8 -0
  147. package/dist/types/models/MemoryStatusRequestView.d.ts +6 -0
  148. package/dist/types/models/MemoryStatusView.d.ts +6 -0
  149. package/dist/types/models/Mentor.d.ts +75 -0
  150. package/dist/types/models/MentorAudience.d.ts +5 -0
  151. package/dist/types/models/MentorCategory.d.ts +9 -0
  152. package/dist/types/models/MentorCategoryCreate.d.ts +11 -0
  153. package/dist/types/models/MentorCategoryGroup.d.ts +11 -0
  154. package/dist/types/models/MentorCategoryGroupCreate.d.ts +11 -0
  155. package/dist/types/models/MentorCreate.d.ts +74 -0
  156. package/dist/types/models/MentorCustomVoice.d.ts +4 -0
  157. package/dist/types/models/MentorCustomVoiceResponse.d.ts +4 -0
  158. package/dist/types/models/MentorData.d.ts +7 -0
  159. package/dist/types/models/MentorDetailAnalytics.d.ts +6 -0
  160. package/dist/types/models/MentorEval.d.ts +11 -0
  161. package/dist/types/models/MentorEvalQuestion.d.ts +5 -0
  162. package/dist/types/models/MentorEvalQuestionRequest.d.ts +4 -0
  163. package/dist/types/models/MentorEvalReport.d.ts +10 -0
  164. package/dist/types/models/MentorEvalRequest.d.ts +8 -0
  165. package/dist/types/models/MentorFork.d.ts +5 -0
  166. package/dist/types/models/MentorFromTemplateRequest.d.ts +4 -0
  167. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +42 -0
  168. package/dist/types/models/MentorMemorySettingsRequest.d.ts +6 -0
  169. package/dist/types/models/MentorMemorySettingsResponse.d.ts +6 -0
  170. package/dist/types/models/MentorMetadata.d.ts +5 -0
  171. package/dist/types/models/MentorScenario.d.ts +6 -0
  172. package/dist/types/models/MentorScenarioPrompt.d.ts +5 -0
  173. package/dist/types/models/MentorSession.d.ts +4 -0
  174. package/dist/types/models/MentorSettings.d.ts +47 -0
  175. package/dist/types/models/MentorSettingsPublic.d.ts +40 -0
  176. package/dist/types/models/MentorSettingsRequest.d.ts +51 -0
  177. package/dist/types/models/MentorVisibilityEnum.d.ts +10 -0
  178. package/dist/types/models/MentorWizard.d.ts +4 -0
  179. package/dist/types/models/MessageStatistics.d.ts +5 -0
  180. package/dist/types/models/MessageView.d.ts +10 -0
  181. package/dist/types/models/MessageViewRequest.d.ts +7 -0
  182. package/dist/types/models/MessageViewUpdatResponse.d.ts +3 -0
  183. package/dist/types/models/Metadata.d.ts +5 -0
  184. package/dist/types/models/MetricChange.d.ts +4 -0
  185. package/dist/types/models/ModelCost.d.ts +4 -0
  186. package/dist/types/models/ModerationLog.d.ts +11 -0
  187. package/dist/types/models/NetRevenueOverTime.d.ts +8 -0
  188. package/dist/types/models/NewPerLearnerList.d.ts +6 -0
  189. package/dist/types/models/NewPerLearnerListData.d.ts +17 -0
  190. package/dist/types/models/NoChatMessagesFound.d.ts +3 -0
  191. package/dist/types/models/Notification.d.ts +13 -0
  192. package/dist/types/models/NotificationCount.d.ts +4 -0
  193. package/dist/types/models/NotificationPreview.d.ts +31 -0
  194. package/dist/types/models/NotificationSource.d.ts +8 -0
  195. package/dist/types/models/NotificationSourceTypeEnum.d.ts +18 -0
  196. package/dist/types/models/NotificationStatusEnum.d.ts +10 -0
  197. package/dist/types/models/NotificationTemplateData.d.ts +26 -0
  198. package/dist/types/models/NullEnum.d.ts +1 -0
  199. package/dist/types/models/Order.d.ts +22 -0
  200. package/dist/types/models/OverTime.d.ts +3 -0
  201. package/dist/types/models/OverTimeWithTotal.d.ts +22 -0
  202. package/dist/types/models/OvertimeMeta.d.ts +30 -0
  203. package/dist/types/models/OvertimeWithChangeInfo.d.ts +24 -0
  204. package/dist/types/models/PageContent.d.ts +6 -0
  205. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +7 -0
  206. package/dist/types/models/PaginatedConversationsList.d.ts +7 -0
  207. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +7 -0
  208. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +7 -0
  209. package/dist/types/models/PaginatedEdxCourseList.d.ts +7 -0
  210. package/dist/types/models/PaginatedEmailPromptListList.d.ts +7 -0
  211. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +7 -0
  212. package/dist/types/models/PaginatedJobRunList.d.ts +7 -0
  213. package/dist/types/models/PaginatedMentorList.d.ts +7 -0
  214. package/dist/types/models/PaginatedModerationLogList.d.ts +7 -0
  215. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +7 -0
  216. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +7 -0
  217. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +7 -0
  218. package/dist/types/models/PaginatedSectionList.d.ts +7 -0
  219. package/dist/types/models/PaginatedSubSectionList.d.ts +7 -0
  220. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +7 -0
  221. package/dist/types/models/PaginatedUnitList.d.ts +7 -0
  222. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +7 -0
  223. package/dist/types/models/PaginatedVoiceList.d.ts +7 -0
  224. package/dist/types/models/Pagination.d.ts +18 -0
  225. package/dist/types/models/PatchedConversations.d.ts +28 -0
  226. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +7 -0
  227. package/dist/types/models/PatchedCredentialRequest.d.ts +14 -0
  228. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +14 -0
  229. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +11 -0
  230. package/dist/types/models/PatchedMentorCreate.d.ts +74 -0
  231. package/dist/types/models/PatchedNotification.d.ts +13 -0
  232. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +41 -0
  233. package/dist/types/models/PatchedPlatformPublicMetadata.d.ts +8 -0
  234. package/dist/types/models/PatchedPlayWrightScript.d.ts +12 -0
  235. package/dist/types/models/PatchedPrompt.d.ts +22 -0
  236. package/dist/types/models/PatchedSection.d.ts +9 -0
  237. package/dist/types/models/PatchedSkillThreshold.d.ts +14 -0
  238. package/dist/types/models/PatchedSubSection.d.ts +9 -0
  239. package/dist/types/models/PatchedUnit.d.ts +11 -0
  240. package/dist/types/models/PerLearnerCourseLastAccessData.d.ts +30 -0
  241. package/dist/types/models/PerLearnerCourseVideosWatched.d.ts +8 -0
  242. package/dist/types/models/PerLearnerCourseVideosWatchedData.d.ts +14 -0
  243. package/dist/types/models/PerLearnerLastAccess.d.ts +4 -0
  244. package/dist/types/models/PerLearnerLastAccessData.d.ts +11 -0
  245. package/dist/types/models/PerLearnerTimeSpentInCourseTree.d.ts +8 -0
  246. package/dist/types/models/PerformanceGradesPerCourse.d.ts +6 -0
  247. package/dist/types/models/PerformanceGradesPerCourseData.d.ts +22 -0
  248. package/dist/types/models/PeriodicAgent.d.ts +42 -0
  249. package/dist/types/models/PeriodicAgentCreate.d.ts +41 -0
  250. package/dist/types/models/PeriodicAgentLog.d.ts +11 -0
  251. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +10 -0
  252. package/dist/types/models/PeriodicTask.d.ts +21 -0
  253. package/dist/types/models/PerlearnerCourseProgress.d.ts +4 -0
  254. package/dist/types/models/PerlearnerCourseProgressData.d.ts +6 -0
  255. package/dist/types/models/PerlearnerEngagementVideosData.d.ts +30 -0
  256. package/dist/types/models/PerlearnerEngagementVideosWatchedPerCourse.d.ts +4 -0
  257. package/dist/types/models/PerlearnerGradeSummary.d.ts +4 -0
  258. package/dist/types/models/PerlearnerGradeSummaryData.d.ts +18 -0
  259. package/dist/types/models/PerlearnerGradeWithCutOff.d.ts +4 -0
  260. package/dist/types/models/PerlearnerGradeWithCutOffData.d.ts +10 -0
  261. package/dist/types/models/PerlearnerGradingPerCourseAPI.d.ts +4 -0
  262. package/dist/types/models/PerlearnerGradingPerCourseAPIData.d.ts +34 -0
  263. package/dist/types/models/PerlearnerUserList.d.ts +6 -0
  264. package/dist/types/models/PerlearnerUserListData.d.ts +34 -0
  265. package/dist/types/models/PieChartData.d.ts +5 -0
  266. package/dist/types/models/PieChartSegment.d.ts +4 -0
  267. package/dist/types/models/PinnedMessageCreate.d.ts +9 -0
  268. package/dist/types/models/PinnedMessageGet.d.ts +7 -0
  269. package/dist/types/models/PinnedMessageRequest.d.ts +6 -0
  270. package/dist/types/models/PlatformPublicMetadata.d.ts +8 -0
  271. package/dist/types/models/PlayWrightScript.d.ts +12 -0
  272. package/dist/types/models/PointsPercentile.d.ts +8 -0
  273. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +4 -0
  274. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +4 -0
  275. package/dist/types/models/PreviewResponse.d.ts +11 -0
  276. package/dist/types/models/PreviousAgentStatusEnum.d.ts +12 -0
  277. package/dist/types/models/Product.d.ts +22 -0
  278. package/dist/types/models/ProductTable.d.ts +26 -0
  279. package/dist/types/models/Program.d.ts +24 -0
  280. package/dist/types/models/ProgramTypeEnum.d.ts +18 -0
  281. package/dist/types/models/Prompt.d.ts +22 -0
  282. package/dist/types/models/PromptCategory.d.ts +7 -0
  283. package/dist/types/models/PromptVisibilityEnum.d.ts +10 -0
  284. package/dist/types/models/ProviderEnum.d.ts +10 -0
  285. package/dist/types/models/QuestionCardTag.d.ts +8 -0
  286. package/dist/types/models/QuestionRequest.d.ts +15 -0
  287. package/dist/types/models/QuestionResponse.d.ts +10 -0
  288. package/dist/types/models/RatingEnum.d.ts +8 -0
  289. package/dist/types/models/RatingRecord.d.ts +4 -0
  290. package/dist/types/models/RecentlyAccessedMentor.d.ts +8 -0
  291. package/dist/types/models/Recipient.d.ts +8 -0
  292. package/dist/types/models/RecommendCourseBlock.d.ts +3 -0
  293. package/dist/types/models/RecommendCourseResponse.d.ts +3 -0
  294. package/dist/types/models/RecommendationSearchAPI.d.ts +3 -0
  295. package/dist/types/models/RedirectTokenRequest.d.ts +3 -0
  296. package/dist/types/models/RedirectTokenResponse.d.ts +5 -0
  297. package/dist/types/models/RelatedText.d.ts +3 -0
  298. package/dist/types/models/ReportCreate.d.ts +7 -0
  299. package/dist/types/models/ReportData.d.ts +28 -0
  300. package/dist/types/models/ReportDetail.d.ts +4 -0
  301. package/dist/types/models/ReportList.d.ts +4 -0
  302. package/dist/types/models/ReportRequest.d.ts +21 -0
  303. package/dist/types/models/ReportStatus.d.ts +41 -0
  304. package/dist/types/models/ReportedSkill.d.ts +4 -0
  305. package/dist/types/models/RequestDataVariable.d.ts +14 -0
  306. package/dist/types/models/ResourcePoint.d.ts +7 -0
  307. package/dist/types/models/ResourceScrappedData.d.ts +13 -0
  308. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +12 -0
  309. package/dist/types/models/ResponseDataVariable.d.ts +14 -0
  310. package/dist/types/models/RetreiverTrainViewRequest.d.ts +10 -0
  311. package/dist/types/models/RetreiverTrainViewResponse.d.ts +6 -0
  312. package/dist/types/models/RetrieveTask.d.ts +3 -0
  313. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +17 -0
  314. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +30 -0
  315. package/dist/types/models/RetrieverRequestSearch.d.ts +10 -0
  316. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +10 -0
  317. package/dist/types/models/RetrieverResponseSearch.d.ts +7 -0
  318. package/dist/types/models/ReuestDataVariableList.d.ts +4 -0
  319. package/dist/types/models/RevenueByProduct.d.ts +6 -0
  320. package/dist/types/models/RunMentorEval.d.ts +3 -0
  321. package/dist/types/models/ScanWebhookRequest.d.ts +6 -0
  322. package/dist/types/models/ScanWebhookResponse.d.ts +3 -0
  323. package/dist/types/models/Section.d.ts +9 -0
  324. package/dist/types/models/SectionWithChildren.d.ts +11 -0
  325. package/dist/types/models/SeedMentorsView.d.ts +3 -0
  326. package/dist/types/models/SendNotification.d.ts +6 -0
  327. package/dist/types/models/SendResponse.d.ts +9 -0
  328. package/dist/types/models/SentimentSummary.d.ts +4 -0
  329. package/dist/types/models/SessionBrowserScreenshot.d.ts +8 -0
  330. package/dist/types/models/SessionDetail.d.ts +6 -0
  331. package/dist/types/models/SessionMemoryStorage.d.ts +6 -0
  332. package/dist/types/models/ShellLogs.d.ts +3 -0
  333. package/dist/types/models/Skill.d.ts +7 -0
  334. package/dist/types/models/SkillDetail.d.ts +9 -0
  335. package/dist/types/models/SkillInfo.d.ts +23 -0
  336. package/dist/types/models/SkillThreshold.d.ts +14 -0
  337. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +3 -0
  338. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +5 -0
  339. package/dist/types/models/StarMentor.d.ts +7 -0
  340. package/dist/types/models/StateEnum.d.ts +22 -0
  341. package/dist/types/models/Status6eeEnum.d.ts +12 -0
  342. package/dist/types/models/Step.d.ts +9 -0
  343. package/dist/types/models/StepStatusEnum.d.ts +10 -0
  344. package/dist/types/models/StudentChatMessage.d.ts +4 -0
  345. package/dist/types/models/StylesView.d.ts +4 -0
  346. package/dist/types/models/SubSection.d.ts +9 -0
  347. package/dist/types/models/SubSectionWithChildren.d.ts +11 -0
  348. package/dist/types/models/SubTimeChild.d.ts +18 -0
  349. package/dist/types/models/Summary.d.ts +18 -0
  350. package/dist/types/models/TagsView.d.ts +5 -0
  351. package/dist/types/models/TargetSystemEnum.d.ts +8 -0
  352. package/dist/types/models/TaskView.d.ts +3 -0
  353. package/dist/types/models/TemplateMentor.d.ts +9 -0
  354. package/dist/types/models/TenantMentorTraces.d.ts +6 -0
  355. package/dist/types/models/ThemeEnum.d.ts +8 -0
  356. package/dist/types/models/TimeChildData.d.ts +20 -0
  357. package/dist/types/models/TimeDetail.d.ts +8 -0
  358. package/dist/types/models/TimeDetailChild.d.ts +26 -0
  359. package/dist/types/models/TimeDetailData.d.ts +24 -0
  360. package/dist/types/models/TimeSpentByUsersInCourse.d.ts +6 -0
  361. package/dist/types/models/TimeSpentByUsersInCourseData.d.ts +22 -0
  362. package/dist/types/models/TimeSpentPerCourse.d.ts +6 -0
  363. package/dist/types/models/TimeSpentPerCourseData.d.ts +26 -0
  364. package/dist/types/models/TimeSpentPerUserResponse.d.ts +3 -0
  365. package/dist/types/models/TimeSpentUpdateRequest.d.ts +11 -0
  366. package/dist/types/models/TimeSpentUpdateResponse.d.ts +4 -0
  367. package/dist/types/models/TonesView.d.ts +4 -0
  368. package/dist/types/models/ToolResponse.d.ts +9 -0
  369. package/dist/types/models/TopicModel.d.ts +3 -0
  370. package/dist/types/models/TopicRecord.d.ts +4 -0
  371. package/dist/types/models/TopicStatistics.d.ts +7 -0
  372. package/dist/types/models/TopicStatisticsResponse.d.ts +6 -0
  373. package/dist/types/models/TopicSummaryView.d.ts +4 -0
  374. package/dist/types/models/TrainChatSessionDocumentView.d.ts +6 -0
  375. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +6 -0
  376. package/dist/types/models/TrainDocumentViewRequest.d.ts +42 -0
  377. package/dist/types/models/TrainDocumentViewResponse.d.ts +14 -0
  378. package/dist/types/models/TrainingStatusEnum.d.ts +12 -0
  379. package/dist/types/models/TrendEntry.d.ts +4 -0
  380. package/dist/types/models/TriggerRequest.d.ts +5 -0
  381. package/dist/types/models/TriggerResponse.d.ts +6 -0
  382. package/dist/types/models/TypeC42Enum.d.ts +8 -0
  383. package/dist/types/models/Unit.d.ts +11 -0
  384. package/dist/types/models/UnitWithChildren.d.ts +13 -0
  385. package/dist/types/models/UploadedImage.d.ts +5 -0
  386. package/dist/types/models/UseMainCreds.d.ts +3 -0
  387. package/dist/types/models/UserAllChatMemoryView.d.ts +7 -0
  388. package/dist/types/models/UserCatalogItemMemoryView.d.ts +14 -0
  389. package/dist/types/models/UserChatByPeriod.d.ts +4 -0
  390. package/dist/types/models/UserChatFeedback.d.ts +14 -0
  391. package/dist/types/models/UserChatFeedbackCount.d.ts +4 -0
  392. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +6 -0
  393. package/dist/types/models/UserChatMemoryStatusView.d.ts +6 -0
  394. package/dist/types/models/UserChatMemoryUpdateView.d.ts +10 -0
  395. package/dist/types/models/UserCountRecord.d.ts +4 -0
  396. package/dist/types/models/UserEdxMemory.d.ts +15 -0
  397. package/dist/types/models/UserInfo.d.ts +13 -0
  398. package/dist/types/models/UserMemoryContextRequest.d.ts +13 -0
  399. package/dist/types/models/UserMemoryContextResponse.d.ts +12 -0
  400. package/dist/types/models/UserMetric.d.ts +4 -0
  401. package/dist/types/models/UserMetricsResponse.d.ts +7 -0
  402. package/dist/types/models/UserSentimentCountView.d.ts +4 -0
  403. package/dist/types/models/UserSkill.d.ts +22 -0
  404. package/dist/types/models/UserSkillPointsPercentile.d.ts +8 -0
  405. package/dist/types/models/UserTrendByPeriod.d.ts +5 -0
  406. package/dist/types/models/ValidateSourceResponse.d.ts +10 -0
  407. package/dist/types/models/Value.d.ts +4 -0
  408. package/dist/types/models/ValueData.d.ts +6 -0
  409. package/dist/types/models/VectorResult.d.ts +8 -0
  410. package/dist/types/models/VideoBlock.d.ts +14 -0
  411. package/dist/types/models/VideoEngagementPerCourse.d.ts +6 -0
  412. package/dist/types/models/VideoEngagementPerCourseData.d.ts +30 -0
  413. package/dist/types/models/VideosCount.d.ts +4 -0
  414. package/dist/types/models/VideosCountData.d.ts +6 -0
  415. package/dist/types/models/VideosInCourseSummary.d.ts +4 -0
  416. package/dist/types/models/VideosInCourseSummaryData.d.ts +12 -0
  417. package/dist/types/models/VideosSpecificCourse.d.ts +4 -0
  418. package/dist/types/models/VideosSpecificCourseData.d.ts +26 -0
  419. package/dist/types/models/VideosWatchedSubSection.d.ts +19 -0
  420. package/dist/types/models/Voice.d.ts +9 -0
  421. package/dist/types/models/WatchedVideosPerUser.d.ts +8 -0
  422. package/dist/types/models/WatchedVideosPerUserData.d.ts +18 -0
  423. package/dist/types/models/WebResource.d.ts +9 -0
  424. package/dist/types/models/WebResourceCard.d.ts +7 -0
  425. package/dist/types/models/WebResourcesQuery.d.ts +3 -0
  426. package/dist/types/services/AiAccountService.d.ts +294 -0
  427. package/dist/types/services/AiAnalyticsService.d.ts +1056 -0
  428. package/dist/types/services/AiIndexService.d.ts +344 -0
  429. package/dist/types/services/AiMarketingService.d.ts +34 -0
  430. package/dist/types/services/AiMentorService.d.ts +4096 -0
  431. package/dist/types/services/AiPromptService.d.ts +879 -0
  432. package/dist/types/services/AnalyticsService.d.ts +51 -0
  433. package/dist/types/services/AudienceService.d.ts +348 -0
  434. package/dist/types/services/CareerService.d.ts +210 -0
  435. package/dist/types/services/CoreService.d.ts +196 -0
  436. package/dist/types/services/CredentialsService.d.ts +1184 -0
  437. package/dist/types/services/DepartmentsService.d.ts +43 -0
  438. package/dist/types/services/EngagementService.d.ts +467 -0
  439. package/dist/types/services/FinanceService.d.ts +52 -0
  440. package/dist/types/services/NotificationBuilderService.d.ts +58 -0
  441. package/dist/types/services/NotificationService.d.ts +118 -0
  442. package/dist/types/services/OverviewService.d.ts +184 -0
  443. package/dist/types/services/PerformanceService.d.ts +183 -0
  444. package/dist/types/services/PerlearnerService.d.ts +501 -0
  445. package/dist/types/services/PlatformService.d.ts +77 -0
  446. package/dist/types/services/RecommendationsService.d.ts +13 -0
  447. package/dist/types/services/ReportsService.d.ts +142 -0
  448. package/dist/types/services/SearchService.d.ts +710 -0
  449. package/dist/types/services/SkillsService.d.ts +377 -0
  450. package/dist/types/services/UserGroupsService.d.ts +49 -0
  451. package/package.json +39 -0
  452. package/rollup.config.js +113 -0
  453. package/src/core/ApiError.ts +25 -0
  454. package/src/core/ApiRequestOptions.ts +17 -0
  455. package/src/core/ApiResult.ts +11 -0
  456. package/src/core/CancelablePromise.ts +131 -0
  457. package/src/core/OpenAPI.ts +32 -0
  458. package/src/core/request.ts +322 -0
  459. package/src/index.ts +446 -0
  460. package/src/models/AIGeneratedImage.ts +18 -0
  461. package/src/models/APITokenCost.ts +19 -0
  462. package/src/models/AcceptanceEnum.ts +14 -0
  463. package/src/models/AccessEnum.ts +12 -0
  464. package/src/models/ActiveUsersData.ts +23 -0
  465. package/src/models/ActiveUsersList.ts +11 -0
  466. package/src/models/ActiveUsersPerCourse.ts +15 -0
  467. package/src/models/ActiveUsersPerCourseData.ts +19 -0
  468. package/src/models/ActivityAPI.ts +13 -0
  469. package/src/models/ActivityData.ts +43 -0
  470. package/src/models/AlignMentorBubbleEnum.ts +12 -0
  471. package/src/models/AnalyticsOverview.ts +12 -0
  472. package/src/models/Answer.ts +16 -0
  473. package/src/models/Assertion.ts +20 -0
  474. package/src/models/AssumedKnowledge.ts +9 -0
  475. package/src/models/AssumedKnowledgeLevel.ts +9 -0
  476. package/src/models/AudioToTextRequest.ts +8 -0
  477. package/src/models/AudioToTextResponse.ts +8 -0
  478. package/src/models/Average.ts +9 -0
  479. package/src/models/AverageData.ts +11 -0
  480. package/src/models/AverageOvertime.ts +27 -0
  481. package/src/models/AvgCourseGradeWithCutoff.ts +9 -0
  482. package/src/models/AvgCourseGradeWithCutoffData.ts +15 -0
  483. package/src/models/BlankEnum.ts +7 -0
  484. package/src/models/BulkCreateAssertion.ts +9 -0
  485. package/src/models/CallAuthenticationRequest.ts +18 -0
  486. package/src/models/CallAuthenticationResponse.ts +26 -0
  487. package/src/models/CampaignEnablement.ts +13 -0
  488. package/src/models/CampaignExclusion.ts +13 -0
  489. package/src/models/ChatHistory.ts +13 -0
  490. package/src/models/ChatHistoryFilterData.ts +14 -0
  491. package/src/models/ChatHistoryFilterUser.ts +10 -0
  492. package/src/models/ChatHistoryItem.ts +10 -0
  493. package/src/models/ChatHistorySessionId.ts +8 -0
  494. package/src/models/ChatSessionRequest.ts +15 -0
  495. package/src/models/ChatSessionResponse.ts +10 -0
  496. package/src/models/CheckDocumentTrainingStatus.ts +15 -0
  497. package/src/models/Company.ts +28 -0
  498. package/src/models/ComponentBlock.ts +14 -0
  499. package/src/models/ComponentBlockTypeEnum.ts +12 -0
  500. package/src/models/ContextResponse.ts +12 -0
  501. package/src/models/ConversationMessage.ts +16 -0
  502. package/src/models/ConversationRating.ts +11 -0
  503. package/src/models/ConversationSummary.ts +10 -0
  504. package/src/models/ConversationVolume.ts +9 -0
  505. package/src/models/Conversations.ts +33 -0
  506. package/src/models/Cost.ts +8 -0
  507. package/src/models/CostPerTenant.ts +11 -0
  508. package/src/models/Count.ts +9 -0
  509. package/src/models/CountData.ts +11 -0
  510. package/src/models/CourseCompletionPerCourse.ts +11 -0
  511. package/src/models/CourseCompletionPerCourseData.ts +27 -0
  512. package/src/models/CourseCompletionSummaryDataOvertime.ts +23 -0
  513. package/src/models/CourseCompletionSummaryOvertime.ts +11 -0
  514. package/src/models/CourseCreationTask.ts +36 -0
  515. package/src/models/CourseCreationTaskFile.ts +12 -0
  516. package/src/models/CourseCreationTaskStatusEnum.ts +20 -0
  517. package/src/models/CourseGradeDetailBlock.ts +23 -0
  518. package/src/models/CourseGradeDetailSubSection.ts +28 -0
  519. package/src/models/CourseGradeSummary.ts +9 -0
  520. package/src/models/CourseGradeSummaryData.ts +23 -0
  521. package/src/models/CourseGradingDetail.ts +9 -0
  522. package/src/models/CourseGradingDetailData.ts +17 -0
  523. package/src/models/CoursePoint.ts +12 -0
  524. package/src/models/CourseSkill.ts +13 -0
  525. package/src/models/Credential.ts +33 -0
  526. package/src/models/CredentialRequest.ts +19 -0
  527. package/src/models/CrontabSchedule.ts +27 -0
  528. package/src/models/CustomInstructionResponse.ts +18 -0
  529. package/src/models/DateRange.ts +9 -0
  530. package/src/models/DesiredSkill.ts +9 -0
  531. package/src/models/DetailedGradeSubsection.ts +27 -0
  532. package/src/models/DetailedGradeView.ts +9 -0
  533. package/src/models/DetailedGradeViewData.ts +17 -0
  534. package/src/models/Education.ts +35 -0
  535. package/src/models/EdxCourse.ts +16 -0
  536. package/src/models/ElevenlabsCustomVoice.ts +9 -0
  537. package/src/models/ElevenlabsCustomVoiceResponse.ts +13 -0
  538. package/src/models/EmailPromptDetail.ts +18 -0
  539. package/src/models/EmailPromptList.ts +16 -0
  540. package/src/models/EmailPromptSummary.ts +10 -0
  541. package/src/models/EngagementPerCourse.ts +11 -0
  542. package/src/models/EngagementPerCourseData.ts +31 -0
  543. package/src/models/Enrollments.ts +13 -0
  544. package/src/models/EnrollmentsData.ts +23 -0
  545. package/src/models/EnrollmentsPerUser.ts +11 -0
  546. package/src/models/EnrollmentsPerUserData.ts +23 -0
  547. package/src/models/ErrorResponse.ts +13 -0
  548. package/src/models/Experience.ts +34 -0
  549. package/src/models/FloatOverTime.ts +15 -0
  550. package/src/models/FreeUsageCount.ts +8 -0
  551. package/src/models/FullCourse.ts +18 -0
  552. package/src/models/GradingPerUser.ts +13 -0
  553. package/src/models/GradingPerUserData.ts +31 -0
  554. package/src/models/GreetingMethodEnum.ts +12 -0
  555. package/src/models/GroupList.ts +11 -0
  556. package/src/models/GroupListData.ts +21 -0
  557. package/src/models/GuidedPromptsResponse.ts +8 -0
  558. package/src/models/HeygenMarketingVideoDetail.ts +13 -0
  559. package/src/models/HeygenMarketingVideoList.ts +11 -0
  560. package/src/models/IBLAIPlatformMeta.ts +8 -0
  561. package/src/models/IBLAIPlatformMetaRequest.ts +11 -0
  562. package/src/models/IBLAIPlatformMetaUpdateRequest.ts +15 -0
  563. package/src/models/ImageUpload.ts +8 -0
  564. package/src/models/InputQuestion.ts +11 -0
  565. package/src/models/Institution.ts +25 -0
  566. package/src/models/InstitutionTypeEnum.ts +18 -0
  567. package/src/models/IntegrationCredential.ts +13 -0
  568. package/src/models/IntialQuestionAnswer.ts +8 -0
  569. package/src/models/Issuer.ts +14 -0
  570. package/src/models/IssuerAuthority.ts +10 -0
  571. package/src/models/JobRun.ts +16 -0
  572. package/src/models/KindEnum.ts +14 -0
  573. package/src/models/LLMCredentialRequest.ts +19 -0
  574. package/src/models/LLMCredentialResponse.ts +13 -0
  575. package/src/models/LLMModelForTenant.ts +11 -0
  576. package/src/models/LLMQuestion.ts +20 -0
  577. package/src/models/LLMResponse.ts +19 -0
  578. package/src/models/LLMTracesListResponse.ts +10 -0
  579. package/src/models/LanguagesView.ts +10 -0
  580. package/src/models/LearnerInformationAPI.ts +9 -0
  581. package/src/models/LearnerInformationAPIData.ts +88 -0
  582. package/src/models/LinkCourseRequest.ts +8 -0
  583. package/src/models/LinkCourseResponse.ts +10 -0
  584. package/src/models/LtiKey.ts +24 -0
  585. package/src/models/LtiLaunchGate.ts +13 -0
  586. package/src/models/LtiTool.ts +51 -0
  587. package/src/models/MemoryComponentData.ts +10 -0
  588. package/src/models/MemoryComponentMemory.ts +9 -0
  589. package/src/models/MemoryComponentMemoryDetail.ts +13 -0
  590. package/src/models/MemoryComponentResponse.ts +10 -0
  591. package/src/models/MemoryProgress.ts +13 -0
  592. package/src/models/MemoryStatusRequestView.ts +11 -0
  593. package/src/models/MemoryStatusView.ts +11 -0
  594. package/src/models/Mentor.ts +80 -0
  595. package/src/models/MentorAudience.ts +10 -0
  596. package/src/models/MentorCategory.ts +14 -0
  597. package/src/models/MentorCategoryCreate.ts +16 -0
  598. package/src/models/MentorCategoryGroup.ts +16 -0
  599. package/src/models/MentorCategoryGroupCreate.ts +16 -0
  600. package/src/models/MentorCreate.ts +79 -0
  601. package/src/models/MentorCustomVoice.ts +9 -0
  602. package/src/models/MentorCustomVoiceResponse.ts +9 -0
  603. package/src/models/MentorData.ts +12 -0
  604. package/src/models/MentorDetailAnalytics.ts +11 -0
  605. package/src/models/MentorEval.ts +16 -0
  606. package/src/models/MentorEvalQuestion.ts +10 -0
  607. package/src/models/MentorEvalQuestionRequest.ts +9 -0
  608. package/src/models/MentorEvalReport.ts +15 -0
  609. package/src/models/MentorEvalRequest.ts +13 -0
  610. package/src/models/MentorFork.ts +10 -0
  611. package/src/models/MentorFromTemplateRequest.ts +9 -0
  612. package/src/models/MentorFromTemplateWithSettingRequest.ts +47 -0
  613. package/src/models/MentorMemorySettingsRequest.ts +11 -0
  614. package/src/models/MentorMemorySettingsResponse.ts +11 -0
  615. package/src/models/MentorMetadata.ts +10 -0
  616. package/src/models/MentorScenario.ts +11 -0
  617. package/src/models/MentorScenarioPrompt.ts +10 -0
  618. package/src/models/MentorSession.ts +9 -0
  619. package/src/models/MentorSettings.ts +52 -0
  620. package/src/models/MentorSettingsPublic.ts +45 -0
  621. package/src/models/MentorSettingsRequest.ts +56 -0
  622. package/src/models/MentorVisibilityEnum.ts +14 -0
  623. package/src/models/MentorWizard.ts +9 -0
  624. package/src/models/MessageStatistics.ts +10 -0
  625. package/src/models/MessageView.ts +15 -0
  626. package/src/models/MessageViewRequest.ts +12 -0
  627. package/src/models/MessageViewUpdatResponse.ts +8 -0
  628. package/src/models/Metadata.ts +10 -0
  629. package/src/models/MetricChange.ts +9 -0
  630. package/src/models/ModelCost.ts +9 -0
  631. package/src/models/ModerationLog.ts +16 -0
  632. package/src/models/NetRevenueOverTime.ts +13 -0
  633. package/src/models/NewPerLearnerList.ts +11 -0
  634. package/src/models/NewPerLearnerListData.ts +22 -0
  635. package/src/models/NoChatMessagesFound.ts +8 -0
  636. package/src/models/Notification.ts +18 -0
  637. package/src/models/NotificationCount.ts +9 -0
  638. package/src/models/NotificationPreview.ts +36 -0
  639. package/src/models/NotificationSource.ts +13 -0
  640. package/src/models/NotificationSourceTypeEnum.ts +22 -0
  641. package/src/models/NotificationStatusEnum.ts +14 -0
  642. package/src/models/NotificationTemplateData.ts +31 -0
  643. package/src/models/NullEnum.ts +7 -0
  644. package/src/models/Order.ts +27 -0
  645. package/src/models/OverTime.ts +8 -0
  646. package/src/models/OverTimeWithTotal.ts +27 -0
  647. package/src/models/OvertimeMeta.ts +35 -0
  648. package/src/models/OvertimeWithChangeInfo.ts +29 -0
  649. package/src/models/PageContent.ts +11 -0
  650. package/src/models/PaginatedAIGeneratedImageList.ts +12 -0
  651. package/src/models/PaginatedConversationsList.ts +12 -0
  652. package/src/models/PaginatedCourseCreationTaskFileList.ts +12 -0
  653. package/src/models/PaginatedCourseCreationTaskList.ts +12 -0
  654. package/src/models/PaginatedEdxCourseList.ts +12 -0
  655. package/src/models/PaginatedEmailPromptListList.ts +12 -0
  656. package/src/models/PaginatedHeygenMarketingVideoListList.ts +12 -0
  657. package/src/models/PaginatedJobRunList.ts +12 -0
  658. package/src/models/PaginatedMentorList.ts +12 -0
  659. package/src/models/PaginatedModerationLogList.ts +12 -0
  660. package/src/models/PaginatedPeriodicAgentList.ts +12 -0
  661. package/src/models/PaginatedPeriodicAgentLogList.ts +12 -0
  662. package/src/models/PaginatedPlayWrightScriptList.ts +12 -0
  663. package/src/models/PaginatedSectionList.ts +12 -0
  664. package/src/models/PaginatedSubSectionList.ts +12 -0
  665. package/src/models/PaginatedTopicStatisticsResponse.ts +12 -0
  666. package/src/models/PaginatedUnitList.ts +12 -0
  667. package/src/models/PaginatedUserEdxMemoryList.ts +12 -0
  668. package/src/models/PaginatedVoiceList.ts +12 -0
  669. package/src/models/Pagination.ts +23 -0
  670. package/src/models/PatchedConversations.ts +33 -0
  671. package/src/models/PatchedCourseCreationTaskFile.ts +12 -0
  672. package/src/models/PatchedCredentialRequest.ts +19 -0
  673. package/src/models/PatchedLLMCredentialRequest.ts +19 -0
  674. package/src/models/PatchedMentorCategoryGroupCreate.ts +16 -0
  675. package/src/models/PatchedMentorCreate.ts +79 -0
  676. package/src/models/PatchedNotification.ts +18 -0
  677. package/src/models/PatchedPeriodicAgentCreate.ts +46 -0
  678. package/src/models/PatchedPlatformPublicMetadata.ts +13 -0
  679. package/src/models/PatchedPlayWrightScript.ts +17 -0
  680. package/src/models/PatchedPrompt.ts +27 -0
  681. package/src/models/PatchedSection.ts +14 -0
  682. package/src/models/PatchedSkillThreshold.ts +19 -0
  683. package/src/models/PatchedSubSection.ts +14 -0
  684. package/src/models/PatchedUnit.ts +16 -0
  685. package/src/models/PerLearnerCourseLastAccessData.ts +35 -0
  686. package/src/models/PerLearnerCourseVideosWatched.ts +13 -0
  687. package/src/models/PerLearnerCourseVideosWatchedData.ts +19 -0
  688. package/src/models/PerLearnerLastAccess.ts +9 -0
  689. package/src/models/PerLearnerLastAccessData.ts +16 -0
  690. package/src/models/PerLearnerTimeSpentInCourseTree.ts +13 -0
  691. package/src/models/PerformanceGradesPerCourse.ts +11 -0
  692. package/src/models/PerformanceGradesPerCourseData.ts +27 -0
  693. package/src/models/PeriodicAgent.ts +47 -0
  694. package/src/models/PeriodicAgentCreate.ts +46 -0
  695. package/src/models/PeriodicAgentLog.ts +16 -0
  696. package/src/models/PeriodicAgentLogStatusEnum.ts +14 -0
  697. package/src/models/PeriodicTask.ts +26 -0
  698. package/src/models/PerlearnerCourseProgress.ts +9 -0
  699. package/src/models/PerlearnerCourseProgressData.ts +11 -0
  700. package/src/models/PerlearnerEngagementVideosData.ts +35 -0
  701. package/src/models/PerlearnerEngagementVideosWatchedPerCourse.ts +9 -0
  702. package/src/models/PerlearnerGradeSummary.ts +9 -0
  703. package/src/models/PerlearnerGradeSummaryData.ts +23 -0
  704. package/src/models/PerlearnerGradeWithCutOff.ts +9 -0
  705. package/src/models/PerlearnerGradeWithCutOffData.ts +15 -0
  706. package/src/models/PerlearnerGradingPerCourseAPI.ts +9 -0
  707. package/src/models/PerlearnerGradingPerCourseAPIData.ts +39 -0
  708. package/src/models/PerlearnerUserList.ts +11 -0
  709. package/src/models/PerlearnerUserListData.ts +39 -0
  710. package/src/models/PieChartData.ts +10 -0
  711. package/src/models/PieChartSegment.ts +9 -0
  712. package/src/models/PinnedMessageCreate.ts +14 -0
  713. package/src/models/PinnedMessageGet.ts +12 -0
  714. package/src/models/PinnedMessageRequest.ts +11 -0
  715. package/src/models/PlatformPublicMetadata.ts +13 -0
  716. package/src/models/PlayWrightScript.ts +17 -0
  717. package/src/models/PointsPercentile.ts +13 -0
  718. package/src/models/PredictiveAnalyticsRequest.ts +9 -0
  719. package/src/models/PredictiveAnalyticsResponse.ts +9 -0
  720. package/src/models/PreviewResponse.ts +16 -0
  721. package/src/models/PreviousAgentStatusEnum.ts +16 -0
  722. package/src/models/Product.ts +27 -0
  723. package/src/models/ProductTable.ts +31 -0
  724. package/src/models/Program.ts +29 -0
  725. package/src/models/ProgramTypeEnum.ts +22 -0
  726. package/src/models/Prompt.ts +27 -0
  727. package/src/models/PromptCategory.ts +12 -0
  728. package/src/models/PromptVisibilityEnum.ts +14 -0
  729. package/src/models/ProviderEnum.ts +14 -0
  730. package/src/models/QuestionCardTag.ts +13 -0
  731. package/src/models/QuestionRequest.ts +20 -0
  732. package/src/models/QuestionResponse.ts +15 -0
  733. package/src/models/RatingEnum.ts +12 -0
  734. package/src/models/RatingRecord.ts +9 -0
  735. package/src/models/RecentlyAccessedMentor.ts +13 -0
  736. package/src/models/Recipient.ts +13 -0
  737. package/src/models/RecommendCourseBlock.ts +8 -0
  738. package/src/models/RecommendCourseResponse.ts +8 -0
  739. package/src/models/RecommendationSearchAPI.ts +8 -0
  740. package/src/models/RedirectTokenRequest.ts +8 -0
  741. package/src/models/RedirectTokenResponse.ts +10 -0
  742. package/src/models/RelatedText.ts +8 -0
  743. package/src/models/ReportCreate.ts +12 -0
  744. package/src/models/ReportData.ts +33 -0
  745. package/src/models/ReportDetail.ts +9 -0
  746. package/src/models/ReportList.ts +9 -0
  747. package/src/models/ReportRequest.ts +26 -0
  748. package/src/models/ReportStatus.ts +46 -0
  749. package/src/models/ReportedSkill.ts +9 -0
  750. package/src/models/RequestDataVariable.ts +19 -0
  751. package/src/models/ResourcePoint.ts +12 -0
  752. package/src/models/ResourceScrappedData.ts +18 -0
  753. package/src/models/ResourceScrappedDataStatusEnum.ts +16 -0
  754. package/src/models/ResponseDataVariable.ts +19 -0
  755. package/src/models/RetreiverTrainViewRequest.ts +15 -0
  756. package/src/models/RetreiverTrainViewResponse.ts +11 -0
  757. package/src/models/RetrieveTask.ts +8 -0
  758. package/src/models/RetrieverDocumentEmbedding.ts +22 -0
  759. package/src/models/RetrieverDocumentEmbeddingRequest.ts +35 -0
  760. package/src/models/RetrieverRequestSearch.ts +15 -0
  761. package/src/models/RetrieverRequestSearchDocument.ts +15 -0
  762. package/src/models/RetrieverResponseSearch.ts +12 -0
  763. package/src/models/ReuestDataVariableList.ts +9 -0
  764. package/src/models/RevenueByProduct.ts +11 -0
  765. package/src/models/RunMentorEval.ts +8 -0
  766. package/src/models/ScanWebhookRequest.ts +11 -0
  767. package/src/models/ScanWebhookResponse.ts +8 -0
  768. package/src/models/Section.ts +14 -0
  769. package/src/models/SectionWithChildren.ts +16 -0
  770. package/src/models/SeedMentorsView.ts +8 -0
  771. package/src/models/SendNotification.ts +11 -0
  772. package/src/models/SendResponse.ts +14 -0
  773. package/src/models/SentimentSummary.ts +9 -0
  774. package/src/models/SessionBrowserScreenshot.ts +13 -0
  775. package/src/models/SessionDetail.ts +11 -0
  776. package/src/models/SessionMemoryStorage.ts +11 -0
  777. package/src/models/ShellLogs.ts +8 -0
  778. package/src/models/Skill.ts +12 -0
  779. package/src/models/SkillDetail.ts +14 -0
  780. package/src/models/SkillInfo.ts +28 -0
  781. package/src/models/SkillThreshold.ts +19 -0
  782. package/src/models/SpacedRepetitionLearningPath.ts +8 -0
  783. package/src/models/SpacedRepetitionQuestionStats.ts +10 -0
  784. package/src/models/StarMentor.ts +12 -0
  785. package/src/models/StateEnum.ts +26 -0
  786. package/src/models/Status6eeEnum.ts +16 -0
  787. package/src/models/Step.ts +14 -0
  788. package/src/models/StepStatusEnum.ts +14 -0
  789. package/src/models/StudentChatMessage.ts +9 -0
  790. package/src/models/StylesView.ts +9 -0
  791. package/src/models/SubSection.ts +14 -0
  792. package/src/models/SubSectionWithChildren.ts +16 -0
  793. package/src/models/SubTimeChild.ts +23 -0
  794. package/src/models/Summary.ts +23 -0
  795. package/src/models/TagsView.ts +10 -0
  796. package/src/models/TargetSystemEnum.ts +12 -0
  797. package/src/models/TaskView.ts +8 -0
  798. package/src/models/TemplateMentor.ts +14 -0
  799. package/src/models/TenantMentorTraces.ts +11 -0
  800. package/src/models/ThemeEnum.ts +12 -0
  801. package/src/models/TimeChildData.ts +25 -0
  802. package/src/models/TimeDetail.ts +13 -0
  803. package/src/models/TimeDetailChild.ts +31 -0
  804. package/src/models/TimeDetailData.ts +29 -0
  805. package/src/models/TimeSpentByUsersInCourse.ts +11 -0
  806. package/src/models/TimeSpentByUsersInCourseData.ts +27 -0
  807. package/src/models/TimeSpentPerCourse.ts +11 -0
  808. package/src/models/TimeSpentPerCourseData.ts +31 -0
  809. package/src/models/TimeSpentPerUserResponse.ts +8 -0
  810. package/src/models/TimeSpentUpdateRequest.ts +16 -0
  811. package/src/models/TimeSpentUpdateResponse.ts +9 -0
  812. package/src/models/TonesView.ts +9 -0
  813. package/src/models/ToolResponse.ts +14 -0
  814. package/src/models/TopicModel.ts +8 -0
  815. package/src/models/TopicRecord.ts +9 -0
  816. package/src/models/TopicStatistics.ts +12 -0
  817. package/src/models/TopicStatisticsResponse.ts +11 -0
  818. package/src/models/TopicSummaryView.ts +9 -0
  819. package/src/models/TrainChatSessionDocumentView.ts +11 -0
  820. package/src/models/TrainChatSessionDocumentViewRequest.ts +11 -0
  821. package/src/models/TrainDocumentViewRequest.ts +47 -0
  822. package/src/models/TrainDocumentViewResponse.ts +19 -0
  823. package/src/models/TrainingStatusEnum.ts +16 -0
  824. package/src/models/TrendEntry.ts +9 -0
  825. package/src/models/TriggerRequest.ts +10 -0
  826. package/src/models/TriggerResponse.ts +11 -0
  827. package/src/models/TypeC42Enum.ts +12 -0
  828. package/src/models/Unit.ts +16 -0
  829. package/src/models/UnitWithChildren.ts +18 -0
  830. package/src/models/UploadedImage.ts +10 -0
  831. package/src/models/UseMainCreds.ts +8 -0
  832. package/src/models/UserAllChatMemoryView.ts +12 -0
  833. package/src/models/UserCatalogItemMemoryView.ts +19 -0
  834. package/src/models/UserChatByPeriod.ts +9 -0
  835. package/src/models/UserChatFeedback.ts +19 -0
  836. package/src/models/UserChatFeedbackCount.ts +9 -0
  837. package/src/models/UserChatMemoryStatusRequestView.ts +11 -0
  838. package/src/models/UserChatMemoryStatusView.ts +11 -0
  839. package/src/models/UserChatMemoryUpdateView.ts +15 -0
  840. package/src/models/UserCountRecord.ts +9 -0
  841. package/src/models/UserEdxMemory.ts +20 -0
  842. package/src/models/UserInfo.ts +18 -0
  843. package/src/models/UserMemoryContextRequest.ts +18 -0
  844. package/src/models/UserMemoryContextResponse.ts +17 -0
  845. package/src/models/UserMetric.ts +9 -0
  846. package/src/models/UserMetricsResponse.ts +12 -0
  847. package/src/models/UserSentimentCountView.ts +9 -0
  848. package/src/models/UserSkill.ts +27 -0
  849. package/src/models/UserSkillPointsPercentile.ts +13 -0
  850. package/src/models/UserTrendByPeriod.ts +10 -0
  851. package/src/models/ValidateSourceResponse.ts +15 -0
  852. package/src/models/Value.ts +9 -0
  853. package/src/models/ValueData.ts +11 -0
  854. package/src/models/VectorResult.ts +13 -0
  855. package/src/models/VideoBlock.ts +19 -0
  856. package/src/models/VideoEngagementPerCourse.ts +11 -0
  857. package/src/models/VideoEngagementPerCourseData.ts +35 -0
  858. package/src/models/VideosCount.ts +9 -0
  859. package/src/models/VideosCountData.ts +11 -0
  860. package/src/models/VideosInCourseSummary.ts +9 -0
  861. package/src/models/VideosInCourseSummaryData.ts +17 -0
  862. package/src/models/VideosSpecificCourse.ts +9 -0
  863. package/src/models/VideosSpecificCourseData.ts +31 -0
  864. package/src/models/VideosWatchedSubSection.ts +24 -0
  865. package/src/models/Voice.ts +14 -0
  866. package/src/models/WatchedVideosPerUser.ts +13 -0
  867. package/src/models/WatchedVideosPerUserData.ts +23 -0
  868. package/src/models/WebResource.ts +14 -0
  869. package/src/models/WebResourceCard.ts +12 -0
  870. package/src/models/WebResourcesQuery.ts +8 -0
  871. package/src/services/AiAccountService.ts +479 -0
  872. package/src/services/AiAnalyticsService.ts +1923 -0
  873. package/src/services/AiIndexService.ts +598 -0
  874. package/src/services/AiMarketingService.ts +87 -0
  875. package/src/services/AiMentorService.ts +7678 -0
  876. package/src/services/AiPromptService.ts +1676 -0
  877. package/src/services/AnalyticsService.ts +94 -0
  878. package/src/services/AudienceService.ts +602 -0
  879. package/src/services/CareerService.ts +568 -0
  880. package/src/services/CoreService.ts +487 -0
  881. package/src/services/CredentialsService.ts +1647 -0
  882. package/src/services/DepartmentsService.ts +85 -0
  883. package/src/services/EngagementService.ts +907 -0
  884. package/src/services/FinanceService.ts +136 -0
  885. package/src/services/NotificationBuilderService.ts +133 -0
  886. package/src/services/NotificationService.ts +294 -0
  887. package/src/services/OverviewService.ts +324 -0
  888. package/src/services/PerformanceService.ts +329 -0
  889. package/src/services/PerlearnerService.ts +1009 -0
  890. package/src/services/PlatformService.ts +181 -0
  891. package/src/services/RecommendationsService.ts +31 -0
  892. package/src/services/ReportsService.ts +218 -0
  893. package/src/services/SearchService.ts +804 -0
  894. package/src/services/SkillsService.ts +521 -0
  895. package/src/services/UserGroupsService.ts +91 -0
  896. package/tsconfig.json +15 -0
@@ -0,0 +1,1923 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { AnalyticsOverview } from '../models/AnalyticsOverview';
6
+ import type { ChatHistoryFilterData } from '../models/ChatHistoryFilterData';
7
+ import type { ConversationMessage } from '../models/ConversationMessage';
8
+ import type { Conversations } from '../models/Conversations';
9
+ import type { ConversationSummary } from '../models/ConversationSummary';
10
+ import type { ConversationVolume } from '../models/ConversationVolume';
11
+ import type { Cost } from '../models/Cost';
12
+ import type { CostPerTenant } from '../models/CostPerTenant';
13
+ import type { LLMTracesListResponse } from '../models/LLMTracesListResponse';
14
+ import type { MentorDetailAnalytics } from '../models/MentorDetailAnalytics';
15
+ import type { MessageStatistics } from '../models/MessageStatistics';
16
+ import type { ModelCost } from '../models/ModelCost';
17
+ import type { PaginatedConversationsList } from '../models/PaginatedConversationsList';
18
+ import type { PaginatedTopicStatisticsResponse } from '../models/PaginatedTopicStatisticsResponse';
19
+ import type { PatchedConversations } from '../models/PatchedConversations';
20
+ import type { PieChartData } from '../models/PieChartData';
21
+ import type { RatingRecord } from '../models/RatingRecord';
22
+ import type { SentimentSummary } from '../models/SentimentSummary';
23
+ import type { StudentChatMessage } from '../models/StudentChatMessage';
24
+ import type { TenantMentorTraces } from '../models/TenantMentorTraces';
25
+ import type { TopicRecord } from '../models/TopicRecord';
26
+ import type { TopicStatisticsResponse } from '../models/TopicStatisticsResponse';
27
+ import type { TopicSummaryView } from '../models/TopicSummaryView';
28
+ import type { TrendEntry } from '../models/TrendEntry';
29
+ import type { UserChatByPeriod } from '../models/UserChatByPeriod';
30
+ import type { UserChatFeedbackCount } from '../models/UserChatFeedbackCount';
31
+ import type { UserCountRecord } from '../models/UserCountRecord';
32
+ import type { UserMetricsResponse } from '../models/UserMetricsResponse';
33
+ import type { UserSentimentCountView } from '../models/UserSentimentCountView';
34
+ import type { UserTrendByPeriod } from '../models/UserTrendByPeriod';
35
+ import type { CancelablePromise } from '../core/CancelablePromise';
36
+ import { OpenAPI } from '../core/OpenAPI';
37
+ import { request as __request } from '../core/request';
38
+ export class AiAnalyticsService {
39
+ /**
40
+ * Retrieve paginated LLM usage costs aggregated by tenant.
41
+ * @param endDate
42
+ * @param startDate
43
+ * @returns CostPerTenant
44
+ * @throws ApiError
45
+ */
46
+ public static aiAnalyticsCostsPertenantList(
47
+ endDate: string,
48
+ startDate: string,
49
+ ): CancelablePromise<Array<CostPerTenant>> {
50
+ return __request(OpenAPI, {
51
+ method: 'GET',
52
+ url: '/api/ai-analytics/costs/pertenant/',
53
+ query: {
54
+ 'end_date': endDate,
55
+ 'start_date': startDate,
56
+ },
57
+ errors: {
58
+ 400: `Invalid parameters`,
59
+ },
60
+ });
61
+ }
62
+ /**
63
+ * Retrieve average message counts per session over time.
64
+ *
65
+ * This endpoint returns data on the average number of messages exchanged in each
66
+ * conversation session within a specified date range, with options for filtering
67
+ * by mentor and aggregating by different time periods (hourly, daily, weekly).
68
+ *
69
+ * Args:
70
+ * request: The HTTP request containing filter query parameters.
71
+ * org: Organization key identifier.
72
+ *
73
+ * Returns:
74
+ * Response: Time series of average message counts and session totals.
75
+ *
76
+ * Raises:
77
+ * NotFound: If the specified organization does not exist.
78
+ * BadRequest: If the provided parameters are invalid.
79
+ *
80
+ * Query Parameters:
81
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
82
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
83
+ * mentor_id (str): Filter by mentor unique ID.
84
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
85
+ * @param endDate End date for filtering (YYYY-MM-DD)
86
+ * @param org
87
+ * @param startDate Start date for filtering (YYYY-MM-DD)
88
+ * @param userId
89
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
90
+ * @param groupBy
91
+ * @param mentorId Filter by mentor unique ID
92
+ * @returns MessageStatistics
93
+ * @throws ApiError
94
+ */
95
+ public static aiAnalyticsOrgsUsersAverageMessagesPerSessionList(
96
+ endDate: string,
97
+ org: string,
98
+ startDate: string,
99
+ userId: string,
100
+ aggregation: 'daily' | 'hourly' | 'weekly' = 'daily',
101
+ groupBy: string = 'day',
102
+ mentorId?: string,
103
+ ): CancelablePromise<Array<MessageStatistics>> {
104
+ return __request(OpenAPI, {
105
+ method: 'GET',
106
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/average-messages-per-session/',
107
+ path: {
108
+ 'org': org,
109
+ 'user_id': userId,
110
+ },
111
+ query: {
112
+ 'aggregation': aggregation,
113
+ 'end_date': endDate,
114
+ 'group_by': groupBy,
115
+ 'mentor_id': mentorId,
116
+ 'start_date': startDate,
117
+ },
118
+ errors: {
119
+ 400: `Invalid parameters`,
120
+ 404: `Organization not found`,
121
+ },
122
+ });
123
+ }
124
+ /**
125
+ * API viewset for retrieving and filtering chat message history.
126
+ *
127
+ * This viewset provides endpoints for retrieving chat message history
128
+ * within an organization, with extensive filtering options by date range,
129
+ * user, topic, mentor, and sentiment.
130
+ *
131
+ * Permissions:
132
+ * - Restricted to platform administrators only
133
+ * @param org
134
+ * @param userId
135
+ * @param endDate
136
+ * @param mentor
137
+ * @param page A page number within the paginated result set.
138
+ * @param pageSize Number of results to return per page.
139
+ * @param sentiment
140
+ * @param startDate
141
+ * @param topics
142
+ * @param userId
143
+ * @returns PaginatedConversationsList
144
+ * @throws ApiError
145
+ */
146
+ public static aiAnalyticsOrgsUsersChatHistoryList(
147
+ org: string,
148
+ userId: string,
149
+ endDate?: string,
150
+ mentor?: string,
151
+ page?: number,
152
+ pageSize?: number,
153
+ sentiment?: string,
154
+ startDate?: string,
155
+ topics?: string,
156
+ userId?: string,
157
+ ): CancelablePromise<PaginatedConversationsList> {
158
+ return __request(OpenAPI, {
159
+ method: 'GET',
160
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/',
161
+ path: {
162
+ 'org': org,
163
+ 'user_id': userId,
164
+ },
165
+ query: {
166
+ 'end_date': endDate,
167
+ 'mentor': mentor,
168
+ 'page': page,
169
+ 'page_size': pageSize,
170
+ 'sentiment': sentiment,
171
+ 'start_date': startDate,
172
+ 'topics': topics,
173
+ 'user_id': userId,
174
+ },
175
+ });
176
+ }
177
+ /**
178
+ * API viewset for retrieving and filtering chat message history.
179
+ *
180
+ * This viewset provides endpoints for retrieving chat message history
181
+ * within an organization, with extensive filtering options by date range,
182
+ * user, topic, mentor, and sentiment.
183
+ *
184
+ * Permissions:
185
+ * - Restricted to platform administrators only
186
+ * @param org
187
+ * @param userId
188
+ * @param requestBody
189
+ * @param endDate
190
+ * @param mentor
191
+ * @param sentiment
192
+ * @param startDate
193
+ * @param topics
194
+ * @param userId
195
+ * @returns Conversations
196
+ * @throws ApiError
197
+ */
198
+ public static aiAnalyticsOrgsUsersChatHistoryCreate(
199
+ org: string,
200
+ userId: string,
201
+ requestBody: Conversations,
202
+ endDate?: string,
203
+ mentor?: string,
204
+ sentiment?: string,
205
+ startDate?: string,
206
+ topics?: string,
207
+ userId?: string,
208
+ ): CancelablePromise<Conversations> {
209
+ return __request(OpenAPI, {
210
+ method: 'POST',
211
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/',
212
+ path: {
213
+ 'org': org,
214
+ 'user_id': userId,
215
+ },
216
+ query: {
217
+ 'end_date': endDate,
218
+ 'mentor': mentor,
219
+ 'sentiment': sentiment,
220
+ 'start_date': startDate,
221
+ 'topics': topics,
222
+ 'user_id': userId,
223
+ },
224
+ body: requestBody,
225
+ mediaType: 'application/json',
226
+ });
227
+ }
228
+ /**
229
+ * Retrieve filter options for chat message history.
230
+ *
231
+ * This endpoint returns data on available filter options for the chat message
232
+ * history endpoint, including topics, date ranges (weekly or monthly),
233
+ * sentiments, and users who have chat history.
234
+ *
235
+ * Args:
236
+ * request: The HTTP request containing query parameters.
237
+ * org: Organization key identifier.
238
+ *
239
+ * Returns:
240
+ * Response: Available filter options for chat message history.
241
+ *
242
+ * Raises:
243
+ * NotFound: If the specified organization does not exist.
244
+ *
245
+ * Query Parameters:
246
+ * monthly_range (bool): Whether to return monthly or weekly date ranges.
247
+ * mentor_id (str): Filter users by those who have chatted with a specific mentor.
248
+ * @param org
249
+ * @param userId
250
+ * @param endDate
251
+ * @param mentorId
252
+ * @param monthlyRange
253
+ * @param startDate
254
+ * @returns ChatHistoryFilterData
255
+ * @throws ApiError
256
+ */
257
+ public static aiAnalyticsOrgsUsersChatHistoryFilterRetrieve(
258
+ org: string,
259
+ userId: string,
260
+ endDate?: string,
261
+ mentorId?: string,
262
+ monthlyRange: boolean = false,
263
+ startDate?: string,
264
+ ): CancelablePromise<ChatHistoryFilterData> {
265
+ return __request(OpenAPI, {
266
+ method: 'GET',
267
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history-filter/',
268
+ path: {
269
+ 'org': org,
270
+ 'user_id': userId,
271
+ },
272
+ query: {
273
+ 'end_date': endDate,
274
+ 'mentor_id': mentorId,
275
+ 'monthly_range': monthlyRange,
276
+ 'start_date': startDate,
277
+ },
278
+ errors: {
279
+ 404: `Organization not found`,
280
+ },
281
+ });
282
+ }
283
+ /**
284
+ * API viewset for retrieving and filtering chat message history.
285
+ *
286
+ * This viewset provides endpoints for retrieving chat message history
287
+ * within an organization, with extensive filtering options by date range,
288
+ * user, topic, mentor, and sentiment.
289
+ *
290
+ * Permissions:
291
+ * - Restricted to platform administrators only
292
+ * @param id A UUID string identifying this session.
293
+ * @param org
294
+ * @param userId
295
+ * @param endDate
296
+ * @param mentor
297
+ * @param sentiment
298
+ * @param startDate
299
+ * @param topics
300
+ * @param userId
301
+ * @returns Conversations
302
+ * @throws ApiError
303
+ */
304
+ public static aiAnalyticsOrgsUsersChatHistoryRetrieve(
305
+ id: string,
306
+ org: string,
307
+ userId: string,
308
+ endDate?: string,
309
+ mentor?: string,
310
+ sentiment?: string,
311
+ startDate?: string,
312
+ topics?: string,
313
+ userId?: string,
314
+ ): CancelablePromise<Conversations> {
315
+ return __request(OpenAPI, {
316
+ method: 'GET',
317
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/',
318
+ path: {
319
+ 'id': id,
320
+ 'org': org,
321
+ 'user_id': userId,
322
+ },
323
+ query: {
324
+ 'end_date': endDate,
325
+ 'mentor': mentor,
326
+ 'sentiment': sentiment,
327
+ 'start_date': startDate,
328
+ 'topics': topics,
329
+ 'user_id': userId,
330
+ },
331
+ });
332
+ }
333
+ /**
334
+ * API viewset for retrieving and filtering chat message history.
335
+ *
336
+ * This viewset provides endpoints for retrieving chat message history
337
+ * within an organization, with extensive filtering options by date range,
338
+ * user, topic, mentor, and sentiment.
339
+ *
340
+ * Permissions:
341
+ * - Restricted to platform administrators only
342
+ * @param id A UUID string identifying this session.
343
+ * @param org
344
+ * @param userId
345
+ * @param requestBody
346
+ * @param endDate
347
+ * @param mentor
348
+ * @param sentiment
349
+ * @param startDate
350
+ * @param topics
351
+ * @param userId
352
+ * @returns Conversations
353
+ * @throws ApiError
354
+ */
355
+ public static aiAnalyticsOrgsUsersChatHistoryUpdate(
356
+ id: string,
357
+ org: string,
358
+ userId: string,
359
+ requestBody: Conversations,
360
+ endDate?: string,
361
+ mentor?: string,
362
+ sentiment?: string,
363
+ startDate?: string,
364
+ topics?: string,
365
+ userId?: string,
366
+ ): CancelablePromise<Conversations> {
367
+ return __request(OpenAPI, {
368
+ method: 'PUT',
369
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/',
370
+ path: {
371
+ 'id': id,
372
+ 'org': org,
373
+ 'user_id': userId,
374
+ },
375
+ query: {
376
+ 'end_date': endDate,
377
+ 'mentor': mentor,
378
+ 'sentiment': sentiment,
379
+ 'start_date': startDate,
380
+ 'topics': topics,
381
+ 'user_id': userId,
382
+ },
383
+ body: requestBody,
384
+ mediaType: 'application/json',
385
+ });
386
+ }
387
+ /**
388
+ * API viewset for retrieving and filtering chat message history.
389
+ *
390
+ * This viewset provides endpoints for retrieving chat message history
391
+ * within an organization, with extensive filtering options by date range,
392
+ * user, topic, mentor, and sentiment.
393
+ *
394
+ * Permissions:
395
+ * - Restricted to platform administrators only
396
+ * @param id A UUID string identifying this session.
397
+ * @param org
398
+ * @param userId
399
+ * @param endDate
400
+ * @param mentor
401
+ * @param sentiment
402
+ * @param startDate
403
+ * @param topics
404
+ * @param userId
405
+ * @param requestBody
406
+ * @returns Conversations
407
+ * @throws ApiError
408
+ */
409
+ public static aiAnalyticsOrgsUsersChatHistoryPartialUpdate(
410
+ id: string,
411
+ org: string,
412
+ userId: string,
413
+ endDate?: string,
414
+ mentor?: string,
415
+ sentiment?: string,
416
+ startDate?: string,
417
+ topics?: string,
418
+ userId?: string,
419
+ requestBody?: PatchedConversations,
420
+ ): CancelablePromise<Conversations> {
421
+ return __request(OpenAPI, {
422
+ method: 'PATCH',
423
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/',
424
+ path: {
425
+ 'id': id,
426
+ 'org': org,
427
+ 'user_id': userId,
428
+ },
429
+ query: {
430
+ 'end_date': endDate,
431
+ 'mentor': mentor,
432
+ 'sentiment': sentiment,
433
+ 'start_date': startDate,
434
+ 'topics': topics,
435
+ 'user_id': userId,
436
+ },
437
+ body: requestBody,
438
+ mediaType: 'application/json',
439
+ });
440
+ }
441
+ /**
442
+ * API viewset for retrieving and filtering chat message history.
443
+ *
444
+ * This viewset provides endpoints for retrieving chat message history
445
+ * within an organization, with extensive filtering options by date range,
446
+ * user, topic, mentor, and sentiment.
447
+ *
448
+ * Permissions:
449
+ * - Restricted to platform administrators only
450
+ * @param id A UUID string identifying this session.
451
+ * @param org
452
+ * @param userId
453
+ * @param endDate
454
+ * @param mentor
455
+ * @param sentiment
456
+ * @param startDate
457
+ * @param topics
458
+ * @param userId
459
+ * @returns void
460
+ * @throws ApiError
461
+ */
462
+ public static aiAnalyticsOrgsUsersChatHistoryDestroy(
463
+ id: string,
464
+ org: string,
465
+ userId: string,
466
+ endDate?: string,
467
+ mentor?: string,
468
+ sentiment?: string,
469
+ startDate?: string,
470
+ topics?: string,
471
+ userId?: string,
472
+ ): CancelablePromise<void> {
473
+ return __request(OpenAPI, {
474
+ method: 'DELETE',
475
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/',
476
+ path: {
477
+ 'id': id,
478
+ 'org': org,
479
+ 'user_id': userId,
480
+ },
481
+ query: {
482
+ 'end_date': endDate,
483
+ 'mentor': mentor,
484
+ 'sentiment': sentiment,
485
+ 'start_date': startDate,
486
+ 'topics': topics,
487
+ 'user_id': userId,
488
+ },
489
+ });
490
+ }
491
+ /**
492
+ * Retrieve conversation volume data over time.
493
+ *
494
+ * This endpoint returns data on the number of conversations that occurred
495
+ * within a specified date range, with options for different time aggregations
496
+ * (hourly, daily, weekly). Results can be filtered by mentor.
497
+ *
498
+ * Args:
499
+ * request: The HTTP request containing filter query parameters.
500
+ * org: Organization key identifier.
501
+ * user_id: User identifier (not used in the implementation).
502
+ *
503
+ * Returns:
504
+ * Response: Time series data of conversation counts.
505
+ *
506
+ * Raises:
507
+ * NotFound: If the specified organization does not exist.
508
+ * BadRequest: If the provided parameters are invalid.
509
+ *
510
+ * Query Parameters:
511
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
512
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
513
+ * mentor_id (str): Filter by mentor unique ID.
514
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
515
+ * @param endDate End date for filtering (YYYY-MM-DD)
516
+ * @param org
517
+ * @param startDate Start date for filtering (YYYY-MM-DD)
518
+ * @param userId
519
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
520
+ * @param mentorId Filter by mentor unique ID
521
+ * @returns ConversationVolume
522
+ * @throws ApiError
523
+ */
524
+ public static aiAnalyticsOrgsUsersConversationList(
525
+ endDate: string,
526
+ org: string,
527
+ startDate: string,
528
+ userId: string,
529
+ aggregation: 'daily' | 'hourly' | 'weekly' = 'daily',
530
+ mentorId?: string,
531
+ ): CancelablePromise<Array<ConversationVolume>> {
532
+ return __request(OpenAPI, {
533
+ method: 'GET',
534
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/conversation/',
535
+ path: {
536
+ 'org': org,
537
+ 'user_id': userId,
538
+ },
539
+ query: {
540
+ 'aggregation': aggregation,
541
+ 'end_date': endDate,
542
+ 'mentor_id': mentorId,
543
+ 'start_date': startDate,
544
+ },
545
+ errors: {
546
+ 400: `Invalid parameters`,
547
+ 404: `Organization not found`,
548
+ },
549
+ });
550
+ }
551
+ /**
552
+ * Retrieve a summary of conversation metrics.
553
+ *
554
+ * This endpoint returns aggregated metrics about conversations within an organization,
555
+ * including:
556
+ * - Total number of conversations
557
+ * - Total number of human messages
558
+ * - Total number of AI messages
559
+ *
560
+ * Results can be filtered by mentor.
561
+ *
562
+ * Args:
563
+ * request: The HTTP request containing filter query parameters.
564
+ * org: Organization key identifier.
565
+ *
566
+ * Returns:
567
+ * Response: Summary of conversation metrics.
568
+ *
569
+ * Raises:
570
+ * NotFound: If the specified organization does not exist.
571
+ *
572
+ * Query Parameters:
573
+ * mentor_id (str): Filter by mentor unique ID.
574
+ * @param org
575
+ * @param userId
576
+ * @param groupBy
577
+ * @param mentorId Filter by mentor unique ID
578
+ * @returns ConversationSummary
579
+ * @throws ApiError
580
+ */
581
+ public static aiAnalyticsOrgsUsersConversationSummaryRetrieve(
582
+ org: string,
583
+ userId: string,
584
+ groupBy: string = 'day',
585
+ mentorId?: string,
586
+ ): CancelablePromise<ConversationSummary> {
587
+ return __request(OpenAPI, {
588
+ method: 'GET',
589
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/conversation-summary/',
590
+ path: {
591
+ 'org': org,
592
+ 'user_id': userId,
593
+ },
594
+ query: {
595
+ 'group_by': groupBy,
596
+ 'mentor_id': mentorId,
597
+ },
598
+ errors: {
599
+ 404: `Organization not found`,
600
+ },
601
+ });
602
+ }
603
+ /**
604
+ * Retrieve the model costs for a tenant
605
+ *
606
+ * Filter parameters for period are start_date and enddate
607
+ *
608
+ * Accessible to tenant Admins only.
609
+ * @param endDate
610
+ * @param org
611
+ * @param startDate
612
+ * @param userId
613
+ * @returns ModelCost
614
+ * @throws ApiError
615
+ */
616
+ public static aiAnalyticsOrgsUsersCostsModelRetrieve(
617
+ endDate: string,
618
+ org: string,
619
+ startDate: string,
620
+ userId: string,
621
+ ): CancelablePromise<ModelCost> {
622
+ return __request(OpenAPI, {
623
+ method: 'GET',
624
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/costs/model/',
625
+ path: {
626
+ 'org': org,
627
+ 'user_id': userId,
628
+ },
629
+ query: {
630
+ 'end_date': endDate,
631
+ 'start_date': startDate,
632
+ },
633
+ });
634
+ }
635
+ /**
636
+ * Retrieve LLM usage costs aggregated by mentor.
637
+ *
638
+ * This endpoint returns data on the total cost of LLM usage for each mentor
639
+ * within a specified date range, with pagination support. The costs are
640
+ * calculated by summing the costs of all observations associated with
641
+ * traces from the mentor's sessions.
642
+ *
643
+ * Args:
644
+ * request: The HTTP request containing filter query parameters.
645
+ * org: Organization key identifier.
646
+ *
647
+ * Returns:
648
+ * Response: Paginated list of mentors with their total LLM usage costs.
649
+ *
650
+ * Raises:
651
+ * NotFound: If the specified organization does not exist.
652
+ * BadRequest: If the provided parameters are invalid.
653
+ *
654
+ * Query Parameters:
655
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
656
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
657
+ * limit (int): Number of results per page - default: 5.
658
+ * offset (int): Offset for pagination - default: 0.
659
+ * @param endDate
660
+ * @param org
661
+ * @param startDate
662
+ * @param userId
663
+ * @returns TenantMentorTraces
664
+ * @throws ApiError
665
+ */
666
+ public static aiAnalyticsOrgsUsersCostsPermentorRetrieve(
667
+ endDate: string,
668
+ org: string,
669
+ startDate: string,
670
+ userId: string,
671
+ ): CancelablePromise<TenantMentorTraces> {
672
+ return __request(OpenAPI, {
673
+ method: 'GET',
674
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/costs/permentor/',
675
+ path: {
676
+ 'org': org,
677
+ 'user_id': userId,
678
+ },
679
+ query: {
680
+ 'end_date': endDate,
681
+ 'start_date': startDate,
682
+ },
683
+ errors: {
684
+ 400: `Invalid parameters`,
685
+ 404: `Organization not found`,
686
+ },
687
+ });
688
+ }
689
+ /**
690
+ * Retrieve LLM usage costs aggregated by user.
691
+ *
692
+ * This endpoint returns data on the total cost of LLM usage for each user
693
+ * within a specified date range, with pagination support. The costs are
694
+ * calculated by summing the costs of all observations associated with
695
+ * traces from the user's sessions.
696
+ *
697
+ * Args:
698
+ * request: The HTTP request containing filter query parameters.
699
+ * org: Organization key identifier.
700
+ *
701
+ * Returns:
702
+ * Response: Paginated list of users with their total LLM usage costs.
703
+ *
704
+ * Raises:
705
+ * NotFound: If the specified organization does not exist.
706
+ * BadRequest: If the provided parameters are invalid.
707
+ *
708
+ * Query Parameters:
709
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
710
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
711
+ * limit (int): Number of results per page - default: 10.
712
+ * offset (int): Offset for pagination - default: 0.
713
+ * @param endDate
714
+ * @param org
715
+ * @param startDate
716
+ * @param userId
717
+ * @returns LLMTracesListResponse
718
+ * @throws ApiError
719
+ */
720
+ public static aiAnalyticsOrgsUsersCostsPeruserRetrieve(
721
+ endDate: string,
722
+ org: string,
723
+ startDate: string,
724
+ userId: string,
725
+ ): CancelablePromise<LLMTracesListResponse> {
726
+ return __request(OpenAPI, {
727
+ method: 'GET',
728
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/costs/peruser/',
729
+ path: {
730
+ 'org': org,
731
+ 'user_id': userId,
732
+ },
733
+ query: {
734
+ 'end_date': endDate,
735
+ 'start_date': startDate,
736
+ },
737
+ errors: {
738
+ 400: `Invalid parameters`,
739
+ 404: `Organization not found`,
740
+ },
741
+ });
742
+ }
743
+ /**
744
+ * Retrieve summary statistics about mentors.
745
+ *
746
+ * This endpoint returns aggregated statistics about mentors within an organization,
747
+ * including total mentors, active mentors (mentors with at least one session),
748
+ * questions answered, and ratings.
749
+ *
750
+ * Args:
751
+ * request: The HTTP request.
752
+ * org: Organization key identifier.
753
+ *
754
+ * Returns:
755
+ * Response: Summary statistics about mentors.
756
+ *
757
+ * Raises:
758
+ * NotFound: If the specified organization does not exist.
759
+ * @param org
760
+ * @param userId
761
+ * @returns MentorDetailAnalytics
762
+ * @throws ApiError
763
+ */
764
+ public static aiAnalyticsOrgsUsersMentorDetailRetrieve(
765
+ org: string,
766
+ userId: string,
767
+ ): CancelablePromise<MentorDetailAnalytics> {
768
+ return __request(OpenAPI, {
769
+ method: 'GET',
770
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/mentor-detail/',
771
+ path: {
772
+ 'org': org,
773
+ 'user_id': userId,
774
+ },
775
+ errors: {
776
+ 404: `Organization not found`,
777
+ },
778
+ });
779
+ }
780
+ /**
781
+ * Retrieve summary statistics about mentors.
782
+ *
783
+ * This endpoint returns aggregated statistics about mentors within an organization,
784
+ * including total mentors, active mentors (mentors with at least one session),
785
+ * questions answered, and ratings.
786
+ *
787
+ * Args:
788
+ * request: The HTTP request.
789
+ * org: Organization key identifier.
790
+ *
791
+ * Returns:
792
+ * Response: Summary statistics about mentors.
793
+ *
794
+ * Raises:
795
+ * NotFound: If the specified organization does not exist.
796
+ * @param org
797
+ * @param userId
798
+ * @returns MentorDetailAnalytics
799
+ * @throws ApiError
800
+ */
801
+ public static aiAnalyticsOrgsUsersMentorSummaryRetrieve(
802
+ org: string,
803
+ userId: string,
804
+ ): CancelablePromise<MentorDetailAnalytics> {
805
+ return __request(OpenAPI, {
806
+ method: 'GET',
807
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/mentor-summary/',
808
+ path: {
809
+ 'org': org,
810
+ 'user_id': userId,
811
+ },
812
+ errors: {
813
+ 404: `Organization not found`,
814
+ },
815
+ });
816
+ }
817
+ /**
818
+ * Retrieve LLM usage costs for a specific mentor.
819
+ *
820
+ * This endpoint returns data on the total cost of LLM usage for a specific mentor
821
+ * within a specified date range. The cost is calculated by summing the costs
822
+ * of all observations associated with traces from the tenant's sessions.
823
+ *
824
+ * Args:
825
+ * request: The HTTP request containing filter query parameters.
826
+ * org: Organization key identifier.
827
+ * mentor_unique_id: User key identifier.
828
+ *
829
+ * Returns:
830
+ * Response: Total LLM usage cost for the specified tenant.
831
+ *
832
+ * Raises:
833
+ * NotFound: If the specified organization does not exist.
834
+ * BadRequest: If the provided parameters are invalid.
835
+ *
836
+ * Query Parameters:
837
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
838
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
839
+ * @param endDate
840
+ * @param mentorUniqueId
841
+ * @param org
842
+ * @param startDate
843
+ * @param userId
844
+ * @returns Cost
845
+ * @throws ApiError
846
+ */
847
+ public static aiAnalyticsOrgsUsersMentorsCostRetrieve(
848
+ endDate: string,
849
+ mentorUniqueId: string,
850
+ org: string,
851
+ startDate: string,
852
+ userId: string,
853
+ ): CancelablePromise<Cost> {
854
+ return __request(OpenAPI, {
855
+ method: 'GET',
856
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/mentors/{mentor_unique_id}/cost/',
857
+ path: {
858
+ 'mentor_unique_id': mentorUniqueId,
859
+ 'org': org,
860
+ 'user_id': userId,
861
+ },
862
+ query: {
863
+ 'end_date': endDate,
864
+ 'start_date': startDate,
865
+ },
866
+ errors: {
867
+ 400: `Invalid parameters`,
868
+ 404: `Organization not found`,
869
+ },
870
+ });
871
+ }
872
+ /**
873
+ * Retrieve the most discussed topics over time.
874
+ *
875
+ * This endpoint returns data on the frequency of topics discussed in conversations
876
+ * within a specified date range, with options for filtering by mentor and
877
+ * aggregating by different time periods (hourly, daily, weekly).
878
+ *
879
+ * Args:
880
+ * request: The HTTP request containing filter query parameters.
881
+ * org: Organization key identifier.
882
+ *
883
+ * Returns:
884
+ * Response: List of topics with their conversation counts, ordered by frequency.
885
+ *
886
+ * Raises:
887
+ * NotFound: If the specified organization does not exist.
888
+ * BadRequest: If the provided parameters are invalid.
889
+ *
890
+ * Query Parameters:
891
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
892
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
893
+ * mentor_id (str): Filter by mentor unique ID.
894
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
895
+ * @param endDate End date for filtering (YYYY-MM-DD)
896
+ * @param org
897
+ * @param startDate Start date for filtering (YYYY-MM-DD)
898
+ * @param userId
899
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
900
+ * @param groupBy
901
+ * @param mentorId Filter by mentor unique ID
902
+ * @returns TopicRecord
903
+ * @throws ApiError
904
+ */
905
+ public static aiAnalyticsOrgsUsersMostDiscussedTopicsList(
906
+ endDate: string,
907
+ org: string,
908
+ startDate: string,
909
+ userId: string,
910
+ aggregation: 'daily' | 'hourly' | 'weekly' = 'daily',
911
+ groupBy: string = 'day',
912
+ mentorId?: string,
913
+ ): CancelablePromise<Array<TopicRecord>> {
914
+ return __request(OpenAPI, {
915
+ method: 'GET',
916
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/most-discussed-topics/',
917
+ path: {
918
+ 'org': org,
919
+ 'user_id': userId,
920
+ },
921
+ query: {
922
+ 'aggregation': aggregation,
923
+ 'end_date': endDate,
924
+ 'group_by': groupBy,
925
+ 'mentor_id': mentorId,
926
+ 'start_date': startDate,
927
+ },
928
+ errors: {
929
+ 400: `Invalid parameters`,
930
+ 404: `Organization not found`,
931
+ },
932
+ });
933
+ }
934
+ /**
935
+ * Retrieve an overview of key analytics metrics.
936
+ *
937
+ * This endpoint returns a comprehensive overview of key analytics metrics
938
+ * for an organization, including:
939
+ * - Conversation volume: Total sessions and month-over-month change
940
+ * - Users: Total unique users and month-over-month change
941
+ * - Topics: Total unique topics and month-over-month change
942
+ * - User ratings: Total ratings and month-over-month change
943
+ *
944
+ * Results can be filtered by mentor.
945
+ *
946
+ * Args:
947
+ * request: The HTTP request containing filter query parameters.
948
+ * org: Organization key identifier.
949
+ * user_id: User identifier (not used in the implementation).
950
+ *
951
+ * Returns:
952
+ * Response: Overview of key analytics metrics with month-over-month changes.
953
+ *
954
+ * Raises:
955
+ * NotFound: If the specified organization does not exist.
956
+ *
957
+ * Query Parameters:
958
+ * mentor_id (str): Filter analytics by mentor unique ID.
959
+ * @param org
960
+ * @param userId
961
+ * @param groupBy
962
+ * @param mentorId Filter analytics by mentor unique ID
963
+ * @returns AnalyticsOverview
964
+ * @throws ApiError
965
+ */
966
+ public static aiAnalyticsOrgsUsersOverviewSummaryRetrieve(
967
+ org: string,
968
+ userId: string,
969
+ groupBy: string = 'day',
970
+ mentorId?: string,
971
+ ): CancelablePromise<AnalyticsOverview> {
972
+ return __request(OpenAPI, {
973
+ method: 'GET',
974
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/overview-summary/',
975
+ path: {
976
+ 'org': org,
977
+ 'user_id': userId,
978
+ },
979
+ query: {
980
+ 'group_by': groupBy,
981
+ 'mentor_id': mentorId,
982
+ },
983
+ errors: {
984
+ 404: `Organization not found`,
985
+ },
986
+ });
987
+ }
988
+ /**
989
+ * Retrieve user rating metrics over time.
990
+ *
991
+ * This endpoint returns data on the number of user ratings submitted
992
+ * within a specified date range, aggregated by day or hour.
993
+ *
994
+ * Args:
995
+ * request: The HTTP request containing filter query parameters.
996
+ * org: Organization key identifier.
997
+ *
998
+ * Returns:
999
+ * Response: Time series of rating counts aggregated by day or hour.
1000
+ *
1001
+ * Raises:
1002
+ * NotFound: If the specified organization does not exist.
1003
+ * BadRequest: If the provided parameters are invalid.
1004
+ *
1005
+ * Query Parameters:
1006
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1007
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1008
+ * group_by (str): Aggregation level (day or hour) - default: day.
1009
+ * @param endDate End date for filtering (YYYY-MM-DD)
1010
+ * @param org
1011
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1012
+ * @param userId
1013
+ * @param groupBy Aggregation level (day or hour)
1014
+ * @returns RatingRecord
1015
+ * @throws ApiError
1016
+ */
1017
+ public static aiAnalyticsOrgsUsersRatingSummaryList(
1018
+ endDate: string,
1019
+ org: string,
1020
+ startDate: string,
1021
+ userId: string,
1022
+ groupBy: 'day' | 'hour' = 'day',
1023
+ ): CancelablePromise<Array<RatingRecord>> {
1024
+ return __request(OpenAPI, {
1025
+ method: 'GET',
1026
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/rating-summary/',
1027
+ path: {
1028
+ 'org': org,
1029
+ 'user_id': userId,
1030
+ },
1031
+ query: {
1032
+ 'end_date': endDate,
1033
+ 'group_by': groupBy,
1034
+ 'start_date': startDate,
1035
+ },
1036
+ errors: {
1037
+ 400: `Invalid parameters`,
1038
+ 404: `Organization not found`,
1039
+ },
1040
+ });
1041
+ }
1042
+ /**
1043
+ * Retrieve trends of registered users over time.
1044
+ *
1045
+ * This endpoint returns data on the number of new user registrations
1046
+ * within a specified date range, with options for different time aggregations
1047
+ * (hourly, daily, weekly, monthly). The data is backfilled to ensure
1048
+ * continuous time series even for periods with zero registrations.
1049
+ *
1050
+ * Args:
1051
+ * request: The HTTP request containing filter query parameters.
1052
+ * org: Organization key identifier.
1053
+ *
1054
+ * Returns:
1055
+ * Response: Time series of user registration counts.
1056
+ *
1057
+ * Raises:
1058
+ * NotFound: If the specified organization does not exist.
1059
+ * BadRequest: If the provided parameters are invalid.
1060
+ *
1061
+ * Query Parameters:
1062
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1063
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1064
+ * aggregation (str): Time aggregation level (hourly, daily, weekly, monthly) - default: daily.
1065
+ * @param endDate End date for filtering (YYYY-MM-DD)
1066
+ * @param org
1067
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1068
+ * @param userId
1069
+ * @param aggregation Time aggregation level (hourly, daily, weekly, monthly)
1070
+ * @param groupBy
1071
+ * @returns TrendEntry
1072
+ * @throws ApiError
1073
+ */
1074
+ public static aiAnalyticsOrgsUsersRegisteredUsersTrendList(
1075
+ endDate: string,
1076
+ org: string,
1077
+ startDate: string,
1078
+ userId: string,
1079
+ aggregation: 'daily' | 'hourly' | 'monthly' | 'weekly' = 'daily',
1080
+ groupBy: string = 'day',
1081
+ ): CancelablePromise<Array<TrendEntry>> {
1082
+ return __request(OpenAPI, {
1083
+ method: 'GET',
1084
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/registered-users-trend/',
1085
+ path: {
1086
+ 'org': org,
1087
+ 'user_id': userId,
1088
+ },
1089
+ query: {
1090
+ 'aggregation': aggregation,
1091
+ 'end_date': endDate,
1092
+ 'group_by': groupBy,
1093
+ 'start_date': startDate,
1094
+ },
1095
+ errors: {
1096
+ 400: `Invalid parameters`,
1097
+ 404: `Organization not found`,
1098
+ },
1099
+ });
1100
+ }
1101
+ /**
1102
+ * Retrieve user sentiment counts over time.
1103
+ *
1104
+ * This endpoint returns data on the number of user sentiment entries
1105
+ * within a specified time period, aggregated by date.
1106
+ *
1107
+ * Args:
1108
+ * request: The HTTP request containing filter query parameters.
1109
+ * org: Organization key identifier.
1110
+ * user_id: User identifier.
1111
+ *
1112
+ * Returns:
1113
+ * Response: Time series data of sentiment counts.
1114
+ *
1115
+ * Raises:
1116
+ * NotFound: If the specified organization does not exist.
1117
+ * ValidationError: If the provided query parameters are invalid.
1118
+ *
1119
+ * Query Parameters:
1120
+ * period (str): Time period filter (today, yesterday, 7d, 30d, 90d) - default: 7d.
1121
+ * @param org
1122
+ * @param userId
1123
+ * @param period
1124
+ * @returns UserSentimentCountView
1125
+ * @throws ApiError
1126
+ */
1127
+ public static aiAnalyticsOrgsUsersSentimentCountList(
1128
+ org: string,
1129
+ userId: string,
1130
+ period: string = '7d',
1131
+ ): CancelablePromise<Array<UserSentimentCountView>> {
1132
+ return __request(OpenAPI, {
1133
+ method: 'GET',
1134
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/sentiment-count/',
1135
+ path: {
1136
+ 'org': org,
1137
+ 'user_id': userId,
1138
+ },
1139
+ query: {
1140
+ 'period': period,
1141
+ },
1142
+ errors: {
1143
+ 404: `Organization not found`,
1144
+ },
1145
+ });
1146
+ }
1147
+ /**
1148
+ * Retrieve LLM usage costs for a specific tenant.
1149
+ *
1150
+ * This endpoint returns data on the total cost of LLM usage for a specific tenant
1151
+ * within a specified date range. The cost is calculated by summing the costs
1152
+ * of all observations associated with traces from the tenant's sessions.
1153
+ *
1154
+ * Args:
1155
+ * request: The HTTP request containing filter query parameters.
1156
+ * org: Organization key identifier.
1157
+ *
1158
+ * Returns:
1159
+ * Response: Total LLM usage cost for the specified tenant.
1160
+ *
1161
+ * Raises:
1162
+ * NotFound: If the specified organization does not exist.
1163
+ * BadRequest: If the provided parameters are invalid.
1164
+ *
1165
+ * Query Parameters:
1166
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1167
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1168
+ * @param endDate
1169
+ * @param org
1170
+ * @param startDate
1171
+ * @param userId
1172
+ * @returns Cost
1173
+ * @throws ApiError
1174
+ */
1175
+ public static aiAnalyticsOrgsUsersTenantCostRetrieve(
1176
+ endDate: string,
1177
+ org: string,
1178
+ startDate: string,
1179
+ userId: string,
1180
+ ): CancelablePromise<Cost> {
1181
+ return __request(OpenAPI, {
1182
+ method: 'GET',
1183
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/tenant-cost/',
1184
+ path: {
1185
+ 'org': org,
1186
+ 'user_id': userId,
1187
+ },
1188
+ query: {
1189
+ 'end_date': endDate,
1190
+ 'start_date': startDate,
1191
+ },
1192
+ errors: {
1193
+ 400: `Invalid parameters`,
1194
+ 404: `Organization not found`,
1195
+ },
1196
+ });
1197
+ }
1198
+ /**
1199
+ * Retrieve the most engaged students based on chat message count.
1200
+ *
1201
+ * This endpoint returns data on the top 20 students with the highest number of
1202
+ * chat messages, with optional filtering by mentor and date range.
1203
+ *
1204
+ * Args:
1205
+ * request: The HTTP request containing filter query parameters.
1206
+ * org: Organization key identifier.
1207
+ * user_id: User identifier (not used in the implementation).
1208
+ *
1209
+ * Returns:
1210
+ * Response: List of top students with their chat message counts.
1211
+ *
1212
+ * Raises:
1213
+ * NotFound: If the specified organization does not exist.
1214
+ * BadRequest: If the provided parameters are invalid.
1215
+ *
1216
+ * Query Parameters:
1217
+ * mentor_id (str): Filter by mentor unique ID.
1218
+ * start_date (str): Start date for filtering (YYYY-MM-DD).
1219
+ * end_date (str): End date for filtering (YYYY-MM-DD).
1220
+ * @param org
1221
+ * @param userId
1222
+ * @param groupBy
1223
+ * @returns StudentChatMessage
1224
+ * @throws ApiError
1225
+ */
1226
+ public static aiAnalyticsOrgsUsersTopStudentsByChatMessagesList(
1227
+ org: string,
1228
+ userId: string,
1229
+ groupBy: string = 'day',
1230
+ ): CancelablePromise<Array<StudentChatMessage>> {
1231
+ return __request(OpenAPI, {
1232
+ method: 'GET',
1233
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/top-students-by-chat-messages/',
1234
+ path: {
1235
+ 'org': org,
1236
+ 'user_id': userId,
1237
+ },
1238
+ query: {
1239
+ 'group_by': groupBy,
1240
+ },
1241
+ errors: {
1242
+ 400: `Invalid parameters`,
1243
+ 404: `Organization not found`,
1244
+ },
1245
+ });
1246
+ }
1247
+ /**
1248
+ * Retrieve aggregated topic statistics.
1249
+ *
1250
+ * This endpoint returns statistical information about topics within an organization,
1251
+ * including total topics, new topics, and percentage changes compared to the
1252
+ * previous month. Results can be filtered by mentor.
1253
+ *
1254
+ * Args:
1255
+ * request: The HTTP request containing filter query parameters.
1256
+ * org: Organization key identifier.
1257
+ *
1258
+ * Returns:
1259
+ * Response: Statistical information about topics.
1260
+ *
1261
+ * Raises:
1262
+ * NotFound: If the specified organization or mentor does not exist.
1263
+ *
1264
+ * Query Parameters:
1265
+ * mentor_id (str): Filter statistics by mentor unique ID.
1266
+ * @param org
1267
+ * @param userId
1268
+ * @param mentorId Filter statistics by mentor unique ID
1269
+ * @returns TopicStatisticsResponse
1270
+ * @throws ApiError
1271
+ */
1272
+ public static aiAnalyticsOrgsUsersTopicOverviewRetrieve(
1273
+ org: string,
1274
+ userId: string,
1275
+ mentorId?: string,
1276
+ ): CancelablePromise<TopicStatisticsResponse> {
1277
+ return __request(OpenAPI, {
1278
+ method: 'GET',
1279
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/topic-overview/',
1280
+ path: {
1281
+ 'org': org,
1282
+ 'user_id': userId,
1283
+ },
1284
+ query: {
1285
+ 'mentor_id': mentorId,
1286
+ },
1287
+ errors: {
1288
+ 404: `Organization or mentor not found`,
1289
+ },
1290
+ });
1291
+ }
1292
+ /**
1293
+ * Retrieve paginated statistics about topics.
1294
+ *
1295
+ * This endpoint returns detailed statistics about topics, including:
1296
+ * - Number of conversations related to each topic
1297
+ * - Total message count for each topic
1298
+ * - Average sentiment of conversations about each topic
1299
+ * - Average user rating for conversations about each topic
1300
+ *
1301
+ * Results can be filtered by mentor and date range, and are paginated.
1302
+ *
1303
+ * Args:
1304
+ * request: The HTTP request containing filter query parameters.
1305
+ * org: Organization key identifier.
1306
+ *
1307
+ * Returns:
1308
+ * Response: Paginated list of topic statistics.
1309
+ *
1310
+ * Raises:
1311
+ * NotFound: If the specified organization or mentor does not exist.
1312
+ * BadRequest: If the provided parameters are invalid.
1313
+ *
1314
+ * Query Parameters:
1315
+ * start_date (str): Start date for filtering (YYYY-MM-DD).
1316
+ * end_date (str): End date for filtering (YYYY-MM-DD).
1317
+ * mentor_id (str): Filter by mentor unique ID.
1318
+ * page (int): Page number for pagination - default: 1.
1319
+ * page_size (int): Number of results per page - default: 20.
1320
+ * @param org
1321
+ * @param userId
1322
+ * @param endDate End date for filtering (YYYY-MM-DD)
1323
+ * @param groupBy
1324
+ * @param mentorId Filter by mentor unique ID
1325
+ * @param page Page number for pagination
1326
+ * @param pageSize Number of results per page
1327
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1328
+ * @returns PaginatedTopicStatisticsResponse
1329
+ * @throws ApiError
1330
+ */
1331
+ public static aiAnalyticsOrgsUsersTopicStatisticsRetrieve(
1332
+ org: string,
1333
+ userId: string,
1334
+ endDate?: string,
1335
+ groupBy: string = 'day',
1336
+ mentorId?: string,
1337
+ page: number = 1,
1338
+ pageSize: number = 20,
1339
+ startDate?: string,
1340
+ ): CancelablePromise<PaginatedTopicStatisticsResponse> {
1341
+ return __request(OpenAPI, {
1342
+ method: 'GET',
1343
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/topic-statistics/',
1344
+ path: {
1345
+ 'org': org,
1346
+ 'user_id': userId,
1347
+ },
1348
+ query: {
1349
+ 'end_date': endDate,
1350
+ 'group_by': groupBy,
1351
+ 'mentor_id': mentorId,
1352
+ 'page': page,
1353
+ 'page_size': pageSize,
1354
+ 'start_date': startDate,
1355
+ },
1356
+ errors: {
1357
+ 400: `Invalid parameters`,
1358
+ 404: `Organization or mentor not found`,
1359
+ },
1360
+ });
1361
+ }
1362
+ /**
1363
+ * Retrieve a summary of the most frequent topics.
1364
+ *
1365
+ * This endpoint returns a summary of the top 10 topics discussed in chat sessions,
1366
+ * ordered by conversation count. Results can be filtered by mentor and date range.
1367
+ *
1368
+ * Args:
1369
+ * request: The HTTP request containing filter query parameters.
1370
+ * org: Organization key identifier.
1371
+ *
1372
+ * Returns:
1373
+ * Response: A list of the top 10 topics with their conversation counts.
1374
+ *
1375
+ * Raises:
1376
+ * NotFound: If the specified organization does not exist.
1377
+ * BadRequest: If the provided date format is invalid.
1378
+ *
1379
+ * Query Parameters:
1380
+ * mentor_id (str): Filter by mentor unique ID.
1381
+ * start_date (str): Start date for filtering (YYYY-MM-DD).
1382
+ * end_date (str): End date for filtering (YYYY-MM-DD).
1383
+ * @param org
1384
+ * @param userId
1385
+ * @param endDate
1386
+ * @param startDate
1387
+ * @returns TopicSummaryView
1388
+ * @throws ApiError
1389
+ */
1390
+ public static aiAnalyticsOrgsUsersTopicsSummaryList(
1391
+ org: string,
1392
+ userId: string,
1393
+ endDate?: string,
1394
+ startDate?: string,
1395
+ ): CancelablePromise<Array<TopicSummaryView>> {
1396
+ return __request(OpenAPI, {
1397
+ method: 'GET',
1398
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/topics/summary/',
1399
+ path: {
1400
+ 'org': org,
1401
+ 'user_id': userId,
1402
+ },
1403
+ query: {
1404
+ 'end_date': endDate,
1405
+ 'start_date': startDate,
1406
+ },
1407
+ errors: {
1408
+ 400: `Invalid date format`,
1409
+ 404: `Organization not found`,
1410
+ },
1411
+ });
1412
+ }
1413
+ /**
1414
+ * Retrieve the total number of users interacting with mentors over time.
1415
+ *
1416
+ * This endpoint returns data on the number of unique users who interacted with
1417
+ * mentors each day or hour within a specified date range, with optional
1418
+ * filtering by specific mentor. If no date range is provided, the last 30 days
1419
+ * are used by default.
1420
+ *
1421
+ * Args:
1422
+ * request: The HTTP request containing filter query parameters.
1423
+ * org: Organization key identifier.
1424
+ *
1425
+ * Returns:
1426
+ * Response: Time series of unique user counts.
1427
+ *
1428
+ * Raises:
1429
+ * NotFound: If the specified organization or mentor does not exist.
1430
+ * BadRequest: If the provided parameters are invalid.
1431
+ *
1432
+ * Query Parameters:
1433
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - defaults to 30 days ago.
1434
+ * end_date (str): End date for filtering (YYYY-MM-DD) - defaults to today.
1435
+ * aggregation (str): Time aggregation level (hourly, daily) - default: daily.
1436
+ * mentor_id (str): Filter by mentor unique ID.
1437
+ * @param org
1438
+ * @param userId
1439
+ * @param aggregation Time aggregation level (hourly, daily)
1440
+ * @param endDate End date for filtering (YYYY-MM-DD)
1441
+ * @param groupBy
1442
+ * @param mentorId Filter by mentor unique ID
1443
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1444
+ * @returns UserChatByPeriod
1445
+ * @throws ApiError
1446
+ */
1447
+ public static aiAnalyticsOrgsUsersTotalUsersByMentorList(
1448
+ org: string,
1449
+ userId: string,
1450
+ aggregation: 'daily' | 'hourly' = 'daily',
1451
+ endDate?: string,
1452
+ groupBy: string = 'day',
1453
+ mentorId?: string,
1454
+ startDate?: string,
1455
+ ): CancelablePromise<Array<UserChatByPeriod>> {
1456
+ return __request(OpenAPI, {
1457
+ method: 'GET',
1458
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/total-users-by-mentor/',
1459
+ path: {
1460
+ 'org': org,
1461
+ 'user_id': userId,
1462
+ },
1463
+ query: {
1464
+ 'aggregation': aggregation,
1465
+ 'end_date': endDate,
1466
+ 'group_by': groupBy,
1467
+ 'mentor_id': mentorId,
1468
+ 'start_date': startDate,
1469
+ },
1470
+ errors: {
1471
+ 400: `Invalid parameters`,
1472
+ 404: `Organization or mentor not found`,
1473
+ },
1474
+ });
1475
+ }
1476
+ /**
1477
+ * Retrieve message data from conversations.
1478
+ *
1479
+ * This endpoint returns data on messages within conversations, with options
1480
+ * for filtering by date range, topics, and mentor.
1481
+ *
1482
+ * Args:
1483
+ * request: The HTTP request containing filter query parameters.
1484
+ * org: Organization key identifier.
1485
+ * user_id: User identifier (not used in the implementation).
1486
+ *
1487
+ * Returns:
1488
+ * Response: A list of conversation message data.
1489
+ *
1490
+ * Raises:
1491
+ * NotFound: If the specified organization does not exist.
1492
+ * ValidationError: If the provided query parameters are invalid.
1493
+ *
1494
+ * Query Parameters:
1495
+ * start_date (str): Start date for filtering (YYYY-MM-DD).
1496
+ * end_date (str): End date for filtering (YYYY-MM-DD).
1497
+ * topics (str): Comma-separated list of topics to filter by.
1498
+ * mentor (str): Filter by mentor unique ID.
1499
+ * @param org
1500
+ * @param userId
1501
+ * @param endDate
1502
+ * @param mentor
1503
+ * @param startDate
1504
+ * @param topics
1505
+ * @returns ConversationMessage
1506
+ * @throws ApiError
1507
+ */
1508
+ public static aiAnalyticsOrgsUsersTranscriptsList(
1509
+ org: string,
1510
+ userId: string,
1511
+ endDate?: string,
1512
+ mentor?: string,
1513
+ startDate?: string,
1514
+ topics?: string,
1515
+ ): CancelablePromise<Array<ConversationMessage>> {
1516
+ return __request(OpenAPI, {
1517
+ method: 'GET',
1518
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/transcripts/',
1519
+ path: {
1520
+ 'org': org,
1521
+ 'user_id': userId,
1522
+ },
1523
+ query: {
1524
+ 'end_date': endDate,
1525
+ 'mentor': mentor,
1526
+ 'start_date': startDate,
1527
+ 'topics': topics,
1528
+ },
1529
+ errors: {
1530
+ 404: `Organization not found`,
1531
+ },
1532
+ });
1533
+ }
1534
+ /**
1535
+ * Retrieve daily user engagement metrics with mentors.
1536
+ *
1537
+ * This endpoint returns data on the number of unique users who interact with
1538
+ * mentors each day within a specified date range.
1539
+ *
1540
+ * Args:
1541
+ * request: The HTTP request containing filter query parameters.
1542
+ * org: Organization key identifier.
1543
+ *
1544
+ * Returns:
1545
+ * Response: Daily time series of unique user counts.
1546
+ *
1547
+ * Raises:
1548
+ * NotFound: If the specified organization does not exist.
1549
+ * BadRequest: If the provided parameters are invalid.
1550
+ *
1551
+ * Query Parameters:
1552
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1553
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1554
+ * @param endDate End date for filtering (YYYY-MM-DD)
1555
+ * @param org
1556
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1557
+ * @param userId
1558
+ * @param groupBy
1559
+ * @returns UserCountRecord
1560
+ * @throws ApiError
1561
+ */
1562
+ public static aiAnalyticsOrgsUsersUsageSummaryList(
1563
+ endDate: string,
1564
+ org: string,
1565
+ startDate: string,
1566
+ userId: string,
1567
+ groupBy: string = 'day',
1568
+ ): CancelablePromise<Array<UserCountRecord>> {
1569
+ return __request(OpenAPI, {
1570
+ method: 'GET',
1571
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/usage-summary/',
1572
+ path: {
1573
+ 'org': org,
1574
+ 'user_id': userId,
1575
+ },
1576
+ query: {
1577
+ 'end_date': endDate,
1578
+ 'group_by': groupBy,
1579
+ 'start_date': startDate,
1580
+ },
1581
+ errors: {
1582
+ 400: `Invalid parameters`,
1583
+ 404: `Organization not found`,
1584
+ },
1585
+ });
1586
+ }
1587
+ /**
1588
+ * Retrieve user cohort trends over time.
1589
+ *
1590
+ * This endpoint returns data on the distribution of new versus veteran users
1591
+ * over time, with options for different time aggregations and filtering by mentor.
1592
+ * New users are those who registered within the specified date range, while
1593
+ * veteran users are those who registered before the date range but were active
1594
+ * during it.
1595
+ *
1596
+ * Args:
1597
+ * request: The HTTP request containing filter query parameters.
1598
+ * org: Organization key identifier.
1599
+ *
1600
+ * Returns:
1601
+ * Response: Time series of new and veteran user counts.
1602
+ *
1603
+ * Raises:
1604
+ * NotFound: If the specified organization does not exist.
1605
+ * BadRequest: If the provided parameters are invalid.
1606
+ *
1607
+ * Query Parameters:
1608
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1609
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1610
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1611
+ * mentor_id (str): Filter by mentor unique ID.
1612
+ * @param endDate End date for filtering (YYYY-MM-DD)
1613
+ * @param org
1614
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1615
+ * @param userId
1616
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
1617
+ * @param mentorId Filter by mentor unique ID
1618
+ * @returns UserTrendByPeriod
1619
+ * @throws ApiError
1620
+ */
1621
+ public static aiAnalyticsOrgsUsersUserCohortsOverTimeRetrieve(
1622
+ endDate: string,
1623
+ org: string,
1624
+ startDate: string,
1625
+ userId: string,
1626
+ aggregation: 'daily' | 'hourly' | 'weekly' = 'daily',
1627
+ mentorId?: string,
1628
+ ): CancelablePromise<UserTrendByPeriod> {
1629
+ return __request(OpenAPI, {
1630
+ method: 'GET',
1631
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-cohorts-over-time/',
1632
+ path: {
1633
+ 'org': org,
1634
+ 'user_id': userId,
1635
+ },
1636
+ query: {
1637
+ 'aggregation': aggregation,
1638
+ 'end_date': endDate,
1639
+ 'mentor_id': mentorId,
1640
+ 'start_date': startDate,
1641
+ },
1642
+ errors: {
1643
+ 400: `Invalid parameters`,
1644
+ 404: `Organization not found`,
1645
+ },
1646
+ });
1647
+ }
1648
+ /**
1649
+ * Retrieve LLM usage costs for a specific user.
1650
+ *
1651
+ * This endpoint returns data on the total cost of LLM usage for a specific user
1652
+ * within a specified date range. The cost is calculated by summing the costs
1653
+ * of all observations associated with traces from the tenant's sessions.
1654
+ *
1655
+ * Args:
1656
+ * request: The HTTP request containing filter query parameters.
1657
+ * org: Organization key identifier.
1658
+ * user_id: User key identifier.
1659
+ *
1660
+ * Returns:
1661
+ * Response: Total LLM usage cost for the specified tenant.
1662
+ *
1663
+ * Raises:
1664
+ * NotFound: If the specified organization does not exist.
1665
+ * BadRequest: If the provided parameters are invalid.
1666
+ *
1667
+ * Query Parameters:
1668
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1669
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1670
+ * @param endDate
1671
+ * @param org
1672
+ * @param startDate
1673
+ * @param userId
1674
+ * @param username
1675
+ * @returns Cost
1676
+ * @throws ApiError
1677
+ */
1678
+ public static aiAnalyticsOrgsUsersUserCostRetrieve(
1679
+ endDate: string,
1680
+ org: string,
1681
+ startDate: string,
1682
+ userId: string,
1683
+ username: string,
1684
+ ): CancelablePromise<Cost> {
1685
+ return __request(OpenAPI, {
1686
+ method: 'GET',
1687
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-cost/',
1688
+ path: {
1689
+ 'org': org,
1690
+ 'user_id': userId,
1691
+ },
1692
+ query: {
1693
+ 'end_date': endDate,
1694
+ 'start_date': startDate,
1695
+ 'username': username,
1696
+ },
1697
+ errors: {
1698
+ 400: `Invalid parameters`,
1699
+ 404: `Organization not found`,
1700
+ },
1701
+ });
1702
+ }
1703
+ /**
1704
+ * Retrieve aggregated user chat feedback counts.
1705
+ *
1706
+ * This endpoint returns data on the number of user chat feedback entries
1707
+ * within a specified date range, with options for different time aggregations
1708
+ * (hourly, daily, weekly). Results can be filtered by mentor.
1709
+ *
1710
+ * Args:
1711
+ * request: The HTTP request containing filter query parameters.
1712
+ * org: Organization key identifier.
1713
+ *
1714
+ * Returns:
1715
+ * Response: Time series data of feedback counts.
1716
+ *
1717
+ * Raises:
1718
+ * NotFound: If the specified organization does not exist.
1719
+ * BadRequest: If the provided parameters are invalid.
1720
+ *
1721
+ * Query Parameters:
1722
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1723
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1724
+ * mentor_id (str): Filter by mentor unique ID.
1725
+ * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1726
+ * @param endDate End date for filtering (YYYY-MM-DD)
1727
+ * @param org
1728
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1729
+ * @param userId
1730
+ * @param aggregation Time aggregation level (hourly, daily, weekly)
1731
+ * @param mentorId Filter by mentor unique ID
1732
+ * @returns UserChatFeedbackCount
1733
+ * @throws ApiError
1734
+ */
1735
+ public static aiAnalyticsOrgsUsersUserFeedbackList(
1736
+ endDate: string,
1737
+ org: string,
1738
+ startDate: string,
1739
+ userId: string,
1740
+ aggregation: 'daily' | 'hourly' | 'weekly' = 'daily',
1741
+ mentorId?: string,
1742
+ ): CancelablePromise<Array<UserChatFeedbackCount>> {
1743
+ return __request(OpenAPI, {
1744
+ method: 'GET',
1745
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-feedback/',
1746
+ path: {
1747
+ 'org': org,
1748
+ 'user_id': userId,
1749
+ },
1750
+ query: {
1751
+ 'aggregation': aggregation,
1752
+ 'end_date': endDate,
1753
+ 'mentor_id': mentorId,
1754
+ 'start_date': startDate,
1755
+ },
1756
+ errors: {
1757
+ 400: `Invalid parameters`,
1758
+ 404: `Organization not found`,
1759
+ },
1760
+ });
1761
+ }
1762
+ /**
1763
+ * Retrieve comprehensive user metrics.
1764
+ *
1765
+ * This endpoint returns data on various user metrics with month-over-month
1766
+ * change calculations:
1767
+ * - Registered users: Total users registered on the platform
1768
+ * - New users: Users who joined in the current month
1769
+ * - Unique users: Distinct users who have had sessions
1770
+ * - Veteran users: Users who have been active for at least 6 months
1771
+ *
1772
+ * Results can be filtered by mentor.
1773
+ *
1774
+ * Args:
1775
+ * request: The HTTP request containing filter query parameters.
1776
+ * org: Organization key identifier.
1777
+ *
1778
+ * Returns:
1779
+ * Response: Comprehensive user metrics with month-over-month changes.
1780
+ *
1781
+ * Raises:
1782
+ * NotFound: If the specified organization does not exist.
1783
+ *
1784
+ * Query Parameters:
1785
+ * mentor_id (str): Filter metrics by mentor unique ID.
1786
+ * @param org
1787
+ * @param userId
1788
+ * @param groupBy
1789
+ * @param mentorId Filter metrics by mentor unique ID
1790
+ * @returns UserMetricsResponse
1791
+ * @throws ApiError
1792
+ */
1793
+ public static aiAnalyticsOrgsUsersUserMetricsRetrieve(
1794
+ org: string,
1795
+ userId: string,
1796
+ groupBy: string = 'day',
1797
+ mentorId?: string,
1798
+ ): CancelablePromise<UserMetricsResponse> {
1799
+ return __request(OpenAPI, {
1800
+ method: 'GET',
1801
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics/',
1802
+ path: {
1803
+ 'org': org,
1804
+ 'user_id': userId,
1805
+ },
1806
+ query: {
1807
+ 'group_by': groupBy,
1808
+ 'mentor_id': mentorId,
1809
+ },
1810
+ errors: {
1811
+ 404: `Organization not found`,
1812
+ },
1813
+ });
1814
+ }
1815
+ /**
1816
+ * Retrieve user distribution data for pie charts.
1817
+ *
1818
+ * This endpoint returns data on the distribution of new versus returning users
1819
+ * within a specified date range, including both counts and percentages,
1820
+ * suitable for pie chart visualization.
1821
+ *
1822
+ * Args:
1823
+ * request: The HTTP request containing filter query parameters.
1824
+ * org: Organization key identifier.
1825
+ *
1826
+ * Returns:
1827
+ * Response: Distribution of new versus returning users with counts and percentages.
1828
+ *
1829
+ * Raises:
1830
+ * NotFound: If the specified organization does not exist.
1831
+ * BadRequest: If the provided parameters are invalid.
1832
+ *
1833
+ * Query Parameters:
1834
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1835
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1836
+ * mentor_id (str): Filter by mentor unique ID.
1837
+ * @param endDate End date for filtering (YYYY-MM-DD)
1838
+ * @param org
1839
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1840
+ * @param userId
1841
+ * @param mentorId Filter by mentor unique ID
1842
+ * @returns PieChartData
1843
+ * @throws ApiError
1844
+ */
1845
+ public static aiAnalyticsOrgsUsersUserMetricsPieChartRetrieve(
1846
+ endDate: string,
1847
+ org: string,
1848
+ startDate: string,
1849
+ userId: string,
1850
+ mentorId?: string,
1851
+ ): CancelablePromise<PieChartData> {
1852
+ return __request(OpenAPI, {
1853
+ method: 'GET',
1854
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics-pie-chart/',
1855
+ path: {
1856
+ 'org': org,
1857
+ 'user_id': userId,
1858
+ },
1859
+ query: {
1860
+ 'end_date': endDate,
1861
+ 'mentor_id': mentorId,
1862
+ 'start_date': startDate,
1863
+ },
1864
+ errors: {
1865
+ 400: `Invalid parameters`,
1866
+ 404: `Organization not found`,
1867
+ },
1868
+ });
1869
+ }
1870
+ /**
1871
+ * Retrieve user sentiment distribution.
1872
+ *
1873
+ * This endpoint returns data on the distribution of user sentiments (positive,
1874
+ * negative, neutral) within a specified date range, expressed as percentages.
1875
+ *
1876
+ * Args:
1877
+ * request: The HTTP request containing filter query parameters.
1878
+ * org: Organization key identifier.
1879
+ *
1880
+ * Returns:
1881
+ * Response: Sentiment distribution percentages and total sentiment count.
1882
+ *
1883
+ * Raises:
1884
+ * NotFound: If the specified organization does not exist.
1885
+ * BadRequest: If the provided parameters are invalid.
1886
+ *
1887
+ * Query Parameters:
1888
+ * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1889
+ * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1890
+ * @param endDate End date for filtering (YYYY-MM-DD)
1891
+ * @param org
1892
+ * @param startDate Start date for filtering (YYYY-MM-DD)
1893
+ * @param userId
1894
+ * @param groupBy
1895
+ * @returns SentimentSummary
1896
+ * @throws ApiError
1897
+ */
1898
+ public static aiAnalyticsOrgsUsersUserSentimentRetrieve(
1899
+ endDate: string,
1900
+ org: string,
1901
+ startDate: string,
1902
+ userId: string,
1903
+ groupBy: string = 'day',
1904
+ ): CancelablePromise<SentimentSummary> {
1905
+ return __request(OpenAPI, {
1906
+ method: 'GET',
1907
+ url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-sentiment/',
1908
+ path: {
1909
+ 'org': org,
1910
+ 'user_id': userId,
1911
+ },
1912
+ query: {
1913
+ 'end_date': endDate,
1914
+ 'group_by': groupBy,
1915
+ 'start_date': startDate,
1916
+ },
1917
+ errors: {
1918
+ 400: `Invalid parameters`,
1919
+ 404: `Organization not found`,
1920
+ },
1921
+ });
1922
+ }
1923
+ }