@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,4096 @@
1
+ import type { AIGeneratedImage } from '../models/AIGeneratedImage';
2
+ import type { AssumedKnowledge } from '../models/AssumedKnowledge';
3
+ import type { AudioToTextRequest } from '../models/AudioToTextRequest';
4
+ import type { AudioToTextResponse } from '../models/AudioToTextResponse';
5
+ import type { CallAuthenticationRequest } from '../models/CallAuthenticationRequest';
6
+ import type { CallAuthenticationResponse } from '../models/CallAuthenticationResponse';
7
+ import type { ChatHistoryItem } from '../models/ChatHistoryItem';
8
+ import type { ChatHistorySessionId } from '../models/ChatHistorySessionId';
9
+ import type { ChatSessionRequest } from '../models/ChatSessionRequest';
10
+ import type { ChatSessionResponse } from '../models/ChatSessionResponse';
11
+ import type { CourseCreationTask } from '../models/CourseCreationTask';
12
+ import type { CourseCreationTaskFile } from '../models/CourseCreationTaskFile';
13
+ import type { CustomInstructionResponse } from '../models/CustomInstructionResponse';
14
+ import type { EdxCourse } from '../models/EdxCourse';
15
+ import type { ElevenlabsCustomVoice } from '../models/ElevenlabsCustomVoice';
16
+ import type { ElevenlabsCustomVoiceResponse } from '../models/ElevenlabsCustomVoiceResponse';
17
+ import type { EmailPromptDetail } from '../models/EmailPromptDetail';
18
+ import type { EmailPromptSummary } from '../models/EmailPromptSummary';
19
+ import type { FreeUsageCount } from '../models/FreeUsageCount';
20
+ import type { FullCourse } from '../models/FullCourse';
21
+ import type { JobRun } from '../models/JobRun';
22
+ import type { LinkCourseRequest } from '../models/LinkCourseRequest';
23
+ import type { LinkCourseResponse } from '../models/LinkCourseResponse';
24
+ import type { LLMModelForTenant } from '../models/LLMModelForTenant';
25
+ import type { LLMResponse } from '../models/LLMResponse';
26
+ import type { MemoryComponentMemoryDetail } from '../models/MemoryComponentMemoryDetail';
27
+ import type { MemoryComponentResponse } from '../models/MemoryComponentResponse';
28
+ import type { MemoryProgress } from '../models/MemoryProgress';
29
+ import type { Mentor } from '../models/Mentor';
30
+ import type { MentorAudience } from '../models/MentorAudience';
31
+ import type { MentorCategory } from '../models/MentorCategory';
32
+ import type { MentorCategoryCreate } from '../models/MentorCategoryCreate';
33
+ import type { MentorCategoryGroup } from '../models/MentorCategoryGroup';
34
+ import type { MentorCategoryGroupCreate } from '../models/MentorCategoryGroupCreate';
35
+ import type { MentorCreate } from '../models/MentorCreate';
36
+ import type { MentorCustomVoice } from '../models/MentorCustomVoice';
37
+ import type { MentorCustomVoiceResponse } from '../models/MentorCustomVoiceResponse';
38
+ import type { MentorEval } from '../models/MentorEval';
39
+ import type { MentorEvalReport } from '../models/MentorEvalReport';
40
+ import type { MentorEvalRequest } from '../models/MentorEvalRequest';
41
+ import type { MentorFork } from '../models/MentorFork';
42
+ import type { MentorFromTemplateRequest } from '../models/MentorFromTemplateRequest';
43
+ import type { MentorFromTemplateWithSettingRequest } from '../models/MentorFromTemplateWithSettingRequest';
44
+ import type { MentorMemorySettingsRequest } from '../models/MentorMemorySettingsRequest';
45
+ import type { MentorMemorySettingsResponse } from '../models/MentorMemorySettingsResponse';
46
+ import type { MentorMetadata } from '../models/MentorMetadata';
47
+ import type { MentorScenario } from '../models/MentorScenario';
48
+ import type { MentorSettings } from '../models/MentorSettings';
49
+ import type { MentorSettingsPublic } from '../models/MentorSettingsPublic';
50
+ import type { MentorSettingsRequest } from '../models/MentorSettingsRequest';
51
+ import type { MentorWizard } from '../models/MentorWizard';
52
+ import type { MessageView } from '../models/MessageView';
53
+ import type { MessageViewRequest } from '../models/MessageViewRequest';
54
+ import type { MessageViewUpdatResponse } from '../models/MessageViewUpdatResponse';
55
+ import type { ModerationLog } from '../models/ModerationLog';
56
+ import type { PaginatedAIGeneratedImageList } from '../models/PaginatedAIGeneratedImageList';
57
+ import type { PaginatedCourseCreationTaskFileList } from '../models/PaginatedCourseCreationTaskFileList';
58
+ import type { PaginatedCourseCreationTaskList } from '../models/PaginatedCourseCreationTaskList';
59
+ import type { PaginatedEdxCourseList } from '../models/PaginatedEdxCourseList';
60
+ import type { PaginatedEmailPromptListList } from '../models/PaginatedEmailPromptListList';
61
+ import type { PaginatedJobRunList } from '../models/PaginatedJobRunList';
62
+ import type { PaginatedMentorList } from '../models/PaginatedMentorList';
63
+ import type { PaginatedModerationLogList } from '../models/PaginatedModerationLogList';
64
+ import type { PaginatedPeriodicAgentList } from '../models/PaginatedPeriodicAgentList';
65
+ import type { PaginatedPeriodicAgentLogList } from '../models/PaginatedPeriodicAgentLogList';
66
+ import type { PaginatedPlayWrightScriptList } from '../models/PaginatedPlayWrightScriptList';
67
+ import type { PaginatedSectionList } from '../models/PaginatedSectionList';
68
+ import type { PaginatedSubSectionList } from '../models/PaginatedSubSectionList';
69
+ import type { PaginatedUnitList } from '../models/PaginatedUnitList';
70
+ import type { PaginatedUserEdxMemoryList } from '../models/PaginatedUserEdxMemoryList';
71
+ import type { PaginatedVoiceList } from '../models/PaginatedVoiceList';
72
+ import type { PatchedCourseCreationTaskFile } from '../models/PatchedCourseCreationTaskFile';
73
+ import type { PatchedMentorCategoryGroupCreate } from '../models/PatchedMentorCategoryGroupCreate';
74
+ import type { PatchedMentorCreate } from '../models/PatchedMentorCreate';
75
+ import type { PatchedPeriodicAgentCreate } from '../models/PatchedPeriodicAgentCreate';
76
+ import type { PatchedPlayWrightScript } from '../models/PatchedPlayWrightScript';
77
+ import type { PatchedSection } from '../models/PatchedSection';
78
+ import type { PatchedSubSection } from '../models/PatchedSubSection';
79
+ import type { PatchedUnit } from '../models/PatchedUnit';
80
+ import type { PeriodicAgent } from '../models/PeriodicAgent';
81
+ import type { PeriodicAgentCreate } from '../models/PeriodicAgentCreate';
82
+ import type { PeriodicAgentLog } from '../models/PeriodicAgentLog';
83
+ import type { PinnedMessageCreate } from '../models/PinnedMessageCreate';
84
+ import type { PinnedMessageGet } from '../models/PinnedMessageGet';
85
+ import type { PinnedMessageRequest } from '../models/PinnedMessageRequest';
86
+ import type { PlayWrightScript } from '../models/PlayWrightScript';
87
+ import type { PredictiveAnalyticsRequest } from '../models/PredictiveAnalyticsRequest';
88
+ import type { PredictiveAnalyticsResponse } from '../models/PredictiveAnalyticsResponse';
89
+ import type { QuestionCardTag } from '../models/QuestionCardTag';
90
+ import type { QuestionRequest } from '../models/QuestionRequest';
91
+ import type { QuestionResponse } from '../models/QuestionResponse';
92
+ import type { RecentlyAccessedMentor } from '../models/RecentlyAccessedMentor';
93
+ import type { RecommendCourseBlock } from '../models/RecommendCourseBlock';
94
+ import type { RecommendCourseResponse } from '../models/RecommendCourseResponse';
95
+ import type { RelatedText } from '../models/RelatedText';
96
+ import type { RetrieveTask } from '../models/RetrieveTask';
97
+ import type { RunMentorEval } from '../models/RunMentorEval';
98
+ import type { Section } from '../models/Section';
99
+ import type { SeedMentorsView } from '../models/SeedMentorsView';
100
+ import type { SessionBrowserScreenshot } from '../models/SessionBrowserScreenshot';
101
+ import type { SessionDetail } from '../models/SessionDetail';
102
+ import type { SessionMemoryStorage } from '../models/SessionMemoryStorage';
103
+ import type { ShellLogs } from '../models/ShellLogs';
104
+ import type { SpacedRepetitionLearningPath } from '../models/SpacedRepetitionLearningPath';
105
+ import type { SpacedRepetitionQuestionStats } from '../models/SpacedRepetitionQuestionStats';
106
+ import type { StarMentor } from '../models/StarMentor';
107
+ import type { SubSection } from '../models/SubSection';
108
+ import type { TaskView } from '../models/TaskView';
109
+ import type { TemplateMentor } from '../models/TemplateMentor';
110
+ import type { ToolResponse } from '../models/ToolResponse';
111
+ import type { TriggerRequest } from '../models/TriggerRequest';
112
+ import type { TriggerResponse } from '../models/TriggerResponse';
113
+ import type { Unit } from '../models/Unit';
114
+ import type { UserChatFeedback } from '../models/UserChatFeedback';
115
+ import type { UserEdxMemory } from '../models/UserEdxMemory';
116
+ import type { VectorResult } from '../models/VectorResult';
117
+ import type { Voice } from '../models/Voice';
118
+ import type { WebResource } from '../models/WebResource';
119
+ import type { WebResourcesQuery } from '../models/WebResourcesQuery';
120
+ import type { CancelablePromise } from '../core/CancelablePromise';
121
+ export declare class AiMentorService {
122
+ /**
123
+ * List all triggers for an organization.
124
+ *
125
+ * Args:
126
+ * request: The HTTP request.
127
+ * org: The organization/tenant identifier.
128
+ *
129
+ * Returns:
130
+ * Response: A list of trigger slugs for the organization.
131
+ *
132
+ * Raises:
133
+ * BadRequest: If the request is invalid.
134
+ * @param org
135
+ * @returns any List of trigger slugs
136
+ * @throws ApiError
137
+ */
138
+ static aiMentorOrgsAllTriggersRetrieve(org: string): CancelablePromise<any>;
139
+ /**
140
+ * Retrieve a list of emails in a mentor's inbox.
141
+ *
142
+ * The list can be filtered using the 'search' query parameter to search
143
+ * for specific terms in the email content or subject.
144
+ *
145
+ * Args:
146
+ * mentor: The unique identifier of the mentor.
147
+ *
148
+ * Returns:
149
+ * Response: A paginated list of emails in the mentor's inbox.
150
+ *
151
+ * Raises:
152
+ * NotFound: If the specified mentor does not exist.
153
+ * @param mentor
154
+ * @param org
155
+ * @param page A page number within the paginated result set.
156
+ * @param pageSize Number of results to return per page.
157
+ * @param search Search term to filter emails by content or subject
158
+ * @returns PaginatedEmailPromptListList
159
+ * @throws ApiError
160
+ */
161
+ static aiMentorOrgsMentorsEmailInboxList(mentor: string, org: string, page?: number, pageSize?: number, search?: string): CancelablePromise<PaginatedEmailPromptListList>;
162
+ /**
163
+ * Retrieve a summary of a mentor's email inbox.
164
+ *
165
+ * Args:
166
+ * request: The HTTP request.
167
+ * mentor: The unique identifier of the mentor.
168
+ *
169
+ * Returns:
170
+ * Response: A summary of the mentor's email inbox statistics.
171
+ *
172
+ * Raises:
173
+ * NotFound: If the specified mentor does not exist.
174
+ * @param mentor
175
+ * @param org
176
+ * @returns EmailPromptSummary
177
+ * @throws ApiError
178
+ */
179
+ static aiMentorOrgsMentorsEmailInboxSummaryRetrieve(mentor: string, org: string): CancelablePromise<EmailPromptSummary>;
180
+ /**
181
+ * Retrieve details of a specific email in a mentor's inbox.
182
+ *
183
+ * Args:
184
+ * request: The HTTP request.
185
+ * email_prompt_id: The ID of the email to retrieve.
186
+ *
187
+ * Returns:
188
+ * Response: The detailed information about the email.
189
+ *
190
+ * Raises:
191
+ * NotFound: If the specified email does not exist.
192
+ * @param emailPromptId
193
+ * @param mentor
194
+ * @param org
195
+ * @returns EmailPromptDetail
196
+ * @throws ApiError
197
+ */
198
+ static aiMentorOrgsMentorsEmailInboxRetrieve(emailPromptId: number, mentor: string, org: string): CancelablePromise<EmailPromptDetail>;
199
+ /**
200
+ * API endpoint to link mentor with a course and enable guided mode.
201
+ *
202
+ * Permissions:
203
+ * - Accessible to tenant admins.
204
+ * @param mentor
205
+ * @param org
206
+ * @returns LinkCourseResponse
207
+ * @throws ApiError
208
+ */
209
+ static aiMentorOrgsMentorsLinkCourseRetrieve(mentor: string, org: string): CancelablePromise<LinkCourseResponse>;
210
+ /**
211
+ * API endpoint to link mentor with a course and enable guided mode.
212
+ *
213
+ * Permissions:
214
+ * - Accessible to tenant admins.
215
+ * @param mentor
216
+ * @param org
217
+ * @param requestBody
218
+ * @returns LinkCourseResponse
219
+ * @throws ApiError
220
+ */
221
+ static aiMentorOrgsMentorsLinkCourseCreate(mentor: string, org: string, requestBody: LinkCourseRequest): CancelablePromise<LinkCourseResponse>;
222
+ /**
223
+ * Create or update metadata for a mentor.
224
+ *
225
+ * Args:
226
+ * request: The HTTP request containing the metadata.
227
+ * org: The organization/tenant identifier.
228
+ *
229
+ * Returns:
230
+ * Response: The created or updated mentor metadata.
231
+ *
232
+ * Raises:
233
+ * BadRequest: If the provided data is invalid.
234
+ * @param org
235
+ * @param requestBody
236
+ * @returns MentorMetadata
237
+ * @throws ApiError
238
+ */
239
+ static aiMentorOrgsMetadataCreate(org: string, requestBody: MentorMetadata): CancelablePromise<MentorMetadata>;
240
+ /**
241
+ * Retrieve existing questions.
242
+ *
243
+ * Args:
244
+ * request: The HTTP request.
245
+ *
246
+ * Returns:
247
+ * Response: The existing questions.
248
+ * @param org
249
+ * @returns any No response body
250
+ * @throws ApiError
251
+ */
252
+ static aiMentorOrgsQuizCustomizerRetrieve(org: string): CancelablePromise<any>;
253
+ /**
254
+ * Generate follow-up questions based on initial questions.
255
+ *
256
+ * Args:
257
+ * request: The HTTP request containing the initial questions.
258
+ *
259
+ * Returns:
260
+ * Response: The generated follow-up questions.
261
+ *
262
+ * Raises:
263
+ * BadRequest: If the provided data is invalid.
264
+ * @param org
265
+ * @param requestBody
266
+ * @returns QuestionResponse
267
+ * @throws ApiError
268
+ */
269
+ static aiMentorOrgsQuizCustomizerCreate(org: string, requestBody: QuestionRequest): CancelablePromise<QuestionResponse>;
270
+ /**
271
+ * Retrieve or create a chat session with a mentor.
272
+ *
273
+ * Passing `null` as `tools` results in using all tools assigned to the mentor.
274
+ * To specify that no tools be used, pass an empty list.
275
+ *
276
+ * Args:
277
+ * request: HTTP request containing mentor details.
278
+ * org: Organization key identifier.
279
+ * user_id (optional): Username for authentication (if required by the mentor).
280
+ *
281
+ * Returns:
282
+ * Response: JSON object containing the session ID.
283
+ *
284
+ * Raises:
285
+ * Http404: If the mentor is not found.
286
+ * ValidationError: If the username is invalid.
287
+ * ValidationError: If one or more tool slugs are invalid.
288
+ * @param org
289
+ * @param requestBody
290
+ * @returns ChatSessionResponse
291
+ * @throws ApiError
292
+ */
293
+ static aiMentorOrgsSessionsCreate(org: string, requestBody: ChatSessionRequest): CancelablePromise<ChatSessionResponse>;
294
+ /**
295
+ * Create or modify a trigger.
296
+ *
297
+ * Args:
298
+ * request: The HTTP request containing the trigger data.
299
+ * org: The organization/tenant identifier.
300
+ *
301
+ * Returns:
302
+ * Response: The created or updated trigger details.
303
+ *
304
+ * Raises:
305
+ * BadRequest: If the provided data is invalid or missing required parameters.
306
+ * @param org
307
+ * @param requestBody
308
+ * @returns TriggerResponse
309
+ * @throws ApiError
310
+ */
311
+ static aiMentorOrgsTriggerCreate(org: string, requestBody: TriggerRequest): CancelablePromise<TriggerResponse>;
312
+ /**
313
+ * Retrieve available trigger templates.
314
+ *
315
+ * Args:
316
+ * request: The HTTP request.
317
+ * org: The organization/tenant identifier.
318
+ *
319
+ * Returns:
320
+ * Response: A dictionary of available trigger templates and their required parameters.
321
+ *
322
+ * Raises:
323
+ * BadRequest: If the request is invalid.
324
+ * @param org
325
+ * @returns any Dictionary of trigger templates and their required parameters
326
+ * @throws ApiError
327
+ */
328
+ static aiMentorOrgsTriggerTemplatesRetrieve(org: string): CancelablePromise<any>;
329
+ /**
330
+ * Retrieve details of a specific trigger.
331
+ *
332
+ * Args:
333
+ * request: The HTTP request.
334
+ * org: The organization/tenant identifier.
335
+ * slug: The unique slug identifier of the trigger.
336
+ *
337
+ * Returns:
338
+ * Response: The details of the specified trigger.
339
+ *
340
+ * Raises:
341
+ * Http404: If the specified trigger does not exist.
342
+ * @param org
343
+ * @param slug
344
+ * @returns TriggerResponse
345
+ * @throws ApiError
346
+ */
347
+ static aiMentorOrgsTriggerRetrieve(org: string, slug: string): CancelablePromise<TriggerResponse>;
348
+ /**
349
+ * Delete a specific trigger.
350
+ *
351
+ * Args:
352
+ * request: The HTTP request.
353
+ * org: The organization/tenant identifier.
354
+ * slug: The unique slug identifier of the trigger to delete.
355
+ *
356
+ * Returns:
357
+ * Response: A confirmation of the deletion status.
358
+ *
359
+ * Raises:
360
+ * BadRequest: If the specified trigger does not exist.
361
+ * @param org
362
+ * @param slug
363
+ * @returns any Trigger successfully deleted
364
+ * @throws ApiError
365
+ */
366
+ static aiMentorOrgsTriggerDeletionCreate(org: string, slug: string): CancelablePromise<any>;
367
+ /**
368
+ * Retrieve a list of mentors.
369
+ *
370
+ * Returns:
371
+ * - List of mentors matching the filters.
372
+ * @param org
373
+ * @param userId
374
+ * @param filterBy Filter options include, date, name, default is date
375
+ * @param metadataKey Metadata key to be queried with
376
+ * @param metadataValue Metadata value to be filter for
377
+ * @param page A page number within the paginated result set.
378
+ * @param pageSize Number of results to return per page.
379
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
380
+ * @param visibility visibility type to be queried with
381
+ * @returns PaginatedMentorList
382
+ * @throws ApiError
383
+ */
384
+ static aiMentorOrgsUsersList(org: string, userId: string, filterBy?: string, metadataKey?: string, metadataValue?: string, page?: number, pageSize?: number, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<PaginatedMentorList>;
385
+ /**
386
+ * Create a new mentor.
387
+ *
388
+ * Body Parameters:
389
+ * - name: Mentor name.
390
+ * - unique_id: Unique identifier.
391
+ * - platform_key: Associated platform.
392
+ * - metadata: Additional mentor attributes.
393
+ * @param org
394
+ * @param userId
395
+ * @param requestBody
396
+ * @param filterBy Filter options include, date, name, default is date
397
+ * @param metadataKey Metadata key to be queried with
398
+ * @param metadataValue Metadata value to be filter for
399
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
400
+ * @param visibility visibility type to be queried with
401
+ * @returns Mentor
402
+ * @throws ApiError
403
+ */
404
+ static aiMentorOrgsUsersCreate(org: string, userId: string, requestBody: MentorCreate, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<Mentor>;
405
+ /**
406
+ * API ViewSet for managing mentors.
407
+ *
408
+ * Provides endpoints to retrieve, create, update, and delete mentor data.
409
+ *
410
+ * Permissions:
411
+ * - Accessible to both tenant admins and students.
412
+ * @param name
413
+ * @param org
414
+ * @param userId
415
+ * @param filterBy Filter options include, date, name, default is date
416
+ * @param metadataKey Metadata key to be queried with
417
+ * @param metadataValue Metadata value to be filter for
418
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
419
+ * @param visibility visibility type to be queried with
420
+ * @returns Mentor
421
+ * @throws ApiError
422
+ */
423
+ static aiMentorOrgsUsersRetrieve(name: string, org: string, userId: string, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<Mentor>;
424
+ /**
425
+ * Update a mentor's details.
426
+ * @param name
427
+ * @param org
428
+ * @param userId
429
+ * @param requestBody
430
+ * @param filterBy Filter options include, date, name, default is date
431
+ * @param metadataKey Metadata key to be queried with
432
+ * @param metadataValue Metadata value to be filter for
433
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
434
+ * @param visibility visibility type to be queried with
435
+ * @returns Mentor
436
+ * @throws ApiError
437
+ */
438
+ static aiMentorOrgsUsersUpdate(name: string, org: string, userId: string, requestBody: MentorCreate, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<Mentor>;
439
+ /**
440
+ * API ViewSet for managing mentors.
441
+ *
442
+ * Provides endpoints to retrieve, create, update, and delete mentor data.
443
+ *
444
+ * Permissions:
445
+ * - Accessible to both tenant admins and students.
446
+ * @param name
447
+ * @param org
448
+ * @param userId
449
+ * @param filterBy Filter options include, date, name, default is date
450
+ * @param metadataKey Metadata key to be queried with
451
+ * @param metadataValue Metadata value to be filter for
452
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
453
+ * @param visibility visibility type to be queried with
454
+ * @param requestBody
455
+ * @returns MentorCreate
456
+ * @throws ApiError
457
+ */
458
+ static aiMentorOrgsUsersPartialUpdate(name: string, org: string, userId: string, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string, requestBody?: PatchedMentorCreate): CancelablePromise<MentorCreate>;
459
+ /**
460
+ * Soft delete a mentor.
461
+ * @param name
462
+ * @param org
463
+ * @param userId
464
+ * @param filterBy Filter options include, date, name, default is date
465
+ * @param metadataKey Metadata key to be queried with
466
+ * @param metadataValue Metadata value to be filter for
467
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
468
+ * @param visibility visibility type to be queried with
469
+ * @returns void
470
+ * @throws ApiError
471
+ */
472
+ static aiMentorOrgsUsersDestroy(name: string, org: string, userId: string, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<void>;
473
+ /**
474
+ * Endpoint to view and delete AI generated images for a user.
475
+ *
476
+ * AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.
477
+ *
478
+ * optional filtering parameters allowed are
479
+ * - username: The username of the user for which this image was stored.
480
+ * - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
481
+ * - model: the text to image model on the provider used to generate the image.
482
+ *
483
+ * This endpoint is accessible to both students and platform admins.
484
+ * @param org
485
+ * @param userId
486
+ * @param model
487
+ * @param ordering Which field to use when ordering the results.
488
+ * @param page A page number within the paginated result set.
489
+ * @param pageSize Number of results to return per page.
490
+ * @param provider
491
+ * @param search A search term.
492
+ * @param username
493
+ * @returns PaginatedAIGeneratedImageList
494
+ * @throws ApiError
495
+ */
496
+ static aiMentorOrgsUsersAiGeneratedImagesList(org: string, userId: string, model?: string, ordering?: string, page?: number, pageSize?: number, provider?: string, search?: string, username?: string): CancelablePromise<PaginatedAIGeneratedImageList>;
497
+ /**
498
+ * Endpoint to view and delete AI generated images for a user.
499
+ *
500
+ * AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.
501
+ *
502
+ * optional filtering parameters allowed are
503
+ * - username: The username of the user for which this image was stored.
504
+ * - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
505
+ * - model: the text to image model on the provider used to generate the image.
506
+ *
507
+ * This endpoint is accessible to both students and platform admins.
508
+ * @param id A unique integer value identifying this ai generated image.
509
+ * @param org
510
+ * @param userId
511
+ * @returns AIGeneratedImage
512
+ * @throws ApiError
513
+ */
514
+ static aiMentorOrgsUsersAiGeneratedImagesRetrieve(id: number, org: string, userId: string): CancelablePromise<AIGeneratedImage>;
515
+ /**
516
+ * Endpoint to view and delete AI generated images for a user.
517
+ *
518
+ * AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.
519
+ *
520
+ * optional filtering parameters allowed are
521
+ * - username: The username of the user for which this image was stored.
522
+ * - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
523
+ * - model: the text to image model on the provider used to generate the image.
524
+ *
525
+ * This endpoint is accessible to both students and platform admins.
526
+ * @param id A unique integer value identifying this ai generated image.
527
+ * @param org
528
+ * @param userId
529
+ * @returns void
530
+ * @throws ApiError
531
+ */
532
+ static aiMentorOrgsUsersAiGeneratedImagesDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
533
+ /**
534
+ * Retrieve assumed knowledge levels.
535
+ *
536
+ * Args:
537
+ * request: The HTTP request.
538
+ * org: The organization/tenant identifier.
539
+ * user_id: The ID of the user to retrieve assumed knowledge for.
540
+ *
541
+ * Returns:
542
+ * Response: The assumed knowledge levels for different categories.
543
+ *
544
+ * Raises:
545
+ * NotFound: If no assumed knowledge exists for the user.
546
+ * @param org
547
+ * @param userId
548
+ * @returns AssumedKnowledge
549
+ * @throws ApiError
550
+ */
551
+ static aiMentorOrgsUsersAssumedKnowledgeRetrieve(org: string, userId: string): CancelablePromise<AssumedKnowledge>;
552
+ /**
553
+ * Update assumed knowledge levels.
554
+ *
555
+ * Args:
556
+ * request: The HTTP request containing the updated knowledge levels.
557
+ * org: The organization/tenant identifier.
558
+ * user_id: The ID of the user to update assumed knowledge for.
559
+ *
560
+ * Returns:
561
+ * Response: The updated assumed knowledge levels.
562
+ *
563
+ * Raises:
564
+ * BadRequest: If the provided data is invalid.
565
+ * @param org
566
+ * @param userId
567
+ * @param requestBody
568
+ * @returns AssumedKnowledge
569
+ * @throws ApiError
570
+ */
571
+ static aiMentorOrgsUsersAssumedKnowledgeCreate(org: string, userId: string, requestBody: AssumedKnowledge): CancelablePromise<AssumedKnowledge>;
572
+ /**
573
+ * Convert an uploaded audio file to text.
574
+ *
575
+ * Args:
576
+ * request: The HTTP request containing the audio file.
577
+ * org: The organization/tenant identifier.
578
+ * user_id: The ID of the user uploading the audio.
579
+ *
580
+ * Returns:
581
+ * Response: The transcribed text from the audio file.
582
+ *
583
+ * Raises:
584
+ * BadRequest: If the audio file is invalid or cannot be processed.
585
+ * NotFound: If the API key for the tenant is not found.
586
+ * @param org
587
+ * @param userId
588
+ * @param requestBody
589
+ * @returns AudioToTextResponse
590
+ * @throws ApiError
591
+ */
592
+ static aiMentorOrgsUsersAudioToTextCreate(org: string, userId: string, requestBody: AudioToTextRequest): CancelablePromise<AudioToTextResponse>;
593
+ /**
594
+ * This endpoint list available template mentors for a tenant
595
+ *
596
+ * Returns:
597
+ *
598
+ * 200 : List of Tool objects
599
+ * @param org
600
+ * @param userId
601
+ * @returns TemplateMentor
602
+ * @throws ApiError
603
+ */
604
+ static aiMentorOrgsUsersAvailableTemplateMentorsRetrieve(org: string, userId: string): CancelablePromise<TemplateMentor>;
605
+ /**
606
+ * Retrieve a list of Mentor Category Groups.
607
+ * @param org
608
+ * @param userId
609
+ * @param audience
610
+ * @param audienceName
611
+ * @param ordering Which field to use when ordering the results.
612
+ * @param search A search term.
613
+ * @returns MentorCategoryGroup
614
+ * @throws ApiError
615
+ */
616
+ static aiMentorOrgsUsersCategoryGroupsList(org: string, userId: string, audience?: number, audienceName?: string, ordering?: string, search?: string): CancelablePromise<Array<MentorCategoryGroup>>;
617
+ /**
618
+ * Create a new Mentor Category Group. Only accessible to Platform Admins.
619
+ * @param org
620
+ * @param userId
621
+ * @param requestBody
622
+ * @returns MentorCategoryGroup
623
+ * @throws ApiError
624
+ */
625
+ static aiMentorOrgsUsersCategoryGroupsCreate(org: string, userId: string, requestBody: MentorCategoryGroupCreate): CancelablePromise<MentorCategoryGroup>;
626
+ /**
627
+ * Mentor Category Groups offer parent grouping for mentor category objects.
628
+ *
629
+ * The parameter `audience` is deprecated and is currently left behind for backward compatibility.
630
+ *
631
+ * Permissions:
632
+ * GET: Accessible to both Platform Admins and Students
633
+ * POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
634
+ * @param id A unique integer value identifying this mentor category group.
635
+ * @param org
636
+ * @param userId
637
+ * @returns MentorCategoryGroup
638
+ * @throws ApiError
639
+ */
640
+ static aiMentorOrgsUsersCategoryGroupsRetrieve(id: number, org: string, userId: string): CancelablePromise<MentorCategoryGroup>;
641
+ /**
642
+ * Mentor Category Groups offer parent grouping for mentor category objects.
643
+ *
644
+ * The parameter `audience` is deprecated and is currently left behind for backward compatibility.
645
+ *
646
+ * Permissions:
647
+ * GET: Accessible to both Platform Admins and Students
648
+ * POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
649
+ * @param id A unique integer value identifying this mentor category group.
650
+ * @param org
651
+ * @param userId
652
+ * @param requestBody
653
+ * @returns MentorCategoryGroupCreate
654
+ * @throws ApiError
655
+ */
656
+ static aiMentorOrgsUsersCategoryGroupsUpdate(id: number, org: string, userId: string, requestBody: MentorCategoryGroupCreate): CancelablePromise<MentorCategoryGroupCreate>;
657
+ /**
658
+ * Mentor Category Groups offer parent grouping for mentor category objects.
659
+ *
660
+ * The parameter `audience` is deprecated and is currently left behind for backward compatibility.
661
+ *
662
+ * Permissions:
663
+ * GET: Accessible to both Platform Admins and Students
664
+ * POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
665
+ * @param id A unique integer value identifying this mentor category group.
666
+ * @param org
667
+ * @param userId
668
+ * @param requestBody
669
+ * @returns MentorCategoryGroupCreate
670
+ * @throws ApiError
671
+ */
672
+ static aiMentorOrgsUsersCategoryGroupsPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedMentorCategoryGroupCreate): CancelablePromise<MentorCategoryGroupCreate>;
673
+ /**
674
+ * Mentor Category Groups offer parent grouping for mentor category objects.
675
+ *
676
+ * The parameter `audience` is deprecated and is currently left behind for backward compatibility.
677
+ *
678
+ * Permissions:
679
+ * GET: Accessible to both Platform Admins and Students
680
+ * POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
681
+ * @param id A unique integer value identifying this mentor category group.
682
+ * @param org
683
+ * @param userId
684
+ * @returns void
685
+ * @throws ApiError
686
+ */
687
+ static aiMentorOrgsUsersCategoryGroupsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
688
+ /**
689
+ * Retrieve and clean up vector results from a specific session.
690
+ *
691
+ * This endpoint retrieves the documents last used by the mentor to answer
692
+ * the most recent query from the user in the specified session, and cleans
693
+ * them to remove any inappropriate content.
694
+ *
695
+ * Args:
696
+ * request: The HTTP request.
697
+ * org: The organization/tenant identifier.
698
+ * user_id: The ID of the user making the request.
699
+ * session_id: The ID of the session to retrieve vector results from.
700
+ *
701
+ * Returns:
702
+ * Response: The cleaned vector results.
703
+ *
704
+ * Raises:
705
+ * BadRequest: If the API key for the cleaning provider is not found.
706
+ * NotFound: If no vector results are found for the session.
707
+ * @param org
708
+ * @param sessionId
709
+ * @param userId
710
+ * @returns VectorResult
711
+ * @throws ApiError
712
+ */
713
+ static aiMentorOrgsUsersCleanVectorResultsList(org: string, sessionId: string, userId: string): CancelablePromise<Array<VectorResult>>;
714
+ /**
715
+ * Clean up provided vector results.
716
+ *
717
+ * This endpoint allows users to submit specific vector results for cleaning,
718
+ * which is useful when there are particular documents that need to be processed.
719
+ *
720
+ * Args:
721
+ * request: The HTTP request containing the vector results to clean.
722
+ * org: The organization/tenant identifier.
723
+ * user_id: The ID of the user making the request.
724
+ *
725
+ * Returns:
726
+ * Response: The cleaned vector results.
727
+ *
728
+ * Raises:
729
+ * BadRequest: If the API key for the cleaning provider is not found or the provided data is invalid.
730
+ * @param org
731
+ * @param sessionId
732
+ * @param userId
733
+ * @param requestBody
734
+ * @returns VectorResult
735
+ * @throws ApiError
736
+ */
737
+ static aiMentorOrgsUsersCleanVectorResultsCreate(org: string, sessionId: string, userId: string, requestBody: Array<VectorResult>): CancelablePromise<Array<VectorResult>>;
738
+ /**
739
+ * Delete User Chat History
740
+ * Endpoint to clear a user's chat history.
741
+ * @param org
742
+ * @param userId
743
+ * @returns void
744
+ * @throws ApiError
745
+ */
746
+ static aiMentorOrgsUsersClearChathistoryDestroy(org: string, userId: string): CancelablePromise<void>;
747
+ /**
748
+ * Endpoint to fetch update and delete files associated with course creation tasks.
749
+ * @param org
750
+ * @param userId
751
+ * @param page A page number within the paginated result set.
752
+ * @param pageSize Number of results to return per page.
753
+ * @returns PaginatedCourseCreationTaskFileList
754
+ * @throws ApiError
755
+ */
756
+ static aiMentorOrgsUsersCourseCreationTaskFilesList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskFileList>;
757
+ /**
758
+ * Endpoint to fetch update and delete files associated with course creation tasks.
759
+ * @param org
760
+ * @param userId
761
+ * @param requestBody
762
+ * @returns CourseCreationTaskFile
763
+ * @throws ApiError
764
+ */
765
+ static aiMentorOrgsUsersCourseCreationTaskFilesCreate(org: string, userId: string, requestBody: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
766
+ /**
767
+ * Endpoint to fetch update and delete files associated with course creation tasks.
768
+ * @param id A unique integer value identifying this course creation task file.
769
+ * @param org
770
+ * @param userId
771
+ * @returns CourseCreationTaskFile
772
+ * @throws ApiError
773
+ */
774
+ static aiMentorOrgsUsersCourseCreationTaskFilesRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTaskFile>;
775
+ /**
776
+ * Endpoint to fetch update and delete files associated with course creation tasks.
777
+ * @param id A unique integer value identifying this course creation task file.
778
+ * @param org
779
+ * @param userId
780
+ * @param requestBody
781
+ * @returns CourseCreationTaskFile
782
+ * @throws ApiError
783
+ */
784
+ static aiMentorOrgsUsersCourseCreationTaskFilesUpdate(id: number, org: string, userId: string, requestBody: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
785
+ /**
786
+ * Endpoint to fetch update and delete files associated with course creation tasks.
787
+ * @param id A unique integer value identifying this course creation task file.
788
+ * @param org
789
+ * @param userId
790
+ * @param requestBody
791
+ * @returns CourseCreationTaskFile
792
+ * @throws ApiError
793
+ */
794
+ static aiMentorOrgsUsersCourseCreationTaskFilesPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedCourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
795
+ /**
796
+ * Endpoint to fetch update and delete files associated with course creation tasks.
797
+ * @param id A unique integer value identifying this course creation task file.
798
+ * @param org
799
+ * @param userId
800
+ * @returns void
801
+ * @throws ApiError
802
+ */
803
+ static aiMentorOrgsUsersCourseCreationTaskFilesDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
804
+ /**
805
+ * Create, retrieve and delete course creation tasks
806
+ *
807
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
808
+ *
809
+ * The course is created entirely by an ai model (as specified in your inputs).
810
+ *
811
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
812
+ * Bigger and newer models tend to outperform smaller once.
813
+ *
814
+ * Clear and unambiguous parameters are more likely to produce better results.
815
+ * @param org
816
+ * @param userId
817
+ * @param page A page number within the paginated result set.
818
+ * @param pageSize Number of results to return per page.
819
+ * @returns PaginatedCourseCreationTaskList
820
+ * @throws ApiError
821
+ */
822
+ static aiMentorOrgsUsersCourseCreationTasksList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskList>;
823
+ /**
824
+ * Create, retrieve and delete course creation tasks
825
+ *
826
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
827
+ *
828
+ * The course is created entirely by an ai model (as specified in your inputs).
829
+ *
830
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
831
+ * Bigger and newer models tend to outperform smaller once.
832
+ *
833
+ * Clear and unambiguous parameters are more likely to produce better results.
834
+ * @param org
835
+ * @param userId
836
+ * @param requestBody
837
+ * @returns CourseCreationTask
838
+ * @throws ApiError
839
+ */
840
+ static aiMentorOrgsUsersCourseCreationTasksCreate(org: string, userId: string, requestBody: CourseCreationTask): CancelablePromise<CourseCreationTask>;
841
+ /**
842
+ * Create, retrieve and delete course creation tasks
843
+ *
844
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
845
+ *
846
+ * The course is created entirely by an ai model (as specified in your inputs).
847
+ *
848
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
849
+ * Bigger and newer models tend to outperform smaller once.
850
+ *
851
+ * Clear and unambiguous parameters are more likely to produce better results.
852
+ * @param id A unique integer value identifying this course creation task.
853
+ * @param org
854
+ * @param userId
855
+ * @returns CourseCreationTask
856
+ * @throws ApiError
857
+ */
858
+ static aiMentorOrgsUsersCourseCreationTasksRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
859
+ /**
860
+ * Create, retrieve and delete course creation tasks
861
+ *
862
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
863
+ *
864
+ * The course is created entirely by an ai model (as specified in your inputs).
865
+ *
866
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
867
+ * Bigger and newer models tend to outperform smaller once.
868
+ *
869
+ * Clear and unambiguous parameters are more likely to produce better results.
870
+ * @param id A unique integer value identifying this course creation task.
871
+ * @param org
872
+ * @param userId
873
+ * @returns void
874
+ * @throws ApiError
875
+ */
876
+ static aiMentorOrgsUsersCourseCreationTasksDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
877
+ /**
878
+ * Cancel a course creation task run.
879
+ * ** Conditions Required **:
880
+ * The task must be running or pending.
881
+ * ** Response **:
882
+ * - 200: The course creation task is successfully cancelled.
883
+ * - 400: The course creation task is not in a running or pending state.
884
+ * @param id A unique integer value identifying this course creation task.
885
+ * @param org
886
+ * @param userId
887
+ * @returns CourseCreationTask
888
+ * @throws ApiError
889
+ */
890
+ static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
891
+ /**
892
+ * This is intended for stepwise approach of course creation.
893
+ *
894
+ * Use this to intiate generating an outline of the course.
895
+ * @param id A unique integer value identifying this course creation task.
896
+ * @param org
897
+ * @param userId
898
+ * @returns FullCourse
899
+ * @throws ApiError
900
+ */
901
+ static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve(id: number, org: string, userId: string): CancelablePromise<FullCourse>;
902
+ /**
903
+ * This is intended for stepwise approach of course creation.
904
+ *
905
+ * Use this to intiate generating an outline of the course.
906
+ * @param id A unique integer value identifying this course creation task.
907
+ * @param org
908
+ * @param userId
909
+ * @param requestBody
910
+ * @returns FullCourse
911
+ * @throws ApiError
912
+ */
913
+ static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate(id: number, org: string, userId: string, requestBody: CourseCreationTask): CancelablePromise<FullCourse>;
914
+ /**
915
+ * Kick start the course creation task.
916
+ * This endpoint should be called once the files for a course creation task has
917
+ * been successfully uploaded.
918
+ *
919
+ * ** Conditions Required **:
920
+ * - The course creation task must be in a pending state or failed state.
921
+ *
922
+ * ** Response **:
923
+ * - 200: The course creation task is successfully started.
924
+ * - 400: The course creation task is not in a pending state.
925
+ * @param id A unique integer value identifying this course creation task.
926
+ * @param org
927
+ * @param userId
928
+ * @returns CourseCreationTask
929
+ * @throws ApiError
930
+ */
931
+ static aiMentorOrgsUsersCourseCreationTasksStartRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
932
+ /**
933
+ * API viewset for managing course units.
934
+ *
935
+ * This viewset allows platform administrators to retrieve and manage
936
+ * units within course subsections, and generate content for them.
937
+ *
938
+ * Permissions:
939
+ * - Restricted to platform administrators only
940
+ * @param org
941
+ * @param userId
942
+ * @param course
943
+ * @param ordering Which field to use when ordering the results.
944
+ * @param page A page number within the paginated result set.
945
+ * @param pageSize Number of results to return per page.
946
+ * @param search A search term.
947
+ * @param section
948
+ * @param subsection
949
+ * @param task
950
+ * @returns PaginatedUnitList
951
+ * @throws ApiError
952
+ */
953
+ static aiMentorOrgsUsersCourseCreationComponentList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, section?: number, subsection?: number, task?: number): CancelablePromise<PaginatedUnitList>;
954
+ /**
955
+ * API viewset for managing course units.
956
+ *
957
+ * This viewset allows platform administrators to retrieve and manage
958
+ * units within course subsections, and generate content for them.
959
+ *
960
+ * Permissions:
961
+ * - Restricted to platform administrators only
962
+ * @param org
963
+ * @param userId
964
+ * @param requestBody
965
+ * @returns Unit
966
+ * @throws ApiError
967
+ */
968
+ static aiMentorOrgsUsersCourseCreationComponentCreate(org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
969
+ /**
970
+ * API viewset for managing course units.
971
+ *
972
+ * This viewset allows platform administrators to retrieve and manage
973
+ * units within course subsections, and generate content for them.
974
+ *
975
+ * Permissions:
976
+ * - Restricted to platform administrators only
977
+ * @param id A unique integer value identifying this unit.
978
+ * @param org
979
+ * @param userId
980
+ * @returns Unit
981
+ * @throws ApiError
982
+ */
983
+ static aiMentorOrgsUsersCourseCreationComponentRetrieve(id: number, org: string, userId: string): CancelablePromise<Unit>;
984
+ /**
985
+ * API viewset for managing course units.
986
+ *
987
+ * This viewset allows platform administrators to retrieve and manage
988
+ * units within course subsections, and generate content for them.
989
+ *
990
+ * Permissions:
991
+ * - Restricted to platform administrators only
992
+ * @param id A unique integer value identifying this unit.
993
+ * @param org
994
+ * @param userId
995
+ * @param requestBody
996
+ * @returns Unit
997
+ * @throws ApiError
998
+ */
999
+ static aiMentorOrgsUsersCourseCreationComponentUpdate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
1000
+ /**
1001
+ * API viewset for managing course units.
1002
+ *
1003
+ * This viewset allows platform administrators to retrieve and manage
1004
+ * units within course subsections, and generate content for them.
1005
+ *
1006
+ * Permissions:
1007
+ * - Restricted to platform administrators only
1008
+ * @param id A unique integer value identifying this unit.
1009
+ * @param org
1010
+ * @param userId
1011
+ * @param requestBody
1012
+ * @returns Unit
1013
+ * @throws ApiError
1014
+ */
1015
+ static aiMentorOrgsUsersCourseCreationComponentPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedUnit): CancelablePromise<Unit>;
1016
+ /**
1017
+ * API viewset for managing course units.
1018
+ *
1019
+ * This viewset allows platform administrators to retrieve and manage
1020
+ * units within course subsections, and generate content for them.
1021
+ *
1022
+ * Permissions:
1023
+ * - Restricted to platform administrators only
1024
+ * @param id A unique integer value identifying this unit.
1025
+ * @param org
1026
+ * @param userId
1027
+ * @returns void
1028
+ * @throws ApiError
1029
+ */
1030
+ static aiMentorOrgsUsersCourseCreationComponentDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1031
+ /**
1032
+ * Generate draft content for a specific unit.
1033
+ *
1034
+ * This action starts a background task to create draft content
1035
+ * for the specified unit using AI.
1036
+ *
1037
+ * Args:
1038
+ * request: The HTTP request.
1039
+ * pk: The primary key of the unit to generate content for.
1040
+ *
1041
+ * Returns:
1042
+ * Response: A confirmation that the content generation task has been started.
1043
+ *
1044
+ * Raises:
1045
+ * NotFound: If the specified unit does not exist.
1046
+ * @param id A unique integer value identifying this unit.
1047
+ * @param org
1048
+ * @param userId
1049
+ * @returns any Content creation started successfully
1050
+ * @throws ApiError
1051
+ */
1052
+ static aiMentorOrgsUsersCourseCreationComponentDraftContentRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1053
+ /**
1054
+ * Generate draft content for a specific unit.
1055
+ *
1056
+ * This action starts a background task to create draft content
1057
+ * for the specified unit using AI.
1058
+ *
1059
+ * Args:
1060
+ * request: The HTTP request.
1061
+ * pk: The primary key of the unit to generate content for.
1062
+ *
1063
+ * Returns:
1064
+ * Response: A confirmation that the content generation task has been started.
1065
+ *
1066
+ * Raises:
1067
+ * NotFound: If the specified unit does not exist.
1068
+ * @param id A unique integer value identifying this unit.
1069
+ * @param org
1070
+ * @param userId
1071
+ * @param requestBody
1072
+ * @returns any Content creation started successfully
1073
+ * @throws ApiError
1074
+ */
1075
+ static aiMentorOrgsUsersCourseCreationComponentDraftContentCreate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<any>;
1076
+ /**
1077
+ * API viewset for managing EdX courses.
1078
+ *
1079
+ * This viewset allows platform administrators to retrieve, delete, and
1080
+ * perform various operations on EdX courses that were created through
1081
+ * course creation tasks.
1082
+ *
1083
+ * Permissions:
1084
+ * - Restricted to platform administrators only
1085
+ * @param org
1086
+ * @param userId
1087
+ * @param ordering Which field to use when ordering the results.
1088
+ * @param page A page number within the paginated result set.
1089
+ * @param pageSize Number of results to return per page.
1090
+ * @param search A search term.
1091
+ * @param task
1092
+ * @returns PaginatedEdxCourseList
1093
+ * @throws ApiError
1094
+ */
1095
+ static aiMentorOrgsUsersCourseCreationCourseList(org: string, userId: string, ordering?: string, page?: number, pageSize?: number, search?: string, task?: number): CancelablePromise<PaginatedEdxCourseList>;
1096
+ /**
1097
+ * API viewset for managing EdX courses.
1098
+ *
1099
+ * This viewset allows platform administrators to retrieve, delete, and
1100
+ * perform various operations on EdX courses that were created through
1101
+ * course creation tasks.
1102
+ *
1103
+ * Permissions:
1104
+ * - Restricted to platform administrators only
1105
+ * @param id A unique integer value identifying this edx course.
1106
+ * @param org
1107
+ * @param userId
1108
+ * @returns EdxCourse
1109
+ * @throws ApiError
1110
+ */
1111
+ static aiMentorOrgsUsersCourseCreationCourseRetrieve(id: number, org: string, userId: string): CancelablePromise<EdxCourse>;
1112
+ /**
1113
+ * API viewset for managing EdX courses.
1114
+ *
1115
+ * This viewset allows platform administrators to retrieve, delete, and
1116
+ * perform various operations on EdX courses that were created through
1117
+ * course creation tasks.
1118
+ *
1119
+ * Permissions:
1120
+ * - Restricted to platform administrators only
1121
+ * @param id A unique integer value identifying this edx course.
1122
+ * @param org
1123
+ * @param userId
1124
+ * @returns void
1125
+ * @throws ApiError
1126
+ */
1127
+ static aiMentorOrgsUsersCourseCreationCourseDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1128
+ /**
1129
+ * Generate draft content for all units in a course.
1130
+ *
1131
+ * This action starts a background task to create draft content
1132
+ * for all units in the course using AI.
1133
+ *
1134
+ * Args:
1135
+ * request: The HTTP request.
1136
+ * pk: The primary key of the course to generate content for.
1137
+ *
1138
+ * Returns:
1139
+ * Response: A confirmation that the content generation task has been started.
1140
+ *
1141
+ * Raises:
1142
+ * NotFound: If the specified course does not exist.
1143
+ * @param id A unique integer value identifying this edx course.
1144
+ * @param org
1145
+ * @param userId
1146
+ * @returns any Content creation started successfully
1147
+ * @throws ApiError
1148
+ */
1149
+ static aiMentorOrgsUsersCourseCreationCourseDraftContentForAllUnitsRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1150
+ /**
1151
+ * Retrieve the full structure of a course.
1152
+ *
1153
+ * This action returns the complete hierarchical structure of the course,
1154
+ * including all sections, subsections, units, and components.
1155
+ *
1156
+ * Args:
1157
+ * request: The HTTP request.
1158
+ * pk: The primary key of the course to retrieve.
1159
+ *
1160
+ * Returns:
1161
+ * Response: The full structure of the course.
1162
+ *
1163
+ * Raises:
1164
+ * NotFound: If the specified course does not exist.
1165
+ * @param id A unique integer value identifying this edx course.
1166
+ * @param org
1167
+ * @param userId
1168
+ * @returns FullCourse
1169
+ * @throws ApiError
1170
+ */
1171
+ static aiMentorOrgsUsersCourseCreationCourseFullStructureRetrieve(id: number, org: string, userId: string): CancelablePromise<FullCourse>;
1172
+ /**
1173
+ * Load existing course structure from OpenEdX.
1174
+ *
1175
+ * This action starts a background task to pull the course structure
1176
+ * from the EdX platform into the database.
1177
+ *
1178
+ * Args:
1179
+ * request: The HTTP request.
1180
+ * pk: The primary key of the course to load.
1181
+ *
1182
+ * Returns:
1183
+ * Response: A confirmation that the load task has been started.
1184
+ *
1185
+ * Raises:
1186
+ * NotFound: If the specified course does not exist.
1187
+ * @param id A unique integer value identifying this edx course.
1188
+ * @param org
1189
+ * @param userId
1190
+ * @returns any Course load started successfully
1191
+ * @throws ApiError
1192
+ */
1193
+ static aiMentorOrgsUsersCourseCreationCourseLoadFromEdxRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1194
+ /**
1195
+ * Synchronize the course structure to EdX.
1196
+ *
1197
+ * This action starts a background task to push the course structure
1198
+ * from the database to the EdX platform.
1199
+ *
1200
+ * Args:
1201
+ * request: The HTTP request.
1202
+ * pk: The primary key of the course to synchronize.
1203
+ *
1204
+ * Returns:
1205
+ * Response: A confirmation that the sync task has been started.
1206
+ *
1207
+ * Raises:
1208
+ * NotFound: If the specified course does not exist.
1209
+ * @param id A unique integer value identifying this edx course.
1210
+ * @param org
1211
+ * @param userId
1212
+ * @returns any Course sync started successfully
1213
+ * @throws ApiError
1214
+ */
1215
+ static aiMentorOrgsUsersCourseCreationCourseSyncToEdxRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1216
+ /**
1217
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1218
+ * @param org
1219
+ * @param userId
1220
+ * @param page A page number within the paginated result set.
1221
+ * @param pageSize Number of results to return per page.
1222
+ * @returns PaginatedCourseCreationTaskFileList
1223
+ * @throws ApiError
1224
+ */
1225
+ static aiMentorOrgsUsersCourseCreationFilesList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskFileList>;
1226
+ /**
1227
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1228
+ * @param org
1229
+ * @param userId
1230
+ * @param requestBody
1231
+ * @returns CourseCreationTaskFile
1232
+ * @throws ApiError
1233
+ */
1234
+ static aiMentorOrgsUsersCourseCreationFilesCreate(org: string, userId: string, requestBody: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
1235
+ /**
1236
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1237
+ * @param id A unique integer value identifying this course creation task file.
1238
+ * @param org
1239
+ * @param userId
1240
+ * @returns CourseCreationTaskFile
1241
+ * @throws ApiError
1242
+ */
1243
+ static aiMentorOrgsUsersCourseCreationFilesRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTaskFile>;
1244
+ /**
1245
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1246
+ * @param id A unique integer value identifying this course creation task file.
1247
+ * @param org
1248
+ * @param userId
1249
+ * @param requestBody
1250
+ * @returns CourseCreationTaskFile
1251
+ * @throws ApiError
1252
+ */
1253
+ static aiMentorOrgsUsersCourseCreationFilesUpdate(id: number, org: string, userId: string, requestBody: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
1254
+ /**
1255
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1256
+ * @param id A unique integer value identifying this course creation task file.
1257
+ * @param org
1258
+ * @param userId
1259
+ * @param requestBody
1260
+ * @returns CourseCreationTaskFile
1261
+ * @throws ApiError
1262
+ */
1263
+ static aiMentorOrgsUsersCourseCreationFilesPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedCourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
1264
+ /**
1265
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1266
+ * @param id A unique integer value identifying this course creation task file.
1267
+ * @param org
1268
+ * @param userId
1269
+ * @returns void
1270
+ * @throws ApiError
1271
+ */
1272
+ static aiMentorOrgsUsersCourseCreationFilesDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1273
+ /**
1274
+ * API viewset for managing course sections.
1275
+ *
1276
+ * This viewset allows platform administrators to retrieve and manage
1277
+ * sections within EdX courses.
1278
+ *
1279
+ * Permissions:
1280
+ * - Restricted to platform administrators only
1281
+ * @param org
1282
+ * @param userId
1283
+ * @param course
1284
+ * @param ordering Which field to use when ordering the results.
1285
+ * @param page A page number within the paginated result set.
1286
+ * @param pageSize Number of results to return per page.
1287
+ * @param search A search term.
1288
+ * @param task
1289
+ * @returns PaginatedSectionList
1290
+ * @throws ApiError
1291
+ */
1292
+ static aiMentorOrgsUsersCourseCreationSectionList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, task?: number): CancelablePromise<PaginatedSectionList>;
1293
+ /**
1294
+ * API viewset for managing course sections.
1295
+ *
1296
+ * This viewset allows platform administrators to retrieve and manage
1297
+ * sections within EdX courses.
1298
+ *
1299
+ * Permissions:
1300
+ * - Restricted to platform administrators only
1301
+ * @param org
1302
+ * @param userId
1303
+ * @param requestBody
1304
+ * @returns Section
1305
+ * @throws ApiError
1306
+ */
1307
+ static aiMentorOrgsUsersCourseCreationSectionCreate(org: string, userId: string, requestBody: Section): CancelablePromise<Section>;
1308
+ /**
1309
+ * API viewset for managing course sections.
1310
+ *
1311
+ * This viewset allows platform administrators to retrieve and manage
1312
+ * sections within EdX courses.
1313
+ *
1314
+ * Permissions:
1315
+ * - Restricted to platform administrators only
1316
+ * @param id A unique integer value identifying this section.
1317
+ * @param org
1318
+ * @param userId
1319
+ * @returns Section
1320
+ * @throws ApiError
1321
+ */
1322
+ static aiMentorOrgsUsersCourseCreationSectionRetrieve(id: number, org: string, userId: string): CancelablePromise<Section>;
1323
+ /**
1324
+ * API viewset for managing course sections.
1325
+ *
1326
+ * This viewset allows platform administrators to retrieve and manage
1327
+ * sections within EdX courses.
1328
+ *
1329
+ * Permissions:
1330
+ * - Restricted to platform administrators only
1331
+ * @param id A unique integer value identifying this section.
1332
+ * @param org
1333
+ * @param userId
1334
+ * @param requestBody
1335
+ * @returns Section
1336
+ * @throws ApiError
1337
+ */
1338
+ static aiMentorOrgsUsersCourseCreationSectionUpdate(id: number, org: string, userId: string, requestBody: Section): CancelablePromise<Section>;
1339
+ /**
1340
+ * API viewset for managing course sections.
1341
+ *
1342
+ * This viewset allows platform administrators to retrieve and manage
1343
+ * sections within EdX courses.
1344
+ *
1345
+ * Permissions:
1346
+ * - Restricted to platform administrators only
1347
+ * @param id A unique integer value identifying this section.
1348
+ * @param org
1349
+ * @param userId
1350
+ * @param requestBody
1351
+ * @returns Section
1352
+ * @throws ApiError
1353
+ */
1354
+ static aiMentorOrgsUsersCourseCreationSectionPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedSection): CancelablePromise<Section>;
1355
+ /**
1356
+ * API viewset for managing course sections.
1357
+ *
1358
+ * This viewset allows platform administrators to retrieve and manage
1359
+ * sections within EdX courses.
1360
+ *
1361
+ * Permissions:
1362
+ * - Restricted to platform administrators only
1363
+ * @param id A unique integer value identifying this section.
1364
+ * @param org
1365
+ * @param userId
1366
+ * @returns void
1367
+ * @throws ApiError
1368
+ */
1369
+ static aiMentorOrgsUsersCourseCreationSectionDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1370
+ /**
1371
+ * API viewset for managing course subsections.
1372
+ *
1373
+ * This viewset allows platform administrators to retrieve and manage
1374
+ * subsections within course sections.
1375
+ *
1376
+ * Permissions:
1377
+ * - Restricted to platform administrators only
1378
+ * @param org
1379
+ * @param userId
1380
+ * @param course
1381
+ * @param ordering Which field to use when ordering the results.
1382
+ * @param page A page number within the paginated result set.
1383
+ * @param pageSize Number of results to return per page.
1384
+ * @param search A search term.
1385
+ * @param section
1386
+ * @param task
1387
+ * @returns PaginatedSubSectionList
1388
+ * @throws ApiError
1389
+ */
1390
+ static aiMentorOrgsUsersCourseCreationSubsectionList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, section?: number, task?: number): CancelablePromise<PaginatedSubSectionList>;
1391
+ /**
1392
+ * API viewset for managing course subsections.
1393
+ *
1394
+ * This viewset allows platform administrators to retrieve and manage
1395
+ * subsections within course sections.
1396
+ *
1397
+ * Permissions:
1398
+ * - Restricted to platform administrators only
1399
+ * @param org
1400
+ * @param userId
1401
+ * @param requestBody
1402
+ * @returns SubSection
1403
+ * @throws ApiError
1404
+ */
1405
+ static aiMentorOrgsUsersCourseCreationSubsectionCreate(org: string, userId: string, requestBody: SubSection): CancelablePromise<SubSection>;
1406
+ /**
1407
+ * API viewset for managing course subsections.
1408
+ *
1409
+ * This viewset allows platform administrators to retrieve and manage
1410
+ * subsections within course sections.
1411
+ *
1412
+ * Permissions:
1413
+ * - Restricted to platform administrators only
1414
+ * @param id A unique integer value identifying this sub section.
1415
+ * @param org
1416
+ * @param userId
1417
+ * @returns SubSection
1418
+ * @throws ApiError
1419
+ */
1420
+ static aiMentorOrgsUsersCourseCreationSubsectionRetrieve(id: number, org: string, userId: string): CancelablePromise<SubSection>;
1421
+ /**
1422
+ * API viewset for managing course subsections.
1423
+ *
1424
+ * This viewset allows platform administrators to retrieve and manage
1425
+ * subsections within course sections.
1426
+ *
1427
+ * Permissions:
1428
+ * - Restricted to platform administrators only
1429
+ * @param id A unique integer value identifying this sub section.
1430
+ * @param org
1431
+ * @param userId
1432
+ * @param requestBody
1433
+ * @returns SubSection
1434
+ * @throws ApiError
1435
+ */
1436
+ static aiMentorOrgsUsersCourseCreationSubsectionUpdate(id: number, org: string, userId: string, requestBody: SubSection): CancelablePromise<SubSection>;
1437
+ /**
1438
+ * API viewset for managing course subsections.
1439
+ *
1440
+ * This viewset allows platform administrators to retrieve and manage
1441
+ * subsections within course sections.
1442
+ *
1443
+ * Permissions:
1444
+ * - Restricted to platform administrators only
1445
+ * @param id A unique integer value identifying this sub section.
1446
+ * @param org
1447
+ * @param userId
1448
+ * @param requestBody
1449
+ * @returns SubSection
1450
+ * @throws ApiError
1451
+ */
1452
+ static aiMentorOrgsUsersCourseCreationSubsectionPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedSubSection): CancelablePromise<SubSection>;
1453
+ /**
1454
+ * API viewset for managing course subsections.
1455
+ *
1456
+ * This viewset allows platform administrators to retrieve and manage
1457
+ * subsections within course sections.
1458
+ *
1459
+ * Permissions:
1460
+ * - Restricted to platform administrators only
1461
+ * @param id A unique integer value identifying this sub section.
1462
+ * @param org
1463
+ * @param userId
1464
+ * @returns void
1465
+ * @throws ApiError
1466
+ */
1467
+ static aiMentorOrgsUsersCourseCreationSubsectionDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1468
+ /**
1469
+ * Create, retrieve and delete course creation tasks
1470
+ *
1471
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
1472
+ *
1473
+ * The course is created entirely by an ai model (as specified in your inputs).
1474
+ *
1475
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
1476
+ * Bigger and newer models tend to outperform smaller once.
1477
+ *
1478
+ * Clear and unambiguous parameters are more likely to produce better results.
1479
+ * @param org
1480
+ * @param userId
1481
+ * @param page A page number within the paginated result set.
1482
+ * @param pageSize Number of results to return per page.
1483
+ * @returns PaginatedCourseCreationTaskList
1484
+ * @throws ApiError
1485
+ */
1486
+ static aiMentorOrgsUsersCourseCreationTasksList2(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskList>;
1487
+ /**
1488
+ * Create, retrieve and delete course creation tasks
1489
+ *
1490
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
1491
+ *
1492
+ * The course is created entirely by an ai model (as specified in your inputs).
1493
+ *
1494
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
1495
+ * Bigger and newer models tend to outperform smaller once.
1496
+ *
1497
+ * Clear and unambiguous parameters are more likely to produce better results.
1498
+ * @param org
1499
+ * @param userId
1500
+ * @param requestBody
1501
+ * @returns CourseCreationTask
1502
+ * @throws ApiError
1503
+ */
1504
+ static aiMentorOrgsUsersCourseCreationTasksCreate2(org: string, userId: string, requestBody: CourseCreationTask): CancelablePromise<CourseCreationTask>;
1505
+ /**
1506
+ * Create, retrieve and delete course creation tasks
1507
+ *
1508
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
1509
+ *
1510
+ * The course is created entirely by an ai model (as specified in your inputs).
1511
+ *
1512
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
1513
+ * Bigger and newer models tend to outperform smaller once.
1514
+ *
1515
+ * Clear and unambiguous parameters are more likely to produce better results.
1516
+ * @param id A unique integer value identifying this course creation task.
1517
+ * @param org
1518
+ * @param userId
1519
+ * @returns CourseCreationTask
1520
+ * @throws ApiError
1521
+ */
1522
+ static aiMentorOrgsUsersCourseCreationTasksRetrieve2(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
1523
+ /**
1524
+ * Create, retrieve and delete course creation tasks
1525
+ *
1526
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
1527
+ *
1528
+ * The course is created entirely by an ai model (as specified in your inputs).
1529
+ *
1530
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
1531
+ * Bigger and newer models tend to outperform smaller once.
1532
+ *
1533
+ * Clear and unambiguous parameters are more likely to produce better results.
1534
+ * @param id A unique integer value identifying this course creation task.
1535
+ * @param org
1536
+ * @param userId
1537
+ * @returns void
1538
+ * @throws ApiError
1539
+ */
1540
+ static aiMentorOrgsUsersCourseCreationTasksDestroy2(id: number, org: string, userId: string): CancelablePromise<void>;
1541
+ /**
1542
+ * Cancel a course creation task run.
1543
+ * ** Conditions Required **:
1544
+ * The task must be running or pending.
1545
+ * ** Response **:
1546
+ * - 200: The course creation task is successfully cancelled.
1547
+ * - 400: The course creation task is not in a running or pending state.
1548
+ * @param id A unique integer value identifying this course creation task.
1549
+ * @param org
1550
+ * @param userId
1551
+ * @returns CourseCreationTask
1552
+ * @throws ApiError
1553
+ */
1554
+ static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve2(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
1555
+ /**
1556
+ * This is intended for stepwise approach of course creation.
1557
+ *
1558
+ * Use this to intiate generating an outline of the course.
1559
+ * @param id A unique integer value identifying this course creation task.
1560
+ * @param org
1561
+ * @param userId
1562
+ * @returns FullCourse
1563
+ * @throws ApiError
1564
+ */
1565
+ static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve2(id: number, org: string, userId: string): CancelablePromise<FullCourse>;
1566
+ /**
1567
+ * This is intended for stepwise approach of course creation.
1568
+ *
1569
+ * Use this to intiate generating an outline of the course.
1570
+ * @param id A unique integer value identifying this course creation task.
1571
+ * @param org
1572
+ * @param userId
1573
+ * @param requestBody
1574
+ * @returns FullCourse
1575
+ * @throws ApiError
1576
+ */
1577
+ static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate2(id: number, org: string, userId: string, requestBody: CourseCreationTask): CancelablePromise<FullCourse>;
1578
+ /**
1579
+ * Kick start the course creation task.
1580
+ * This endpoint should be called once the files for a course creation task has
1581
+ * been successfully uploaded.
1582
+ *
1583
+ * ** Conditions Required **:
1584
+ * - The course creation task must be in a pending state or failed state.
1585
+ *
1586
+ * ** Response **:
1587
+ * - 200: The course creation task is successfully started.
1588
+ * - 400: The course creation task is not in a pending state.
1589
+ * @param id A unique integer value identifying this course creation task.
1590
+ * @param org
1591
+ * @param userId
1592
+ * @returns CourseCreationTask
1593
+ * @throws ApiError
1594
+ */
1595
+ static aiMentorOrgsUsersCourseCreationTasksStartRetrieve2(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
1596
+ /**
1597
+ * API viewset for managing course units.
1598
+ *
1599
+ * This viewset allows platform administrators to retrieve and manage
1600
+ * units within course subsections, and generate content for them.
1601
+ *
1602
+ * Permissions:
1603
+ * - Restricted to platform administrators only
1604
+ * @param org
1605
+ * @param userId
1606
+ * @param course
1607
+ * @param ordering Which field to use when ordering the results.
1608
+ * @param page A page number within the paginated result set.
1609
+ * @param pageSize Number of results to return per page.
1610
+ * @param search A search term.
1611
+ * @param section
1612
+ * @param subsection
1613
+ * @param task
1614
+ * @returns PaginatedUnitList
1615
+ * @throws ApiError
1616
+ */
1617
+ static aiMentorOrgsUsersCourseCreationUnitList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, section?: number, subsection?: number, task?: number): CancelablePromise<PaginatedUnitList>;
1618
+ /**
1619
+ * API viewset for managing course units.
1620
+ *
1621
+ * This viewset allows platform administrators to retrieve and manage
1622
+ * units within course subsections, and generate content for them.
1623
+ *
1624
+ * Permissions:
1625
+ * - Restricted to platform administrators only
1626
+ * @param org
1627
+ * @param userId
1628
+ * @param requestBody
1629
+ * @returns Unit
1630
+ * @throws ApiError
1631
+ */
1632
+ static aiMentorOrgsUsersCourseCreationUnitCreate(org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
1633
+ /**
1634
+ * API viewset for managing course units.
1635
+ *
1636
+ * This viewset allows platform administrators to retrieve and manage
1637
+ * units within course subsections, and generate content for them.
1638
+ *
1639
+ * Permissions:
1640
+ * - Restricted to platform administrators only
1641
+ * @param id A unique integer value identifying this unit.
1642
+ * @param org
1643
+ * @param userId
1644
+ * @returns Unit
1645
+ * @throws ApiError
1646
+ */
1647
+ static aiMentorOrgsUsersCourseCreationUnitRetrieve(id: number, org: string, userId: string): CancelablePromise<Unit>;
1648
+ /**
1649
+ * API viewset for managing course units.
1650
+ *
1651
+ * This viewset allows platform administrators to retrieve and manage
1652
+ * units within course subsections, and generate content for them.
1653
+ *
1654
+ * Permissions:
1655
+ * - Restricted to platform administrators only
1656
+ * @param id A unique integer value identifying this unit.
1657
+ * @param org
1658
+ * @param userId
1659
+ * @param requestBody
1660
+ * @returns Unit
1661
+ * @throws ApiError
1662
+ */
1663
+ static aiMentorOrgsUsersCourseCreationUnitUpdate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
1664
+ /**
1665
+ * API viewset for managing course units.
1666
+ *
1667
+ * This viewset allows platform administrators to retrieve and manage
1668
+ * units within course subsections, and generate content for them.
1669
+ *
1670
+ * Permissions:
1671
+ * - Restricted to platform administrators only
1672
+ * @param id A unique integer value identifying this unit.
1673
+ * @param org
1674
+ * @param userId
1675
+ * @param requestBody
1676
+ * @returns Unit
1677
+ * @throws ApiError
1678
+ */
1679
+ static aiMentorOrgsUsersCourseCreationUnitPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedUnit): CancelablePromise<Unit>;
1680
+ /**
1681
+ * API viewset for managing course units.
1682
+ *
1683
+ * This viewset allows platform administrators to retrieve and manage
1684
+ * units within course subsections, and generate content for them.
1685
+ *
1686
+ * Permissions:
1687
+ * - Restricted to platform administrators only
1688
+ * @param id A unique integer value identifying this unit.
1689
+ * @param org
1690
+ * @param userId
1691
+ * @returns void
1692
+ * @throws ApiError
1693
+ */
1694
+ static aiMentorOrgsUsersCourseCreationUnitDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1695
+ /**
1696
+ * Generate draft content for a specific unit.
1697
+ *
1698
+ * This action starts a background task to create draft content
1699
+ * for the specified unit using AI.
1700
+ *
1701
+ * Args:
1702
+ * request: The HTTP request.
1703
+ * pk: The primary key of the unit to generate content for.
1704
+ *
1705
+ * Returns:
1706
+ * Response: A confirmation that the content generation task has been started.
1707
+ *
1708
+ * Raises:
1709
+ * NotFound: If the specified unit does not exist.
1710
+ * @param id A unique integer value identifying this unit.
1711
+ * @param org
1712
+ * @param userId
1713
+ * @returns any Content creation started successfully
1714
+ * @throws ApiError
1715
+ */
1716
+ static aiMentorOrgsUsersCourseCreationUnitDraftContentRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1717
+ /**
1718
+ * Generate draft content for a specific unit.
1719
+ *
1720
+ * This action starts a background task to create draft content
1721
+ * for the specified unit using AI.
1722
+ *
1723
+ * Args:
1724
+ * request: The HTTP request.
1725
+ * pk: The primary key of the unit to generate content for.
1726
+ *
1727
+ * Returns:
1728
+ * Response: A confirmation that the content generation task has been started.
1729
+ *
1730
+ * Raises:
1731
+ * NotFound: If the specified unit does not exist.
1732
+ * @param id A unique integer value identifying this unit.
1733
+ * @param org
1734
+ * @param userId
1735
+ * @param requestBody
1736
+ * @returns any Content creation started successfully
1737
+ * @throws ApiError
1738
+ */
1739
+ static aiMentorOrgsUsersCourseCreationUnitDraftContentCreate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<any>;
1740
+ /**
1741
+ * Create a new mentor using the wizard interface.
1742
+ *
1743
+ * Args:
1744
+ * request: The HTTP request containing the mentor data.
1745
+ * org: The organization/tenant identifier.
1746
+ * user_id: The ID of the user creating the mentor.
1747
+ *
1748
+ * Returns:
1749
+ * Response: The created mentor.
1750
+ *
1751
+ * Raises:
1752
+ * BadRequest: If the provided data is invalid.
1753
+ * @param org
1754
+ * @param userId
1755
+ * @param requestBody
1756
+ * @returns Mentor
1757
+ * @throws ApiError
1758
+ */
1759
+ static aiMentorOrgsUsersCreateMentorWizardCreate(org: string, userId: string, requestBody: MentorWizard): CancelablePromise<Mentor>;
1760
+ /**
1761
+ * Retrieve custom instructions for a specific user.
1762
+ *
1763
+ * Args:
1764
+ * request: The HTTP request.
1765
+ * org: The organization/tenant identifier.
1766
+ * user_id: The ID of the user to retrieve custom instructions for.
1767
+ *
1768
+ * Returns:
1769
+ * Response: The custom instructions for the user.
1770
+ *
1771
+ * Raises:
1772
+ * NotFound: If no custom instructions exist for the user.
1773
+ * @param org
1774
+ * @param userId
1775
+ * @returns CustomInstructionResponse
1776
+ * @throws ApiError
1777
+ */
1778
+ static aiMentorOrgsUsersCustomInstructionRetrieve(org: string, userId: string): CancelablePromise<CustomInstructionResponse>;
1779
+ /**
1780
+ * Create a new custom instruction for a user.
1781
+ *
1782
+ * Args:
1783
+ * request: The HTTP request containing the custom instruction data.
1784
+ * org: The organization/tenant identifier.
1785
+ * user_id: The ID of the user to create custom instructions for.
1786
+ *
1787
+ * Returns:
1788
+ * Response: The created custom instruction.
1789
+ *
1790
+ * Raises:
1791
+ * BadRequest: If the provided data is invalid.
1792
+ * @param org
1793
+ * @param userId
1794
+ * @param requestBody
1795
+ * @returns CustomInstructionResponse
1796
+ * @throws ApiError
1797
+ */
1798
+ static aiMentorOrgsUsersCustomInstructionCreate(org: string, userId: string, requestBody?: CustomInstructionResponse): CancelablePromise<CustomInstructionResponse>;
1799
+ /**
1800
+ * Update an existing custom instruction for a user.
1801
+ *
1802
+ * Args:
1803
+ * request: The HTTP request containing the updated custom instruction data.
1804
+ * org: The organization/tenant identifier.
1805
+ * user_id: The ID of the user to update custom instructions for.
1806
+ *
1807
+ * Returns:
1808
+ * Response: The updated custom instruction.
1809
+ *
1810
+ * Raises:
1811
+ * BadRequest: If the provided data is invalid.
1812
+ * NotFound: If no custom instruction exists for the user.
1813
+ * @param org
1814
+ * @param userId
1815
+ * @param requestBody
1816
+ * @returns CustomInstructionResponse
1817
+ * @throws ApiError
1818
+ */
1819
+ static aiMentorOrgsUsersCustomInstructionUpdate(org: string, userId: string, requestBody?: CustomInstructionResponse): CancelablePromise<CustomInstructionResponse>;
1820
+ /**
1821
+ * Retrieves the chat history for a user if the export task is ready.
1822
+ *
1823
+ * This Endpoint to download user chathistory.
1824
+ *
1825
+ * Accessible to tenant admins and students.
1826
+ *
1827
+ * Returns:
1828
+ *
1829
+ * 200: When task is not ready.
1830
+ *
1831
+ * 200: chat history object
1832
+ *
1833
+ * 400: When data is not valid.
1834
+ * @param org
1835
+ * @param taskId
1836
+ * @param userId
1837
+ * @param toCsv Choose download in csv or not
1838
+ * @returns ChatHistoryItem
1839
+ * @throws ApiError
1840
+ */
1841
+ static aiMentorOrgsUsersDownloadsTasksRetrieve(org: string, taskId: string, userId: string, toCsv?: boolean): CancelablePromise<ChatHistoryItem>;
1842
+ /**
1843
+ * Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
1844
+ * This information is passed to the corresponding mentor so the mentor has context information
1845
+ * about the course and unit that the user last interracted with.
1846
+ *
1847
+ * There can be only one UserEdxMemory instance per student and course_id.
1848
+ *
1849
+ * Url Args:
1850
+ * org (str): The organization's platform key.
1851
+ * user_id (str): The username identifier of the individual.
1852
+ *
1853
+ * Returns:
1854
+ *
1855
+ * 200: A paginated list of UserEdxMemory objects
1856
+ *
1857
+ * Examples:
1858
+ *
1859
+ * - List all memories
1860
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
1861
+ *
1862
+ * Request: None
1863
+ * Response: {
1864
+ * "count": 0,
1865
+ * "next": null,
1866
+ * "previous": null,
1867
+ * "results": [{
1868
+ * "student": 1,
1869
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1870
+ * "data": {},
1871
+ * "date_created": "2024-06-25T15:30:26.257140",
1872
+ * "last_modified": "2024-06-25T15:30:26.257140"
1873
+ * }]
1874
+ * }
1875
+ * - Get a single UserEdxMemory object
1876
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
1877
+ *
1878
+ * Request: None
1879
+ * Response: {
1880
+ * "student": 1,
1881
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1882
+ * "data": {},
1883
+ * "date_created": "2024-06-25T15:30:26.257140",
1884
+ * "last_modified": "2024-06-25T15:30:26.257140"
1885
+ * }
1886
+ * @param org
1887
+ * @param userId
1888
+ * @param courseId
1889
+ * @param ordering Which field to use when ordering the results.
1890
+ * @param page A page number within the paginated result set.
1891
+ * @param pageSize Number of results to return per page.
1892
+ * @param student edX user ID
1893
+ * @param username
1894
+ * @returns PaginatedUserEdxMemoryList
1895
+ * @throws ApiError
1896
+ */
1897
+ static aiMentorOrgsUsersEdxMemoryList(org: string, userId: string, courseId?: string, ordering?: string, page?: number, pageSize?: number, student?: number, username?: string): CancelablePromise<PaginatedUserEdxMemoryList>;
1898
+ /**
1899
+ * Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
1900
+ * This information is passed to the corresponding mentor so the mentor has context information
1901
+ * about the course and unit that the user last interracted with.
1902
+ *
1903
+ * There can be only one UserEdxMemory instance per student and course_id.
1904
+ *
1905
+ * Url Args:
1906
+ * org (str): The organization's platform key.
1907
+ * user_id (str): The username identifier of the individual.
1908
+ *
1909
+ * Returns:
1910
+ *
1911
+ * 200: A paginated list of UserEdxMemory objects
1912
+ *
1913
+ * Examples:
1914
+ *
1915
+ * - List all memories
1916
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
1917
+ *
1918
+ * Request: None
1919
+ * Response: {
1920
+ * "count": 0,
1921
+ * "next": null,
1922
+ * "previous": null,
1923
+ * "results": [{
1924
+ * "student": 1,
1925
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1926
+ * "data": {},
1927
+ * "date_created": "2024-06-25T15:30:26.257140",
1928
+ * "last_modified": "2024-06-25T15:30:26.257140"
1929
+ * }]
1930
+ * }
1931
+ * - Get a single UserEdxMemory object
1932
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
1933
+ *
1934
+ * Request: None
1935
+ * Response: {
1936
+ * "student": 1,
1937
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1938
+ * "data": {},
1939
+ * "date_created": "2024-06-25T15:30:26.257140",
1940
+ * "last_modified": "2024-06-25T15:30:26.257140"
1941
+ * }
1942
+ * @param id A unique integer value identifying this user edx memory.
1943
+ * @param org
1944
+ * @param userId
1945
+ * @returns UserEdxMemory
1946
+ * @throws ApiError
1947
+ */
1948
+ static aiMentorOrgsUsersEdxMemoryRetrieve(id: number, org: string, userId: string): CancelablePromise<UserEdxMemory>;
1949
+ /**
1950
+ * Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
1951
+ * This information is passed to the corresponding mentor so the mentor has context information
1952
+ * about the course and unit that the user last interracted with.
1953
+ *
1954
+ * There can be only one UserEdxMemory instance per student and course_id.
1955
+ *
1956
+ * Url Args:
1957
+ * org (str): The organization's platform key.
1958
+ * user_id (str): The username identifier of the individual.
1959
+ *
1960
+ * Returns:
1961
+ *
1962
+ * 200: A paginated list of UserEdxMemory objects
1963
+ *
1964
+ * Examples:
1965
+ *
1966
+ * - List all memories
1967
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
1968
+ *
1969
+ * Request: None
1970
+ * Response: {
1971
+ * "count": 0,
1972
+ * "next": null,
1973
+ * "previous": null,
1974
+ * "results": [{
1975
+ * "student": 1,
1976
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1977
+ * "data": {},
1978
+ * "date_created": "2024-06-25T15:30:26.257140",
1979
+ * "last_modified": "2024-06-25T15:30:26.257140"
1980
+ * }]
1981
+ * }
1982
+ * - Get a single UserEdxMemory object
1983
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
1984
+ *
1985
+ * Request: None
1986
+ * Response: {
1987
+ * "student": 1,
1988
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1989
+ * "data": {},
1990
+ * "date_created": "2024-06-25T15:30:26.257140",
1991
+ * "last_modified": "2024-06-25T15:30:26.257140"
1992
+ * }
1993
+ * @param id A unique integer value identifying this user edx memory.
1994
+ * @param org
1995
+ * @param userId
1996
+ * @returns void
1997
+ * @throws ApiError
1998
+ */
1999
+ static aiMentorOrgsUsersEdxMemoryDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
2000
+ /**
2001
+ * Retrieve a list of Elevenlabs voices available to a user.
2002
+ *
2003
+ * This endpoint returns both custom voices created by the user
2004
+ * and premade voices available to all users.
2005
+ *
2006
+ * Args:
2007
+ * request: The HTTP request.
2008
+ * org: The organization/tenant identifier.
2009
+ * user_id: The ID of the user to retrieve voices for.
2010
+ *
2011
+ * Returns:
2012
+ * Response: A list of available Elevenlabs voices.
2013
+ *
2014
+ * Raises:
2015
+ * NotFound: If the specified user does not exist.
2016
+ * @param org
2017
+ * @param userId
2018
+ * @returns ElevenlabsCustomVoiceResponse
2019
+ * @throws ApiError
2020
+ */
2021
+ static aiMentorOrgsUsersElevenlabsVoiceList(org: string, userId: string): CancelablePromise<Array<ElevenlabsCustomVoiceResponse>>;
2022
+ /**
2023
+ * Create a new custom Elevenlabs voice.
2024
+ *
2025
+ * This endpoint allows users to upload audio files to create a custom voice
2026
+ * that can be used with the Elevenlabs text-to-speech service.
2027
+ *
2028
+ * Note: The audio files' total length should be longer than 1 minute and
2029
+ * the total size should be smaller than 11 MiB.
2030
+ *
2031
+ * Args:
2032
+ * request: The HTTP request containing the voice name and audio files.
2033
+ * org: The organization/tenant identifier.
2034
+ * user_id: The ID of the user creating the voice.
2035
+ *
2036
+ * Returns:
2037
+ * Response: The created voice configuration.
2038
+ *
2039
+ * Raises:
2040
+ * BadRequest: If the provided data is invalid, credentials are not found, or there's an API error.
2041
+ * @param org
2042
+ * @param userId
2043
+ * @param formData
2044
+ * @returns ElevenlabsCustomVoiceResponse
2045
+ * @throws ApiError
2046
+ */
2047
+ static aiMentorOrgsUsersElevenlabsVoiceCreate(org: string, userId: string, formData: ElevenlabsCustomVoice): CancelablePromise<ElevenlabsCustomVoiceResponse>;
2048
+ /**
2049
+ * Delete an existing Elevenlabs voice configuration.
2050
+ *
2051
+ * This endpoint removes a custom voice configuration both from the local database
2052
+ * and from the Elevenlabs remote API if applicable.
2053
+ *
2054
+ * Args:
2055
+ * request: The HTTP request.
2056
+ * org: The organization/tenant identifier.
2057
+ * user_id: The ID of the user who owns the voice.
2058
+ * voice_name: The name of the voice to delete.
2059
+ *
2060
+ * Returns:
2061
+ * Response: A confirmation of the deletion.
2062
+ *
2063
+ * Raises:
2064
+ * BadRequest: If the Elevenlabs credentials are not found or there's an API error.
2065
+ * @param org
2066
+ * @param userId
2067
+ * @param voiceName
2068
+ * @returns any Voice successfully deleted
2069
+ * @throws ApiError
2070
+ */
2071
+ static aiMentorOrgsUsersElevenlabsVoiceDestroy(org: string, userId: string, voiceName: string): CancelablePromise<any>;
2072
+ /**
2073
+ * Initiates a background task to export the user's chat history.
2074
+ *
2075
+ * Returns:
2076
+ *
2077
+ * 200: task id.
2078
+ * @param org
2079
+ * @param userId
2080
+ * @returns TaskView
2081
+ * @throws ApiError
2082
+ */
2083
+ static aiMentorOrgsUsersExportChathistoryCreate(org: string, userId: string): CancelablePromise<TaskView>;
2084
+ /**
2085
+ * Retrieve the count of free usage credits available to a user.
2086
+ *
2087
+ * Args:
2088
+ * request: The HTTP request.
2089
+ * org: The organization/tenant identifier.
2090
+ * user_id: The ID of the user to check free usage for.
2091
+ *
2092
+ * Returns:
2093
+ * Response: The count of free usage credits available.
2094
+ *
2095
+ * Raises:
2096
+ * NotFound: If the specified user does not exist.
2097
+ * @param org
2098
+ * @param userId
2099
+ * @returns FreeUsageCount
2100
+ * @throws ApiError
2101
+ */
2102
+ static aiMentorOrgsUsersFreeUsageCountRetrieve(org: string, userId: string): CancelablePromise<FreeUsageCount>;
2103
+ /**
2104
+ * Retrieve details of a specific user chat feedback entry.
2105
+ *
2106
+ * Args:
2107
+ * request: The HTTP request.
2108
+ * org: The organization/tenant identifier.
2109
+ * feedback_id: The ID of the feedback entry to retrieve.
2110
+ *
2111
+ * Returns:
2112
+ * Response: The feedback entry details.
2113
+ *
2114
+ * Raises:
2115
+ * NotFound: If the specified feedback entry does not exist.
2116
+ * @param feedbackId
2117
+ * @param org
2118
+ * @param userId
2119
+ * @returns UserChatFeedback
2120
+ * @throws ApiError
2121
+ */
2122
+ static aiMentorOrgsUsersMentorFeedbackRetrieve(feedbackId: number, org: string, userId: string): CancelablePromise<UserChatFeedback>;
2123
+ /**
2124
+ * Update an existing user chat feedback entry.
2125
+ *
2126
+ * Args:
2127
+ * request: The HTTP request containing the updated feedback data.
2128
+ * org: The organization/tenant identifier.
2129
+ * feedback_id: The ID of the feedback entry to update.
2130
+ *
2131
+ * Returns:
2132
+ * Response: The updated feedback entry.
2133
+ *
2134
+ * Raises:
2135
+ * NotFound: If the specified feedback entry does not exist.
2136
+ * BadRequest: If the provided data is invalid or the mentor does not exist.
2137
+ * @param feedbackId
2138
+ * @param org
2139
+ * @param userId
2140
+ * @param requestBody
2141
+ * @returns UserChatFeedback
2142
+ * @throws ApiError
2143
+ */
2144
+ static aiMentorOrgsUsersMentorFeedbackUpdate(feedbackId: number, org: string, userId: string, requestBody: UserChatFeedback): CancelablePromise<UserChatFeedback>;
2145
+ /**
2146
+ * Create a new user chat feedback entry.
2147
+ *
2148
+ * Args:
2149
+ * request: The HTTP request containing the feedback data.
2150
+ * org: The organization/tenant identifier.
2151
+ *
2152
+ * Returns:
2153
+ * Response: The created feedback entry.
2154
+ *
2155
+ * Raises:
2156
+ * BadRequest: If the provided data is invalid or the mentor does not exist.
2157
+ * @param org
2158
+ * @param userId
2159
+ * @param requestBody
2160
+ * @returns UserChatFeedback
2161
+ * @throws ApiError
2162
+ */
2163
+ static aiMentorOrgsUsersMentorFeedbackCreateCreate(org: string, userId: string, requestBody: UserChatFeedback): CancelablePromise<UserChatFeedback>;
2164
+ /**
2165
+ * View to create a mentor from a template
2166
+ *
2167
+ * Accessible to only tenant admins.
2168
+ * @param org
2169
+ * @param userId
2170
+ * @param requestBody
2171
+ * @returns Mentor
2172
+ * @throws ApiError
2173
+ */
2174
+ static aiMentorOrgsUsersMentorFromTemplateCreate(org: string, userId: string, requestBody: MentorFromTemplateRequest): CancelablePromise<Mentor>;
2175
+ /**
2176
+ * Retrieve available LLMs for a user.
2177
+ * @param org
2178
+ * @param userId
2179
+ * @returns LLMResponse
2180
+ * @throws ApiError
2181
+ */
2182
+ static aiMentorOrgsUsersMentorLlmsList(org: string, userId: string): CancelablePromise<Array<LLMResponse>>;
2183
+ /**
2184
+ * Retrieve the list of available mentor tools.
2185
+ * @param org
2186
+ * @param userId
2187
+ * @returns ToolResponse
2188
+ * @throws ApiError
2189
+ */
2190
+ static aiMentorOrgsUsersMentorToolsList(org: string, userId: string): CancelablePromise<Array<ToolResponse>>;
2191
+ /**
2192
+ * View to create a mentor from a template with settings.
2193
+ *
2194
+ * Accessible to tenant admins only.
2195
+ * @param org
2196
+ * @param userId
2197
+ * @param requestBody
2198
+ * @returns Mentor
2199
+ * @throws ApiError
2200
+ */
2201
+ static aiMentorOrgsUsersMentorWithSettingsCreate(org: string, userId: string, requestBody: MentorFromTemplateWithSettingRequest): CancelablePromise<Mentor>;
2202
+ /**
2203
+ * Retrieve the list of mentor audiences.
2204
+ *
2205
+ * Returns:
2206
+ * - 200: List of mentor audiences.
2207
+ * @param org
2208
+ * @param userId
2209
+ * @returns MentorAudience
2210
+ * @throws ApiError
2211
+ */
2212
+ static aiMentorOrgsUsersMentorAudienceList(org: string, userId: string): CancelablePromise<Array<MentorAudience>>;
2213
+ /**
2214
+ * Create a new mentor audience.
2215
+ *
2216
+ * Accessible to tenant admins only.
2217
+ *
2218
+ * Returns:
2219
+ * - 201: Created mentor audience.
2220
+ * - 401: Unauthorized.
2221
+ * @param org
2222
+ * @param userId
2223
+ * @param requestBody
2224
+ * @returns MentorAudience
2225
+ * @throws ApiError
2226
+ */
2227
+ static aiMentorOrgsUsersMentorAudienceCreate(org: string, userId: string, requestBody: MentorAudience): CancelablePromise<MentorAudience>;
2228
+ /**
2229
+ * Delete a mentor audience.
2230
+ *
2231
+ * Accessible to tenant admins only.
2232
+ *
2233
+ * Returns:
2234
+ * - 204: No content.
2235
+ * - 400: Bad request if audience name is missing.
2236
+ * - 404: Not found if audience does not exist.
2237
+ * - 401: Unauthorized.
2238
+ * @param org
2239
+ * @param userId
2240
+ * @returns void
2241
+ * @throws ApiError
2242
+ */
2243
+ static aiMentorOrgsUsersMentorAudienceDestroy(org: string, userId: string): CancelablePromise<void>;
2244
+ /**
2245
+ * Retrieve a list of mentor categories.
2246
+ *
2247
+ * Returns:
2248
+ * 200: A list of mentor categories.
2249
+ * @param org
2250
+ * @param userId
2251
+ * @returns MentorCategory
2252
+ * @throws ApiError
2253
+ */
2254
+ static aiMentorOrgsUsersMentorCategoriesList(org: string, userId: string): CancelablePromise<Array<MentorCategory>>;
2255
+ /**
2256
+ * Create a new mentor category.
2257
+ *
2258
+ * Accessible only to tenant admins.
2259
+ *
2260
+ * Returns:
2261
+ * 200: Details of the created mentor category.
2262
+ * @param org
2263
+ * @param userId
2264
+ * @param requestBody
2265
+ * @returns MentorCategory
2266
+ * @throws ApiError
2267
+ */
2268
+ static aiMentorOrgsUsersMentorCategoriesCreate(org: string, userId: string, requestBody: MentorCategoryCreate): CancelablePromise<MentorCategory>;
2269
+ /**
2270
+ * Delete a mentor category.
2271
+ *
2272
+ * Accessible only to tenant admins.
2273
+ *
2274
+ * Returns:
2275
+ * 204: "No content" when Delete succeeded.
2276
+ * 400: Bad request data received
2277
+ * @param org
2278
+ * @param userId
2279
+ * @returns void
2280
+ * @throws ApiError
2281
+ */
2282
+ static aiMentorOrgsUsersMentorCategoriesDestroy(org: string, userId: string): CancelablePromise<void>;
2283
+ /**
2284
+ * Seed initial mentors in a tenant.
2285
+ *
2286
+ * Args:
2287
+ * request: The HTTP request.
2288
+ * org: The organization/tenant identifier.
2289
+ * user_id: The ID of the user initiating the seeding.
2290
+ *
2291
+ * Returns:
2292
+ * Response: A success message with details about the seeded mentors.
2293
+ *
2294
+ * Raises:
2295
+ * BadRequest: If the seeding process fails.
2296
+ * @param org
2297
+ * @param userId
2298
+ * @returns SeedMentorsView
2299
+ * @throws ApiError
2300
+ */
2301
+ static aiMentorOrgsUsersMentorSeedRetrieve(org: string, userId: string): CancelablePromise<SeedMentorsView>;
2302
+ /**
2303
+ * Retrieve details of a specific mentor by slug or name.
2304
+ * @param mentor
2305
+ * @param org
2306
+ * @param userId
2307
+ * @returns Mentor
2308
+ * @throws ApiError
2309
+ */
2310
+ static aiMentorOrgsUsersMentorsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<Mentor>;
2311
+ /**
2312
+ * Retrieve tools available for a particular mentor.
2313
+ * @param mentor
2314
+ * @param org
2315
+ * @param userId
2316
+ * @returns ToolResponse
2317
+ * @throws ApiError
2318
+ */
2319
+ static aiMentorOrgsUsersMentorsAvailableToolsList(mentor: string, org: string, userId: string): CancelablePromise<Array<ToolResponse>>;
2320
+ /**
2321
+ * Generate IBL Call Pro authentication parameters for audio calls.
2322
+ *
2323
+ * This endpoint creates the necessary authentication tokens and parameters
2324
+ * for connecting to a IBL Call Pro room for audio communication with a mentor.
2325
+ *
2326
+ * Args:
2327
+ * request: The HTTP request object containing the required parameters.
2328
+ * org: The organization/tenant identifier.
2329
+ * user_id: The ID of the user requesting authentication.
2330
+ *
2331
+ * Returns:
2332
+ * Response: IBL Call Pro authentication parameters including URL, room name,
2333
+ * participant name, and authentication token.
2334
+ *
2335
+ * Raises:
2336
+ * ValidationError: If the request parameters are invalid.
2337
+ * BadRequest: If the IBL Call Pro credentials are not properly configured.
2338
+ * @param mentor
2339
+ * @param org
2340
+ * @param userId
2341
+ * @param requestBody
2342
+ * @returns CallAuthenticationResponse
2343
+ * @throws ApiError
2344
+ */
2345
+ static aiMentorOrgsUsersMentorsCreateCallCredentialsCreate(mentor: string, org: string, userId: string, requestBody: CallAuthenticationRequest): CancelablePromise<CallAuthenticationResponse>;
2346
+ /**
2347
+ * Retrieve memory components for a specific mentor.
2348
+ *
2349
+ * Args:
2350
+ * request: The HTTP request.
2351
+ * org: The organization/tenant identifier.
2352
+ * user_id: The ID of the user making the request.
2353
+ * mentor: The identifier of the mentor to retrieve memory for.
2354
+ *
2355
+ * Returns:
2356
+ * Response: The memory components for the mentor.
2357
+ *
2358
+ * Raises:
2359
+ * NotFound: If the specified mentor or memory does not exist.
2360
+ * @param mentor
2361
+ * @param org
2362
+ * @param userId
2363
+ * @returns MemoryComponentResponse
2364
+ * @throws ApiError
2365
+ */
2366
+ static aiMentorOrgsUsersMentorsCurrentMemoryRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MemoryComponentResponse>;
2367
+ /**
2368
+ * Update memory components for a specific mentor.
2369
+ *
2370
+ * Args:
2371
+ * request: The HTTP request containing the updated memory data.
2372
+ * org: The organization/tenant identifier.
2373
+ * user_id: The ID of the user making the request.
2374
+ * mentor: The identifier of the mentor to update memory for.
2375
+ *
2376
+ * Returns:
2377
+ * Response: The updated memory components for the mentor.
2378
+ *
2379
+ * Raises:
2380
+ * BadRequest: If the provided data is invalid.
2381
+ * NotFound: If the specified mentor does not exist.
2382
+ * @param mentor
2383
+ * @param org
2384
+ * @param userId
2385
+ * @param requestBody
2386
+ * @returns QuestionResponse
2387
+ * @throws ApiError
2388
+ */
2389
+ static aiMentorOrgsUsersMentorsCurrentMemoryUpdate(mentor: string, org: string, userId: string, requestBody: QuestionRequest): CancelablePromise<QuestionResponse>;
2390
+ /**
2391
+ * Retrieve the current custom voice settings for a mentor.
2392
+ *
2393
+ * Args:
2394
+ * request: The HTTP request.
2395
+ * org: The organization/tenant identifier.
2396
+ * user_id: The ID of the user who owns the mentor link.
2397
+ * mentor: The unique identifier of the mentor.
2398
+ *
2399
+ * Returns:
2400
+ * Response: The current custom voice settings.
2401
+ *
2402
+ * Raises:
2403
+ * NotFound: If the specified mentor or student does not exist.
2404
+ * @param mentor
2405
+ * @param org
2406
+ * @param userId
2407
+ * @returns MentorCustomVoiceResponse
2408
+ * @throws ApiError
2409
+ */
2410
+ static aiMentorOrgsUsersMentorsCustomVoiceRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorCustomVoiceResponse>;
2411
+ /**
2412
+ * Set a custom voice for a mentor.
2413
+ *
2414
+ * This endpoint allows setting a custom voice for a specific mentor,
2415
+ * either using the default voice provider or Elevenlabs.
2416
+ *
2417
+ * Args:
2418
+ * request: The HTTP request containing the voice provider and name.
2419
+ * org: The organization/tenant identifier.
2420
+ * user_id: The ID of the user who owns the mentor link.
2421
+ * mentor: The unique identifier of the mentor.
2422
+ *
2423
+ * Returns:
2424
+ * Response: The updated custom voice settings.
2425
+ *
2426
+ * Raises:
2427
+ * BadRequest: If the provided data is invalid or the voice does not exist.
2428
+ * NotFound: If the mentor or student does not exist.
2429
+ * @param mentor
2430
+ * @param org
2431
+ * @param userId
2432
+ * @param requestBody
2433
+ * @returns MentorCustomVoiceResponse
2434
+ * @throws ApiError
2435
+ */
2436
+ static aiMentorOrgsUsersMentorsCustomVoiceCreate(mentor: string, org: string, userId: string, requestBody: MentorCustomVoice): CancelablePromise<MentorCustomVoiceResponse>;
2437
+ /**
2438
+ * Generate audio from text using a mentor's custom voice.
2439
+ *
2440
+ * This endpoint converts the provided text to speech using the
2441
+ * custom voice configured for the specified mentor.
2442
+ *
2443
+ * Args:
2444
+ * request: The HTTP request containing the text to convert.
2445
+ * org: The organization/tenant identifier.
2446
+ * user_id: The ID of the user who owns the mentor link.
2447
+ * mentor: The unique identifier of the mentor.
2448
+ *
2449
+ * Returns:
2450
+ * Response: An MP3 audio file of the synthesized speech.
2451
+ *
2452
+ * Raises:
2453
+ * BadRequest: If the text is empty, credentials are not found, or custom voice is not set.
2454
+ * NotFound: If the mentor or student does not exist.
2455
+ * @param mentor
2456
+ * @param org
2457
+ * @param userId
2458
+ * @param requestBody
2459
+ * @returns any MP3 audio file
2460
+ * @throws ApiError
2461
+ */
2462
+ static aiMentorOrgsUsersMentorsCustomVoiceTtsCreate(mentor: string, org: string, userId: string, requestBody?: Record<string, any>): CancelablePromise<any>;
2463
+ /**
2464
+ * Update scenarios for a specific mentor.
2465
+ *
2466
+ * Args:
2467
+ * request: The HTTP request containing the updated scenarios.
2468
+ * org: The organization/tenant identifier.
2469
+ * user_id: The ID of the user making the request.
2470
+ * mentor: The identifier of the mentor to update scenarios for.
2471
+ *
2472
+ * Returns:
2473
+ * Response: The updated scenarios for the mentor.
2474
+ *
2475
+ * Raises:
2476
+ * BadRequest: If the provided data is invalid.
2477
+ * NotFound: If the specified mentor does not exist.
2478
+ * @param mentor
2479
+ * @param org
2480
+ * @param userId
2481
+ * @param requestBody
2482
+ * @returns MentorScenario
2483
+ * @throws ApiError
2484
+ */
2485
+ static aiMentorOrgsUsersMentorsEditScenariosUpdate(mentor: string, org: string, userId: string, requestBody: MentorScenario): CancelablePromise<MentorScenario>;
2486
+ /**
2487
+ * Fork (clone) an existing mentor.
2488
+ *
2489
+ * Args:
2490
+ * request: The HTTP request containing the fork parameters.
2491
+ * org: The organization/tenant identifier.
2492
+ * mentor: The identifier of the mentor to fork.
2493
+ * user_id: The ID of the user initiating the fork.
2494
+ *
2495
+ * Returns:
2496
+ * Response: The newly created forked mentor.
2497
+ *
2498
+ * Raises:
2499
+ * BadRequest: If the provided data is invalid or the fork operation fails.
2500
+ * NotFound: If the specified mentor does not exist.
2501
+ * @param mentor
2502
+ * @param org
2503
+ * @param userId
2504
+ * @param requestBody
2505
+ * @returns Mentor
2506
+ * @throws ApiError
2507
+ */
2508
+ static aiMentorOrgsUsersMentorsForkCreate(mentor: string, org: string, userId: string, requestBody: MentorFork): CancelablePromise<Mentor>;
2509
+ /**
2510
+ * Retrieve memory history entries for a specific mentor and user.
2511
+ *
2512
+ * Args:
2513
+ * request: The HTTP request.
2514
+ * org: The organization/tenant identifier.
2515
+ * user_id: The ID of the user to retrieve memory history for.
2516
+ * mentor: The identifier of the mentor to retrieve memory history for.
2517
+ *
2518
+ * Returns:
2519
+ * Response: The memory history entries for the mentor and user.
2520
+ *
2521
+ * Raises:
2522
+ * NotFound: If the specified mentor or memory history does not exist.
2523
+ * @param mentor
2524
+ * @param org
2525
+ * @param userId
2526
+ * @returns MemoryComponentMemoryDetail
2527
+ * @throws ApiError
2528
+ */
2529
+ static aiMentorOrgsUsersMentorsHistoricalMemoryRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MemoryComponentMemoryDetail>;
2530
+ /**
2531
+ * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
2532
+ * @param mentor
2533
+ * @param org
2534
+ * @param userId
2535
+ * @returns MemoryProgress
2536
+ * @throws ApiError
2537
+ */
2538
+ static aiMentorOrgsUsersMentorsMemoryProgressRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MemoryProgress>;
2539
+ /**
2540
+ * Retrieve memory settings for a specific mentor.
2541
+ *
2542
+ * Args:
2543
+ * request: The HTTP request.
2544
+ * org: The organization/tenant identifier.
2545
+ * user_id: The ID of the user making the request.
2546
+ * mentor: The identifier of the mentor to retrieve settings for.
2547
+ *
2548
+ * Returns:
2549
+ * Response: The memory settings for the mentor.
2550
+ *
2551
+ * Raises:
2552
+ * NotFound: If the specified mentor or settings do not exist.
2553
+ * @param mentor
2554
+ * @param org
2555
+ * @param userId
2556
+ * @returns MentorMemorySettingsResponse
2557
+ * @throws ApiError
2558
+ */
2559
+ static aiMentorOrgsUsersMentorsMemorySettingsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorMemorySettingsResponse>;
2560
+ /**
2561
+ * Endpoint for mentor memory item settings.
2562
+ *
2563
+ * Accessible to platform admins and superusers.
2564
+ *
2565
+ * Returns:
2566
+ *
2567
+ * 200: Change mentor memory component item.
2568
+ *
2569
+ * 400: When request is not valid.
2570
+ * @param mentor
2571
+ * @param org
2572
+ * @param userId
2573
+ * @param requestBody
2574
+ * @returns MentorMemorySettingsResponse
2575
+ * @throws ApiError
2576
+ */
2577
+ static aiMentorOrgsUsersMentorsMemorySettingsCreate(mentor: string, org: string, userId: string, requestBody?: MentorMemorySettingsRequest): CancelablePromise<MentorMemorySettingsResponse>;
2578
+ /**
2579
+ * Retrieve evaluation criteria for a specific mentor.
2580
+ *
2581
+ * Args:
2582
+ * request: The HTTP request.
2583
+ * org: The organization/tenant identifier.
2584
+ * user_id: The ID of the user making the request.
2585
+ * mentor: The identifier of the mentor to retrieve evaluations for.
2586
+ *
2587
+ * Returns:
2588
+ * Response: The evaluation criteria for the mentor.
2589
+ *
2590
+ * Raises:
2591
+ * NotFound: If the specified mentor or evaluations do not exist.
2592
+ * @param mentor
2593
+ * @param org
2594
+ * @param userId
2595
+ * @returns MentorEval
2596
+ * @throws ApiError
2597
+ */
2598
+ static aiMentorOrgsUsersMentorsMentorEvalRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorEval>;
2599
+ /**
2600
+ * Create or update evaluation criteria for a specific mentor.
2601
+ *
2602
+ * Args:
2603
+ * request: The HTTP request containing the evaluation data.
2604
+ * org: The organization/tenant identifier.
2605
+ * user_id: The ID of the user making the request.
2606
+ * mentor: The identifier of the mentor to create/update evaluations for.
2607
+ *
2608
+ * Returns:
2609
+ * Response: The created or updated evaluation criteria.
2610
+ *
2611
+ * Raises:
2612
+ * BadRequest: If the provided data is invalid or the mentor does not exist.
2613
+ * @param mentor
2614
+ * @param org
2615
+ * @param userId
2616
+ * @param requestBody
2617
+ * @returns MentorEval
2618
+ * @throws ApiError
2619
+ */
2620
+ static aiMentorOrgsUsersMentorsMentorEvalCreate(mentor: string, org: string, userId: string, requestBody?: MentorEvalRequest): CancelablePromise<MentorEval>;
2621
+ /**
2622
+ * Run an evaluation for a specific mentor.
2623
+ *
2624
+ * Args:
2625
+ * request: The HTTP request containing the evaluation ID.
2626
+ * org: The organization/tenant identifier.
2627
+ * user_id: The ID of the user making the request.
2628
+ * mentor: The identifier of the mentor to evaluate.
2629
+ *
2630
+ * Returns:
2631
+ * Response: The ID of the generated evaluation report.
2632
+ *
2633
+ * Raises:
2634
+ * BadRequest: If the evaluation ID is invalid or the mentor does not match.
2635
+ * @param mentor
2636
+ * @param org
2637
+ * @param userId
2638
+ * @param requestBody
2639
+ * @returns any Evaluation execution started successfully
2640
+ * @throws ApiError
2641
+ */
2642
+ static aiMentorOrgsUsersMentorsMentorEvalExecutionCreate(mentor: string, org: string, userId: string, requestBody: RunMentorEval): CancelablePromise<any>;
2643
+ /**
2644
+ * Retrieve public mentor settings.
2645
+ *
2646
+ * Args:
2647
+ * request: HTTP request instance.
2648
+ * user_id: The ID of the user requesting settings.
2649
+ * mentor: The mentor identifier (name, slug, or unique_id).
2650
+ * org: The organization key.
2651
+ *
2652
+ * Returns:
2653
+ * Response containing the mentor settings or an error message.
2654
+ * @param mentor
2655
+ * @param org
2656
+ * @param userId
2657
+ * @returns MentorSettingsPublic
2658
+ * @throws ApiError
2659
+ */
2660
+ static aiMentorOrgsUsersMentorsPublicSettingsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorSettingsPublic>;
2661
+ /**
2662
+ * Retrieve a specific evaluation report.
2663
+ *
2664
+ * Args:
2665
+ * request: The HTTP request.
2666
+ * org: The organization/tenant identifier.
2667
+ * user_id: The ID of the user making the request.
2668
+ * mentor: The identifier of the mentor that was evaluated.
2669
+ * report_id: The ID of the evaluation report to retrieve.
2670
+ *
2671
+ * Returns:
2672
+ * Response: The detailed evaluation report.
2673
+ *
2674
+ * Raises:
2675
+ * BadRequest: If the report does not exist, does not match the mentor, or is still being generated.
2676
+ * @param mentor
2677
+ * @param org
2678
+ * @param reportId
2679
+ * @param userId
2680
+ * @returns MentorEvalReport
2681
+ * @throws ApiError
2682
+ */
2683
+ static aiMentorOrgsUsersMentorsReportsMentorEvalReportRetrieve(mentor: string, org: string, reportId: number, userId: string): CancelablePromise<MentorEvalReport>;
2684
+ /**
2685
+ * Retrieve available scenarios for a specific mentor.
2686
+ *
2687
+ * Args:
2688
+ * request: The HTTP request.
2689
+ * org: The organization/tenant identifier.
2690
+ * user_id: The ID of the user making the request.
2691
+ * mentor: The identifier of the mentor to retrieve scenarios for.
2692
+ *
2693
+ * Returns:
2694
+ * Response: The available scenarios for the mentor.
2695
+ *
2696
+ * Raises:
2697
+ * NotFound: If the specified mentor or scenarios do not exist.
2698
+ * @param mentor
2699
+ * @param org
2700
+ * @param userId
2701
+ * @returns MentorScenario
2702
+ * @throws ApiError
2703
+ */
2704
+ static aiMentorOrgsUsersMentorsScenariosRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorScenario>;
2705
+ /**
2706
+ * Retrieve Mentor Settings
2707
+ * Fetch the settings of a mentor within an organization. Only accessible to tenant admins.
2708
+ * @param mentor
2709
+ * @param org
2710
+ * @param userId
2711
+ * @returns MentorSettingsPublic
2712
+ * @throws ApiError
2713
+ */
2714
+ static aiMentorOrgsUsersMentorsSettingsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorSettingsPublic>;
2715
+ /**
2716
+ * Update Mentor Settings
2717
+ * Update various mentor settings including system prompts, tool permissions, and UI configurations.
2718
+ * @param mentor
2719
+ * @param org
2720
+ * @param userId
2721
+ * @param requestBody
2722
+ * @returns MentorSettings
2723
+ * @throws ApiError
2724
+ */
2725
+ static aiMentorOrgsUsersMentorsSettingsUpdate(mentor: string, org: string, userId: string, requestBody?: MentorSettingsRequest): CancelablePromise<MentorSettings>;
2726
+ /**
2727
+ * Retrieve spaced repetition question statistics.
2728
+ *
2729
+ * Args:
2730
+ * request: The HTTP request.
2731
+ * org: The organization/tenant identifier.
2732
+ * user_id: The ID of the user to retrieve statistics for.
2733
+ * mentor: The unique identifier of the mentor.
2734
+ *
2735
+ * Returns:
2736
+ * Response: Statistics about the user's performance on spaced repetition questions.
2737
+ *
2738
+ * Raises:
2739
+ * NotFound: If the mentor or student does not exist.
2740
+ * @param mentor
2741
+ * @param org
2742
+ * @param userId
2743
+ * @returns SpacedRepetitionQuestionStats
2744
+ * @throws ApiError
2745
+ */
2746
+ static aiMentorOrgsUsersMentorsSpacedRepetitionQuestionStatsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<SpacedRepetitionQuestionStats>;
2747
+ /**
2748
+ * Retrieve a list of learning paths associated with a specific mentor and student.
2749
+ *
2750
+ * This endpoint uses the memory component to establish the learning context for a student
2751
+ * under the guidance of a mentor. It verifies that the provided organization identifier matches
2752
+ * the mentor's platform key, and then retrieves learning path tags associated with the student's
2753
+ * question cards. Each tag is annotated with the total number of question cards and the count of
2754
+ * cards with successful repetitions (i.e., correct answers). The learning paths are ordered by the
2755
+ * number of correct answers and limited to the top five entries.
2756
+ *
2757
+ * Args:
2758
+ * request: The HTTP request containing the necessary context.
2759
+ * org (str): The organization identifier/platform key.
2760
+ * user_id (str): The username of the student.
2761
+ * mentor (str): The unique identifier of the mentor.
2762
+ * *args: Additional positional arguments.
2763
+ * **kwargs: Additional keyword arguments.
2764
+ *
2765
+ * Returns:
2766
+ * Resp200onse: memory component detail infomrmation
2767
+ *
2768
+ * Raises:
2769
+ * NotFound: If the memory component for the specified mentor and student cannot be found,
2770
+ * or if the organization identifier does not match the mentor's platform key.
2771
+ * @param mentor
2772
+ * @param org
2773
+ * @param userId
2774
+ * @returns QuestionCardTag
2775
+ * @throws ApiError
2776
+ */
2777
+ static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsList(mentor: string, org: string, userId: string): CancelablePromise<Array<QuestionCardTag>>;
2778
+ /**
2779
+ * Set a specific learning path for spaced repetition.
2780
+ *
2781
+ * Args:
2782
+ * request: The HTTP request containing the learning path.
2783
+ * org: The organization/tenant identifier.
2784
+ * user_id: The ID of the user to set the learning path for.
2785
+ * mentor: The unique identifier of the mentor.
2786
+ *
2787
+ * Returns:
2788
+ * Response: The set learning path.
2789
+ *
2790
+ * Raises:
2791
+ * BadRequest: If the provided data is invalid.
2792
+ * NotFound: If the learning path, mentor, or student does not exist.
2793
+ * @param mentor
2794
+ * @param org
2795
+ * @param userId
2796
+ * @param requestBody
2797
+ * @returns SpacedRepetitionLearningPath
2798
+ * @throws ApiError
2799
+ */
2800
+ static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsUpdate(mentor: string, org: string, userId: string, requestBody: SpacedRepetitionLearningPath): CancelablePromise<SpacedRepetitionLearningPath>;
2801
+ /**
2802
+ * Endpoint for getting the star status of a mentor.
2803
+ *
2804
+ * Accessible to students and admins.
2805
+ *
2806
+ *
2807
+ * Returns:
2808
+ *
2809
+ * 200: Star status.
2810
+ *
2811
+ * 400: When request is not valid.
2812
+ * @param mentor
2813
+ * @param org
2814
+ * @param userId
2815
+ * @returns StarMentor
2816
+ * @throws ApiError
2817
+ */
2818
+ static aiMentorOrgsUsersMentorsStarRetrieve(mentor: string, org: string, userId: string): CancelablePromise<StarMentor>;
2819
+ /**
2820
+ * Endpoint for starring a mentor.
2821
+ *
2822
+ * Accessible to students and admins.
2823
+ *
2824
+ *
2825
+ * Returns:
2826
+ *
2827
+ * 200: Star status.
2828
+ *
2829
+ * 400: When request is not valid.
2830
+ * @param mentor
2831
+ * @param org
2832
+ * @param userId
2833
+ * @returns StarMentor
2834
+ * @throws ApiError
2835
+ */
2836
+ static aiMentorOrgsUsersMentorsStarCreate(mentor: string, org: string, userId: string): CancelablePromise<StarMentor>;
2837
+ /**
2838
+ * Remove a mentor from a user's starred list.
2839
+ *
2840
+ * Args:
2841
+ * request: The HTTP request.
2842
+ * org: The organization/tenant identifier.
2843
+ * user_id: The ID of the user unstarring the mentor.
2844
+ * mentor: The identifier of the mentor to unstar.
2845
+ *
2846
+ * Returns:
2847
+ * Response: The updated star status of the mentor.
2848
+ *
2849
+ * Raises:
2850
+ * NotFound: If the specified mentor or student does not exist.
2851
+ * BadRequest: If the request is invalid.
2852
+ * @param mentor
2853
+ * @param org
2854
+ * @param userId
2855
+ * @returns StarMentor
2856
+ * @throws ApiError
2857
+ */
2858
+ static aiMentorOrgsUsersMentorsUnstarCreate(mentor: string, org: string, userId: string): CancelablePromise<StarMentor>;
2859
+ /**
2860
+ * Retrieve metadata for a mentor.
2861
+ *
2862
+ * Args:
2863
+ * request: The HTTP request.
2864
+ * org: The organization/tenant identifier.
2865
+ * user_id: The ID of the user making the request.
2866
+ *
2867
+ * Returns:
2868
+ * Response: The mentor metadata.
2869
+ *
2870
+ * Raises:
2871
+ * NotFound: If no metadata exists for the specified mentor.
2872
+ * @param org
2873
+ * @param userId
2874
+ * @returns MentorMetadata
2875
+ * @throws ApiError
2876
+ */
2877
+ static aiMentorOrgsUsersMetadataRetrieve(org: string, userId: string): CancelablePromise<MentorMetadata>;
2878
+ /**
2879
+ * Endpoint to view and delete Moderation Logs for a tenant.
2880
+ *
2881
+ * These can be filtered by username, platform_key and mentor id
2882
+ *
2883
+ *
2884
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
2885
+ * @param org
2886
+ * @param userId
2887
+ * @param mentor
2888
+ * @param ordering Which field to use when ordering the results.
2889
+ * @param page A page number within the paginated result set.
2890
+ * @param pageSize Number of results to return per page.
2891
+ * @param platformKey
2892
+ * @param search A search term.
2893
+ * @param targetSystem * `Safety System` - Safety System
2894
+ * * `Moderation System` - Moderation System
2895
+ * @param username
2896
+ * @returns PaginatedModerationLogList
2897
+ * @throws ApiError
2898
+ */
2899
+ static aiMentorOrgsUsersModerationLogsList(org: string, userId: string, mentor?: number, ordering?: string, page?: number, pageSize?: number, platformKey?: string, search?: string, targetSystem?: 'Moderation System' | 'Safety System', username?: string): CancelablePromise<PaginatedModerationLogList>;
2900
+ /**
2901
+ * Endpoint to view and delete Moderation Logs for a tenant.
2902
+ *
2903
+ * These can be filtered by username, platform_key and mentor id
2904
+ *
2905
+ *
2906
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
2907
+ * @param id A unique integer value identifying this moderation log.
2908
+ * @param org
2909
+ * @param userId
2910
+ * @returns ModerationLog
2911
+ * @throws ApiError
2912
+ */
2913
+ static aiMentorOrgsUsersModerationLogsRetrieve(id: number, org: string, userId: string): CancelablePromise<ModerationLog>;
2914
+ /**
2915
+ * Endpoint to view and delete Moderation Logs for a tenant.
2916
+ *
2917
+ * These can be filtered by username, platform_key and mentor id
2918
+ *
2919
+ *
2920
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
2921
+ * @param id A unique integer value identifying this moderation log.
2922
+ * @param org
2923
+ * @param userId
2924
+ * @returns void
2925
+ * @throws ApiError
2926
+ */
2927
+ static aiMentorOrgsUsersModerationLogsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
2928
+ /**
2929
+ * Endpoint to view logs for periodic agent runs.
2930
+ *
2931
+ * These logs contain the full mentor output for each run for debugging.
2932
+ * Logs are ordered from newest to oldest. However this can be changed.
2933
+ *
2934
+ * You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL.
2935
+ * @param org
2936
+ * @param userId
2937
+ * @param ordering Which field to use when ordering the results.
2938
+ * @param page A page number within the paginated result set.
2939
+ * @param pageSize Number of results to return per page.
2940
+ * @param parentMentorId
2941
+ * @param parentSessionId
2942
+ * @param periodicAgent
2943
+ * @param search A search term.
2944
+ * @param status * `success` - Success
2945
+ * * `error` - Error
2946
+ * * `running` - Running
2947
+ * @param username
2948
+ * @returns PaginatedPeriodicAgentLogList
2949
+ * @throws ApiError
2950
+ */
2951
+ static aiMentorOrgsUsersPeriodicAgentLogsList(org: string, userId: string, ordering?: string, page?: number, pageSize?: number, parentMentorId?: string, parentSessionId?: string, periodicAgent?: number, search?: string, status?: 'error' | 'running' | 'success', username?: string): CancelablePromise<PaginatedPeriodicAgentLogList>;
2952
+ /**
2953
+ * Endpoint to view logs for periodic agent runs.
2954
+ *
2955
+ * These logs contain the full mentor output for each run for debugging.
2956
+ * Logs are ordered from newest to oldest. However this can be changed.
2957
+ *
2958
+ * You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL.
2959
+ * @param id A unique integer value identifying this periodic agent log.
2960
+ * @param org
2961
+ * @param userId
2962
+ * @returns PeriodicAgentLog
2963
+ * @throws ApiError
2964
+ */
2965
+ static aiMentorOrgsUsersPeriodicAgentLogsRetrieve(id: number, org: string, userId: string): CancelablePromise<PeriodicAgentLog>;
2966
+ /**
2967
+ * Endpoint to create and view, update and delete periodic agents.
2968
+ *
2969
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
2970
+ * as well as a cron schedule to trigger the periodic agent.
2971
+ *
2972
+ * Access to these are restricted to platform admins and tenant administrators
2973
+ *
2974
+ * Session information for running the periodic agent will be generated with the credentials of the
2975
+ * user (platform administrator) who created the agent.
2976
+ *
2977
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
2978
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
2979
+ * of the run will be made to the callback_url provided.
2980
+ * Here is the payload structure:
2981
+ * ```
2982
+ * {
2983
+ * "timestamp": "timestamp when the run completed",
2984
+ * "status": "status of the periodic agent",
2985
+ * "prompt": "input prompt to agent,
2986
+ * "agent_output": "...final response of agent",
2987
+ * "log": "... full agent run log",
2988
+ * "log_id": periodic agent log id.,
2989
+ * }
2990
+ * ```
2991
+ * The payload is encrypted using the `callback_secret` provided.
2992
+ *
2993
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
2994
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
2995
+ *
2996
+ * ```python
2997
+ * import hmac
2998
+ * import haslib
2999
+ *
3000
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3001
+ * # Get the X-Hub-Signature-256 header from the request
3002
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3003
+ *
3004
+ * if not received_signature.startswith("sha256="):
3005
+ * # Invalid signature format
3006
+ * return False
3007
+ *
3008
+ * received_signature = received_signature[len("sha256=") :]
3009
+ *
3010
+ * try:
3011
+ * # Get the raw request body
3012
+ * payload = request.body
3013
+ *
3014
+ * # Compute the expected signature using the app_secret
3015
+ * expected_signature = hmac.new(
3016
+ * callback_secret.encode(), payload, hashlib.sha256
3017
+ * ).hexdigest()
3018
+ *
3019
+ * if hmac.compare_digest(received_signature, expected_signature):
3020
+ * # Signatures match, the payload is genuine
3021
+ * return True
3022
+ * else:
3023
+ * # Signatures don't match
3024
+ * return False
3025
+ * except Exception as e:
3026
+ * # Handle any errors that may occur during validation
3027
+ * return False
3028
+ *
3029
+ * ```
3030
+ * @param org
3031
+ * @param userId
3032
+ * @param enabled
3033
+ * @param ordering Which field to use when ordering the results.
3034
+ * @param page A page number within the paginated result set.
3035
+ * @param pageSize Number of results to return per page.
3036
+ * @param parentMentorId
3037
+ * @param parentSessionId
3038
+ * @param previousAgent
3039
+ * @param previousAgentStatus The status that the previous agent must be in before this agent gets scheduled.
3040
+ *
3041
+ * * `success` - Success
3042
+ * * `error` - Error
3043
+ * * `running` - Running
3044
+ * * `pending` - Pending
3045
+ * @param search A search term.
3046
+ * @param status * `success` - Success
3047
+ * * `error` - Error
3048
+ * * `running` - Running
3049
+ * * `pending` - Pending
3050
+ * @param title
3051
+ * @param username
3052
+ * @returns PaginatedPeriodicAgentList
3053
+ * @throws ApiError
3054
+ */
3055
+ static aiMentorOrgsUsersPeriodicAgentsList(org: string, userId: string, enabled?: boolean, ordering?: string, page?: number, pageSize?: number, parentMentorId?: number, parentSessionId?: string, previousAgent?: number, previousAgentStatus?: 'error' | 'pending' | 'running' | 'success', search?: string, status?: 'error' | 'pending' | 'running' | 'success', title?: string, username?: string): CancelablePromise<PaginatedPeriodicAgentList>;
3056
+ /**
3057
+ * Endpoint to create and view, update and delete periodic agents.
3058
+ *
3059
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3060
+ * as well as a cron schedule to trigger the periodic agent.
3061
+ *
3062
+ * Access to these are restricted to platform admins and tenant administrators
3063
+ *
3064
+ * Session information for running the periodic agent will be generated with the credentials of the
3065
+ * user (platform administrator) who created the agent.
3066
+ *
3067
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3068
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3069
+ * of the run will be made to the callback_url provided.
3070
+ * Here is the payload structure:
3071
+ * ```
3072
+ * {
3073
+ * "timestamp": "timestamp when the run completed",
3074
+ * "status": "status of the periodic agent",
3075
+ * "prompt": "input prompt to agent,
3076
+ * "agent_output": "...final response of agent",
3077
+ * "log": "... full agent run log",
3078
+ * "log_id": periodic agent log id.,
3079
+ * }
3080
+ * ```
3081
+ * The payload is encrypted using the `callback_secret` provided.
3082
+ *
3083
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3084
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3085
+ *
3086
+ * ```python
3087
+ * import hmac
3088
+ * import haslib
3089
+ *
3090
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3091
+ * # Get the X-Hub-Signature-256 header from the request
3092
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3093
+ *
3094
+ * if not received_signature.startswith("sha256="):
3095
+ * # Invalid signature format
3096
+ * return False
3097
+ *
3098
+ * received_signature = received_signature[len("sha256=") :]
3099
+ *
3100
+ * try:
3101
+ * # Get the raw request body
3102
+ * payload = request.body
3103
+ *
3104
+ * # Compute the expected signature using the app_secret
3105
+ * expected_signature = hmac.new(
3106
+ * callback_secret.encode(), payload, hashlib.sha256
3107
+ * ).hexdigest()
3108
+ *
3109
+ * if hmac.compare_digest(received_signature, expected_signature):
3110
+ * # Signatures match, the payload is genuine
3111
+ * return True
3112
+ * else:
3113
+ * # Signatures don't match
3114
+ * return False
3115
+ * except Exception as e:
3116
+ * # Handle any errors that may occur during validation
3117
+ * return False
3118
+ *
3119
+ * ```
3120
+ * @param org
3121
+ * @param userId
3122
+ * @param requestBody
3123
+ * @returns PeriodicAgentCreate
3124
+ * @throws ApiError
3125
+ */
3126
+ static aiMentorOrgsUsersPeriodicAgentsCreate(org: string, userId: string, requestBody: PeriodicAgentCreate): CancelablePromise<PeriodicAgentCreate>;
3127
+ /**
3128
+ * Endpoint to create and view, update and delete periodic agents.
3129
+ *
3130
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3131
+ * as well as a cron schedule to trigger the periodic agent.
3132
+ *
3133
+ * Access to these are restricted to platform admins and tenant administrators
3134
+ *
3135
+ * Session information for running the periodic agent will be generated with the credentials of the
3136
+ * user (platform administrator) who created the agent.
3137
+ *
3138
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3139
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3140
+ * of the run will be made to the callback_url provided.
3141
+ * Here is the payload structure:
3142
+ * ```
3143
+ * {
3144
+ * "timestamp": "timestamp when the run completed",
3145
+ * "status": "status of the periodic agent",
3146
+ * "prompt": "input prompt to agent,
3147
+ * "agent_output": "...final response of agent",
3148
+ * "log": "... full agent run log",
3149
+ * "log_id": periodic agent log id.,
3150
+ * }
3151
+ * ```
3152
+ * The payload is encrypted using the `callback_secret` provided.
3153
+ *
3154
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3155
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3156
+ *
3157
+ * ```python
3158
+ * import hmac
3159
+ * import haslib
3160
+ *
3161
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3162
+ * # Get the X-Hub-Signature-256 header from the request
3163
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3164
+ *
3165
+ * if not received_signature.startswith("sha256="):
3166
+ * # Invalid signature format
3167
+ * return False
3168
+ *
3169
+ * received_signature = received_signature[len("sha256=") :]
3170
+ *
3171
+ * try:
3172
+ * # Get the raw request body
3173
+ * payload = request.body
3174
+ *
3175
+ * # Compute the expected signature using the app_secret
3176
+ * expected_signature = hmac.new(
3177
+ * callback_secret.encode(), payload, hashlib.sha256
3178
+ * ).hexdigest()
3179
+ *
3180
+ * if hmac.compare_digest(received_signature, expected_signature):
3181
+ * # Signatures match, the payload is genuine
3182
+ * return True
3183
+ * else:
3184
+ * # Signatures don't match
3185
+ * return False
3186
+ * except Exception as e:
3187
+ * # Handle any errors that may occur during validation
3188
+ * return False
3189
+ *
3190
+ * ```
3191
+ * @param id A unique integer value identifying this periodic agent.
3192
+ * @param org
3193
+ * @param userId
3194
+ * @returns PeriodicAgent
3195
+ * @throws ApiError
3196
+ */
3197
+ static aiMentorOrgsUsersPeriodicAgentsRetrieve(id: number, org: string, userId: string): CancelablePromise<PeriodicAgent>;
3198
+ /**
3199
+ * Endpoint to create and view, update and delete periodic agents.
3200
+ *
3201
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3202
+ * as well as a cron schedule to trigger the periodic agent.
3203
+ *
3204
+ * Access to these are restricted to platform admins and tenant administrators
3205
+ *
3206
+ * Session information for running the periodic agent will be generated with the credentials of the
3207
+ * user (platform administrator) who created the agent.
3208
+ *
3209
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3210
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3211
+ * of the run will be made to the callback_url provided.
3212
+ * Here is the payload structure:
3213
+ * ```
3214
+ * {
3215
+ * "timestamp": "timestamp when the run completed",
3216
+ * "status": "status of the periodic agent",
3217
+ * "prompt": "input prompt to agent,
3218
+ * "agent_output": "...final response of agent",
3219
+ * "log": "... full agent run log",
3220
+ * "log_id": periodic agent log id.,
3221
+ * }
3222
+ * ```
3223
+ * The payload is encrypted using the `callback_secret` provided.
3224
+ *
3225
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3226
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3227
+ *
3228
+ * ```python
3229
+ * import hmac
3230
+ * import haslib
3231
+ *
3232
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3233
+ * # Get the X-Hub-Signature-256 header from the request
3234
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3235
+ *
3236
+ * if not received_signature.startswith("sha256="):
3237
+ * # Invalid signature format
3238
+ * return False
3239
+ *
3240
+ * received_signature = received_signature[len("sha256=") :]
3241
+ *
3242
+ * try:
3243
+ * # Get the raw request body
3244
+ * payload = request.body
3245
+ *
3246
+ * # Compute the expected signature using the app_secret
3247
+ * expected_signature = hmac.new(
3248
+ * callback_secret.encode(), payload, hashlib.sha256
3249
+ * ).hexdigest()
3250
+ *
3251
+ * if hmac.compare_digest(received_signature, expected_signature):
3252
+ * # Signatures match, the payload is genuine
3253
+ * return True
3254
+ * else:
3255
+ * # Signatures don't match
3256
+ * return False
3257
+ * except Exception as e:
3258
+ * # Handle any errors that may occur during validation
3259
+ * return False
3260
+ *
3261
+ * ```
3262
+ * @param id A unique integer value identifying this periodic agent.
3263
+ * @param org
3264
+ * @param userId
3265
+ * @param requestBody
3266
+ * @returns PeriodicAgentCreate
3267
+ * @throws ApiError
3268
+ */
3269
+ static aiMentorOrgsUsersPeriodicAgentsUpdate(id: number, org: string, userId: string, requestBody: PeriodicAgentCreate): CancelablePromise<PeriodicAgentCreate>;
3270
+ /**
3271
+ * Endpoint to create and view, update and delete periodic agents.
3272
+ *
3273
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3274
+ * as well as a cron schedule to trigger the periodic agent.
3275
+ *
3276
+ * Access to these are restricted to platform admins and tenant administrators
3277
+ *
3278
+ * Session information for running the periodic agent will be generated with the credentials of the
3279
+ * user (platform administrator) who created the agent.
3280
+ *
3281
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3282
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3283
+ * of the run will be made to the callback_url provided.
3284
+ * Here is the payload structure:
3285
+ * ```
3286
+ * {
3287
+ * "timestamp": "timestamp when the run completed",
3288
+ * "status": "status of the periodic agent",
3289
+ * "prompt": "input prompt to agent,
3290
+ * "agent_output": "...final response of agent",
3291
+ * "log": "... full agent run log",
3292
+ * "log_id": periodic agent log id.,
3293
+ * }
3294
+ * ```
3295
+ * The payload is encrypted using the `callback_secret` provided.
3296
+ *
3297
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3298
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3299
+ *
3300
+ * ```python
3301
+ * import hmac
3302
+ * import haslib
3303
+ *
3304
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3305
+ * # Get the X-Hub-Signature-256 header from the request
3306
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3307
+ *
3308
+ * if not received_signature.startswith("sha256="):
3309
+ * # Invalid signature format
3310
+ * return False
3311
+ *
3312
+ * received_signature = received_signature[len("sha256=") :]
3313
+ *
3314
+ * try:
3315
+ * # Get the raw request body
3316
+ * payload = request.body
3317
+ *
3318
+ * # Compute the expected signature using the app_secret
3319
+ * expected_signature = hmac.new(
3320
+ * callback_secret.encode(), payload, hashlib.sha256
3321
+ * ).hexdigest()
3322
+ *
3323
+ * if hmac.compare_digest(received_signature, expected_signature):
3324
+ * # Signatures match, the payload is genuine
3325
+ * return True
3326
+ * else:
3327
+ * # Signatures don't match
3328
+ * return False
3329
+ * except Exception as e:
3330
+ * # Handle any errors that may occur during validation
3331
+ * return False
3332
+ *
3333
+ * ```
3334
+ * @param id A unique integer value identifying this periodic agent.
3335
+ * @param org
3336
+ * @param userId
3337
+ * @param requestBody
3338
+ * @returns PeriodicAgentCreate
3339
+ * @throws ApiError
3340
+ */
3341
+ static aiMentorOrgsUsersPeriodicAgentsPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedPeriodicAgentCreate): CancelablePromise<PeriodicAgentCreate>;
3342
+ /**
3343
+ * Endpoint to create and view, update and delete periodic agents.
3344
+ *
3345
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3346
+ * as well as a cron schedule to trigger the periodic agent.
3347
+ *
3348
+ * Access to these are restricted to platform admins and tenant administrators
3349
+ *
3350
+ * Session information for running the periodic agent will be generated with the credentials of the
3351
+ * user (platform administrator) who created the agent.
3352
+ *
3353
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3354
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3355
+ * of the run will be made to the callback_url provided.
3356
+ * Here is the payload structure:
3357
+ * ```
3358
+ * {
3359
+ * "timestamp": "timestamp when the run completed",
3360
+ * "status": "status of the periodic agent",
3361
+ * "prompt": "input prompt to agent,
3362
+ * "agent_output": "...final response of agent",
3363
+ * "log": "... full agent run log",
3364
+ * "log_id": periodic agent log id.,
3365
+ * }
3366
+ * ```
3367
+ * The payload is encrypted using the `callback_secret` provided.
3368
+ *
3369
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3370
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3371
+ *
3372
+ * ```python
3373
+ * import hmac
3374
+ * import haslib
3375
+ *
3376
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3377
+ * # Get the X-Hub-Signature-256 header from the request
3378
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3379
+ *
3380
+ * if not received_signature.startswith("sha256="):
3381
+ * # Invalid signature format
3382
+ * return False
3383
+ *
3384
+ * received_signature = received_signature[len("sha256=") :]
3385
+ *
3386
+ * try:
3387
+ * # Get the raw request body
3388
+ * payload = request.body
3389
+ *
3390
+ * # Compute the expected signature using the app_secret
3391
+ * expected_signature = hmac.new(
3392
+ * callback_secret.encode(), payload, hashlib.sha256
3393
+ * ).hexdigest()
3394
+ *
3395
+ * if hmac.compare_digest(received_signature, expected_signature):
3396
+ * # Signatures match, the payload is genuine
3397
+ * return True
3398
+ * else:
3399
+ * # Signatures don't match
3400
+ * return False
3401
+ * except Exception as e:
3402
+ * # Handle any errors that may occur during validation
3403
+ * return False
3404
+ *
3405
+ * ```
3406
+ * @param id A unique integer value identifying this periodic agent.
3407
+ * @param org
3408
+ * @param userId
3409
+ * @returns void
3410
+ * @throws ApiError
3411
+ */
3412
+ static aiMentorOrgsUsersPeriodicAgentsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
3413
+ /**
3414
+ * Retrieve pinned messages for a user.
3415
+ *
3416
+ * Args:
3417
+ * request: The HTTP request.
3418
+ * org: Organization key identifier.
3419
+ * user_id: The username of the student.
3420
+ *
3421
+ * Returns:
3422
+ * Response: Paginated list of pinned messages.
3423
+ *
3424
+ * Raises:
3425
+ * NotFound: If the student or session does not exist.
3426
+ * @param org
3427
+ * @param sessionId Session id of the message to pin
3428
+ * @param userId
3429
+ * @returns PinnedMessageGet
3430
+ * @throws ApiError
3431
+ */
3432
+ static aiMentorOrgsUsersPinMessageList(org: string, sessionId: string, userId: string): CancelablePromise<Array<PinnedMessageGet>>;
3433
+ /**
3434
+ * Create a pinned message for a user session.
3435
+ *
3436
+ * Args:
3437
+ * request: The HTTP request containing session details.
3438
+ * org: Organization key identifier.
3439
+ * user_id: The username of the student.
3440
+ *
3441
+ * Returns:
3442
+ * Response: Status 201 on success.
3443
+ *
3444
+ * Raises:
3445
+ * NotFound: If the student does not exist.
3446
+ * ValidationError: If request data is invalid.
3447
+ * @param org
3448
+ * @param userId
3449
+ * @param requestBody
3450
+ * @returns PinnedMessageCreate
3451
+ * @throws ApiError
3452
+ */
3453
+ static aiMentorOrgsUsersPinMessageCreate(org: string, userId: string, requestBody: PinnedMessageRequest): CancelablePromise<PinnedMessageCreate>;
3454
+ /**
3455
+ * Delete a pinned message for a user.
3456
+ *
3457
+ * Args:
3458
+ * request: The HTTP request containing session details.
3459
+ * org: Organization key identifier.
3460
+ * user_id: The username of the student.
3461
+ *
3462
+ * Returns:
3463
+ * Response: Status 204 on success.
3464
+ *
3465
+ * Raises:
3466
+ * NotFound: If the student or pinned message does not exist.
3467
+ * ValidationError: If request data is invalid.
3468
+ * @param org
3469
+ * @param userId
3470
+ * @returns void
3471
+ * @throws ApiError
3472
+ */
3473
+ static aiMentorOrgsUsersPinMessageDestroy(org: string, userId: string): CancelablePromise<void>;
3474
+ /**
3475
+ * Endpoints for viewing jobs and their status
3476
+ * A job run refers to a task with steps that an agent is going to undertake.
3477
+ * You can filter job runs by their status.
3478
+ * Note that for a single user and a specified session, at most only one JobRun instance
3479
+ * is active at any point in time.
3480
+ * @param org
3481
+ * @param userId
3482
+ * @param active
3483
+ * @param ordering Which field to use when ordering the results.
3484
+ * @param page A page number within the paginated result set.
3485
+ * @param pageSize Number of results to return per page.
3486
+ * @param search A search term.
3487
+ * @param session
3488
+ * @returns PaginatedJobRunList
3489
+ * @throws ApiError
3490
+ */
3491
+ static aiMentorOrgsUsersPlannedJobsList(org: string, userId: string, active?: boolean, ordering?: string, page?: number, pageSize?: number, search?: string, session?: string): CancelablePromise<PaginatedJobRunList>;
3492
+ /**
3493
+ * Endpoints for viewing jobs and their status
3494
+ * A job run refers to a task with steps that an agent is going to undertake.
3495
+ * You can filter job runs by their status.
3496
+ * Note that for a single user and a specified session, at most only one JobRun instance
3497
+ * is active at any point in time.
3498
+ * @param id A unique integer value identifying this job run.
3499
+ * @param org
3500
+ * @param userId
3501
+ * @returns JobRun
3502
+ * @throws ApiError
3503
+ */
3504
+ static aiMentorOrgsUsersPlannedJobsRetrieve(id: number, org: string, userId: string): CancelablePromise<JobRun>;
3505
+ /**
3506
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3507
+ * @param org
3508
+ * @param userId
3509
+ * @param isPublic
3510
+ * @param ordering Which field to use when ordering the results.
3511
+ * @param page A page number within the paginated result set.
3512
+ * @param pageSize Number of results to return per page.
3513
+ * @param search A search term.
3514
+ * @param student edX user ID
3515
+ * @returns PaginatedPlayWrightScriptList
3516
+ * @throws ApiError
3517
+ */
3518
+ static aiMentorOrgsUsersPlaywrightScriptsList(org: string, userId: string, isPublic?: boolean, ordering?: string, page?: number, pageSize?: number, search?: string, student?: number): CancelablePromise<PaginatedPlayWrightScriptList>;
3519
+ /**
3520
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3521
+ * @param org
3522
+ * @param userId
3523
+ * @param requestBody
3524
+ * @returns PlayWrightScript
3525
+ * @throws ApiError
3526
+ */
3527
+ static aiMentorOrgsUsersPlaywrightScriptsCreate(org: string, userId: string, requestBody: PlayWrightScript): CancelablePromise<PlayWrightScript>;
3528
+ /**
3529
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3530
+ * @param id A unique integer value identifying this play wright script.
3531
+ * @param org
3532
+ * @param userId
3533
+ * @returns PlayWrightScript
3534
+ * @throws ApiError
3535
+ */
3536
+ static aiMentorOrgsUsersPlaywrightScriptsRetrieve(id: number, org: string, userId: string): CancelablePromise<PlayWrightScript>;
3537
+ /**
3538
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3539
+ * @param id A unique integer value identifying this play wright script.
3540
+ * @param org
3541
+ * @param userId
3542
+ * @param requestBody
3543
+ * @returns PlayWrightScript
3544
+ * @throws ApiError
3545
+ */
3546
+ static aiMentorOrgsUsersPlaywrightScriptsUpdate(id: number, org: string, userId: string, requestBody: PlayWrightScript): CancelablePromise<PlayWrightScript>;
3547
+ /**
3548
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3549
+ * @param id A unique integer value identifying this play wright script.
3550
+ * @param org
3551
+ * @param userId
3552
+ * @param requestBody
3553
+ * @returns PlayWrightScript
3554
+ * @throws ApiError
3555
+ */
3556
+ static aiMentorOrgsUsersPlaywrightScriptsPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedPlayWrightScript): CancelablePromise<PlayWrightScript>;
3557
+ /**
3558
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3559
+ * @param id A unique integer value identifying this play wright script.
3560
+ * @param org
3561
+ * @param userId
3562
+ * @returns void
3563
+ * @throws ApiError
3564
+ */
3565
+ static aiMentorOrgsUsersPlaywrightScriptsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
3566
+ /**
3567
+ * Retrieve predictive analytics based on historical data variables.
3568
+ *
3569
+ * Args:
3570
+ * request: HTTP request containing predictive analytics input.
3571
+ * org: Organization key identifier.
3572
+ *
3573
+ * Returns:
3574
+ * - 200: Object containing predicted data.
3575
+ * - 400: When AI response cannot be loaded into JSON.
3576
+ * - 404: When OpenAI key for the tenant is not set.
3577
+ * - 429: When OpenAI request exceeds the rate limit.
3578
+ *
3579
+ * Example:
3580
+ * **POST** `/api/ai-prompt/orgs/main/users/johndoe/predictive-analytics/`
3581
+ * @param org
3582
+ * @param userId
3583
+ * @param requestBody
3584
+ * @returns PredictiveAnalyticsResponse
3585
+ * @throws ApiError
3586
+ */
3587
+ static aiMentorOrgsUsersPredictiveAnalyticsCreate(org: string, userId: string, requestBody: PredictiveAnalyticsRequest): CancelablePromise<PredictiveAnalyticsResponse>;
3588
+ /**
3589
+ * Retrieves recent chat messages based on provided query parameters.
3590
+ *
3591
+ * Returns:
3592
+ * 200: Paginated List of chat messages.
3593
+ * 400: Invalid query parameters.
3594
+ * @param org
3595
+ * @param userId
3596
+ * @returns any No response body
3597
+ * @throws ApiError
3598
+ */
3599
+ static aiMentorOrgsUsersRecentMessagesRetrieve(org: string, userId: string): CancelablePromise<any>;
3600
+ /**
3601
+ * Endpoint for listing most recently accessed mentors.
3602
+ *
3603
+ * Accessible to students and admins.
3604
+ *
3605
+ *
3606
+ * Returns:
3607
+ *
3608
+ * 200: List of most recently accessed mentors.
3609
+ *
3610
+ * 400: When request is not valid.
3611
+ * @param org
3612
+ * @param userId
3613
+ * @returns RecentlyAccessedMentor
3614
+ * @throws ApiError
3615
+ */
3616
+ static aiMentorOrgsUsersRecentlyAccessedMentorsList(org: string, userId: string): CancelablePromise<Array<RecentlyAccessedMentor>>;
3617
+ /**
3618
+ * Retrieve recommended courses for a specific user.
3619
+ *
3620
+ * Args:
3621
+ * request: The HTTP request containing query parameters.
3622
+ * org: The organization/tenant identifier.
3623
+ * user_id: The ID of the user to get recommendations for.
3624
+ *
3625
+ * Returns:
3626
+ * Response: A list of recommended courses.
3627
+ *
3628
+ * Raises:
3629
+ * BadRequest: If the query parameters are invalid.
3630
+ * NotFound: If the OpenAI API key for the tenant is not found.
3631
+ * TooManyRequests: If rate limits are exceeded.
3632
+ * ServerError: If there's an error processing the AI response.
3633
+ * @param org
3634
+ * @param userId
3635
+ * @param includeLearnerSkills Include available learner skills for search
3636
+ * @param includeMainCourses Include courses from the main tenant
3637
+ * @param rankByDifficulty Rank by course difficulty
3638
+ * @param returnCourseData Return course data
3639
+ * @param returnNumber Number of courses to return
3640
+ * @param searchTerms Terms to be searched
3641
+ * @returns RecommendCourseResponse
3642
+ * @throws ApiError
3643
+ */
3644
+ static aiMentorOrgsUsersRecommendCoursesRetrieve(org: string, userId: string, includeLearnerSkills?: boolean, includeMainCourses?: boolean, rankByDifficulty?: boolean, returnCourseData?: boolean, returnNumber?: number, searchTerms?: string): CancelablePromise<RecommendCourseResponse>;
3645
+ /**
3646
+ * Retrieve recommended course blocks for a specific user.
3647
+ *
3648
+ * Args:
3649
+ * request: The HTTP request containing query parameters.
3650
+ * org: The organization/tenant identifier.
3651
+ * user_id: The ID of the user to get recommendations for.
3652
+ *
3653
+ * Returns:
3654
+ * Response: A list of recommended course blocks.
3655
+ *
3656
+ * Raises:
3657
+ * BadRequest: If the query parameters are invalid.
3658
+ * @param org
3659
+ * @param userId
3660
+ * @param includeLearnerSkills Include available learner skills for search
3661
+ * @param includeMainCourses Include courses from the main tenant
3662
+ * @param rankByDifficulty Rank by course difficulty
3663
+ * @param returnCourseData Return course data
3664
+ * @param returnNumber Number of courses to return
3665
+ * @param searchTerms Terms to be searched
3666
+ * @returns RecommendCourseBlock
3667
+ * @throws ApiError
3668
+ */
3669
+ static aiMentorOrgsUsersRecommendCoursesBlockRetrieve(org: string, userId: string, includeLearnerSkills?: boolean, includeMainCourses?: boolean, rankByDifficulty?: boolean, returnCourseData?: boolean, returnNumber?: number, searchTerms?: string): CancelablePromise<RecommendCourseBlock>;
3670
+ /**
3671
+ * Search for web resources based on a query.
3672
+ *
3673
+ * Args:
3674
+ * request: The HTTP request containing the search query.
3675
+ * org: The organization/tenant identifier.
3676
+ * user_id: The ID of the user making the request.
3677
+ *
3678
+ * Returns:
3679
+ * Response: A list of web resources matching the query.
3680
+ *
3681
+ * Raises:
3682
+ * ValidationError: If the search fails or returns no results.
3683
+ * @param org
3684
+ * @param userId
3685
+ * @param requestBody
3686
+ * @returns WebResource
3687
+ * @throws ApiError
3688
+ */
3689
+ static aiMentorOrgsUsersResourcesWebCreate(org: string, userId: string, requestBody: WebResourcesQuery): CancelablePromise<Array<WebResource>>;
3690
+ /**
3691
+ * Endpoint to view and delete Safety System Logs for a tenant.
3692
+ *
3693
+ * These can be filtered by username, platform_key and mentor id
3694
+ *
3695
+ *
3696
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
3697
+ * @param org
3698
+ * @param userId
3699
+ * @param mentor
3700
+ * @param ordering Which field to use when ordering the results.
3701
+ * @param page A page number within the paginated result set.
3702
+ * @param pageSize Number of results to return per page.
3703
+ * @param platformKey
3704
+ * @param search A search term.
3705
+ * @param targetSystem * `Safety System` - Safety System
3706
+ * * `Moderation System` - Moderation System
3707
+ * @param username
3708
+ * @returns PaginatedModerationLogList
3709
+ * @throws ApiError
3710
+ */
3711
+ static aiMentorOrgsUsersSafetyLogsList(org: string, userId: string, mentor?: number, ordering?: string, page?: number, pageSize?: number, platformKey?: string, search?: string, targetSystem?: 'Moderation System' | 'Safety System', username?: string): CancelablePromise<PaginatedModerationLogList>;
3712
+ /**
3713
+ * Endpoint to view and delete Safety System Logs for a tenant.
3714
+ *
3715
+ * These can be filtered by username, platform_key and mentor id
3716
+ *
3717
+ *
3718
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
3719
+ * @param id A unique integer value identifying this moderation log.
3720
+ * @param org
3721
+ * @param userId
3722
+ * @returns ModerationLog
3723
+ * @throws ApiError
3724
+ */
3725
+ static aiMentorOrgsUsersSafetyLogsRetrieve(id: number, org: string, userId: string): CancelablePromise<ModerationLog>;
3726
+ /**
3727
+ * Endpoint to view and delete Safety System Logs for a tenant.
3728
+ *
3729
+ * These can be filtered by username, platform_key and mentor id
3730
+ *
3731
+ *
3732
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
3733
+ * @param id A unique integer value identifying this moderation log.
3734
+ * @param org
3735
+ * @param userId
3736
+ * @returns void
3737
+ * @throws ApiError
3738
+ */
3739
+ static aiMentorOrgsUsersSafetyLogsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
3740
+ /**
3741
+ * Retrieve session details including message counts and timestamps.
3742
+ *
3743
+ * Query Parameters:
3744
+ * page (optional, int): Page number for pagination.
3745
+ *
3746
+ * Returns:
3747
+ * - 200: Paginated list of session details.
3748
+ * - 404: Session not found.
3749
+ * @param mentor
3750
+ * @param org
3751
+ * @param userId
3752
+ * @param page Page number for pagination
3753
+ * @returns SessionDetail
3754
+ * @throws ApiError
3755
+ */
3756
+ static aiMentorOrgsUsersSessionDetailMentorsList(mentor: string, org: string, userId: string, page?: number): CancelablePromise<Array<SessionDetail>>;
3757
+ /**
3758
+ * Retrieve user sessions filtered by start date and end date.
3759
+ *
3760
+ * Query Parameters:
3761
+ * start_date (optional, ISO format): Start date for filtering sessions.
3762
+ * end_date (optional, ISO format): End date for filtering sessions.
3763
+ *
3764
+ * Returns:
3765
+ * - 200: List of session IDs with insertion timestamps.
3766
+ * - 400: Invalid request parameters.
3767
+ * @param org
3768
+ * @param userId
3769
+ * @param endDate
3770
+ * @param startDate
3771
+ * @returns ChatHistorySessionId
3772
+ * @throws ApiError
3773
+ */
3774
+ static aiMentorOrgsUsersSessionidList(org: string, userId: string, endDate?: string, startDate?: string): CancelablePromise<Array<ChatHistorySessionId>>;
3775
+ /**
3776
+ * Retrieve or create a chat session with a mentor.
3777
+ *
3778
+ * Passing `null` as `tools` results in using all tools assigned to the mentor.
3779
+ * To specify that no tools be used, pass an empty list.
3780
+ *
3781
+ * Args:
3782
+ * request: HTTP request containing mentor details.
3783
+ * org: Organization key identifier.
3784
+ * user_id (optional): Username for authentication (if required by the mentor).
3785
+ *
3786
+ * Returns:
3787
+ * Response: JSON object containing the session ID.
3788
+ *
3789
+ * Raises:
3790
+ * Http404: If the mentor is not found.
3791
+ * ValidationError: If the username is invalid.
3792
+ * ValidationError: If one or more tool slugs are invalid.
3793
+ * @param org
3794
+ * @param userId
3795
+ * @param requestBody
3796
+ * @returns ChatSessionResponse
3797
+ * @throws ApiError
3798
+ */
3799
+ static aiMentorOrgsUsersSessionsCreate(org: string, userId: string, requestBody: ChatSessionRequest): CancelablePromise<ChatSessionResponse>;
3800
+ /**
3801
+ * Retrieve Chat Messages
3802
+ * Fetches chat messages for a specific session.
3803
+ * @param org
3804
+ * @param sessionId
3805
+ * @param userId
3806
+ * @param share
3807
+ * @returns MessageView
3808
+ * @throws ApiError
3809
+ */
3810
+ static aiMentorOrgsUsersSessionsRetrieve(org: string, sessionId: string, userId: string, share?: boolean): CancelablePromise<MessageView>;
3811
+ /**
3812
+ * Update the title of a chat session and its tools
3813
+ * @param org
3814
+ * @param sessionId
3815
+ * @param userId
3816
+ * @param requestBody
3817
+ * @returns MessageViewUpdatResponse
3818
+ * @throws ApiError
3819
+ */
3820
+ static aiMentorOrgsUsersSessionsUpdate(org: string, sessionId: string, userId: string, requestBody?: MessageViewRequest): CancelablePromise<MessageViewUpdatResponse>;
3821
+ /**
3822
+ * Deletes all messages in a chat session.
3823
+ * @param org
3824
+ * @param sessionId
3825
+ * @param userId
3826
+ * @returns void
3827
+ * @throws ApiError
3828
+ */
3829
+ static aiMentorOrgsUsersSessionsDestroy(org: string, sessionId: string, userId: string): CancelablePromise<void>;
3830
+ /**
3831
+ * Endpoint to fetch the logs of a session.
3832
+ * Logs are cached for up to 1 hour of their creation: accessing the logs after an hour will result in an empty data.
3833
+ *
3834
+ * This is intentional and made to avoid cases where logs bloat our in-memory db.
3835
+ *
3836
+ * Accessible to tenant admins and students.
3837
+ *
3838
+ * Url Args:
3839
+ * org (str): The organization's platform key.
3840
+ * user_id (str): The username identifier of the individual.
3841
+ * session_id (str): The session id.
3842
+ *
3843
+ * Returns:
3844
+ *
3845
+ * 200: a SessionBrowserScreenshot object
3846
+ * @param org
3847
+ * @param sessionId
3848
+ * @param userId
3849
+ * @returns SessionBrowserScreenshot
3850
+ * @throws ApiError
3851
+ */
3852
+ static aiMentorOrgsUsersSessionsBrowserScreenshotRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<SessionBrowserScreenshot>;
3853
+ /**
3854
+ * Retrieves the chat history for a session as a plain text file.
3855
+ *
3856
+ * Returns:
3857
+ * 200: txt file containing coversation
3858
+ * @param org
3859
+ * @param sessionId
3860
+ * @param userId
3861
+ * @returns any No response body
3862
+ * @throws ApiError
3863
+ */
3864
+ static aiMentorOrgsUsersSessionsDownloadSessionRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<any>;
3865
+ /**
3866
+ * Retrieve memory data for a specific session.
3867
+ *
3868
+ * This endpoint returns the memory components (knowledge gaps, lessons learned,
3869
+ * help requests) that were generated during the specified chat session.
3870
+ *
3871
+ * Args:
3872
+ * org: The organization/tenant identifier.
3873
+ * user_id: The ID of the user who owns the session.
3874
+ * session_id: The ID of the session to retrieve memory for.
3875
+ *
3876
+ * Returns:
3877
+ * Response: The memory data associated with the session.
3878
+ *
3879
+ * Raises:
3880
+ * NotFound: If the session does not exist or does not belong to the user.
3881
+ * @param org
3882
+ * @param sessionId
3883
+ * @param userId
3884
+ * @returns SessionMemoryStorage
3885
+ * @throws ApiError
3886
+ */
3887
+ static aiMentorOrgsUsersSessionsMemoryRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<SessionMemoryStorage>;
3888
+ /**
3889
+ * Retrieve shell logs for a specific session.
3890
+ *
3891
+ * Args:
3892
+ * request: The HTTP request.
3893
+ * org: The organization/tenant identifier.
3894
+ * user_id: The ID of the user who owns the session.
3895
+ * session_id: The ID of the session to retrieve logs for.
3896
+ *
3897
+ * Returns:
3898
+ * Response: The shell logs for the specified session.
3899
+ *
3900
+ * Raises:
3901
+ * NotFound: If the specified session does not exist.
3902
+ * @param org
3903
+ * @param sessionId
3904
+ * @param userId
3905
+ * @returns ShellLogs
3906
+ * @throws ApiError
3907
+ */
3908
+ static aiMentorOrgsUsersSessionsShellLogsRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<ShellLogs>;
3909
+ /**
3910
+ * Retrieve a list of related questions based on a chat session.
3911
+ * @param org
3912
+ * @param sessionId
3913
+ * @param userId
3914
+ * @param numQuestions
3915
+ * @returns RelatedText
3916
+ * @throws ApiError
3917
+ */
3918
+ static aiMentorOrgsUsersSessionsSuggestionList(org: string, sessionId: string, userId: string, numQuestions?: number): CancelablePromise<Array<RelatedText>>;
3919
+ /**
3920
+ * Retrieves the chat history for a given session if the export task is ready.
3921
+ *
3922
+ * Returns:
3923
+ *
3924
+ * 200: When task is not ready.
3925
+ *
3926
+ * 200: chat history object
3927
+ *
3928
+ * 400: When data is not valid.
3929
+ * @param org
3930
+ * @param sessionId
3931
+ * @param taskId
3932
+ * @param userId
3933
+ * @param toCsv Choose download in csv or not
3934
+ * @returns ChatHistoryItem
3935
+ * @throws ApiError
3936
+ */
3937
+ static aiMentorOrgsUsersSessionsTasksRetrieve(org: string, sessionId: string, taskId: string, userId: string, toCsv?: boolean): CancelablePromise<ChatHistoryItem>;
3938
+ /**
3939
+ * Retrieve all LLM models assigned to a specific tenant.
3940
+ *
3941
+ * Args:
3942
+ * request: The HTTP request.
3943
+ * org: The unique identifier of the tenant.
3944
+ *
3945
+ * Returns:
3946
+ * Response: A list of LLM models assigned to the tenant.
3947
+ *
3948
+ * Raises:
3949
+ * NotFound: If the specified tenant does not have any associated models.
3950
+ * ValidationError: If an unexpected error occurs.
3951
+ * @param org
3952
+ * @param userId
3953
+ * @returns LLMModelForTenant
3954
+ * @throws ApiError
3955
+ */
3956
+ static aiMentorOrgsUsersSettingsTenantLlmList(org: string, userId: string): CancelablePromise<Array<LLMModelForTenant>>;
3957
+ /**
3958
+ * Create or update an LLM model for a tenant.
3959
+ *
3960
+ * Accessible only to tenant administrators.
3961
+ *
3962
+ * Args:
3963
+ * request: The HTTP request containing LLM model details.
3964
+ * org: The unique identifier of the tenant.
3965
+ *
3966
+ * Returns:
3967
+ * Response: Details of the newly created or updated LLM model.
3968
+ *
3969
+ * Raises:
3970
+ * ValidationError: If request data is invalid.
3971
+ * NotFound: If the tenant does not exist.
3972
+ * @param org
3973
+ * @param userId
3974
+ * @param requestBody
3975
+ * @returns LLMModelForTenant
3976
+ * @throws ApiError
3977
+ */
3978
+ static aiMentorOrgsUsersSettingsTenantLlmCreate(org: string, userId: string, requestBody: LLMModelForTenant): CancelablePromise<LLMModelForTenant>;
3979
+ /**
3980
+ * Retrieve a list of mentors starred by a specific user.
3981
+ *
3982
+ * Args:
3983
+ * request: The HTTP request.
3984
+ * org: The organization/tenant identifier.
3985
+ * user_id: The ID of the user to retrieve starred mentors for.
3986
+ *
3987
+ * Returns:
3988
+ * Response: A list of the user's starred mentors, sorted by most recently accessed.
3989
+ *
3990
+ * Raises:
3991
+ * NotFound: If the specified student does not exist.
3992
+ * BadRequest: If the request is invalid.
3993
+ * @param org
3994
+ * @param userId
3995
+ * @returns StarMentor
3996
+ * @throws ApiError
3997
+ */
3998
+ static aiMentorOrgsUsersStarredMentorsList(org: string, userId: string): CancelablePromise<Array<StarMentor>>;
3999
+ /**
4000
+ * Retrieves the status of a task using its task ID.
4001
+ *
4002
+ * Accessible to both tenant admins and students.
4003
+ *
4004
+ * Returns:
4005
+ *
4006
+ * 200: task id
4007
+ * @param org
4008
+ * @param taskId
4009
+ * @param userId
4010
+ * @returns RetrieveTask
4011
+ * @throws ApiError
4012
+ */
4013
+ static aiMentorOrgsUsersTasksRetrieve(org: string, taskId: string, userId: string): CancelablePromise<RetrieveTask>;
4014
+ /**
4015
+ * Export chat history for a session.
4016
+ *
4017
+ * Returns:
4018
+ * 200: Task ID for the export operation.
4019
+ * @param org
4020
+ * @param sessionId
4021
+ * @param userId
4022
+ * @param requestBody
4023
+ * @returns TaskView
4024
+ * @throws ApiError
4025
+ */
4026
+ static aiMentorOrgsUsersTasksSessionsCreate(org: string, sessionId: string, userId: string, requestBody: TaskView): CancelablePromise<TaskView>;
4027
+ /**
4028
+ * Retrieve a list of available voice options.
4029
+ *
4030
+ * Args:
4031
+ * request: The HTTP request.
4032
+ *
4033
+ * Returns:
4034
+ * Response: A list of available voice options.
4035
+ *
4036
+ * Raises:
4037
+ * NotFound: If no voice options are available.
4038
+ * @param org
4039
+ * @param userId
4040
+ * @param ordering Which field to use when ordering the results.
4041
+ * @param page A page number within the paginated result set.
4042
+ * @param pageSize Number of results to return per page.
4043
+ * @param provider * `openai` - Openai
4044
+ * * `google` - Google
4045
+ * * `elevenlabs` - Elevenlabs
4046
+ * @param search A search term.
4047
+ * @returns PaginatedVoiceList
4048
+ * @throws ApiError
4049
+ */
4050
+ static aiMentorOrgsUsersVoicesList(org: string, userId: string, ordering?: string, page?: number, pageSize?: number, provider?: 'elevenlabs' | 'google' | 'openai', search?: string): CancelablePromise<PaginatedVoiceList>;
4051
+ /**
4052
+ * Retrieve details of a specific voice option.
4053
+ *
4054
+ * Args:
4055
+ * request: The HTTP request.
4056
+ * pk: The primary key of the voice option to retrieve.
4057
+ *
4058
+ * Returns:
4059
+ * Response: The details of the specified voice option.
4060
+ *
4061
+ * Raises:
4062
+ * NotFound: If the specified voice option does not exist.
4063
+ * @param id A unique integer value identifying this voice.
4064
+ * @param org
4065
+ * @param userId
4066
+ * @returns Voice
4067
+ * @throws ApiError
4068
+ */
4069
+ static aiMentorOrgsUsersVoicesRetrieve(id: number, org: string, userId: string): CancelablePromise<Voice>;
4070
+ /**
4071
+ * @param org
4072
+ * @param slug
4073
+ * @returns any No response body
4074
+ * @throws ApiError
4075
+ */
4076
+ static aiMentorOrgsWebhooksAzureTriggerCreate(org: string, slug: string): CancelablePromise<any>;
4077
+ /**
4078
+ * Handle incoming POST requests from GitHub webhook for pull requests.
4079
+ *
4080
+ * Args:
4081
+ * request: The HTTP request object containing the webhook payload.
4082
+ * org: the organizaion name.
4083
+ *
4084
+ * Returns:
4085
+ * Response: A response indicating the result of processing the webhook event.
4086
+ * @param org
4087
+ * @returns any No response body
4088
+ * @throws ApiError
4089
+ */
4090
+ static aiMentorOrgsWebhooksGithubPullrequestCreate(org: string): CancelablePromise<any>;
4091
+ /**
4092
+ * @returns any No response body
4093
+ * @throws ApiError
4094
+ */
4095
+ static aiMentorWebhooksAzureEmailchatCreate(): CancelablePromise<any>;
4096
+ }