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