@iblai/iblai-api 3.65.1-core → 3.65.2-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 (616) hide show
  1. package/dist/index.cjs.js +17437 -1345
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +17432 -1346
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +17437 -1345
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +299 -2
  8. package/dist/types/models/AIGeneratedImage.d.ts +13 -0
  9. package/dist/types/models/AIUserProfileMemoryRelation.d.ts +4 -0
  10. package/dist/types/models/AIUserProfileRequest.d.ts +4 -0
  11. package/dist/types/models/APITokenCost.d.ts +14 -0
  12. package/dist/types/models/AccessEnum.d.ts +8 -0
  13. package/dist/types/models/AlignMentorBubbleEnum.d.ts +8 -0
  14. package/dist/types/models/AnalyticsOverview.d.ts +7 -0
  15. package/dist/types/models/Answer.d.ts +11 -0
  16. package/dist/types/models/AssumedKnowledge.d.ts +4 -0
  17. package/dist/types/models/AssumedKnowledgeLevel.d.ts +4 -0
  18. package/dist/types/models/AudioToTextRequest.d.ts +3 -0
  19. package/dist/types/models/AudioToTextResponse.d.ts +3 -0
  20. package/dist/types/models/CallAuthenticationRequest.d.ts +13 -0
  21. package/dist/types/models/CallAuthenticationResponse.d.ts +21 -0
  22. package/dist/types/models/CallConfiguration.d.ts +26 -0
  23. package/dist/types/models/CallConfigurationModeEnum.d.ts +8 -0
  24. package/dist/types/models/ChatHistory.d.ts +8 -0
  25. package/dist/types/models/ChatHistoryFilterData.d.ts +9 -0
  26. package/dist/types/models/ChatHistoryFilterUser.d.ts +5 -0
  27. package/dist/types/models/ChatHistoryItem.d.ts +5 -0
  28. package/dist/types/models/ChatHistorySessionId.d.ts +3 -0
  29. package/dist/types/models/ChatSessionRequest.d.ts +14 -0
  30. package/dist/types/models/ChatSessionResponse.d.ts +5 -0
  31. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +10 -0
  32. package/dist/types/models/ComponentBlock.d.ts +9 -0
  33. package/dist/types/models/ComponentBlockTypeEnum.d.ts +8 -0
  34. package/dist/types/models/ConversationMessage.d.ts +11 -0
  35. package/dist/types/models/ConversationRating.d.ts +6 -0
  36. package/dist/types/models/ConversationSummary.d.ts +5 -0
  37. package/dist/types/models/ConversationVolume.d.ts +4 -0
  38. package/dist/types/models/Conversations.d.ts +28 -0
  39. package/dist/types/models/Cost.d.ts +3 -0
  40. package/dist/types/models/CostPerTenant.d.ts +6 -0
  41. package/dist/types/models/CourseCreationTask.d.ts +31 -0
  42. package/dist/types/models/CourseCreationTaskFile.d.ts +7 -0
  43. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +16 -0
  44. package/dist/types/models/CrawlerPatternTypeEnum.d.ts +8 -0
  45. package/dist/types/models/CredentialRequest.d.ts +14 -0
  46. package/dist/types/models/CrontabSchedule.d.ts +22 -0
  47. package/dist/types/models/CustomInstructionResponse.d.ts +13 -0
  48. package/dist/types/models/DateRange.d.ts +4 -0
  49. package/dist/types/models/Document.d.ts +41 -0
  50. package/dist/types/models/DocumentFacet.d.ts +17 -0
  51. package/dist/types/models/DocumentSearchResponse.d.ts +35 -0
  52. package/dist/types/models/DocumentSettingsResponse.d.ts +3 -0
  53. package/dist/types/models/EdxCourse.d.ts +11 -0
  54. package/dist/types/models/ElevenlabsCustomVoice.d.ts +4 -0
  55. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +8 -0
  56. package/dist/types/models/EmailPromptDetail.d.ts +13 -0
  57. package/dist/types/models/EmailPromptList.d.ts +11 -0
  58. package/dist/types/models/EmailPromptSummary.d.ts +5 -0
  59. package/dist/types/models/FreeUsageCount.d.ts +3 -0
  60. package/dist/types/models/FullCourse.d.ts +13 -0
  61. package/dist/types/models/GreetingMethodEnum.d.ts +8 -0
  62. package/dist/types/models/GuidedPromptsResponse.d.ts +3 -0
  63. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +8 -0
  64. package/dist/types/models/HeygenMarketingVideoList.d.ts +6 -0
  65. package/dist/types/models/HeygenTemplateRequest.d.ts +5 -0
  66. package/dist/types/models/HeygenTemplateResponseSingle.d.ts +6 -0
  67. package/dist/types/models/HeygenVideoDetail.d.ts +8 -0
  68. package/dist/types/models/HeygenVideoRequest.d.ts +5 -0
  69. package/dist/types/models/HumanSupportTicket.d.ts +21 -0
  70. package/dist/types/models/HumanSupportTicketStatusEnum.d.ts +10 -0
  71. package/dist/types/models/IBLAIPlatformMeta.d.ts +3 -0
  72. package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +6 -0
  73. package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +10 -0
  74. package/dist/types/models/InputQuestion.d.ts +6 -0
  75. package/dist/types/models/IntegrationCredential.d.ts +8 -0
  76. package/dist/types/models/IntialQuestionAnswer.d.ts +3 -0
  77. package/dist/types/models/JobRun.d.ts +11 -0
  78. package/dist/types/models/KindEnum.d.ts +10 -0
  79. package/dist/types/models/LLMCredentialRequest.d.ts +14 -0
  80. package/dist/types/models/LLMCredentialResponse.d.ts +8 -0
  81. package/dist/types/models/LLMModelForTenant.d.ts +6 -0
  82. package/dist/types/models/LLMQuestion.d.ts +15 -0
  83. package/dist/types/models/LLMResponse.d.ts +14 -0
  84. package/dist/types/models/LLMTracesListResponse.d.ts +5 -0
  85. package/dist/types/models/LanguagesView.d.ts +5 -0
  86. package/dist/types/models/LinkCourseRequest.d.ts +3 -0
  87. package/dist/types/models/LinkCourseResponse.d.ts +5 -0
  88. package/dist/types/models/LlmProviderEnum.d.ts +8 -0
  89. package/dist/types/models/MCPServer.d.ts +21 -0
  90. package/dist/types/models/MemoryComponentData.d.ts +5 -0
  91. package/dist/types/models/MemoryComponentMemory.d.ts +4 -0
  92. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +8 -0
  93. package/dist/types/models/MemoryComponentResponse.d.ts +5 -0
  94. package/dist/types/models/MemoryProgress.d.ts +8 -0
  95. package/dist/types/models/MemoryStatusRequestView.d.ts +6 -0
  96. package/dist/types/models/MemoryStatusView.d.ts +6 -0
  97. package/dist/types/models/Mentor.d.ts +87 -0
  98. package/dist/types/models/MentorAudience.d.ts +5 -0
  99. package/dist/types/models/MentorCategory.d.ts +9 -0
  100. package/dist/types/models/MentorCategoryCreate.d.ts +11 -0
  101. package/dist/types/models/MentorCategoryGroup.d.ts +11 -0
  102. package/dist/types/models/MentorCategoryGroupCreate.d.ts +11 -0
  103. package/dist/types/models/MentorCreate.d.ts +84 -0
  104. package/dist/types/models/MentorCustomVoice.d.ts +4 -0
  105. package/dist/types/models/MentorCustomVoiceResponse.d.ts +4 -0
  106. package/dist/types/models/MentorData.d.ts +7 -0
  107. package/dist/types/models/MentorDetailAnalytics.d.ts +6 -0
  108. package/dist/types/models/MentorEval.d.ts +11 -0
  109. package/dist/types/models/MentorEvalQuestion.d.ts +5 -0
  110. package/dist/types/models/MentorEvalQuestionRequest.d.ts +4 -0
  111. package/dist/types/models/MentorEvalReport.d.ts +10 -0
  112. package/dist/types/models/MentorEvalRequest.d.ts +8 -0
  113. package/dist/types/models/MentorFacet.d.ts +17 -0
  114. package/dist/types/models/MentorFork.d.ts +5 -0
  115. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +47 -0
  116. package/dist/types/models/MentorMemorySettingsRequest.d.ts +6 -0
  117. package/dist/types/models/MentorMemorySettingsResponse.d.ts +6 -0
  118. package/dist/types/models/MentorMetadata.d.ts +5 -0
  119. package/dist/types/models/MentorScenario.d.ts +6 -0
  120. package/dist/types/models/MentorScenarioPrompt.d.ts +5 -0
  121. package/dist/types/models/MentorSearchResponse.d.ts +35 -0
  122. package/dist/types/models/MentorSession.d.ts +4 -0
  123. package/dist/types/models/MentorSettings.d.ts +76 -0
  124. package/dist/types/models/MentorSettingsPublic.d.ts +52 -0
  125. package/dist/types/models/MentorSettingsRequest.d.ts +62 -0
  126. package/dist/types/models/MentorVisibilityEnum.d.ts +10 -0
  127. package/dist/types/models/MentorWizard.d.ts +4 -0
  128. package/dist/types/models/MessageStatistics.d.ts +5 -0
  129. package/dist/types/models/MessageView.d.ts +10 -0
  130. package/dist/types/models/MessageViewRequest.d.ts +7 -0
  131. package/dist/types/models/MessageViewUpdatResponse.d.ts +3 -0
  132. package/dist/types/models/Metadata.d.ts +5 -0
  133. package/dist/types/models/MetricChange.d.ts +4 -0
  134. package/dist/types/models/ModelCost.d.ts +4 -0
  135. package/dist/types/models/ModerationLog.d.ts +11 -0
  136. package/dist/types/models/NoChatMessagesFound.d.ts +3 -0
  137. package/dist/types/models/NotificationSource.d.ts +2 -2
  138. package/dist/types/models/{TypeEnum.d.ts → NotificationSourceTypeEnum.d.ts} +1 -1
  139. package/dist/types/models/NullEnum.d.ts +1 -0
  140. package/dist/types/models/Observation.d.ts +31 -0
  141. package/dist/types/models/PageContent.d.ts +6 -0
  142. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +7 -0
  143. package/dist/types/models/PaginatedConversationsList.d.ts +7 -0
  144. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +7 -0
  145. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +7 -0
  146. package/dist/types/models/PaginatedEdxCourseList.d.ts +7 -0
  147. package/dist/types/models/PaginatedEmailPromptListList.d.ts +7 -0
  148. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +7 -0
  149. package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +7 -0
  150. package/dist/types/models/PaginatedHumanSupportTicketList.d.ts +7 -0
  151. package/dist/types/models/PaginatedJobRunList.d.ts +7 -0
  152. package/dist/types/models/PaginatedMCPServerList.d.ts +7 -0
  153. package/dist/types/models/PaginatedMentorList.d.ts +7 -0
  154. package/dist/types/models/PaginatedModerationLogList.d.ts +7 -0
  155. package/dist/types/models/PaginatedObservationList.d.ts +7 -0
  156. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +7 -0
  157. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +7 -0
  158. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +7 -0
  159. package/dist/types/models/PaginatedRetrieverDocumentEmbeddingList.d.ts +7 -0
  160. package/dist/types/models/PaginatedSectionList.d.ts +7 -0
  161. package/dist/types/models/PaginatedSubSectionList.d.ts +7 -0
  162. package/dist/types/models/PaginatedTicketMessageList.d.ts +7 -0
  163. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +7 -0
  164. package/dist/types/models/PaginatedTraceList.d.ts +7 -0
  165. package/dist/types/models/PaginatedUnitList.d.ts +7 -0
  166. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +7 -0
  167. package/dist/types/models/PaginatedVoiceList.d.ts +7 -0
  168. package/dist/types/models/PatchedCallConfiguration.d.ts +26 -0
  169. package/dist/types/models/PatchedConversations.d.ts +28 -0
  170. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +7 -0
  171. package/dist/types/models/PatchedCredentialRequest.d.ts +14 -0
  172. package/dist/types/models/PatchedHumanSupportTicket.d.ts +21 -0
  173. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +14 -0
  174. package/dist/types/models/PatchedMCPServer.d.ts +21 -0
  175. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +11 -0
  176. package/dist/types/models/PatchedMentorCreate.d.ts +84 -0
  177. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +41 -0
  178. package/dist/types/models/PatchedPlayWrightScript.d.ts +12 -0
  179. package/dist/types/models/PatchedPrompt.d.ts +22 -0
  180. package/dist/types/models/PatchedSection.d.ts +9 -0
  181. package/dist/types/models/PatchedSubSection.d.ts +9 -0
  182. package/dist/types/models/PatchedTicketMessage.d.ts +10 -0
  183. package/dist/types/models/PatchedUnit.d.ts +11 -0
  184. package/dist/types/models/PeriodicAgent.d.ts +42 -0
  185. package/dist/types/models/PeriodicAgentCreate.d.ts +41 -0
  186. package/dist/types/models/PeriodicAgentLog.d.ts +11 -0
  187. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +10 -0
  188. package/dist/types/models/PeriodicTask.d.ts +21 -0
  189. package/dist/types/models/PieChartData.d.ts +5 -0
  190. package/dist/types/models/PieChartSegment.d.ts +4 -0
  191. package/dist/types/models/PinnedMessageCreate.d.ts +9 -0
  192. package/dist/types/models/PinnedMessageGet.d.ts +7 -0
  193. package/dist/types/models/PinnedMessageRequest.d.ts +6 -0
  194. package/dist/types/models/PlayWrightScript.d.ts +12 -0
  195. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +4 -0
  196. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +4 -0
  197. package/dist/types/models/PreviousAgentStatusEnum.d.ts +12 -0
  198. package/dist/types/models/Prompt.d.ts +22 -0
  199. package/dist/types/models/PromptCategory.d.ts +7 -0
  200. package/dist/types/models/PromptFacet.d.ts +17 -0
  201. package/dist/types/models/PromptSearchResponse.d.ts +35 -0
  202. package/dist/types/models/PromptVisibilityEnum.d.ts +10 -0
  203. package/dist/types/models/ProviderEnum.d.ts +10 -0
  204. package/dist/types/models/QuestionCardTag.d.ts +8 -0
  205. package/dist/types/models/QuestionRequest.d.ts +15 -0
  206. package/dist/types/models/QuestionResponse.d.ts +10 -0
  207. package/dist/types/models/RatingEnum.d.ts +8 -0
  208. package/dist/types/models/RatingRecord.d.ts +4 -0
  209. package/dist/types/models/RecentlyAccessedMentor.d.ts +8 -0
  210. package/dist/types/models/RecommendCourseBlock.d.ts +3 -0
  211. package/dist/types/models/RecommendCourseResponse.d.ts +3 -0
  212. package/dist/types/models/RecommendedCoursesResponse.d.ts +33 -0
  213. package/dist/types/models/RelatedText.d.ts +3 -0
  214. package/dist/types/models/RequestDataVariable.d.ts +14 -0
  215. package/dist/types/models/ResourceScrappedData.d.ts +13 -0
  216. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +12 -0
  217. package/dist/types/models/ResponseDataVariable.d.ts +14 -0
  218. package/dist/types/models/RetreiverTrainViewRequest.d.ts +10 -0
  219. package/dist/types/models/RetreiverTrainViewResponse.d.ts +6 -0
  220. package/dist/types/models/RetrieveTask.d.ts +3 -0
  221. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +28 -0
  222. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +62 -0
  223. package/dist/types/models/RetrieverRequestSearch.d.ts +10 -0
  224. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +10 -0
  225. package/dist/types/models/RetrieverResponseSearch.d.ts +7 -0
  226. package/dist/types/models/ReuestDataVariableList.d.ts +4 -0
  227. package/dist/types/models/RunMentorEval.d.ts +3 -0
  228. package/dist/types/models/ScanWebhookRequest.d.ts +6 -0
  229. package/dist/types/models/ScanWebhookResponse.d.ts +3 -0
  230. package/dist/types/models/Section.d.ts +9 -0
  231. package/dist/types/models/SectionWithChildren.d.ts +11 -0
  232. package/dist/types/models/SeedMentorsView.d.ts +3 -0
  233. package/dist/types/models/SentimentSummary.d.ts +4 -0
  234. package/dist/types/models/SessionBrowserScreenshot.d.ts +8 -0
  235. package/dist/types/models/SessionDetail.d.ts +6 -0
  236. package/dist/types/models/SessionMemoryStorage.d.ts +6 -0
  237. package/dist/types/models/ShareableMentorLink.d.ts +8 -0
  238. package/dist/types/models/ShellLogs.d.ts +3 -0
  239. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +3 -0
  240. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +5 -0
  241. package/dist/types/models/StarMentor.d.ts +7 -0
  242. package/dist/types/models/Status6eeEnum.d.ts +12 -0
  243. package/dist/types/models/Step.d.ts +9 -0
  244. package/dist/types/models/StepStatusEnum.d.ts +10 -0
  245. package/dist/types/models/StripeCheckoutSessionRequest.d.ts +2 -2
  246. package/dist/types/models/{ModeEnum.d.ts → StripeCheckoutSessionRequestModeEnum.d.ts} +1 -1
  247. package/dist/types/models/SttProviderEnum.d.ts +12 -0
  248. package/dist/types/models/StudentChatMessage.d.ts +4 -0
  249. package/dist/types/models/StylesView.d.ts +4 -0
  250. package/dist/types/models/SubSection.d.ts +9 -0
  251. package/dist/types/models/SubSectionWithChildren.d.ts +11 -0
  252. package/dist/types/models/TagsView.d.ts +5 -0
  253. package/dist/types/models/TargetSystemEnum.d.ts +8 -0
  254. package/dist/types/models/TaskView.d.ts +3 -0
  255. package/dist/types/models/TemplateMentor.d.ts +9 -0
  256. package/dist/types/models/TenantMentorTraces.d.ts +6 -0
  257. package/dist/types/models/ThemeEnum.d.ts +8 -0
  258. package/dist/types/models/TicketMessage.d.ts +10 -0
  259. package/dist/types/models/TonesView.d.ts +4 -0
  260. package/dist/types/models/ToolResponse.d.ts +11 -0
  261. package/dist/types/models/TopicModel.d.ts +3 -0
  262. package/dist/types/models/TopicRecord.d.ts +4 -0
  263. package/dist/types/models/TopicStatistics.d.ts +7 -0
  264. package/dist/types/models/TopicStatisticsResponse.d.ts +6 -0
  265. package/dist/types/models/TopicSummaryView.d.ts +4 -0
  266. package/dist/types/models/Trace.d.ts +17 -0
  267. package/dist/types/models/TrainChatSessionDocumentView.d.ts +6 -0
  268. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +6 -0
  269. package/dist/types/models/TrainDocumentViewRequest.d.ts +66 -0
  270. package/dist/types/models/TrainDocumentViewResponse.d.ts +15 -0
  271. package/dist/types/models/TrainingStatusEnum.d.ts +12 -0
  272. package/dist/types/models/TransportEnum.d.ts +8 -0
  273. package/dist/types/models/TrendEntry.d.ts +4 -0
  274. package/dist/types/models/TriggerRequest.d.ts +5 -0
  275. package/dist/types/models/TriggerResponse.d.ts +6 -0
  276. package/dist/types/models/TtsProviderEnum.d.ts +10 -0
  277. package/dist/types/models/TypeC42Enum.d.ts +8 -0
  278. package/dist/types/models/Unit.d.ts +11 -0
  279. package/dist/types/models/UnitWithChildren.d.ts +13 -0
  280. package/dist/types/models/UseMainCreds.d.ts +3 -0
  281. package/dist/types/models/UserAllChatMemoryView.d.ts +7 -0
  282. package/dist/types/models/UserCatalogItemMemoryView.d.ts +14 -0
  283. package/dist/types/models/UserChatByPeriod.d.ts +4 -0
  284. package/dist/types/models/UserChatFeedback.d.ts +14 -0
  285. package/dist/types/models/UserChatFeedbackCount.d.ts +4 -0
  286. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +6 -0
  287. package/dist/types/models/UserChatMemoryStatusView.d.ts +6 -0
  288. package/dist/types/models/UserChatMemoryUpdateView.d.ts +10 -0
  289. package/dist/types/models/UserCountRecord.d.ts +4 -0
  290. package/dist/types/models/UserEdxMemory.d.ts +15 -0
  291. package/dist/types/models/UserMemoryContextRequest.d.ts +13 -0
  292. package/dist/types/models/UserMemoryContextResponse.d.ts +12 -0
  293. package/dist/types/models/UserMetric.d.ts +4 -0
  294. package/dist/types/models/UserMetricsResponse.d.ts +7 -0
  295. package/dist/types/models/UserSentimentCountView.d.ts +4 -0
  296. package/dist/types/models/UserTrendByPeriod.d.ts +5 -0
  297. package/dist/types/models/VectorResult.d.ts +8 -0
  298. package/dist/types/models/VideoCaption.d.ts +3 -0
  299. package/dist/types/models/Voice.d.ts +9 -0
  300. package/dist/types/models/WebResource.d.ts +9 -0
  301. package/dist/types/models/WebResourceCard.d.ts +7 -0
  302. package/dist/types/models/WebResourcesQuery.d.ts +3 -0
  303. package/dist/types/services/AiAccountService.d.ts +319 -0
  304. package/dist/types/services/AiAnalyticsService.d.ts +3934 -0
  305. package/dist/types/services/AiIndexService.d.ts +408 -0
  306. package/dist/types/services/AiMarketingService.d.ts +38 -0
  307. package/dist/types/services/AiMediaService.d.ts +122 -0
  308. package/dist/types/services/AiMentorService.d.ts +5259 -0
  309. package/dist/types/services/AiPromptService.d.ts +1034 -0
  310. package/dist/types/services/SearchService.d.ts +726 -0
  311. package/package.json +1 -1
  312. package/src/core/OpenAPI.ts +1 -1
  313. package/src/index.ts +299 -2
  314. package/src/models/AIGeneratedImage.ts +18 -0
  315. package/src/models/AIUserProfileMemoryRelation.ts +9 -0
  316. package/src/models/AIUserProfileRequest.ts +9 -0
  317. package/src/models/APITokenCost.ts +19 -0
  318. package/src/models/AccessEnum.ts +12 -0
  319. package/src/models/AlignMentorBubbleEnum.ts +12 -0
  320. package/src/models/AnalyticsOverview.ts +12 -0
  321. package/src/models/Answer.ts +16 -0
  322. package/src/models/AssumedKnowledge.ts +9 -0
  323. package/src/models/AssumedKnowledgeLevel.ts +9 -0
  324. package/src/models/AudioToTextRequest.ts +8 -0
  325. package/src/models/AudioToTextResponse.ts +8 -0
  326. package/src/models/CallAuthenticationRequest.ts +18 -0
  327. package/src/models/CallAuthenticationResponse.ts +26 -0
  328. package/src/models/CallConfiguration.ts +31 -0
  329. package/src/models/CallConfigurationModeEnum.ts +12 -0
  330. package/src/models/ChatHistory.ts +13 -0
  331. package/src/models/ChatHistoryFilterData.ts +14 -0
  332. package/src/models/ChatHistoryFilterUser.ts +10 -0
  333. package/src/models/ChatHistoryItem.ts +10 -0
  334. package/src/models/ChatHistorySessionId.ts +8 -0
  335. package/src/models/ChatSessionRequest.ts +19 -0
  336. package/src/models/ChatSessionResponse.ts +10 -0
  337. package/src/models/CheckDocumentTrainingStatus.ts +15 -0
  338. package/src/models/ComponentBlock.ts +14 -0
  339. package/src/models/ComponentBlockTypeEnum.ts +12 -0
  340. package/src/models/ConversationMessage.ts +16 -0
  341. package/src/models/ConversationRating.ts +11 -0
  342. package/src/models/ConversationSummary.ts +10 -0
  343. package/src/models/ConversationVolume.ts +9 -0
  344. package/src/models/Conversations.ts +33 -0
  345. package/src/models/Cost.ts +8 -0
  346. package/src/models/CostPerTenant.ts +11 -0
  347. package/src/models/CourseCreationTask.ts +36 -0
  348. package/src/models/CourseCreationTaskFile.ts +12 -0
  349. package/src/models/CourseCreationTaskStatusEnum.ts +20 -0
  350. package/src/models/CrawlerPatternTypeEnum.ts +12 -0
  351. package/src/models/CredentialRequest.ts +19 -0
  352. package/src/models/CrontabSchedule.ts +27 -0
  353. package/src/models/CustomInstructionResponse.ts +18 -0
  354. package/src/models/DateRange.ts +9 -0
  355. package/src/models/Document.ts +46 -0
  356. package/src/models/DocumentFacet.ts +22 -0
  357. package/src/models/DocumentSearchResponse.ts +40 -0
  358. package/src/models/DocumentSettingsResponse.ts +8 -0
  359. package/src/models/EdxCourse.ts +16 -0
  360. package/src/models/ElevenlabsCustomVoice.ts +9 -0
  361. package/src/models/ElevenlabsCustomVoiceResponse.ts +13 -0
  362. package/src/models/EmailPromptDetail.ts +18 -0
  363. package/src/models/EmailPromptList.ts +16 -0
  364. package/src/models/EmailPromptSummary.ts +10 -0
  365. package/src/models/FreeUsageCount.ts +8 -0
  366. package/src/models/FullCourse.ts +18 -0
  367. package/src/models/GreetingMethodEnum.ts +12 -0
  368. package/src/models/GuidedPromptsResponse.ts +8 -0
  369. package/src/models/HeygenMarketingVideoDetail.ts +13 -0
  370. package/src/models/HeygenMarketingVideoList.ts +11 -0
  371. package/src/models/HeygenTemplateRequest.ts +10 -0
  372. package/src/models/HeygenTemplateResponseSingle.ts +11 -0
  373. package/src/models/HeygenVideoDetail.ts +13 -0
  374. package/src/models/HeygenVideoRequest.ts +10 -0
  375. package/src/models/HumanSupportTicket.ts +26 -0
  376. package/src/models/HumanSupportTicketStatusEnum.ts +14 -0
  377. package/src/models/IBLAIPlatformMeta.ts +8 -0
  378. package/src/models/IBLAIPlatformMetaRequest.ts +11 -0
  379. package/src/models/IBLAIPlatformMetaUpdateRequest.ts +15 -0
  380. package/src/models/InputQuestion.ts +11 -0
  381. package/src/models/IntegrationCredential.ts +13 -0
  382. package/src/models/IntialQuestionAnswer.ts +8 -0
  383. package/src/models/JobRun.ts +16 -0
  384. package/src/models/KindEnum.ts +14 -0
  385. package/src/models/LLMCredentialRequest.ts +19 -0
  386. package/src/models/LLMCredentialResponse.ts +13 -0
  387. package/src/models/LLMModelForTenant.ts +11 -0
  388. package/src/models/LLMQuestion.ts +20 -0
  389. package/src/models/LLMResponse.ts +19 -0
  390. package/src/models/LLMTracesListResponse.ts +10 -0
  391. package/src/models/LanguagesView.ts +10 -0
  392. package/src/models/LinkCourseRequest.ts +8 -0
  393. package/src/models/LinkCourseResponse.ts +10 -0
  394. package/src/models/LlmProviderEnum.ts +12 -0
  395. package/src/models/MCPServer.ts +26 -0
  396. package/src/models/MemoryComponentData.ts +10 -0
  397. package/src/models/MemoryComponentMemory.ts +9 -0
  398. package/src/models/MemoryComponentMemoryDetail.ts +13 -0
  399. package/src/models/MemoryComponentResponse.ts +10 -0
  400. package/src/models/MemoryProgress.ts +13 -0
  401. package/src/models/MemoryStatusRequestView.ts +11 -0
  402. package/src/models/MemoryStatusView.ts +11 -0
  403. package/src/models/Mentor.ts +92 -0
  404. package/src/models/MentorAudience.ts +10 -0
  405. package/src/models/MentorCategory.ts +14 -0
  406. package/src/models/MentorCategoryCreate.ts +16 -0
  407. package/src/models/MentorCategoryGroup.ts +16 -0
  408. package/src/models/MentorCategoryGroupCreate.ts +16 -0
  409. package/src/models/MentorCreate.ts +89 -0
  410. package/src/models/MentorCustomVoice.ts +9 -0
  411. package/src/models/MentorCustomVoiceResponse.ts +9 -0
  412. package/src/models/MentorData.ts +12 -0
  413. package/src/models/MentorDetailAnalytics.ts +11 -0
  414. package/src/models/MentorEval.ts +16 -0
  415. package/src/models/MentorEvalQuestion.ts +10 -0
  416. package/src/models/MentorEvalQuestionRequest.ts +9 -0
  417. package/src/models/MentorEvalReport.ts +15 -0
  418. package/src/models/MentorEvalRequest.ts +13 -0
  419. package/src/models/MentorFacet.ts +22 -0
  420. package/src/models/MentorFork.ts +10 -0
  421. package/src/models/MentorFromTemplateWithSettingRequest.ts +52 -0
  422. package/src/models/MentorMemorySettingsRequest.ts +11 -0
  423. package/src/models/MentorMemorySettingsResponse.ts +11 -0
  424. package/src/models/MentorMetadata.ts +10 -0
  425. package/src/models/MentorScenario.ts +11 -0
  426. package/src/models/MentorScenarioPrompt.ts +10 -0
  427. package/src/models/MentorSearchResponse.ts +40 -0
  428. package/src/models/MentorSession.ts +9 -0
  429. package/src/models/MentorSettings.ts +81 -0
  430. package/src/models/MentorSettingsPublic.ts +57 -0
  431. package/src/models/MentorSettingsRequest.ts +67 -0
  432. package/src/models/MentorVisibilityEnum.ts +14 -0
  433. package/src/models/MentorWizard.ts +9 -0
  434. package/src/models/MessageStatistics.ts +10 -0
  435. package/src/models/MessageView.ts +15 -0
  436. package/src/models/MessageViewRequest.ts +12 -0
  437. package/src/models/MessageViewUpdatResponse.ts +8 -0
  438. package/src/models/Metadata.ts +10 -0
  439. package/src/models/MetricChange.ts +9 -0
  440. package/src/models/ModelCost.ts +9 -0
  441. package/src/models/ModerationLog.ts +16 -0
  442. package/src/models/NoChatMessagesFound.ts +8 -0
  443. package/src/models/NotificationSource.ts +2 -2
  444. package/src/models/{TypeEnum.ts → NotificationSourceTypeEnum.ts} +1 -1
  445. package/src/models/NullEnum.ts +7 -0
  446. package/src/models/Observation.ts +36 -0
  447. package/src/models/PageContent.ts +11 -0
  448. package/src/models/PaginatedAIGeneratedImageList.ts +12 -0
  449. package/src/models/PaginatedConversationsList.ts +12 -0
  450. package/src/models/PaginatedCourseCreationTaskFileList.ts +12 -0
  451. package/src/models/PaginatedCourseCreationTaskList.ts +12 -0
  452. package/src/models/PaginatedEdxCourseList.ts +12 -0
  453. package/src/models/PaginatedEmailPromptListList.ts +12 -0
  454. package/src/models/PaginatedHeygenMarketingVideoListList.ts +12 -0
  455. package/src/models/PaginatedHeygenTemplateResponseSingleList.ts +12 -0
  456. package/src/models/PaginatedHumanSupportTicketList.ts +12 -0
  457. package/src/models/PaginatedJobRunList.ts +12 -0
  458. package/src/models/PaginatedMCPServerList.ts +12 -0
  459. package/src/models/PaginatedMentorList.ts +12 -0
  460. package/src/models/PaginatedModerationLogList.ts +12 -0
  461. package/src/models/PaginatedObservationList.ts +12 -0
  462. package/src/models/PaginatedPeriodicAgentList.ts +12 -0
  463. package/src/models/PaginatedPeriodicAgentLogList.ts +12 -0
  464. package/src/models/PaginatedPlayWrightScriptList.ts +12 -0
  465. package/src/models/PaginatedRetrieverDocumentEmbeddingList.ts +12 -0
  466. package/src/models/PaginatedSectionList.ts +12 -0
  467. package/src/models/PaginatedSubSectionList.ts +12 -0
  468. package/src/models/PaginatedTicketMessageList.ts +12 -0
  469. package/src/models/PaginatedTopicStatisticsResponse.ts +12 -0
  470. package/src/models/PaginatedTraceList.ts +12 -0
  471. package/src/models/PaginatedUnitList.ts +12 -0
  472. package/src/models/PaginatedUserEdxMemoryList.ts +12 -0
  473. package/src/models/PaginatedVoiceList.ts +12 -0
  474. package/src/models/PatchedCallConfiguration.ts +31 -0
  475. package/src/models/PatchedConversations.ts +33 -0
  476. package/src/models/PatchedCourseCreationTaskFile.ts +12 -0
  477. package/src/models/PatchedCredentialRequest.ts +19 -0
  478. package/src/models/PatchedHumanSupportTicket.ts +26 -0
  479. package/src/models/PatchedLLMCredentialRequest.ts +19 -0
  480. package/src/models/PatchedMCPServer.ts +26 -0
  481. package/src/models/PatchedMentorCategoryGroupCreate.ts +16 -0
  482. package/src/models/PatchedMentorCreate.ts +89 -0
  483. package/src/models/PatchedPeriodicAgentCreate.ts +46 -0
  484. package/src/models/PatchedPlayWrightScript.ts +17 -0
  485. package/src/models/PatchedPrompt.ts +27 -0
  486. package/src/models/PatchedSection.ts +14 -0
  487. package/src/models/PatchedSubSection.ts +14 -0
  488. package/src/models/PatchedTicketMessage.ts +15 -0
  489. package/src/models/PatchedUnit.ts +16 -0
  490. package/src/models/PeriodicAgent.ts +47 -0
  491. package/src/models/PeriodicAgentCreate.ts +46 -0
  492. package/src/models/PeriodicAgentLog.ts +16 -0
  493. package/src/models/PeriodicAgentLogStatusEnum.ts +14 -0
  494. package/src/models/PeriodicTask.ts +26 -0
  495. package/src/models/PieChartData.ts +10 -0
  496. package/src/models/PieChartSegment.ts +9 -0
  497. package/src/models/PinnedMessageCreate.ts +14 -0
  498. package/src/models/PinnedMessageGet.ts +12 -0
  499. package/src/models/PinnedMessageRequest.ts +11 -0
  500. package/src/models/PlayWrightScript.ts +17 -0
  501. package/src/models/PredictiveAnalyticsRequest.ts +9 -0
  502. package/src/models/PredictiveAnalyticsResponse.ts +9 -0
  503. package/src/models/PreviousAgentStatusEnum.ts +16 -0
  504. package/src/models/Prompt.ts +27 -0
  505. package/src/models/PromptCategory.ts +12 -0
  506. package/src/models/PromptFacet.ts +22 -0
  507. package/src/models/PromptSearchResponse.ts +40 -0
  508. package/src/models/PromptVisibilityEnum.ts +14 -0
  509. package/src/models/ProviderEnum.ts +14 -0
  510. package/src/models/QuestionCardTag.ts +13 -0
  511. package/src/models/QuestionRequest.ts +20 -0
  512. package/src/models/QuestionResponse.ts +15 -0
  513. package/src/models/RatingEnum.ts +12 -0
  514. package/src/models/RatingRecord.ts +9 -0
  515. package/src/models/RecentlyAccessedMentor.ts +13 -0
  516. package/src/models/RecommendCourseBlock.ts +8 -0
  517. package/src/models/RecommendCourseResponse.ts +8 -0
  518. package/src/models/RecommendedCoursesResponse.ts +38 -0
  519. package/src/models/RelatedText.ts +8 -0
  520. package/src/models/RequestDataVariable.ts +19 -0
  521. package/src/models/ResourceScrappedData.ts +18 -0
  522. package/src/models/ResourceScrappedDataStatusEnum.ts +16 -0
  523. package/src/models/ResponseDataVariable.ts +19 -0
  524. package/src/models/RetreiverTrainViewRequest.ts +15 -0
  525. package/src/models/RetreiverTrainViewResponse.ts +11 -0
  526. package/src/models/RetrieveTask.ts +8 -0
  527. package/src/models/RetrieverDocumentEmbedding.ts +33 -0
  528. package/src/models/RetrieverDocumentEmbeddingRequest.ts +67 -0
  529. package/src/models/RetrieverRequestSearch.ts +15 -0
  530. package/src/models/RetrieverRequestSearchDocument.ts +15 -0
  531. package/src/models/RetrieverResponseSearch.ts +12 -0
  532. package/src/models/ReuestDataVariableList.ts +9 -0
  533. package/src/models/RunMentorEval.ts +8 -0
  534. package/src/models/ScanWebhookRequest.ts +11 -0
  535. package/src/models/ScanWebhookResponse.ts +8 -0
  536. package/src/models/Section.ts +14 -0
  537. package/src/models/SectionWithChildren.ts +16 -0
  538. package/src/models/SeedMentorsView.ts +8 -0
  539. package/src/models/SentimentSummary.ts +9 -0
  540. package/src/models/SessionBrowserScreenshot.ts +13 -0
  541. package/src/models/SessionDetail.ts +11 -0
  542. package/src/models/SessionMemoryStorage.ts +11 -0
  543. package/src/models/ShareableMentorLink.ts +13 -0
  544. package/src/models/ShellLogs.ts +8 -0
  545. package/src/models/SpacedRepetitionLearningPath.ts +8 -0
  546. package/src/models/SpacedRepetitionQuestionStats.ts +10 -0
  547. package/src/models/StarMentor.ts +12 -0
  548. package/src/models/Status6eeEnum.ts +16 -0
  549. package/src/models/Step.ts +14 -0
  550. package/src/models/StepStatusEnum.ts +14 -0
  551. package/src/models/StripeCheckoutSessionRequest.ts +2 -2
  552. package/src/models/{ModeEnum.ts → StripeCheckoutSessionRequestModeEnum.ts} +1 -1
  553. package/src/models/SttProviderEnum.ts +16 -0
  554. package/src/models/StudentChatMessage.ts +9 -0
  555. package/src/models/StylesView.ts +9 -0
  556. package/src/models/SubSection.ts +14 -0
  557. package/src/models/SubSectionWithChildren.ts +16 -0
  558. package/src/models/TagsView.ts +10 -0
  559. package/src/models/TargetSystemEnum.ts +12 -0
  560. package/src/models/TaskView.ts +8 -0
  561. package/src/models/TemplateMentor.ts +14 -0
  562. package/src/models/TenantMentorTraces.ts +11 -0
  563. package/src/models/ThemeEnum.ts +12 -0
  564. package/src/models/TicketMessage.ts +15 -0
  565. package/src/models/TonesView.ts +9 -0
  566. package/src/models/ToolResponse.ts +16 -0
  567. package/src/models/TopicModel.ts +8 -0
  568. package/src/models/TopicRecord.ts +9 -0
  569. package/src/models/TopicStatistics.ts +12 -0
  570. package/src/models/TopicStatisticsResponse.ts +11 -0
  571. package/src/models/TopicSummaryView.ts +9 -0
  572. package/src/models/Trace.ts +22 -0
  573. package/src/models/TrainChatSessionDocumentView.ts +11 -0
  574. package/src/models/TrainChatSessionDocumentViewRequest.ts +11 -0
  575. package/src/models/TrainDocumentViewRequest.ts +71 -0
  576. package/src/models/TrainDocumentViewResponse.ts +20 -0
  577. package/src/models/TrainingStatusEnum.ts +16 -0
  578. package/src/models/TransportEnum.ts +12 -0
  579. package/src/models/TrendEntry.ts +9 -0
  580. package/src/models/TriggerRequest.ts +10 -0
  581. package/src/models/TriggerResponse.ts +11 -0
  582. package/src/models/TtsProviderEnum.ts +14 -0
  583. package/src/models/TypeC42Enum.ts +12 -0
  584. package/src/models/Unit.ts +16 -0
  585. package/src/models/UnitWithChildren.ts +18 -0
  586. package/src/models/UseMainCreds.ts +8 -0
  587. package/src/models/UserAllChatMemoryView.ts +12 -0
  588. package/src/models/UserCatalogItemMemoryView.ts +19 -0
  589. package/src/models/UserChatByPeriod.ts +9 -0
  590. package/src/models/UserChatFeedback.ts +19 -0
  591. package/src/models/UserChatFeedbackCount.ts +9 -0
  592. package/src/models/UserChatMemoryStatusRequestView.ts +11 -0
  593. package/src/models/UserChatMemoryStatusView.ts +11 -0
  594. package/src/models/UserChatMemoryUpdateView.ts +15 -0
  595. package/src/models/UserCountRecord.ts +9 -0
  596. package/src/models/UserEdxMemory.ts +20 -0
  597. package/src/models/UserMemoryContextRequest.ts +18 -0
  598. package/src/models/UserMemoryContextResponse.ts +17 -0
  599. package/src/models/UserMetric.ts +9 -0
  600. package/src/models/UserMetricsResponse.ts +12 -0
  601. package/src/models/UserSentimentCountView.ts +9 -0
  602. package/src/models/UserTrendByPeriod.ts +10 -0
  603. package/src/models/VectorResult.ts +13 -0
  604. package/src/models/VideoCaption.ts +8 -0
  605. package/src/models/Voice.ts +14 -0
  606. package/src/models/WebResource.ts +14 -0
  607. package/src/models/WebResourceCard.ts +12 -0
  608. package/src/models/WebResourcesQuery.ts +8 -0
  609. package/src/services/AiAccountService.ts +505 -0
  610. package/src/services/AiAnalyticsService.ts +10127 -3575
  611. package/src/services/AiIndexService.ts +719 -0
  612. package/src/services/AiMarketingService.ts +96 -0
  613. package/src/services/AiMediaService.ts +289 -0
  614. package/src/services/AiMentorService.ts +9698 -0
  615. package/src/services/AiPromptService.ts +1980 -0
  616. package/src/services/SearchService.ts +1440 -398
@@ -2,12 +2,131 @@
2
2
  /* istanbul ignore file */
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
+ import type { DocumentSearchResponse } from '../models/DocumentSearchResponse';
5
6
  import type { GlobalCatalogSearchResponse } from '../models/GlobalCatalogSearchResponse';
7
+ import type { MentorSearchResponse } from '../models/MentorSearchResponse';
8
+ import type { PromptSearchResponse } from '../models/PromptSearchResponse';
9
+ import type { RecommendedCoursesResponse } from '../models/RecommendedCoursesResponse';
6
10
  import type { UserSearchResponse } from '../models/UserSearchResponse';
7
11
  import type { CancelablePromise } from '../core/CancelablePromise';
8
12
  import { OpenAPI } from '../core/OpenAPI';
9
13
  import { request as __request } from '../core/request';
10
14
  export class SearchService {
15
+ /**
16
+ * Legacy endpoint for backward compatible mentor search
17
+ * @returns MentorSearchResponse
18
+ * @throws ApiError
19
+ */
20
+ public static searchAiSearchRetrieve({
21
+ audience,
22
+ category,
23
+ createdBy,
24
+ filterFacet = false,
25
+ id,
26
+ limit = 12,
27
+ llm,
28
+ offset,
29
+ orderBy,
30
+ orderDirection = 'desc',
31
+ page,
32
+ pageSize,
33
+ query,
34
+ tags,
35
+ tenant,
36
+ uniqueId,
37
+ }: {
38
+ /**
39
+ * Filter by target audience
40
+ */
41
+ audience?: Array<string>,
42
+ /**
43
+ * Filter by mentor category
44
+ */
45
+ category?: Array<string>,
46
+ /**
47
+ * Filter mentors created by specific user
48
+ */
49
+ createdBy?: string,
50
+ /**
51
+ * If present, return only facets without results
52
+ */
53
+ filterFacet?: boolean,
54
+ /**
55
+ * Retrieve a specific mentor by ID
56
+ */
57
+ id?: number,
58
+ /**
59
+ * Number of results per page
60
+ */
61
+ limit?: number,
62
+ /**
63
+ * Filter by language model type
64
+ */
65
+ llm?: Array<string>,
66
+ /**
67
+ * Starting position for pagination
68
+ */
69
+ offset?: number,
70
+ /**
71
+ * Field to sort results by ('created_at', 'recently_accessed_at')
72
+ */
73
+ orderBy?: string,
74
+ /**
75
+ * Sort direction ('asc' or 'desc')
76
+ */
77
+ orderDirection?: string,
78
+ /**
79
+ * Page number (1-based, used with page_size)
80
+ */
81
+ page?: number,
82
+ /**
83
+ * Number of results per page
84
+ */
85
+ pageSize?: number,
86
+ /**
87
+ * Search term to filter mentors by name or description
88
+ */
89
+ query?: string,
90
+ /**
91
+ * Filter by tags
92
+ */
93
+ tags?: Array<string>,
94
+ /**
95
+ * Filter by tenant/organization
96
+ */
97
+ tenant?: string,
98
+ /**
99
+ * Retrieve a specific mentor by UUID
100
+ */
101
+ uniqueId?: string,
102
+ }): CancelablePromise<MentorSearchResponse> {
103
+ return __request(OpenAPI, {
104
+ method: 'GET',
105
+ url: '/api/search/ai-search/',
106
+ query: {
107
+ 'audience': audience,
108
+ 'category': category,
109
+ 'created_by': createdBy,
110
+ 'filter_facet': filterFacet,
111
+ 'id': id,
112
+ 'limit': limit,
113
+ 'llm': llm,
114
+ 'offset': offset,
115
+ 'order_by': orderBy,
116
+ 'order_direction': orderDirection,
117
+ 'page': page,
118
+ 'page_size': pageSize,
119
+ 'query': query,
120
+ 'tags': tags,
121
+ 'tenant': tenant,
122
+ 'unique_id': uniqueId,
123
+ },
124
+ errors: {
125
+ 400: `Bad request`,
126
+ 500: `Server error`,
127
+ },
128
+ });
129
+ }
11
130
  /**
12
131
  * Search and filter content across the learning catalog.
13
132
  *
@@ -365,411 +484,1334 @@ export class SearchService {
365
484
  });
366
485
  }
367
486
  /**
368
- * Determine whether to serve a detail view or a list view.
369
- * If any detail-identifying parameters are present (course_id, program_id, etc.)
370
- * the detail view is returned; otherwise the aggregated list view is returned.
371
- * @returns any
372
- * @throws ApiError
373
- */
374
- public static searchPersonalizedCatalogRetrieve({
375
- username,
376
- allowSkillSearch = false,
377
- alphabetical = false,
378
- certificate,
379
- content,
380
- courseId,
381
- duration,
382
- language,
383
- level,
384
- limit = 12,
385
- offset,
386
- orderAscending = false,
387
- orderBy,
388
- pathwayId,
389
- price,
390
- programId,
391
- programType,
392
- promotion,
393
- query,
394
- recommended = false,
395
- resourceId,
396
- resourceType,
397
- returnFacet = true,
398
- returnItems = false,
399
- roleId,
400
- selfPaced,
401
- skillId,
402
- skills,
403
- subject,
404
- tags,
405
- tenant,
406
- topics,
407
- updateFacet,
408
- }: {
409
- username: string,
410
- /**
411
- * Enable skill-based search
412
- */
413
- allowSkillSearch?: boolean,
414
- /**
415
- * Sort alphabetically by name
416
- */
417
- alphabetical?: boolean,
418
- /**
419
- * Filter by certificate type
420
- */
421
- certificate?: Array<string>,
422
- /**
423
- * Content types to include in results
424
- */
425
- content?: Array<string>,
426
- /**
427
- * Retrieve a specific course by ID
428
- */
429
- courseId?: string,
430
- /**
431
- * Filter by course duration range
432
- */
433
- duration?: Array<string>,
434
- /**
435
- * Filter by content language
436
- */
437
- language?: Array<string>,
438
- /**
439
- * Filter by difficulty level
440
- */
441
- level?: Array<string>,
442
- /**
443
- * Number of results per page
444
- */
445
- limit?: number,
446
- /**
447
- * Starting position for pagination
448
- */
449
- offset?: number,
450
- /**
451
- * Sort direction
452
- */
453
- orderAscending?: boolean,
454
- /**
455
- * Field to sort results by
456
- */
457
- orderBy?: string,
458
- /**
459
- * Retrieve a specific pathway by ID
460
- */
461
- pathwayId?: string,
462
- /**
463
- * Filter by price/audit status
464
- */
465
- price?: string,
466
- /**
467
- * Retrieve a specific program by ID
468
- */
469
- programId?: string,
470
- /**
471
- * Filter by program type
472
- */
473
- programType?: Array<string>,
474
- /**
475
- * Filter by promotion status
476
- */
477
- promotion?: Array<string>,
478
- /**
479
- * Search term to filter content by name or description
480
- */
481
- query?: string,
482
- /**
483
- * Show only recommended content
484
- */
485
- recommended?: boolean,
486
- /**
487
- * Retrieve a specific resource by ID
488
- */
489
- resourceId?: string,
490
- /**
491
- * Filter by resource type
492
- */
493
- resourceType?: Array<string>,
494
- /**
495
- * Include facet data in response
496
- */
497
- returnFacet?: boolean,
498
- /**
499
- * Include items in programs/pathways
500
- */
501
- returnItems?: boolean,
502
- /**
503
- * Retrieve a specific role by ID
504
- */
505
- roleId?: string,
506
- /**
507
- * Filter by course format
508
- */
509
- selfPaced?: Array<string>,
510
- /**
511
- * Retrieve a specific skill by ID
512
- */
513
- skillId?: string,
514
- /**
515
- * Filter by skills
516
- */
517
- skills?: Array<string>,
518
- /**
519
- * Filter by subject areas
520
- */
521
- subject?: Array<string>,
522
- /**
523
- * Filter by tags
524
- */
525
- tags?: Array<string>,
526
- /**
527
- * Filter by tenant/organization
528
- */
529
- tenant?: Array<string>,
530
- /**
531
- * Filter by topic areas
532
- */
533
- topics?: Array<string>,
534
- /**
535
- * Force facet update
536
- */
537
- updateFacet?: string,
538
- }): CancelablePromise<Record<string, any>> {
539
- return __request(OpenAPI, {
540
- method: 'GET',
541
- url: '/api/search/personalized-catalog/{username}/',
542
- path: {
543
- 'username': username,
544
- },
545
- query: {
546
- 'allow_skill_search': allowSkillSearch,
547
- 'alphabetical': alphabetical,
548
- 'certificate': certificate,
549
- 'content': content,
550
- 'course_id': courseId,
551
- 'duration': duration,
552
- 'language': language,
553
- 'level': level,
554
- 'limit': limit,
555
- 'offset': offset,
556
- 'order_ascending': orderAscending,
557
- 'order_by': orderBy,
558
- 'pathway_id': pathwayId,
559
- 'price': price,
560
- 'program_id': programId,
561
- 'program_type': programType,
562
- 'promotion': promotion,
563
- 'query': query,
564
- 'recommended': recommended,
565
- 'resource_id': resourceId,
566
- 'resource_type': resourceType,
567
- 'return_facet': returnFacet,
568
- 'return_items': returnItems,
569
- 'role_id': roleId,
570
- 'self_paced': selfPaced,
571
- 'skill_id': skillId,
572
- 'skills': skills,
573
- 'subject': subject,
574
- 'tags': tags,
575
- 'tenant': tenant,
576
- 'topics': topics,
577
- 'update_facet': updateFacet,
578
- },
579
- });
580
- }
581
- /**
582
- * Search and filter users within a specific organization/tenant.
487
+ * Search and filter AI mentors across the platform.
583
488
  *
584
- * This endpoint provides a search interface for discovering users within an organization,
585
- * with support for filtering by departments, pagination, and faceted filtering.
586
- *
587
- * Path Parameters:
588
- * org (str): The organization/tenant identifier
589
- * username (str): The username of the user making the request
489
+ * This endpoint provides a powerful search interface for discovering AI mentors
490
+ * with support for filtering, pagination, and detailed mentor information.
590
491
  *
591
492
  * Query Parameters:
592
- * # Search parameters
593
- * query (str, optional): Search term to filter users by name, username, or email
594
- *
595
- * # Department filtering
596
- * department_mode (bool, optional): Enable department-based filtering (default: false)
597
- * user_department (bool, optional): Legacy parameter for department_mode (default: false)
598
- * department (list, optional): Filter by specific departments
493
+ * # Identification parameters (for detail view)
494
+ * id (int, optional): Retrieve a specific mentor by ID
495
+ * unique_id (uuid, optional): Retrieve a specific mentor by UUID
599
496
  *
600
- * # Additional filters
601
- * role (list, optional): Filter by user role
602
- * status (list, optional): Filter by user status (active, inactive)
603
- * joined_date (list, optional): Filter by join date range
604
- * last_login (list, optional): Filter by last login date range
497
+ * # Search and filtering parameters
498
+ * query (str, optional): Search term to filter mentors by name or description
499
+ * tenant (str, optional): Filter by tenant/organization
500
+ * llm (list, optional): Filter by language model type
501
+ * audience (list, optional): Filter by target audience
502
+ * category (list, optional): Filter by mentor category
503
+ * tags (list, optional): Filter by tags
504
+ * created_by (str, optional): Filter mentors created by specific user
605
505
  *
606
- * # Pagination
607
- * limit (int, optional): Number of results per page (default: 10)
506
+ * # Sorting and pagination
507
+ * order_by (str, optional): Field to sort results by ('created_at', 'recently_accessed_at')
508
+ * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
509
+ * limit (int, optional): Number of results per page (default: 12, max: 100)
608
510
  * offset (int, optional): Starting position for pagination
609
511
  *
610
512
  * Returns:
611
- * A JSON response containing:
612
- * ```
513
+ * For detail view (when id or unique_id is provided):
514
+ * A JSON response containing a single mentor's details:
613
515
  * {
614
- * "results": [
615
- * {
616
- * "id": 123,
617
- * "username": "john.doe",
618
- * "email": "john.doe@example.com",
619
- * "first_name": "John",
620
- * "last_name": "Doe",
621
- * "full_name": "John Doe",
622
- * "profile_image": "https://example.com/profiles/john-doe.jpg",
623
- * "role": "Student",
624
- * "departments": ["Computer Science", "Data Science"],
625
- * "status": "active",
626
- * "joined_date": "2023-01-15T12:00:00Z",
627
- * "last_login": "2023-06-20T15:30:00Z",
628
- * "metadata": {
629
- * "location": "New York",
630
- * "title": "Software Engineer",
631
- * "bio": "Experienced software engineer with a passion for education"
632
- * }
516
+ * "id": 123,
517
+ * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
518
+ * "name": "Professor Smith",
519
+ * "description": "AI mentor specializing in computer science",
520
+ * "image_url": "https://example.com/images/prof-smith.jpg",
521
+ * "llm": {
522
+ * "id": 1,
523
+ * "name": "GPT-4",
524
+ * "description": "Advanced language model"
525
+ * },
526
+ * "audience": {
527
+ * "id": 2,
528
+ * "name": "College Students",
529
+ * "description": "For university-level learners"
530
+ * },
531
+ * "category": "Computer Science",
532
+ * "tags": ["programming", "algorithms", "data structures"],
533
+ * "created_at": "2023-01-15T12:00:00Z",
534
+ * "recently_accessed_at": "2023-06-20T15:30:00Z",
535
+ * "platform": {
536
+ * "id": 1,
537
+ * "name": "Example University",
538
+ * "key": "example-university"
633
539
  * },
634
- * // Additional user objects...
635
- * ],
636
- * "count": 50,
637
- * "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
638
- * "previous": null,
639
- * "current_page": 1,
640
- * "total_pages": 5,
641
- * "facets": {
642
- * "role": [
643
- * {"key": "Student", "doc_count": 30},
644
- * {"key": "Instructor", "doc_count": 15},
645
- * {"key": "Admin", "doc_count": 5}
646
- * ],
647
- * "department": [
648
- * {"key": "Computer Science", "doc_count": 20},
649
- * {"key": "Data Science", "doc_count": 15},
650
- * {"key": "Business", "doc_count": 10},
651
- * {"key": "Engineering", "doc_count": 5}
652
- * ],
653
- * "status": [
654
- * {"key": "active", "doc_count": 45},
655
- * {"key": "inactive", "doc_count": 5}
656
- * ]
657
- * }
658
- * }
659
- * ```
660
- * Error Responses:
661
- * 400 Bad Request: If the request parameters are invalid
662
- * 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
663
- * 404 Not Found: If the user or organization doesn't exist
664
- * 500 Internal Server Error: If an unexpected error occurs
665
- *
666
- * Access Control:
667
- * - The requesting user must have an active account in the specified organization
668
- * - When department_mode is enabled, the user must be an admin of at least one department
669
- * - Department filtering restricts results to users in departments where the requesting user is an admin
670
- * @returns UserSearchResponse
671
- * @throws ApiError
672
- */
673
- public static searchUsersOrgsUsersRetrieve({
674
- org,
675
- username,
676
- department,
677
- educationDegree,
678
- educationFieldOfStudy,
679
- educationInstitution,
680
- includeMembershipData = false,
681
- limit = 10,
682
- offset,
683
- q,
684
- userResumeCompany,
685
- userResumeIndustry,
686
- userResumeJobTitle,
687
- userResumeLocation,
688
- userResumeSkills,
689
- }: {
690
- org: string,
691
- username: string,
692
- /**
693
- * Filter by department names
694
- */
695
- department?: Array<string>,
696
- /**
697
- * Filter by degree
698
- */
699
- educationDegree?: string,
700
- /**
701
- * Filter by field of study
702
- */
703
- educationFieldOfStudy?: string,
704
- /**
705
- * Filter by institution
706
- */
707
- educationInstitution?: string,
708
- /**
709
- * Include user group membership data in results
710
- */
711
- includeMembershipData?: boolean,
712
- /**
713
- * Number of results per page
714
- */
715
- limit?: number,
716
- /**
717
- * Starting position for pagination
718
- */
719
- offset?: number,
720
- /**
721
- * Search term to filter users by name, email, or other attributes
722
- */
723
- q?: string,
724
- /**
725
- * Filter by company
726
- */
727
- userResumeCompany?: string,
728
- /**
729
- * Filter by industry
730
- */
731
- userResumeIndustry?: string,
732
- /**
733
- * Filter by job title
734
- */
735
- userResumeJobTitle?: string,
736
- /**
737
- * Filter by location
738
- */
739
- userResumeLocation?: string,
740
- /**
741
- * Filter by skills
742
- */
743
- userResumeSkills?: string,
744
- }): CancelablePromise<UserSearchResponse> {
745
- return __request(OpenAPI, {
746
- method: 'GET',
747
- url: '/api/search/users/orgs/{org}/users/{username}/',
748
- path: {
749
- 'org': org,
750
- 'username': username,
751
- },
752
- query: {
753
- 'department': department,
754
- 'education__degree': educationDegree,
755
- 'education__field_of_study': educationFieldOfStudy,
756
- 'education__institution': educationInstitution,
757
- 'include_membership_data': includeMembershipData,
758
- 'limit': limit,
759
- 'offset': offset,
760
- 'q': q,
761
- 'user_resume__company': userResumeCompany,
762
- 'user_resume__industry': userResumeIndustry,
763
- 'user_resume__job_title': userResumeJobTitle,
764
- 'user_resume__location': userResumeLocation,
765
- 'user_resume__skills': userResumeSkills,
766
- },
767
- errors: {
768
- 400: `Bad request`,
769
- 403: `Forbidden`,
770
- 404: `Not found`,
771
- 500: `Server error`,
772
- },
773
- });
774
- }
775
- }
540
+ * "visibility": "public",
541
+ * "settings": {
542
+ * "temperature": 0.7,
543
+ * "max_tokens": 1024,
544
+ * "system_prompt": "You are Professor Smith, an expert in computer science..."
545
+ * }
546
+ * }
547
+ *
548
+ * For list view:
549
+ * A JSON response containing:
550
+ * {
551
+ * "results": [
552
+ * {
553
+ * "id": 123,
554
+ * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
555
+ * "name": "Professor Smith",
556
+ * "description": "AI mentor specializing in computer science",
557
+ * "image_url": "https://example.com/images/prof-smith.jpg",
558
+ * "llm": {"id": 1, "name": "GPT-4"},
559
+ * "audience": {"id": 2, "name": "College Students"},
560
+ * "category": "Computer Science",
561
+ * "tags": ["programming", "algorithms"],
562
+ * "created_at": "2023-01-15T12:00:00Z",
563
+ * "recently_accessed_at": "2023-06-20T15:30:00Z"
564
+ * },
565
+ * // Additional mentor objects...
566
+ * ],
567
+ * "count": 50,
568
+ * "next": "https://api.example.com/api/search/mentors/?limit=12&offset=12",
569
+ * "previous": null,
570
+ * "current_page": 1,
571
+ * "num_pages": 5,
572
+ * "facets": {
573
+ * "llm": [
574
+ * {"key": "GPT-4", "doc_count": 30},
575
+ * {"key": "Claude", "doc_count": 20}
576
+ * ],
577
+ * "audience": [
578
+ * {"key": "College Students", "doc_count": 35},
579
+ * {"key": "Professionals", "doc_count": 15}
580
+ * ],
581
+ * "category": [
582
+ * {"key": "Computer Science", "doc_count": 25},
583
+ * {"key": "Mathematics", "doc_count": 15},
584
+ * {"key": "Business", "doc_count": 10}
585
+ * ]
586
+ * }
587
+ * }
588
+ *
589
+ * Error Responses:
590
+ * 400 Bad Request: If the request parameters are invalid
591
+ * 404 Not Found: If the requested mentor doesn't exist
592
+ * 500 Internal Server Error: If an unexpected error occurs
593
+ *
594
+ * Notes:
595
+ * - Results are cached for performance
596
+ * - Public mentors are visible to all users
597
+ * - Private mentors are only visible to authorized users
598
+ * @returns MentorSearchResponse
599
+ * @throws ApiError
600
+ */
601
+ public static searchMentorsRetrieve({
602
+ audience,
603
+ category,
604
+ createdBy,
605
+ featured,
606
+ id,
607
+ includeMainPublicMentors = false,
608
+ limit = 12,
609
+ llm,
610
+ offset,
611
+ orderBy,
612
+ orderDirection = 'desc',
613
+ query,
614
+ tags,
615
+ tenant,
616
+ uniqueId,
617
+ }: {
618
+ /**
619
+ * Filter by target audience
620
+ */
621
+ audience?: Array<string>,
622
+ /**
623
+ * Filter by mentor category
624
+ */
625
+ category?: Array<string>,
626
+ /**
627
+ * Filter mentors created by specific user
628
+ */
629
+ createdBy?: string,
630
+ /**
631
+ * Filter by featured status
632
+ */
633
+ featured?: boolean,
634
+ /**
635
+ * Retrieve a specific mentor by ID
636
+ */
637
+ id?: number,
638
+ /**
639
+ * Include public mentors from main tenant
640
+ */
641
+ includeMainPublicMentors?: boolean,
642
+ /**
643
+ * Number of results per page
644
+ */
645
+ limit?: number,
646
+ /**
647
+ * Filter by language model type
648
+ */
649
+ llm?: Array<string>,
650
+ /**
651
+ * Starting position for pagination
652
+ */
653
+ offset?: number,
654
+ /**
655
+ * Field to sort results by ('created_at', 'recently_accessed_at')
656
+ */
657
+ orderBy?: string,
658
+ /**
659
+ * Sort direction ('asc' or 'desc')
660
+ */
661
+ orderDirection?: string,
662
+ /**
663
+ * Search term to filter mentors by name or description
664
+ */
665
+ query?: string,
666
+ /**
667
+ * Filter by tags
668
+ */
669
+ tags?: Array<string>,
670
+ /**
671
+ * Filter by tenant/organization
672
+ */
673
+ tenant?: string,
674
+ /**
675
+ * Retrieve a specific mentor by UUID
676
+ */
677
+ uniqueId?: string,
678
+ }): CancelablePromise<MentorSearchResponse> {
679
+ return __request(OpenAPI, {
680
+ method: 'GET',
681
+ url: '/api/search/mentors/',
682
+ query: {
683
+ 'audience': audience,
684
+ 'category': category,
685
+ 'created_by': createdBy,
686
+ 'featured': featured,
687
+ 'id': id,
688
+ 'include_main_public_mentors': includeMainPublicMentors,
689
+ 'limit': limit,
690
+ 'llm': llm,
691
+ 'offset': offset,
692
+ 'order_by': orderBy,
693
+ 'order_direction': orderDirection,
694
+ 'query': query,
695
+ 'tags': tags,
696
+ 'tenant': tenant,
697
+ 'unique_id': uniqueId,
698
+ },
699
+ errors: {
700
+ 400: `Bad request`,
701
+ 500: `Server error`,
702
+ },
703
+ });
704
+ }
705
+ /**
706
+ * Search and filter documents associated with a specific mentor
707
+ * @returns DocumentSearchResponse
708
+ * @throws ApiError
709
+ */
710
+ public static searchMentorsDocumentsRetrieve({
711
+ mentorUniqueId,
712
+ access,
713
+ documentType,
714
+ limit = 12,
715
+ offset,
716
+ orderBy,
717
+ orderDirection = 'desc',
718
+ platformKey,
719
+ query,
720
+ trainingStatus,
721
+ }: {
722
+ mentorUniqueId: string,
723
+ /**
724
+ * Filter by access level (e.g., 'public', 'private')
725
+ */
726
+ access?: string,
727
+ /**
728
+ * Filter by document type (e.g., 'pdf', 'text')
729
+ */
730
+ documentType?: string,
731
+ /**
732
+ * Number of results per page
733
+ */
734
+ limit?: number,
735
+ /**
736
+ * Starting position for pagination
737
+ */
738
+ offset?: number,
739
+ /**
740
+ * Field to sort results by ('date_created', 'last_modified', 'document_name')
741
+ */
742
+ orderBy?: string,
743
+ /**
744
+ * Sort direction ('asc' or 'desc')
745
+ */
746
+ orderDirection?: string,
747
+ /**
748
+ * Filter by platform key
749
+ */
750
+ platformKey?: string,
751
+ /**
752
+ * Search term to filter documents by name or content
753
+ */
754
+ query?: string,
755
+ /**
756
+ * Filter by training status (e.g., 'trained', 'pending')
757
+ */
758
+ trainingStatus?: string,
759
+ }): CancelablePromise<DocumentSearchResponse> {
760
+ return __request(OpenAPI, {
761
+ method: 'GET',
762
+ url: '/api/search/mentors/{mentor_unique_id}/documents/',
763
+ path: {
764
+ 'mentor_unique_id': mentorUniqueId,
765
+ },
766
+ query: {
767
+ 'access': access,
768
+ 'document_type': documentType,
769
+ 'limit': limit,
770
+ 'offset': offset,
771
+ 'order_by': orderBy,
772
+ 'order_direction': orderDirection,
773
+ 'platform_key': platformKey,
774
+ 'query': query,
775
+ 'training_status': trainingStatus,
776
+ },
777
+ errors: {
778
+ 400: `Bad request`,
779
+ 404: `Mentor not found`,
780
+ 500: `Server error`,
781
+ },
782
+ });
783
+ }
784
+ /**
785
+ * Handle GET requests for tenant-specific mentor search.
786
+ *
787
+ * Args:
788
+ * request: HTTP request object
789
+ * org: Tenant/organization key
790
+ * username: Username of the user making the request
791
+ *
792
+ * Returns:
793
+ * Response: DRF Response object with search results
794
+ * @returns MentorSearchResponse
795
+ * @throws ApiError
796
+ */
797
+ public static searchOrgsUsersMentorsRetrieve({
798
+ org,
799
+ username,
800
+ audience,
801
+ category,
802
+ createdBy,
803
+ featured,
804
+ id,
805
+ includeMainPublicMentors = false,
806
+ limit = 12,
807
+ llm,
808
+ offset,
809
+ orderBy,
810
+ orderDirection = 'desc',
811
+ query,
812
+ tags,
813
+ tenant,
814
+ uniqueId,
815
+ }: {
816
+ org: string,
817
+ username: string,
818
+ /**
819
+ * Filter by target audience
820
+ */
821
+ audience?: Array<string>,
822
+ /**
823
+ * Filter by mentor category
824
+ */
825
+ category?: Array<string>,
826
+ /**
827
+ * Filter mentors created by specific user
828
+ */
829
+ createdBy?: string,
830
+ /**
831
+ * Filter by featured status
832
+ */
833
+ featured?: boolean,
834
+ /**
835
+ * Retrieve a specific mentor by ID
836
+ */
837
+ id?: number,
838
+ /**
839
+ * Include public mentors from main tenant
840
+ */
841
+ includeMainPublicMentors?: boolean,
842
+ /**
843
+ * Number of results per page
844
+ */
845
+ limit?: number,
846
+ /**
847
+ * Filter by language model type
848
+ */
849
+ llm?: Array<string>,
850
+ /**
851
+ * Starting position for pagination
852
+ */
853
+ offset?: number,
854
+ /**
855
+ * Field to sort results by ('created_at', 'recently_accessed_at')
856
+ */
857
+ orderBy?: string,
858
+ /**
859
+ * Sort direction ('asc' or 'desc')
860
+ */
861
+ orderDirection?: string,
862
+ /**
863
+ * Search term to filter mentors by name or description
864
+ */
865
+ query?: string,
866
+ /**
867
+ * Filter by tags
868
+ */
869
+ tags?: Array<string>,
870
+ /**
871
+ * Filter by tenant/organization
872
+ */
873
+ tenant?: string,
874
+ /**
875
+ * Retrieve a specific mentor by UUID
876
+ */
877
+ uniqueId?: string,
878
+ }): CancelablePromise<MentorSearchResponse> {
879
+ return __request(OpenAPI, {
880
+ method: 'GET',
881
+ url: '/api/search/orgs/{org}/users/{username}/mentors/',
882
+ path: {
883
+ 'org': org,
884
+ 'username': username,
885
+ },
886
+ query: {
887
+ 'audience': audience,
888
+ 'category': category,
889
+ 'created_by': createdBy,
890
+ 'featured': featured,
891
+ 'id': id,
892
+ 'include_main_public_mentors': includeMainPublicMentors,
893
+ 'limit': limit,
894
+ 'llm': llm,
895
+ 'offset': offset,
896
+ 'order_by': orderBy,
897
+ 'order_direction': orderDirection,
898
+ 'query': query,
899
+ 'tags': tags,
900
+ 'tenant': tenant,
901
+ 'unique_id': uniqueId,
902
+ },
903
+ errors: {
904
+ 400: `Bad request`,
905
+ 500: `Server error`,
906
+ },
907
+ });
908
+ }
909
+ /**
910
+ * Search and filter AI prompts for a specific user within a tenant.
911
+ *
912
+ * This endpoint extends the base prompt search functionality but filters results
913
+ * to only show prompts that are available to a specific user within a specific
914
+ * organization/tenant.
915
+ *
916
+ * Path Parameters:
917
+ * org (str): The organization/tenant identifier
918
+ * username (str): The username to filter prompts for
919
+ *
920
+ * Query Parameters:
921
+ * Same as PromptSearchView, plus:
922
+ *
923
+ * # Identification parameters (for detail view)
924
+ * id (int, optional): Retrieve a specific prompt by ID
925
+ *
926
+ * Returns:
927
+ * Same format as PromptSearchView, but filtered to only include prompts
928
+ * that the specified user has access to within the specified organization.
929
+ *
930
+ * Error Responses:
931
+ * 400 Bad Request: If the request parameters are invalid
932
+ * 403 Forbidden: If the requested prompt exists but the user doesn't have access
933
+ * 404 Not Found: If the requested prompt doesn't exist
934
+ * 500 Internal Server Error: If an unexpected error occurs
935
+ *
936
+ * Access Control:
937
+ * - Results are filtered based on user's permissions within the organization
938
+ * - Private prompts are only visible to authorized users
939
+ * @returns PromptSearchResponse
940
+ * @throws ApiError
941
+ */
942
+ public static searchOrgsUsersPromptsRetrieve({
943
+ org,
944
+ username,
945
+ alphabetical = false,
946
+ category,
947
+ filterFacet,
948
+ language,
949
+ limit = 10,
950
+ mentor,
951
+ offset,
952
+ orderDirection = 'desc',
953
+ query,
954
+ sortBy,
955
+ style,
956
+ tenant,
957
+ tone,
958
+ }: {
959
+ org: string,
960
+ username: string,
961
+ /**
962
+ * Sort alphabetically
963
+ */
964
+ alphabetical?: boolean,
965
+ /**
966
+ * Filter by prompt category
967
+ */
968
+ category?: string,
969
+ /**
970
+ * If true, return only facets without results
971
+ */
972
+ filterFacet?: boolean,
973
+ /**
974
+ * Filter by prompt language
975
+ */
976
+ language?: string,
977
+ /**
978
+ * Number of results per page
979
+ */
980
+ limit?: number,
981
+ /**
982
+ * Filter by mentor UUID
983
+ */
984
+ mentor?: string,
985
+ /**
986
+ * Starting position for pagination
987
+ */
988
+ offset?: number,
989
+ /**
990
+ * Sort direction ('asc' or 'desc')
991
+ */
992
+ orderDirection?: string,
993
+ /**
994
+ * Search term to filter prompts by name or content
995
+ */
996
+ query?: string,
997
+ /**
998
+ * Field to sort results by
999
+ */
1000
+ sortBy?: string,
1001
+ /**
1002
+ * Filter by prompt style
1003
+ */
1004
+ style?: string,
1005
+ /**
1006
+ * Filter by tenant/organization
1007
+ */
1008
+ tenant?: string,
1009
+ /**
1010
+ * Filter by prompt tone
1011
+ */
1012
+ tone?: string,
1013
+ }): CancelablePromise<PromptSearchResponse> {
1014
+ return __request(OpenAPI, {
1015
+ method: 'GET',
1016
+ url: '/api/search/orgs/{org}/users/{username}/prompts/',
1017
+ path: {
1018
+ 'org': org,
1019
+ 'username': username,
1020
+ },
1021
+ query: {
1022
+ 'alphabetical': alphabetical,
1023
+ 'category': category,
1024
+ 'filter_facet': filterFacet,
1025
+ 'language': language,
1026
+ 'limit': limit,
1027
+ 'mentor': mentor,
1028
+ 'offset': offset,
1029
+ 'order_direction': orderDirection,
1030
+ 'query': query,
1031
+ 'sort_by': sortBy,
1032
+ 'style': style,
1033
+ 'tenant': tenant,
1034
+ 'tone': tone,
1035
+ },
1036
+ errors: {
1037
+ 400: `Bad request`,
1038
+ 403: `Forbidden`,
1039
+ 404: `Not found`,
1040
+ 500: `Server error`,
1041
+ },
1042
+ });
1043
+ }
1044
+ /**
1045
+ * Determine whether to serve a detail view or a list view.
1046
+ * @returns RecommendedCoursesResponse
1047
+ * @throws ApiError
1048
+ */
1049
+ public static searchOrgsUsersRecommendedRetrieve({
1050
+ org,
1051
+ username,
1052
+ certificate,
1053
+ content,
1054
+ courseId,
1055
+ duration,
1056
+ language,
1057
+ level,
1058
+ limit = 12,
1059
+ offset,
1060
+ pathwayId,
1061
+ price,
1062
+ programId,
1063
+ programType,
1064
+ query,
1065
+ resourceId,
1066
+ resourceType,
1067
+ roleId,
1068
+ selfPaced,
1069
+ skillId,
1070
+ skills,
1071
+ subject,
1072
+ tags,
1073
+ topics,
1074
+ }: {
1075
+ org: string,
1076
+ username: string,
1077
+ /**
1078
+ * Filter by certificate type
1079
+ */
1080
+ certificate?: Array<string>,
1081
+ /**
1082
+ * Content types to include in recommendations (courses, programs, pathways, skills, roles, resources)
1083
+ */
1084
+ content?: Array<string>,
1085
+ /**
1086
+ * Retrieve a specific course by ID
1087
+ */
1088
+ courseId?: string,
1089
+ /**
1090
+ * Filter by course duration range
1091
+ */
1092
+ duration?: Array<string>,
1093
+ /**
1094
+ * Filter by content language
1095
+ */
1096
+ language?: Array<string>,
1097
+ /**
1098
+ * Filter by difficulty level
1099
+ */
1100
+ level?: Array<string>,
1101
+ /**
1102
+ * Number of results per page
1103
+ */
1104
+ limit?: number,
1105
+ /**
1106
+ * Starting position for pagination
1107
+ */
1108
+ offset?: number,
1109
+ /**
1110
+ * Retrieve a specific pathway by ID
1111
+ */
1112
+ pathwayId?: string,
1113
+ /**
1114
+ * Filter by price/audit status
1115
+ */
1116
+ price?: string,
1117
+ /**
1118
+ * Retrieve a specific program by ID
1119
+ */
1120
+ programId?: string,
1121
+ /**
1122
+ * Filter by program type
1123
+ */
1124
+ programType?: Array<string>,
1125
+ /**
1126
+ * Search term to filter content by name or description
1127
+ */
1128
+ query?: string,
1129
+ /**
1130
+ * Retrieve a specific resource by ID
1131
+ */
1132
+ resourceId?: string,
1133
+ /**
1134
+ * Filter by resource type
1135
+ */
1136
+ resourceType?: Array<string>,
1137
+ /**
1138
+ * Retrieve a specific role by ID
1139
+ */
1140
+ roleId?: string,
1141
+ /**
1142
+ * Filter by course format (self-paced, instructor-led)
1143
+ */
1144
+ selfPaced?: Array<string>,
1145
+ /**
1146
+ * Retrieve a specific skill by ID
1147
+ */
1148
+ skillId?: string,
1149
+ /**
1150
+ * Filter by skills
1151
+ */
1152
+ skills?: Array<string>,
1153
+ /**
1154
+ * Filter by subject areas
1155
+ */
1156
+ subject?: Array<string>,
1157
+ /**
1158
+ * Filter by tags
1159
+ */
1160
+ tags?: Array<string>,
1161
+ /**
1162
+ * Filter by topic areas
1163
+ */
1164
+ topics?: Array<string>,
1165
+ }): CancelablePromise<RecommendedCoursesResponse> {
1166
+ return __request(OpenAPI, {
1167
+ method: 'GET',
1168
+ url: '/api/search/orgs/{org}/users/{username}/recommended/',
1169
+ path: {
1170
+ 'org': org,
1171
+ 'username': username,
1172
+ },
1173
+ query: {
1174
+ 'certificate': certificate,
1175
+ 'content': content,
1176
+ 'course_id': courseId,
1177
+ 'duration': duration,
1178
+ 'language': language,
1179
+ 'level': level,
1180
+ 'limit': limit,
1181
+ 'offset': offset,
1182
+ 'pathway_id': pathwayId,
1183
+ 'price': price,
1184
+ 'program_id': programId,
1185
+ 'program_type': programType,
1186
+ 'query': query,
1187
+ 'resource_id': resourceId,
1188
+ 'resource_type': resourceType,
1189
+ 'role_id': roleId,
1190
+ 'self_paced': selfPaced,
1191
+ 'skill_id': skillId,
1192
+ 'skills': skills,
1193
+ 'subject': subject,
1194
+ 'tags': tags,
1195
+ 'topics': topics,
1196
+ },
1197
+ errors: {
1198
+ 400: `Bad request`,
1199
+ 404: `User not found`,
1200
+ 500: `Server error`,
1201
+ },
1202
+ });
1203
+ }
1204
+ /**
1205
+ * Determine whether to serve a detail view or a list view.
1206
+ * If any detail-identifying parameters are present (course_id, program_id, etc.)
1207
+ * the detail view is returned; otherwise the aggregated list view is returned.
1208
+ * @returns any
1209
+ * @throws ApiError
1210
+ */
1211
+ public static searchPersonalizedCatalogRetrieve({
1212
+ username,
1213
+ allowSkillSearch = false,
1214
+ alphabetical = false,
1215
+ certificate,
1216
+ content,
1217
+ courseId,
1218
+ duration,
1219
+ language,
1220
+ level,
1221
+ limit = 12,
1222
+ offset,
1223
+ orderAscending = false,
1224
+ orderBy,
1225
+ pathwayId,
1226
+ price,
1227
+ programId,
1228
+ programType,
1229
+ promotion,
1230
+ query,
1231
+ recommended = false,
1232
+ resourceId,
1233
+ resourceType,
1234
+ returnFacet = true,
1235
+ returnItems = false,
1236
+ roleId,
1237
+ selfPaced,
1238
+ skillId,
1239
+ skills,
1240
+ subject,
1241
+ tags,
1242
+ tenant,
1243
+ topics,
1244
+ updateFacet,
1245
+ }: {
1246
+ username: string,
1247
+ /**
1248
+ * Enable skill-based search
1249
+ */
1250
+ allowSkillSearch?: boolean,
1251
+ /**
1252
+ * Sort alphabetically by name
1253
+ */
1254
+ alphabetical?: boolean,
1255
+ /**
1256
+ * Filter by certificate type
1257
+ */
1258
+ certificate?: Array<string>,
1259
+ /**
1260
+ * Content types to include in results
1261
+ */
1262
+ content?: Array<string>,
1263
+ /**
1264
+ * Retrieve a specific course by ID
1265
+ */
1266
+ courseId?: string,
1267
+ /**
1268
+ * Filter by course duration range
1269
+ */
1270
+ duration?: Array<string>,
1271
+ /**
1272
+ * Filter by content language
1273
+ */
1274
+ language?: Array<string>,
1275
+ /**
1276
+ * Filter by difficulty level
1277
+ */
1278
+ level?: Array<string>,
1279
+ /**
1280
+ * Number of results per page
1281
+ */
1282
+ limit?: number,
1283
+ /**
1284
+ * Starting position for pagination
1285
+ */
1286
+ offset?: number,
1287
+ /**
1288
+ * Sort direction
1289
+ */
1290
+ orderAscending?: boolean,
1291
+ /**
1292
+ * Field to sort results by
1293
+ */
1294
+ orderBy?: string,
1295
+ /**
1296
+ * Retrieve a specific pathway by ID
1297
+ */
1298
+ pathwayId?: string,
1299
+ /**
1300
+ * Filter by price/audit status
1301
+ */
1302
+ price?: string,
1303
+ /**
1304
+ * Retrieve a specific program by ID
1305
+ */
1306
+ programId?: string,
1307
+ /**
1308
+ * Filter by program type
1309
+ */
1310
+ programType?: Array<string>,
1311
+ /**
1312
+ * Filter by promotion status
1313
+ */
1314
+ promotion?: Array<string>,
1315
+ /**
1316
+ * Search term to filter content by name or description
1317
+ */
1318
+ query?: string,
1319
+ /**
1320
+ * Show only recommended content
1321
+ */
1322
+ recommended?: boolean,
1323
+ /**
1324
+ * Retrieve a specific resource by ID
1325
+ */
1326
+ resourceId?: string,
1327
+ /**
1328
+ * Filter by resource type
1329
+ */
1330
+ resourceType?: Array<string>,
1331
+ /**
1332
+ * Include facet data in response
1333
+ */
1334
+ returnFacet?: boolean,
1335
+ /**
1336
+ * Include items in programs/pathways
1337
+ */
1338
+ returnItems?: boolean,
1339
+ /**
1340
+ * Retrieve a specific role by ID
1341
+ */
1342
+ roleId?: string,
1343
+ /**
1344
+ * Filter by course format
1345
+ */
1346
+ selfPaced?: Array<string>,
1347
+ /**
1348
+ * Retrieve a specific skill by ID
1349
+ */
1350
+ skillId?: string,
1351
+ /**
1352
+ * Filter by skills
1353
+ */
1354
+ skills?: Array<string>,
1355
+ /**
1356
+ * Filter by subject areas
1357
+ */
1358
+ subject?: Array<string>,
1359
+ /**
1360
+ * Filter by tags
1361
+ */
1362
+ tags?: Array<string>,
1363
+ /**
1364
+ * Filter by tenant/organization
1365
+ */
1366
+ tenant?: Array<string>,
1367
+ /**
1368
+ * Filter by topic areas
1369
+ */
1370
+ topics?: Array<string>,
1371
+ /**
1372
+ * Force facet update
1373
+ */
1374
+ updateFacet?: string,
1375
+ }): CancelablePromise<Record<string, any>> {
1376
+ return __request(OpenAPI, {
1377
+ method: 'GET',
1378
+ url: '/api/search/personalized-catalog/{username}/',
1379
+ path: {
1380
+ 'username': username,
1381
+ },
1382
+ query: {
1383
+ 'allow_skill_search': allowSkillSearch,
1384
+ 'alphabetical': alphabetical,
1385
+ 'certificate': certificate,
1386
+ 'content': content,
1387
+ 'course_id': courseId,
1388
+ 'duration': duration,
1389
+ 'language': language,
1390
+ 'level': level,
1391
+ 'limit': limit,
1392
+ 'offset': offset,
1393
+ 'order_ascending': orderAscending,
1394
+ 'order_by': orderBy,
1395
+ 'pathway_id': pathwayId,
1396
+ 'price': price,
1397
+ 'program_id': programId,
1398
+ 'program_type': programType,
1399
+ 'promotion': promotion,
1400
+ 'query': query,
1401
+ 'recommended': recommended,
1402
+ 'resource_id': resourceId,
1403
+ 'resource_type': resourceType,
1404
+ 'return_facet': returnFacet,
1405
+ 'return_items': returnItems,
1406
+ 'role_id': roleId,
1407
+ 'self_paced': selfPaced,
1408
+ 'skill_id': skillId,
1409
+ 'skills': skills,
1410
+ 'subject': subject,
1411
+ 'tags': tags,
1412
+ 'tenant': tenant,
1413
+ 'topics': topics,
1414
+ 'update_facet': updateFacet,
1415
+ },
1416
+ });
1417
+ }
1418
+ /**
1419
+ * Search and filter AI prompts across the platform.
1420
+ *
1421
+ * This endpoint provides a search interface for discovering AI prompts
1422
+ * with support for filtering, pagination, and detailed prompt information.
1423
+ *
1424
+ * Query Parameters:
1425
+ * # Identification parameters (for detail view)
1426
+ * id (int, optional): Retrieve a specific prompt by ID
1427
+ *
1428
+ * # Search and filtering parameters
1429
+ * query (str, optional): Search term to filter prompts by name or content
1430
+ * category (str, optional): Filter by prompt category
1431
+ * language (str, optional): Filter by prompt language
1432
+ * style (str, optional): Filter by writing style
1433
+ * tone (str, optional): Filter by tone
1434
+ * tenant (str, optional): Filter by tenant/organization
1435
+ * mentor (str, optional): Filter by associated mentor (UUID)
1436
+ *
1437
+ * # Sorting and pagination
1438
+ * sort_by (str, optional): Field to sort results by
1439
+ * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
1440
+ * alphabetical (bool, optional): Sort alphabetically by name (default: false)
1441
+ * limit (int, optional): Number of results per page (default: 10)
1442
+ * offset (int, optional): Starting position for pagination
1443
+ *
1444
+ * # Special parameters
1445
+ * filter_facet (any, optional): If present, return only facets without results
1446
+ *
1447
+ * Returns:
1448
+ * For detail view (when id is provided):
1449
+ * A JSON response containing a single prompt's details:
1450
+ * {
1451
+ * "id": 456,
1452
+ * "name": "Essay Writing Guide",
1453
+ * "content": "Write a well-structured essay on the following topic: {{topic}}...",
1454
+ * "category": "Academic Writing",
1455
+ * "language": "English",
1456
+ * "style": "Formal",
1457
+ * "tone": "Professional",
1458
+ * "mentor": {
1459
+ * "id": 123,
1460
+ * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
1461
+ * "name": "Professor Smith"
1462
+ * },
1463
+ * "platform": {
1464
+ * "id": 1,
1465
+ * "name": "Example University",
1466
+ * "key": "example-university"
1467
+ * },
1468
+ * "created_at": "2023-02-10T09:15:00Z",
1469
+ * "updated_at": "2023-05-05T14:20:00Z",
1470
+ * "visibility": "public",
1471
+ * "variables": ["topic", "length", "style"]
1472
+ * }
1473
+ *
1474
+ * For list view:
1475
+ * A JSON response containing:
1476
+ * {
1477
+ * "results": [
1478
+ * {
1479
+ * "id": 456,
1480
+ * "name": "Essay Writing Guide",
1481
+ * "content": "Write a well-structured essay on the following topic: {{topic}}...",
1482
+ * "category": "Academic Writing",
1483
+ * "language": "English",
1484
+ * "style": "Formal",
1485
+ * "tone": "Professional",
1486
+ * "mentor": {"id": 123, "name": "Professor Smith"},
1487
+ * "created_at": "2023-02-10T09:15:00Z",
1488
+ * "updated_at": "2023-05-05T14:20:00Z"
1489
+ * },
1490
+ * // Additional prompt objects...
1491
+ * ],
1492
+ * "count": 30,
1493
+ * "next": "?limit=10&offset=10",
1494
+ * "previous": null,
1495
+ * "current_page": 1,
1496
+ * "num_pages": 3,
1497
+ * "facets": {
1498
+ * "category": [
1499
+ * {"key": "Academic Writing", "doc_count": 15},
1500
+ * {"key": "Creative Writing", "doc_count": 10},
1501
+ * {"key": "Technical Documentation", "doc_count": 5}
1502
+ * ],
1503
+ * "language": [
1504
+ * {"key": "English", "doc_count": 25},
1505
+ * {"key": "Spanish", "doc_count": 5}
1506
+ * ],
1507
+ * "style": [
1508
+ * {"key": "Formal", "doc_count": 20},
1509
+ * {"key": "Casual", "doc_count": 10}
1510
+ * ],
1511
+ * "tone": [
1512
+ * {"key": "Professional", "doc_count": 15},
1513
+ * {"key": "Friendly", "doc_count": 10},
1514
+ * {"key": "Technical", "doc_count": 5}
1515
+ * ]
1516
+ * }
1517
+ * }
1518
+ *
1519
+ * Error Responses:
1520
+ * 400 Bad Request: If the request parameters are invalid
1521
+ * 403 Forbidden: If the requested prompt exists but is not publicly available
1522
+ * 404 Not Found: If the requested prompt doesn't exist
1523
+ * 500 Internal Server Error: If an unexpected error occurs
1524
+ *
1525
+ * Notes:
1526
+ * - Only publicly available prompts are returned by default
1527
+ * - When filtering by mentor, the mentor ID must be a valid UUID
1528
+ * @returns PromptSearchResponse
1529
+ * @throws ApiError
1530
+ */
1531
+ public static searchPromptsRetrieve({
1532
+ alphabetical = false,
1533
+ category,
1534
+ filterFacet,
1535
+ language,
1536
+ limit = 10,
1537
+ mentor,
1538
+ offset,
1539
+ orderDirection = 'desc',
1540
+ query,
1541
+ sortBy,
1542
+ style,
1543
+ tenant,
1544
+ tone,
1545
+ }: {
1546
+ /**
1547
+ * Sort alphabetically
1548
+ */
1549
+ alphabetical?: boolean,
1550
+ /**
1551
+ * Filter by prompt category
1552
+ */
1553
+ category?: string,
1554
+ /**
1555
+ * If true, return only facets without results
1556
+ */
1557
+ filterFacet?: boolean,
1558
+ /**
1559
+ * Filter by prompt language
1560
+ */
1561
+ language?: string,
1562
+ /**
1563
+ * Number of results per page
1564
+ */
1565
+ limit?: number,
1566
+ /**
1567
+ * Filter by mentor UUID
1568
+ */
1569
+ mentor?: string,
1570
+ /**
1571
+ * Starting position for pagination
1572
+ */
1573
+ offset?: number,
1574
+ /**
1575
+ * Sort direction ('asc' or 'desc')
1576
+ */
1577
+ orderDirection?: string,
1578
+ /**
1579
+ * Search term to filter prompts by name or content
1580
+ */
1581
+ query?: string,
1582
+ /**
1583
+ * Field to sort results by
1584
+ */
1585
+ sortBy?: string,
1586
+ /**
1587
+ * Filter by prompt style
1588
+ */
1589
+ style?: string,
1590
+ /**
1591
+ * Filter by tenant/organization
1592
+ */
1593
+ tenant?: string,
1594
+ /**
1595
+ * Filter by prompt tone
1596
+ */
1597
+ tone?: string,
1598
+ }): CancelablePromise<PromptSearchResponse> {
1599
+ return __request(OpenAPI, {
1600
+ method: 'GET',
1601
+ url: '/api/search/prompts/',
1602
+ query: {
1603
+ 'alphabetical': alphabetical,
1604
+ 'category': category,
1605
+ 'filter_facet': filterFacet,
1606
+ 'language': language,
1607
+ 'limit': limit,
1608
+ 'mentor': mentor,
1609
+ 'offset': offset,
1610
+ 'order_direction': orderDirection,
1611
+ 'query': query,
1612
+ 'sort_by': sortBy,
1613
+ 'style': style,
1614
+ 'tenant': tenant,
1615
+ 'tone': tone,
1616
+ },
1617
+ errors: {
1618
+ 400: `Bad request`,
1619
+ 500: `Server error`,
1620
+ },
1621
+ });
1622
+ }
1623
+ /**
1624
+ * Search and filter users within a specific organization/tenant.
1625
+ *
1626
+ * This endpoint provides a search interface for discovering users within an organization,
1627
+ * with support for filtering by departments, pagination, and faceted filtering.
1628
+ *
1629
+ * Path Parameters:
1630
+ * org (str): The organization/tenant identifier
1631
+ * username (str): The username of the user making the request
1632
+ *
1633
+ * Query Parameters:
1634
+ * # Search parameters
1635
+ * query (str, optional): Search term to filter users by name, username, or email
1636
+ *
1637
+ * # Department filtering
1638
+ * department_mode (bool, optional): Enable department-based filtering (default: false)
1639
+ * user_department (bool, optional): Legacy parameter for department_mode (default: false)
1640
+ * department (list, optional): Filter by specific departments
1641
+ *
1642
+ * # Additional filters
1643
+ * role (list, optional): Filter by user role
1644
+ * status (list, optional): Filter by user status (active, inactive)
1645
+ * joined_date (list, optional): Filter by join date range
1646
+ * last_login (list, optional): Filter by last login date range
1647
+ *
1648
+ * # Pagination
1649
+ * limit (int, optional): Number of results per page (default: 10)
1650
+ * offset (int, optional): Starting position for pagination
1651
+ *
1652
+ * Returns:
1653
+ * A JSON response containing:
1654
+ * ```
1655
+ * {
1656
+ * "results": [
1657
+ * {
1658
+ * "id": 123,
1659
+ * "username": "john.doe",
1660
+ * "email": "john.doe@example.com",
1661
+ * "first_name": "John",
1662
+ * "last_name": "Doe",
1663
+ * "full_name": "John Doe",
1664
+ * "profile_image": "https://example.com/profiles/john-doe.jpg",
1665
+ * "role": "Student",
1666
+ * "departments": ["Computer Science", "Data Science"],
1667
+ * "status": "active",
1668
+ * "joined_date": "2023-01-15T12:00:00Z",
1669
+ * "last_login": "2023-06-20T15:30:00Z",
1670
+ * "metadata": {
1671
+ * "location": "New York",
1672
+ * "title": "Software Engineer",
1673
+ * "bio": "Experienced software engineer with a passion for education"
1674
+ * }
1675
+ * },
1676
+ * // Additional user objects...
1677
+ * ],
1678
+ * "count": 50,
1679
+ * "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
1680
+ * "previous": null,
1681
+ * "current_page": 1,
1682
+ * "total_pages": 5,
1683
+ * "facets": {
1684
+ * "role": [
1685
+ * {"key": "Student", "doc_count": 30},
1686
+ * {"key": "Instructor", "doc_count": 15},
1687
+ * {"key": "Admin", "doc_count": 5}
1688
+ * ],
1689
+ * "department": [
1690
+ * {"key": "Computer Science", "doc_count": 20},
1691
+ * {"key": "Data Science", "doc_count": 15},
1692
+ * {"key": "Business", "doc_count": 10},
1693
+ * {"key": "Engineering", "doc_count": 5}
1694
+ * ],
1695
+ * "status": [
1696
+ * {"key": "active", "doc_count": 45},
1697
+ * {"key": "inactive", "doc_count": 5}
1698
+ * ]
1699
+ * }
1700
+ * }
1701
+ * ```
1702
+ * Error Responses:
1703
+ * 400 Bad Request: If the request parameters are invalid
1704
+ * 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
1705
+ * 404 Not Found: If the user or organization doesn't exist
1706
+ * 500 Internal Server Error: If an unexpected error occurs
1707
+ *
1708
+ * Access Control:
1709
+ * - The requesting user must have an active account in the specified organization
1710
+ * - When department_mode is enabled, the user must be an admin of at least one department
1711
+ * - Department filtering restricts results to users in departments where the requesting user is an admin
1712
+ * @returns UserSearchResponse
1713
+ * @throws ApiError
1714
+ */
1715
+ public static searchUsersOrgsUsersRetrieve({
1716
+ org,
1717
+ username,
1718
+ department,
1719
+ educationDegree,
1720
+ educationFieldOfStudy,
1721
+ educationInstitution,
1722
+ includeMembershipData = false,
1723
+ limit = 10,
1724
+ offset,
1725
+ q,
1726
+ userResumeCompany,
1727
+ userResumeIndustry,
1728
+ userResumeJobTitle,
1729
+ userResumeLocation,
1730
+ userResumeSkills,
1731
+ }: {
1732
+ org: string,
1733
+ username: string,
1734
+ /**
1735
+ * Filter by department names
1736
+ */
1737
+ department?: Array<string>,
1738
+ /**
1739
+ * Filter by degree
1740
+ */
1741
+ educationDegree?: string,
1742
+ /**
1743
+ * Filter by field of study
1744
+ */
1745
+ educationFieldOfStudy?: string,
1746
+ /**
1747
+ * Filter by institution
1748
+ */
1749
+ educationInstitution?: string,
1750
+ /**
1751
+ * Include user group membership data in results
1752
+ */
1753
+ includeMembershipData?: boolean,
1754
+ /**
1755
+ * Number of results per page
1756
+ */
1757
+ limit?: number,
1758
+ /**
1759
+ * Starting position for pagination
1760
+ */
1761
+ offset?: number,
1762
+ /**
1763
+ * Search term to filter users by name, email, or other attributes
1764
+ */
1765
+ q?: string,
1766
+ /**
1767
+ * Filter by company
1768
+ */
1769
+ userResumeCompany?: string,
1770
+ /**
1771
+ * Filter by industry
1772
+ */
1773
+ userResumeIndustry?: string,
1774
+ /**
1775
+ * Filter by job title
1776
+ */
1777
+ userResumeJobTitle?: string,
1778
+ /**
1779
+ * Filter by location
1780
+ */
1781
+ userResumeLocation?: string,
1782
+ /**
1783
+ * Filter by skills
1784
+ */
1785
+ userResumeSkills?: string,
1786
+ }): CancelablePromise<UserSearchResponse> {
1787
+ return __request(OpenAPI, {
1788
+ method: 'GET',
1789
+ url: '/api/search/users/orgs/{org}/users/{username}/',
1790
+ path: {
1791
+ 'org': org,
1792
+ 'username': username,
1793
+ },
1794
+ query: {
1795
+ 'department': department,
1796
+ 'education__degree': educationDegree,
1797
+ 'education__field_of_study': educationFieldOfStudy,
1798
+ 'education__institution': educationInstitution,
1799
+ 'include_membership_data': includeMembershipData,
1800
+ 'limit': limit,
1801
+ 'offset': offset,
1802
+ 'q': q,
1803
+ 'user_resume__company': userResumeCompany,
1804
+ 'user_resume__industry': userResumeIndustry,
1805
+ 'user_resume__job_title': userResumeJobTitle,
1806
+ 'user_resume__location': userResumeLocation,
1807
+ 'user_resume__skills': userResumeSkills,
1808
+ },
1809
+ errors: {
1810
+ 400: `Bad request`,
1811
+ 403: `Forbidden`,
1812
+ 404: `Not found`,
1813
+ 500: `Server error`,
1814
+ },
1815
+ });
1816
+ }
1817
+ }