@iblai/iblai-api 3.34.5-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 (382) hide show
  1. package/README.md +222 -0
  2. package/dist/index.cjs.js +7291 -0
  3. package/dist/index.cjs.js.map +1 -0
  4. package/dist/index.esm.js +7267 -0
  5. package/dist/index.esm.js.map +1 -0
  6. package/dist/index.umd.js +7297 -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 +183 -0
  15. package/dist/types/models/AcceptanceEnum.d.ts +10 -0
  16. package/dist/types/models/ActiveUsersData.d.ts +18 -0
  17. package/dist/types/models/ActiveUsersList.d.ts +6 -0
  18. package/dist/types/models/ActiveUsersPerCourse.d.ts +10 -0
  19. package/dist/types/models/ActiveUsersPerCourseData.d.ts +14 -0
  20. package/dist/types/models/ActivityAPI.d.ts +8 -0
  21. package/dist/types/models/ActivityData.d.ts +38 -0
  22. package/dist/types/models/Assertion.d.ts +15 -0
  23. package/dist/types/models/Average.d.ts +4 -0
  24. package/dist/types/models/AverageData.d.ts +6 -0
  25. package/dist/types/models/AverageOvertime.d.ts +22 -0
  26. package/dist/types/models/AvgCourseGradeWithCutoff.d.ts +4 -0
  27. package/dist/types/models/AvgCourseGradeWithCutoffData.d.ts +10 -0
  28. package/dist/types/models/BlankEnum.d.ts +2 -0
  29. package/dist/types/models/BulkCreateAssertion.d.ts +4 -0
  30. package/dist/types/models/CampaignEnablement.d.ts +8 -0
  31. package/dist/types/models/CampaignExclusion.d.ts +8 -0
  32. package/dist/types/models/Company.d.ts +23 -0
  33. package/dist/types/models/ContextResponse.d.ts +7 -0
  34. package/dist/types/models/Count.d.ts +4 -0
  35. package/dist/types/models/CountData.d.ts +6 -0
  36. package/dist/types/models/CourseCompletionPerCourse.d.ts +6 -0
  37. package/dist/types/models/CourseCompletionPerCourseData.d.ts +22 -0
  38. package/dist/types/models/CourseCompletionSummaryDataOvertime.d.ts +18 -0
  39. package/dist/types/models/CourseCompletionSummaryOvertime.d.ts +6 -0
  40. package/dist/types/models/CourseGradeDetailBlock.d.ts +18 -0
  41. package/dist/types/models/CourseGradeDetailSubSection.d.ts +23 -0
  42. package/dist/types/models/CourseGradeSummary.d.ts +4 -0
  43. package/dist/types/models/CourseGradeSummaryData.d.ts +18 -0
  44. package/dist/types/models/CourseGradingDetail.d.ts +4 -0
  45. package/dist/types/models/CourseGradingDetailData.d.ts +12 -0
  46. package/dist/types/models/CoursePoint.d.ts +7 -0
  47. package/dist/types/models/CourseSkill.d.ts +8 -0
  48. package/dist/types/models/Credential.d.ts +28 -0
  49. package/dist/types/models/DesiredSkill.d.ts +4 -0
  50. package/dist/types/models/DetailedGradeSubsection.d.ts +22 -0
  51. package/dist/types/models/DetailedGradeView.d.ts +4 -0
  52. package/dist/types/models/DetailedGradeViewData.d.ts +12 -0
  53. package/dist/types/models/Education.d.ts +30 -0
  54. package/dist/types/models/EngagementPerCourse.d.ts +6 -0
  55. package/dist/types/models/EngagementPerCourseData.d.ts +26 -0
  56. package/dist/types/models/Enrollments.d.ts +8 -0
  57. package/dist/types/models/EnrollmentsData.d.ts +18 -0
  58. package/dist/types/models/EnrollmentsPerUser.d.ts +6 -0
  59. package/dist/types/models/EnrollmentsPerUserData.d.ts +18 -0
  60. package/dist/types/models/ErrorResponse.d.ts +8 -0
  61. package/dist/types/models/Experience.d.ts +29 -0
  62. package/dist/types/models/FloatOverTime.d.ts +10 -0
  63. package/dist/types/models/GradingPerUser.d.ts +8 -0
  64. package/dist/types/models/GradingPerUserData.d.ts +26 -0
  65. package/dist/types/models/GroupList.d.ts +6 -0
  66. package/dist/types/models/GroupListData.d.ts +16 -0
  67. package/dist/types/models/ImageUpload.d.ts +3 -0
  68. package/dist/types/models/Institution.d.ts +20 -0
  69. package/dist/types/models/InstitutionTypeEnum.d.ts +14 -0
  70. package/dist/types/models/Issuer.d.ts +9 -0
  71. package/dist/types/models/IssuerAuthority.d.ts +5 -0
  72. package/dist/types/models/LearnerInformationAPI.d.ts +4 -0
  73. package/dist/types/models/LearnerInformationAPIData.d.ts +83 -0
  74. package/dist/types/models/LtiKey.d.ts +19 -0
  75. package/dist/types/models/LtiLaunchGate.d.ts +8 -0
  76. package/dist/types/models/LtiTool.d.ts +46 -0
  77. package/dist/types/models/NetRevenueOverTime.d.ts +8 -0
  78. package/dist/types/models/NewPerLearnerList.d.ts +6 -0
  79. package/dist/types/models/NewPerLearnerListData.d.ts +17 -0
  80. package/dist/types/models/Notification.d.ts +13 -0
  81. package/dist/types/models/NotificationCount.d.ts +4 -0
  82. package/dist/types/models/NotificationPreview.d.ts +31 -0
  83. package/dist/types/models/NotificationSource.d.ts +8 -0
  84. package/dist/types/models/NotificationTemplateData.d.ts +26 -0
  85. package/dist/types/models/Order.d.ts +22 -0
  86. package/dist/types/models/OverTime.d.ts +3 -0
  87. package/dist/types/models/OverTimeWithTotal.d.ts +22 -0
  88. package/dist/types/models/OvertimeMeta.d.ts +30 -0
  89. package/dist/types/models/OvertimeWithChangeInfo.d.ts +24 -0
  90. package/dist/types/models/Pagination.d.ts +18 -0
  91. package/dist/types/models/PatchedNotification.d.ts +13 -0
  92. package/dist/types/models/PatchedPlatformPublicMetadata.d.ts +8 -0
  93. package/dist/types/models/PatchedSkillThreshold.d.ts +14 -0
  94. package/dist/types/models/PerLearnerCourseLastAccessData.d.ts +30 -0
  95. package/dist/types/models/PerLearnerCourseVideosWatched.d.ts +8 -0
  96. package/dist/types/models/PerLearnerCourseVideosWatchedData.d.ts +14 -0
  97. package/dist/types/models/PerLearnerLastAccess.d.ts +4 -0
  98. package/dist/types/models/PerLearnerLastAccessData.d.ts +11 -0
  99. package/dist/types/models/PerLearnerTimeSpentInCourseTree.d.ts +8 -0
  100. package/dist/types/models/PerformanceGradesPerCourse.d.ts +6 -0
  101. package/dist/types/models/PerformanceGradesPerCourseData.d.ts +22 -0
  102. package/dist/types/models/PerlearnerCourseProgress.d.ts +4 -0
  103. package/dist/types/models/PerlearnerCourseProgressData.d.ts +6 -0
  104. package/dist/types/models/PerlearnerEngagementVideosData.d.ts +30 -0
  105. package/dist/types/models/PerlearnerEngagementVideosWatchedPerCourse.d.ts +4 -0
  106. package/dist/types/models/PerlearnerGradeSummary.d.ts +4 -0
  107. package/dist/types/models/PerlearnerGradeSummaryData.d.ts +18 -0
  108. package/dist/types/models/PerlearnerGradeWithCutOff.d.ts +4 -0
  109. package/dist/types/models/PerlearnerGradeWithCutOffData.d.ts +10 -0
  110. package/dist/types/models/PerlearnerGradingPerCourseAPI.d.ts +4 -0
  111. package/dist/types/models/PerlearnerGradingPerCourseAPIData.d.ts +34 -0
  112. package/dist/types/models/PerlearnerUserList.d.ts +6 -0
  113. package/dist/types/models/PerlearnerUserListData.d.ts +34 -0
  114. package/dist/types/models/PlatformPublicMetadata.d.ts +8 -0
  115. package/dist/types/models/PointsPercentile.d.ts +8 -0
  116. package/dist/types/models/PreviewResponse.d.ts +11 -0
  117. package/dist/types/models/Product.d.ts +22 -0
  118. package/dist/types/models/ProductTable.d.ts +26 -0
  119. package/dist/types/models/Program.d.ts +24 -0
  120. package/dist/types/models/ProgramTypeEnum.d.ts +18 -0
  121. package/dist/types/models/Recipient.d.ts +8 -0
  122. package/dist/types/models/RecommendationSearchAPI.d.ts +3 -0
  123. package/dist/types/models/RedirectTokenRequest.d.ts +3 -0
  124. package/dist/types/models/RedirectTokenResponse.d.ts +5 -0
  125. package/dist/types/models/ReportCreate.d.ts +7 -0
  126. package/dist/types/models/ReportData.d.ts +28 -0
  127. package/dist/types/models/ReportDetail.d.ts +4 -0
  128. package/dist/types/models/ReportList.d.ts +4 -0
  129. package/dist/types/models/ReportRequest.d.ts +21 -0
  130. package/dist/types/models/ReportStatus.d.ts +41 -0
  131. package/dist/types/models/ReportedSkill.d.ts +4 -0
  132. package/dist/types/models/ResourcePoint.d.ts +7 -0
  133. package/dist/types/models/RevenueByProduct.d.ts +6 -0
  134. package/dist/types/models/SendNotification.d.ts +6 -0
  135. package/dist/types/models/SendResponse.d.ts +9 -0
  136. package/dist/types/models/Skill.d.ts +7 -0
  137. package/dist/types/models/SkillDetail.d.ts +9 -0
  138. package/dist/types/models/SkillInfo.d.ts +23 -0
  139. package/dist/types/models/SkillThreshold.d.ts +14 -0
  140. package/dist/types/models/StateEnum.d.ts +22 -0
  141. package/dist/types/models/StatusEnum.d.ts +10 -0
  142. package/dist/types/models/SubTimeChild.d.ts +18 -0
  143. package/dist/types/models/Summary.d.ts +18 -0
  144. package/dist/types/models/TimeChildData.d.ts +20 -0
  145. package/dist/types/models/TimeDetail.d.ts +8 -0
  146. package/dist/types/models/TimeDetailChild.d.ts +26 -0
  147. package/dist/types/models/TimeDetailData.d.ts +24 -0
  148. package/dist/types/models/TimeSpentByUsersInCourse.d.ts +6 -0
  149. package/dist/types/models/TimeSpentByUsersInCourseData.d.ts +22 -0
  150. package/dist/types/models/TimeSpentPerCourse.d.ts +6 -0
  151. package/dist/types/models/TimeSpentPerCourseData.d.ts +26 -0
  152. package/dist/types/models/TimeSpentPerUserResponse.d.ts +3 -0
  153. package/dist/types/models/TimeSpentUpdateRequest.d.ts +11 -0
  154. package/dist/types/models/TimeSpentUpdateResponse.d.ts +4 -0
  155. package/dist/types/models/TypeEnum.d.ts +18 -0
  156. package/dist/types/models/UploadedImage.d.ts +5 -0
  157. package/dist/types/models/UserInfo.d.ts +13 -0
  158. package/dist/types/models/UserSkill.d.ts +22 -0
  159. package/dist/types/models/UserSkillPointsPercentile.d.ts +8 -0
  160. package/dist/types/models/ValidateSourceResponse.d.ts +10 -0
  161. package/dist/types/models/Value.d.ts +4 -0
  162. package/dist/types/models/ValueData.d.ts +6 -0
  163. package/dist/types/models/VideoBlock.d.ts +14 -0
  164. package/dist/types/models/VideoEngagementPerCourse.d.ts +6 -0
  165. package/dist/types/models/VideoEngagementPerCourseData.d.ts +30 -0
  166. package/dist/types/models/VideosCount.d.ts +4 -0
  167. package/dist/types/models/VideosCountData.d.ts +6 -0
  168. package/dist/types/models/VideosInCourseSummary.d.ts +4 -0
  169. package/dist/types/models/VideosInCourseSummaryData.d.ts +12 -0
  170. package/dist/types/models/VideosSpecificCourse.d.ts +4 -0
  171. package/dist/types/models/VideosSpecificCourseData.d.ts +26 -0
  172. package/dist/types/models/VideosWatchedSubSection.d.ts +19 -0
  173. package/dist/types/models/WatchedVideosPerUser.d.ts +8 -0
  174. package/dist/types/models/WatchedVideosPerUserData.d.ts +18 -0
  175. package/dist/types/services/AnalyticsService.d.ts +51 -0
  176. package/dist/types/services/AudienceService.d.ts +348 -0
  177. package/dist/types/services/CareerService.d.ts +210 -0
  178. package/dist/types/services/CoreService.d.ts +196 -0
  179. package/dist/types/services/CredentialsService.d.ts +1184 -0
  180. package/dist/types/services/DepartmentsService.d.ts +43 -0
  181. package/dist/types/services/EngagementService.d.ts +467 -0
  182. package/dist/types/services/FinanceService.d.ts +52 -0
  183. package/dist/types/services/NotificationBuilderService.d.ts +58 -0
  184. package/dist/types/services/NotificationService.d.ts +118 -0
  185. package/dist/types/services/OverviewService.d.ts +184 -0
  186. package/dist/types/services/PerformanceService.d.ts +183 -0
  187. package/dist/types/services/PerlearnerService.d.ts +501 -0
  188. package/dist/types/services/PlatformService.d.ts +77 -0
  189. package/dist/types/services/RecommendationsService.d.ts +13 -0
  190. package/dist/types/services/ReportsService.d.ts +142 -0
  191. package/dist/types/services/SearchService.d.ts +276 -0
  192. package/dist/types/services/SkillsService.d.ts +377 -0
  193. package/dist/types/services/UserGroupsService.d.ts +49 -0
  194. package/package.json +39 -0
  195. package/rollup.config.js +113 -0
  196. package/src/core/ApiError.ts +25 -0
  197. package/src/core/ApiRequestOptions.ts +17 -0
  198. package/src/core/ApiResult.ts +11 -0
  199. package/src/core/CancelablePromise.ts +131 -0
  200. package/src/core/OpenAPI.ts +32 -0
  201. package/src/core/request.ts +322 -0
  202. package/src/index.ts +189 -0
  203. package/src/models/AcceptanceEnum.ts +14 -0
  204. package/src/models/ActiveUsersData.ts +23 -0
  205. package/src/models/ActiveUsersList.ts +11 -0
  206. package/src/models/ActiveUsersPerCourse.ts +15 -0
  207. package/src/models/ActiveUsersPerCourseData.ts +19 -0
  208. package/src/models/ActivityAPI.ts +13 -0
  209. package/src/models/ActivityData.ts +43 -0
  210. package/src/models/Assertion.ts +20 -0
  211. package/src/models/Average.ts +9 -0
  212. package/src/models/AverageData.ts +11 -0
  213. package/src/models/AverageOvertime.ts +27 -0
  214. package/src/models/AvgCourseGradeWithCutoff.ts +9 -0
  215. package/src/models/AvgCourseGradeWithCutoffData.ts +15 -0
  216. package/src/models/BlankEnum.ts +7 -0
  217. package/src/models/BulkCreateAssertion.ts +9 -0
  218. package/src/models/CampaignEnablement.ts +13 -0
  219. package/src/models/CampaignExclusion.ts +13 -0
  220. package/src/models/Company.ts +28 -0
  221. package/src/models/ContextResponse.ts +12 -0
  222. package/src/models/Count.ts +9 -0
  223. package/src/models/CountData.ts +11 -0
  224. package/src/models/CourseCompletionPerCourse.ts +11 -0
  225. package/src/models/CourseCompletionPerCourseData.ts +27 -0
  226. package/src/models/CourseCompletionSummaryDataOvertime.ts +23 -0
  227. package/src/models/CourseCompletionSummaryOvertime.ts +11 -0
  228. package/src/models/CourseGradeDetailBlock.ts +23 -0
  229. package/src/models/CourseGradeDetailSubSection.ts +28 -0
  230. package/src/models/CourseGradeSummary.ts +9 -0
  231. package/src/models/CourseGradeSummaryData.ts +23 -0
  232. package/src/models/CourseGradingDetail.ts +9 -0
  233. package/src/models/CourseGradingDetailData.ts +17 -0
  234. package/src/models/CoursePoint.ts +12 -0
  235. package/src/models/CourseSkill.ts +13 -0
  236. package/src/models/Credential.ts +33 -0
  237. package/src/models/DesiredSkill.ts +9 -0
  238. package/src/models/DetailedGradeSubsection.ts +27 -0
  239. package/src/models/DetailedGradeView.ts +9 -0
  240. package/src/models/DetailedGradeViewData.ts +17 -0
  241. package/src/models/Education.ts +35 -0
  242. package/src/models/EngagementPerCourse.ts +11 -0
  243. package/src/models/EngagementPerCourseData.ts +31 -0
  244. package/src/models/Enrollments.ts +13 -0
  245. package/src/models/EnrollmentsData.ts +23 -0
  246. package/src/models/EnrollmentsPerUser.ts +11 -0
  247. package/src/models/EnrollmentsPerUserData.ts +23 -0
  248. package/src/models/ErrorResponse.ts +13 -0
  249. package/src/models/Experience.ts +34 -0
  250. package/src/models/FloatOverTime.ts +15 -0
  251. package/src/models/GradingPerUser.ts +13 -0
  252. package/src/models/GradingPerUserData.ts +31 -0
  253. package/src/models/GroupList.ts +11 -0
  254. package/src/models/GroupListData.ts +21 -0
  255. package/src/models/ImageUpload.ts +8 -0
  256. package/src/models/Institution.ts +25 -0
  257. package/src/models/InstitutionTypeEnum.ts +18 -0
  258. package/src/models/Issuer.ts +14 -0
  259. package/src/models/IssuerAuthority.ts +10 -0
  260. package/src/models/LearnerInformationAPI.ts +9 -0
  261. package/src/models/LearnerInformationAPIData.ts +88 -0
  262. package/src/models/LtiKey.ts +24 -0
  263. package/src/models/LtiLaunchGate.ts +13 -0
  264. package/src/models/LtiTool.ts +51 -0
  265. package/src/models/NetRevenueOverTime.ts +13 -0
  266. package/src/models/NewPerLearnerList.ts +11 -0
  267. package/src/models/NewPerLearnerListData.ts +22 -0
  268. package/src/models/Notification.ts +18 -0
  269. package/src/models/NotificationCount.ts +9 -0
  270. package/src/models/NotificationPreview.ts +36 -0
  271. package/src/models/NotificationSource.ts +13 -0
  272. package/src/models/NotificationTemplateData.ts +31 -0
  273. package/src/models/Order.ts +27 -0
  274. package/src/models/OverTime.ts +8 -0
  275. package/src/models/OverTimeWithTotal.ts +27 -0
  276. package/src/models/OvertimeMeta.ts +35 -0
  277. package/src/models/OvertimeWithChangeInfo.ts +29 -0
  278. package/src/models/Pagination.ts +23 -0
  279. package/src/models/PatchedNotification.ts +18 -0
  280. package/src/models/PatchedPlatformPublicMetadata.ts +13 -0
  281. package/src/models/PatchedSkillThreshold.ts +19 -0
  282. package/src/models/PerLearnerCourseLastAccessData.ts +35 -0
  283. package/src/models/PerLearnerCourseVideosWatched.ts +13 -0
  284. package/src/models/PerLearnerCourseVideosWatchedData.ts +19 -0
  285. package/src/models/PerLearnerLastAccess.ts +9 -0
  286. package/src/models/PerLearnerLastAccessData.ts +16 -0
  287. package/src/models/PerLearnerTimeSpentInCourseTree.ts +13 -0
  288. package/src/models/PerformanceGradesPerCourse.ts +11 -0
  289. package/src/models/PerformanceGradesPerCourseData.ts +27 -0
  290. package/src/models/PerlearnerCourseProgress.ts +9 -0
  291. package/src/models/PerlearnerCourseProgressData.ts +11 -0
  292. package/src/models/PerlearnerEngagementVideosData.ts +35 -0
  293. package/src/models/PerlearnerEngagementVideosWatchedPerCourse.ts +9 -0
  294. package/src/models/PerlearnerGradeSummary.ts +9 -0
  295. package/src/models/PerlearnerGradeSummaryData.ts +23 -0
  296. package/src/models/PerlearnerGradeWithCutOff.ts +9 -0
  297. package/src/models/PerlearnerGradeWithCutOffData.ts +15 -0
  298. package/src/models/PerlearnerGradingPerCourseAPI.ts +9 -0
  299. package/src/models/PerlearnerGradingPerCourseAPIData.ts +39 -0
  300. package/src/models/PerlearnerUserList.ts +11 -0
  301. package/src/models/PerlearnerUserListData.ts +39 -0
  302. package/src/models/PlatformPublicMetadata.ts +13 -0
  303. package/src/models/PointsPercentile.ts +13 -0
  304. package/src/models/PreviewResponse.ts +16 -0
  305. package/src/models/Product.ts +27 -0
  306. package/src/models/ProductTable.ts +31 -0
  307. package/src/models/Program.ts +29 -0
  308. package/src/models/ProgramTypeEnum.ts +22 -0
  309. package/src/models/Recipient.ts +13 -0
  310. package/src/models/RecommendationSearchAPI.ts +8 -0
  311. package/src/models/RedirectTokenRequest.ts +8 -0
  312. package/src/models/RedirectTokenResponse.ts +10 -0
  313. package/src/models/ReportCreate.ts +12 -0
  314. package/src/models/ReportData.ts +33 -0
  315. package/src/models/ReportDetail.ts +9 -0
  316. package/src/models/ReportList.ts +9 -0
  317. package/src/models/ReportRequest.ts +26 -0
  318. package/src/models/ReportStatus.ts +46 -0
  319. package/src/models/ReportedSkill.ts +9 -0
  320. package/src/models/ResourcePoint.ts +12 -0
  321. package/src/models/RevenueByProduct.ts +11 -0
  322. package/src/models/SendNotification.ts +11 -0
  323. package/src/models/SendResponse.ts +14 -0
  324. package/src/models/Skill.ts +12 -0
  325. package/src/models/SkillDetail.ts +14 -0
  326. package/src/models/SkillInfo.ts +28 -0
  327. package/src/models/SkillThreshold.ts +19 -0
  328. package/src/models/StateEnum.ts +26 -0
  329. package/src/models/StatusEnum.ts +14 -0
  330. package/src/models/SubTimeChild.ts +23 -0
  331. package/src/models/Summary.ts +23 -0
  332. package/src/models/TimeChildData.ts +25 -0
  333. package/src/models/TimeDetail.ts +13 -0
  334. package/src/models/TimeDetailChild.ts +31 -0
  335. package/src/models/TimeDetailData.ts +29 -0
  336. package/src/models/TimeSpentByUsersInCourse.ts +11 -0
  337. package/src/models/TimeSpentByUsersInCourseData.ts +27 -0
  338. package/src/models/TimeSpentPerCourse.ts +11 -0
  339. package/src/models/TimeSpentPerCourseData.ts +31 -0
  340. package/src/models/TimeSpentPerUserResponse.ts +8 -0
  341. package/src/models/TimeSpentUpdateRequest.ts +16 -0
  342. package/src/models/TimeSpentUpdateResponse.ts +9 -0
  343. package/src/models/TypeEnum.ts +22 -0
  344. package/src/models/UploadedImage.ts +10 -0
  345. package/src/models/UserInfo.ts +18 -0
  346. package/src/models/UserSkill.ts +27 -0
  347. package/src/models/UserSkillPointsPercentile.ts +13 -0
  348. package/src/models/ValidateSourceResponse.ts +15 -0
  349. package/src/models/Value.ts +9 -0
  350. package/src/models/ValueData.ts +11 -0
  351. package/src/models/VideoBlock.ts +19 -0
  352. package/src/models/VideoEngagementPerCourse.ts +11 -0
  353. package/src/models/VideoEngagementPerCourseData.ts +35 -0
  354. package/src/models/VideosCount.ts +9 -0
  355. package/src/models/VideosCountData.ts +11 -0
  356. package/src/models/VideosInCourseSummary.ts +9 -0
  357. package/src/models/VideosInCourseSummaryData.ts +17 -0
  358. package/src/models/VideosSpecificCourse.ts +9 -0
  359. package/src/models/VideosSpecificCourseData.ts +31 -0
  360. package/src/models/VideosWatchedSubSection.ts +24 -0
  361. package/src/models/WatchedVideosPerUser.ts +13 -0
  362. package/src/models/WatchedVideosPerUserData.ts +23 -0
  363. package/src/services/AnalyticsService.ts +94 -0
  364. package/src/services/AudienceService.ts +602 -0
  365. package/src/services/CareerService.ts +568 -0
  366. package/src/services/CoreService.ts +487 -0
  367. package/src/services/CredentialsService.ts +1647 -0
  368. package/src/services/DepartmentsService.ts +85 -0
  369. package/src/services/EngagementService.ts +907 -0
  370. package/src/services/FinanceService.ts +136 -0
  371. package/src/services/NotificationBuilderService.ts +133 -0
  372. package/src/services/NotificationService.ts +294 -0
  373. package/src/services/OverviewService.ts +324 -0
  374. package/src/services/PerformanceService.ts +329 -0
  375. package/src/services/PerlearnerService.ts +1009 -0
  376. package/src/services/PlatformService.ts +181 -0
  377. package/src/services/RecommendationsService.ts +31 -0
  378. package/src/services/ReportsService.ts +218 -0
  379. package/src/services/SearchService.ts +309 -0
  380. package/src/services/SkillsService.ts +521 -0
  381. package/src/services/UserGroupsService.ts +91 -0
  382. package/tsconfig.json +15 -0
@@ -0,0 +1,1647 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { Assertion } from '../models/Assertion';
6
+ import type { BulkCreateAssertion } from '../models/BulkCreateAssertion';
7
+ import type { Credential } from '../models/Credential';
8
+ import type { Issuer } from '../models/Issuer';
9
+ import type { IssuerAuthority } from '../models/IssuerAuthority';
10
+ import type { OverTime } from '../models/OverTime';
11
+ import type { UploadedImage } from '../models/UploadedImage';
12
+ import type { CancelablePromise } from '../core/CancelablePromise';
13
+ import { OpenAPI } from '../core/OpenAPI';
14
+ import { request as __request } from '../core/request';
15
+ export class CredentialsService {
16
+ /**
17
+ * Get all credentials for a platform with search and pagination support.
18
+ *
19
+ * Query Parameters:
20
+ * - platform_org: Platform org ID (takes precedence over URL org)
21
+ * - page: Page number (default: 1)
22
+ * - page_size: Items per page (default: 10, max: 100)
23
+ * - search: Search term to filter credentials
24
+ * - course: Course ID to filter credentials
25
+ * - program: Program ID to filter credentials
26
+ * @param org
27
+ * @param userId
28
+ * @returns Credential
29
+ * @throws ApiError
30
+ */
31
+ public static credentialsOrgsUsersRetrieve(
32
+ org: string,
33
+ userId: string,
34
+ ): CancelablePromise<Credential> {
35
+ return __request(OpenAPI, {
36
+ method: 'GET',
37
+ url: '/api/credentials/orgs/{org}/users/{user_id}/',
38
+ path: {
39
+ 'org': org,
40
+ 'user_id': userId,
41
+ },
42
+ });
43
+ }
44
+ /**
45
+ * API View for managing credentials across a platform.
46
+ *
47
+ * This endpoint allows creating and retrieving credentials for a specific organization/tenant,
48
+ * with support for filtering, searching, and pagination.
49
+ *
50
+ * Path Parameters:
51
+ * org (str): The organization/tenant identifier
52
+ * user_id (str): The user ID making the request
53
+ *
54
+ * Query Parameters:
55
+ * # Platform identification
56
+ * platform_org (str, optional): Alternative platform identifier (takes precedence over URL org)
57
+ *
58
+ * # Pagination
59
+ * page (int, optional): Page number (default: 1)
60
+ * page_size (int, optional): Items per page (default: 10, max: 100)
61
+ *
62
+ * # Filtering and search
63
+ * search (str, optional): Search term to filter credentials by name or description
64
+ * course (str, optional): Course ID to filter credentials associated with a specific course
65
+ * program (str, optional): Program ID to filter credentials associated with a specific program
66
+ *
67
+ * Methods:
68
+ * GET: Retrieve credentials with filtering and pagination
69
+ * POST: Create a new credential
70
+ *
71
+ * POST Request Body:
72
+ * A JSON object containing credential details:
73
+ * - name (str): Credential name
74
+ * - description (str, optional): Credential description
75
+ * - issuer (str): Issuer entity ID
76
+ * - credential_type (str, optional): Type of credential
77
+ * - html_template (str, optional): HTML template for credential rendering
78
+ * - css_template (str, optional): CSS template for credential styling
79
+ * - icon_image (str, optional): URL to credential icon
80
+ * - background_image (str, optional): URL to credential background
81
+ * - thumbnail_image (str, optional): URL to credential thumbnail
82
+ * - criteria_url (str, optional): URL to credential criteria
83
+ * - criteria_text (str, optional): Text description of credential criteria
84
+ * - issuing_signal (str, optional): Signal that triggers credential issuance
85
+ *
86
+ * Returns:
87
+ * GET: A JSON response containing:
88
+ * {
89
+ * "status": {"success": true, "description": "Ok"},
90
+ * "result": {
91
+ * "next": "URL to next page",
92
+ * "previous": "URL to previous page",
93
+ * "count": 42,
94
+ * "data": [
95
+ * {credential object},
96
+ * {credential object},
97
+ * ...
98
+ * ],
99
+ * "num_pages": 5,
100
+ * "page_number": 1,
101
+ * "max_page_size": 100
102
+ * }
103
+ * }
104
+ *
105
+ * POST: A JSON response containing:
106
+ * {
107
+ * "status": {"success": true, "description": "Created"},
108
+ * "result": {credential object}
109
+ * }
110
+ *
111
+ * Error Responses:
112
+ * 400 Bad Request: If the request data is invalid
113
+ * 401 Unauthorized: If the user is not authenticated
114
+ * 403 Forbidden: If the user does not have permission to access this resource
115
+ * 404 Not Found: If the platform doesn't exist
116
+ * 500 Internal Server Error: If an unexpected error occurs
117
+ *
118
+ * Access Control:
119
+ * - Requires CredentialAssignmentPermission
120
+ * - Only public credentials are returned by default
121
+ * @param org
122
+ * @param userId
123
+ * @param requestBody
124
+ * @returns Credential
125
+ * @throws ApiError
126
+ */
127
+ public static credentialsOrgsUsersCreate(
128
+ org: string,
129
+ userId: string,
130
+ requestBody: Credential,
131
+ ): CancelablePromise<Credential> {
132
+ return __request(OpenAPI, {
133
+ method: 'POST',
134
+ url: '/api/credentials/orgs/{org}/users/{user_id}/',
135
+ path: {
136
+ 'org': org,
137
+ 'user_id': userId,
138
+ },
139
+ body: requestBody,
140
+ mediaType: 'application/json',
141
+ });
142
+ }
143
+ /**
144
+ * API View for managing individual credentials.
145
+ *
146
+ * This endpoint allows retrieving, updating, and deleting specific credentials
147
+ * identified by their entity_id.
148
+ *
149
+ * Path Parameters:
150
+ * org (str): The organization/tenant identifier
151
+ * user_id (str): The user ID making the request
152
+ * entity_id (str): The credential entity ID
153
+ *
154
+ * Methods:
155
+ * GET: Retrieve a specific credential
156
+ * PUT: Update a specific credential
157
+ * DELETE: Delete a specific credential
158
+ *
159
+ * PUT Request Body:
160
+ * A JSON object containing credential details to update:
161
+ * - name (str, optional): Credential name
162
+ * - description (str, optional): Credential description
163
+ * - credential_type (str, optional): Type of credential
164
+ * - html_template (str, optional): HTML template for credential rendering
165
+ * - css_template (str, optional): CSS template for credential styling
166
+ * - icon_image (str, optional): URL to credential icon
167
+ * - background_image (str, optional): URL to credential background
168
+ * - thumbnail_image (str, optional): URL to credential thumbnail
169
+ * - criteria_url (str, optional): URL to credential criteria
170
+ * - criteria_text (str, optional): Text description of credential criteria
171
+ * - issuing_signal (str, optional): Signal that triggers credential issuance
172
+ *
173
+ * Returns:
174
+ * GET: A JSON response containing:
175
+ * {
176
+ * "status": {"success": true, "description": "Ok"},
177
+ * "result": {credential object}
178
+ * }
179
+ *
180
+ * PUT: A JSON response containing:
181
+ * {
182
+ * "status": {"success": true, "description": "Updated"},
183
+ * "result": {credential object}
184
+ * }
185
+ *
186
+ * DELETE: No content (204)
187
+ *
188
+ * Error Responses:
189
+ * 400 Bad Request: If the request data is invalid
190
+ * 401 Unauthorized: If the user is not authenticated
191
+ * 403 Forbidden: If the user does not have permission to access this resource
192
+ * 404 Not Found: If the credential doesn't exist
193
+ * 500 Internal Server Error: If an unexpected error occurs
194
+ *
195
+ * Access Control:
196
+ * - Requires CredentialAssignmentPermission
197
+ * - Users can only manage credentials they have permission to access
198
+ * @param entityId
199
+ * @param org
200
+ * @param userId
201
+ * @returns Credential
202
+ * @throws ApiError
203
+ */
204
+ public static credentialsOrgsUsersRetrieve2(
205
+ entityId: string,
206
+ org: string,
207
+ userId: string,
208
+ ): CancelablePromise<Credential> {
209
+ return __request(OpenAPI, {
210
+ method: 'GET',
211
+ url: '/api/credentials/orgs/{org}/users/{user_id}/{entity_id}',
212
+ path: {
213
+ 'entity_id': entityId,
214
+ 'org': org,
215
+ 'user_id': userId,
216
+ },
217
+ });
218
+ }
219
+ /**
220
+ * API View for managing individual credentials.
221
+ *
222
+ * This endpoint allows retrieving, updating, and deleting specific credentials
223
+ * identified by their entity_id.
224
+ *
225
+ * Path Parameters:
226
+ * org (str): The organization/tenant identifier
227
+ * user_id (str): The user ID making the request
228
+ * entity_id (str): The credential entity ID
229
+ *
230
+ * Methods:
231
+ * GET: Retrieve a specific credential
232
+ * PUT: Update a specific credential
233
+ * DELETE: Delete a specific credential
234
+ *
235
+ * PUT Request Body:
236
+ * A JSON object containing credential details to update:
237
+ * - name (str, optional): Credential name
238
+ * - description (str, optional): Credential description
239
+ * - credential_type (str, optional): Type of credential
240
+ * - html_template (str, optional): HTML template for credential rendering
241
+ * - css_template (str, optional): CSS template for credential styling
242
+ * - icon_image (str, optional): URL to credential icon
243
+ * - background_image (str, optional): URL to credential background
244
+ * - thumbnail_image (str, optional): URL to credential thumbnail
245
+ * - criteria_url (str, optional): URL to credential criteria
246
+ * - criteria_text (str, optional): Text description of credential criteria
247
+ * - issuing_signal (str, optional): Signal that triggers credential issuance
248
+ *
249
+ * Returns:
250
+ * GET: A JSON response containing:
251
+ * {
252
+ * "status": {"success": true, "description": "Ok"},
253
+ * "result": {credential object}
254
+ * }
255
+ *
256
+ * PUT: A JSON response containing:
257
+ * {
258
+ * "status": {"success": true, "description": "Updated"},
259
+ * "result": {credential object}
260
+ * }
261
+ *
262
+ * DELETE: No content (204)
263
+ *
264
+ * Error Responses:
265
+ * 400 Bad Request: If the request data is invalid
266
+ * 401 Unauthorized: If the user is not authenticated
267
+ * 403 Forbidden: If the user does not have permission to access this resource
268
+ * 404 Not Found: If the credential doesn't exist
269
+ * 500 Internal Server Error: If an unexpected error occurs
270
+ *
271
+ * Access Control:
272
+ * - Requires CredentialAssignmentPermission
273
+ * - Users can only manage credentials they have permission to access
274
+ * @param entityId
275
+ * @param org
276
+ * @param userId
277
+ * @param requestBody
278
+ * @returns Credential
279
+ * @throws ApiError
280
+ */
281
+ public static credentialsOrgsUsersUpdate(
282
+ entityId: string,
283
+ org: string,
284
+ userId: string,
285
+ requestBody: Credential,
286
+ ): CancelablePromise<Credential> {
287
+ return __request(OpenAPI, {
288
+ method: 'PUT',
289
+ url: '/api/credentials/orgs/{org}/users/{user_id}/{entity_id}',
290
+ path: {
291
+ 'entity_id': entityId,
292
+ 'org': org,
293
+ 'user_id': userId,
294
+ },
295
+ body: requestBody,
296
+ mediaType: 'application/json',
297
+ });
298
+ }
299
+ /**
300
+ * API View for managing individual credentials.
301
+ *
302
+ * This endpoint allows retrieving, updating, and deleting specific credentials
303
+ * identified by their entity_id.
304
+ *
305
+ * Path Parameters:
306
+ * org (str): The organization/tenant identifier
307
+ * user_id (str): The user ID making the request
308
+ * entity_id (str): The credential entity ID
309
+ *
310
+ * Methods:
311
+ * GET: Retrieve a specific credential
312
+ * PUT: Update a specific credential
313
+ * DELETE: Delete a specific credential
314
+ *
315
+ * PUT Request Body:
316
+ * A JSON object containing credential details to update:
317
+ * - name (str, optional): Credential name
318
+ * - description (str, optional): Credential description
319
+ * - credential_type (str, optional): Type of credential
320
+ * - html_template (str, optional): HTML template for credential rendering
321
+ * - css_template (str, optional): CSS template for credential styling
322
+ * - icon_image (str, optional): URL to credential icon
323
+ * - background_image (str, optional): URL to credential background
324
+ * - thumbnail_image (str, optional): URL to credential thumbnail
325
+ * - criteria_url (str, optional): URL to credential criteria
326
+ * - criteria_text (str, optional): Text description of credential criteria
327
+ * - issuing_signal (str, optional): Signal that triggers credential issuance
328
+ *
329
+ * Returns:
330
+ * GET: A JSON response containing:
331
+ * {
332
+ * "status": {"success": true, "description": "Ok"},
333
+ * "result": {credential object}
334
+ * }
335
+ *
336
+ * PUT: A JSON response containing:
337
+ * {
338
+ * "status": {"success": true, "description": "Updated"},
339
+ * "result": {credential object}
340
+ * }
341
+ *
342
+ * DELETE: No content (204)
343
+ *
344
+ * Error Responses:
345
+ * 400 Bad Request: If the request data is invalid
346
+ * 401 Unauthorized: If the user is not authenticated
347
+ * 403 Forbidden: If the user does not have permission to access this resource
348
+ * 404 Not Found: If the credential doesn't exist
349
+ * 500 Internal Server Error: If an unexpected error occurs
350
+ *
351
+ * Access Control:
352
+ * - Requires CredentialAssignmentPermission
353
+ * - Users can only manage credentials they have permission to access
354
+ * @param entityId
355
+ * @param org
356
+ * @param userId
357
+ * @returns void
358
+ * @throws ApiError
359
+ */
360
+ public static credentialsOrgsUsersDestroy(
361
+ entityId: string,
362
+ org: string,
363
+ userId: string,
364
+ ): CancelablePromise<void> {
365
+ return __request(OpenAPI, {
366
+ method: 'DELETE',
367
+ url: '/api/credentials/orgs/{org}/users/{user_id}/{entity_id}',
368
+ path: {
369
+ 'entity_id': entityId,
370
+ 'org': org,
371
+ 'user_id': userId,
372
+ },
373
+ });
374
+ }
375
+ /**
376
+ * Endpoint to issue and retrieve credential assertions for a specific credential.
377
+ *
378
+ * This endpoint allows issuing new credential assertions and retrieving existing
379
+ * assertions for a specific credential.
380
+ *
381
+ * Path Parameters:
382
+ * org (str): The organization/tenant identifier
383
+ * user_id (str): The user ID making the request
384
+ * entity_id (str): The credential entity ID
385
+ *
386
+ * Methods:
387
+ * POST: Issue a new credential assertion
388
+ * GET: Retrieve assertions for a specific credential
389
+ *
390
+ * POST Request Body:
391
+ * A JSON object containing recipient information and any additional metadata
392
+ * required for issuing the credential.
393
+ *
394
+ * Returns:
395
+ * POST: A JSON response containing the created assertion using the AssertionSerializer format
396
+ * GET: A paginated list of assertions using the AssertionSerializer format
397
+ *
398
+ * Error Responses:
399
+ * 400 Bad Request: If the request data is invalid
400
+ * 401 Unauthorized: If the user is not authenticated
401
+ * 403 Forbidden: If the user does not have permission to access this resource
402
+ * 404 Not Found: If the credential doesn't exist
403
+ * 500 Internal Server Error: If an unexpected error occurs
404
+ * @param entityId
405
+ * @param org
406
+ * @param userId
407
+ * @returns Assertion
408
+ * @throws ApiError
409
+ */
410
+ public static credentialsOrgsUsersAssertionsRetrieve3(
411
+ entityId: string,
412
+ org: string,
413
+ userId: string,
414
+ ): CancelablePromise<Assertion> {
415
+ return __request(OpenAPI, {
416
+ method: 'GET',
417
+ url: '/api/credentials/orgs/{org}/users/{user_id}/{entity_id}/assertions/',
418
+ path: {
419
+ 'entity_id': entityId,
420
+ 'org': org,
421
+ 'user_id': userId,
422
+ },
423
+ });
424
+ }
425
+ /**
426
+ * Endpoint to issue and retrieve credential assertions for a specific credential.
427
+ *
428
+ * This endpoint allows issuing new credential assertions and retrieving existing
429
+ * assertions for a specific credential.
430
+ *
431
+ * Path Parameters:
432
+ * org (str): The organization/tenant identifier
433
+ * user_id (str): The user ID making the request
434
+ * entity_id (str): The credential entity ID
435
+ *
436
+ * Methods:
437
+ * POST: Issue a new credential assertion
438
+ * GET: Retrieve assertions for a specific credential
439
+ *
440
+ * POST Request Body:
441
+ * A JSON object containing recipient information and any additional metadata
442
+ * required for issuing the credential.
443
+ *
444
+ * Returns:
445
+ * POST: A JSON response containing the created assertion using the AssertionSerializer format
446
+ * GET: A paginated list of assertions using the AssertionSerializer format
447
+ *
448
+ * Error Responses:
449
+ * 400 Bad Request: If the request data is invalid
450
+ * 401 Unauthorized: If the user is not authenticated
451
+ * 403 Forbidden: If the user does not have permission to access this resource
452
+ * 404 Not Found: If the credential doesn't exist
453
+ * 500 Internal Server Error: If an unexpected error occurs
454
+ * @param entityId
455
+ * @param org
456
+ * @param userId
457
+ * @param requestBody
458
+ * @returns Assertion
459
+ * @throws ApiError
460
+ */
461
+ public static credentialsOrgsUsersAssertionsCreate(
462
+ entityId: string,
463
+ org: string,
464
+ userId: string,
465
+ requestBody: Assertion,
466
+ ): CancelablePromise<Assertion> {
467
+ return __request(OpenAPI, {
468
+ method: 'POST',
469
+ url: '/api/credentials/orgs/{org}/users/{user_id}/{entity_id}/assertions/',
470
+ path: {
471
+ 'entity_id': entityId,
472
+ 'org': org,
473
+ 'user_id': userId,
474
+ },
475
+ body: requestBody,
476
+ mediaType: 'application/json',
477
+ });
478
+ }
479
+ /**
480
+ * Endpoint to issue credential assertions in bulk for a specific credential.
481
+ *
482
+ * This endpoint allows issuing credential assertions to multiple users at once.
483
+ *
484
+ * Path Parameters:
485
+ * org (str): The organization/tenant identifier
486
+ * user_id (str): The user ID making the request
487
+ * entity_id (str): The credential entity ID
488
+ *
489
+ * POST Request Body:
490
+ * A JSON object containing:
491
+ * - users (list): List of usernames to issue the credential to
492
+ * - Additional metadata required for issuing the credential
493
+ *
494
+ * Returns:
495
+ * A JSON response containing:
496
+ * {
497
+ * "skipped": ["username1", "username3"], // Users that were skipped (e.g., already have the credential)
498
+ * "issued": ["username2", "username4"] // Users that were successfully issued the credential
499
+ * }
500
+ *
501
+ * Error Responses:
502
+ * 400 Bad Request: If the request data is invalid or missing required fields
503
+ * 401 Unauthorized: If the user is not authenticated
504
+ * 403 Forbidden: If the user does not have permission to access this resource
505
+ * 404 Not Found: If the credential doesn't exist
506
+ * 500 Internal Server Error: If an unexpected error occurs
507
+ * @param entityId
508
+ * @param org
509
+ * @param userId
510
+ * @param requestBody
511
+ * @returns BulkCreateAssertion
512
+ * @throws ApiError
513
+ */
514
+ public static credentialsOrgsUsersAssertionsBulkCreate(
515
+ entityId: string,
516
+ org: string,
517
+ userId: string,
518
+ requestBody: BulkCreateAssertion,
519
+ ): CancelablePromise<BulkCreateAssertion> {
520
+ return __request(OpenAPI, {
521
+ method: 'POST',
522
+ url: '/api/credentials/orgs/{org}/users/{user_id}/{entity_id}/assertions/bulk/',
523
+ path: {
524
+ 'entity_id': entityId,
525
+ 'org': org,
526
+ 'user_id': userId,
527
+ },
528
+ body: requestBody,
529
+ mediaType: 'application/json',
530
+ });
531
+ }
532
+ /**
533
+ * Endpoint to retrieve all credential assertions for a user within an organization.
534
+ *
535
+ * This endpoint provides access to all credential assertions (issued credentials)
536
+ * for a specific user within an organization, with support for filtering.
537
+ *
538
+ * Path Parameters:
539
+ * org (str): The organization/tenant identifier
540
+ * user_id (str): The user ID to retrieve assertions for
541
+ *
542
+ * Query Parameters:
543
+ * course (str, optional): Filter by course ID
544
+ * include_revoked (bool, optional): Include revoked assertions (default: false)
545
+ * include_expired (bool, optional): Include expired assertions (default: false)
546
+ * exclude_main_tenant_assertions (bool, optional): Exclude assertions from the main tenant (default: false)
547
+ *
548
+ * Returns:
549
+ * A paginated response using the AssertionSerializer format
550
+ *
551
+ * Error Responses:
552
+ * 401 Unauthorized: If the user is not authenticated
553
+ * 403 Forbidden: If the user does not have permission to access this resource
554
+ * 404 Not Found: If the user or organization doesn't exist
555
+ * 500 Internal Server Error: If an unexpected error occurs
556
+ * @param org
557
+ * @param userId
558
+ * @param course
559
+ * @param excludeMainTenantAssertions
560
+ * @param includeExpired
561
+ * @param includeRevoked
562
+ * @returns Assertion
563
+ * @throws ApiError
564
+ */
565
+ public static credentialsOrgsUsersAssertionsRetrieve(
566
+ org: string,
567
+ userId: string,
568
+ course?: string,
569
+ excludeMainTenantAssertions?: boolean,
570
+ includeExpired?: boolean,
571
+ includeRevoked?: boolean,
572
+ ): CancelablePromise<Assertion> {
573
+ return __request(OpenAPI, {
574
+ method: 'GET',
575
+ url: '/api/credentials/orgs/{org}/users/{user_id}/assertions/',
576
+ path: {
577
+ 'org': org,
578
+ 'user_id': userId,
579
+ },
580
+ query: {
581
+ 'course': course,
582
+ 'exclude_main_tenant_assertions': excludeMainTenantAssertions,
583
+ 'include_expired': includeExpired,
584
+ 'include_revoked': includeRevoked,
585
+ },
586
+ });
587
+ }
588
+ /**
589
+ * Get all credentials of a given tenant
590
+ * @param org
591
+ * @param userId
592
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
593
+ * @param endDate end date. ISO 8601
594
+ * @param format Format
595
+ *
596
+ * * `json` - json
597
+ * @param includeMainPlatform Include main platform data
598
+ * @param startDate start date. ISO 8601
599
+ * @returns OverTime
600
+ * @throws ApiError
601
+ */
602
+ public static credentialsOrgsUsersAssertionsOverTimeRetrieve(
603
+ org: string,
604
+ userId: string,
605
+ departmentId?: number,
606
+ endDate?: string,
607
+ format: 'json' = 'json',
608
+ includeMainPlatform: boolean = true,
609
+ startDate?: string,
610
+ ): CancelablePromise<OverTime> {
611
+ return __request(OpenAPI, {
612
+ method: 'GET',
613
+ url: '/api/credentials/orgs/{org}/users/{user_id}/assertions-over-time/',
614
+ path: {
615
+ 'org': org,
616
+ 'user_id': userId,
617
+ },
618
+ query: {
619
+ 'department_id': departmentId,
620
+ 'end_date': endDate,
621
+ 'format': format,
622
+ 'include_main_platform': includeMainPlatform,
623
+ 'start_date': startDate,
624
+ },
625
+ });
626
+ }
627
+ /**
628
+ * Endpoint to retrieve and update a specific credential assertion.
629
+ *
630
+ * This endpoint allows retrieving details of a specific credential assertion
631
+ * and updating its status (e.g., revoking it).
632
+ *
633
+ * Path Parameters:
634
+ * org (str): The organization/tenant identifier
635
+ * user_id (str): The user ID making the request
636
+ * entity_id (str): The assertion entity ID
637
+ *
638
+ * Methods:
639
+ * GET: Retrieve assertion details
640
+ * PUT: Update assertion status (e.g., revoke)
641
+ *
642
+ * PUT Request Body:
643
+ * A JSON object containing:
644
+ * - revoked (bool): Set to true to revoke the assertion
645
+ * - revocationReason (str): Reason for revocation (required when revoking)
646
+ *
647
+ * Returns:
648
+ * GET: A JSON response containing the assertion details using the AssertionSerializer format
649
+ * PUT: A JSON response containing the updated assertion using the AssertionSerializer format
650
+ *
651
+ * Error Responses:
652
+ * 400 Bad Request: If the request data is invalid
653
+ * 401 Unauthorized: If the user is not authenticated
654
+ * 403 Forbidden: If the user does not have permission to access this resource
655
+ * 404 Not Found: If the assertion doesn't exist
656
+ * 500 Internal Server Error: If an unexpected error occurs
657
+ * @param entityId
658
+ * @param org
659
+ * @param userId
660
+ * @returns Assertion
661
+ * @throws ApiError
662
+ */
663
+ public static credentialsOrgsUsersAssertionsRetrieve2(
664
+ entityId: string,
665
+ org: string,
666
+ userId: string,
667
+ ): CancelablePromise<Assertion> {
668
+ return __request(OpenAPI, {
669
+ method: 'GET',
670
+ url: '/api/credentials/orgs/{org}/users/{user_id}/assertions/{entity_id}',
671
+ path: {
672
+ 'entity_id': entityId,
673
+ 'org': org,
674
+ 'user_id': userId,
675
+ },
676
+ });
677
+ }
678
+ /**
679
+ * Endpoint to retrieve and update a specific credential assertion.
680
+ *
681
+ * This endpoint allows retrieving details of a specific credential assertion
682
+ * and updating its status (e.g., revoking it).
683
+ *
684
+ * Path Parameters:
685
+ * org (str): The organization/tenant identifier
686
+ * user_id (str): The user ID making the request
687
+ * entity_id (str): The assertion entity ID
688
+ *
689
+ * Methods:
690
+ * GET: Retrieve assertion details
691
+ * PUT: Update assertion status (e.g., revoke)
692
+ *
693
+ * PUT Request Body:
694
+ * A JSON object containing:
695
+ * - revoked (bool): Set to true to revoke the assertion
696
+ * - revocationReason (str): Reason for revocation (required when revoking)
697
+ *
698
+ * Returns:
699
+ * GET: A JSON response containing the assertion details using the AssertionSerializer format
700
+ * PUT: A JSON response containing the updated assertion using the AssertionSerializer format
701
+ *
702
+ * Error Responses:
703
+ * 400 Bad Request: If the request data is invalid
704
+ * 401 Unauthorized: If the user is not authenticated
705
+ * 403 Forbidden: If the user does not have permission to access this resource
706
+ * 404 Not Found: If the assertion doesn't exist
707
+ * 500 Internal Server Error: If an unexpected error occurs
708
+ * @param entityId
709
+ * @param org
710
+ * @param userId
711
+ * @param requestBody
712
+ * @returns Assertion
713
+ * @throws ApiError
714
+ */
715
+ public static credentialsOrgsUsersAssertionsUpdate(
716
+ entityId: string,
717
+ org: string,
718
+ userId: string,
719
+ requestBody: Assertion,
720
+ ): CancelablePromise<Assertion> {
721
+ return __request(OpenAPI, {
722
+ method: 'PUT',
723
+ url: '/api/credentials/orgs/{org}/users/{user_id}/assertions/{entity_id}',
724
+ path: {
725
+ 'entity_id': entityId,
726
+ 'org': org,
727
+ 'user_id': userId,
728
+ },
729
+ body: requestBody,
730
+ mediaType: 'application/json',
731
+ });
732
+ }
733
+ /**
734
+ * Delete a credential assignment using its entity_id.
735
+ * Only platform admins and department admins can delete assignments.
736
+ * @param assignmentId
737
+ * @param org
738
+ * @param userId
739
+ * @returns void
740
+ * @throws ApiError
741
+ */
742
+ public static credentialsOrgsUsersAssignmentsDestroy(
743
+ assignmentId: string,
744
+ org: string,
745
+ userId: string,
746
+ ): CancelablePromise<void> {
747
+ return __request(OpenAPI, {
748
+ method: 'DELETE',
749
+ url: '/api/credentials/orgs/{org}/users/{user_id}/assignments/{assignment_id}',
750
+ path: {
751
+ 'assignment_id': assignmentId,
752
+ 'org': org,
753
+ 'user_id': userId,
754
+ },
755
+ });
756
+ }
757
+ /**
758
+ * Get group assignments with department-aware filtering
759
+ * @param org
760
+ * @param userId
761
+ * @returns any No response body
762
+ * @throws ApiError
763
+ */
764
+ public static credentialsOrgsUsersAssignmentsGroupsRetrieve(
765
+ org: string,
766
+ userId: string,
767
+ ): CancelablePromise<any> {
768
+ return __request(OpenAPI, {
769
+ method: 'GET',
770
+ url: '/api/credentials/orgs/{org}/users/{user_id}/assignments/groups/',
771
+ path: {
772
+ 'org': org,
773
+ 'user_id': userId,
774
+ },
775
+ });
776
+ }
777
+ /**
778
+ * Create group assignment with department access validation
779
+ * @param org
780
+ * @param userId
781
+ * @returns any No response body
782
+ * @throws ApiError
783
+ */
784
+ public static credentialsOrgsUsersAssignmentsGroupsCreate(
785
+ org: string,
786
+ userId: string,
787
+ ): CancelablePromise<any> {
788
+ return __request(OpenAPI, {
789
+ method: 'POST',
790
+ url: '/api/credentials/orgs/{org}/users/{user_id}/assignments/groups/',
791
+ path: {
792
+ 'org': org,
793
+ 'user_id': userId,
794
+ },
795
+ });
796
+ }
797
+ /**
798
+ * Get assignments and their corresponding assertions based on user role:
799
+ * - Regular users: get only their own assignments
800
+ * - Platform admins: get assignments for all users in their platform
801
+ * - Department admins: get assignments for users in their department groups
802
+ * @param org
803
+ * @param userId
804
+ * @returns any No response body
805
+ * @throws ApiError
806
+ */
807
+ public static credentialsOrgsUsersAssignmentsUsersRetrieve(
808
+ org: string,
809
+ userId: string,
810
+ ): CancelablePromise<any> {
811
+ return __request(OpenAPI, {
812
+ method: 'GET',
813
+ url: '/api/credentials/orgs/{org}/users/{user_id}/assignments/users/',
814
+ path: {
815
+ 'org': org,
816
+ 'user_id': userId,
817
+ },
818
+ });
819
+ }
820
+ /**
821
+ * Create assignments with department access validation
822
+ * @param org
823
+ * @param userId
824
+ * @returns any No response body
825
+ * @throws ApiError
826
+ */
827
+ public static credentialsOrgsUsersAssignmentsUsersCreate(
828
+ org: string,
829
+ userId: string,
830
+ ): CancelablePromise<any> {
831
+ return __request(OpenAPI, {
832
+ method: 'POST',
833
+ url: '/api/credentials/orgs/{org}/users/{user_id}/assignments/users/',
834
+ path: {
835
+ 'org': org,
836
+ 'user_id': userId,
837
+ },
838
+ });
839
+ }
840
+ /**
841
+ * Get all credentials of a given tenant
842
+ * @param org
843
+ * @param userId
844
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
845
+ * @param endDate end date. ISO 8601
846
+ * @param format Format
847
+ *
848
+ * * `json` - json
849
+ * @param includeMainPlatform Include main platform data
850
+ * @param startDate start date. ISO 8601
851
+ * @returns OverTime
852
+ * @throws ApiError
853
+ */
854
+ public static credentialsOrgsUsersCourseAssertionsOverTimeRetrieve(
855
+ org: string,
856
+ userId: string,
857
+ departmentId?: number,
858
+ endDate?: string,
859
+ format: 'json' = 'json',
860
+ includeMainPlatform: boolean = true,
861
+ startDate?: string,
862
+ ): CancelablePromise<OverTime> {
863
+ return __request(OpenAPI, {
864
+ method: 'GET',
865
+ url: '/api/credentials/orgs/{org}/users/{user_id}/course-assertions-over-time/',
866
+ path: {
867
+ 'org': org,
868
+ 'user_id': userId,
869
+ },
870
+ query: {
871
+ 'department_id': departmentId,
872
+ 'end_date': endDate,
873
+ 'format': format,
874
+ 'include_main_platform': includeMainPlatform,
875
+ 'start_date': startDate,
876
+ },
877
+ });
878
+ }
879
+ /**
880
+ * Endpoint to retrieve the credentials of a given tenant grouped by course.
881
+ *
882
+ * This endpoint provides access to credential data grouped by course for a specific
883
+ * organization/tenant, with support for pagination and filtering.
884
+ *
885
+ * Path Parameters:
886
+ * org (str): The organization/tenant identifier
887
+ *
888
+ * Query Parameters:
889
+ * limit (int, optional): Number of results per page (default: 10)
890
+ * offset (int, optional): Starting position for pagination
891
+ * search (str, optional): Search term e.g course_id
892
+ *
893
+ * Returns:
894
+ * A paginated response using the CourseCredentialSerializer format.
895
+ *
896
+ * Error Responses:
897
+ * 401 Unauthorized: If the user is not authenticated
898
+ * 403 Forbidden: If the user does not have permission to access this data
899
+ * 404 Not Found: If the organization doesn't exist
900
+ * 500 Internal Server Error: If an unexpected error occurs
901
+ * @param org
902
+ * @param userId
903
+ * @param page A page number within the paginated result set.
904
+ * @param pageSize Number of results to return per page.
905
+ * @returns any No response body
906
+ * @throws ApiError
907
+ */
908
+ public static credentialsOrgsUsersCourseCredentialsList(
909
+ org: string,
910
+ userId: string,
911
+ page?: number,
912
+ pageSize?: number,
913
+ ): CancelablePromise<any> {
914
+ return __request(OpenAPI, {
915
+ method: 'GET',
916
+ url: '/api/credentials/orgs/{org}/users/{user_id}/course-credentials/',
917
+ path: {
918
+ 'org': org,
919
+ 'user_id': userId,
920
+ },
921
+ query: {
922
+ 'page': page,
923
+ 'page_size': pageSize,
924
+ },
925
+ });
926
+ }
927
+ /**
928
+ * Get all credentials of a given tenant
929
+ * @param org
930
+ * @param userId
931
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
932
+ * @param endDate end date. ISO 8601
933
+ * @param format Format
934
+ *
935
+ * * `json` - json
936
+ * @param includeMainPlatform Include main platform data
937
+ * @param startDate start date. ISO 8601
938
+ * @returns OverTime
939
+ * @throws ApiError
940
+ */
941
+ public static credentialsOrgsUsersCredentialsOverTimeRetrieve(
942
+ org: string,
943
+ userId: string,
944
+ departmentId?: number,
945
+ endDate?: string,
946
+ format: 'json' = 'json',
947
+ includeMainPlatform: boolean = true,
948
+ startDate?: string,
949
+ ): CancelablePromise<OverTime> {
950
+ return __request(OpenAPI, {
951
+ method: 'GET',
952
+ url: '/api/credentials/orgs/{org}/users/{user_id}/credentials-over-time/',
953
+ path: {
954
+ 'org': org,
955
+ 'user_id': userId,
956
+ },
957
+ query: {
958
+ 'department_id': departmentId,
959
+ 'end_date': endDate,
960
+ 'format': format,
961
+ 'include_main_platform': includeMainPlatform,
962
+ 'start_date': startDate,
963
+ },
964
+ });
965
+ }
966
+ /**
967
+ * API View for managing uploaded images for credentials.
968
+ *
969
+ * This endpoint allows uploading new images and retrieving existing images
970
+ * for use with credentials (icons, backgrounds, thumbnails, etc.).
971
+ *
972
+ * Path Parameters:
973
+ * org (str): The organization/tenant identifier
974
+ * user_id (str): The user ID making the request
975
+ *
976
+ * Query Parameters:
977
+ * query (str, required for GET): Search term to filter images by name
978
+ *
979
+ * Methods:
980
+ * GET: Retrieve images matching a search query
981
+ * POST: Upload a new image
982
+ *
983
+ * POST Request Body:
984
+ * Multipart form data containing:
985
+ * - image (file, required): The image file to upload
986
+ * - name (str, optional): A descriptive name for the image
987
+ *
988
+ * Returns:
989
+ * GET: A JSON array of image objects:
990
+ * [
991
+ * {
992
+ * "id": 123,
993
+ * "name": "Logo",
994
+ * "image": "https://example.com/media/uploaded_images/logo.png"
995
+ * },
996
+ * {
997
+ * "id": 124,
998
+ * "name": "Background",
999
+ * "image": "https://example.com/media/uploaded_images/background.jpg"
1000
+ * },
1001
+ * ...
1002
+ * ]
1003
+ *
1004
+ * POST: A JSON object containing the uploaded image details:
1005
+ * {
1006
+ * "id": 125,
1007
+ * "name": "Certificate Icon",
1008
+ * "image": "https://example.com/media/uploaded_images/certificate-icon.png"
1009
+ * }
1010
+ *
1011
+ * Error Responses:
1012
+ * 400 Bad Request: If the request data is invalid or missing required parameters
1013
+ * 401 Unauthorized: If the user is not authenticated
1014
+ * 403 Forbidden: If the user does not have permission to access this resource
1015
+ * 500 Internal Server Error: If an unexpected error occurs
1016
+ *
1017
+ * Access Control:
1018
+ * - Requires IsAdminUserOrStudentDRFMixin
1019
+ * - Only authenticated users with appropriate permissions can upload and retrieve images
1020
+ * @param org
1021
+ * @param userId
1022
+ * @returns UploadedImage
1023
+ * @throws ApiError
1024
+ */
1025
+ public static credentialsOrgsUsersImagesRetrieve(
1026
+ org: string,
1027
+ userId: string,
1028
+ ): CancelablePromise<UploadedImage> {
1029
+ return __request(OpenAPI, {
1030
+ method: 'GET',
1031
+ url: '/api/credentials/orgs/{org}/users/{user_id}/images/',
1032
+ path: {
1033
+ 'org': org,
1034
+ 'user_id': userId,
1035
+ },
1036
+ });
1037
+ }
1038
+ /**
1039
+ * API View for managing uploaded images for credentials.
1040
+ *
1041
+ * This endpoint allows uploading new images and retrieving existing images
1042
+ * for use with credentials (icons, backgrounds, thumbnails, etc.).
1043
+ *
1044
+ * Path Parameters:
1045
+ * org (str): The organization/tenant identifier
1046
+ * user_id (str): The user ID making the request
1047
+ *
1048
+ * Query Parameters:
1049
+ * query (str, required for GET): Search term to filter images by name
1050
+ *
1051
+ * Methods:
1052
+ * GET: Retrieve images matching a search query
1053
+ * POST: Upload a new image
1054
+ *
1055
+ * POST Request Body:
1056
+ * Multipart form data containing:
1057
+ * - image (file, required): The image file to upload
1058
+ * - name (str, optional): A descriptive name for the image
1059
+ *
1060
+ * Returns:
1061
+ * GET: A JSON array of image objects:
1062
+ * [
1063
+ * {
1064
+ * "id": 123,
1065
+ * "name": "Logo",
1066
+ * "image": "https://example.com/media/uploaded_images/logo.png"
1067
+ * },
1068
+ * {
1069
+ * "id": 124,
1070
+ * "name": "Background",
1071
+ * "image": "https://example.com/media/uploaded_images/background.jpg"
1072
+ * },
1073
+ * ...
1074
+ * ]
1075
+ *
1076
+ * POST: A JSON object containing the uploaded image details:
1077
+ * {
1078
+ * "id": 125,
1079
+ * "name": "Certificate Icon",
1080
+ * "image": "https://example.com/media/uploaded_images/certificate-icon.png"
1081
+ * }
1082
+ *
1083
+ * Error Responses:
1084
+ * 400 Bad Request: If the request data is invalid or missing required parameters
1085
+ * 401 Unauthorized: If the user is not authenticated
1086
+ * 403 Forbidden: If the user does not have permission to access this resource
1087
+ * 500 Internal Server Error: If an unexpected error occurs
1088
+ *
1089
+ * Access Control:
1090
+ * - Requires IsAdminUserOrStudentDRFMixin
1091
+ * - Only authenticated users with appropriate permissions can upload and retrieve images
1092
+ * @param org
1093
+ * @param userId
1094
+ * @param requestBody
1095
+ * @returns UploadedImage
1096
+ * @throws ApiError
1097
+ */
1098
+ public static credentialsOrgsUsersImagesCreate(
1099
+ org: string,
1100
+ userId: string,
1101
+ requestBody?: UploadedImage,
1102
+ ): CancelablePromise<UploadedImage> {
1103
+ return __request(OpenAPI, {
1104
+ method: 'POST',
1105
+ url: '/api/credentials/orgs/{org}/users/{user_id}/images/',
1106
+ path: {
1107
+ 'org': org,
1108
+ 'user_id': userId,
1109
+ },
1110
+ body: requestBody,
1111
+ mediaType: 'application/json',
1112
+ });
1113
+ }
1114
+ /**
1115
+ * API View for managing credential issuers.
1116
+ *
1117
+ * This endpoint allows creating and retrieving issuers for a specific organization/tenant,
1118
+ * with support for filtering and pagination.
1119
+ *
1120
+ * Path Parameters:
1121
+ * org (str): The organization/tenant identifier
1122
+ * user_id (str): The user ID making the request
1123
+ *
1124
+ * Query Parameters:
1125
+ * q (str, optional): Search term to filter issuers by name
1126
+ * limit (int, optional): Number of results per page (default: 50)
1127
+ * offset (int, optional): Starting position for pagination
1128
+ *
1129
+ * Methods:
1130
+ * GET: Retrieve issuers with filtering and pagination
1131
+ * POST: Create a new issuer
1132
+ *
1133
+ * POST Request Body:
1134
+ * A JSON object containing issuer details:
1135
+ * - name (str): Issuer name
1136
+ * - iconImage (str, optional): URL to issuer icon
1137
+ * - email (str, optional): Contact email for the issuer
1138
+ * - url (str, optional): Website URL for the issuer
1139
+ * - allowed_template_tags (array, optional): List of allowed template tags
1140
+ *
1141
+ * Returns:
1142
+ * GET: A JSON response containing:
1143
+ * {
1144
+ * "status": {"success": true, "description": "Ok"},
1145
+ * "result": {
1146
+ * "next": "URL to next page",
1147
+ * "previous": "URL to previous page",
1148
+ * "count": 10,
1149
+ * "data": [
1150
+ * {issuer object},
1151
+ * {issuer object},
1152
+ * ...
1153
+ * ],
1154
+ * "num_pages": 1,
1155
+ * "page_number": 1,
1156
+ * "max_page_size": 1000
1157
+ * }
1158
+ * }
1159
+ *
1160
+ * POST: A JSON response containing:
1161
+ * {
1162
+ * "status": {"success": true, "description": "Created"},
1163
+ * "result": {issuer object}
1164
+ * }
1165
+ *
1166
+ * Error Responses:
1167
+ * 400 Bad Request: If the request data is invalid
1168
+ * 401 Unauthorized: If the user is not authenticated
1169
+ * 403 Forbidden: If the user does not have permission to access this resource
1170
+ * 404 Not Found: If the platform doesn't exist
1171
+ * 500 Internal Server Error: If an unexpected error occurs
1172
+ *
1173
+ * Access Control:
1174
+ * - Requires IsAdminUserOrStudentDRFMixin
1175
+ * - Only authenticated users with appropriate permissions can manage issuers
1176
+ * @param org
1177
+ * @param q
1178
+ * @param userId
1179
+ * @returns Issuer
1180
+ * @throws ApiError
1181
+ */
1182
+ public static credentialsOrgsUsersIssuersRetrieve(
1183
+ org: string,
1184
+ q: string,
1185
+ userId: string,
1186
+ ): CancelablePromise<Issuer> {
1187
+ return __request(OpenAPI, {
1188
+ method: 'GET',
1189
+ url: '/api/credentials/orgs/{org}/users/{user_id}/issuers/',
1190
+ path: {
1191
+ 'org': org,
1192
+ 'user_id': userId,
1193
+ },
1194
+ query: {
1195
+ 'q': q,
1196
+ },
1197
+ });
1198
+ }
1199
+ /**
1200
+ * API View for managing credential issuers.
1201
+ *
1202
+ * This endpoint allows creating and retrieving issuers for a specific organization/tenant,
1203
+ * with support for filtering and pagination.
1204
+ *
1205
+ * Path Parameters:
1206
+ * org (str): The organization/tenant identifier
1207
+ * user_id (str): The user ID making the request
1208
+ *
1209
+ * Query Parameters:
1210
+ * q (str, optional): Search term to filter issuers by name
1211
+ * limit (int, optional): Number of results per page (default: 50)
1212
+ * offset (int, optional): Starting position for pagination
1213
+ *
1214
+ * Methods:
1215
+ * GET: Retrieve issuers with filtering and pagination
1216
+ * POST: Create a new issuer
1217
+ *
1218
+ * POST Request Body:
1219
+ * A JSON object containing issuer details:
1220
+ * - name (str): Issuer name
1221
+ * - iconImage (str, optional): URL to issuer icon
1222
+ * - email (str, optional): Contact email for the issuer
1223
+ * - url (str, optional): Website URL for the issuer
1224
+ * - allowed_template_tags (array, optional): List of allowed template tags
1225
+ *
1226
+ * Returns:
1227
+ * GET: A JSON response containing:
1228
+ * {
1229
+ * "status": {"success": true, "description": "Ok"},
1230
+ * "result": {
1231
+ * "next": "URL to next page",
1232
+ * "previous": "URL to previous page",
1233
+ * "count": 10,
1234
+ * "data": [
1235
+ * {issuer object},
1236
+ * {issuer object},
1237
+ * ...
1238
+ * ],
1239
+ * "num_pages": 1,
1240
+ * "page_number": 1,
1241
+ * "max_page_size": 1000
1242
+ * }
1243
+ * }
1244
+ *
1245
+ * POST: A JSON response containing:
1246
+ * {
1247
+ * "status": {"success": true, "description": "Created"},
1248
+ * "result": {issuer object}
1249
+ * }
1250
+ *
1251
+ * Error Responses:
1252
+ * 400 Bad Request: If the request data is invalid
1253
+ * 401 Unauthorized: If the user is not authenticated
1254
+ * 403 Forbidden: If the user does not have permission to access this resource
1255
+ * 404 Not Found: If the platform doesn't exist
1256
+ * 500 Internal Server Error: If an unexpected error occurs
1257
+ *
1258
+ * Access Control:
1259
+ * - Requires IsAdminUserOrStudentDRFMixin
1260
+ * - Only authenticated users with appropriate permissions can manage issuers
1261
+ * @param org
1262
+ * @param q
1263
+ * @param userId
1264
+ * @param requestBody
1265
+ * @returns Issuer
1266
+ * @throws ApiError
1267
+ */
1268
+ public static credentialsOrgsUsersIssuersCreate(
1269
+ org: string,
1270
+ q: string,
1271
+ userId: string,
1272
+ requestBody: Issuer,
1273
+ ): CancelablePromise<Issuer> {
1274
+ return __request(OpenAPI, {
1275
+ method: 'POST',
1276
+ url: '/api/credentials/orgs/{org}/users/{user_id}/issuers/',
1277
+ path: {
1278
+ 'org': org,
1279
+ 'user_id': userId,
1280
+ },
1281
+ query: {
1282
+ 'q': q,
1283
+ },
1284
+ body: requestBody,
1285
+ mediaType: 'application/json',
1286
+ });
1287
+ }
1288
+ /**
1289
+ * API View for managing individual issuers.
1290
+ *
1291
+ * This endpoint allows retrieving, updating, and deleting specific issuers
1292
+ * identified by their entity_id or org identifier.
1293
+ *
1294
+ * Path Parameters:
1295
+ * org (str): The organization/tenant identifier
1296
+ * user_id (str): The user ID making the request
1297
+ * entity_id (str): The issuer entity ID or org identifier
1298
+ *
1299
+ * Methods:
1300
+ * GET: Retrieve a specific issuer
1301
+ * PUT: Update a specific issuer
1302
+ * DELETE: Delete a specific issuer
1303
+ *
1304
+ * PUT Request Body:
1305
+ * A JSON object containing issuer details to update:
1306
+ * - name (str, optional): Issuer name
1307
+ * - iconImage (str, optional): URL to issuer icon
1308
+ * - email (str, optional): Contact email for the issuer
1309
+ * - url (str, optional): Website URL for the issuer
1310
+ * - allowed_template_tags (array, optional): List of allowed template tags
1311
+ *
1312
+ * Returns:
1313
+ * GET: A JSON response containing the issuer details:
1314
+ * [
1315
+ * {
1316
+ * "name": "Example University",
1317
+ * "org": "example-university",
1318
+ * "entityId": "abc123",
1319
+ * "signatories": [...],
1320
+ * "url": "https://example.com",
1321
+ * "iconImage": "https://example.com/logo.png",
1322
+ * "allowed_template_tags": [...]
1323
+ * }
1324
+ * ]
1325
+ *
1326
+ * PUT: A JSON response containing the updated issuer details:
1327
+ * [
1328
+ * {
1329
+ * "name": "Example University",
1330
+ * "org": "example-university",
1331
+ * "entityId": "abc123",
1332
+ * "signatories": [...],
1333
+ * "url": "https://example.com",
1334
+ * "iconImage": "https://example.com/new-logo.png",
1335
+ * "allowed_template_tags": [...]
1336
+ * }
1337
+ * ]
1338
+ *
1339
+ * DELETE: A JSON response indicating success:
1340
+ * {
1341
+ * "status": {"success": true, "description": "Deleted"}
1342
+ * }
1343
+ *
1344
+ * Error Responses:
1345
+ * 400 Bad Request: If the request data is invalid
1346
+ * 401 Unauthorized: If the user is not authenticated
1347
+ * 403 Forbidden: If the user does not have permission to access this resource
1348
+ * 404 Not Found: If the issuer doesn't exist
1349
+ * 500 Internal Server Error: If an unexpected error occurs
1350
+ *
1351
+ * Access Control:
1352
+ * - Requires IsAdminUserOrStudentDRFMixin
1353
+ * - Only authenticated users with appropriate permissions can manage issuers
1354
+ * @param entityId
1355
+ * @param org
1356
+ * @param userId
1357
+ * @returns Issuer
1358
+ * @throws ApiError
1359
+ */
1360
+ public static credentialsOrgsUsersIssuersRetrieve2(
1361
+ entityId: string,
1362
+ org: string,
1363
+ userId: string,
1364
+ ): CancelablePromise<Issuer> {
1365
+ return __request(OpenAPI, {
1366
+ method: 'GET',
1367
+ url: '/api/credentials/orgs/{org}/users/{user_id}/issuers/{entity_id}',
1368
+ path: {
1369
+ 'entity_id': entityId,
1370
+ 'org': org,
1371
+ 'user_id': userId,
1372
+ },
1373
+ });
1374
+ }
1375
+ /**
1376
+ * API View for managing individual issuers.
1377
+ *
1378
+ * This endpoint allows retrieving, updating, and deleting specific issuers
1379
+ * identified by their entity_id or org identifier.
1380
+ *
1381
+ * Path Parameters:
1382
+ * org (str): The organization/tenant identifier
1383
+ * user_id (str): The user ID making the request
1384
+ * entity_id (str): The issuer entity ID or org identifier
1385
+ *
1386
+ * Methods:
1387
+ * GET: Retrieve a specific issuer
1388
+ * PUT: Update a specific issuer
1389
+ * DELETE: Delete a specific issuer
1390
+ *
1391
+ * PUT Request Body:
1392
+ * A JSON object containing issuer details to update:
1393
+ * - name (str, optional): Issuer name
1394
+ * - iconImage (str, optional): URL to issuer icon
1395
+ * - email (str, optional): Contact email for the issuer
1396
+ * - url (str, optional): Website URL for the issuer
1397
+ * - allowed_template_tags (array, optional): List of allowed template tags
1398
+ *
1399
+ * Returns:
1400
+ * GET: A JSON response containing the issuer details:
1401
+ * [
1402
+ * {
1403
+ * "name": "Example University",
1404
+ * "org": "example-university",
1405
+ * "entityId": "abc123",
1406
+ * "signatories": [...],
1407
+ * "url": "https://example.com",
1408
+ * "iconImage": "https://example.com/logo.png",
1409
+ * "allowed_template_tags": [...]
1410
+ * }
1411
+ * ]
1412
+ *
1413
+ * PUT: A JSON response containing the updated issuer details:
1414
+ * [
1415
+ * {
1416
+ * "name": "Example University",
1417
+ * "org": "example-university",
1418
+ * "entityId": "abc123",
1419
+ * "signatories": [...],
1420
+ * "url": "https://example.com",
1421
+ * "iconImage": "https://example.com/new-logo.png",
1422
+ * "allowed_template_tags": [...]
1423
+ * }
1424
+ * ]
1425
+ *
1426
+ * DELETE: A JSON response indicating success:
1427
+ * {
1428
+ * "status": {"success": true, "description": "Deleted"}
1429
+ * }
1430
+ *
1431
+ * Error Responses:
1432
+ * 400 Bad Request: If the request data is invalid
1433
+ * 401 Unauthorized: If the user is not authenticated
1434
+ * 403 Forbidden: If the user does not have permission to access this resource
1435
+ * 404 Not Found: If the issuer doesn't exist
1436
+ * 500 Internal Server Error: If an unexpected error occurs
1437
+ *
1438
+ * Access Control:
1439
+ * - Requires IsAdminUserOrStudentDRFMixin
1440
+ * - Only authenticated users with appropriate permissions can manage issuers
1441
+ * @param entityId
1442
+ * @param org
1443
+ * @param userId
1444
+ * @param requestBody
1445
+ * @returns Issuer
1446
+ * @throws ApiError
1447
+ */
1448
+ public static credentialsOrgsUsersIssuersUpdate(
1449
+ entityId: string,
1450
+ org: string,
1451
+ userId: string,
1452
+ requestBody: Issuer,
1453
+ ): CancelablePromise<Issuer> {
1454
+ return __request(OpenAPI, {
1455
+ method: 'PUT',
1456
+ url: '/api/credentials/orgs/{org}/users/{user_id}/issuers/{entity_id}',
1457
+ path: {
1458
+ 'entity_id': entityId,
1459
+ 'org': org,
1460
+ 'user_id': userId,
1461
+ },
1462
+ body: requestBody,
1463
+ mediaType: 'application/json',
1464
+ });
1465
+ }
1466
+ /**
1467
+ * API View for managing individual issuers.
1468
+ *
1469
+ * This endpoint allows retrieving, updating, and deleting specific issuers
1470
+ * identified by their entity_id or org identifier.
1471
+ *
1472
+ * Path Parameters:
1473
+ * org (str): The organization/tenant identifier
1474
+ * user_id (str): The user ID making the request
1475
+ * entity_id (str): The issuer entity ID or org identifier
1476
+ *
1477
+ * Methods:
1478
+ * GET: Retrieve a specific issuer
1479
+ * PUT: Update a specific issuer
1480
+ * DELETE: Delete a specific issuer
1481
+ *
1482
+ * PUT Request Body:
1483
+ * A JSON object containing issuer details to update:
1484
+ * - name (str, optional): Issuer name
1485
+ * - iconImage (str, optional): URL to issuer icon
1486
+ * - email (str, optional): Contact email for the issuer
1487
+ * - url (str, optional): Website URL for the issuer
1488
+ * - allowed_template_tags (array, optional): List of allowed template tags
1489
+ *
1490
+ * Returns:
1491
+ * GET: A JSON response containing the issuer details:
1492
+ * [
1493
+ * {
1494
+ * "name": "Example University",
1495
+ * "org": "example-university",
1496
+ * "entityId": "abc123",
1497
+ * "signatories": [...],
1498
+ * "url": "https://example.com",
1499
+ * "iconImage": "https://example.com/logo.png",
1500
+ * "allowed_template_tags": [...]
1501
+ * }
1502
+ * ]
1503
+ *
1504
+ * PUT: A JSON response containing the updated issuer details:
1505
+ * [
1506
+ * {
1507
+ * "name": "Example University",
1508
+ * "org": "example-university",
1509
+ * "entityId": "abc123",
1510
+ * "signatories": [...],
1511
+ * "url": "https://example.com",
1512
+ * "iconImage": "https://example.com/new-logo.png",
1513
+ * "allowed_template_tags": [...]
1514
+ * }
1515
+ * ]
1516
+ *
1517
+ * DELETE: A JSON response indicating success:
1518
+ * {
1519
+ * "status": {"success": true, "description": "Deleted"}
1520
+ * }
1521
+ *
1522
+ * Error Responses:
1523
+ * 400 Bad Request: If the request data is invalid
1524
+ * 401 Unauthorized: If the user is not authenticated
1525
+ * 403 Forbidden: If the user does not have permission to access this resource
1526
+ * 404 Not Found: If the issuer doesn't exist
1527
+ * 500 Internal Server Error: If an unexpected error occurs
1528
+ *
1529
+ * Access Control:
1530
+ * - Requires IsAdminUserOrStudentDRFMixin
1531
+ * - Only authenticated users with appropriate permissions can manage issuers
1532
+ * @param entityId
1533
+ * @param org
1534
+ * @param userId
1535
+ * @returns void
1536
+ * @throws ApiError
1537
+ */
1538
+ public static credentialsOrgsUsersIssuersDestroy(
1539
+ entityId: string,
1540
+ org: string,
1541
+ userId: string,
1542
+ ): CancelablePromise<void> {
1543
+ return __request(OpenAPI, {
1544
+ method: 'DELETE',
1545
+ url: '/api/credentials/orgs/{org}/users/{user_id}/issuers/{entity_id}',
1546
+ path: {
1547
+ 'entity_id': entityId,
1548
+ 'org': org,
1549
+ 'user_id': userId,
1550
+ },
1551
+ });
1552
+ }
1553
+ /**
1554
+ * API View for managing issuer authorities (signatories).
1555
+ *
1556
+ * This endpoint allows creating authorities/signatories that can be associated
1557
+ * with issuers or specific credentials.
1558
+ *
1559
+ * Path Parameters:
1560
+ * org (str): The organization/tenant identifier
1561
+ * user_id (str): The user ID making the request
1562
+ *
1563
+ * Methods:
1564
+ * POST: Create a new issuer authority
1565
+ *
1566
+ * POST Request Body:
1567
+ * A JSON object containing authority details:
1568
+ * - name (str, required): Name of the signatory
1569
+ * - title (str, required): Title of the signatory
1570
+ * - signature (str, required): URL to the signature image
1571
+ * - org (str, optional): Organization identifier to associate with an issuer
1572
+ * - entityId (str, optional): Issuer entity ID to associate with
1573
+ * - credential (str, optional): Credential entity ID to associate with
1574
+ *
1575
+ * Returns:
1576
+ * POST: A JSON response containing the created authority:
1577
+ * {
1578
+ * "data": {
1579
+ * "name": "John Smith",
1580
+ * "title": "President",
1581
+ * "signature": "https://example.com/signatures/john-smith.png"
1582
+ * }
1583
+ * }
1584
+ *
1585
+ * Error Responses:
1586
+ * 400 Bad Request: If the request data is invalid or missing required fields
1587
+ * 401 Unauthorized: If the user is not authenticated
1588
+ * 403 Forbidden: If the user does not have permission to access this resource
1589
+ * 404 Not Found: If the issuer or credential doesn't exist
1590
+ * 500 Internal Server Error: If an unexpected error occurs
1591
+ *
1592
+ * Access Control:
1593
+ * - Requires IsAdminUserOrStudentDRFMixin
1594
+ * - Only authenticated users with appropriate permissions can manage authorities
1595
+ * @param org
1596
+ * @param userId
1597
+ * @param requestBody
1598
+ * @returns IssuerAuthority
1599
+ * @throws ApiError
1600
+ */
1601
+ public static credentialsOrgsUsersIssuersAuthorityCreate(
1602
+ org: string,
1603
+ userId: string,
1604
+ requestBody: IssuerAuthority,
1605
+ ): CancelablePromise<IssuerAuthority> {
1606
+ return __request(OpenAPI, {
1607
+ method: 'POST',
1608
+ url: '/api/credentials/orgs/{org}/users/{user_id}/issuers/authority/',
1609
+ path: {
1610
+ 'org': org,
1611
+ 'user_id': userId,
1612
+ },
1613
+ body: requestBody,
1614
+ mediaType: 'application/json',
1615
+ });
1616
+ }
1617
+ /**
1618
+ * Public endpoint to retrieve a specific credential assertion by its entity ID.
1619
+ *
1620
+ * This endpoint allows public access to view a specific credential assertion
1621
+ * without authentication.
1622
+ *
1623
+ * Path Parameters:
1624
+ * entity_id (str): The assertion entity ID
1625
+ *
1626
+ * Returns:
1627
+ * A JSON response containing the assertion details using the AssertionSerializer format
1628
+ *
1629
+ * Error Responses:
1630
+ * 404 Not Found: If the assertion doesn't exist
1631
+ * 500 Internal Server Error: If an unexpected error occurs
1632
+ * @param entityId
1633
+ * @returns any No response body
1634
+ * @throws ApiError
1635
+ */
1636
+ public static credentialsPublicAssertionsRetrieve(
1637
+ entityId: string,
1638
+ ): CancelablePromise<any> {
1639
+ return __request(OpenAPI, {
1640
+ method: 'GET',
1641
+ url: '/api/credentials/public/assertions/{entity_id}/',
1642
+ path: {
1643
+ 'entity_id': entityId,
1644
+ },
1645
+ });
1646
+ }
1647
+ }