@iblai/iblai-api 3.38.8-ai-plus → 3.38.9-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 (181) hide show
  1. package/dist/index.cjs.js +1649 -2197
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +1650 -2196
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +1649 -2197
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +38 -40
  8. package/dist/types/models/CatalogAutoIncrementResponse.d.ts +25 -0
  9. package/dist/types/models/CatalogAutoIncrementUpdateRequest.d.ts +17 -0
  10. package/dist/types/models/Course.d.ts +15 -0
  11. package/dist/types/models/CourseCreateUpdate.d.ts +25 -0
  12. package/dist/types/models/CourseDeleteResponse.d.ts +13 -0
  13. package/dist/types/models/CourseEligibilityCheckResponse.d.ts +25 -0
  14. package/dist/types/models/CourseEnrollmentSearchResponse.d.ts +53 -0
  15. package/dist/types/models/CourseMetadataSearchRequest.d.ts +17 -0
  16. package/dist/types/models/CourseMetadataUpdateRequest.d.ts +17 -0
  17. package/dist/types/models/CourseReviewInfoResponse.d.ts +17 -0
  18. package/dist/types/models/DesiredRole.d.ts +3 -0
  19. package/dist/types/models/DesiredRoleCreateUpdateRequest.d.ts +21 -0
  20. package/dist/types/models/DesiredSkill.d.ts +3 -0
  21. package/dist/types/models/DesiredSkillCreateUpdateRequest.d.ts +21 -0
  22. package/dist/types/models/Document.d.ts +41 -0
  23. package/dist/types/models/DocumentFacet.d.ts +17 -0
  24. package/dist/types/models/DocumentSearchResponse.d.ts +35 -0
  25. package/dist/types/models/GlobalCatalogSearchResponse.d.ts +33 -0
  26. package/dist/types/models/MentorFacet.d.ts +17 -0
  27. package/dist/types/models/MentorSearchResponse.d.ts +35 -0
  28. package/dist/types/models/Pathway.d.ts +28 -0
  29. package/dist/types/models/PathwayCreateUpdateRequest.d.ts +45 -0
  30. package/dist/types/models/PathwayDeleteResponse.d.ts +13 -0
  31. package/dist/types/models/PathwayEnrollment.d.ts +22 -0
  32. package/dist/types/models/PathwayEnrollmentPlus.d.ts +26 -0
  33. package/dist/types/models/PathwayEnrollmentRequest.d.ts +49 -0
  34. package/dist/types/models/PathwaySelfEnrollmentRequest.d.ts +37 -0
  35. package/dist/types/models/ProgramCoursePosition.d.ts +6 -0
  36. package/dist/types/models/ProgramCreateUpdateRequest.d.ts +45 -0
  37. package/dist/types/models/ProgramDeleteResponse.d.ts +13 -0
  38. package/dist/types/models/ProgramEnrollment.d.ts +30 -0
  39. package/dist/types/models/ProgramEnrollmentPlus.d.ts +34 -0
  40. package/dist/types/models/ProgramReviewInfoResponse.d.ts +17 -0
  41. package/dist/types/models/ProgramSearch.d.ts +28 -0
  42. package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
  43. package/dist/types/models/ReportedRole.d.ts +3 -0
  44. package/dist/types/models/ReportedRoleCreateUpdateRequest.d.ts +21 -0
  45. package/dist/types/models/ReportedSkill.d.ts +3 -0
  46. package/dist/types/models/ResourceDeleteResponse.d.ts +13 -0
  47. package/dist/types/models/Role.d.ts +12 -1
  48. package/dist/types/models/RoleCreateUpdateRequest.d.ts +25 -0
  49. package/dist/types/models/Skill.d.ts +10 -1
  50. package/dist/types/models/SkillCreateUpdateRequest.d.ts +25 -0
  51. package/dist/types/models/UserSearchResponse.d.ts +29 -0
  52. package/dist/types/models/Voice.d.ts +2 -2
  53. package/dist/types/services/CatalogService.d.ts +424 -463
  54. package/dist/types/services/SearchService.d.ts +419 -134
  55. package/package.json +1 -1
  56. package/src/core/OpenAPI.ts +1 -1
  57. package/src/index.ts +38 -40
  58. package/src/models/CatalogAutoIncrementResponse.ts +30 -0
  59. package/src/models/CatalogAutoIncrementUpdateRequest.ts +22 -0
  60. package/src/models/Course.ts +20 -0
  61. package/src/models/CourseCreateUpdate.ts +30 -0
  62. package/src/models/CourseDeleteResponse.ts +18 -0
  63. package/src/models/CourseEligibilityCheckResponse.ts +30 -0
  64. package/src/models/CourseEnrollmentSearchResponse.ts +58 -0
  65. package/src/models/CourseMetadataSearchRequest.ts +22 -0
  66. package/src/models/CourseMetadataUpdateRequest.ts +22 -0
  67. package/src/models/CourseReviewInfoResponse.ts +22 -0
  68. package/src/models/DesiredRole.ts +3 -0
  69. package/src/models/DesiredRoleCreateUpdateRequest.ts +26 -0
  70. package/src/models/DesiredSkill.ts +3 -0
  71. package/src/models/DesiredSkillCreateUpdateRequest.ts +26 -0
  72. package/src/models/Document.ts +46 -0
  73. package/src/models/DocumentFacet.ts +22 -0
  74. package/src/models/DocumentSearchResponse.ts +40 -0
  75. package/src/models/GlobalCatalogSearchResponse.ts +38 -0
  76. package/src/models/MentorFacet.ts +22 -0
  77. package/src/models/MentorSearchResponse.ts +40 -0
  78. package/src/models/Pathway.ts +33 -0
  79. package/src/models/PathwayCreateUpdateRequest.ts +50 -0
  80. package/src/models/PathwayDeleteResponse.ts +18 -0
  81. package/src/models/PathwayEnrollment.ts +27 -0
  82. package/src/models/PathwayEnrollmentPlus.ts +31 -0
  83. package/src/models/PathwayEnrollmentRequest.ts +54 -0
  84. package/src/models/PathwaySelfEnrollmentRequest.ts +42 -0
  85. package/src/models/{DiscordWebhook.ts → ProgramCoursePosition.ts} +5 -5
  86. package/src/models/ProgramCreateUpdateRequest.ts +50 -0
  87. package/src/models/ProgramDeleteResponse.ts +18 -0
  88. package/src/models/ProgramEnrollment.ts +35 -0
  89. package/src/models/ProgramEnrollmentPlus.ts +39 -0
  90. package/src/models/ProgramReviewInfoResponse.ts +22 -0
  91. package/src/models/ProgramSearch.ts +33 -0
  92. package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
  93. package/src/models/ReportedRole.ts +3 -0
  94. package/src/models/ReportedRoleCreateUpdateRequest.ts +26 -0
  95. package/src/models/ReportedSkill.ts +3 -0
  96. package/src/models/ResourceDeleteResponse.ts +18 -0
  97. package/src/models/Role.ts +12 -1
  98. package/src/models/RoleCreateUpdateRequest.ts +30 -0
  99. package/src/models/Skill.ts +10 -1
  100. package/src/models/SkillCreateUpdateRequest.ts +30 -0
  101. package/src/models/UserSearchResponse.ts +34 -0
  102. package/src/models/Voice.ts +2 -2
  103. package/src/services/CatalogService.ts +1191 -457
  104. package/src/services/SearchService.ts +1178 -700
  105. package/dist/types/models/Bot.d.ts +0 -15
  106. package/dist/types/models/BotCommand.d.ts +0 -6
  107. package/dist/types/models/BotCreate.d.ts +0 -12
  108. package/dist/types/models/DataSet.d.ts +0 -21
  109. package/dist/types/models/DataSetCreate.d.ts +0 -12
  110. package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
  111. package/dist/types/models/DiscordConfig.d.ts +0 -7
  112. package/dist/types/models/DiscordUserConfig.d.ts +0 -10
  113. package/dist/types/models/DiscordWebhook.d.ts +0 -6
  114. package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
  115. package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
  116. package/dist/types/models/PatchedBotCommand.d.ts +0 -6
  117. package/dist/types/models/PatchedBotCreate.d.ts +0 -12
  118. package/dist/types/models/PatchedDataSet.d.ts +0 -21
  119. package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
  120. package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
  121. package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
  122. package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
  123. package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
  124. package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
  125. package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
  126. package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
  127. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
  128. package/dist/types/models/Provider05cEnum.d.ts +0 -14
  129. package/dist/types/models/Provider63aEnum.d.ts +0 -6
  130. package/dist/types/models/SlackConfig.d.ts +0 -8
  131. package/dist/types/models/SlackUserConfig.d.ts +0 -17
  132. package/dist/types/models/SlackWebhook.d.ts +0 -6
  133. package/dist/types/models/TeamsConfig.d.ts +0 -7
  134. package/dist/types/models/TeamsWebhook.d.ts +0 -17
  135. package/dist/types/models/Training.d.ts +0 -41
  136. package/dist/types/models/TrainingCreate.d.ts +0 -31
  137. package/dist/types/models/WebexConfig.d.ts +0 -10
  138. package/dist/types/models/WebexWebhook.d.ts +0 -4
  139. package/dist/types/models/WhatAppWebHook.d.ts +0 -3
  140. package/dist/types/models/WhatsappConfig.d.ts +0 -11
  141. package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
  142. package/dist/types/services/AiBotService.d.ts +0 -486
  143. package/dist/types/services/AiFinetuningService.d.ts +0 -162
  144. package/src/models/Bot.ts +0 -20
  145. package/src/models/BotCommand.ts +0 -11
  146. package/src/models/BotCreate.ts +0 -17
  147. package/src/models/DataSet.ts +0 -26
  148. package/src/models/DataSetCreate.ts +0 -17
  149. package/src/models/DataSetStatusEnum.ts +0 -16
  150. package/src/models/DiscordConfig.ts +0 -12
  151. package/src/models/DiscordUserConfig.ts +0 -15
  152. package/src/models/PaginatedDataSetList.ts +0 -12
  153. package/src/models/PaginatedTrainingList.ts +0 -12
  154. package/src/models/PatchedBotCommand.ts +0 -11
  155. package/src/models/PatchedBotCreate.ts +0 -17
  156. package/src/models/PatchedDataSet.ts +0 -26
  157. package/src/models/PatchedDiscordConfig.ts +0 -12
  158. package/src/models/PatchedDiscordUserConfig.ts +0 -15
  159. package/src/models/PatchedSlackConfig.ts +0 -13
  160. package/src/models/PatchedSlackUserConfig.ts +0 -22
  161. package/src/models/PatchedTeamsConfig.ts +0 -12
  162. package/src/models/PatchedTrainingCreate.ts +0 -36
  163. package/src/models/PatchedWebexConfig.ts +0 -15
  164. package/src/models/PatchedWhatsappConfig.ts +0 -16
  165. package/src/models/PatchedWhatsappUserConfig.ts +0 -15
  166. package/src/models/Provider05cEnum.ts +0 -18
  167. package/src/models/Provider63aEnum.ts +0 -10
  168. package/src/models/SlackConfig.ts +0 -13
  169. package/src/models/SlackUserConfig.ts +0 -22
  170. package/src/models/SlackWebhook.ts +0 -11
  171. package/src/models/TeamsConfig.ts +0 -12
  172. package/src/models/TeamsWebhook.ts +0 -22
  173. package/src/models/Training.ts +0 -46
  174. package/src/models/TrainingCreate.ts +0 -36
  175. package/src/models/WebexConfig.ts +0 -15
  176. package/src/models/WebexWebhook.ts +0 -9
  177. package/src/models/WhatAppWebHook.ts +0 -8
  178. package/src/models/WhatsappConfig.ts +0 -16
  179. package/src/models/WhatsappUserConfig.ts +0 -15
  180. package/src/services/AiBotService.ts +0 -1174
  181. package/src/services/AiFinetuningService.ts +0 -402
package/dist/index.cjs.js CHANGED
@@ -110,7 +110,7 @@ class CancelablePromise {
110
110
 
111
111
  const OpenAPI = {
112
112
  BASE: 'https://base.manager.iblai.app',
113
- VERSION: '3.38.8-ai-plus',
113
+ VERSION: '3.38.9-ai',
114
114
  WITH_CREDENTIALS: false,
115
115
  CREDENTIALS: 'include',
116
116
  TOKEN: undefined,
@@ -231,24 +231,6 @@ exports.CourseCreationTaskStatusEnum = void 0;
231
231
  CourseCreationTaskStatusEnum["IN_PROGRESS"] = "In Progress";
232
232
  })(exports.CourseCreationTaskStatusEnum || (exports.CourseCreationTaskStatusEnum = {}));
233
233
 
234
- /* generated using openapi-typescript-codegen -- do not edit */
235
- /* istanbul ignore file */
236
- /* tslint:disable */
237
- /* eslint-disable */
238
- /**
239
- * * `pending` - Pending
240
- * * `processing` - Processing
241
- * * `completed` - Completed
242
- * * `failed` - Failed
243
- */
244
- exports.DataSetStatusEnum = void 0;
245
- (function (DataSetStatusEnum) {
246
- DataSetStatusEnum["PENDING"] = "pending";
247
- DataSetStatusEnum["PROCESSING"] = "processing";
248
- DataSetStatusEnum["COMPLETED"] = "completed";
249
- DataSetStatusEnum["FAILED"] = "failed";
250
- })(exports.DataSetStatusEnum || (exports.DataSetStatusEnum = {}));
251
-
252
234
  /* generated using openapi-typescript-codegen -- do not edit */
253
235
  /* istanbul ignore file */
254
236
  /* tslint:disable */
@@ -531,37 +513,21 @@ exports.PromptVisibilityEnum = void 0;
531
513
  PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
532
514
  })(exports.PromptVisibilityEnum || (exports.PromptVisibilityEnum = {}));
533
515
 
534
- /* generated using openapi-typescript-codegen -- do not edit */
535
- /* istanbul ignore file */
536
- /* tslint:disable */
537
- /* eslint-disable */
538
- /**
539
- * * `webex` - Webex
540
- * * `slack` - Slack
541
- * * `whatsapp` - Whatsapp
542
- * * `discord` - Discord
543
- * * `teams` - Teams
544
- */
545
- exports.Provider05cEnum = void 0;
546
- (function (Provider05cEnum) {
547
- Provider05cEnum["WEBEX"] = "webex";
548
- Provider05cEnum["SLACK"] = "slack";
549
- Provider05cEnum["WHATSAPP"] = "whatsapp";
550
- Provider05cEnum["DISCORD"] = "discord";
551
- Provider05cEnum["TEAMS"] = "teams";
552
- })(exports.Provider05cEnum || (exports.Provider05cEnum = {}));
553
-
554
516
  /* generated using openapi-typescript-codegen -- do not edit */
555
517
  /* istanbul ignore file */
556
518
  /* tslint:disable */
557
519
  /* eslint-disable */
558
520
  /**
559
521
  * * `openai` - Openai
522
+ * * `google` - Google
523
+ * * `elevenlabs` - Elevenlabs
560
524
  */
561
- exports.Provider63aEnum = void 0;
562
- (function (Provider63aEnum) {
563
- Provider63aEnum["OPENAI"] = "openai";
564
- })(exports.Provider63aEnum || (exports.Provider63aEnum = {}));
525
+ exports.ProviderEnum = void 0;
526
+ (function (ProviderEnum) {
527
+ ProviderEnum["OPENAI"] = "openai";
528
+ ProviderEnum["GOOGLE"] = "google";
529
+ ProviderEnum["ELEVENLABS"] = "elevenlabs";
530
+ })(exports.ProviderEnum || (exports.ProviderEnum = {}));
565
531
 
566
532
  /* generated using openapi-typescript-codegen -- do not edit */
567
533
  /* istanbul ignore file */
@@ -731,22 +697,6 @@ exports.TypeC42Enum = void 0;
731
697
  TypeC42Enum["ASSESSMENT"] = "assessment";
732
698
  })(exports.TypeC42Enum || (exports.TypeC42Enum = {}));
733
699
 
734
- /* generated using openapi-typescript-codegen -- do not edit */
735
- /* istanbul ignore file */
736
- /* tslint:disable */
737
- /* eslint-disable */
738
- /**
739
- * * `openai` - Openai
740
- * * `google` - Google
741
- * * `elevenlabs` - Elevenlabs
742
- */
743
- exports.VoiceProviderEnum = void 0;
744
- (function (VoiceProviderEnum) {
745
- VoiceProviderEnum["OPENAI"] = "openai";
746
- VoiceProviderEnum["GOOGLE"] = "google";
747
- VoiceProviderEnum["ELEVENLABS"] = "elevenlabs";
748
- })(exports.VoiceProviderEnum || (exports.VoiceProviderEnum = {}));
749
-
750
700
  /* generated using openapi-typescript-codegen -- do not edit */
751
701
  /* istanbul ignore file */
752
702
  /* tslint:disable */
@@ -5790,1566 +5740,282 @@ class AiAnalyticsService {
5790
5740
  }
5791
5741
  }
5792
5742
 
5793
- class AiBotService {
5743
+ class AiIndexService {
5794
5744
  /**
5795
- * Create modify and update bot information for a specific tenant.
5745
+ * Retrieve details of a specific document embedding.
5746
+ *
5747
+ * This endpoint returns detailed information about a specific
5748
+ * document embedding identified by its ID.
5749
+ *
5750
+ * Args:
5751
+ * request: The HTTP request.
5752
+ * org: Organization key identifier.
5753
+ * document_id: The ID of the document embedding to retrieve.
5754
+ *
5755
+ * Returns:
5756
+ * Response: Detailed information about the document embedding.
5757
+ *
5758
+ * Raises:
5759
+ * NotFound: If the specified document embedding does not exist.
5760
+ * @param documentId
5796
5761
  * @param org
5797
- * @returns Bot
5762
+ * @param userId
5763
+ * @returns RetrieverDocumentEmbedding
5798
5764
  * @throws ApiError
5799
5765
  */
5800
- static aiBotV1BotsBotList(org) {
5766
+ static aiIndexOrgsUsersDocumentsRetrieve(documentId, org, userId) {
5801
5767
  return request(OpenAPI, {
5802
5768
  method: 'GET',
5803
- url: '/api/ai-bot/v1/bots/{org}/bot/',
5769
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
5804
5770
  path: {
5805
- 'org': org
5771
+ 'document_id': documentId,
5772
+ 'org': org,
5773
+ 'user_id': userId
5774
+ },
5775
+ errors: {
5776
+ 404: `Document not found`
5806
5777
  }
5807
5778
  });
5808
5779
  }
5809
5780
  /**
5810
- * Create modify and update bot information for a specific tenant.
5781
+ * Update a specific document embedding.
5782
+ *
5783
+ * This endpoint allows updating various properties of a document embedding,
5784
+ * including its name, type, pathway, and training status.
5785
+ *
5786
+ * Args:
5787
+ * request: The HTTP request containing the updated document data.
5788
+ * org: Organization key identifier.
5789
+ * document_id: The ID of the document embedding to update.
5790
+ *
5791
+ * Returns:
5792
+ * Response: The updated document embedding information.
5793
+ *
5794
+ * Raises:
5795
+ * BadRequest: If the provided data is invalid.
5796
+ * NotFound: If the specified document embedding does not exist.
5797
+ * @param documentId
5811
5798
  * @param org
5812
- * @param requestBody
5813
- * @returns BotCreate
5799
+ * @param userId
5800
+ * @param formData
5801
+ * @returns RetrieverDocumentEmbedding
5814
5802
  * @throws ApiError
5815
5803
  */
5816
- static aiBotV1BotsBotCreate(org, requestBody) {
5804
+ static aiIndexOrgsUsersDocumentsUpdate(documentId, org, userId, formData) {
5817
5805
  return request(OpenAPI, {
5818
- method: 'POST',
5819
- url: '/api/ai-bot/v1/bots/{org}/bot/',
5806
+ method: 'PUT',
5807
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
5820
5808
  path: {
5821
- 'org': org
5809
+ 'document_id': documentId,
5810
+ 'org': org,
5811
+ 'user_id': userId
5822
5812
  },
5823
- body: requestBody,
5824
- mediaType: 'application/json'
5813
+ formData: formData,
5814
+ mediaType: 'multipart/form-data',
5815
+ errors: {
5816
+ 400: `Invalid request data`,
5817
+ 404: `Document not found`
5818
+ }
5825
5819
  });
5826
5820
  }
5827
5821
  /**
5828
- * Create slash commands for a specific bot
5829
- * eg. /iblai-baseline
5822
+ * Delete a specific document embedding.
5823
+ *
5824
+ * This endpoint removes a document embedding from the system,
5825
+ * including untraining it from any associated pathways.
5826
+ *
5827
+ * Args:
5828
+ * request: The HTTP request.
5829
+ * org: Organization key identifier.
5830
+ * document_id: The ID of the document embedding to delete.
5831
+ *
5832
+ * Returns:
5833
+ * Response: An empty response with a 204 status code if successful.
5834
+ *
5835
+ * Raises:
5836
+ * NotFound: If the specified document embedding does not exist.
5837
+ * @param documentId
5830
5838
  * @param org
5831
- * @returns BotCommand
5839
+ * @param userId
5840
+ * @returns void
5832
5841
  * @throws ApiError
5833
5842
  */
5834
- static aiBotV1BotsBotCommandsList(org) {
5843
+ static aiIndexOrgsUsersDocumentsDestroy(documentId, org, userId) {
5835
5844
  return request(OpenAPI, {
5836
- method: 'GET',
5837
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
5845
+ method: 'DELETE',
5846
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
5838
5847
  path: {
5839
- 'org': org
5848
+ 'document_id': documentId,
5849
+ 'org': org,
5850
+ 'user_id': userId
5851
+ },
5852
+ errors: {
5853
+ 404: `Document not found`
5840
5854
  }
5841
5855
  });
5842
5856
  }
5843
5857
  /**
5844
- * Create slash commands for a specific bot
5845
- * eg. /iblai-baseline
5858
+ * Train a graph-based document through a worker process.
5859
+ *
5860
+ * This endpoint queues graph-based documents for training through a
5861
+ * specialized worker process that handles knowledge graph processing.
5862
+ *
5863
+ * Args:
5864
+ * request: The HTTP request containing the document information.
5865
+ * org: Organization key identifier.
5866
+ *
5867
+ * Returns:
5868
+ * Response: A confirmation that the document was queued for training,
5869
+ * including a task ID for tracking the progress.
5870
+ *
5871
+ * Raises:
5872
+ * ValidationError: If the request data is invalid.
5873
+ * BadRequest: If there was an error processing the document.
5846
5874
  * @param org
5847
- * @param requestBody
5848
- * @returns BotCommand
5875
+ * @param userId
5876
+ * @param formData
5877
+ * @returns TrainDocumentViewResponse
5849
5878
  * @throws ApiError
5850
5879
  */
5851
- static aiBotV1BotsBotCommandsCreate(org, requestBody) {
5880
+ static aiIndexOrgsUsersDocumentsGraphTrainCreate(org, userId, formData) {
5852
5881
  return request(OpenAPI, {
5853
5882
  method: 'POST',
5854
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
5883
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
5855
5884
  path: {
5856
- 'org': org
5885
+ 'org': org,
5886
+ 'user_id': userId
5857
5887
  },
5858
- body: requestBody,
5859
- mediaType: 'application/json'
5888
+ formData: formData,
5889
+ mediaType: 'multipart/form-data',
5890
+ errors: {
5891
+ 400: `Invalid request data or document processing error`
5892
+ }
5860
5893
  });
5861
5894
  }
5862
5895
  /**
5863
- * Create slash commands for a specific bot
5864
- * eg. /iblai-baseline
5865
- * @param id A unique integer value identifying this bot command.
5896
+ * Retrieve a list of document embeddings for a specific pathway.
5897
+ *
5898
+ * This endpoint returns a paginated list of all document embeddings
5899
+ * that have been created for the specified pathway within the organization.
5900
+ *
5901
+ * Args:
5902
+ * request: The HTTP request.
5903
+ * org: Organization key identifier.
5904
+ * pathway: The pathway to retrieve document embeddings for.
5905
+ *
5906
+ * Returns:
5907
+ * Response: A paginated list of document embeddings for the pathway.
5866
5908
  * @param org
5867
- * @returns BotCommand
5909
+ * @param pathway
5910
+ * @param userId
5911
+ * @returns RetrieverDocumentEmbedding
5868
5912
  * @throws ApiError
5869
5913
  */
5870
- static aiBotV1BotsBotCommandsRetrieve(id, org) {
5914
+ static aiIndexOrgsUsersDocumentsPathwaysList(org, pathway, userId) {
5871
5915
  return request(OpenAPI, {
5872
5916
  method: 'GET',
5873
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5917
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
5874
5918
  path: {
5875
- 'id': id,
5876
- 'org': org
5919
+ 'org': org,
5920
+ 'pathway': pathway,
5921
+ 'user_id': userId
5877
5922
  }
5878
5923
  });
5879
5924
  }
5880
5925
  /**
5881
- * Create slash commands for a specific bot
5882
- * eg. /iblai-baseline
5883
- * @param id A unique integer value identifying this bot command.
5926
+ * Retrieve resource documents similar to the given query.
5927
+ *
5928
+ * This endpoint performs a semantic search to find documents that are
5929
+ * relevant to the provided query within the specified pathway.
5930
+ *
5931
+ * Args:
5932
+ * request: The HTTP request containing the search query.
5933
+ * org: Organization key identifier.
5934
+ *
5935
+ * Returns:
5936
+ * Response: A list of documents relevant to the search query.
5937
+ *
5938
+ * Raises:
5939
+ * ValidationError: If the request data is invalid.
5884
5940
  * @param org
5941
+ * @param userId
5885
5942
  * @param requestBody
5886
- * @returns BotCommand
5943
+ * @returns RetrieverResponseSearch
5887
5944
  * @throws ApiError
5888
5945
  */
5889
- static aiBotV1BotsBotCommandsUpdate(id, org, requestBody) {
5946
+ static aiIndexOrgsUsersDocumentsSearchCreate(org, userId, requestBody) {
5890
5947
  return request(OpenAPI, {
5891
- method: 'PUT',
5892
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5948
+ method: 'POST',
5949
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
5893
5950
  path: {
5894
- 'id': id,
5895
- 'org': org
5951
+ 'org': org,
5952
+ 'user_id': userId
5896
5953
  },
5897
5954
  body: requestBody,
5898
- mediaType: 'application/json'
5955
+ mediaType: 'application/json',
5956
+ errors: {
5957
+ 400: `Invalid request data`
5958
+ }
5899
5959
  });
5900
5960
  }
5901
5961
  /**
5902
- * Create slash commands for a specific bot
5903
- * eg. /iblai-baseline
5904
- * @param id A unique integer value identifying this bot command.
5962
+ * Retrieve document sources related to a given query.
5963
+ *
5964
+ * This endpoint performs a semantic search to find document sources
5965
+ * that are relevant to the provided query within the specified pathway,
5966
+ * and returns them along with confidence levels.
5967
+ *
5968
+ * Args:
5969
+ * request: The HTTP request containing the search query.
5970
+ * org: Organization key identifier.
5971
+ *
5972
+ * Returns:
5973
+ * Response: A list of document sources with confidence levels.
5974
+ *
5975
+ * Raises:
5976
+ * ValidationError: If the request data is invalid.
5905
5977
  * @param org
5978
+ * @param userId
5906
5979
  * @param requestBody
5907
- * @returns BotCommand
5980
+ * @returns RetrieverRequestSearchDocument
5908
5981
  * @throws ApiError
5909
5982
  */
5910
- static aiBotV1BotsBotCommandsPartialUpdate(id, org, requestBody) {
5983
+ static aiIndexOrgsUsersDocumentsSourcesCreate(org, userId, requestBody) {
5911
5984
  return request(OpenAPI, {
5912
- method: 'PATCH',
5913
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5985
+ method: 'POST',
5986
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/',
5914
5987
  path: {
5915
- 'id': id,
5916
- 'org': org
5988
+ 'org': org,
5989
+ 'user_id': userId
5917
5990
  },
5918
5991
  body: requestBody,
5919
- mediaType: 'application/json'
5992
+ mediaType: 'application/json',
5993
+ errors: {
5994
+ 400: `Invalid request data`
5995
+ }
5920
5996
  });
5921
5997
  }
5922
5998
  /**
5923
- * Create slash commands for a specific bot
5924
- * eg. /iblai-baseline
5925
- * @param id A unique integer value identifying this bot command.
5999
+ * Check the status of a document training task.
6000
+ *
6001
+ * This endpoint retrieves the current status of an asynchronous
6002
+ * document training task that was previously initiated.
6003
+ *
6004
+ * Args:
6005
+ * request: The HTTP request.
6006
+ * org: Organization key identifier.
6007
+ * task_id: The ID of the training task to check.
6008
+ *
6009
+ * Returns:
6010
+ * Response: The current status of the document training task,
6011
+ * which can be "pending", "completed", or "failed".
5926
6012
  * @param org
5927
- * @returns void
6013
+ * @param taskId
6014
+ * @param userId
6015
+ * @returns CheckDocumentTrainingStatus
5928
6016
  * @throws ApiError
5929
6017
  */
5930
- static aiBotV1BotsBotCommandsDestroy(id, org) {
5931
- return request(OpenAPI, {
5932
- method: 'DELETE',
5933
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5934
- path: {
5935
- 'id': id,
5936
- 'org': org
5937
- }
5938
- });
5939
- }
5940
- /**
5941
- * Create modify and update bot information for a specific tenant.
5942
- * @param id A unique integer value identifying this bot.
5943
- * @param org
5944
- * @returns Bot
5945
- * @throws ApiError
5946
- */
5947
- static aiBotV1BotsBotRetrieve(id, org) {
5948
- return request(OpenAPI, {
5949
- method: 'GET',
5950
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
5951
- path: {
5952
- 'id': id,
5953
- 'org': org
5954
- }
5955
- });
5956
- }
5957
- /**
5958
- * Create modify and update bot information for a specific tenant.
5959
- * @param id A unique integer value identifying this bot.
5960
- * @param org
5961
- * @param requestBody
5962
- * @returns BotCreate
5963
- * @throws ApiError
5964
- */
5965
- static aiBotV1BotsBotUpdate(id, org, requestBody) {
5966
- return request(OpenAPI, {
5967
- method: 'PUT',
5968
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
5969
- path: {
5970
- 'id': id,
5971
- 'org': org
5972
- },
5973
- body: requestBody,
5974
- mediaType: 'application/json'
5975
- });
5976
- }
5977
- /**
5978
- * Create modify and update bot information for a specific tenant.
5979
- * @param id A unique integer value identifying this bot.
5980
- * @param org
5981
- * @param requestBody
5982
- * @returns BotCreate
5983
- * @throws ApiError
5984
- */
5985
- static aiBotV1BotsBotPartialUpdate(id, org, requestBody) {
5986
- return request(OpenAPI, {
5987
- method: 'PATCH',
5988
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
5989
- path: {
5990
- 'id': id,
5991
- 'org': org
5992
- },
5993
- body: requestBody,
5994
- mediaType: 'application/json'
5995
- });
5996
- }
5997
- /**
5998
- * Create modify and update bot information for a specific tenant.
5999
- * @param id A unique integer value identifying this bot.
6000
- * @param org
6001
- * @returns void
6002
- * @throws ApiError
6003
- */
6004
- static aiBotV1BotsBotDestroy(id, org) {
6005
- return request(OpenAPI, {
6006
- method: 'DELETE',
6007
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
6008
- path: {
6009
- 'id': id,
6010
- 'org': org
6011
- }
6012
- });
6013
- }
6014
- /**
6015
- * Create modify and update bot information for a specific tenant.
6016
- * @param id A unique integer value identifying this bot.
6017
- * @param org
6018
- * @returns DiscordConfig
6019
- * @throws ApiError
6020
- */
6021
- static aiBotV1BotsBotConfigDiscordRetrieve(id, org) {
6022
- return request(OpenAPI, {
6023
- method: 'GET',
6024
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
6025
- path: {
6026
- 'id': id,
6027
- 'org': org
6028
- }
6029
- });
6030
- }
6031
- /**
6032
- * Create modify and update bot information for a specific tenant.
6033
- * @param id A unique integer value identifying this bot.
6034
- * @param org
6035
- * @param requestBody
6036
- * @returns DiscordConfig
6037
- * @throws ApiError
6038
- */
6039
- static aiBotV1BotsBotConfigDiscordPartialUpdate(id, org, requestBody) {
6040
- return request(OpenAPI, {
6041
- method: 'PATCH',
6042
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
6043
- path: {
6044
- 'id': id,
6045
- 'org': org
6046
- },
6047
- body: requestBody,
6048
- mediaType: 'application/json'
6049
- });
6050
- }
6051
- /**
6052
- * Create modify and update bot information for a specific tenant.
6053
- * @param id A unique integer value identifying this bot.
6054
- * @param org
6055
- * @returns SlackConfig
6056
- * @throws ApiError
6057
- */
6058
- static aiBotV1BotsBotConfigSlackRetrieve(id, org) {
6059
- return request(OpenAPI, {
6060
- method: 'GET',
6061
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/',
6062
- path: {
6063
- 'id': id,
6064
- 'org': org
6065
- }
6066
- });
6067
- }
6068
- /**
6069
- * Create modify and update bot information for a specific tenant.
6070
- * @param id A unique integer value identifying this bot.
6071
- * @param org
6072
- * @param requestBody
6073
- * @returns SlackConfig
6074
- * @throws ApiError
6075
- */
6076
- static aiBotV1BotsBotConfigSlackUpdateCreate(id, org, requestBody) {
6077
- return request(OpenAPI, {
6078
- method: 'POST',
6079
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
6080
- path: {
6081
- 'id': id,
6082
- 'org': org
6083
- },
6084
- body: requestBody,
6085
- mediaType: 'application/json'
6086
- });
6087
- }
6088
- /**
6089
- * Create modify and update bot information for a specific tenant.
6090
- * @param id A unique integer value identifying this bot.
6091
- * @param org
6092
- * @param requestBody
6093
- * @returns SlackConfig
6094
- * @throws ApiError
6095
- */
6096
- static aiBotV1BotsBotConfigSlackUpdateUpdate(id, org, requestBody) {
6097
- return request(OpenAPI, {
6098
- method: 'PUT',
6099
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
6100
- path: {
6101
- 'id': id,
6102
- 'org': org
6103
- },
6104
- body: requestBody,
6105
- mediaType: 'application/json'
6106
- });
6107
- }
6108
- /**
6109
- * Create modify and update bot information for a specific tenant.
6110
- * @param id A unique integer value identifying this bot.
6111
- * @param org
6112
- * @param requestBody
6113
- * @returns SlackConfig
6114
- * @throws ApiError
6115
- */
6116
- static aiBotV1BotsBotConfigSlackUpdatePartialUpdate(id, org, requestBody) {
6117
- return request(OpenAPI, {
6118
- method: 'PATCH',
6119
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
6120
- path: {
6121
- 'id': id,
6122
- 'org': org
6123
- },
6124
- body: requestBody,
6125
- mediaType: 'application/json'
6126
- });
6127
- }
6128
- /**
6129
- * Create modify and update bot information for a specific tenant.
6130
- * @param id A unique integer value identifying this bot.
6131
- * @param org
6132
- * @returns TeamsConfig
6133
- * @throws ApiError
6134
- */
6135
- static aiBotV1BotsBotConfigTeamsRetrieve(id, org) {
6136
- return request(OpenAPI, {
6137
- method: 'GET',
6138
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
6139
- path: {
6140
- 'id': id,
6141
- 'org': org
6142
- }
6143
- });
6144
- }
6145
- /**
6146
- * Create modify and update bot information for a specific tenant.
6147
- * @param id A unique integer value identifying this bot.
6148
- * @param org
6149
- * @param requestBody
6150
- * @returns TeamsConfig
6151
- * @throws ApiError
6152
- */
6153
- static aiBotV1BotsBotConfigTeamsUpdateCreate(id, org, requestBody) {
6154
- return request(OpenAPI, {
6155
- method: 'POST',
6156
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
6157
- path: {
6158
- 'id': id,
6159
- 'org': org
6160
- },
6161
- body: requestBody,
6162
- mediaType: 'application/json'
6163
- });
6164
- }
6165
- /**
6166
- * Create modify and update bot information for a specific tenant.
6167
- * @param id A unique integer value identifying this bot.
6168
- * @param org
6169
- * @param requestBody
6170
- * @returns TeamsConfig
6171
- * @throws ApiError
6172
- */
6173
- static aiBotV1BotsBotConfigTeamsUpdateUpdate(id, org, requestBody) {
6174
- return request(OpenAPI, {
6175
- method: 'PUT',
6176
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
6177
- path: {
6178
- 'id': id,
6179
- 'org': org
6180
- },
6181
- body: requestBody,
6182
- mediaType: 'application/json'
6183
- });
6184
- }
6185
- /**
6186
- * Create modify and update bot information for a specific tenant.
6187
- * @param id A unique integer value identifying this bot.
6188
- * @param org
6189
- * @param requestBody
6190
- * @returns TeamsConfig
6191
- * @throws ApiError
6192
- */
6193
- static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate(id, org, requestBody) {
6194
- return request(OpenAPI, {
6195
- method: 'PATCH',
6196
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
6197
- path: {
6198
- 'id': id,
6199
- 'org': org
6200
- },
6201
- body: requestBody,
6202
- mediaType: 'application/json'
6203
- });
6204
- }
6205
- /**
6206
- * Create modify and update bot information for a specific tenant.
6207
- * @param id A unique integer value identifying this bot.
6208
- * @param org
6209
- * @returns WebexConfig
6210
- * @throws ApiError
6211
- */
6212
- static aiBotV1BotsBotConfigWebexRetrieve(id, org) {
6213
- return request(OpenAPI, {
6214
- method: 'GET',
6215
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
6216
- path: {
6217
- 'id': id,
6218
- 'org': org
6219
- }
6220
- });
6221
- }
6222
- /**
6223
- * Create modify and update bot information for a specific tenant.
6224
- * @param id A unique integer value identifying this bot.
6225
- * @param org
6226
- * @param requestBody
6227
- * @returns WebexConfig
6228
- * @throws ApiError
6229
- */
6230
- static aiBotV1BotsBotConfigWebexPartialUpdate(id, org, requestBody) {
6231
- return request(OpenAPI, {
6232
- method: 'PATCH',
6233
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
6234
- path: {
6235
- 'id': id,
6236
- 'org': org
6237
- },
6238
- body: requestBody,
6239
- mediaType: 'application/json'
6240
- });
6241
- }
6242
- /**
6243
- * Create modify and update bot information for a specific tenant.
6244
- * @param id A unique integer value identifying this bot.
6245
- * @param org
6246
- * @returns WhatsappConfig
6247
- * @throws ApiError
6248
- */
6249
- static aiBotV1BotsBotConfigWhatsappRetrieve(id, org) {
6250
- return request(OpenAPI, {
6251
- method: 'GET',
6252
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
6253
- path: {
6254
- 'id': id,
6255
- 'org': org
6256
- }
6257
- });
6258
- }
6259
- /**
6260
- * Create modify and update bot information for a specific tenant.
6261
- * @param id A unique integer value identifying this bot.
6262
- * @param org
6263
- * @param requestBody
6264
- * @returns WhatsappConfig
6265
- * @throws ApiError
6266
- */
6267
- static aiBotV1BotsBotWhatsappConfigUpdate(id, org, requestBody) {
6268
- return request(OpenAPI, {
6269
- method: 'PUT',
6270
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
6271
- path: {
6272
- 'id': id,
6273
- 'org': org
6274
- },
6275
- body: requestBody,
6276
- mediaType: 'application/json'
6277
- });
6278
- }
6279
- /**
6280
- * Create modify and update bot information for a specific tenant.
6281
- * @param id A unique integer value identifying this bot.
6282
- * @param org
6283
- * @param requestBody
6284
- * @returns WhatsappConfig
6285
- * @throws ApiError
6286
- */
6287
- static aiBotV1BotsBotWhatsappConfigPartialUpdate(id, org, requestBody) {
6288
- return request(OpenAPI, {
6289
- method: 'PATCH',
6290
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
6291
- path: {
6292
- 'id': id,
6293
- 'org': org
6294
- },
6295
- body: requestBody,
6296
- mediaType: 'application/json'
6297
- });
6298
- }
6299
- /**
6300
- * Setup discord user id linkage with discord bots
6301
- * this will be used to authenticate the user when interracting with discord bots.
6302
- * the user id can be copied from the discord app after tapping on the user profile.
6303
- * @param org
6304
- * @returns DiscordUserConfig
6305
- * @throws ApiError
6306
- */
6307
- static aiBotV1BotsDiscordUserConfigList(org) {
6308
- return request(OpenAPI, {
6309
- method: 'GET',
6310
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
6311
- path: {
6312
- 'org': org
6313
- }
6314
- });
6315
- }
6316
- /**
6317
- * Setup discord user id linkage with discord bots
6318
- * this will be used to authenticate the user when interracting with discord bots.
6319
- * the user id can be copied from the discord app after tapping on the user profile.
6320
- * @param org
6321
- * @param requestBody
6322
- * @returns DiscordUserConfig
6323
- * @throws ApiError
6324
- */
6325
- static aiBotV1BotsDiscordUserConfigCreate(org, requestBody) {
6326
- return request(OpenAPI, {
6327
- method: 'POST',
6328
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
6329
- path: {
6330
- 'org': org
6331
- },
6332
- body: requestBody,
6333
- mediaType: 'application/json'
6334
- });
6335
- }
6336
- /**
6337
- * Setup discord user id linkage with discord bots
6338
- * this will be used to authenticate the user when interracting with discord bots.
6339
- * the user id can be copied from the discord app after tapping on the user profile.
6340
- * @param id A unique integer value identifying this discord user config.
6341
- * @param org
6342
- * @returns DiscordUserConfig
6343
- * @throws ApiError
6344
- */
6345
- static aiBotV1BotsDiscordUserConfigRetrieve(id, org) {
6346
- return request(OpenAPI, {
6347
- method: 'GET',
6348
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
6349
- path: {
6350
- 'id': id,
6351
- 'org': org
6352
- }
6353
- });
6354
- }
6355
- /**
6356
- * Setup discord user id linkage with discord bots
6357
- * this will be used to authenticate the user when interracting with discord bots.
6358
- * the user id can be copied from the discord app after tapping on the user profile.
6359
- * @param id A unique integer value identifying this discord user config.
6360
- * @param org
6361
- * @param requestBody
6362
- * @returns DiscordUserConfig
6363
- * @throws ApiError
6364
- */
6365
- static aiBotV1BotsDiscordUserConfigUpdate(id, org, requestBody) {
6366
- return request(OpenAPI, {
6367
- method: 'PUT',
6368
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
6369
- path: {
6370
- 'id': id,
6371
- 'org': org
6372
- },
6373
- body: requestBody,
6374
- mediaType: 'application/json'
6375
- });
6376
- }
6377
- /**
6378
- * Setup discord user id linkage with discord bots
6379
- * this will be used to authenticate the user when interracting with discord bots.
6380
- * the user id can be copied from the discord app after tapping on the user profile.
6381
- * @param id A unique integer value identifying this discord user config.
6382
- * @param org
6383
- * @param requestBody
6384
- * @returns DiscordUserConfig
6385
- * @throws ApiError
6386
- */
6387
- static aiBotV1BotsDiscordUserConfigPartialUpdate(id, org, requestBody) {
6388
- return request(OpenAPI, {
6389
- method: 'PATCH',
6390
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
6391
- path: {
6392
- 'id': id,
6393
- 'org': org
6394
- },
6395
- body: requestBody,
6396
- mediaType: 'application/json'
6397
- });
6398
- }
6399
- /**
6400
- * Setup discord user id linkage with discord bots
6401
- * this will be used to authenticate the user when interracting with discord bots.
6402
- * the user id can be copied from the discord app after tapping on the user profile.
6403
- * @param id A unique integer value identifying this discord user config.
6404
- * @param org
6405
- * @returns void
6406
- * @throws ApiError
6407
- */
6408
- static aiBotV1BotsDiscordUserConfigDestroy(id, org) {
6409
- return request(OpenAPI, {
6410
- method: 'DELETE',
6411
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
6412
- path: {
6413
- 'id': id,
6414
- 'org': org
6415
- }
6416
- });
6417
- }
6418
- /**
6419
- * Setup slack username and domain linkage with slack bots
6420
- * this will be used to authenticate the user when interracting with slack bots.
6421
- * @param org
6422
- * @returns SlackUserConfig
6423
- * @throws ApiError
6424
- */
6425
- static aiBotV1BotsSlackUserConfigList(org) {
6426
- return request(OpenAPI, {
6427
- method: 'GET',
6428
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
6429
- path: {
6430
- 'org': org
6431
- }
6432
- });
6433
- }
6434
- /**
6435
- * Setup slack username and domain linkage with slack bots
6436
- * this will be used to authenticate the user when interracting with slack bots.
6437
- * @param org
6438
- * @param requestBody
6439
- * @returns SlackUserConfig
6440
- * @throws ApiError
6441
- */
6442
- static aiBotV1BotsSlackUserConfigCreate(org, requestBody) {
6443
- return request(OpenAPI, {
6444
- method: 'POST',
6445
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
6446
- path: {
6447
- 'org': org
6448
- },
6449
- body: requestBody,
6450
- mediaType: 'application/json'
6451
- });
6452
- }
6453
- /**
6454
- * Setup slack username and domain linkage with slack bots
6455
- * this will be used to authenticate the user when interracting with slack bots.
6456
- * @param id A unique integer value identifying this slack user config.
6457
- * @param org
6458
- * @returns SlackUserConfig
6459
- * @throws ApiError
6460
- */
6461
- static aiBotV1BotsSlackUserConfigRetrieve(id, org) {
6462
- return request(OpenAPI, {
6463
- method: 'GET',
6464
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
6465
- path: {
6466
- 'id': id,
6467
- 'org': org
6468
- }
6469
- });
6470
- }
6471
- /**
6472
- * Setup slack username and domain linkage with slack bots
6473
- * this will be used to authenticate the user when interracting with slack bots.
6474
- * @param id A unique integer value identifying this slack user config.
6475
- * @param org
6476
- * @param requestBody
6477
- * @returns SlackUserConfig
6478
- * @throws ApiError
6479
- */
6480
- static aiBotV1BotsSlackUserConfigUpdate(id, org, requestBody) {
6481
- return request(OpenAPI, {
6482
- method: 'PUT',
6483
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
6484
- path: {
6485
- 'id': id,
6486
- 'org': org
6487
- },
6488
- body: requestBody,
6489
- mediaType: 'application/json'
6490
- });
6491
- }
6492
- /**
6493
- * Setup slack username and domain linkage with slack bots
6494
- * this will be used to authenticate the user when interracting with slack bots.
6495
- * @param id A unique integer value identifying this slack user config.
6496
- * @param org
6497
- * @param requestBody
6498
- * @returns SlackUserConfig
6499
- * @throws ApiError
6500
- */
6501
- static aiBotV1BotsSlackUserConfigPartialUpdate(id, org, requestBody) {
6502
- return request(OpenAPI, {
6503
- method: 'PATCH',
6504
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
6505
- path: {
6506
- 'id': id,
6507
- 'org': org
6508
- },
6509
- body: requestBody,
6510
- mediaType: 'application/json'
6511
- });
6512
- }
6513
- /**
6514
- * Setup slack username and domain linkage with slack bots
6515
- * this will be used to authenticate the user when interracting with slack bots.
6516
- * @param id A unique integer value identifying this slack user config.
6517
- * @param org
6518
- * @returns void
6519
- * @throws ApiError
6520
- */
6521
- static aiBotV1BotsSlackUserConfigDestroy(id, org) {
6522
- return request(OpenAPI, {
6523
- method: 'DELETE',
6524
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
6525
- path: {
6526
- 'id': id,
6527
- 'org': org
6528
- }
6529
- });
6530
- }
6531
- /**
6532
- * Setup phone number linkage with whatsapp bots
6533
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6534
- * @param org
6535
- * @returns WhatsappUserConfig
6536
- * @throws ApiError
6537
- */
6538
- static aiBotV1BotsWhatsappUserConfigList(org) {
6539
- return request(OpenAPI, {
6540
- method: 'GET',
6541
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
6542
- path: {
6543
- 'org': org
6544
- }
6545
- });
6546
- }
6547
- /**
6548
- * Setup phone number linkage with whatsapp bots
6549
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6550
- * @param org
6551
- * @param requestBody
6552
- * @returns WhatsappUserConfig
6553
- * @throws ApiError
6554
- */
6555
- static aiBotV1BotsWhatsappUserConfigCreate(org, requestBody) {
6556
- return request(OpenAPI, {
6557
- method: 'POST',
6558
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
6559
- path: {
6560
- 'org': org
6561
- },
6562
- body: requestBody,
6563
- mediaType: 'application/json'
6564
- });
6565
- }
6566
- /**
6567
- * Setup phone number linkage with whatsapp bots
6568
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6569
- * @param id A unique integer value identifying this whatsapp user config.
6570
- * @param org
6571
- * @returns WhatsappUserConfig
6572
- * @throws ApiError
6573
- */
6574
- static aiBotV1BotsWhatsappUserConfigRetrieve(id, org) {
6575
- return request(OpenAPI, {
6576
- method: 'GET',
6577
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
6578
- path: {
6579
- 'id': id,
6580
- 'org': org
6581
- }
6582
- });
6583
- }
6584
- /**
6585
- * Setup phone number linkage with whatsapp bots
6586
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6587
- * @param id A unique integer value identifying this whatsapp user config.
6588
- * @param org
6589
- * @param requestBody
6590
- * @returns WhatsappUserConfig
6591
- * @throws ApiError
6592
- */
6593
- static aiBotV1BotsWhatsappUserConfigUpdate(id, org, requestBody) {
6594
- return request(OpenAPI, {
6595
- method: 'PUT',
6596
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
6597
- path: {
6598
- 'id': id,
6599
- 'org': org
6600
- },
6601
- body: requestBody,
6602
- mediaType: 'application/json'
6603
- });
6604
- }
6605
- /**
6606
- * Setup phone number linkage with whatsapp bots
6607
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6608
- * @param id A unique integer value identifying this whatsapp user config.
6609
- * @param org
6610
- * @param requestBody
6611
- * @returns WhatsappUserConfig
6612
- * @throws ApiError
6613
- */
6614
- static aiBotV1BotsWhatsappUserConfigPartialUpdate(id, org, requestBody) {
6615
- return request(OpenAPI, {
6616
- method: 'PATCH',
6617
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
6618
- path: {
6619
- 'id': id,
6620
- 'org': org
6621
- },
6622
- body: requestBody,
6623
- mediaType: 'application/json'
6624
- });
6625
- }
6626
- /**
6627
- * Setup phone number linkage with whatsapp bots
6628
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6629
- * @param id A unique integer value identifying this whatsapp user config.
6630
- * @param org
6631
- * @returns void
6632
- * @throws ApiError
6633
- */
6634
- static aiBotV1BotsWhatsappUserConfigDestroy(id, org) {
6635
- return request(OpenAPI, {
6636
- method: 'DELETE',
6637
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
6638
- path: {
6639
- 'id': id,
6640
- 'org': org
6641
- }
6642
- });
6643
- }
6644
- /**
6645
- * Webhook endpoint to receive and process discord messages.
6646
- * @param name
6647
- * @param org
6648
- * @param requestBody
6649
- * @returns DiscordWebhook
6650
- * @throws ApiError
6651
- */
6652
- static aiBotV1BotsWebhooksDiscordCreate(name, org, requestBody) {
6653
- return request(OpenAPI, {
6654
- method: 'POST',
6655
- url: '/api/ai-bot/v1/bots/webhooks/{org}/discord/{name}/',
6656
- path: {
6657
- 'name': name,
6658
- 'org': org
6659
- },
6660
- body: requestBody,
6661
- mediaType: 'application/json'
6662
- });
6663
- }
6664
- /**
6665
- * @param name
6666
- * @param org
6667
- * @param requestBody
6668
- * @returns SlackWebhook
6669
- * @throws ApiError
6670
- */
6671
- static aiBotV1BotsWebhooksSlackCreate(name, org, requestBody) {
6672
- return request(OpenAPI, {
6673
- method: 'POST',
6674
- url: '/api/ai-bot/v1/bots/webhooks/{org}/slack/{name}/',
6675
- path: {
6676
- 'name': name,
6677
- 'org': org
6678
- },
6679
- body: requestBody,
6680
- mediaType: 'application/json'
6681
- });
6682
- }
6683
- /**
6684
- * @param name
6685
- * @param org
6686
- * @param requestBody
6687
- * @returns TeamsWebhook
6688
- * @throws ApiError
6689
- */
6690
- static aiBotV1BotsWebhooksTeamsCreate(name, org, requestBody) {
6691
- return request(OpenAPI, {
6692
- method: 'POST',
6693
- url: '/api/ai-bot/v1/bots/webhooks/{org}/teams/{name}/',
6694
- path: {
6695
- 'name': name,
6696
- 'org': org
6697
- },
6698
- body: requestBody,
6699
- mediaType: 'application/json'
6700
- });
6701
- }
6702
- /**
6703
- * Webhook endpoint to receive and process discord messages.
6704
- * @param name
6705
- * @param org
6706
- * @param requestBody
6707
- * @returns WebexWebhook
6708
- * @throws ApiError
6709
- */
6710
- static aiBotV1BotsWebhooksWebexCreate(name, org, requestBody) {
6711
- return request(OpenAPI, {
6712
- method: 'POST',
6713
- url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
6714
- path: {
6715
- 'name': name,
6716
- 'org': org
6717
- },
6718
- body: requestBody,
6719
- mediaType: 'application/json'
6720
- });
6721
- }
6722
- /**
6723
- * Respond to whatsapp's webhook challenge.
6724
- * Parameters Required include the tenant key (org) and the name of the bot: (name)
6725
- * @param name
6726
- * @param org
6727
- * @returns WhatAppWebHook
6728
- * @throws ApiError
6729
- */
6730
- static aiBotV1BotsWebhooksWhatsappRetrieve(name, org) {
6731
- return request(OpenAPI, {
6732
- method: 'GET',
6733
- url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
6734
- path: {
6735
- 'name': name,
6736
- 'org': org
6737
- }
6738
- });
6739
- }
6740
- /**
6741
- * Accept and process webhook events from whatsapp.
6742
- * @param name
6743
- * @param org
6744
- * @param requestBody
6745
- * @returns WhatAppWebHook
6746
- * @throws ApiError
6747
- */
6748
- static aiBotV1BotsWebhooksWhatsappCreate(name, org, requestBody) {
6749
- return request(OpenAPI, {
6750
- method: 'POST',
6751
- url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
6752
- path: {
6753
- 'name': name,
6754
- 'org': org
6755
- },
6756
- body: requestBody,
6757
- mediaType: 'application/json'
6758
- });
6759
- }
6760
- }
6761
-
6762
- class AiFinetuningService {
6763
- /**
6764
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6765
- * @param org
6766
- * @param username
6767
- * @param dateCreated
6768
- * @param numDataPoints
6769
- * @param ordering Which field to use when ordering the results.
6770
- * @param page A page number within the paginated result set.
6771
- * @param pageSize Number of results to return per page.
6772
- * @param retryAttempts
6773
- * @param search A search term.
6774
- * @param status * `pending` - Pending
6775
- * * `processing` - Processing
6776
- * * `completed` - Completed
6777
- * * `failed` - Failed
6778
- * @returns PaginatedDataSetList
6779
- * @throws ApiError
6780
- */
6781
- static aiFinetuningV1OrgUserDatasetsList(org, username, dateCreated, numDataPoints, ordering, page, pageSize, retryAttempts, search, status) {
6782
- return request(OpenAPI, {
6783
- method: 'GET',
6784
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
6785
- path: {
6786
- 'org': org,
6787
- 'username': username
6788
- },
6789
- query: {
6790
- 'date_created': dateCreated,
6791
- 'num_data_points': numDataPoints,
6792
- 'ordering': ordering,
6793
- 'page': page,
6794
- 'page_size': pageSize,
6795
- 'retry_attempts': retryAttempts,
6796
- 'search': search,
6797
- 'status': status
6798
- }
6799
- });
6800
- }
6801
- /**
6802
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6803
- * @param org
6804
- * @param username
6805
- * @param requestBody
6806
- * @returns DataSetCreate
6807
- * @throws ApiError
6808
- */
6809
- static aiFinetuningV1OrgUserDatasetsCreate(org, username, requestBody) {
6810
- return request(OpenAPI, {
6811
- method: 'POST',
6812
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
6813
- path: {
6814
- 'org': org,
6815
- 'username': username
6816
- },
6817
- body: requestBody,
6818
- mediaType: 'application/json'
6819
- });
6820
- }
6821
- /**
6822
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6823
- * @param id A UUID string identifying this data set.
6824
- * @param org
6825
- * @param username
6826
- * @returns DataSet
6827
- * @throws ApiError
6828
- */
6829
- static aiFinetuningV1OrgUserDatasetsRetrieve(id, org, username) {
6830
- return request(OpenAPI, {
6831
- method: 'GET',
6832
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6833
- path: {
6834
- 'id': id,
6835
- 'org': org,
6836
- 'username': username
6837
- }
6838
- });
6839
- }
6840
- /**
6841
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6842
- * @param id A UUID string identifying this data set.
6843
- * @param org
6844
- * @param username
6845
- * @param requestBody
6846
- * @returns DataSet
6847
- * @throws ApiError
6848
- */
6849
- static aiFinetuningV1OrgUserDatasetsUpdate(id, org, username, requestBody) {
6850
- return request(OpenAPI, {
6851
- method: 'PUT',
6852
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6853
- path: {
6854
- 'id': id,
6855
- 'org': org,
6856
- 'username': username
6857
- },
6858
- body: requestBody,
6859
- mediaType: 'application/json'
6860
- });
6861
- }
6862
- /**
6863
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6864
- * @param id A UUID string identifying this data set.
6865
- * @param org
6866
- * @param username
6867
- * @param requestBody
6868
- * @returns DataSet
6869
- * @throws ApiError
6870
- */
6871
- static aiFinetuningV1OrgUserDatasetsPartialUpdate(id, org, username, requestBody) {
6872
- return request(OpenAPI, {
6873
- method: 'PATCH',
6874
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6875
- path: {
6876
- 'id': id,
6877
- 'org': org,
6878
- 'username': username
6879
- },
6880
- body: requestBody,
6881
- mediaType: 'application/json'
6882
- });
6883
- }
6884
- /**
6885
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6886
- * @param id A UUID string identifying this data set.
6887
- * @param org
6888
- * @param username
6889
- * @returns void
6890
- * @throws ApiError
6891
- */
6892
- static aiFinetuningV1OrgUserDatasetsDestroy(id, org, username) {
6893
- return request(OpenAPI, {
6894
- method: 'DELETE',
6895
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6896
- path: {
6897
- 'id': id,
6898
- 'org': org,
6899
- 'username': username
6900
- }
6901
- });
6902
- }
6903
- /**
6904
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6905
- * @param org
6906
- * @param username
6907
- * @param baseModelName
6908
- * @param dataset
6909
- * @param dateCreated
6910
- * @param fineTunedModel
6911
- * @param lastModified
6912
- * @param ordering Which field to use when ordering the results.
6913
- * @param page A page number within the paginated result set.
6914
- * @param pageSize Number of results to return per page.
6915
- * @param preprocessDataset
6916
- * @param provider * `openai` - Openai
6917
- * @param search A search term.
6918
- * @param status * `pending` - Pending
6919
- * * `processing` - Processing
6920
- * * `completed` - Completed
6921
- * * `cancelled` - Cancelled
6922
- * * `failed` - Failed
6923
- * @returns PaginatedTrainingList
6924
- * @throws ApiError
6925
- */
6926
- static aiFinetuningV1OrgUserTrainingsList(org, username, baseModelName, dataset, dateCreated, fineTunedModel, lastModified, ordering, page, pageSize, preprocessDataset, provider, search, status) {
6927
- return request(OpenAPI, {
6928
- method: 'GET',
6929
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
6930
- path: {
6931
- 'org': org,
6932
- 'username': username
6933
- },
6934
- query: {
6935
- 'base_model_name': baseModelName,
6936
- 'dataset': dataset,
6937
- 'date_created': dateCreated,
6938
- 'fine_tuned_model': fineTunedModel,
6939
- 'last_modified': lastModified,
6940
- 'ordering': ordering,
6941
- 'page': page,
6942
- 'page_size': pageSize,
6943
- 'preprocess_dataset': preprocessDataset,
6944
- 'provider': provider,
6945
- 'search': search,
6946
- 'status': status
6947
- }
6948
- });
6949
- }
6950
- /**
6951
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6952
- * @param org
6953
- * @param username
6954
- * @param requestBody
6955
- * @returns TrainingCreate
6956
- * @throws ApiError
6957
- */
6958
- static aiFinetuningV1OrgUserTrainingsCreate(org, username, requestBody) {
6959
- return request(OpenAPI, {
6960
- method: 'POST',
6961
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
6962
- path: {
6963
- 'org': org,
6964
- 'username': username
6965
- },
6966
- body: requestBody,
6967
- mediaType: 'application/json'
6968
- });
6969
- }
6970
- /**
6971
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6972
- * @param id A UUID string identifying this training.
6973
- * @param org
6974
- * @param username
6975
- * @returns Training
6976
- * @throws ApiError
6977
- */
6978
- static aiFinetuningV1OrgUserTrainingsRetrieve(id, org, username) {
6979
- return request(OpenAPI, {
6980
- method: 'GET',
6981
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
6982
- path: {
6983
- 'id': id,
6984
- 'org': org,
6985
- 'username': username
6986
- }
6987
- });
6988
- }
6989
- /**
6990
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6991
- * @param id A UUID string identifying this training.
6992
- * @param org
6993
- * @param username
6994
- * @param requestBody
6995
- * @returns TrainingCreate
6996
- * @throws ApiError
6997
- */
6998
- static aiFinetuningV1OrgUserTrainingsUpdate(id, org, username, requestBody) {
6999
- return request(OpenAPI, {
7000
- method: 'PUT',
7001
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
7002
- path: {
7003
- 'id': id,
7004
- 'org': org,
7005
- 'username': username
7006
- },
7007
- body: requestBody,
7008
- mediaType: 'application/json'
7009
- });
7010
- }
7011
- /**
7012
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
7013
- * @param id A UUID string identifying this training.
7014
- * @param org
7015
- * @param username
7016
- * @param requestBody
7017
- * @returns TrainingCreate
7018
- * @throws ApiError
7019
- */
7020
- static aiFinetuningV1OrgUserTrainingsPartialUpdate(id, org, username, requestBody) {
7021
- return request(OpenAPI, {
7022
- method: 'PATCH',
7023
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
7024
- path: {
7025
- 'id': id,
7026
- 'org': org,
7027
- 'username': username
7028
- },
7029
- body: requestBody,
7030
- mediaType: 'application/json'
7031
- });
7032
- }
7033
- /**
7034
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
7035
- * @param id A UUID string identifying this training.
7036
- * @param org
7037
- * @param username
7038
- * @returns void
7039
- * @throws ApiError
7040
- */
7041
- static aiFinetuningV1OrgUserTrainingsDestroy(id, org, username) {
7042
- return request(OpenAPI, {
7043
- method: 'DELETE',
7044
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
7045
- path: {
7046
- 'id': id,
7047
- 'org': org,
7048
- 'username': username
7049
- }
7050
- });
7051
- }
7052
- /**
7053
- * Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model.
7054
- * Filtering and pagination is allowed.
7055
- *
7056
- * NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
7057
- * training list endpoint.
7058
- * Returns:
7059
- * Response: A paginated response containing the serialized fine-tuned models.
7060
- * @param org
7061
- * @param username
7062
- * @returns Training
7063
- * @throws ApiError
7064
- */
7065
- static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve(org, username) {
7066
- return request(OpenAPI, {
7067
- method: 'GET',
7068
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/',
7069
- path: {
7070
- 'org': org,
7071
- 'username': username
7072
- }
7073
- });
7074
- }
7075
- }
7076
-
7077
- class AiIndexService {
7078
- /**
7079
- * Retrieve details of a specific document embedding.
7080
- *
7081
- * This endpoint returns detailed information about a specific
7082
- * document embedding identified by its ID.
7083
- *
7084
- * Args:
7085
- * request: The HTTP request.
7086
- * org: Organization key identifier.
7087
- * document_id: The ID of the document embedding to retrieve.
7088
- *
7089
- * Returns:
7090
- * Response: Detailed information about the document embedding.
7091
- *
7092
- * Raises:
7093
- * NotFound: If the specified document embedding does not exist.
7094
- * @param documentId
7095
- * @param org
7096
- * @param userId
7097
- * @returns RetrieverDocumentEmbedding
7098
- * @throws ApiError
7099
- */
7100
- static aiIndexOrgsUsersDocumentsRetrieve(documentId, org, userId) {
7101
- return request(OpenAPI, {
7102
- method: 'GET',
7103
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
7104
- path: {
7105
- 'document_id': documentId,
7106
- 'org': org,
7107
- 'user_id': userId
7108
- },
7109
- errors: {
7110
- 404: `Document not found`
7111
- }
7112
- });
7113
- }
7114
- /**
7115
- * Update a specific document embedding.
7116
- *
7117
- * This endpoint allows updating various properties of a document embedding,
7118
- * including its name, type, pathway, and training status.
7119
- *
7120
- * Args:
7121
- * request: The HTTP request containing the updated document data.
7122
- * org: Organization key identifier.
7123
- * document_id: The ID of the document embedding to update.
7124
- *
7125
- * Returns:
7126
- * Response: The updated document embedding information.
7127
- *
7128
- * Raises:
7129
- * BadRequest: If the provided data is invalid.
7130
- * NotFound: If the specified document embedding does not exist.
7131
- * @param documentId
7132
- * @param org
7133
- * @param userId
7134
- * @param formData
7135
- * @returns RetrieverDocumentEmbedding
7136
- * @throws ApiError
7137
- */
7138
- static aiIndexOrgsUsersDocumentsUpdate(documentId, org, userId, formData) {
7139
- return request(OpenAPI, {
7140
- method: 'PUT',
7141
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
7142
- path: {
7143
- 'document_id': documentId,
7144
- 'org': org,
7145
- 'user_id': userId
7146
- },
7147
- formData: formData,
7148
- mediaType: 'multipart/form-data',
7149
- errors: {
7150
- 400: `Invalid request data`,
7151
- 404: `Document not found`
7152
- }
7153
- });
7154
- }
7155
- /**
7156
- * Delete a specific document embedding.
7157
- *
7158
- * This endpoint removes a document embedding from the system,
7159
- * including untraining it from any associated pathways.
7160
- *
7161
- * Args:
7162
- * request: The HTTP request.
7163
- * org: Organization key identifier.
7164
- * document_id: The ID of the document embedding to delete.
7165
- *
7166
- * Returns:
7167
- * Response: An empty response with a 204 status code if successful.
7168
- *
7169
- * Raises:
7170
- * NotFound: If the specified document embedding does not exist.
7171
- * @param documentId
7172
- * @param org
7173
- * @param userId
7174
- * @returns void
7175
- * @throws ApiError
7176
- */
7177
- static aiIndexOrgsUsersDocumentsDestroy(documentId, org, userId) {
7178
- return request(OpenAPI, {
7179
- method: 'DELETE',
7180
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
7181
- path: {
7182
- 'document_id': documentId,
7183
- 'org': org,
7184
- 'user_id': userId
7185
- },
7186
- errors: {
7187
- 404: `Document not found`
7188
- }
7189
- });
7190
- }
7191
- /**
7192
- * Train a graph-based document through a worker process.
7193
- *
7194
- * This endpoint queues graph-based documents for training through a
7195
- * specialized worker process that handles knowledge graph processing.
7196
- *
7197
- * Args:
7198
- * request: The HTTP request containing the document information.
7199
- * org: Organization key identifier.
7200
- *
7201
- * Returns:
7202
- * Response: A confirmation that the document was queued for training,
7203
- * including a task ID for tracking the progress.
7204
- *
7205
- * Raises:
7206
- * ValidationError: If the request data is invalid.
7207
- * BadRequest: If there was an error processing the document.
7208
- * @param org
7209
- * @param userId
7210
- * @param formData
7211
- * @returns TrainDocumentViewResponse
7212
- * @throws ApiError
7213
- */
7214
- static aiIndexOrgsUsersDocumentsGraphTrainCreate(org, userId, formData) {
7215
- return request(OpenAPI, {
7216
- method: 'POST',
7217
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
7218
- path: {
7219
- 'org': org,
7220
- 'user_id': userId
7221
- },
7222
- formData: formData,
7223
- mediaType: 'multipart/form-data',
7224
- errors: {
7225
- 400: `Invalid request data or document processing error`
7226
- }
7227
- });
7228
- }
7229
- /**
7230
- * Retrieve a list of document embeddings for a specific pathway.
7231
- *
7232
- * This endpoint returns a paginated list of all document embeddings
7233
- * that have been created for the specified pathway within the organization.
7234
- *
7235
- * Args:
7236
- * request: The HTTP request.
7237
- * org: Organization key identifier.
7238
- * pathway: The pathway to retrieve document embeddings for.
7239
- *
7240
- * Returns:
7241
- * Response: A paginated list of document embeddings for the pathway.
7242
- * @param org
7243
- * @param pathway
7244
- * @param userId
7245
- * @returns RetrieverDocumentEmbedding
7246
- * @throws ApiError
7247
- */
7248
- static aiIndexOrgsUsersDocumentsPathwaysList(org, pathway, userId) {
7249
- return request(OpenAPI, {
7250
- method: 'GET',
7251
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
7252
- path: {
7253
- 'org': org,
7254
- 'pathway': pathway,
7255
- 'user_id': userId
7256
- }
7257
- });
7258
- }
7259
- /**
7260
- * Retrieve resource documents similar to the given query.
7261
- *
7262
- * This endpoint performs a semantic search to find documents that are
7263
- * relevant to the provided query within the specified pathway.
7264
- *
7265
- * Args:
7266
- * request: The HTTP request containing the search query.
7267
- * org: Organization key identifier.
7268
- *
7269
- * Returns:
7270
- * Response: A list of documents relevant to the search query.
7271
- *
7272
- * Raises:
7273
- * ValidationError: If the request data is invalid.
7274
- * @param org
7275
- * @param userId
7276
- * @param requestBody
7277
- * @returns RetrieverResponseSearch
7278
- * @throws ApiError
7279
- */
7280
- static aiIndexOrgsUsersDocumentsSearchCreate(org, userId, requestBody) {
7281
- return request(OpenAPI, {
7282
- method: 'POST',
7283
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
7284
- path: {
7285
- 'org': org,
7286
- 'user_id': userId
7287
- },
7288
- body: requestBody,
7289
- mediaType: 'application/json',
7290
- errors: {
7291
- 400: `Invalid request data`
7292
- }
7293
- });
7294
- }
7295
- /**
7296
- * Retrieve document sources related to a given query.
7297
- *
7298
- * This endpoint performs a semantic search to find document sources
7299
- * that are relevant to the provided query within the specified pathway,
7300
- * and returns them along with confidence levels.
7301
- *
7302
- * Args:
7303
- * request: The HTTP request containing the search query.
7304
- * org: Organization key identifier.
7305
- *
7306
- * Returns:
7307
- * Response: A list of document sources with confidence levels.
7308
- *
7309
- * Raises:
7310
- * ValidationError: If the request data is invalid.
7311
- * @param org
7312
- * @param userId
7313
- * @param requestBody
7314
- * @returns RetrieverRequestSearchDocument
7315
- * @throws ApiError
7316
- */
7317
- static aiIndexOrgsUsersDocumentsSourcesCreate(org, userId, requestBody) {
7318
- return request(OpenAPI, {
7319
- method: 'POST',
7320
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/',
7321
- path: {
7322
- 'org': org,
7323
- 'user_id': userId
7324
- },
7325
- body: requestBody,
7326
- mediaType: 'application/json',
7327
- errors: {
7328
- 400: `Invalid request data`
7329
- }
7330
- });
7331
- }
7332
- /**
7333
- * Check the status of a document training task.
7334
- *
7335
- * This endpoint retrieves the current status of an asynchronous
7336
- * document training task that was previously initiated.
7337
- *
7338
- * Args:
7339
- * request: The HTTP request.
7340
- * org: Organization key identifier.
7341
- * task_id: The ID of the training task to check.
7342
- *
7343
- * Returns:
7344
- * Response: The current status of the document training task,
7345
- * which can be "pending", "completed", or "failed".
7346
- * @param org
7347
- * @param taskId
7348
- * @param userId
7349
- * @returns CheckDocumentTrainingStatus
7350
- * @throws ApiError
7351
- */
7352
- static aiIndexOrgsUsersDocumentsTasksRetrieve(org, taskId, userId) {
6018
+ static aiIndexOrgsUsersDocumentsTasksRetrieve(org, taskId, userId) {
7353
6019
  return request(OpenAPI, {
7354
6020
  method: 'GET',
7355
6021
  url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/tasks/{task_id}/',
@@ -17378,124 +16044,123 @@ class CatalogService {
17378
16044
  });
17379
16045
  }
17380
16046
  /**
17381
- * Retrieve courses matching query parameters.
17382
- *
17383
- * Query Parameters:
17384
- * course_id (str, optional): Filter courses by their unique identifier
17385
- * slug (str, optional): Filter courses by their slug (case-insensitive)
17386
- * org (str, optional): Filter courses by their associated organization
17387
- *
17388
- * Returns:
17389
- * A list of courses matching the provided filters. If no filters are provided,
17390
- * all courses are returned.
17391
- * @returns any No response body
16047
+ * Retrieve courses matching specified filters.
16048
+ * @param courseId Filter courses by their unique identifier
16049
+ * @param org Filter courses by their associated organization
16050
+ * @param slug Filter courses by their slug (case-insensitive)
16051
+ * @returns Course
17392
16052
  * @throws ApiError
17393
16053
  */
17394
- static catalogCoursesRetrieve() {
16054
+ static catalogCoursesList(courseId, org, slug) {
17395
16055
  return request(OpenAPI, {
17396
16056
  method: 'GET',
17397
- url: '/api/catalog/courses/'
16057
+ url: '/api/catalog/courses/',
16058
+ query: {
16059
+ 'course_id': courseId,
16060
+ 'org': org,
16061
+ 'slug': slug
16062
+ },
16063
+ errors: {
16064
+ 400: `No response body`
16065
+ }
17398
16066
  });
17399
16067
  }
17400
16068
  /**
17401
16069
  * Add or update a course in the database.
17402
- *
17403
- * Request Body:
17404
- * course_id (str, required): The unique identifier for the course
17405
- * org (str, required): The organization associated with the course
17406
- * name (str, optional): The name of the course
17407
- *
17408
- * Returns:
17409
- * A JSON representation of the course that was added or updated.
17410
- * Status code 201 if the course was newly created.
17411
- * Status code 200 if the course already existed and was updated.
17412
- *
17413
- * Error Responses:
17414
- * 400 Bad Request: If the course could not be created or updated due to invalid data
17415
- * @returns any No response body
16070
+ * @param requestBody
16071
+ * @param courseId Filter courses by their unique identifier
16072
+ * @param org Filter courses by their associated organization
16073
+ * @param slug Filter courses by their slug (case-insensitive)
16074
+ * @returns Course
17416
16075
  * @throws ApiError
17417
16076
  */
17418
- static catalogCoursesCreate() {
16077
+ static catalogCoursesCreate(requestBody, courseId, org, slug) {
17419
16078
  return request(OpenAPI, {
17420
16079
  method: 'POST',
17421
- url: '/api/catalog/courses/'
16080
+ url: '/api/catalog/courses/',
16081
+ query: {
16082
+ 'course_id': courseId,
16083
+ 'org': org,
16084
+ 'slug': slug
16085
+ },
16086
+ body: requestBody,
16087
+ mediaType: 'application/json',
16088
+ errors: {
16089
+ 400: `No response body`
16090
+ }
17422
16091
  });
17423
16092
  }
17424
16093
  /**
17425
16094
  * Remove a course from the database.
17426
- *
17427
- * Query Parameters:
17428
- * course_id (str, required): The unique identifier for the course to be deleted
17429
- *
17430
- * Returns:
17431
- * A JSON object containing the count of deleted items and their type.
17432
- * Status code 200 upon successful deletion.
17433
- *
17434
- * Error Responses:
17435
- * 400 Bad Request: If the required parameters are not provided or if no course
17436
- * matches the given filters
17437
- * @returns void
16095
+ * @param courseId Filter courses by their unique identifier
16096
+ * @param org Filter courses by their associated organization
16097
+ * @param slug Filter courses by their slug (case-insensitive)
16098
+ * @returns CourseDeleteResponse
17438
16099
  * @throws ApiError
17439
16100
  */
17440
- static catalogCoursesDestroy() {
16101
+ static catalogCoursesDestroy(courseId, org, slug) {
17441
16102
  return request(OpenAPI, {
17442
16103
  method: 'DELETE',
17443
- url: '/api/catalog/courses/'
16104
+ url: '/api/catalog/courses/',
16105
+ query: {
16106
+ 'course_id': courseId,
16107
+ 'org': org,
16108
+ 'slug': slug
16109
+ },
16110
+ errors: {
16111
+ 400: `No response body`
16112
+ }
17444
16113
  });
17445
16114
  }
17446
16115
  /**
17447
- * GET
17448
- * List 'eligible' courses for user.
17449
- *
17450
- * This method retrieves a list of courses that the specified user is eligible for.
17451
- * It requires either a user_id or a username to identify the user, and optionally an organization (org)
17452
- * and a search query to filter the courses.
17453
- *
17454
- * Params:
17455
- * - user_id/username: Identifies the user whose eligible courses are to be listed.
17456
- * - org: (Optional) Filters courses by organization.
17457
- * - query: (Optional) A search term to filter the courses.
17458
- *
17459
- * Returns:
17460
- * - A 200 status code with a list of serialized course data if courses are found.
17461
- * - A 200 status code with an empty list if no eligible courses are found.
17462
- * - A 400 status code if the user_id or username is not provided or invalid.
17463
- *
17464
- * Side Effects:
17465
- * - If a username is provided instead of a user_id, the method attempts to retrieve the user_id from the username.
17466
- * @returns any No response body
16116
+ * List courses that a user is eligible for.
16117
+ * @param org Filter eligible courses by organization
16118
+ * @param query Search term to filter eligible courses
16119
+ * @param userId User ID to check eligibility for
16120
+ * @param username Username to check eligibility for
16121
+ * @returns Course
17467
16122
  * @throws ApiError
17468
16123
  */
17469
- static catalogEligibilityCoursesRetrieve() {
16124
+ static catalogEligibilityCoursesList(org, query, userId, username) {
17470
16125
  return request(OpenAPI, {
17471
16126
  method: 'GET',
17472
- url: '/api/catalog/eligibility/courses/'
16127
+ url: '/api/catalog/eligibility/courses/',
16128
+ query: {
16129
+ 'org': org,
16130
+ 'query': query,
16131
+ 'user_id': userId,
16132
+ 'username': username
16133
+ },
16134
+ errors: {
16135
+ 400: `No response body`
16136
+ }
17473
16137
  });
17474
16138
  }
17475
16139
  /**
17476
- * GET
17477
- * Check whether user is eligible to enroll in a course
17478
- *
17479
- * Params:
17480
- * user_id/username: The unique identifier or username of the user whose eligibility is being checked.
17481
- * course_id: The unique identifier of the course for which eligibility is being checked.
17482
- * org: The organization associated with the course.
17483
- * local_only: A flag indicating whether to check eligibility only within the local organization.
17484
- *
17485
- * Returns:
17486
- * - 200: If eligibility information is successfully retrieved.
17487
- * - 400: If required parameters are missing.
17488
- * - 500: If there is an error retrieving eligibility information.
17489
- *
17490
- * Side Effects:
17491
- * - If 'username' is provided instead of 'user_id', the method attempts to resolve the user_id from the username.
17492
- * @returns any No response body
16140
+ * Check whether a user is eligible to enroll in a specific course.
16141
+ * @param courseId Course ID to check eligibility for
16142
+ * @param localOnly Whether to check eligibility only within the local organization
16143
+ * @param org Organization of the course
16144
+ * @param userId User ID to check eligibility for
16145
+ * @param username Username to check eligibility for
16146
+ * @returns CourseEligibilityCheckResponse
17493
16147
  * @throws ApiError
17494
16148
  */
17495
- static catalogEligibilityCoursesCheckRetrieve() {
16149
+ static catalogEligibilityCoursesCheckRetrieve(courseId, localOnly, org, userId, username) {
17496
16150
  return request(OpenAPI, {
17497
16151
  method: 'GET',
17498
- url: '/api/catalog/eligibility/courses/check/'
16152
+ url: '/api/catalog/eligibility/courses/check/',
16153
+ query: {
16154
+ 'course_id': courseId,
16155
+ 'local_only': localOnly,
16156
+ 'org': org,
16157
+ 'user_id': userId,
16158
+ 'username': username
16159
+ },
16160
+ errors: {
16161
+ 400: `No response body`,
16162
+ 500: `No response body`
16163
+ }
17499
16164
  });
17500
16165
  }
17501
16166
  /**
@@ -17558,51 +16223,152 @@ class CatalogService {
17558
16223
  * - Users can view their own enrollments
17559
16224
  * - Platform admins can view enrollments for users in their platform
17560
16225
  * - DM admins can view all enrollments
17561
- * @returns any No response body
16226
+ * @param courseId Filter enrollments by course ID
16227
+ * @param courseName Filter enrollments by course name (partial match)
16228
+ * @param email Filter enrollments by user email
16229
+ * @param includeDefaultPlatform Include enrollments from default platform
16230
+ * @param org Filter enrollments by organization
16231
+ * @param page Page number for pagination
16232
+ * @param pageSize Number of items per page
16233
+ * @param platformKey Filter enrollments by platform key
16234
+ * @param slug Filter enrollments by course slug
16235
+ * @param sort Field to sort results by
16236
+ * @param userId Filter enrollments by user ID
16237
+ * @param username Filter enrollments by username
16238
+ * @returns CourseEnrollmentSearchResponse
17562
16239
  * @throws ApiError
17563
16240
  */
17564
- static catalogEnrollmentCoursesSearchRetrieve() {
16241
+ static catalogEnrollmentCoursesSearchRetrieve(courseId, courseName, email, includeDefaultPlatform, org, page, pageSize, platformKey, slug, sort = '-id', userId, username) {
17565
16242
  return request(OpenAPI, {
17566
16243
  method: 'GET',
17567
- url: '/api/catalog/enrollment/courses/search/'
16244
+ url: '/api/catalog/enrollment/courses/search/',
16245
+ query: {
16246
+ 'course_id': courseId,
16247
+ 'course_name': courseName,
16248
+ 'email': email,
16249
+ 'include_default_platform': includeDefaultPlatform,
16250
+ 'org': org,
16251
+ 'page': page,
16252
+ 'page_size': pageSize,
16253
+ 'platform_key': platformKey,
16254
+ 'slug': slug,
16255
+ 'sort': sort,
16256
+ 'user_id': userId,
16257
+ 'username': username
16258
+ }
17568
16259
  });
17569
16260
  }
17570
16261
  /**
17571
16262
  * Search pathway enrollments. Requires user_id or username and pathway_id or slug.
17572
- * @returns any No response body
16263
+ * @param active Whether the enrollment should be active
16264
+ * @param includeDefaultPlatform Include enrollments from default platform
16265
+ * @param includeMetadata Include metadata in the response
16266
+ * @param org Organization for the pathway
16267
+ * @param pathwayId Pathway ID for enrollment
16268
+ * @param pathwayKey Pathway key for enrollment
16269
+ * @param pathwayUuid Pathway UUID for enrollment
16270
+ * @param platformKey Platform key for the pathway
16271
+ * @param slug Pathway slug for enrollment
16272
+ * @param userId User ID for enrollment
16273
+ * @param username Username for enrollment
16274
+ * @returns PathwayEnrollmentPlus
17573
16275
  * @throws ApiError
17574
16276
  */
17575
- static catalogEnrollmentPathwaysRetrieve() {
16277
+ static catalogEnrollmentPathwaysRetrieve(active = true, includeDefaultPlatform, includeMetadata = true, org, pathwayId, pathwayKey, pathwayUuid, platformKey, slug, userId, username) {
17576
16278
  return request(OpenAPI, {
17577
16279
  method: 'GET',
17578
- url: '/api/catalog/enrollment/pathways/'
16280
+ url: '/api/catalog/enrollment/pathways/',
16281
+ query: {
16282
+ 'active': active,
16283
+ 'include_default_platform': includeDefaultPlatform,
16284
+ 'include_metadata': includeMetadata,
16285
+ 'org': org,
16286
+ 'pathway_id': pathwayId,
16287
+ 'pathway_key': pathwayKey,
16288
+ 'pathway_uuid': pathwayUuid,
16289
+ 'platform_key': platformKey,
16290
+ 'slug': slug,
16291
+ 'user_id': userId,
16292
+ 'username': username
16293
+ }
17579
16294
  });
17580
16295
  }
17581
16296
  /**
17582
16297
  * Log user enrollment with a pathway.
17583
- * @returns any No response body
16298
+ * @param active Whether the enrollment should be active
16299
+ * @param includeDefaultPlatform Include enrollments from default platform
16300
+ * @param includeMetadata Include metadata in the response
16301
+ * @param org Organization for the pathway
16302
+ * @param pathwayId Pathway ID for enrollment
16303
+ * @param pathwayKey Pathway key for enrollment
16304
+ * @param pathwayUuid Pathway UUID for enrollment
16305
+ * @param platformKey Platform key for the pathway
16306
+ * @param slug Pathway slug for enrollment
16307
+ * @param userId User ID for enrollment
16308
+ * @param username Username for enrollment
16309
+ * @param requestBody
16310
+ * @returns PathwayEnrollment
17584
16311
  * @throws ApiError
17585
16312
  */
17586
- static catalogEnrollmentPathwaysCreate() {
16313
+ static catalogEnrollmentPathwaysCreate(active = true, includeDefaultPlatform, includeMetadata = true, org, pathwayId, pathwayKey, pathwayUuid, platformKey, slug, userId, username, requestBody) {
17587
16314
  return request(OpenAPI, {
17588
16315
  method: 'POST',
17589
- url: '/api/catalog/enrollment/pathways/'
16316
+ url: '/api/catalog/enrollment/pathways/',
16317
+ query: {
16318
+ 'active': active,
16319
+ 'include_default_platform': includeDefaultPlatform,
16320
+ 'include_metadata': includeMetadata,
16321
+ 'org': org,
16322
+ 'pathway_id': pathwayId,
16323
+ 'pathway_key': pathwayKey,
16324
+ 'pathway_uuid': pathwayUuid,
16325
+ 'platform_key': platformKey,
16326
+ 'slug': slug,
16327
+ 'user_id': userId,
16328
+ 'username': username
16329
+ },
16330
+ body: requestBody,
16331
+ mediaType: 'application/json'
17590
16332
  });
17591
16333
  }
17592
16334
  /**
17593
16335
  * Unenroll from a pathway. Deactivates enrollment.
17594
- * @returns void
17595
- * @throws ApiError
17596
- */
17597
- static catalogEnrollmentPathwaysDestroy() {
16336
+ * @param active Whether the enrollment should be active
16337
+ * @param includeDefaultPlatform Include enrollments from default platform
16338
+ * @param includeMetadata Include metadata in the response
16339
+ * @param org Organization for the pathway
16340
+ * @param pathwayId Pathway ID for enrollment
16341
+ * @param pathwayKey Pathway key for enrollment
16342
+ * @param pathwayUuid Pathway UUID for enrollment
16343
+ * @param platformKey Platform key for the pathway
16344
+ * @param slug Pathway slug for enrollment
16345
+ * @param userId User ID for enrollment
16346
+ * @param username Username for enrollment
16347
+ * @returns PathwayEnrollment
16348
+ * @throws ApiError
16349
+ */
16350
+ static catalogEnrollmentPathwaysDestroy(active = true, includeDefaultPlatform, includeMetadata = true, org, pathwayId, pathwayKey, pathwayUuid, platformKey, slug, userId, username) {
17598
16351
  return request(OpenAPI, {
17599
16352
  method: 'DELETE',
17600
- url: '/api/catalog/enrollment/pathways/'
16353
+ url: '/api/catalog/enrollment/pathways/',
16354
+ query: {
16355
+ 'active': active,
16356
+ 'include_default_platform': includeDefaultPlatform,
16357
+ 'include_metadata': includeMetadata,
16358
+ 'org': org,
16359
+ 'pathway_id': pathwayId,
16360
+ 'pathway_key': pathwayKey,
16361
+ 'pathway_uuid': pathwayUuid,
16362
+ 'platform_key': platformKey,
16363
+ 'slug': slug,
16364
+ 'user_id': userId,
16365
+ 'username': username
16366
+ }
17601
16367
  });
17602
16368
  }
17603
16369
  /**
17604
16370
  * Search pathway enrollments based on user or pathway identifiers. Returns paginated enrollment results.
17605
- * @returns any No response body
16371
+ * @returns PathwayEnrollmentPlus
17606
16372
  * @throws ApiError
17607
16373
  */
17608
16374
  static catalogEnrollmentPathwaysSearchRetrieve() {
@@ -17613,112 +16379,329 @@ class CatalogService {
17613
16379
  }
17614
16380
  /**
17615
16381
  * Log user enrollment with a pathway.
17616
- * @returns any No response body
16382
+ * @param active Whether the enrollment should be active
16383
+ * @param org Organization for the pathway
16384
+ * @param pathwayId Pathway ID for self-enrollment
16385
+ * @param pathwayKey Pathway key for self-enrollment
16386
+ * @param platformKey Platform key for the pathway
16387
+ * @param slug Pathway slug for self-enrollment
16388
+ * @param userId User ID for self-enrollment
16389
+ * @param username Username for self-enrollment
16390
+ * @param requestBody
16391
+ * @returns PathwayEnrollment
17617
16392
  * @throws ApiError
17618
16393
  */
17619
- static catalogEnrollmentPathwaysSelfCreate() {
16394
+ static catalogEnrollmentPathwaysSelfCreate(active = true, org, pathwayId, pathwayKey, platformKey, slug, userId, username, requestBody) {
17620
16395
  return request(OpenAPI, {
17621
16396
  method: 'POST',
17622
- url: '/api/catalog/enrollment/pathways/self/'
16397
+ url: '/api/catalog/enrollment/pathways/self/',
16398
+ query: {
16399
+ 'active': active,
16400
+ 'org': org,
16401
+ 'pathway_id': pathwayId,
16402
+ 'pathway_key': pathwayKey,
16403
+ 'platform_key': platformKey,
16404
+ 'slug': slug,
16405
+ 'user_id': userId,
16406
+ 'username': username
16407
+ },
16408
+ body: requestBody,
16409
+ mediaType: 'application/json'
17623
16410
  });
17624
16411
  }
17625
16412
  /**
17626
16413
  * Unenroll from a pathway. Deactivates enrollment.
17627
- * @returns void
16414
+ * @param active Whether the enrollment should be active
16415
+ * @param org Organization for the pathway
16416
+ * @param pathwayId Pathway ID for self-enrollment
16417
+ * @param pathwayKey Pathway key for self-enrollment
16418
+ * @param platformKey Platform key for the pathway
16419
+ * @param slug Pathway slug for self-enrollment
16420
+ * @param userId User ID for self-enrollment
16421
+ * @param username Username for self-enrollment
16422
+ * @returns PathwayEnrollment
17628
16423
  * @throws ApiError
17629
16424
  */
17630
- static catalogEnrollmentPathwaysSelfDestroy() {
16425
+ static catalogEnrollmentPathwaysSelfDestroy(active = true, org, pathwayId, pathwayKey, platformKey, slug, userId, username) {
17631
16426
  return request(OpenAPI, {
17632
16427
  method: 'DELETE',
17633
- url: '/api/catalog/enrollment/pathways/self/'
16428
+ url: '/api/catalog/enrollment/pathways/self/',
16429
+ query: {
16430
+ 'active': active,
16431
+ 'org': org,
16432
+ 'pathway_id': pathwayId,
16433
+ 'pathway_key': pathwayKey,
16434
+ 'platform_key': platformKey,
16435
+ 'slug': slug,
16436
+ 'user_id': userId,
16437
+ 'username': username
16438
+ }
17634
16439
  });
17635
16440
  }
17636
16441
  /**
17637
16442
  * Search program enrollments. Requires user_id or username and program_id or slug.
17638
- * @returns any No response body
16443
+ * @param active Whether the enrollment should be active
16444
+ * @param expired Date when enrollment expires
16445
+ * @param ignoreExpiration Whether to ignore expiration during unenrollment
16446
+ * @param includeDefaultPlatform Include enrollments from default platform
16447
+ * @param includeMetadata Include metadata in the response
16448
+ * @param org Organization for the program
16449
+ * @param platformKey Platform key for the program
16450
+ * @param programId Program ID for enrollment
16451
+ * @param programKey Program key for enrollment
16452
+ * @param programType Program type (standard, platform, custom)
16453
+ * @param slug Program slug for enrollment
16454
+ * @param started Date when enrollment started
16455
+ * @param userId User ID for enrollment
16456
+ * @param username Username for enrollment
16457
+ * @returns ProgramEnrollmentPlus
17639
16458
  * @throws ApiError
17640
16459
  */
17641
- static catalogEnrollmentProgramsRetrieve() {
16460
+ static catalogEnrollmentProgramsRetrieve(active = true, expired, ignoreExpiration = false, includeDefaultPlatform, includeMetadata = true, org, platformKey, programId, programKey, programType, slug, started, userId, username) {
17642
16461
  return request(OpenAPI, {
17643
16462
  method: 'GET',
17644
- url: '/api/catalog/enrollment/programs/'
16463
+ url: '/api/catalog/enrollment/programs/',
16464
+ query: {
16465
+ 'active': active,
16466
+ 'expired': expired,
16467
+ 'ignore_expiration': ignoreExpiration,
16468
+ 'include_default_platform': includeDefaultPlatform,
16469
+ 'include_metadata': includeMetadata,
16470
+ 'org': org,
16471
+ 'platform_key': platformKey,
16472
+ 'program_id': programId,
16473
+ 'program_key': programKey,
16474
+ 'program_type': programType,
16475
+ 'slug': slug,
16476
+ 'started': started,
16477
+ 'user_id': userId,
16478
+ 'username': username
16479
+ }
17645
16480
  });
17646
16481
  }
17647
16482
  /**
17648
16483
  * Log user enrollment with a program.
17649
- * @returns any No response body
16484
+ * @param active Whether the enrollment should be active
16485
+ * @param expired Date when enrollment expires
16486
+ * @param ignoreExpiration Whether to ignore expiration during unenrollment
16487
+ * @param includeDefaultPlatform Include enrollments from default platform
16488
+ * @param includeMetadata Include metadata in the response
16489
+ * @param org Organization for the program
16490
+ * @param platformKey Platform key for the program
16491
+ * @param programId Program ID for enrollment
16492
+ * @param programKey Program key for enrollment
16493
+ * @param programType Program type (standard, platform, custom)
16494
+ * @param slug Program slug for enrollment
16495
+ * @param started Date when enrollment started
16496
+ * @param userId User ID for enrollment
16497
+ * @param username Username for enrollment
16498
+ * @param requestBody
16499
+ * @returns ProgramEnrollment
17650
16500
  * @throws ApiError
17651
16501
  */
17652
- static catalogEnrollmentProgramsCreate() {
16502
+ static catalogEnrollmentProgramsCreate(active = true, expired, ignoreExpiration = false, includeDefaultPlatform, includeMetadata = true, org, platformKey, programId, programKey, programType, slug, started, userId, username, requestBody) {
17653
16503
  return request(OpenAPI, {
17654
16504
  method: 'POST',
17655
- url: '/api/catalog/enrollment/programs/'
16505
+ url: '/api/catalog/enrollment/programs/',
16506
+ query: {
16507
+ 'active': active,
16508
+ 'expired': expired,
16509
+ 'ignore_expiration': ignoreExpiration,
16510
+ 'include_default_platform': includeDefaultPlatform,
16511
+ 'include_metadata': includeMetadata,
16512
+ 'org': org,
16513
+ 'platform_key': platformKey,
16514
+ 'program_id': programId,
16515
+ 'program_key': programKey,
16516
+ 'program_type': programType,
16517
+ 'slug': slug,
16518
+ 'started': started,
16519
+ 'user_id': userId,
16520
+ 'username': username
16521
+ },
16522
+ body: requestBody,
16523
+ mediaType: 'application/json'
17656
16524
  });
17657
16525
  }
17658
16526
  /**
17659
16527
  * Unenroll from a program. Deactivates enrollment.
17660
- * @returns void
17661
- * @throws ApiError
17662
- */
17663
- static catalogEnrollmentProgramsDestroy() {
16528
+ * @param active Whether the enrollment should be active
16529
+ * @param expired Date when enrollment expires
16530
+ * @param ignoreExpiration Whether to ignore expiration during unenrollment
16531
+ * @param includeDefaultPlatform Include enrollments from default platform
16532
+ * @param includeMetadata Include metadata in the response
16533
+ * @param org Organization for the program
16534
+ * @param platformKey Platform key for the program
16535
+ * @param programId Program ID for enrollment
16536
+ * @param programKey Program key for enrollment
16537
+ * @param programType Program type (standard, platform, custom)
16538
+ * @param slug Program slug for enrollment
16539
+ * @param started Date when enrollment started
16540
+ * @param userId User ID for enrollment
16541
+ * @param username Username for enrollment
16542
+ * @returns ProgramEnrollment
16543
+ * @throws ApiError
16544
+ */
16545
+ static catalogEnrollmentProgramsDestroy(active = true, expired, ignoreExpiration = false, includeDefaultPlatform, includeMetadata = true, org, platformKey, programId, programKey, programType, slug, started, userId, username) {
17664
16546
  return request(OpenAPI, {
17665
16547
  method: 'DELETE',
17666
- url: '/api/catalog/enrollment/programs/'
16548
+ url: '/api/catalog/enrollment/programs/',
16549
+ query: {
16550
+ 'active': active,
16551
+ 'expired': expired,
16552
+ 'ignore_expiration': ignoreExpiration,
16553
+ 'include_default_platform': includeDefaultPlatform,
16554
+ 'include_metadata': includeMetadata,
16555
+ 'org': org,
16556
+ 'platform_key': platformKey,
16557
+ 'program_id': programId,
16558
+ 'program_key': programKey,
16559
+ 'program_type': programType,
16560
+ 'slug': slug,
16561
+ 'started': started,
16562
+ 'user_id': userId,
16563
+ 'username': username
16564
+ }
17667
16565
  });
17668
16566
  }
17669
16567
  /**
17670
16568
  * Search program enrollments based on user or program identifiers. Returns paginated enrollment results.
17671
- * @returns any No response body
16569
+ * @param includeDefaultPlatform Include enrollments from default platform
16570
+ * @param org Filter enrollments by organization
16571
+ * @param page Page number for pagination
16572
+ * @param pageSize Number of items per page
16573
+ * @param platformKey Filter enrollments by platform key
16574
+ * @param programId Filter enrollments by program ID
16575
+ * @param programType Filter by program type (standard, platform, custom)
16576
+ * @param slug Filter enrollments by program slug
16577
+ * @param sort Field to sort results by
16578
+ * @param userId Filter enrollments by user ID
16579
+ * @param username Filter enrollments by username
16580
+ * @returns ProgramEnrollmentPlus
17672
16581
  * @throws ApiError
17673
16582
  */
17674
- static catalogEnrollmentProgramsSearchRetrieve() {
16583
+ static catalogEnrollmentProgramsSearchRetrieve(includeDefaultPlatform, org, page, pageSize, platformKey, programId, programType, slug, sort = '-id', userId, username) {
17675
16584
  return request(OpenAPI, {
17676
16585
  method: 'GET',
17677
- url: '/api/catalog/enrollment/programs/search/'
16586
+ url: '/api/catalog/enrollment/programs/search/',
16587
+ query: {
16588
+ 'include_default_platform': includeDefaultPlatform,
16589
+ 'org': org,
16590
+ 'page': page,
16591
+ 'page_size': pageSize,
16592
+ 'platform_key': platformKey,
16593
+ 'program_id': programId,
16594
+ 'program_type': programType,
16595
+ 'slug': slug,
16596
+ 'sort': sort,
16597
+ 'user_id': userId,
16598
+ 'username': username
16599
+ }
17678
16600
  });
17679
16601
  }
17680
16602
  /**
17681
16603
  * Log user enrollment with a program.
17682
- * @returns any No response body
16604
+ * @param active Whether the enrollment should be active
16605
+ * @param expired Date when enrollment expires
16606
+ * @param ignoreExpiration Whether to ignore expiration during unenrollment
16607
+ * @param org Organization for the program
16608
+ * @param platformKey Platform key for the program
16609
+ * @param programId Program ID for self-enrollment
16610
+ * @param programKey Program key for self-enrollment
16611
+ * @param slug Program slug for self-enrollment
16612
+ * @param started Date when enrollment started
16613
+ * @param userId User ID for self-enrollment
16614
+ * @param username Username for self-enrollment
16615
+ * @param requestBody
16616
+ * @returns ProgramEnrollment
17683
16617
  * @throws ApiError
17684
16618
  */
17685
- static catalogEnrollmentProgramsSelfCreate() {
16619
+ static catalogEnrollmentProgramsSelfCreate(active = true, expired, ignoreExpiration = false, org, platformKey, programId, programKey, slug, started, userId, username, requestBody) {
17686
16620
  return request(OpenAPI, {
17687
16621
  method: 'POST',
17688
- url: '/api/catalog/enrollment/programs/self/'
16622
+ url: '/api/catalog/enrollment/programs/self/',
16623
+ query: {
16624
+ 'active': active,
16625
+ 'expired': expired,
16626
+ 'ignore_expiration': ignoreExpiration,
16627
+ 'org': org,
16628
+ 'platform_key': platformKey,
16629
+ 'program_id': programId,
16630
+ 'program_key': programKey,
16631
+ 'slug': slug,
16632
+ 'started': started,
16633
+ 'user_id': userId,
16634
+ 'username': username
16635
+ },
16636
+ body: requestBody,
16637
+ mediaType: 'application/json'
17689
16638
  });
17690
16639
  }
17691
16640
  /**
17692
16641
  * Unenroll from a program. Deactivates enrollment.
16642
+ * @param active Whether the enrollment should be active
16643
+ * @param expired Date when enrollment expires
16644
+ * @param ignoreExpiration Whether to ignore expiration during unenrollment
16645
+ * @param org Organization for the program
16646
+ * @param platformKey Platform key for the program
16647
+ * @param programId Program ID for self-enrollment
16648
+ * @param programKey Program key for self-enrollment
16649
+ * @param slug Program slug for self-enrollment
16650
+ * @param started Date when enrollment started
16651
+ * @param userId User ID for self-enrollment
16652
+ * @param username Username for self-enrollment
17693
16653
  * @returns void
17694
16654
  * @throws ApiError
17695
16655
  */
17696
- static catalogEnrollmentProgramsSelfDestroy() {
16656
+ static catalogEnrollmentProgramsSelfDestroy(active = true, expired, ignoreExpiration = false, org, platformKey, programId, programKey, slug, started, userId, username) {
17697
16657
  return request(OpenAPI, {
17698
16658
  method: 'DELETE',
17699
- url: '/api/catalog/enrollment/programs/self/'
16659
+ url: '/api/catalog/enrollment/programs/self/',
16660
+ query: {
16661
+ 'active': active,
16662
+ 'expired': expired,
16663
+ 'ignore_expiration': ignoreExpiration,
16664
+ 'org': org,
16665
+ 'platform_key': platformKey,
16666
+ 'program_id': programId,
16667
+ 'program_key': programKey,
16668
+ 'slug': slug,
16669
+ 'started': started,
16670
+ 'user_id': userId,
16671
+ 'username': username
16672
+ }
17700
16673
  });
17701
16674
  }
17702
16675
  /**
17703
16676
  * Retrieve auto increment information for a specific platform.
17704
- * @returns any No response body
16677
+ * @returns CatalogAutoIncrementResponse
17705
16678
  * @throws ApiError
17706
16679
  */
17707
16680
  static catalogIncrementRetrieve() {
17708
16681
  return request(OpenAPI, {
17709
16682
  method: 'GET',
17710
- url: '/api/catalog/increment/'
16683
+ url: '/api/catalog/increment/',
16684
+ errors: {
16685
+ 404: `No response body`
16686
+ }
17711
16687
  });
17712
16688
  }
17713
16689
  /**
17714
16690
  * Update auto increment information and retrieve a new ID for a specific platform.
17715
- * @returns any No response body
16691
+ * @param requestBody
16692
+ * @returns any
17716
16693
  * @throws ApiError
17717
16694
  */
17718
- static catalogIncrementCreate() {
16695
+ static catalogIncrementCreate(requestBody) {
17719
16696
  return request(OpenAPI, {
17720
16697
  method: 'POST',
17721
- url: '/api/catalog/increment/'
16698
+ url: '/api/catalog/increment/',
16699
+ body: requestBody,
16700
+ mediaType: 'application/json',
16701
+ errors: {
16702
+ 400: `No response body`,
16703
+ 500: `No response body`
16704
+ }
17722
16705
  });
17723
16706
  }
17724
16707
  /**
@@ -21212,199 +20195,170 @@ class CatalogService {
21212
20195
  }
21213
20196
  /**
21214
20197
  * Query metadata choices based on field_key, scope, and org parameters.
20198
+ * @param fieldKey The key of the field for which choices are being queried
20199
+ * @param org The organization context for the metadata choices
20200
+ * @param scope The scope within which to query the metadata choices (course, program, pathway, resource)
21215
20201
  * @returns any No response body
21216
20202
  * @throws ApiError
21217
20203
  */
21218
- static catalogMetadataChoicesRetrieve() {
20204
+ static catalogMetadataChoicesRetrieve(fieldKey, org, scope) {
21219
20205
  return request(OpenAPI, {
21220
20206
  method: 'GET',
21221
- url: '/api/catalog/metadata/choices/'
20207
+ url: '/api/catalog/metadata/choices/',
20208
+ query: {
20209
+ 'field_key': fieldKey,
20210
+ 'org': org,
20211
+ 'scope': scope
20212
+ }
21222
20213
  });
21223
20214
  }
21224
20215
  /**
21225
- * GET
21226
- * Query course metadata
21227
- *
21228
- * This method retrieves metadata for a specified course. The course_id must be provided
21229
- * as a query parameter. If the course is not found, a 400 status code is returned.
21230
- * If the metadata retrieval fails, a 404 status code is returned. On successful retrieval,
21231
- * the metadata is returned with a 200 status code.
21232
- *
21233
- * Params:
21234
- * course_id: The ID of the course for which metadata is being queried.
20216
+ * Retrieve metadata for a course.
20217
+ * @param courseId The course ID to get metadata for
21235
20218
  * @returns any No response body
21236
20219
  * @throws ApiError
21237
20220
  */
21238
- static catalogMetadataCourseRetrieve() {
20221
+ static catalogMetadataCourseRetrieve(courseId) {
21239
20222
  return request(OpenAPI, {
21240
20223
  method: 'GET',
21241
- url: '/api/catalog/metadata/course/'
20224
+ url: '/api/catalog/metadata/course/',
20225
+ query: {
20226
+ 'course_id': courseId
20227
+ },
20228
+ errors: {
20229
+ 400: `No response body`,
20230
+ 404: `No response body`
20231
+ }
21242
20232
  });
21243
20233
  }
21244
20234
  /**
21245
- * POST
21246
- * Update course metadata
21247
- *
21248
- * This method updates the metadata for a specified course. The course_id and metadata
21249
- * must be provided in the request data. An optional 'update' parameter can be provided
21250
- * to specify whether to overwrite existing metadata. If the course is not found, a 400
21251
- * status code is returned. If the field parameter is provided, a 404 status code is returned
21252
- * as field updates are not supported. On successful update, the updated metadata is returned
21253
- * with a 200 status code. If the update fails, a 400 status code is returned.
21254
- *
21255
- * Params:
21256
- * course_id: The ID of the course for which metadata is being updated.
21257
- * metadata: The new metadata to update the course with.
21258
- * update (optional): A boolean indicating whether to overwrite existing metadata.
20235
+ * Update metadata for a course.
20236
+ * @param courseId The course ID to get metadata for
20237
+ * @param requestBody
21259
20238
  * @returns any No response body
21260
20239
  * @throws ApiError
21261
20240
  */
21262
- static catalogMetadataCourseCreate() {
20241
+ static catalogMetadataCourseCreate(courseId, requestBody) {
21263
20242
  return request(OpenAPI, {
21264
20243
  method: 'POST',
21265
- url: '/api/catalog/metadata/course/'
20244
+ url: '/api/catalog/metadata/course/',
20245
+ query: {
20246
+ 'course_id': courseId
20247
+ },
20248
+ body: requestBody,
20249
+ mediaType: 'application/json',
20250
+ errors: {
20251
+ 400: `No response body`,
20252
+ 404: `No response body`
20253
+ }
21266
20254
  });
21267
20255
  }
21268
20256
  /**
21269
- * GET
21270
- * Query public course metadata.
21271
- *
21272
- * This method retrieves and returns the public metadata for a specified course.
21273
- * It requires a 'course_id' parameter to identify the course for which metadata is requested.
21274
- *
21275
- * CAUTION: Does not factor in course visibility.
21276
- *
21277
- * Params:
21278
- * course_id: The unique identifier for the course whose metadata is being queried.
21279
- *
21280
- * Returns:
21281
- * - 200: Successfully retrieved the course metadata.
21282
- * - 400: The course ID provided does not correspond to any existing course.
21283
- * - 404: Metadata retrieval failed for the specified course.
21284
- *
21285
- * Side Effects:
21286
- * - Logs debug information if the course is not found or if metadata retrieval fails.
20257
+ * Retrieve public metadata for a course.
20258
+ * @param courseId The course ID to get metadata for
21287
20259
  * @returns any No response body
21288
20260
  * @throws ApiError
21289
20261
  */
21290
- static catalogMetadataCoursePublicRetrieve() {
20262
+ static catalogMetadataCoursePublicRetrieve(courseId) {
21291
20263
  return request(OpenAPI, {
21292
20264
  method: 'GET',
21293
- url: '/api/catalog/metadata/course-public/'
20265
+ url: '/api/catalog/metadata/course-public/',
20266
+ query: {
20267
+ 'course_id': courseId
20268
+ },
20269
+ errors: {
20270
+ 400: `No response body`,
20271
+ 404: `No response body`
20272
+ }
21294
20273
  });
21295
20274
  }
21296
20275
  /**
21297
- * GET
21298
- * Query public course metadata.
21299
- *
21300
- * This method retrieves and returns the public metadata for a specified course.
21301
- * It requires a 'course_id' parameter to identify the course for which metadata is requested.
21302
- *
21303
- * CAUTION: Does not factor in course visibility.
21304
- *
21305
- * Params:
21306
- * course_id: The unique identifier for the course whose metadata is being queried.
21307
- *
21308
- * Returns:
21309
- * - 200: Successfully retrieved the course metadata.
21310
- * - 400: The course ID provided does not correspond to any existing course.
21311
- * - 404: Metadata retrieval failed for the specified course.
21312
- *
21313
- * Side Effects:
21314
- * - Logs debug information if the course is not found or if metadata retrieval fails.
20276
+ * Retrieve public metadata for a course.
20277
+ * @param courseId The course ID to get metadata for
21315
20278
  * @param field
21316
20279
  * @returns any No response body
21317
20280
  * @throws ApiError
21318
20281
  */
21319
- static catalogMetadataCoursePublicRetrieve2(field) {
20282
+ static catalogMetadataCoursePublicRetrieve2(courseId, field) {
21320
20283
  return request(OpenAPI, {
21321
20284
  method: 'GET',
21322
20285
  url: '/api/catalog/metadata/course-public/{field}/',
21323
20286
  path: {
21324
20287
  'field': field
20288
+ },
20289
+ query: {
20290
+ 'course_id': courseId
20291
+ },
20292
+ errors: {
20293
+ 400: `No response body`,
20294
+ 404: `No response body`
21325
20295
  }
21326
20296
  });
21327
20297
  }
21328
20298
  /**
21329
- * POST
21330
- * Query course metadata
21331
- *
21332
- * Return course info for courses matching course query
21333
- *
21334
- * Params:
21335
- * <filters>
21336
- *
21337
- * This method accepts a set of filters in the request body to query the course metadata.
21338
- * It returns a list of courses that match the provided filters.
21339
- *
21340
- * Error Conditions:
21341
- * - Returns a 400 status code if the search filters are empty or invalid.
21342
- * - Returns a 500 status code if an unexpected error occurs during the query process.
21343
- *
21344
- * Side Effects:
21345
- * - Logs an error if the search filters are empty.
21346
- * - Logs an exception if the filters are invalid or if an unexpected error occurs.
21347
- *
21348
- * Special Return Codes:
21349
- * - A 200 status code indicates successful retrieval of course metadata.
21350
- * @returns any No response body
20299
+ * Search for courses matching specified metadata filters.
20300
+ * @param requestBody
20301
+ * @returns any
21351
20302
  * @throws ApiError
21352
20303
  */
21353
- static catalogMetadataCourseSearchCreate() {
20304
+ static catalogMetadataCourseSearchCreate(requestBody) {
21354
20305
  return request(OpenAPI, {
21355
20306
  method: 'POST',
21356
- url: '/api/catalog/metadata/course-search/'
20307
+ url: '/api/catalog/metadata/course-search/',
20308
+ body: requestBody,
20309
+ mediaType: 'application/json',
20310
+ errors: {
20311
+ 400: `No response body`,
20312
+ 500: `No response body`
20313
+ }
21357
20314
  });
21358
20315
  }
21359
20316
  /**
21360
- * GET
21361
- * Query course metadata
21362
- *
21363
- * This method retrieves metadata for a specified course. The course_id must be provided
21364
- * as a query parameter. If the course is not found, a 400 status code is returned.
21365
- * If the metadata retrieval fails, a 404 status code is returned. On successful retrieval,
21366
- * the metadata is returned with a 200 status code.
21367
- *
21368
- * Params:
21369
- * course_id: The ID of the course for which metadata is being queried.
20317
+ * Retrieve metadata for a course.
20318
+ * @param courseId The course ID to get metadata for
21370
20319
  * @param field
21371
20320
  * @returns any No response body
21372
20321
  * @throws ApiError
21373
20322
  */
21374
- static catalogMetadataCourseRetrieve2(field) {
20323
+ static catalogMetadataCourseRetrieve2(courseId, field) {
21375
20324
  return request(OpenAPI, {
21376
20325
  method: 'GET',
21377
20326
  url: '/api/catalog/metadata/course/{field}/',
21378
20327
  path: {
21379
20328
  'field': field
20329
+ },
20330
+ query: {
20331
+ 'course_id': courseId
20332
+ },
20333
+ errors: {
20334
+ 400: `No response body`,
20335
+ 404: `No response body`
21380
20336
  }
21381
20337
  });
21382
20338
  }
21383
20339
  /**
21384
- * POST
21385
- * Update course metadata
21386
- *
21387
- * This method updates the metadata for a specified course. The course_id and metadata
21388
- * must be provided in the request data. An optional 'update' parameter can be provided
21389
- * to specify whether to overwrite existing metadata. If the course is not found, a 400
21390
- * status code is returned. If the field parameter is provided, a 404 status code is returned
21391
- * as field updates are not supported. On successful update, the updated metadata is returned
21392
- * with a 200 status code. If the update fails, a 400 status code is returned.
21393
- *
21394
- * Params:
21395
- * course_id: The ID of the course for which metadata is being updated.
21396
- * metadata: The new metadata to update the course with.
21397
- * update (optional): A boolean indicating whether to overwrite existing metadata.
20340
+ * Update metadata for a course.
20341
+ * @param courseId The course ID to get metadata for
21398
20342
  * @param field
20343
+ * @param requestBody
21399
20344
  * @returns any No response body
21400
20345
  * @throws ApiError
21401
20346
  */
21402
- static catalogMetadataCourseCreate2(field) {
20347
+ static catalogMetadataCourseCreate2(courseId, field, requestBody) {
21403
20348
  return request(OpenAPI, {
21404
20349
  method: 'POST',
21405
20350
  url: '/api/catalog/metadata/course/{field}/',
21406
20351
  path: {
21407
20352
  'field': field
20353
+ },
20354
+ query: {
20355
+ 'course_id': courseId
20356
+ },
20357
+ body: requestBody,
20358
+ mediaType: 'application/json',
20359
+ errors: {
20360
+ 400: `No response body`,
20361
+ 404: `No response body`
21408
20362
  }
21409
20363
  });
21410
20364
  }
@@ -22016,10 +20970,10 @@ class CatalogService {
22016
20970
  }
22017
20971
  /**
22018
20972
  * Retrieve pathways matching query. Limited parameters.
22019
- * @returns any No response body
20973
+ * @returns Pathway
22020
20974
  * @throws ApiError
22021
20975
  */
22022
- static catalogPathwaysRetrieve() {
20976
+ static catalogPathwaysList() {
22023
20977
  return request(OpenAPI, {
22024
20978
  method: 'GET',
22025
20979
  url: '/api/catalog/pathways/'
@@ -22027,32 +20981,41 @@ class CatalogService {
22027
20981
  }
22028
20982
  /**
22029
20983
  * Add or update a pathway.
22030
- * @returns any No response body
20984
+ * @param requestBody
20985
+ * @returns Pathway
22031
20986
  * @throws ApiError
22032
20987
  */
22033
- static catalogPathwaysCreate() {
20988
+ static catalogPathwaysCreate(requestBody) {
22034
20989
  return request(OpenAPI, {
22035
20990
  method: 'POST',
22036
- url: '/api/catalog/pathways/'
20991
+ url: '/api/catalog/pathways/',
20992
+ body: requestBody,
20993
+ mediaType: 'application/json',
20994
+ errors: {
20995
+ 400: `No response body`
20996
+ }
22037
20997
  });
22038
20998
  }
22039
20999
  /**
22040
21000
  * Remove a pathway from the database.
22041
- * @returns void
21001
+ * @returns PathwayDeleteResponse
22042
21002
  * @throws ApiError
22043
21003
  */
22044
21004
  static catalogPathwaysDestroy() {
22045
21005
  return request(OpenAPI, {
22046
21006
  method: 'DELETE',
22047
- url: '/api/catalog/pathways/'
21007
+ url: '/api/catalog/pathways/',
21008
+ errors: {
21009
+ 400: `No response body`
21010
+ }
22048
21011
  });
22049
21012
  }
22050
21013
  /**
22051
21014
  * Retrieve programs matching query parameters. Limited parameters include program_id, name, slug, enabled, and org.
22052
- * @returns any No response body
21015
+ * @returns Program
22053
21016
  * @throws ApiError
22054
21017
  */
22055
- static catalogProgramsRetrieve() {
21018
+ static catalogProgramsList() {
22056
21019
  return request(OpenAPI, {
22057
21020
  method: 'GET',
22058
21021
  url: '/api/catalog/programs/'
@@ -22060,24 +21023,33 @@ class CatalogService {
22060
21023
  }
22061
21024
  /**
22062
21025
  * Add or update a program. Accepts a list of courses and updates or creates a program.
22063
- * @returns any No response body
21026
+ * @param requestBody
21027
+ * @returns Program
22064
21028
  * @throws ApiError
22065
21029
  */
22066
- static catalogProgramsCreate() {
21030
+ static catalogProgramsCreate(requestBody) {
22067
21031
  return request(OpenAPI, {
22068
21032
  method: 'POST',
22069
- url: '/api/catalog/programs/'
21033
+ url: '/api/catalog/programs/',
21034
+ body: requestBody,
21035
+ mediaType: 'application/json',
21036
+ errors: {
21037
+ 400: `No response body`
21038
+ }
22070
21039
  });
22071
21040
  }
22072
21041
  /**
22073
21042
  * Remove a program from the database. Requires program_id and org as parameters.
22074
- * @returns void
21043
+ * @returns ProgramDeleteResponse
22075
21044
  * @throws ApiError
22076
21045
  */
22077
21046
  static catalogProgramsDestroy() {
22078
21047
  return request(OpenAPI, {
22079
21048
  method: 'DELETE',
22080
- url: '/api/catalog/programs/'
21049
+ url: '/api/catalog/programs/',
21050
+ errors: {
21051
+ 400: `No response body`
21052
+ }
22081
21053
  });
22082
21054
  }
22083
21055
  /**
@@ -22100,89 +21072,124 @@ class CatalogService {
22100
21072
  *
22101
21073
  * Side Effects:
22102
21074
  * - None
22103
- * @returns any No response body
21075
+ * @param courseId Current course ID
21076
+ * @param org Organization to filter recommendations
21077
+ * @param userId User ID for personalized recommendations
21078
+ * @returns Course
22104
21079
  * @throws ApiError
22105
21080
  */
22106
- static catalogRecommendationCoursesRetrieve() {
21081
+ static catalogRecommendationCoursesRetrieve(courseId, org, userId) {
22107
21082
  return request(OpenAPI, {
22108
21083
  method: 'GET',
22109
- url: '/api/catalog/recommendation/courses/'
21084
+ url: '/api/catalog/recommendation/courses/',
21085
+ query: {
21086
+ 'course_id': courseId,
21087
+ 'org': org,
21088
+ 'user_id': userId
21089
+ }
22110
21090
  });
22111
21091
  }
22112
21092
  /**
22113
- * GET
22114
21093
  * Retrieve resources matching query. Limited parameters.
22115
- *
22116
- * Params:
22117
- * id
22118
- *
22119
- * Optional:
22120
- * resource_type
22121
- * item_id
22122
- * name
22123
- * platform_key/key
22124
- * platform_org/org
22125
- *
22126
- * This method retrieves resources based on the provided query parameters.
22127
- * It filters the resources using the allowed parameters and returns a serialized list of resources.
22128
- *
22129
- * Error Conditions:
22130
- * - If no resources match the query, an empty list is returned.
22131
- *
22132
- * Side Effects:
22133
- * - None
22134
- * @returns any No response body
21094
+ * @param id Resource ID
21095
+ * @param itemId Item ID associated with the resource
21096
+ * @param key Platform key
21097
+ * @param name Resource name
21098
+ * @param org Platform organization
21099
+ * @param platformKey Platform key (alternative to key)
21100
+ * @param platformOrg Platform organization (alternative to org)
21101
+ * @param resourceType Type of resource
21102
+ * @param userId User ID who owns the resource
21103
+ * @param username Username who owns the resource
21104
+ * @returns Resource
22135
21105
  * @throws ApiError
22136
21106
  */
22137
- static catalogResourcesRetrieve() {
21107
+ static catalogResourcesList(id, itemId, key, name, org, platformKey, platformOrg, resourceType, userId, username) {
22138
21108
  return request(OpenAPI, {
22139
21109
  method: 'GET',
22140
- url: '/api/catalog/resources/'
21110
+ url: '/api/catalog/resources/',
21111
+ query: {
21112
+ 'id': id,
21113
+ 'item_id': itemId,
21114
+ 'key': key,
21115
+ 'name': name,
21116
+ 'org': org,
21117
+ 'platform_key': platformKey,
21118
+ 'platform_org': platformOrg,
21119
+ 'resource_type': resourceType,
21120
+ 'user_id': userId,
21121
+ 'username': username
21122
+ }
22141
21123
  });
22142
21124
  }
22143
21125
  /**
22144
21126
  * Create or update a resource with optional image upload
22145
21127
  * Create or update a resource. For updates, include the resource ID.
22146
21128
  * @param formData
21129
+ * @param id Resource ID
21130
+ * @param itemId Item ID associated with the resource
21131
+ * @param key Platform key
21132
+ * @param name Resource name
21133
+ * @param org Platform organization
21134
+ * @param platformKey Platform key (alternative to key)
21135
+ * @param platformOrg Platform organization (alternative to org)
21136
+ * @param resourceType Type of resource
21137
+ * @param userId User ID who owns the resource
21138
+ * @param username Username who owns the resource
22147
21139
  * @returns Resource
22148
21140
  * @throws ApiError
22149
21141
  */
22150
- static catalogResourcesCreate(formData) {
21142
+ static catalogResourcesCreate(formData, id, itemId, key, name, org, platformKey, platformOrg, resourceType, userId, username) {
22151
21143
  return request(OpenAPI, {
22152
21144
  method: 'POST',
22153
21145
  url: '/api/catalog/resources/',
21146
+ query: {
21147
+ 'id': id,
21148
+ 'item_id': itemId,
21149
+ 'key': key,
21150
+ 'name': name,
21151
+ 'org': org,
21152
+ 'platform_key': platformKey,
21153
+ 'platform_org': platformOrg,
21154
+ 'resource_type': resourceType,
21155
+ 'user_id': userId,
21156
+ 'username': username
21157
+ },
22154
21158
  formData: formData,
22155
21159
  mediaType: 'multipart/form-data'
22156
21160
  });
22157
21161
  }
22158
21162
  /**
22159
- * DELETE
22160
21163
  * Remove a resource from the database.
22161
- *
22162
- * Params (all required):
22163
- * id
22164
- * user_id or platform_key
22165
- *
22166
- * Return:
22167
- * count
22168
- * type
22169
- *
22170
- * This method deletes a resource from the database based on the provided parameters.
22171
- * It returns the count of deleted resources and their type.
22172
- *
22173
- * Error Conditions:
22174
- * - If required parameters are missing, a 400 status is returned.
22175
- * - If no resources match the query, the count will be zero.
22176
- *
22177
- * Side Effects:
22178
- * - The specified resource is removed from the database.
22179
- * @returns void
21164
+ * @param id Resource ID
21165
+ * @param itemId Item ID associated with the resource
21166
+ * @param key Platform key
21167
+ * @param name Resource name
21168
+ * @param org Platform organization
21169
+ * @param platformKey Platform key (alternative to key)
21170
+ * @param platformOrg Platform organization (alternative to org)
21171
+ * @param resourceType Type of resource
21172
+ * @param userId User ID who owns the resource
21173
+ * @param username Username who owns the resource
21174
+ * @returns ResourceDeleteResponse
22180
21175
  * @throws ApiError
22181
21176
  */
22182
- static catalogResourcesDestroy() {
21177
+ static catalogResourcesDestroy(id, itemId, key, name, org, platformKey, platformOrg, resourceType, userId, username) {
22183
21178
  return request(OpenAPI, {
22184
21179
  method: 'DELETE',
22185
- url: '/api/catalog/resources/'
21180
+ url: '/api/catalog/resources/',
21181
+ query: {
21182
+ 'id': id,
21183
+ 'item_id': itemId,
21184
+ 'key': key,
21185
+ 'name': name,
21186
+ 'org': org,
21187
+ 'platform_key': platformKey,
21188
+ 'platform_org': platformOrg,
21189
+ 'resource_type': resourceType,
21190
+ 'user_id': userId,
21191
+ 'username': username
21192
+ }
22186
21193
  });
22187
21194
  }
22188
21195
  /**
@@ -22246,17 +21253,22 @@ class CatalogService {
22246
21253
  });
22247
21254
  }
22248
21255
  /**
22249
- * Query course review info
22250
- *
22251
- * Params:
22252
- * course_id
22253
- * @returns any No response body
21256
+ * Retrieve aggregate review information for a course.
21257
+ * @param courseId The course ID to get review information for
21258
+ * @returns CourseReviewInfoResponse
22254
21259
  * @throws ApiError
22255
21260
  */
22256
- static catalogReviewsCourseInfoRetrieve() {
21261
+ static catalogReviewsCourseInfoRetrieve(courseId) {
22257
21262
  return request(OpenAPI, {
22258
21263
  method: 'GET',
22259
- url: '/api/catalog/reviews/course/info/'
21264
+ url: '/api/catalog/reviews/course/info/',
21265
+ query: {
21266
+ 'course_id': courseId
21267
+ },
21268
+ errors: {
21269
+ 400: `No response body`,
21270
+ 404: `No response body`
21271
+ }
22260
21272
  });
22261
21273
  }
22262
21274
  /**
@@ -22434,17 +21446,22 @@ class CatalogService {
22434
21446
  });
22435
21447
  }
22436
21448
  /**
22437
- * Query program review info
22438
- *
22439
- * Params:
22440
- * program_key
22441
- * @returns any No response body
21449
+ * Retrieve aggregate review information for a program.
21450
+ * @param programKey The program key to get review information for
21451
+ * @returns ProgramReviewInfoResponse
22442
21452
  * @throws ApiError
22443
21453
  */
22444
- static catalogReviewsProgramInfoRetrieve() {
21454
+ static catalogReviewsProgramInfoRetrieve(programKey) {
22445
21455
  return request(OpenAPI, {
22446
21456
  method: 'GET',
22447
- url: '/api/catalog/reviews/program/info/'
21457
+ url: '/api/catalog/reviews/program/info/',
21458
+ query: {
21459
+ 'program_key': programKey
21460
+ },
21461
+ errors: {
21462
+ 400: `No response body`,
21463
+ 404: `No response body`
21464
+ }
22448
21465
  });
22449
21466
  }
22450
21467
  /**
@@ -22563,158 +21580,166 @@ class CatalogService {
22563
21580
  }
22564
21581
  /**
22565
21582
  * Retrieve roles matching query parameters. Supports filtering by name, id, and slug.
22566
- * @returns any No response body
21583
+ * @param id Role ID
21584
+ * @param name Role name
21585
+ * @param nameIexact Exact match for role name (case insensitive)
21586
+ * @param page Page number for pagination
21587
+ * @param pageSize Number of items per page
21588
+ * @param platformKey Platform key
21589
+ * @param slug Role slug
21590
+ * @param sort Field to sort results by
21591
+ * @returns Role
22567
21592
  * @throws ApiError
22568
21593
  */
22569
- static catalogRolesRetrieve() {
21594
+ static catalogRolesRetrieve(id, name, nameIexact, page, pageSize, platformKey, slug, sort = 'id') {
22570
21595
  return request(OpenAPI, {
22571
21596
  method: 'GET',
22572
- url: '/api/catalog/roles/'
21597
+ url: '/api/catalog/roles/',
21598
+ query: {
21599
+ 'id': id,
21600
+ 'name': name,
21601
+ 'name__iexact': nameIexact,
21602
+ 'page': page,
21603
+ 'page_size': pageSize,
21604
+ 'platform_key': platformKey,
21605
+ 'slug': slug,
21606
+ 'sort': sort
21607
+ }
22573
21608
  });
22574
21609
  }
22575
21610
  /**
22576
21611
  * Add a new role or update an existing role based on provided data.
22577
- * @returns any No response body
21612
+ * @param requestBody
21613
+ * @param id Role ID
21614
+ * @param name Role name
21615
+ * @param nameIexact Exact match for role name (case insensitive)
21616
+ * @param page Page number for pagination
21617
+ * @param pageSize Number of items per page
21618
+ * @param platformKey Platform key
21619
+ * @param slug Role slug
21620
+ * @param sort Field to sort results by
21621
+ * @returns Role
22578
21622
  * @throws ApiError
22579
21623
  */
22580
- static catalogRolesCreate() {
21624
+ static catalogRolesCreate(requestBody, id, name, nameIexact, page, pageSize, platformKey, slug, sort = 'id') {
22581
21625
  return request(OpenAPI, {
22582
21626
  method: 'POST',
22583
- url: '/api/catalog/roles/'
21627
+ url: '/api/catalog/roles/',
21628
+ query: {
21629
+ 'id': id,
21630
+ 'name': name,
21631
+ 'name__iexact': nameIexact,
21632
+ 'page': page,
21633
+ 'page_size': pageSize,
21634
+ 'platform_key': platformKey,
21635
+ 'slug': slug,
21636
+ 'sort': sort
21637
+ },
21638
+ body: requestBody,
21639
+ mediaType: 'application/json'
22584
21640
  });
22585
21641
  }
22586
21642
  /**
22587
21643
  * Retrieve desired roles for a user.
22588
- *
22589
- * This method retrieves the desired roles for a user based on the provided query parameters.
22590
- * If the user is found and has desired roles, it returns the serialized role data with a status of 200.
22591
- * If no roles are found, it returns a status of 400 indicating a bad request.
22592
- *
22593
- * Error Conditions:
22594
- * - If the user cannot be identified from the provided parameters, a 400 status is returned.
22595
- * - If no desired roles exist for the user, a 400 status is returned.
22596
- *
22597
- * Side Effects:
22598
- * - None
22599
- * @returns any No response body
21644
+ * @param userId User ID
21645
+ * @param username Username
21646
+ * @returns DesiredRole
22600
21647
  * @throws ApiError
22601
21648
  */
22602
- static catalogRolesDesiredRetrieve() {
21649
+ static catalogRolesDesiredRetrieve(userId, username) {
22603
21650
  return request(OpenAPI, {
22604
21651
  method: 'GET',
22605
- url: '/api/catalog/roles/desired/'
21652
+ url: '/api/catalog/roles/desired/',
21653
+ query: {
21654
+ 'user_id': userId,
21655
+ 'username': username
21656
+ },
21657
+ errors: {
21658
+ 400: `No response body`
21659
+ }
22606
21660
  });
22607
21661
  }
22608
21662
  /**
22609
- * POST
22610
- * Add or update a role.
22611
- *
22612
- * Params:
22613
- * - user_id/username: The identifier for the user.
22614
- * - skills: The skills associated with the desired role.
22615
- * - data: Additional data related to the desired role.
22616
- *
22617
- * This method allows adding or updating a user's desired roles. It accepts user identification
22618
- * and role data in the request body. If the role is successfully created, it returns the serialized
22619
- * role data with a status of 201. If the role is updated, it returns the serialized role data with
22620
- * a status of 200. If the operation fails, it returns a status of 400.
22621
- *
22622
- * Error Conditions:
22623
- * - If the user cannot be identified from the provided parameters, a 400 status is returned.
22624
- * - If the role cannot be created or updated, a 400 status is returned.
22625
- *
22626
- * Side Effects:
22627
- * - Creates or updates the desired roles for the specified user.
22628
- * @returns any No response body
21663
+ * Add or update desired roles for a user.
21664
+ * @param requestBody
21665
+ * @param userId User ID
21666
+ * @param username Username
21667
+ * @returns DesiredRole
22629
21668
  * @throws ApiError
22630
21669
  */
22631
- static catalogRolesDesiredCreate() {
21670
+ static catalogRolesDesiredCreate(requestBody, userId, username) {
22632
21671
  return request(OpenAPI, {
22633
21672
  method: 'POST',
22634
- url: '/api/catalog/roles/desired/'
21673
+ url: '/api/catalog/roles/desired/',
21674
+ query: {
21675
+ 'user_id': userId,
21676
+ 'username': username
21677
+ },
21678
+ body: requestBody,
21679
+ mediaType: 'application/json',
21680
+ errors: {
21681
+ 400: `No response body`
21682
+ }
22635
21683
  });
22636
21684
  }
22637
21685
  /**
22638
- * Add or update a role.
22639
- *
22640
- * This method handles the creation or updating of a role based on the provided data.
22641
- * It checks if public role creation is allowed, and if not, returns a 404 status.
22642
- * If the request is made by a user token, the user is logged.
22643
- *
22644
- * Params:
22645
- * - id: Identifier for the role.
22646
- * - name: Name of the role.
22647
- * - slug: A short label for the role.
22648
- * - data: Additional data for the role.
22649
- *
22650
- * Returns:
22651
- * - 201 status code if a new role is created.
22652
- * - 200 status code if an existing role is updated.
22653
- * - 400 status code if the role creation or update fails.
22654
- * - 404 status code if public role creation is not allowed.
22655
- *
22656
- * Side Effects:
22657
- * - Logs the user if the request is made by a user token.
22658
- * @returns any No response body
21686
+ * Add or update a role through the public API (when enabled).
21687
+ * @param requestBody
21688
+ * @returns Role
22659
21689
  * @throws ApiError
22660
21690
  */
22661
- static catalogRolesPublicCreate() {
21691
+ static catalogRolesPublicCreate(requestBody) {
22662
21692
  return request(OpenAPI, {
22663
21693
  method: 'POST',
22664
- url: '/api/catalog/roles/public/'
21694
+ url: '/api/catalog/roles/public/',
21695
+ body: requestBody,
21696
+ mediaType: 'application/json',
21697
+ errors: {
21698
+ 404: `No response body`
21699
+ }
22665
21700
  });
22666
21701
  }
22667
21702
  /**
22668
- * GET
22669
- * Retrieve desired roles for user.
22670
- *
22671
- * Params:
22672
- * - name: The name of the role.
22673
- * - id: The ID of the role.
22674
- * - slug: The slug of the role.
22675
- *
22676
- * Returns:
22677
- * - 200: If the role is found, returns the serialized role data.
22678
- * - 400: If no role is found for the user.
22679
- *
22680
- * Error Conditions:
22681
- * - If the user cannot be found using the provided user_id or username, a 400 status is returned.
22682
- * @returns any No response body
21703
+ * Retrieve reported roles for a user.
21704
+ * @param userId User ID
21705
+ * @param username Username
21706
+ * @returns ReportedRole
22683
21707
  * @throws ApiError
22684
21708
  */
22685
- static catalogRolesReportedRetrieve() {
21709
+ static catalogRolesReportedRetrieve(userId, username) {
22686
21710
  return request(OpenAPI, {
22687
21711
  method: 'GET',
22688
- url: '/api/catalog/roles/reported/'
21712
+ url: '/api/catalog/roles/reported/',
21713
+ query: {
21714
+ 'user_id': userId,
21715
+ 'username': username
21716
+ },
21717
+ errors: {
21718
+ 400: `No response body`
21719
+ }
22689
21720
  });
22690
21721
  }
22691
21722
  /**
22692
- * POST
22693
- * Add or update a role.
22694
- *
22695
- * Params:
22696
- * - user_id/username: The identifier for the user.
22697
- * - skills: The skills associated with the role.
22698
- * - data: Additional data related to the role.
22699
- *
22700
- * Returns:
22701
- * - 201: If a new role is created, returns the serialized role data.
22702
- * - 200: If an existing role is updated, returns the serialized role data.
22703
- * - 400: If the role cannot be saved or updated.
22704
- *
22705
- * Error Conditions:
22706
- * - If the user cannot be found using the provided user_id or username, a 400 status is returned.
22707
- * - If the role cannot be saved or updated, a 400 status is returned.
22708
- *
22709
- * Side Effects:
22710
- * - Creates a new role or updates an existing role for the user.
22711
- * @returns any No response body
21723
+ * Add or update reported roles for a user.
21724
+ * @param requestBody
21725
+ * @param userId User ID
21726
+ * @param username Username
21727
+ * @returns ReportedRole
22712
21728
  * @throws ApiError
22713
21729
  */
22714
- static catalogRolesReportedCreate() {
21730
+ static catalogRolesReportedCreate(requestBody, userId, username) {
22715
21731
  return request(OpenAPI, {
22716
21732
  method: 'POST',
22717
- url: '/api/catalog/roles/reported/'
21733
+ url: '/api/catalog/roles/reported/',
21734
+ query: {
21735
+ 'user_id': userId,
21736
+ 'username': username
21737
+ },
21738
+ body: requestBody,
21739
+ mediaType: 'application/json',
21740
+ errors: {
21741
+ 400: `No response body`
21742
+ }
22718
21743
  });
22719
21744
  }
22720
21745
  /**
@@ -22737,123 +21762,134 @@ class CatalogService {
22737
21762
  *
22738
21763
  * Special Return Codes:
22739
21764
  * - A 200 status code indicates successful retrieval of programs matching the query.
22740
- * @returns any No response body
21765
+ * @param requestBody
21766
+ * @param org The organization to which the programs belong
21767
+ * @param query The search term used to filter programs
21768
+ * @returns ProgramSearch
22741
21769
  * @throws ApiError
22742
21770
  */
22743
- static catalogSearchProgramsCreate() {
21771
+ static catalogSearchProgramsCreate(requestBody, org, query = '') {
22744
21772
  return request(OpenAPI, {
22745
21773
  method: 'POST',
22746
- url: '/api/catalog/search/programs/'
21774
+ url: '/api/catalog/search/programs/',
21775
+ query: {
21776
+ 'org': org,
21777
+ 'query': query
21778
+ },
21779
+ body: requestBody,
21780
+ mediaType: 'application/json'
22747
21781
  });
22748
21782
  }
22749
21783
  /**
22750
21784
  * Retrieve skills matching query. Limited parameters.
22751
- * @returns any No response body
21785
+ * @param id Skill ID
21786
+ * @param name Skill name
21787
+ * @param nameIexact Exact match for skill name (case insensitive)
21788
+ * @param page Page number for pagination
21789
+ * @param pageSize Number of items per page
21790
+ * @param platformKey Platform key
21791
+ * @param slug Skill slug
21792
+ * @param sort Field to sort results by
21793
+ * @returns Skill
22752
21794
  * @throws ApiError
22753
21795
  */
22754
- static catalogSkillsRetrieve() {
21796
+ static catalogSkillsRetrieve(id, name, nameIexact, page, pageSize, platformKey, slug, sort = 'id') {
22755
21797
  return request(OpenAPI, {
22756
21798
  method: 'GET',
22757
- url: '/api/catalog/skills/'
21799
+ url: '/api/catalog/skills/',
21800
+ query: {
21801
+ 'id': id,
21802
+ 'name': name,
21803
+ 'name__iexact': nameIexact,
21804
+ 'page': page,
21805
+ 'page_size': pageSize,
21806
+ 'platform_key': platformKey,
21807
+ 'slug': slug,
21808
+ 'sort': sort
21809
+ }
22758
21810
  });
22759
21811
  }
22760
21812
  /**
22761
21813
  * Add or update a skill.
22762
- * @returns any No response body
21814
+ * @param id Skill ID
21815
+ * @param name Skill name
21816
+ * @param nameIexact Exact match for skill name (case insensitive)
21817
+ * @param page Page number for pagination
21818
+ * @param pageSize Number of items per page
21819
+ * @param platformKey Platform key
21820
+ * @param slug Skill slug
21821
+ * @param sort Field to sort results by
21822
+ * @param requestBody
21823
+ * @returns Skill
22763
21824
  * @throws ApiError
22764
21825
  */
22765
- static catalogSkillsCreate() {
21826
+ static catalogSkillsCreate(id, name, nameIexact, page, pageSize, platformKey, slug, sort = 'id', requestBody) {
22766
21827
  return request(OpenAPI, {
22767
21828
  method: 'POST',
22768
- url: '/api/catalog/skills/'
21829
+ url: '/api/catalog/skills/',
21830
+ query: {
21831
+ 'id': id,
21832
+ 'name': name,
21833
+ 'name__iexact': nameIexact,
21834
+ 'page': page,
21835
+ 'page_size': pageSize,
21836
+ 'platform_key': platformKey,
21837
+ 'slug': slug,
21838
+ 'sort': sort
21839
+ },
21840
+ body: requestBody,
21841
+ mediaType: 'application/json'
22769
21842
  });
22770
21843
  }
22771
21844
  /**
22772
- * GET
22773
21845
  * Retrieve desired skills for a user.
22774
- *
22775
- * This method fetches the desired skills associated with a user based on the provided
22776
- * query parameters. It requires either a user_id or username to identify the user.
22777
- *
22778
- * Params:
22779
- * - name: The name of the skill to retrieve.
22780
- * - id: The unique identifier of the skill.
22781
- * - slug: A slug representation of the skill.
22782
- *
22783
- * Returns:
22784
- * - 200: A successful response containing the serialized desired skill data.
22785
- * - 400: If the user is not found or no desired skills exist for the user.
22786
- *
22787
- * Error Conditions:
22788
- * - If the user cannot be identified from the provided parameters, a 400 status is returned.
22789
- * - If no desired skills are found for the identified user, a 400 status is returned.
22790
- * @returns any No response body
21846
+ * @param userId User ID
21847
+ * @param username Username
21848
+ * @returns DesiredSkill
22791
21849
  * @throws ApiError
22792
21850
  */
22793
- static catalogSkillsDesiredRetrieve() {
21851
+ static catalogSkillsDesiredRetrieve(userId, username) {
22794
21852
  return request(OpenAPI, {
22795
21853
  method: 'GET',
22796
- url: '/api/catalog/skills/desired/'
21854
+ url: '/api/catalog/skills/desired/',
21855
+ query: {
21856
+ 'user_id': userId,
21857
+ 'username': username
21858
+ }
22797
21859
  });
22798
21860
  }
22799
21861
  /**
22800
- * POST
22801
- * Add or update a skill.
22802
- *
22803
- * This method allows adding new skills or updating existing skills for a user.
22804
- * It requires user identification through user_id or username and a list of skills
22805
- * to be added or updated.
22806
- *
22807
- * Params:
22808
- * - user_id/username: Identifies the user for whom the skills are to be added or updated.
22809
- * - skills: A list of skills to be added or updated.
22810
- * - data: Additional data related to the skills.
22811
- *
22812
- * Returns:
22813
- * - 201: If a new skill is successfully created.
22814
- * - 200: If an existing skill is successfully updated.
22815
- * - 400: If the user cannot be identified or the skill cannot be saved.
22816
- *
22817
- * Error Conditions:
22818
- * - If the user cannot be identified from the provided parameters, a 400 status is returned.
22819
- * - If the skill cannot be saved due to any reason, a 400 status is returned.
22820
- *
22821
- * Side Effects:
22822
- * - This method may create a new skill entry or update an existing one in the database.
22823
- * @returns any No response body
21862
+ * Add or update desired skills for a user.
21863
+ * @param requestBody
21864
+ * @param userId User ID
21865
+ * @param username Username
21866
+ * @returns DesiredSkill
22824
21867
  * @throws ApiError
22825
21868
  */
22826
- static catalogSkillsDesiredCreate() {
21869
+ static catalogSkillsDesiredCreate(requestBody, userId, username) {
22827
21870
  return request(OpenAPI, {
22828
21871
  method: 'POST',
22829
- url: '/api/catalog/skills/desired/'
21872
+ url: '/api/catalog/skills/desired/',
21873
+ query: {
21874
+ 'user_id': userId,
21875
+ 'username': username
21876
+ },
21877
+ body: requestBody,
21878
+ mediaType: 'application/json'
22830
21879
  });
22831
21880
  }
22832
21881
  /**
22833
- * POST
22834
21882
  * Add or update a skill.
22835
- *
22836
- * This method processes POST requests to add or update a role. It expects the following parameters in the request data:
22837
- * - id: The unique identifier for the skill.
22838
- * - name: The name of the skill.
22839
- * - slug: A URL-friendly version of the skill name.
22840
- * - data: Additional data related to the skill.
22841
- *
22842
- * If the `ALLOW_PUBLIC_SKILL_CREATE` setting is disabled, the method will return a 404 status code, indicating that the creation of new skills is not allowed.
22843
- *
22844
- * If the request is made by a user with a valid token, the user will be logged.
22845
- *
22846
- * Returns:
22847
- * - 201 status code if a new skill is created successfully.
22848
- * - 200 status code if an existing skill is updated successfully.
22849
- * - 400 status code if the skill creation or update fails.
22850
- * @returns any No response body
21883
+ * @param requestBody
21884
+ * @returns Skill
22851
21885
  * @throws ApiError
22852
21886
  */
22853
- static catalogSkillsPublicCreate() {
21887
+ static catalogSkillsPublicCreate(requestBody) {
22854
21888
  return request(OpenAPI, {
22855
21889
  method: 'POST',
22856
- url: '/api/catalog/skills/public/'
21890
+ url: '/api/catalog/skills/public/',
21891
+ body: requestBody,
21892
+ mediaType: 'application/json'
22857
21893
  });
22858
21894
  }
22859
21895
  /**
@@ -22873,13 +21909,19 @@ class CatalogService {
22873
21909
  * Error Conditions:
22874
21910
  * - If the user cannot be identified, a 400 status code is returned.
22875
21911
  * - If no reported skills exist for the user, a 400 status code is returned.
22876
- * @returns any No response body
21912
+ * @param userId User ID
21913
+ * @param username Username
21914
+ * @returns ReportedSkill
22877
21915
  * @throws ApiError
22878
21916
  */
22879
- static catalogSkillsReportedRetrieve() {
21917
+ static catalogSkillsReportedRetrieve(userId, username) {
22880
21918
  return request(OpenAPI, {
22881
21919
  method: 'GET',
22882
- url: '/api/catalog/skills/reported/'
21920
+ url: '/api/catalog/skills/reported/',
21921
+ query: {
21922
+ 'user_id': userId,
21923
+ 'username': username
21924
+ }
22883
21925
  });
22884
21926
  }
22885
21927
  /**
@@ -22905,13 +21947,22 @@ class CatalogService {
22905
21947
  * Side Effects:
22906
21948
  * - If a new skill is created, it will be persisted in the database.
22907
21949
  * - If an existing skill is updated, the changes will be saved in the database.
22908
- * @returns any No response body
21950
+ * @param requestBody
21951
+ * @param userId User ID
21952
+ * @param username Username
21953
+ * @returns ReportedSkill
22909
21954
  * @throws ApiError
22910
21955
  */
22911
- static catalogSkillsReportedCreate() {
21956
+ static catalogSkillsReportedCreate(requestBody, userId, username) {
22912
21957
  return request(OpenAPI, {
22913
21958
  method: 'POST',
22914
- url: '/api/catalog/skills/reported/'
21959
+ url: '/api/catalog/skills/reported/',
21960
+ query: {
21961
+ 'user_id': userId,
21962
+ 'username': username
21963
+ },
21964
+ body: requestBody,
21965
+ mediaType: 'application/json'
22915
21966
  });
22916
21967
  }
22917
21968
  /**
@@ -31625,7 +30676,7 @@ class SearchService {
31625
30676
  * @param tags Filter by tags
31626
30677
  * @param tenant Filter by tenant/organization
31627
30678
  * @param uniqueId Retrieve a specific mentor by UUID
31628
- * @returns any
30679
+ * @returns MentorSearchResponse
31629
30680
  * @throws ApiError
31630
30681
  */
31631
30682
  static searchAiSearchRetrieve(audience, category, createdBy, filterFacet = false, id, limit = 12, llm, offset, orderBy, orderDirection = 'desc', page, pageSize, query, tags, tenant, uniqueId) {
@@ -31649,43 +30700,210 @@ class SearchService {
31649
30700
  'tags': tags,
31650
30701
  'tenant': tenant,
31651
30702
  'unique_id': uniqueId
30703
+ },
30704
+ errors: {
30705
+ 400: `Bad request`,
30706
+ 500: `Server error`
31652
30707
  }
31653
30708
  });
31654
30709
  }
31655
30710
  /**
31656
- * Search and filter content across the learning catalog
31657
- * @param allowSkillSearch Enable skill-based search
31658
- * @param alphabetical Sort alphabetically by name
31659
- * @param certificate Filter by certificate type
31660
- * @param content Content types to include in results
31661
- * @param courseId Filter by specific course ID
31662
- * @param duration Filter by course duration range
31663
- * @param language Filter by content language
31664
- * @param level Filter by difficulty level
31665
- * @param limit Number of results per page
31666
- * @param offset Starting position for pagination
31667
- * @param orderAscending Sort direction
31668
- * @param orderBy Field to sort results by
31669
- * @param pathwayId Filter by specific pathway ID
31670
- * @param price Filter by price/audit status
31671
- * @param programId Filter by specific program ID
31672
- * @param programType Filter by program type
31673
- * @param promotion Filter by promotion status
31674
- * @param query Search term to filter content by name or description
31675
- * @param resourceType Filter by resource type
31676
- * @param returnFacet Include facet data in response
31677
- * @param returnItems Include items in programs/pathways
31678
- * @param selfPaced Filter by course format
31679
- * @param skillId Filter by specific skill ID
31680
- * @param skills Filter by skills
31681
- * @param subject Filter by subject areas
31682
- * @param tags Filter by tags
31683
- * @param tenant Filter by tenant/organization
31684
- * @param topics Filter by topic areas
31685
- * @param updateFacet Force facet update
31686
- * @returns any
31687
- * @throws ApiError
31688
- */
30711
+ * Search and filter content across the learning catalog.
30712
+ *
30713
+ * This endpoint provides a powerful search interface for discovering content across
30714
+ * multiple content types (courses, programs, pathways, skills, roles, resources).
30715
+ * It supports full-text search, faceted filtering, and pagination.
30716
+ *
30717
+ * Query Parameters:
30718
+ * query (str, optional): Search term to filter content by name or description
30719
+ * content (list, optional): Content types to include in results
30720
+ * (courses, programs, pathways, skills, roles, resources)
30721
+ * Default: ["programs", "courses", "pathways", "skills"]
30722
+ *
30723
+ * # Filtering parameters
30724
+ * course_id (str, optional): Filter by specific course ID
30725
+ * program_id (str, optional): Filter by specific program ID
30726
+ * pathway_id (str, optional): Filter by specific pathway ID
30727
+ * skill_id (str, optional): Filter by specific skill ID
30728
+ * subject (list, optional): Filter by subject areas
30729
+ * tenant (list, optional): Filter by tenant/organization
30730
+ * topics (list, optional): Filter by topic areas
30731
+ * tags (list, optional): Filter by tags
30732
+ * level (list, optional): Filter by difficulty level
30733
+ * self_paced (list, optional): Filter by course format (self-paced, instructor-led)
30734
+ * promotion (list, optional): Filter by promotion status
30735
+ * language (list, optional): Filter by content language
30736
+ * certificate (list, optional): Filter by certificate type
30737
+ * program_type (list, optional): Filter by program type
30738
+ * duration (list, optional): Filter by course duration range
30739
+ * price (str, optional): Filter by price/audit status
30740
+ * resource_type (list, optional): Filter by resource type
30741
+ * skills (list, optional): Filter by skills
30742
+ *
30743
+ * # Sorting and pagination
30744
+ * order_by (str, optional): Field to sort results by
30745
+ * order_ascending (bool, optional): Sort direction (default: false)
30746
+ * alphabetical (bool, optional): Sort alphabetically by name (default: false)
30747
+ * limit (int, optional): Number of results per page (default: 12, max: 100)
30748
+ * offset (int, optional): Starting position for pagination
30749
+ *
30750
+ * # Response options
30751
+ * return_facet (bool, optional): Include facet data in response (default: true)
30752
+ * return_items (bool, optional): Include items in programs/pathways (default: false)
30753
+ * allow_skill_search (bool, optional): Enable skill-based search (default: false)
30754
+ * update_facet (str, optional): Force facet update
30755
+ *
30756
+ * Returns:
30757
+ * A JSON response containing:
30758
+ * - results: List of content items with metadata
30759
+ * - count: Total number of matching items
30760
+ * - next: URL for the next page of results (if available)
30761
+ * - previous: URL for the previous page of results (if available)
30762
+ * - current_page: Current page number
30763
+ * - total_pages: Total number of pages
30764
+ * - facets: Aggregated counts for each filter category (if requested)
30765
+ *
30766
+ * Each content item contains type-specific fields:
30767
+ * - Courses:
30768
+ * {
30769
+ * "id": 123,
30770
+ * "type": "course",
30771
+ * "course_id": "CS101",
30772
+ * "name": "Introduction to Computer Science",
30773
+ * "description": "Learn the fundamentals of computer science",
30774
+ * "short_description": "CS fundamentals",
30775
+ * "image_url": "https://example.com/images/cs101.jpg",
30776
+ * "level": "Beginner",
30777
+ * "subject": "Computer Science",
30778
+ * "topics": ["Programming", "Algorithms"],
30779
+ * "tags": ["python", "coding"],
30780
+ * "language": "English",
30781
+ * "tenant": "example-university",
30782
+ * "self_paced": true,
30783
+ * "duration": "6 weeks",
30784
+ * "certificate": "Professional Certificate",
30785
+ * "price": "Free",
30786
+ * "skills": [
30787
+ * {"id": 1, "name": "Python Programming"},
30788
+ * {"id": 2, "name": "Algorithms"}
30789
+ * ],
30790
+ * "url": "https://example.com/courses/cs101"
30791
+ * }
30792
+ *
30793
+ * - Programs:
30794
+ * {
30795
+ * "id": 456,
30796
+ * "type": "program",
30797
+ * "program_id": "PROG123",
30798
+ * "name": "Data Science Program",
30799
+ * "description": "Comprehensive data science curriculum",
30800
+ * "short_description": "Learn data science",
30801
+ * "image_url": "https://example.com/images/datascience.jpg",
30802
+ * "level": "Intermediate",
30803
+ * "subject": "Data Science",
30804
+ * "topics": ["Machine Learning", "Statistics"],
30805
+ * "program_type": "Professional Certificate",
30806
+ * "courses": [
30807
+ * {"id": 123, "name": "Introduction to Python"},
30808
+ * {"id": 124, "name": "Statistics for Data Science"}
30809
+ * ],
30810
+ * "url": "https://example.com/programs/prog123"
30811
+ * }
30812
+ *
30813
+ * - Pathways:
30814
+ * {
30815
+ * "id": 789,
30816
+ * "type": "pathway",
30817
+ * "pathway_id": "PATH456",
30818
+ * "name": "Software Engineering Career Path",
30819
+ * "description": "Complete pathway to become a software engineer",
30820
+ * "image_url": "https://example.com/images/swe-path.jpg",
30821
+ * "programs": [
30822
+ * {"id": 456, "name": "Programming Fundamentals"},
30823
+ * {"id": 457, "name": "Web Development"}
30824
+ * ],
30825
+ * "url": "https://example.com/pathways/path456"
30826
+ * }
30827
+ *
30828
+ * - Skills:
30829
+ * {
30830
+ * "id": 321,
30831
+ * "type": "skill",
30832
+ * "name": "Machine Learning",
30833
+ * "description": "Building systems that learn from data",
30834
+ * "courses": [
30835
+ * {"id": 125, "name": "Machine Learning Fundamentals"}
30836
+ * ],
30837
+ * "related_skills": [
30838
+ * {"id": 322, "name": "Deep Learning"}
30839
+ * ]
30840
+ * }
30841
+ *
30842
+ * - Roles:
30843
+ * {
30844
+ * "id": 654,
30845
+ * "type": "role",
30846
+ * "name": "Data Scientist",
30847
+ * "description": "Professional who analyzes and interprets complex data",
30848
+ * "skills": [
30849
+ * {"id": 321, "name": "Machine Learning"},
30850
+ * {"id": 323, "name": "Data Analysis"}
30851
+ * ],
30852
+ * "recommended_courses": [
30853
+ * {"id": 125, "name": "Machine Learning Fundamentals"}
30854
+ * ]
30855
+ * }
30856
+ *
30857
+ * - Resources:
30858
+ * {
30859
+ * "id": 987,
30860
+ * "type": "resource",
30861
+ * "name": "Python Cheat Sheet",
30862
+ * "description": "Quick reference guide for Python",
30863
+ * "resource_type": "PDF",
30864
+ * "url": "https://example.com/resources/python-cheatsheet.pdf",
30865
+ * "topics": ["Programming", "Python"]
30866
+ * }
30867
+ *
30868
+ * Error Responses:
30869
+ * 500 Internal Server Error: If an unexpected error occurs during processing
30870
+ *
30871
+ * Notes:
30872
+ * - Results are cached for performance
30873
+ * - The 'resources' content type is only included by default if IBL_ENABLE_RESOURCES_IN_FACET is true
30874
+ * - For debugging, add ?debug=true to see detailed information about skill matching
30875
+ * @param allowSkillSearch Enable skill-based search
30876
+ * @param alphabetical Sort alphabetically by name
30877
+ * @param certificate Filter by certificate type
30878
+ * @param content Content types to include in results
30879
+ * @param courseId Filter by specific course ID
30880
+ * @param duration Filter by course duration range
30881
+ * @param language Filter by content language
30882
+ * @param level Filter by difficulty level
30883
+ * @param limit Number of results per page
30884
+ * @param offset Starting position for pagination
30885
+ * @param orderAscending Sort direction
30886
+ * @param orderBy Field to sort results by
30887
+ * @param pathwayId Filter by specific pathway ID
30888
+ * @param price Filter by price/audit status
30889
+ * @param programId Filter by specific program ID
30890
+ * @param programType Filter by program type
30891
+ * @param promotion Filter by promotion status
30892
+ * @param query Search term to filter content by name or description
30893
+ * @param resourceType Filter by resource type
30894
+ * @param returnFacet Include facet data in response
30895
+ * @param returnItems Include items in programs/pathways
30896
+ * @param selfPaced Filter by course format
30897
+ * @param skillId Filter by specific skill ID
30898
+ * @param skills Filter by skills
30899
+ * @param subject Filter by subject areas
30900
+ * @param tags Filter by tags
30901
+ * @param tenant Filter by tenant/organization
30902
+ * @param topics Filter by topic areas
30903
+ * @param updateFacet Force facet update
30904
+ * @returns GlobalCatalogSearchResponse
30905
+ * @throws ApiError
30906
+ */
31689
30907
  static searchCatalogRetrieve(allowSkillSearch = false, alphabetical = false, certificate, content, courseId, duration, language, level, limit = 12, offset, orderAscending = false, orderBy, pathwayId, price, programId, programType, promotion, query, resourceType, returnFacet = true, returnItems = false, selfPaced, skillId, skills, subject, tags, tenant, topics, updateFacet) {
31690
30908
  return request(OpenAPI, {
31691
30909
  method: 'GET',
@@ -31720,27 +30938,141 @@ class SearchService {
31720
30938
  'tenant': tenant,
31721
30939
  'topics': topics,
31722
30940
  'update_facet': updateFacet
30941
+ },
30942
+ errors: {
30943
+ 400: `Bad request`,
30944
+ 500: `Server error`
31723
30945
  }
31724
30946
  });
31725
30947
  }
31726
30948
  /**
31727
- * Get AI mentors based on search criteria
31728
- * @param audience Filter by target audience
31729
- * @param category Filter by mentor category
31730
- * @param createdBy Filter mentors created by specific user
31731
- * @param id Retrieve a specific mentor by ID
31732
- * @param limit Number of results per page
31733
- * @param llm Filter by language model type
31734
- * @param offset Starting position for pagination
31735
- * @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
31736
- * @param orderDirection Sort direction ('asc' or 'desc')
31737
- * @param query Search term to filter mentors by name or description
31738
- * @param tags Filter by tags
31739
- * @param tenant Filter by tenant/organization
31740
- * @param uniqueId Retrieve a specific mentor by UUID
31741
- * @returns any
31742
- * @throws ApiError
31743
- */
30949
+ * Search and filter AI mentors across the platform.
30950
+ *
30951
+ * This endpoint provides a powerful search interface for discovering AI mentors
30952
+ * with support for filtering, pagination, and detailed mentor information.
30953
+ *
30954
+ * Query Parameters:
30955
+ * # Identification parameters (for detail view)
30956
+ * id (int, optional): Retrieve a specific mentor by ID
30957
+ * unique_id (uuid, optional): Retrieve a specific mentor by UUID
30958
+ *
30959
+ * # Search and filtering parameters
30960
+ * query (str, optional): Search term to filter mentors by name or description
30961
+ * tenant (str, optional): Filter by tenant/organization
30962
+ * llm (list, optional): Filter by language model type
30963
+ * audience (list, optional): Filter by target audience
30964
+ * category (list, optional): Filter by mentor category
30965
+ * tags (list, optional): Filter by tags
30966
+ * created_by (str, optional): Filter mentors created by specific user
30967
+ *
30968
+ * # Sorting and pagination
30969
+ * order_by (str, optional): Field to sort results by ('created_at', 'recently_accessed_at')
30970
+ * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
30971
+ * limit (int, optional): Number of results per page (default: 12, max: 100)
30972
+ * offset (int, optional): Starting position for pagination
30973
+ *
30974
+ * Returns:
30975
+ * For detail view (when id or unique_id is provided):
30976
+ * A JSON response containing a single mentor's details:
30977
+ * {
30978
+ * "id": 123,
30979
+ * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
30980
+ * "name": "Professor Smith",
30981
+ * "description": "AI mentor specializing in computer science",
30982
+ * "image_url": "https://example.com/images/prof-smith.jpg",
30983
+ * "llm": {
30984
+ * "id": 1,
30985
+ * "name": "GPT-4",
30986
+ * "description": "Advanced language model"
30987
+ * },
30988
+ * "audience": {
30989
+ * "id": 2,
30990
+ * "name": "College Students",
30991
+ * "description": "For university-level learners"
30992
+ * },
30993
+ * "category": "Computer Science",
30994
+ * "tags": ["programming", "algorithms", "data structures"],
30995
+ * "created_at": "2023-01-15T12:00:00Z",
30996
+ * "recently_accessed_at": "2023-06-20T15:30:00Z",
30997
+ * "platform": {
30998
+ * "id": 1,
30999
+ * "name": "Example University",
31000
+ * "key": "example-university"
31001
+ * },
31002
+ * "visibility": "public",
31003
+ * "settings": {
31004
+ * "temperature": 0.7,
31005
+ * "max_tokens": 1024,
31006
+ * "system_prompt": "You are Professor Smith, an expert in computer science..."
31007
+ * }
31008
+ * }
31009
+ *
31010
+ * For list view:
31011
+ * A JSON response containing:
31012
+ * {
31013
+ * "results": [
31014
+ * {
31015
+ * "id": 123,
31016
+ * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
31017
+ * "name": "Professor Smith",
31018
+ * "description": "AI mentor specializing in computer science",
31019
+ * "image_url": "https://example.com/images/prof-smith.jpg",
31020
+ * "llm": {"id": 1, "name": "GPT-4"},
31021
+ * "audience": {"id": 2, "name": "College Students"},
31022
+ * "category": "Computer Science",
31023
+ * "tags": ["programming", "algorithms"],
31024
+ * "created_at": "2023-01-15T12:00:00Z",
31025
+ * "recently_accessed_at": "2023-06-20T15:30:00Z"
31026
+ * },
31027
+ * // Additional mentor objects...
31028
+ * ],
31029
+ * "count": 50,
31030
+ * "next": "https://api.example.com/api/search/mentors/?limit=12&offset=12",
31031
+ * "previous": null,
31032
+ * "current_page": 1,
31033
+ * "num_pages": 5,
31034
+ * "facets": {
31035
+ * "llm": [
31036
+ * {"key": "GPT-4", "doc_count": 30},
31037
+ * {"key": "Claude", "doc_count": 20}
31038
+ * ],
31039
+ * "audience": [
31040
+ * {"key": "College Students", "doc_count": 35},
31041
+ * {"key": "Professionals", "doc_count": 15}
31042
+ * ],
31043
+ * "category": [
31044
+ * {"key": "Computer Science", "doc_count": 25},
31045
+ * {"key": "Mathematics", "doc_count": 15},
31046
+ * {"key": "Business", "doc_count": 10}
31047
+ * ]
31048
+ * }
31049
+ * }
31050
+ *
31051
+ * Error Responses:
31052
+ * 400 Bad Request: If the request parameters are invalid
31053
+ * 404 Not Found: If the requested mentor doesn't exist
31054
+ * 500 Internal Server Error: If an unexpected error occurs
31055
+ *
31056
+ * Notes:
31057
+ * - Results are cached for performance
31058
+ * - Public mentors are visible to all users
31059
+ * - Private mentors are only visible to authorized users
31060
+ * @param audience Filter by target audience
31061
+ * @param category Filter by mentor category
31062
+ * @param createdBy Filter mentors created by specific user
31063
+ * @param id Retrieve a specific mentor by ID
31064
+ * @param limit Number of results per page
31065
+ * @param llm Filter by language model type
31066
+ * @param offset Starting position for pagination
31067
+ * @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
31068
+ * @param orderDirection Sort direction ('asc' or 'desc')
31069
+ * @param query Search term to filter mentors by name or description
31070
+ * @param tags Filter by tags
31071
+ * @param tenant Filter by tenant/organization
31072
+ * @param uniqueId Retrieve a specific mentor by UUID
31073
+ * @returns MentorSearchResponse
31074
+ * @throws ApiError
31075
+ */
31744
31076
  static searchMentorsRetrieve(audience, category, createdBy, id, limit = 12, llm, offset, orderBy, orderDirection = 'desc', query, tags, tenant, uniqueId) {
31745
31077
  return request(OpenAPI, {
31746
31078
  method: 'GET',
@@ -31759,98 +31091,63 @@ class SearchService {
31759
31091
  'tags': tags,
31760
31092
  'tenant': tenant,
31761
31093
  'unique_id': uniqueId
31094
+ },
31095
+ errors: {
31096
+ 400: `Bad request`,
31097
+ 500: `Server error`
31762
31098
  }
31763
31099
  });
31764
31100
  }
31765
31101
  /**
31766
- * Search and filter documents associated with a specific mentor.
31767
- *
31768
- * This endpoint allows searching and filtering documents that are linked to a
31769
- * particular mentor, with support for pagination, sorting, and faceted filtering.
31770
- *
31771
- * Path Parameters:
31772
- * mentor_unique_id (uuid): The unique identifier of the mentor
31773
- *
31774
- * Query Parameters:
31775
- * query (str, optional): Search term to filter documents by name or content
31776
- * document_type (str, optional): Filter by document type (e.g., 'pdf', 'text')
31777
- * access (str, optional): Filter by access level (e.g., 'public', 'private')
31778
- * training_status (str, optional): Filter by training status (e.g., 'trained', 'pending')
31779
- * platform_key (str, optional): Filter by platform key
31780
- * order_by (str, optional): Field to sort results by ('date_created', 'last_modified', 'document_name')
31781
- * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
31782
- * limit (int, optional): Number of results per page (default: 12, max: 100)
31783
- * offset (int, optional): Starting position for pagination
31784
- *
31785
- * Returns:
31786
- * A JSON response containing:
31787
- * {
31788
- * "results": [
31789
- * {
31790
- * "id": 789,
31791
- * "document_name": "Introduction to Algorithms.pdf",
31792
- * "document_type": "pdf",
31793
- * "access": "public",
31794
- * "training_status": "trained",
31795
- * "date_created": "2023-03-15T10:30:00Z",
31796
- * "last_modified": "2023-04-20T14:45:00Z",
31797
- * "url": "https://example.com/documents/intro-algorithms.pdf",
31798
- * "metadata": {
31799
- * "page_count": 45,
31800
- * "author": "John Smith",
31801
- * "keywords": ["algorithms", "computer science", "data structures"],
31802
- * "description": "Comprehensive introduction to fundamental algorithms"
31803
- * }
31804
- * },
31805
- * // Additional document objects...
31806
- * ],
31807
- * "count": 25,
31808
- * "next": "https://api.example.com/api/search/mentors/550e8400-e29b-41d4-a716-446655440000/documents/?limit=12&offset=12",
31809
- * "previous": null,
31810
- * "current_page": 1,
31811
- * "total_pages": 3,
31812
- * "facets": {
31813
- * "document_type": [
31814
- * {"key": "pdf", "doc_count": 15},
31815
- * {"key": "text", "doc_count": 5},
31816
- * {"key": "docx", "doc_count": 5}
31817
- * ],
31818
- * "access": [
31819
- * {"key": "public", "doc_count": 20},
31820
- * {"key": "private", "doc_count": 5}
31821
- * ],
31822
- * "training_status": [
31823
- * {"key": "trained", "doc_count": 18},
31824
- * {"key": "pending", "doc_count": 5},
31825
- * {"key": "failed", "doc_count": 2}
31826
- * ]
31827
- * }
31828
- * }
31829
- *
31830
- * Error Responses:
31831
- * 400 Bad Request: If the request parameters are invalid
31832
- * 404 Not Found: If the mentor doesn't exist
31833
- * 500 Internal Server Error: If an unexpected error occurs during processing
31834
- *
31835
- * Access Control:
31836
- * - Requires platform membership
31837
- * - Only documents associated with the specified mentor are returned
31838
- * - Access level filtering respects user permissions
31839
- * @param mentorUniqueId
31840
- * @returns any No response body
31841
- * @throws ApiError
31842
- */
31843
- static searchMentorsDocumentsRetrieve(mentorUniqueId) {
31102
+ * Search and filter documents associated with a specific mentor
31103
+ * @param mentorUniqueId
31104
+ * @param access Filter by access level (e.g., 'public', 'private')
31105
+ * @param documentType Filter by document type (e.g., 'pdf', 'text')
31106
+ * @param limit Number of results per page
31107
+ * @param offset Starting position for pagination
31108
+ * @param orderBy Field to sort results by ('date_created', 'last_modified', 'document_name')
31109
+ * @param orderDirection Sort direction ('asc' or 'desc')
31110
+ * @param platformKey Filter by platform key
31111
+ * @param query Search term to filter documents by name or content
31112
+ * @param trainingStatus Filter by training status (e.g., 'trained', 'pending')
31113
+ * @returns DocumentSearchResponse
31114
+ * @throws ApiError
31115
+ */
31116
+ static searchMentorsDocumentsRetrieve(mentorUniqueId, access, documentType, limit = 12, offset, orderBy, orderDirection = 'desc', platformKey, query, trainingStatus) {
31844
31117
  return request(OpenAPI, {
31845
31118
  method: 'GET',
31846
31119
  url: '/api/search/mentors/{mentor_unique_id}/documents/',
31847
31120
  path: {
31848
31121
  'mentor_unique_id': mentorUniqueId
31122
+ },
31123
+ query: {
31124
+ 'access': access,
31125
+ 'document_type': documentType,
31126
+ 'limit': limit,
31127
+ 'offset': offset,
31128
+ 'order_by': orderBy,
31129
+ 'order_direction': orderDirection,
31130
+ 'platform_key': platformKey,
31131
+ 'query': query,
31132
+ 'training_status': trainingStatus
31133
+ },
31134
+ errors: {
31135
+ 400: `Bad request`,
31136
+ 404: `Mentor not found`,
31137
+ 500: `Server error`
31849
31138
  }
31850
31139
  });
31851
31140
  }
31852
31141
  /**
31853
- * Get AI mentors for a specific tenant and user
31142
+ * Handle GET requests for tenant-specific mentor search.
31143
+ *
31144
+ * Args:
31145
+ * request: HTTP request object
31146
+ * org: Tenant/organization key
31147
+ * username: Username of the user making the request
31148
+ *
31149
+ * Returns:
31150
+ * Response: DRF Response object with search results
31854
31151
  * @param org
31855
31152
  * @param username
31856
31153
  * @param audience Filter by target audience
@@ -31866,7 +31163,7 @@ class SearchService {
31866
31163
  * @param tags Filter by tags
31867
31164
  * @param tenant Filter by tenant/organization
31868
31165
  * @param uniqueId Retrieve a specific mentor by UUID
31869
- * @returns any
31166
+ * @returns MentorSearchResponse
31870
31167
  * @throws ApiError
31871
31168
  */
31872
31169
  static searchOrgsUsersMentorsRetrieve(org, username, audience, category, createdBy, id, limit = 12, llm, offset, orderBy, orderDirection = 'desc', query, tags, tenant, uniqueId) {
@@ -31891,6 +31188,10 @@ class SearchService {
31891
31188
  'tags': tags,
31892
31189
  'tenant': tenant,
31893
31190
  'unique_id': uniqueId
31191
+ },
31192
+ errors: {
31193
+ 400: `Bad request`,
31194
+ 500: `Server error`
31894
31195
  }
31895
31196
  });
31896
31197
  }
@@ -31926,16 +31227,50 @@ class SearchService {
31926
31227
  * - Private prompts are only visible to authorized users
31927
31228
  * @param org
31928
31229
  * @param username
31929
- * @returns any No response body
31230
+ * @param alphabetical Sort alphabetically
31231
+ * @param category Filter by prompt category
31232
+ * @param filterFacet If true, return only facets without results
31233
+ * @param language Filter by prompt language
31234
+ * @param limit Number of results per page
31235
+ * @param mentor Filter by mentor UUID
31236
+ * @param offset Starting position for pagination
31237
+ * @param orderDirection Sort direction ('asc' or 'desc')
31238
+ * @param query Search term to filter prompts by name or content
31239
+ * @param sortBy Field to sort results by
31240
+ * @param style Filter by prompt style
31241
+ * @param tenant Filter by tenant/organization
31242
+ * @param tone Filter by prompt tone
31243
+ * @returns void
31930
31244
  * @throws ApiError
31931
31245
  */
31932
- static searchOrgsUsersPromptsRetrieve(org, username) {
31246
+ static searchOrgsUsersPromptsRetrieve(org, username, alphabetical = false, category, filterFacet, language, limit = 10, mentor, offset, orderDirection = 'desc', query, sortBy, style, tenant, tone) {
31933
31247
  return request(OpenAPI, {
31934
31248
  method: 'GET',
31935
31249
  url: '/api/search/orgs/{org}/users/{username}/prompts/',
31936
31250
  path: {
31937
31251
  'org': org,
31938
31252
  'username': username
31253
+ },
31254
+ query: {
31255
+ 'alphabetical': alphabetical,
31256
+ 'category': category,
31257
+ 'filter_facet': filterFacet,
31258
+ 'language': language,
31259
+ 'limit': limit,
31260
+ 'mentor': mentor,
31261
+ 'offset': offset,
31262
+ 'order_direction': orderDirection,
31263
+ 'query': query,
31264
+ 'sort_by': sortBy,
31265
+ 'style': style,
31266
+ 'tenant': tenant,
31267
+ 'tone': tone
31268
+ },
31269
+ errors: {
31270
+ 400: `Bad request`,
31271
+ 403: `Forbidden`,
31272
+ 404: `Not found`,
31273
+ 500: `Server error`
31939
31274
  }
31940
31275
  });
31941
31276
  }
@@ -31943,21 +31278,74 @@ class SearchService {
31943
31278
  * Determine whether to serve a detail view or a list view.
31944
31279
  * @param org
31945
31280
  * @param username
31946
- * @returns any No response body
31281
+ * @param certificate Filter by certificate type
31282
+ * @param content Content types to include in recommendations (courses, programs, pathways, skills, roles, resources)
31283
+ * @param courseId Retrieve a specific course by ID
31284
+ * @param duration Filter by course duration range
31285
+ * @param language Filter by content language
31286
+ * @param level Filter by difficulty level
31287
+ * @param limit Number of results per page
31288
+ * @param offset Starting position for pagination
31289
+ * @param pathwayId Retrieve a specific pathway by ID
31290
+ * @param price Filter by price/audit status
31291
+ * @param programId Retrieve a specific program by ID
31292
+ * @param programType Filter by program type
31293
+ * @param query Search term to filter content by name or description
31294
+ * @param resourceId Retrieve a specific resource by ID
31295
+ * @param resourceType Filter by resource type
31296
+ * @param roleId Retrieve a specific role by ID
31297
+ * @param selfPaced Filter by course format (self-paced, instructor-led)
31298
+ * @param skillId Retrieve a specific skill by ID
31299
+ * @param skills Filter by skills
31300
+ * @param subject Filter by subject areas
31301
+ * @param tags Filter by tags
31302
+ * @param topics Filter by topic areas
31303
+ * @returns void
31947
31304
  * @throws ApiError
31948
31305
  */
31949
- static searchOrgsUsersRecommendedRetrieve(org, username) {
31306
+ static searchOrgsUsersRecommendedRetrieve(org, username, certificate, content, courseId, duration, language, level, limit = 12, offset, pathwayId, price, programId, programType, query, resourceId, resourceType, roleId, selfPaced, skillId, skills, subject, tags, topics) {
31950
31307
  return request(OpenAPI, {
31951
31308
  method: 'GET',
31952
31309
  url: '/api/search/orgs/{org}/users/{username}/recommended/',
31953
31310
  path: {
31954
31311
  'org': org,
31955
31312
  'username': username
31313
+ },
31314
+ query: {
31315
+ 'certificate': certificate,
31316
+ 'content': content,
31317
+ 'course_id': courseId,
31318
+ 'duration': duration,
31319
+ 'language': language,
31320
+ 'level': level,
31321
+ 'limit': limit,
31322
+ 'offset': offset,
31323
+ 'pathway_id': pathwayId,
31324
+ 'price': price,
31325
+ 'program_id': programId,
31326
+ 'program_type': programType,
31327
+ 'query': query,
31328
+ 'resource_id': resourceId,
31329
+ 'resource_type': resourceType,
31330
+ 'role_id': roleId,
31331
+ 'self_paced': selfPaced,
31332
+ 'skill_id': skillId,
31333
+ 'skills': skills,
31334
+ 'subject': subject,
31335
+ 'tags': tags,
31336
+ 'topics': topics
31337
+ },
31338
+ errors: {
31339
+ 400: `Bad request`,
31340
+ 404: `User not found`,
31341
+ 500: `Server error`
31956
31342
  }
31957
31343
  });
31958
31344
  }
31959
31345
  /**
31960
- * Get personalized content for a specific user
31346
+ * Determine whether to serve a detail view or a list view.
31347
+ * If any detail-identifying parameters are present (course_id, program_id, etc.)
31348
+ * the detail view is returned; otherwise the aggregated list view is returned.
31961
31349
  * @param username
31962
31350
  * @param allowSkillSearch Enable skill-based search
31963
31351
  * @param alphabetical Sort alphabetically by name
@@ -32147,13 +31535,45 @@ class SearchService {
32147
31535
  * Notes:
32148
31536
  * - Only publicly available prompts are returned by default
32149
31537
  * - When filtering by mentor, the mentor ID must be a valid UUID
32150
- * @returns any No response body
31538
+ * @param alphabetical Sort alphabetically
31539
+ * @param category Filter by prompt category
31540
+ * @param filterFacet If true, return only facets without results
31541
+ * @param language Filter by prompt language
31542
+ * @param limit Number of results per page
31543
+ * @param mentor Filter by mentor UUID
31544
+ * @param offset Starting position for pagination
31545
+ * @param orderDirection Sort direction ('asc' or 'desc')
31546
+ * @param query Search term to filter prompts by name or content
31547
+ * @param sortBy Field to sort results by
31548
+ * @param style Filter by prompt style
31549
+ * @param tenant Filter by tenant/organization
31550
+ * @param tone Filter by prompt tone
31551
+ * @returns void
32151
31552
  * @throws ApiError
32152
31553
  */
32153
- static searchPromptsRetrieve() {
31554
+ static searchPromptsRetrieve(alphabetical = false, category, filterFacet, language, limit = 10, mentor, offset, orderDirection = 'desc', query, sortBy, style, tenant, tone) {
32154
31555
  return request(OpenAPI, {
32155
31556
  method: 'GET',
32156
- url: '/api/search/prompts/'
31557
+ url: '/api/search/prompts/',
31558
+ query: {
31559
+ 'alphabetical': alphabetical,
31560
+ 'category': category,
31561
+ 'filter_facet': filterFacet,
31562
+ 'language': language,
31563
+ 'limit': limit,
31564
+ 'mentor': mentor,
31565
+ 'offset': offset,
31566
+ 'order_direction': orderDirection,
31567
+ 'query': query,
31568
+ 'sort_by': sortBy,
31569
+ 'style': style,
31570
+ 'tenant': tenant,
31571
+ 'tone': tone
31572
+ },
31573
+ errors: {
31574
+ 400: `Bad request`,
31575
+ 500: `Server error`
31576
+ }
32157
31577
  });
32158
31578
  }
32159
31579
  /**
@@ -32247,16 +31667,50 @@ class SearchService {
32247
31667
  * - Department filtering restricts results to users in departments where the requesting user is an admin
32248
31668
  * @param org
32249
31669
  * @param username
32250
- * @returns any No response body
31670
+ * @param department Filter by department names
31671
+ * @param educationDegree Filter by degree
31672
+ * @param educationFieldOfStudy Filter by field of study
31673
+ * @param educationInstitution Filter by institution
31674
+ * @param includeMembershipData Include user group membership data in results
31675
+ * @param limit Number of results per page
31676
+ * @param offset Starting position for pagination
31677
+ * @param q Search term to filter users by name, email, or other attributes
31678
+ * @param userResumeCompany Filter by company
31679
+ * @param userResumeIndustry Filter by industry
31680
+ * @param userResumeJobTitle Filter by job title
31681
+ * @param userResumeLocation Filter by location
31682
+ * @param userResumeSkills Filter by skills
31683
+ * @returns UserSearchResponse
32251
31684
  * @throws ApiError
32252
31685
  */
32253
- static searchUsersOrgsUsersRetrieve(org, username) {
31686
+ static searchUsersOrgsUsersRetrieve(org, username, department, educationDegree, educationFieldOfStudy, educationInstitution, includeMembershipData = false, limit = 10, offset, q, userResumeCompany, userResumeIndustry, userResumeJobTitle, userResumeLocation, userResumeSkills) {
32254
31687
  return request(OpenAPI, {
32255
31688
  method: 'GET',
32256
31689
  url: '/api/search/users/orgs/{org}/users/{username}/',
32257
31690
  path: {
32258
31691
  'org': org,
32259
31692
  'username': username
31693
+ },
31694
+ query: {
31695
+ 'department': department,
31696
+ 'education__degree': educationDegree,
31697
+ 'education__field_of_study': educationFieldOfStudy,
31698
+ 'education__institution': educationInstitution,
31699
+ 'include_membership_data': includeMembershipData,
31700
+ 'limit': limit,
31701
+ 'offset': offset,
31702
+ 'q': q,
31703
+ 'user_resume__company': userResumeCompany,
31704
+ 'user_resume__industry': userResumeIndustry,
31705
+ 'user_resume__job_title': userResumeJobTitle,
31706
+ 'user_resume__location': userResumeLocation,
31707
+ 'user_resume__skills': userResumeSkills
31708
+ },
31709
+ errors: {
31710
+ 400: `Bad request`,
31711
+ 403: `Forbidden`,
31712
+ 404: `Not found`,
31713
+ 500: `Server error`
32260
31714
  }
32261
31715
  });
32262
31716
  }
@@ -33084,8 +32538,6 @@ class UserGroupsService {
33084
32538
 
33085
32539
  exports.AiAccountService = AiAccountService;
33086
32540
  exports.AiAnalyticsService = AiAnalyticsService;
33087
- exports.AiBotService = AiBotService;
33088
- exports.AiFinetuningService = AiFinetuningService;
33089
32541
  exports.AiIndexService = AiIndexService;
33090
32542
  exports.AiMarketingService = AiMarketingService;
33091
32543
  exports.AiMentorService = AiMentorService;