@iblai/iblai-api 1.0.0-add-mcp-server-test-mount-core

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (544) hide show
  1. package/README.md +222 -0
  2. package/dist/index.cjs.js +17341 -0
  3. package/dist/index.cjs.js.map +1 -0
  4. package/dist/index.esm.js +17310 -0
  5. package/dist/index.esm.js.map +1 -0
  6. package/dist/index.umd.js +17347 -0
  7. package/dist/index.umd.js.map +1 -0
  8. package/dist/types/core/ApiError.d.ts +10 -0
  9. package/dist/types/core/ApiRequestOptions.d.ts +13 -0
  10. package/dist/types/core/ApiResult.d.ts +7 -0
  11. package/dist/types/core/CancelablePromise.d.ts +20 -0
  12. package/dist/types/core/OpenAPI.d.ts +16 -0
  13. package/dist/types/core/request.d.ts +30 -0
  14. package/dist/types/index.d.ts +264 -0
  15. package/dist/types/models/AWSTenantLaunchRequest.d.ts +20 -0
  16. package/dist/types/models/AcceptanceEnum.d.ts +10 -0
  17. package/dist/types/models/ActivateUserFreeTrial.d.ts +11 -0
  18. package/dist/types/models/ActiveUsersData.d.ts +18 -0
  19. package/dist/types/models/ActiveUsersList.d.ts +6 -0
  20. package/dist/types/models/ActiveUsersPerCourse.d.ts +10 -0
  21. package/dist/types/models/ActiveUsersPerCourseData.d.ts +14 -0
  22. package/dist/types/models/ActivityAPI.d.ts +8 -0
  23. package/dist/types/models/ActivityData.d.ts +38 -0
  24. package/dist/types/models/App.d.ts +10 -0
  25. package/dist/types/models/AppleSubscriptionStatusRequest.d.ts +3 -0
  26. package/dist/types/models/AppleSubscriptionStatusView.d.ts +3 -0
  27. package/dist/types/models/AppleVerifyTransactionId.d.ts +3 -0
  28. package/dist/types/models/Assertion.d.ts +15 -0
  29. package/dist/types/models/AssociateAccountResponse.d.ts +5 -0
  30. package/dist/types/models/AssociateAppleAccount.d.ts +3 -0
  31. package/dist/types/models/AuthToken.d.ts +10 -0
  32. package/dist/types/models/Average.d.ts +4 -0
  33. package/dist/types/models/AverageData.d.ts +6 -0
  34. package/dist/types/models/AverageOvertime.d.ts +22 -0
  35. package/dist/types/models/AvgCourseGradeWithCutoff.d.ts +4 -0
  36. package/dist/types/models/AvgCourseGradeWithCutoffData.d.ts +10 -0
  37. package/dist/types/models/BaseErrorResponse.d.ts +5 -0
  38. package/dist/types/models/BaseResponse.d.ts +5 -0
  39. package/dist/types/models/BlankEnum.d.ts +2 -0
  40. package/dist/types/models/BulkCreateAssertion.d.ts +4 -0
  41. package/dist/types/models/CampaignEnablement.d.ts +8 -0
  42. package/dist/types/models/CampaignExclusion.d.ts +8 -0
  43. package/dist/types/models/CeleryHeartbeat.d.ts +5 -0
  44. package/dist/types/models/CeleryHeartbeatFail.d.ts +5 -0
  45. package/dist/types/models/CeleryHeartbeatFailStatusEnum.d.ts +8 -0
  46. package/dist/types/models/CeleryHeartbeatStatusEnum.d.ts +8 -0
  47. package/dist/types/models/Company.d.ts +23 -0
  48. package/dist/types/models/ContextResponse.d.ts +7 -0
  49. package/dist/types/models/Count.d.ts +4 -0
  50. package/dist/types/models/CountData.d.ts +6 -0
  51. package/dist/types/models/CourseCompletionPerCourse.d.ts +6 -0
  52. package/dist/types/models/CourseCompletionPerCourseData.d.ts +22 -0
  53. package/dist/types/models/CourseCompletionSummaryDataOvertime.d.ts +18 -0
  54. package/dist/types/models/CourseCompletionSummaryOvertime.d.ts +6 -0
  55. package/dist/types/models/CourseGradeDetailBlock.d.ts +18 -0
  56. package/dist/types/models/CourseGradeDetailSubSection.d.ts +23 -0
  57. package/dist/types/models/CourseGradeSummary.d.ts +4 -0
  58. package/dist/types/models/CourseGradeSummaryData.d.ts +18 -0
  59. package/dist/types/models/CourseGradingDetail.d.ts +4 -0
  60. package/dist/types/models/CourseGradingDetailData.d.ts +12 -0
  61. package/dist/types/models/CoursePoint.d.ts +7 -0
  62. package/dist/types/models/CourseSkill.d.ts +8 -0
  63. package/dist/types/models/Credential.d.ts +28 -0
  64. package/dist/types/models/DesiredRole.d.ts +4 -0
  65. package/dist/types/models/DesiredSkill.d.ts +4 -0
  66. package/dist/types/models/DetailedGradeSubsection.d.ts +22 -0
  67. package/dist/types/models/DetailedGradeView.d.ts +4 -0
  68. package/dist/types/models/DetailedGradeViewData.d.ts +12 -0
  69. package/dist/types/models/Education.d.ts +30 -0
  70. package/dist/types/models/EdxSignalReceiverRequest.d.ts +4 -0
  71. package/dist/types/models/EngagementPerCourse.d.ts +6 -0
  72. package/dist/types/models/EngagementPerCourseData.d.ts +26 -0
  73. package/dist/types/models/Enrollments.d.ts +8 -0
  74. package/dist/types/models/EnrollmentsData.d.ts +18 -0
  75. package/dist/types/models/EnrollmentsPerUser.d.ts +6 -0
  76. package/dist/types/models/EnrollmentsPerUserData.d.ts +18 -0
  77. package/dist/types/models/ErrorResponse.d.ts +8 -0
  78. package/dist/types/models/Experience.d.ts +29 -0
  79. package/dist/types/models/FloatOverTime.d.ts +10 -0
  80. package/dist/types/models/GCPTenantLaunchRequest.d.ts +24 -0
  81. package/dist/types/models/GooglePayAccountResponse.d.ts +15 -0
  82. package/dist/types/models/GooglePayAccountResponseStatusEnum.d.ts +8 -0
  83. package/dist/types/models/GooglePayVerifyToken.d.ts +6 -0
  84. package/dist/types/models/GradingPerUser.d.ts +8 -0
  85. package/dist/types/models/GradingPerUserData.d.ts +26 -0
  86. package/dist/types/models/GroupList.d.ts +6 -0
  87. package/dist/types/models/GroupListData.d.ts +16 -0
  88. package/dist/types/models/ImageUpload.d.ts +3 -0
  89. package/dist/types/models/Institution.d.ts +20 -0
  90. package/dist/types/models/InstitutionTypeEnum.d.ts +14 -0
  91. package/dist/types/models/Issuer.d.ts +9 -0
  92. package/dist/types/models/IssuerAuthority.d.ts +5 -0
  93. package/dist/types/models/ItemTypeEnum.d.ts +18 -0
  94. package/dist/types/models/LauncherViewPostRequest.d.ts +9 -0
  95. package/dist/types/models/LearnerInformationAPI.d.ts +4 -0
  96. package/dist/types/models/LearnerInformationAPIData.d.ts +83 -0
  97. package/dist/types/models/LtiKey.d.ts +19 -0
  98. package/dist/types/models/LtiLaunchGate.d.ts +8 -0
  99. package/dist/types/models/LtiTool.d.ts +46 -0
  100. package/dist/types/models/ManagerAuthToken.d.ts +13 -0
  101. package/dist/types/models/MarkAllReadRequest.d.ts +9 -0
  102. package/dist/types/models/MarkAllReadResponse.d.ts +7 -0
  103. package/dist/types/models/MediaResource.d.ts +71 -0
  104. package/dist/types/models/MediaTypeEnum.d.ts +14 -0
  105. package/dist/types/models/ModeEnum.d.ts +10 -0
  106. package/dist/types/models/NetRevenueOverTime.d.ts +8 -0
  107. package/dist/types/models/NewPerLearnerList.d.ts +6 -0
  108. package/dist/types/models/NewPerLearnerListData.d.ts +17 -0
  109. package/dist/types/models/Notification.d.ts +14 -0
  110. package/dist/types/models/NotificationCount.d.ts +4 -0
  111. package/dist/types/models/NotificationPreview.d.ts +31 -0
  112. package/dist/types/models/NotificationSource.d.ts +8 -0
  113. package/dist/types/models/NotificationStatusEnum.d.ts +10 -0
  114. package/dist/types/models/NotificationTemplateData.d.ts +26 -0
  115. package/dist/types/models/OnboardingStatusUpdate.d.ts +7 -0
  116. package/dist/types/models/Order.d.ts +22 -0
  117. package/dist/types/models/OverTime.d.ts +3 -0
  118. package/dist/types/models/OverTimeWithTotal.d.ts +22 -0
  119. package/dist/types/models/OvertimeMeta.d.ts +30 -0
  120. package/dist/types/models/OvertimeWithChangeInfo.d.ts +24 -0
  121. package/dist/types/models/PaginatedUserAppList.d.ts +7 -0
  122. package/dist/types/models/Pagination.d.ts +18 -0
  123. package/dist/types/models/PatchedMediaResource.d.ts +71 -0
  124. package/dist/types/models/PatchedNotification.d.ts +14 -0
  125. package/dist/types/models/PatchedPlatformPublicMetadata.d.ts +8 -0
  126. package/dist/types/models/PatchedSkillThreshold.d.ts +14 -0
  127. package/dist/types/models/PerLearnerCourseLastAccessData.d.ts +30 -0
  128. package/dist/types/models/PerLearnerCourseVideosWatched.d.ts +8 -0
  129. package/dist/types/models/PerLearnerCourseVideosWatchedData.d.ts +14 -0
  130. package/dist/types/models/PerLearnerLastAccess.d.ts +4 -0
  131. package/dist/types/models/PerLearnerLastAccessData.d.ts +11 -0
  132. package/dist/types/models/PerLearnerTimeSpentInCourseTree.d.ts +8 -0
  133. package/dist/types/models/PerformanceGradesPerCourse.d.ts +6 -0
  134. package/dist/types/models/PerformanceGradesPerCourseData.d.ts +22 -0
  135. package/dist/types/models/PerlearnerCourseProgress.d.ts +4 -0
  136. package/dist/types/models/PerlearnerCourseProgressData.d.ts +6 -0
  137. package/dist/types/models/PerlearnerEngagementVideosData.d.ts +30 -0
  138. package/dist/types/models/PerlearnerEngagementVideosWatchedPerCourse.d.ts +4 -0
  139. package/dist/types/models/PerlearnerGradeSummary.d.ts +4 -0
  140. package/dist/types/models/PerlearnerGradeSummaryData.d.ts +18 -0
  141. package/dist/types/models/PerlearnerGradeWithCutOff.d.ts +4 -0
  142. package/dist/types/models/PerlearnerGradeWithCutOffData.d.ts +10 -0
  143. package/dist/types/models/PerlearnerGradingPerCourseAPI.d.ts +4 -0
  144. package/dist/types/models/PerlearnerGradingPerCourseAPIData.d.ts +34 -0
  145. package/dist/types/models/PerlearnerUserList.d.ts +6 -0
  146. package/dist/types/models/PerlearnerUserListData.d.ts +34 -0
  147. package/dist/types/models/Platform.d.ts +29 -0
  148. package/dist/types/models/PlatformApiKey.d.ts +30 -0
  149. package/dist/types/models/PlatformList.d.ts +29 -0
  150. package/dist/types/models/PlatformListStatusEnum.d.ts +22 -0
  151. package/dist/types/models/PlatformPublicMetadata.d.ts +8 -0
  152. package/dist/types/models/PlatformUpdatePostRequest.d.ts +9 -0
  153. package/dist/types/models/PointsPercentile.d.ts +8 -0
  154. package/dist/types/models/PreviewResponse.d.ts +11 -0
  155. package/dist/types/models/Product.d.ts +22 -0
  156. package/dist/types/models/ProductTable.d.ts +26 -0
  157. package/dist/types/models/Program.d.ts +24 -0
  158. package/dist/types/models/ProgramTypeEnum.d.ts +18 -0
  159. package/dist/types/models/Recipient.d.ts +8 -0
  160. package/dist/types/models/RecommendationSearchAPI.d.ts +3 -0
  161. package/dist/types/models/RedirectTokenRequest.d.ts +3 -0
  162. package/dist/types/models/RedirectTokenResponse.d.ts +5 -0
  163. package/dist/types/models/ReportCreate.d.ts +7 -0
  164. package/dist/types/models/ReportData.d.ts +28 -0
  165. package/dist/types/models/ReportDetail.d.ts +4 -0
  166. package/dist/types/models/ReportList.d.ts +4 -0
  167. package/dist/types/models/ReportRequest.d.ts +21 -0
  168. package/dist/types/models/ReportStatus.d.ts +41 -0
  169. package/dist/types/models/ReportedRole.d.ts +4 -0
  170. package/dist/types/models/ReportedSkill.d.ts +4 -0
  171. package/dist/types/models/Resource.d.ts +22 -0
  172. package/dist/types/models/ResourceCreateUpdate.d.ts +42 -0
  173. package/dist/types/models/ResourcePoint.d.ts +7 -0
  174. package/dist/types/models/RevenueByProduct.d.ts +6 -0
  175. package/dist/types/models/Role.d.ts +7 -0
  176. package/dist/types/models/SendNotification.d.ts +6 -0
  177. package/dist/types/models/SendResponse.d.ts +9 -0
  178. package/dist/types/models/Skill.d.ts +7 -0
  179. package/dist/types/models/SkillDetail.d.ts +9 -0
  180. package/dist/types/models/SkillInfo.d.ts +23 -0
  181. package/dist/types/models/SkillThreshold.d.ts +14 -0
  182. package/dist/types/models/StateEnum.d.ts +22 -0
  183. package/dist/types/models/StripeCheckoutSessionRequest.d.ts +54 -0
  184. package/dist/types/models/StripeCheckoutSessionResponse.d.ts +6 -0
  185. package/dist/types/models/StripeCustomerPortalRequest.d.ts +3 -0
  186. package/dist/types/models/StripeCustomerPortalResponse.d.ts +3 -0
  187. package/dist/types/models/StripeLocalProduct.d.ts +8 -0
  188. package/dist/types/models/StripeSubscriptionRenewalRequest.d.ts +4 -0
  189. package/dist/types/models/StripeSubscriptionRenewalResponse.d.ts +3 -0
  190. package/dist/types/models/SubTimeChild.d.ts +18 -0
  191. package/dist/types/models/Summary.d.ts +18 -0
  192. package/dist/types/models/TenantLaunchError.d.ts +10 -0
  193. package/dist/types/models/TenantLaunchFailed.d.ts +15 -0
  194. package/dist/types/models/TenantLaunchRequest.d.ts +16 -0
  195. package/dist/types/models/TenantLaunchResponse.d.ts +15 -0
  196. package/dist/types/models/TimeChildData.d.ts +20 -0
  197. package/dist/types/models/TimeDetail.d.ts +8 -0
  198. package/dist/types/models/TimeDetailChild.d.ts +26 -0
  199. package/dist/types/models/TimeDetailData.d.ts +24 -0
  200. package/dist/types/models/TimeSpentByUsersInCourse.d.ts +6 -0
  201. package/dist/types/models/TimeSpentByUsersInCourseData.d.ts +22 -0
  202. package/dist/types/models/TimeSpentPerCourse.d.ts +6 -0
  203. package/dist/types/models/TimeSpentPerCourseData.d.ts +26 -0
  204. package/dist/types/models/TimeSpentPerUserResponse.d.ts +3 -0
  205. package/dist/types/models/TimeSpentUpdateRequest.d.ts +34 -0
  206. package/dist/types/models/TimeSpentUpdateResponse.d.ts +4 -0
  207. package/dist/types/models/TokenProxyInput.d.ts +21 -0
  208. package/dist/types/models/TokenProxyOutput.d.ts +7 -0
  209. package/dist/types/models/TokenProxyOutputSerializerData.d.ts +20 -0
  210. package/dist/types/models/TokenProxyUser.d.ts +25 -0
  211. package/dist/types/models/TypeEnum.d.ts +18 -0
  212. package/dist/types/models/UploadedImage.d.ts +5 -0
  213. package/dist/types/models/UserApp.d.ts +27 -0
  214. package/dist/types/models/UserDeleteAPIError.d.ts +3 -0
  215. package/dist/types/models/UserDeleteAPIRequest.d.ts +3 -0
  216. package/dist/types/models/UserDeleteAPIResponse.d.ts +3 -0
  217. package/dist/types/models/UserInfo.d.ts +13 -0
  218. package/dist/types/models/UserPlatformLink.d.ts +17 -0
  219. package/dist/types/models/UserPlatformManagementListViewGetResponse.d.ts +6 -0
  220. package/dist/types/models/UserPlatformViewPostRequest.d.ts +8 -0
  221. package/dist/types/models/UserProxyBulkRequest.d.ts +3 -0
  222. package/dist/types/models/UserProxyGetResponse.d.ts +8 -0
  223. package/dist/types/models/UserProxyPostRequest.d.ts +7 -0
  224. package/dist/types/models/UserProxyPostResponse.d.ts +8 -0
  225. package/dist/types/models/UserSearchViewGetResponse.d.ts +6 -0
  226. package/dist/types/models/UserSkill.d.ts +22 -0
  227. package/dist/types/models/UserSkillPointsPercentile.d.ts +8 -0
  228. package/dist/types/models/ValidateSourceResponse.d.ts +10 -0
  229. package/dist/types/models/Value.d.ts +4 -0
  230. package/dist/types/models/ValueData.d.ts +6 -0
  231. package/dist/types/models/VerifyGCPMarketPlaceFailedResponse.d.ts +11 -0
  232. package/dist/types/models/VerifyGCPMarketPlaceRequest.d.ts +3 -0
  233. package/dist/types/models/VerifyGCPMarketPlaceResponse.d.ts +11 -0
  234. package/dist/types/models/VideoBlock.d.ts +14 -0
  235. package/dist/types/models/VideoEngagementPerCourse.d.ts +6 -0
  236. package/dist/types/models/VideoEngagementPerCourseData.d.ts +30 -0
  237. package/dist/types/models/VideosCount.d.ts +4 -0
  238. package/dist/types/models/VideosCountData.d.ts +6 -0
  239. package/dist/types/models/VideosInCourseSummary.d.ts +4 -0
  240. package/dist/types/models/VideosInCourseSummaryData.d.ts +12 -0
  241. package/dist/types/models/VideosSpecificCourse.d.ts +4 -0
  242. package/dist/types/models/VideosSpecificCourseData.d.ts +26 -0
  243. package/dist/types/models/VideosWatchedSubSection.d.ts +19 -0
  244. package/dist/types/models/WatchedVideosPerCourse.d.ts +8 -0
  245. package/dist/types/models/WatchedVideosPerCourseData.d.ts +18 -0
  246. package/dist/types/models/WatchedVideosPerUser.d.ts +8 -0
  247. package/dist/types/models/WatchedVideosPerUserData.d.ts +18 -0
  248. package/dist/types/models/WhitelistedDomain.d.ts +4 -0
  249. package/dist/types/services/AnalyticsService.d.ts +54 -0
  250. package/dist/types/services/AudienceService.d.ts +348 -0
  251. package/dist/types/services/CareerService.d.ts +210 -0
  252. package/dist/types/services/CatalogService.d.ts +6904 -0
  253. package/dist/types/services/CoreService.d.ts +638 -0
  254. package/dist/types/services/CredentialsService.d.ts +1186 -0
  255. package/dist/types/services/DepartmentsService.d.ts +43 -0
  256. package/dist/types/services/EngagementService.d.ts +467 -0
  257. package/dist/types/services/FeaturesService.d.ts +75 -0
  258. package/dist/types/services/FinanceService.d.ts +52 -0
  259. package/dist/types/services/MediaResourcesService.d.ts +112 -0
  260. package/dist/types/services/NotificationBuilderService.d.ts +58 -0
  261. package/dist/types/services/NotificationService.d.ts +128 -0
  262. package/dist/types/services/OverviewService.d.ts +184 -0
  263. package/dist/types/services/PerformanceService.d.ts +183 -0
  264. package/dist/types/services/PerlearnerService.d.ts +501 -0
  265. package/dist/types/services/PlatformService.d.ts +391 -0
  266. package/dist/types/services/ProvidersService.d.ts +142 -0
  267. package/dist/types/services/ProvisionService.d.ts +14 -0
  268. package/dist/types/services/RecommendationsService.d.ts +13 -0
  269. package/dist/types/services/ReportsService.d.ts +142 -0
  270. package/dist/types/services/RolesService.d.ts +57 -0
  271. package/dist/types/services/SearchService.d.ts +172 -0
  272. package/dist/types/services/ServiceService.d.ts +170 -0
  273. package/dist/types/services/SkillsService.d.ts +377 -0
  274. package/dist/types/services/UserGroupsService.d.ts +49 -0
  275. package/package.json +39 -0
  276. package/rollup.config.js +113 -0
  277. package/src/core/ApiError.ts +25 -0
  278. package/src/core/ApiRequestOptions.ts +17 -0
  279. package/src/core/ApiResult.ts +11 -0
  280. package/src/core/CancelablePromise.ts +131 -0
  281. package/src/core/OpenAPI.ts +32 -0
  282. package/src/core/request.ts +322 -0
  283. package/src/index.ts +270 -0
  284. package/src/models/AWSTenantLaunchRequest.ts +25 -0
  285. package/src/models/AcceptanceEnum.ts +14 -0
  286. package/src/models/ActivateUserFreeTrial.ts +16 -0
  287. package/src/models/ActiveUsersData.ts +23 -0
  288. package/src/models/ActiveUsersList.ts +11 -0
  289. package/src/models/ActiveUsersPerCourse.ts +15 -0
  290. package/src/models/ActiveUsersPerCourseData.ts +19 -0
  291. package/src/models/ActivityAPI.ts +13 -0
  292. package/src/models/ActivityData.ts +43 -0
  293. package/src/models/App.ts +15 -0
  294. package/src/models/AppleSubscriptionStatusRequest.ts +8 -0
  295. package/src/models/AppleSubscriptionStatusView.ts +8 -0
  296. package/src/models/AppleVerifyTransactionId.ts +8 -0
  297. package/src/models/Assertion.ts +20 -0
  298. package/src/models/AssociateAccountResponse.ts +10 -0
  299. package/src/models/AssociateAppleAccount.ts +8 -0
  300. package/src/models/AuthToken.ts +15 -0
  301. package/src/models/Average.ts +9 -0
  302. package/src/models/AverageData.ts +11 -0
  303. package/src/models/AverageOvertime.ts +27 -0
  304. package/src/models/AvgCourseGradeWithCutoff.ts +9 -0
  305. package/src/models/AvgCourseGradeWithCutoffData.ts +15 -0
  306. package/src/models/BaseErrorResponse.ts +10 -0
  307. package/src/models/BaseResponse.ts +10 -0
  308. package/src/models/BlankEnum.ts +7 -0
  309. package/src/models/BulkCreateAssertion.ts +9 -0
  310. package/src/models/CampaignEnablement.ts +13 -0
  311. package/src/models/CampaignExclusion.ts +13 -0
  312. package/src/models/CeleryHeartbeat.ts +10 -0
  313. package/src/models/CeleryHeartbeatFail.ts +10 -0
  314. package/src/models/CeleryHeartbeatFailStatusEnum.ts +12 -0
  315. package/src/models/CeleryHeartbeatStatusEnum.ts +12 -0
  316. package/src/models/Company.ts +28 -0
  317. package/src/models/ContextResponse.ts +12 -0
  318. package/src/models/Count.ts +9 -0
  319. package/src/models/CountData.ts +11 -0
  320. package/src/models/CourseCompletionPerCourse.ts +11 -0
  321. package/src/models/CourseCompletionPerCourseData.ts +27 -0
  322. package/src/models/CourseCompletionSummaryDataOvertime.ts +23 -0
  323. package/src/models/CourseCompletionSummaryOvertime.ts +11 -0
  324. package/src/models/CourseGradeDetailBlock.ts +23 -0
  325. package/src/models/CourseGradeDetailSubSection.ts +28 -0
  326. package/src/models/CourseGradeSummary.ts +9 -0
  327. package/src/models/CourseGradeSummaryData.ts +23 -0
  328. package/src/models/CourseGradingDetail.ts +9 -0
  329. package/src/models/CourseGradingDetailData.ts +17 -0
  330. package/src/models/CoursePoint.ts +12 -0
  331. package/src/models/CourseSkill.ts +13 -0
  332. package/src/models/Credential.ts +33 -0
  333. package/src/models/DesiredRole.ts +9 -0
  334. package/src/models/DesiredSkill.ts +9 -0
  335. package/src/models/DetailedGradeSubsection.ts +27 -0
  336. package/src/models/DetailedGradeView.ts +9 -0
  337. package/src/models/DetailedGradeViewData.ts +17 -0
  338. package/src/models/Education.ts +35 -0
  339. package/src/models/EdxSignalReceiverRequest.ts +9 -0
  340. package/src/models/EngagementPerCourse.ts +11 -0
  341. package/src/models/EngagementPerCourseData.ts +31 -0
  342. package/src/models/Enrollments.ts +13 -0
  343. package/src/models/EnrollmentsData.ts +23 -0
  344. package/src/models/EnrollmentsPerUser.ts +11 -0
  345. package/src/models/EnrollmentsPerUserData.ts +23 -0
  346. package/src/models/ErrorResponse.ts +13 -0
  347. package/src/models/Experience.ts +34 -0
  348. package/src/models/FloatOverTime.ts +15 -0
  349. package/src/models/GCPTenantLaunchRequest.ts +29 -0
  350. package/src/models/GooglePayAccountResponse.ts +20 -0
  351. package/src/models/GooglePayAccountResponseStatusEnum.ts +12 -0
  352. package/src/models/GooglePayVerifyToken.ts +11 -0
  353. package/src/models/GradingPerUser.ts +13 -0
  354. package/src/models/GradingPerUserData.ts +31 -0
  355. package/src/models/GroupList.ts +11 -0
  356. package/src/models/GroupListData.ts +21 -0
  357. package/src/models/ImageUpload.ts +8 -0
  358. package/src/models/Institution.ts +25 -0
  359. package/src/models/InstitutionTypeEnum.ts +18 -0
  360. package/src/models/Issuer.ts +14 -0
  361. package/src/models/IssuerAuthority.ts +10 -0
  362. package/src/models/ItemTypeEnum.ts +22 -0
  363. package/src/models/LauncherViewPostRequest.ts +14 -0
  364. package/src/models/LearnerInformationAPI.ts +9 -0
  365. package/src/models/LearnerInformationAPIData.ts +88 -0
  366. package/src/models/LtiKey.ts +24 -0
  367. package/src/models/LtiLaunchGate.ts +13 -0
  368. package/src/models/LtiTool.ts +51 -0
  369. package/src/models/ManagerAuthToken.ts +18 -0
  370. package/src/models/MarkAllReadRequest.ts +14 -0
  371. package/src/models/MarkAllReadResponse.ts +12 -0
  372. package/src/models/MediaResource.ts +76 -0
  373. package/src/models/MediaTypeEnum.ts +18 -0
  374. package/src/models/ModeEnum.ts +14 -0
  375. package/src/models/NetRevenueOverTime.ts +13 -0
  376. package/src/models/NewPerLearnerList.ts +11 -0
  377. package/src/models/NewPerLearnerListData.ts +22 -0
  378. package/src/models/Notification.ts +19 -0
  379. package/src/models/NotificationCount.ts +9 -0
  380. package/src/models/NotificationPreview.ts +36 -0
  381. package/src/models/NotificationSource.ts +13 -0
  382. package/src/models/NotificationStatusEnum.ts +14 -0
  383. package/src/models/NotificationTemplateData.ts +31 -0
  384. package/src/models/OnboardingStatusUpdate.ts +12 -0
  385. package/src/models/Order.ts +27 -0
  386. package/src/models/OverTime.ts +8 -0
  387. package/src/models/OverTimeWithTotal.ts +27 -0
  388. package/src/models/OvertimeMeta.ts +35 -0
  389. package/src/models/OvertimeWithChangeInfo.ts +29 -0
  390. package/src/models/PaginatedUserAppList.ts +12 -0
  391. package/src/models/Pagination.ts +23 -0
  392. package/src/models/PatchedMediaResource.ts +76 -0
  393. package/src/models/PatchedNotification.ts +19 -0
  394. package/src/models/PatchedPlatformPublicMetadata.ts +13 -0
  395. package/src/models/PatchedSkillThreshold.ts +19 -0
  396. package/src/models/PerLearnerCourseLastAccessData.ts +35 -0
  397. package/src/models/PerLearnerCourseVideosWatched.ts +13 -0
  398. package/src/models/PerLearnerCourseVideosWatchedData.ts +19 -0
  399. package/src/models/PerLearnerLastAccess.ts +9 -0
  400. package/src/models/PerLearnerLastAccessData.ts +16 -0
  401. package/src/models/PerLearnerTimeSpentInCourseTree.ts +13 -0
  402. package/src/models/PerformanceGradesPerCourse.ts +11 -0
  403. package/src/models/PerformanceGradesPerCourseData.ts +27 -0
  404. package/src/models/PerlearnerCourseProgress.ts +9 -0
  405. package/src/models/PerlearnerCourseProgressData.ts +11 -0
  406. package/src/models/PerlearnerEngagementVideosData.ts +35 -0
  407. package/src/models/PerlearnerEngagementVideosWatchedPerCourse.ts +9 -0
  408. package/src/models/PerlearnerGradeSummary.ts +9 -0
  409. package/src/models/PerlearnerGradeSummaryData.ts +23 -0
  410. package/src/models/PerlearnerGradeWithCutOff.ts +9 -0
  411. package/src/models/PerlearnerGradeWithCutOffData.ts +15 -0
  412. package/src/models/PerlearnerGradingPerCourseAPI.ts +9 -0
  413. package/src/models/PerlearnerGradingPerCourseAPIData.ts +39 -0
  414. package/src/models/PerlearnerUserList.ts +11 -0
  415. package/src/models/PerlearnerUserListData.ts +39 -0
  416. package/src/models/Platform.ts +34 -0
  417. package/src/models/PlatformApiKey.ts +35 -0
  418. package/src/models/PlatformList.ts +34 -0
  419. package/src/models/PlatformListStatusEnum.ts +26 -0
  420. package/src/models/PlatformPublicMetadata.ts +13 -0
  421. package/src/models/PlatformUpdatePostRequest.ts +14 -0
  422. package/src/models/PointsPercentile.ts +13 -0
  423. package/src/models/PreviewResponse.ts +16 -0
  424. package/src/models/Product.ts +27 -0
  425. package/src/models/ProductTable.ts +31 -0
  426. package/src/models/Program.ts +29 -0
  427. package/src/models/ProgramTypeEnum.ts +22 -0
  428. package/src/models/Recipient.ts +13 -0
  429. package/src/models/RecommendationSearchAPI.ts +8 -0
  430. package/src/models/RedirectTokenRequest.ts +8 -0
  431. package/src/models/RedirectTokenResponse.ts +10 -0
  432. package/src/models/ReportCreate.ts +12 -0
  433. package/src/models/ReportData.ts +33 -0
  434. package/src/models/ReportDetail.ts +9 -0
  435. package/src/models/ReportList.ts +9 -0
  436. package/src/models/ReportRequest.ts +26 -0
  437. package/src/models/ReportStatus.ts +46 -0
  438. package/src/models/ReportedRole.ts +9 -0
  439. package/src/models/ReportedSkill.ts +9 -0
  440. package/src/models/Resource.ts +27 -0
  441. package/src/models/ResourceCreateUpdate.ts +47 -0
  442. package/src/models/ResourcePoint.ts +12 -0
  443. package/src/models/RevenueByProduct.ts +11 -0
  444. package/src/models/Role.ts +12 -0
  445. package/src/models/SendNotification.ts +11 -0
  446. package/src/models/SendResponse.ts +14 -0
  447. package/src/models/Skill.ts +12 -0
  448. package/src/models/SkillDetail.ts +14 -0
  449. package/src/models/SkillInfo.ts +28 -0
  450. package/src/models/SkillThreshold.ts +19 -0
  451. package/src/models/StateEnum.ts +26 -0
  452. package/src/models/StripeCheckoutSessionRequest.ts +59 -0
  453. package/src/models/StripeCheckoutSessionResponse.ts +11 -0
  454. package/src/models/StripeCustomerPortalRequest.ts +8 -0
  455. package/src/models/StripeCustomerPortalResponse.ts +8 -0
  456. package/src/models/StripeLocalProduct.ts +13 -0
  457. package/src/models/StripeSubscriptionRenewalRequest.ts +9 -0
  458. package/src/models/StripeSubscriptionRenewalResponse.ts +8 -0
  459. package/src/models/SubTimeChild.ts +23 -0
  460. package/src/models/Summary.ts +23 -0
  461. package/src/models/TenantLaunchError.ts +15 -0
  462. package/src/models/TenantLaunchFailed.ts +20 -0
  463. package/src/models/TenantLaunchRequest.ts +21 -0
  464. package/src/models/TenantLaunchResponse.ts +20 -0
  465. package/src/models/TimeChildData.ts +25 -0
  466. package/src/models/TimeDetail.ts +13 -0
  467. package/src/models/TimeDetailChild.ts +31 -0
  468. package/src/models/TimeDetailData.ts +29 -0
  469. package/src/models/TimeSpentByUsersInCourse.ts +11 -0
  470. package/src/models/TimeSpentByUsersInCourseData.ts +27 -0
  471. package/src/models/TimeSpentPerCourse.ts +11 -0
  472. package/src/models/TimeSpentPerCourseData.ts +31 -0
  473. package/src/models/TimeSpentPerUserResponse.ts +8 -0
  474. package/src/models/TimeSpentUpdateRequest.ts +39 -0
  475. package/src/models/TimeSpentUpdateResponse.ts +9 -0
  476. package/src/models/TokenProxyInput.ts +26 -0
  477. package/src/models/TokenProxyOutput.ts +12 -0
  478. package/src/models/TokenProxyOutputSerializerData.ts +25 -0
  479. package/src/models/TokenProxyUser.ts +30 -0
  480. package/src/models/TypeEnum.ts +22 -0
  481. package/src/models/UploadedImage.ts +10 -0
  482. package/src/models/UserApp.ts +32 -0
  483. package/src/models/UserDeleteAPIError.ts +8 -0
  484. package/src/models/UserDeleteAPIRequest.ts +8 -0
  485. package/src/models/UserDeleteAPIResponse.ts +8 -0
  486. package/src/models/UserInfo.ts +18 -0
  487. package/src/models/UserPlatformLink.ts +22 -0
  488. package/src/models/UserPlatformManagementListViewGetResponse.ts +11 -0
  489. package/src/models/UserPlatformViewPostRequest.ts +13 -0
  490. package/src/models/UserProxyBulkRequest.ts +8 -0
  491. package/src/models/UserProxyGetResponse.ts +13 -0
  492. package/src/models/UserProxyPostRequest.ts +12 -0
  493. package/src/models/UserProxyPostResponse.ts +13 -0
  494. package/src/models/UserSearchViewGetResponse.ts +11 -0
  495. package/src/models/UserSkill.ts +27 -0
  496. package/src/models/UserSkillPointsPercentile.ts +13 -0
  497. package/src/models/ValidateSourceResponse.ts +15 -0
  498. package/src/models/Value.ts +9 -0
  499. package/src/models/ValueData.ts +11 -0
  500. package/src/models/VerifyGCPMarketPlaceFailedResponse.ts +16 -0
  501. package/src/models/VerifyGCPMarketPlaceRequest.ts +8 -0
  502. package/src/models/VerifyGCPMarketPlaceResponse.ts +16 -0
  503. package/src/models/VideoBlock.ts +19 -0
  504. package/src/models/VideoEngagementPerCourse.ts +11 -0
  505. package/src/models/VideoEngagementPerCourseData.ts +35 -0
  506. package/src/models/VideosCount.ts +9 -0
  507. package/src/models/VideosCountData.ts +11 -0
  508. package/src/models/VideosInCourseSummary.ts +9 -0
  509. package/src/models/VideosInCourseSummaryData.ts +17 -0
  510. package/src/models/VideosSpecificCourse.ts +9 -0
  511. package/src/models/VideosSpecificCourseData.ts +31 -0
  512. package/src/models/VideosWatchedSubSection.ts +24 -0
  513. package/src/models/WatchedVideosPerCourse.ts +13 -0
  514. package/src/models/WatchedVideosPerCourseData.ts +23 -0
  515. package/src/models/WatchedVideosPerUser.ts +13 -0
  516. package/src/models/WatchedVideosPerUserData.ts +23 -0
  517. package/src/models/WhitelistedDomain.ts +9 -0
  518. package/src/services/AnalyticsService.ts +103 -0
  519. package/src/services/AudienceService.ts +602 -0
  520. package/src/services/CareerService.ts +568 -0
  521. package/src/services/CatalogService.ts +7769 -0
  522. package/src/services/CoreService.ts +1278 -0
  523. package/src/services/CredentialsService.ts +1649 -0
  524. package/src/services/DepartmentsService.ts +85 -0
  525. package/src/services/EngagementService.ts +907 -0
  526. package/src/services/FeaturesService.ts +126 -0
  527. package/src/services/FinanceService.ts +136 -0
  528. package/src/services/MediaResourcesService.ts +319 -0
  529. package/src/services/NotificationBuilderService.ts +133 -0
  530. package/src/services/NotificationService.ts +317 -0
  531. package/src/services/OverviewService.ts +324 -0
  532. package/src/services/PerformanceService.ts +329 -0
  533. package/src/services/PerlearnerService.ts +1009 -0
  534. package/src/services/PlatformService.ts +763 -0
  535. package/src/services/ProvidersService.ts +271 -0
  536. package/src/services/ProvisionService.ts +30 -0
  537. package/src/services/RecommendationsService.ts +31 -0
  538. package/src/services/ReportsService.ts +218 -0
  539. package/src/services/RolesService.ts +87 -0
  540. package/src/services/SearchService.ts +332 -0
  541. package/src/services/ServiceService.ts +320 -0
  542. package/src/services/SkillsService.ts +521 -0
  543. package/src/services/UserGroupsService.ts +91 -0
  544. package/tsconfig.json +15 -0
@@ -0,0 +1,332 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { CancelablePromise } from '../core/CancelablePromise';
6
+ import { OpenAPI } from '../core/OpenAPI';
7
+ import { request as __request } from '../core/request';
8
+ export class SearchService {
9
+ /**
10
+ * Search and filter content across the learning catalog
11
+ * @param allowSkillSearch Enable skill-based search
12
+ * @param alphabetical Sort alphabetically by name
13
+ * @param certificate Filter by certificate type
14
+ * @param content Content types to include in results
15
+ * @param courseId Filter by specific course ID
16
+ * @param duration Filter by course duration range
17
+ * @param language Filter by content language
18
+ * @param level Filter by difficulty level
19
+ * @param limit Number of results per page
20
+ * @param offset Starting position for pagination
21
+ * @param orderAscending Sort direction
22
+ * @param orderBy Field to sort results by
23
+ * @param pathwayId Filter by specific pathway ID
24
+ * @param price Filter by price/audit status
25
+ * @param programId Filter by specific program ID
26
+ * @param programType Filter by program type
27
+ * @param promotion Filter by promotion status
28
+ * @param query Search term to filter content by name or description
29
+ * @param resourceType Filter by resource type
30
+ * @param returnFacet Include facet data in response
31
+ * @param returnItems Include items in programs/pathways
32
+ * @param selfPaced Filter by course format
33
+ * @param skillId Filter by specific skill ID
34
+ * @param skills Filter by skills
35
+ * @param subject Filter by subject areas
36
+ * @param tags Filter by tags
37
+ * @param tenant Filter by tenant/organization
38
+ * @param topics Filter by topic areas
39
+ * @param updateFacet Force facet update
40
+ * @returns any
41
+ * @throws ApiError
42
+ */
43
+ public static searchCatalogRetrieve(
44
+ allowSkillSearch: boolean = false,
45
+ alphabetical: boolean = false,
46
+ certificate?: Array<string>,
47
+ content?: Array<string>,
48
+ courseId?: string,
49
+ duration?: Array<string>,
50
+ language?: Array<string>,
51
+ level?: Array<string>,
52
+ limit: number = 12,
53
+ offset?: number,
54
+ orderAscending: boolean = false,
55
+ orderBy?: string,
56
+ pathwayId?: string,
57
+ price?: string,
58
+ programId?: string,
59
+ programType?: Array<string>,
60
+ promotion?: Array<string>,
61
+ query?: string,
62
+ resourceType?: Array<string>,
63
+ returnFacet: boolean = true,
64
+ returnItems: boolean = false,
65
+ selfPaced?: Array<string>,
66
+ skillId?: string,
67
+ skills?: Array<string>,
68
+ subject?: Array<string>,
69
+ tags?: Array<string>,
70
+ tenant?: Array<string>,
71
+ topics?: Array<string>,
72
+ updateFacet?: string,
73
+ ): CancelablePromise<Record<string, any>> {
74
+ return __request(OpenAPI, {
75
+ method: 'GET',
76
+ url: '/api/search/catalog/',
77
+ query: {
78
+ 'allow_skill_search': allowSkillSearch,
79
+ 'alphabetical': alphabetical,
80
+ 'certificate': certificate,
81
+ 'content': content,
82
+ 'course_id': courseId,
83
+ 'duration': duration,
84
+ 'language': language,
85
+ 'level': level,
86
+ 'limit': limit,
87
+ 'offset': offset,
88
+ 'order_ascending': orderAscending,
89
+ 'order_by': orderBy,
90
+ 'pathway_id': pathwayId,
91
+ 'price': price,
92
+ 'program_id': programId,
93
+ 'program_type': programType,
94
+ 'promotion': promotion,
95
+ 'query': query,
96
+ 'resource_type': resourceType,
97
+ 'return_facet': returnFacet,
98
+ 'return_items': returnItems,
99
+ 'self_paced': selfPaced,
100
+ 'skill_id': skillId,
101
+ 'skills': skills,
102
+ 'subject': subject,
103
+ 'tags': tags,
104
+ 'tenant': tenant,
105
+ 'topics': topics,
106
+ 'update_facet': updateFacet,
107
+ },
108
+ });
109
+ }
110
+ /**
111
+ * Get personalized content for a specific user
112
+ * @param username
113
+ * @param allowSkillSearch Enable skill-based search
114
+ * @param alphabetical Sort alphabetically by name
115
+ * @param certificate Filter by certificate type
116
+ * @param content Content types to include in results
117
+ * @param courseId Retrieve a specific course by ID
118
+ * @param duration Filter by course duration range
119
+ * @param language Filter by content language
120
+ * @param level Filter by difficulty level
121
+ * @param limit Number of results per page
122
+ * @param offset Starting position for pagination
123
+ * @param orderAscending Sort direction
124
+ * @param orderBy Field to sort results by
125
+ * @param pathwayId Retrieve a specific pathway by ID
126
+ * @param price Filter by price/audit status
127
+ * @param programId Retrieve a specific program by ID
128
+ * @param programType Filter by program type
129
+ * @param promotion Filter by promotion status
130
+ * @param query Search term to filter content by name or description
131
+ * @param recommended Show only recommended content
132
+ * @param resourceId Retrieve a specific resource by ID
133
+ * @param resourceType Filter by resource type
134
+ * @param returnFacet Include facet data in response
135
+ * @param returnItems Include items in programs/pathways
136
+ * @param roleId Retrieve a specific role by ID
137
+ * @param selfPaced Filter by course format
138
+ * @param skillId Retrieve a specific skill by ID
139
+ * @param skills Filter by skills
140
+ * @param subject Filter by subject areas
141
+ * @param tags Filter by tags
142
+ * @param tenant Filter by tenant/organization
143
+ * @param topics Filter by topic areas
144
+ * @param updateFacet Force facet update
145
+ * @returns any
146
+ * @throws ApiError
147
+ */
148
+ public static searchPersonalizedCatalogRetrieve(
149
+ username: string,
150
+ allowSkillSearch: boolean = false,
151
+ alphabetical: boolean = false,
152
+ certificate?: Array<string>,
153
+ content?: Array<string>,
154
+ courseId?: string,
155
+ duration?: Array<string>,
156
+ language?: Array<string>,
157
+ level?: Array<string>,
158
+ limit: number = 12,
159
+ offset?: number,
160
+ orderAscending: boolean = false,
161
+ orderBy?: string,
162
+ pathwayId?: string,
163
+ price?: string,
164
+ programId?: string,
165
+ programType?: Array<string>,
166
+ promotion?: Array<string>,
167
+ query?: string,
168
+ recommended: boolean = false,
169
+ resourceId?: string,
170
+ resourceType?: Array<string>,
171
+ returnFacet: boolean = true,
172
+ returnItems: boolean = false,
173
+ roleId?: string,
174
+ selfPaced?: Array<string>,
175
+ skillId?: string,
176
+ skills?: Array<string>,
177
+ subject?: Array<string>,
178
+ tags?: Array<string>,
179
+ tenant?: Array<string>,
180
+ topics?: Array<string>,
181
+ updateFacet?: string,
182
+ ): CancelablePromise<Record<string, any>> {
183
+ return __request(OpenAPI, {
184
+ method: 'GET',
185
+ url: '/api/search/personalized-catalog/{username}/',
186
+ path: {
187
+ 'username': username,
188
+ },
189
+ query: {
190
+ 'allow_skill_search': allowSkillSearch,
191
+ 'alphabetical': alphabetical,
192
+ 'certificate': certificate,
193
+ 'content': content,
194
+ 'course_id': courseId,
195
+ 'duration': duration,
196
+ 'language': language,
197
+ 'level': level,
198
+ 'limit': limit,
199
+ 'offset': offset,
200
+ 'order_ascending': orderAscending,
201
+ 'order_by': orderBy,
202
+ 'pathway_id': pathwayId,
203
+ 'price': price,
204
+ 'program_id': programId,
205
+ 'program_type': programType,
206
+ 'promotion': promotion,
207
+ 'query': query,
208
+ 'recommended': recommended,
209
+ 'resource_id': resourceId,
210
+ 'resource_type': resourceType,
211
+ 'return_facet': returnFacet,
212
+ 'return_items': returnItems,
213
+ 'role_id': roleId,
214
+ 'self_paced': selfPaced,
215
+ 'skill_id': skillId,
216
+ 'skills': skills,
217
+ 'subject': subject,
218
+ 'tags': tags,
219
+ 'tenant': tenant,
220
+ 'topics': topics,
221
+ 'update_facet': updateFacet,
222
+ },
223
+ });
224
+ }
225
+ /**
226
+ * Search and filter users within a specific organization/tenant.
227
+ *
228
+ * This endpoint provides a search interface for discovering users within an organization,
229
+ * with support for filtering by departments, pagination, and faceted filtering.
230
+ *
231
+ * Path Parameters:
232
+ * org (str): The organization/tenant identifier
233
+ * username (str): The username of the user making the request
234
+ *
235
+ * Query Parameters:
236
+ * # Search parameters
237
+ * query (str, optional): Search term to filter users by name, username, or email
238
+ *
239
+ * # Department filtering
240
+ * department_mode (bool, optional): Enable department-based filtering (default: false)
241
+ * user_department (bool, optional): Legacy parameter for department_mode (default: false)
242
+ * department (list, optional): Filter by specific departments
243
+ *
244
+ * # Additional filters
245
+ * role (list, optional): Filter by user role
246
+ * status (list, optional): Filter by user status (active, inactive)
247
+ * joined_date (list, optional): Filter by join date range
248
+ * last_login (list, optional): Filter by last login date range
249
+ *
250
+ * # Pagination
251
+ * limit (int, optional): Number of results per page (default: 10)
252
+ * offset (int, optional): Starting position for pagination
253
+ *
254
+ * Returns:
255
+ * A JSON response containing:
256
+ * ```
257
+ * {
258
+ * "results": [
259
+ * {
260
+ * "id": 123,
261
+ * "username": "john.doe",
262
+ * "email": "john.doe@example.com",
263
+ * "first_name": "John",
264
+ * "last_name": "Doe",
265
+ * "full_name": "John Doe",
266
+ * "profile_image": "https://example.com/profiles/john-doe.jpg",
267
+ * "role": "Student",
268
+ * "departments": ["Computer Science", "Data Science"],
269
+ * "status": "active",
270
+ * "joined_date": "2023-01-15T12:00:00Z",
271
+ * "last_login": "2023-06-20T15:30:00Z",
272
+ * "metadata": {
273
+ * "location": "New York",
274
+ * "title": "Software Engineer",
275
+ * "bio": "Experienced software engineer with a passion for education"
276
+ * }
277
+ * },
278
+ * // Additional user objects...
279
+ * ],
280
+ * "count": 50,
281
+ * "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
282
+ * "previous": null,
283
+ * "current_page": 1,
284
+ * "total_pages": 5,
285
+ * "facets": {
286
+ * "role": [
287
+ * {"key": "Student", "doc_count": 30},
288
+ * {"key": "Instructor", "doc_count": 15},
289
+ * {"key": "Admin", "doc_count": 5}
290
+ * ],
291
+ * "department": [
292
+ * {"key": "Computer Science", "doc_count": 20},
293
+ * {"key": "Data Science", "doc_count": 15},
294
+ * {"key": "Business", "doc_count": 10},
295
+ * {"key": "Engineering", "doc_count": 5}
296
+ * ],
297
+ * "status": [
298
+ * {"key": "active", "doc_count": 45},
299
+ * {"key": "inactive", "doc_count": 5}
300
+ * ]
301
+ * }
302
+ * }
303
+ * ```
304
+ * Error Responses:
305
+ * 400 Bad Request: If the request parameters are invalid
306
+ * 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
307
+ * 404 Not Found: If the user or organization doesn't exist
308
+ * 500 Internal Server Error: If an unexpected error occurs
309
+ *
310
+ * Access Control:
311
+ * - The requesting user must have an active account in the specified organization
312
+ * - When department_mode is enabled, the user must be an admin of at least one department
313
+ * - Department filtering restricts results to users in departments where the requesting user is an admin
314
+ * @param org
315
+ * @param username
316
+ * @returns any No response body
317
+ * @throws ApiError
318
+ */
319
+ public static searchUsersOrgsUsersRetrieve(
320
+ org: string,
321
+ username: string,
322
+ ): CancelablePromise<any> {
323
+ return __request(OpenAPI, {
324
+ method: 'GET',
325
+ url: '/api/search/users/orgs/{org}/users/{username}/',
326
+ path: {
327
+ 'org': org,
328
+ 'username': username,
329
+ },
330
+ });
331
+ }
332
+ }
@@ -0,0 +1,320 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { StripeCheckoutSessionRequest } from '../models/StripeCheckoutSessionRequest';
6
+ import type { StripeCheckoutSessionResponse } from '../models/StripeCheckoutSessionResponse';
7
+ import type { StripeCustomerPortalRequest } from '../models/StripeCustomerPortalRequest';
8
+ import type { StripeCustomerPortalResponse } from '../models/StripeCustomerPortalResponse';
9
+ import type { StripeLocalProduct } from '../models/StripeLocalProduct';
10
+ import type { StripeSubscriptionRenewalRequest } from '../models/StripeSubscriptionRenewalRequest';
11
+ import type { StripeSubscriptionRenewalResponse } from '../models/StripeSubscriptionRenewalResponse';
12
+ import type { TenantLaunchRequest } from '../models/TenantLaunchRequest';
13
+ import type { TenantLaunchResponse } from '../models/TenantLaunchResponse';
14
+ import type { CancelablePromise } from '../core/CancelablePromise';
15
+ import { OpenAPI } from '../core/OpenAPI';
16
+ import { request as __request } from '../core/request';
17
+ export class ServiceService {
18
+ /**
19
+ * User/tenant creation API
20
+ *
21
+ * To create using any payment provider, ensure you use the StudentToken Authentication Mechanism
22
+ * and also include the correct `provider_key` in the request body:
23
+ *
24
+ * ```
25
+ * apple_transaction_id: str
26
+ * stripe_checkout_id: str
27
+ * x_gcp_marketplace_token: str
28
+ * aws_transaction_id: str
29
+ * google_pay_transaction_id: str
30
+ * ```
31
+ *
32
+ * To create a tenant without a payment provider, call the API without ny of the above provider keys in the request body
33
+ * @param requestBody
34
+ * @returns TenantLaunchResponse
35
+ * @throws ApiError
36
+ */
37
+ public static serviceLaunchTenantCreate(
38
+ requestBody: TenantLaunchRequest,
39
+ ): CancelablePromise<TenantLaunchResponse> {
40
+ return __request(OpenAPI, {
41
+ method: 'POST',
42
+ url: '/api/service/launch/tenant/',
43
+ body: requestBody,
44
+ mediaType: 'application/json',
45
+ });
46
+ }
47
+ /**
48
+ * User creation flow
49
+ * @returns any No response body
50
+ * @throws ApiError
51
+ */
52
+ public static serviceManageUserCreate(): CancelablePromise<any> {
53
+ return __request(OpenAPI, {
54
+ method: 'POST',
55
+ url: '/api/service/manage/user/',
56
+ });
57
+ }
58
+ /**
59
+ * Make user tenant admin
60
+ * @returns any No response body
61
+ * @throws ApiError
62
+ */
63
+ public static serviceManageUserRoleCreate(): CancelablePromise<any> {
64
+ return __request(OpenAPI, {
65
+ method: 'POST',
66
+ url: '/api/service/manage/user/role/',
67
+ });
68
+ }
69
+ /**
70
+ * Stripe checkout session API View for user upgrade
71
+ *
72
+ * Request the following fields:
73
+ *
74
+ * - tenant
75
+ * - sku
76
+ * - mode
77
+ * - success_url
78
+ * - cancel_url
79
+ *
80
+ * Response:
81
+ * {
82
+ * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
83
+ * }
84
+ * @param org
85
+ * @param userId
86
+ * @param requestBody
87
+ * @returns StripeCheckoutSessionResponse
88
+ * @throws ApiError
89
+ */
90
+ public static serviceOrgsUsersStripeCheckoutSessionCreate(
91
+ org: string,
92
+ userId: string,
93
+ requestBody: StripeCheckoutSessionRequest,
94
+ ): CancelablePromise<StripeCheckoutSessionResponse> {
95
+ return __request(OpenAPI, {
96
+ method: 'POST',
97
+ url: '/api/service/orgs/{org}/users/{user_id}/stripe/checkout-session/',
98
+ path: {
99
+ 'org': org,
100
+ 'user_id': userId,
101
+ },
102
+ body: requestBody,
103
+ mediaType: 'application/json',
104
+ });
105
+ }
106
+ /**
107
+ * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
108
+ * @param org
109
+ * @param userId
110
+ * @param requestBody
111
+ * @returns StripeCustomerPortalResponse
112
+ * @throws ApiError
113
+ */
114
+ public static serviceOrgsUsersStripeCustomerPortalCreate(
115
+ org: string,
116
+ userId: string,
117
+ requestBody: StripeCustomerPortalRequest,
118
+ ): CancelablePromise<StripeCustomerPortalResponse> {
119
+ return __request(OpenAPI, {
120
+ method: 'POST',
121
+ url: '/api/service/orgs/{org}/users/{user_id}/stripe/customer-portal/',
122
+ path: {
123
+ 'org': org,
124
+ 'user_id': userId,
125
+ },
126
+ body: requestBody,
127
+ mediaType: 'application/json',
128
+ });
129
+ }
130
+ /**
131
+ * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
132
+ * @param org
133
+ * @param userId
134
+ * @returns StripeLocalProduct
135
+ * @throws ApiError
136
+ */
137
+ public static serviceOrgsUsersStripeProductsRetrieve(
138
+ org: string,
139
+ userId: string,
140
+ ): CancelablePromise<StripeLocalProduct> {
141
+ return __request(OpenAPI, {
142
+ method: 'GET',
143
+ url: '/api/service/orgs/{org}/users/{user_id}/stripe/products/',
144
+ path: {
145
+ 'org': org,
146
+ 'user_id': userId,
147
+ },
148
+ });
149
+ }
150
+ /**
151
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
152
+ * @param org
153
+ * @param userId
154
+ * @returns any No response body
155
+ * @throws ApiError
156
+ */
157
+ public static serviceOrgsUsersStripeProductsManageCreate(
158
+ org: string,
159
+ userId: string,
160
+ ): CancelablePromise<any> {
161
+ return __request(OpenAPI, {
162
+ method: 'POST',
163
+ url: '/api/service/orgs/{org}/users/{user_id}/stripe/products/manage/',
164
+ path: {
165
+ 'org': org,
166
+ 'user_id': userId,
167
+ },
168
+ });
169
+ }
170
+ /**
171
+ * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
172
+ * @param org
173
+ * @param userId
174
+ * @param requestBody
175
+ * @returns StripeSubscriptionRenewalResponse
176
+ * @throws ApiError
177
+ */
178
+ public static serviceOrgsUsersStripeSubscriptionRenewalCreate(
179
+ org: string,
180
+ userId: string,
181
+ requestBody: StripeSubscriptionRenewalRequest,
182
+ ): CancelablePromise<StripeSubscriptionRenewalResponse> {
183
+ return __request(OpenAPI, {
184
+ method: 'POST',
185
+ url: '/api/service/orgs/{org}/users/{user_id}/stripe/subscription-renewal/',
186
+ path: {
187
+ 'org': org,
188
+ 'user_id': userId,
189
+ },
190
+ body: requestBody,
191
+ mediaType: 'application/json',
192
+ });
193
+ }
194
+ /**
195
+ * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
196
+ * @param org
197
+ * @param userId
198
+ * @returns any No response body
199
+ * @throws ApiError
200
+ */
201
+ public static serviceOrgsUsersStripeSubscriptionsRetrieve(
202
+ org: string,
203
+ userId: string,
204
+ ): CancelablePromise<any> {
205
+ return __request(OpenAPI, {
206
+ method: 'GET',
207
+ url: '/api/service/orgs/{org}/users/{user_id}/stripe/subscriptions/',
208
+ path: {
209
+ 'org': org,
210
+ 'user_id': userId,
211
+ },
212
+ });
213
+ }
214
+ /**
215
+ * Handle course payment callback after successful Stripe checkout.
216
+ * Enrolls the user in the purchased course.
217
+ *
218
+ * URL Parameters:
219
+ * - stripe_checkout_id: The local Checkout Session UUID
220
+ *
221
+ * Response:
222
+ * - Redirect: Successfully processed course enrollment
223
+ * - 404: Checkout session not found
224
+ * - 400: Invalid checkout session or product
225
+ * - 500: Server error during processing
226
+ * @param platformKey
227
+ * @returns any No response body
228
+ * @throws ApiError
229
+ */
230
+ public static serviceOrgsStripeCoursePaymentCallbackRetrieve(
231
+ platformKey: string,
232
+ ): CancelablePromise<any> {
233
+ return __request(OpenAPI, {
234
+ method: 'GET',
235
+ url: '/api/service/orgs/{platform_key}/stripe/course-payment-callback/',
236
+ path: {
237
+ 'platform_key': platformKey,
238
+ },
239
+ });
240
+ }
241
+ /**
242
+ * @param checkoutUuid
243
+ * @returns any No response body
244
+ * @throws ApiError
245
+ */
246
+ public static serviceStripeCheckoutRetrieve(
247
+ checkoutUuid: string,
248
+ ): CancelablePromise<any> {
249
+ return __request(OpenAPI, {
250
+ method: 'GET',
251
+ url: '/api/service/stripe/checkout/{checkout_uuid}/',
252
+ path: {
253
+ 'checkout_uuid': checkoutUuid,
254
+ },
255
+ });
256
+ }
257
+ /**
258
+ * Stripe free trial checkout session. No user auth
259
+ *
260
+ * Request the following fields:
261
+ *
262
+ * - success_url
263
+ * - cancel_url
264
+ * - product
265
+ *
266
+ * Response:
267
+ * {
268
+ * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
269
+ * }
270
+ * @param requestBody
271
+ * @returns StripeCheckoutSessionResponse
272
+ * @throws ApiError
273
+ */
274
+ public static serviceStripeCheckoutFreeTrialCreate(
275
+ requestBody: StripeCheckoutSessionResponse,
276
+ ): CancelablePromise<StripeCheckoutSessionResponse> {
277
+ return __request(OpenAPI, {
278
+ method: 'POST',
279
+ url: '/api/service/stripe/checkout/free-trial/',
280
+ body: requestBody,
281
+ mediaType: 'application/json',
282
+ });
283
+ }
284
+ /**
285
+ * Check if tenant exists or not
286
+ * @returns any No response body
287
+ * @throws ApiError
288
+ */
289
+ public static serviceTenantValidationCreate(): CancelablePromise<any> {
290
+ return __request(OpenAPI, {
291
+ method: 'POST',
292
+ url: '/api/service/tenant/validation/',
293
+ });
294
+ }
295
+ /**
296
+ * GET
297
+ * Gets site hash_key from
298
+ * or
299
+ * Gets site_id form hash_key
300
+ * @returns any No response body
301
+ * @throws ApiError
302
+ */
303
+ public static serviceTokenRetrieve(): CancelablePromise<any> {
304
+ return __request(OpenAPI, {
305
+ method: 'GET',
306
+ url: '/api/service/token/',
307
+ });
308
+ }
309
+ /**
310
+ * Check if tenant exists or not
311
+ * @returns any No response body
312
+ * @throws ApiError
313
+ */
314
+ public static serviceUserValidationCreate(): CancelablePromise<any> {
315
+ return __request(OpenAPI, {
316
+ method: 'POST',
317
+ url: '/api/service/user/validation/',
318
+ });
319
+ }
320
+ }