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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (544) hide show
  1. package/README.md +222 -0
  2. package/dist/index.cjs.js +17341 -0
  3. package/dist/index.cjs.js.map +1 -0
  4. package/dist/index.esm.js +17310 -0
  5. package/dist/index.esm.js.map +1 -0
  6. package/dist/index.umd.js +17347 -0
  7. package/dist/index.umd.js.map +1 -0
  8. package/dist/types/core/ApiError.d.ts +10 -0
  9. package/dist/types/core/ApiRequestOptions.d.ts +13 -0
  10. package/dist/types/core/ApiResult.d.ts +7 -0
  11. package/dist/types/core/CancelablePromise.d.ts +20 -0
  12. package/dist/types/core/OpenAPI.d.ts +16 -0
  13. package/dist/types/core/request.d.ts +30 -0
  14. package/dist/types/index.d.ts +264 -0
  15. package/dist/types/models/AWSTenantLaunchRequest.d.ts +20 -0
  16. package/dist/types/models/AcceptanceEnum.d.ts +10 -0
  17. package/dist/types/models/ActivateUserFreeTrial.d.ts +11 -0
  18. package/dist/types/models/ActiveUsersData.d.ts +18 -0
  19. package/dist/types/models/ActiveUsersList.d.ts +6 -0
  20. package/dist/types/models/ActiveUsersPerCourse.d.ts +10 -0
  21. package/dist/types/models/ActiveUsersPerCourseData.d.ts +14 -0
  22. package/dist/types/models/ActivityAPI.d.ts +8 -0
  23. package/dist/types/models/ActivityData.d.ts +38 -0
  24. package/dist/types/models/App.d.ts +10 -0
  25. package/dist/types/models/AppleSubscriptionStatusRequest.d.ts +3 -0
  26. package/dist/types/models/AppleSubscriptionStatusView.d.ts +3 -0
  27. package/dist/types/models/AppleVerifyTransactionId.d.ts +3 -0
  28. package/dist/types/models/Assertion.d.ts +15 -0
  29. package/dist/types/models/AssociateAccountResponse.d.ts +5 -0
  30. package/dist/types/models/AssociateAppleAccount.d.ts +3 -0
  31. package/dist/types/models/AuthToken.d.ts +10 -0
  32. package/dist/types/models/Average.d.ts +4 -0
  33. package/dist/types/models/AverageData.d.ts +6 -0
  34. package/dist/types/models/AverageOvertime.d.ts +22 -0
  35. package/dist/types/models/AvgCourseGradeWithCutoff.d.ts +4 -0
  36. package/dist/types/models/AvgCourseGradeWithCutoffData.d.ts +10 -0
  37. package/dist/types/models/BaseErrorResponse.d.ts +5 -0
  38. package/dist/types/models/BaseResponse.d.ts +5 -0
  39. package/dist/types/models/BlankEnum.d.ts +2 -0
  40. package/dist/types/models/BulkCreateAssertion.d.ts +4 -0
  41. package/dist/types/models/CampaignEnablement.d.ts +8 -0
  42. package/dist/types/models/CampaignExclusion.d.ts +8 -0
  43. package/dist/types/models/CeleryHeartbeat.d.ts +5 -0
  44. package/dist/types/models/CeleryHeartbeatFail.d.ts +5 -0
  45. package/dist/types/models/CeleryHeartbeatFailStatusEnum.d.ts +8 -0
  46. package/dist/types/models/CeleryHeartbeatStatusEnum.d.ts +8 -0
  47. package/dist/types/models/Company.d.ts +23 -0
  48. package/dist/types/models/ContextResponse.d.ts +7 -0
  49. package/dist/types/models/Count.d.ts +4 -0
  50. package/dist/types/models/CountData.d.ts +6 -0
  51. package/dist/types/models/CourseCompletionPerCourse.d.ts +6 -0
  52. package/dist/types/models/CourseCompletionPerCourseData.d.ts +22 -0
  53. package/dist/types/models/CourseCompletionSummaryDataOvertime.d.ts +18 -0
  54. package/dist/types/models/CourseCompletionSummaryOvertime.d.ts +6 -0
  55. package/dist/types/models/CourseGradeDetailBlock.d.ts +18 -0
  56. package/dist/types/models/CourseGradeDetailSubSection.d.ts +23 -0
  57. package/dist/types/models/CourseGradeSummary.d.ts +4 -0
  58. package/dist/types/models/CourseGradeSummaryData.d.ts +18 -0
  59. package/dist/types/models/CourseGradingDetail.d.ts +4 -0
  60. package/dist/types/models/CourseGradingDetailData.d.ts +12 -0
  61. package/dist/types/models/CoursePoint.d.ts +7 -0
  62. package/dist/types/models/CourseSkill.d.ts +8 -0
  63. package/dist/types/models/Credential.d.ts +28 -0
  64. package/dist/types/models/DesiredRole.d.ts +4 -0
  65. package/dist/types/models/DesiredSkill.d.ts +4 -0
  66. package/dist/types/models/DetailedGradeSubsection.d.ts +22 -0
  67. package/dist/types/models/DetailedGradeView.d.ts +4 -0
  68. package/dist/types/models/DetailedGradeViewData.d.ts +12 -0
  69. package/dist/types/models/Education.d.ts +30 -0
  70. package/dist/types/models/EdxSignalReceiverRequest.d.ts +4 -0
  71. package/dist/types/models/EngagementPerCourse.d.ts +6 -0
  72. package/dist/types/models/EngagementPerCourseData.d.ts +26 -0
  73. package/dist/types/models/Enrollments.d.ts +8 -0
  74. package/dist/types/models/EnrollmentsData.d.ts +18 -0
  75. package/dist/types/models/EnrollmentsPerUser.d.ts +6 -0
  76. package/dist/types/models/EnrollmentsPerUserData.d.ts +18 -0
  77. package/dist/types/models/ErrorResponse.d.ts +8 -0
  78. package/dist/types/models/Experience.d.ts +29 -0
  79. package/dist/types/models/FloatOverTime.d.ts +10 -0
  80. package/dist/types/models/GCPTenantLaunchRequest.d.ts +24 -0
  81. package/dist/types/models/GooglePayAccountResponse.d.ts +15 -0
  82. package/dist/types/models/GooglePayAccountResponseStatusEnum.d.ts +8 -0
  83. package/dist/types/models/GooglePayVerifyToken.d.ts +6 -0
  84. package/dist/types/models/GradingPerUser.d.ts +8 -0
  85. package/dist/types/models/GradingPerUserData.d.ts +26 -0
  86. package/dist/types/models/GroupList.d.ts +6 -0
  87. package/dist/types/models/GroupListData.d.ts +16 -0
  88. package/dist/types/models/ImageUpload.d.ts +3 -0
  89. package/dist/types/models/Institution.d.ts +20 -0
  90. package/dist/types/models/InstitutionTypeEnum.d.ts +14 -0
  91. package/dist/types/models/Issuer.d.ts +9 -0
  92. package/dist/types/models/IssuerAuthority.d.ts +5 -0
  93. package/dist/types/models/ItemTypeEnum.d.ts +18 -0
  94. package/dist/types/models/LauncherViewPostRequest.d.ts +9 -0
  95. package/dist/types/models/LearnerInformationAPI.d.ts +4 -0
  96. package/dist/types/models/LearnerInformationAPIData.d.ts +83 -0
  97. package/dist/types/models/LtiKey.d.ts +19 -0
  98. package/dist/types/models/LtiLaunchGate.d.ts +8 -0
  99. package/dist/types/models/LtiTool.d.ts +46 -0
  100. package/dist/types/models/ManagerAuthToken.d.ts +13 -0
  101. package/dist/types/models/MarkAllReadRequest.d.ts +9 -0
  102. package/dist/types/models/MarkAllReadResponse.d.ts +7 -0
  103. package/dist/types/models/MediaResource.d.ts +71 -0
  104. package/dist/types/models/MediaTypeEnum.d.ts +14 -0
  105. package/dist/types/models/ModeEnum.d.ts +10 -0
  106. package/dist/types/models/NetRevenueOverTime.d.ts +8 -0
  107. package/dist/types/models/NewPerLearnerList.d.ts +6 -0
  108. package/dist/types/models/NewPerLearnerListData.d.ts +17 -0
  109. package/dist/types/models/Notification.d.ts +14 -0
  110. package/dist/types/models/NotificationCount.d.ts +4 -0
  111. package/dist/types/models/NotificationPreview.d.ts +31 -0
  112. package/dist/types/models/NotificationSource.d.ts +8 -0
  113. package/dist/types/models/NotificationStatusEnum.d.ts +10 -0
  114. package/dist/types/models/NotificationTemplateData.d.ts +26 -0
  115. package/dist/types/models/OnboardingStatusUpdate.d.ts +7 -0
  116. package/dist/types/models/Order.d.ts +22 -0
  117. package/dist/types/models/OverTime.d.ts +3 -0
  118. package/dist/types/models/OverTimeWithTotal.d.ts +22 -0
  119. package/dist/types/models/OvertimeMeta.d.ts +30 -0
  120. package/dist/types/models/OvertimeWithChangeInfo.d.ts +24 -0
  121. package/dist/types/models/PaginatedUserAppList.d.ts +7 -0
  122. package/dist/types/models/Pagination.d.ts +18 -0
  123. package/dist/types/models/PatchedMediaResource.d.ts +71 -0
  124. package/dist/types/models/PatchedNotification.d.ts +14 -0
  125. package/dist/types/models/PatchedPlatformPublicMetadata.d.ts +8 -0
  126. package/dist/types/models/PatchedSkillThreshold.d.ts +14 -0
  127. package/dist/types/models/PerLearnerCourseLastAccessData.d.ts +30 -0
  128. package/dist/types/models/PerLearnerCourseVideosWatched.d.ts +8 -0
  129. package/dist/types/models/PerLearnerCourseVideosWatchedData.d.ts +14 -0
  130. package/dist/types/models/PerLearnerLastAccess.d.ts +4 -0
  131. package/dist/types/models/PerLearnerLastAccessData.d.ts +11 -0
  132. package/dist/types/models/PerLearnerTimeSpentInCourseTree.d.ts +8 -0
  133. package/dist/types/models/PerformanceGradesPerCourse.d.ts +6 -0
  134. package/dist/types/models/PerformanceGradesPerCourseData.d.ts +22 -0
  135. package/dist/types/models/PerlearnerCourseProgress.d.ts +4 -0
  136. package/dist/types/models/PerlearnerCourseProgressData.d.ts +6 -0
  137. package/dist/types/models/PerlearnerEngagementVideosData.d.ts +30 -0
  138. package/dist/types/models/PerlearnerEngagementVideosWatchedPerCourse.d.ts +4 -0
  139. package/dist/types/models/PerlearnerGradeSummary.d.ts +4 -0
  140. package/dist/types/models/PerlearnerGradeSummaryData.d.ts +18 -0
  141. package/dist/types/models/PerlearnerGradeWithCutOff.d.ts +4 -0
  142. package/dist/types/models/PerlearnerGradeWithCutOffData.d.ts +10 -0
  143. package/dist/types/models/PerlearnerGradingPerCourseAPI.d.ts +4 -0
  144. package/dist/types/models/PerlearnerGradingPerCourseAPIData.d.ts +34 -0
  145. package/dist/types/models/PerlearnerUserList.d.ts +6 -0
  146. package/dist/types/models/PerlearnerUserListData.d.ts +34 -0
  147. package/dist/types/models/Platform.d.ts +29 -0
  148. package/dist/types/models/PlatformApiKey.d.ts +30 -0
  149. package/dist/types/models/PlatformList.d.ts +29 -0
  150. package/dist/types/models/PlatformListStatusEnum.d.ts +22 -0
  151. package/dist/types/models/PlatformPublicMetadata.d.ts +8 -0
  152. package/dist/types/models/PlatformUpdatePostRequest.d.ts +9 -0
  153. package/dist/types/models/PointsPercentile.d.ts +8 -0
  154. package/dist/types/models/PreviewResponse.d.ts +11 -0
  155. package/dist/types/models/Product.d.ts +22 -0
  156. package/dist/types/models/ProductTable.d.ts +26 -0
  157. package/dist/types/models/Program.d.ts +24 -0
  158. package/dist/types/models/ProgramTypeEnum.d.ts +18 -0
  159. package/dist/types/models/Recipient.d.ts +8 -0
  160. package/dist/types/models/RecommendationSearchAPI.d.ts +3 -0
  161. package/dist/types/models/RedirectTokenRequest.d.ts +3 -0
  162. package/dist/types/models/RedirectTokenResponse.d.ts +5 -0
  163. package/dist/types/models/ReportCreate.d.ts +7 -0
  164. package/dist/types/models/ReportData.d.ts +28 -0
  165. package/dist/types/models/ReportDetail.d.ts +4 -0
  166. package/dist/types/models/ReportList.d.ts +4 -0
  167. package/dist/types/models/ReportRequest.d.ts +21 -0
  168. package/dist/types/models/ReportStatus.d.ts +41 -0
  169. package/dist/types/models/ReportedRole.d.ts +4 -0
  170. package/dist/types/models/ReportedSkill.d.ts +4 -0
  171. package/dist/types/models/Resource.d.ts +22 -0
  172. package/dist/types/models/ResourceCreateUpdate.d.ts +42 -0
  173. package/dist/types/models/ResourcePoint.d.ts +7 -0
  174. package/dist/types/models/RevenueByProduct.d.ts +6 -0
  175. package/dist/types/models/Role.d.ts +7 -0
  176. package/dist/types/models/SendNotification.d.ts +6 -0
  177. package/dist/types/models/SendResponse.d.ts +9 -0
  178. package/dist/types/models/Skill.d.ts +7 -0
  179. package/dist/types/models/SkillDetail.d.ts +9 -0
  180. package/dist/types/models/SkillInfo.d.ts +23 -0
  181. package/dist/types/models/SkillThreshold.d.ts +14 -0
  182. package/dist/types/models/StateEnum.d.ts +22 -0
  183. package/dist/types/models/StripeCheckoutSessionRequest.d.ts +54 -0
  184. package/dist/types/models/StripeCheckoutSessionResponse.d.ts +6 -0
  185. package/dist/types/models/StripeCustomerPortalRequest.d.ts +3 -0
  186. package/dist/types/models/StripeCustomerPortalResponse.d.ts +3 -0
  187. package/dist/types/models/StripeLocalProduct.d.ts +8 -0
  188. package/dist/types/models/StripeSubscriptionRenewalRequest.d.ts +4 -0
  189. package/dist/types/models/StripeSubscriptionRenewalResponse.d.ts +3 -0
  190. package/dist/types/models/SubTimeChild.d.ts +18 -0
  191. package/dist/types/models/Summary.d.ts +18 -0
  192. package/dist/types/models/TenantLaunchError.d.ts +10 -0
  193. package/dist/types/models/TenantLaunchFailed.d.ts +15 -0
  194. package/dist/types/models/TenantLaunchRequest.d.ts +16 -0
  195. package/dist/types/models/TenantLaunchResponse.d.ts +15 -0
  196. package/dist/types/models/TimeChildData.d.ts +20 -0
  197. package/dist/types/models/TimeDetail.d.ts +8 -0
  198. package/dist/types/models/TimeDetailChild.d.ts +26 -0
  199. package/dist/types/models/TimeDetailData.d.ts +24 -0
  200. package/dist/types/models/TimeSpentByUsersInCourse.d.ts +6 -0
  201. package/dist/types/models/TimeSpentByUsersInCourseData.d.ts +22 -0
  202. package/dist/types/models/TimeSpentPerCourse.d.ts +6 -0
  203. package/dist/types/models/TimeSpentPerCourseData.d.ts +26 -0
  204. package/dist/types/models/TimeSpentPerUserResponse.d.ts +3 -0
  205. package/dist/types/models/TimeSpentUpdateRequest.d.ts +34 -0
  206. package/dist/types/models/TimeSpentUpdateResponse.d.ts +4 -0
  207. package/dist/types/models/TokenProxyInput.d.ts +21 -0
  208. package/dist/types/models/TokenProxyOutput.d.ts +7 -0
  209. package/dist/types/models/TokenProxyOutputSerializerData.d.ts +20 -0
  210. package/dist/types/models/TokenProxyUser.d.ts +25 -0
  211. package/dist/types/models/TypeEnum.d.ts +18 -0
  212. package/dist/types/models/UploadedImage.d.ts +5 -0
  213. package/dist/types/models/UserApp.d.ts +27 -0
  214. package/dist/types/models/UserDeleteAPIError.d.ts +3 -0
  215. package/dist/types/models/UserDeleteAPIRequest.d.ts +3 -0
  216. package/dist/types/models/UserDeleteAPIResponse.d.ts +3 -0
  217. package/dist/types/models/UserInfo.d.ts +13 -0
  218. package/dist/types/models/UserPlatformLink.d.ts +17 -0
  219. package/dist/types/models/UserPlatformManagementListViewGetResponse.d.ts +6 -0
  220. package/dist/types/models/UserPlatformViewPostRequest.d.ts +8 -0
  221. package/dist/types/models/UserProxyBulkRequest.d.ts +3 -0
  222. package/dist/types/models/UserProxyGetResponse.d.ts +8 -0
  223. package/dist/types/models/UserProxyPostRequest.d.ts +7 -0
  224. package/dist/types/models/UserProxyPostResponse.d.ts +8 -0
  225. package/dist/types/models/UserSearchViewGetResponse.d.ts +6 -0
  226. package/dist/types/models/UserSkill.d.ts +22 -0
  227. package/dist/types/models/UserSkillPointsPercentile.d.ts +8 -0
  228. package/dist/types/models/ValidateSourceResponse.d.ts +10 -0
  229. package/dist/types/models/Value.d.ts +4 -0
  230. package/dist/types/models/ValueData.d.ts +6 -0
  231. package/dist/types/models/VerifyGCPMarketPlaceFailedResponse.d.ts +11 -0
  232. package/dist/types/models/VerifyGCPMarketPlaceRequest.d.ts +3 -0
  233. package/dist/types/models/VerifyGCPMarketPlaceResponse.d.ts +11 -0
  234. package/dist/types/models/VideoBlock.d.ts +14 -0
  235. package/dist/types/models/VideoEngagementPerCourse.d.ts +6 -0
  236. package/dist/types/models/VideoEngagementPerCourseData.d.ts +30 -0
  237. package/dist/types/models/VideosCount.d.ts +4 -0
  238. package/dist/types/models/VideosCountData.d.ts +6 -0
  239. package/dist/types/models/VideosInCourseSummary.d.ts +4 -0
  240. package/dist/types/models/VideosInCourseSummaryData.d.ts +12 -0
  241. package/dist/types/models/VideosSpecificCourse.d.ts +4 -0
  242. package/dist/types/models/VideosSpecificCourseData.d.ts +26 -0
  243. package/dist/types/models/VideosWatchedSubSection.d.ts +19 -0
  244. package/dist/types/models/WatchedVideosPerCourse.d.ts +8 -0
  245. package/dist/types/models/WatchedVideosPerCourseData.d.ts +18 -0
  246. package/dist/types/models/WatchedVideosPerUser.d.ts +8 -0
  247. package/dist/types/models/WatchedVideosPerUserData.d.ts +18 -0
  248. package/dist/types/models/WhitelistedDomain.d.ts +4 -0
  249. package/dist/types/services/AnalyticsService.d.ts +54 -0
  250. package/dist/types/services/AudienceService.d.ts +348 -0
  251. package/dist/types/services/CareerService.d.ts +210 -0
  252. package/dist/types/services/CatalogService.d.ts +6904 -0
  253. package/dist/types/services/CoreService.d.ts +638 -0
  254. package/dist/types/services/CredentialsService.d.ts +1186 -0
  255. package/dist/types/services/DepartmentsService.d.ts +43 -0
  256. package/dist/types/services/EngagementService.d.ts +467 -0
  257. package/dist/types/services/FeaturesService.d.ts +75 -0
  258. package/dist/types/services/FinanceService.d.ts +52 -0
  259. package/dist/types/services/MediaResourcesService.d.ts +112 -0
  260. package/dist/types/services/NotificationBuilderService.d.ts +58 -0
  261. package/dist/types/services/NotificationService.d.ts +128 -0
  262. package/dist/types/services/OverviewService.d.ts +184 -0
  263. package/dist/types/services/PerformanceService.d.ts +183 -0
  264. package/dist/types/services/PerlearnerService.d.ts +501 -0
  265. package/dist/types/services/PlatformService.d.ts +391 -0
  266. package/dist/types/services/ProvidersService.d.ts +142 -0
  267. package/dist/types/services/ProvisionService.d.ts +14 -0
  268. package/dist/types/services/RecommendationsService.d.ts +13 -0
  269. package/dist/types/services/ReportsService.d.ts +142 -0
  270. package/dist/types/services/RolesService.d.ts +57 -0
  271. package/dist/types/services/SearchService.d.ts +172 -0
  272. package/dist/types/services/ServiceService.d.ts +170 -0
  273. package/dist/types/services/SkillsService.d.ts +377 -0
  274. package/dist/types/services/UserGroupsService.d.ts +49 -0
  275. package/package.json +39 -0
  276. package/rollup.config.js +113 -0
  277. package/src/core/ApiError.ts +25 -0
  278. package/src/core/ApiRequestOptions.ts +17 -0
  279. package/src/core/ApiResult.ts +11 -0
  280. package/src/core/CancelablePromise.ts +131 -0
  281. package/src/core/OpenAPI.ts +32 -0
  282. package/src/core/request.ts +322 -0
  283. package/src/index.ts +270 -0
  284. package/src/models/AWSTenantLaunchRequest.ts +25 -0
  285. package/src/models/AcceptanceEnum.ts +14 -0
  286. package/src/models/ActivateUserFreeTrial.ts +16 -0
  287. package/src/models/ActiveUsersData.ts +23 -0
  288. package/src/models/ActiveUsersList.ts +11 -0
  289. package/src/models/ActiveUsersPerCourse.ts +15 -0
  290. package/src/models/ActiveUsersPerCourseData.ts +19 -0
  291. package/src/models/ActivityAPI.ts +13 -0
  292. package/src/models/ActivityData.ts +43 -0
  293. package/src/models/App.ts +15 -0
  294. package/src/models/AppleSubscriptionStatusRequest.ts +8 -0
  295. package/src/models/AppleSubscriptionStatusView.ts +8 -0
  296. package/src/models/AppleVerifyTransactionId.ts +8 -0
  297. package/src/models/Assertion.ts +20 -0
  298. package/src/models/AssociateAccountResponse.ts +10 -0
  299. package/src/models/AssociateAppleAccount.ts +8 -0
  300. package/src/models/AuthToken.ts +15 -0
  301. package/src/models/Average.ts +9 -0
  302. package/src/models/AverageData.ts +11 -0
  303. package/src/models/AverageOvertime.ts +27 -0
  304. package/src/models/AvgCourseGradeWithCutoff.ts +9 -0
  305. package/src/models/AvgCourseGradeWithCutoffData.ts +15 -0
  306. package/src/models/BaseErrorResponse.ts +10 -0
  307. package/src/models/BaseResponse.ts +10 -0
  308. package/src/models/BlankEnum.ts +7 -0
  309. package/src/models/BulkCreateAssertion.ts +9 -0
  310. package/src/models/CampaignEnablement.ts +13 -0
  311. package/src/models/CampaignExclusion.ts +13 -0
  312. package/src/models/CeleryHeartbeat.ts +10 -0
  313. package/src/models/CeleryHeartbeatFail.ts +10 -0
  314. package/src/models/CeleryHeartbeatFailStatusEnum.ts +12 -0
  315. package/src/models/CeleryHeartbeatStatusEnum.ts +12 -0
  316. package/src/models/Company.ts +28 -0
  317. package/src/models/ContextResponse.ts +12 -0
  318. package/src/models/Count.ts +9 -0
  319. package/src/models/CountData.ts +11 -0
  320. package/src/models/CourseCompletionPerCourse.ts +11 -0
  321. package/src/models/CourseCompletionPerCourseData.ts +27 -0
  322. package/src/models/CourseCompletionSummaryDataOvertime.ts +23 -0
  323. package/src/models/CourseCompletionSummaryOvertime.ts +11 -0
  324. package/src/models/CourseGradeDetailBlock.ts +23 -0
  325. package/src/models/CourseGradeDetailSubSection.ts +28 -0
  326. package/src/models/CourseGradeSummary.ts +9 -0
  327. package/src/models/CourseGradeSummaryData.ts +23 -0
  328. package/src/models/CourseGradingDetail.ts +9 -0
  329. package/src/models/CourseGradingDetailData.ts +17 -0
  330. package/src/models/CoursePoint.ts +12 -0
  331. package/src/models/CourseSkill.ts +13 -0
  332. package/src/models/Credential.ts +33 -0
  333. package/src/models/DesiredRole.ts +9 -0
  334. package/src/models/DesiredSkill.ts +9 -0
  335. package/src/models/DetailedGradeSubsection.ts +27 -0
  336. package/src/models/DetailedGradeView.ts +9 -0
  337. package/src/models/DetailedGradeViewData.ts +17 -0
  338. package/src/models/Education.ts +35 -0
  339. package/src/models/EdxSignalReceiverRequest.ts +9 -0
  340. package/src/models/EngagementPerCourse.ts +11 -0
  341. package/src/models/EngagementPerCourseData.ts +31 -0
  342. package/src/models/Enrollments.ts +13 -0
  343. package/src/models/EnrollmentsData.ts +23 -0
  344. package/src/models/EnrollmentsPerUser.ts +11 -0
  345. package/src/models/EnrollmentsPerUserData.ts +23 -0
  346. package/src/models/ErrorResponse.ts +13 -0
  347. package/src/models/Experience.ts +34 -0
  348. package/src/models/FloatOverTime.ts +15 -0
  349. package/src/models/GCPTenantLaunchRequest.ts +29 -0
  350. package/src/models/GooglePayAccountResponse.ts +20 -0
  351. package/src/models/GooglePayAccountResponseStatusEnum.ts +12 -0
  352. package/src/models/GooglePayVerifyToken.ts +11 -0
  353. package/src/models/GradingPerUser.ts +13 -0
  354. package/src/models/GradingPerUserData.ts +31 -0
  355. package/src/models/GroupList.ts +11 -0
  356. package/src/models/GroupListData.ts +21 -0
  357. package/src/models/ImageUpload.ts +8 -0
  358. package/src/models/Institution.ts +25 -0
  359. package/src/models/InstitutionTypeEnum.ts +18 -0
  360. package/src/models/Issuer.ts +14 -0
  361. package/src/models/IssuerAuthority.ts +10 -0
  362. package/src/models/ItemTypeEnum.ts +22 -0
  363. package/src/models/LauncherViewPostRequest.ts +14 -0
  364. package/src/models/LearnerInformationAPI.ts +9 -0
  365. package/src/models/LearnerInformationAPIData.ts +88 -0
  366. package/src/models/LtiKey.ts +24 -0
  367. package/src/models/LtiLaunchGate.ts +13 -0
  368. package/src/models/LtiTool.ts +51 -0
  369. package/src/models/ManagerAuthToken.ts +18 -0
  370. package/src/models/MarkAllReadRequest.ts +14 -0
  371. package/src/models/MarkAllReadResponse.ts +12 -0
  372. package/src/models/MediaResource.ts +76 -0
  373. package/src/models/MediaTypeEnum.ts +18 -0
  374. package/src/models/ModeEnum.ts +14 -0
  375. package/src/models/NetRevenueOverTime.ts +13 -0
  376. package/src/models/NewPerLearnerList.ts +11 -0
  377. package/src/models/NewPerLearnerListData.ts +22 -0
  378. package/src/models/Notification.ts +19 -0
  379. package/src/models/NotificationCount.ts +9 -0
  380. package/src/models/NotificationPreview.ts +36 -0
  381. package/src/models/NotificationSource.ts +13 -0
  382. package/src/models/NotificationStatusEnum.ts +14 -0
  383. package/src/models/NotificationTemplateData.ts +31 -0
  384. package/src/models/OnboardingStatusUpdate.ts +12 -0
  385. package/src/models/Order.ts +27 -0
  386. package/src/models/OverTime.ts +8 -0
  387. package/src/models/OverTimeWithTotal.ts +27 -0
  388. package/src/models/OvertimeMeta.ts +35 -0
  389. package/src/models/OvertimeWithChangeInfo.ts +29 -0
  390. package/src/models/PaginatedUserAppList.ts +12 -0
  391. package/src/models/Pagination.ts +23 -0
  392. package/src/models/PatchedMediaResource.ts +76 -0
  393. package/src/models/PatchedNotification.ts +19 -0
  394. package/src/models/PatchedPlatformPublicMetadata.ts +13 -0
  395. package/src/models/PatchedSkillThreshold.ts +19 -0
  396. package/src/models/PerLearnerCourseLastAccessData.ts +35 -0
  397. package/src/models/PerLearnerCourseVideosWatched.ts +13 -0
  398. package/src/models/PerLearnerCourseVideosWatchedData.ts +19 -0
  399. package/src/models/PerLearnerLastAccess.ts +9 -0
  400. package/src/models/PerLearnerLastAccessData.ts +16 -0
  401. package/src/models/PerLearnerTimeSpentInCourseTree.ts +13 -0
  402. package/src/models/PerformanceGradesPerCourse.ts +11 -0
  403. package/src/models/PerformanceGradesPerCourseData.ts +27 -0
  404. package/src/models/PerlearnerCourseProgress.ts +9 -0
  405. package/src/models/PerlearnerCourseProgressData.ts +11 -0
  406. package/src/models/PerlearnerEngagementVideosData.ts +35 -0
  407. package/src/models/PerlearnerEngagementVideosWatchedPerCourse.ts +9 -0
  408. package/src/models/PerlearnerGradeSummary.ts +9 -0
  409. package/src/models/PerlearnerGradeSummaryData.ts +23 -0
  410. package/src/models/PerlearnerGradeWithCutOff.ts +9 -0
  411. package/src/models/PerlearnerGradeWithCutOffData.ts +15 -0
  412. package/src/models/PerlearnerGradingPerCourseAPI.ts +9 -0
  413. package/src/models/PerlearnerGradingPerCourseAPIData.ts +39 -0
  414. package/src/models/PerlearnerUserList.ts +11 -0
  415. package/src/models/PerlearnerUserListData.ts +39 -0
  416. package/src/models/Platform.ts +34 -0
  417. package/src/models/PlatformApiKey.ts +35 -0
  418. package/src/models/PlatformList.ts +34 -0
  419. package/src/models/PlatformListStatusEnum.ts +26 -0
  420. package/src/models/PlatformPublicMetadata.ts +13 -0
  421. package/src/models/PlatformUpdatePostRequest.ts +14 -0
  422. package/src/models/PointsPercentile.ts +13 -0
  423. package/src/models/PreviewResponse.ts +16 -0
  424. package/src/models/Product.ts +27 -0
  425. package/src/models/ProductTable.ts +31 -0
  426. package/src/models/Program.ts +29 -0
  427. package/src/models/ProgramTypeEnum.ts +22 -0
  428. package/src/models/Recipient.ts +13 -0
  429. package/src/models/RecommendationSearchAPI.ts +8 -0
  430. package/src/models/RedirectTokenRequest.ts +8 -0
  431. package/src/models/RedirectTokenResponse.ts +10 -0
  432. package/src/models/ReportCreate.ts +12 -0
  433. package/src/models/ReportData.ts +33 -0
  434. package/src/models/ReportDetail.ts +9 -0
  435. package/src/models/ReportList.ts +9 -0
  436. package/src/models/ReportRequest.ts +26 -0
  437. package/src/models/ReportStatus.ts +46 -0
  438. package/src/models/ReportedRole.ts +9 -0
  439. package/src/models/ReportedSkill.ts +9 -0
  440. package/src/models/Resource.ts +27 -0
  441. package/src/models/ResourceCreateUpdate.ts +47 -0
  442. package/src/models/ResourcePoint.ts +12 -0
  443. package/src/models/RevenueByProduct.ts +11 -0
  444. package/src/models/Role.ts +12 -0
  445. package/src/models/SendNotification.ts +11 -0
  446. package/src/models/SendResponse.ts +14 -0
  447. package/src/models/Skill.ts +12 -0
  448. package/src/models/SkillDetail.ts +14 -0
  449. package/src/models/SkillInfo.ts +28 -0
  450. package/src/models/SkillThreshold.ts +19 -0
  451. package/src/models/StateEnum.ts +26 -0
  452. package/src/models/StripeCheckoutSessionRequest.ts +59 -0
  453. package/src/models/StripeCheckoutSessionResponse.ts +11 -0
  454. package/src/models/StripeCustomerPortalRequest.ts +8 -0
  455. package/src/models/StripeCustomerPortalResponse.ts +8 -0
  456. package/src/models/StripeLocalProduct.ts +13 -0
  457. package/src/models/StripeSubscriptionRenewalRequest.ts +9 -0
  458. package/src/models/StripeSubscriptionRenewalResponse.ts +8 -0
  459. package/src/models/SubTimeChild.ts +23 -0
  460. package/src/models/Summary.ts +23 -0
  461. package/src/models/TenantLaunchError.ts +15 -0
  462. package/src/models/TenantLaunchFailed.ts +20 -0
  463. package/src/models/TenantLaunchRequest.ts +21 -0
  464. package/src/models/TenantLaunchResponse.ts +20 -0
  465. package/src/models/TimeChildData.ts +25 -0
  466. package/src/models/TimeDetail.ts +13 -0
  467. package/src/models/TimeDetailChild.ts +31 -0
  468. package/src/models/TimeDetailData.ts +29 -0
  469. package/src/models/TimeSpentByUsersInCourse.ts +11 -0
  470. package/src/models/TimeSpentByUsersInCourseData.ts +27 -0
  471. package/src/models/TimeSpentPerCourse.ts +11 -0
  472. package/src/models/TimeSpentPerCourseData.ts +31 -0
  473. package/src/models/TimeSpentPerUserResponse.ts +8 -0
  474. package/src/models/TimeSpentUpdateRequest.ts +39 -0
  475. package/src/models/TimeSpentUpdateResponse.ts +9 -0
  476. package/src/models/TokenProxyInput.ts +26 -0
  477. package/src/models/TokenProxyOutput.ts +12 -0
  478. package/src/models/TokenProxyOutputSerializerData.ts +25 -0
  479. package/src/models/TokenProxyUser.ts +30 -0
  480. package/src/models/TypeEnum.ts +22 -0
  481. package/src/models/UploadedImage.ts +10 -0
  482. package/src/models/UserApp.ts +32 -0
  483. package/src/models/UserDeleteAPIError.ts +8 -0
  484. package/src/models/UserDeleteAPIRequest.ts +8 -0
  485. package/src/models/UserDeleteAPIResponse.ts +8 -0
  486. package/src/models/UserInfo.ts +18 -0
  487. package/src/models/UserPlatformLink.ts +22 -0
  488. package/src/models/UserPlatformManagementListViewGetResponse.ts +11 -0
  489. package/src/models/UserPlatformViewPostRequest.ts +13 -0
  490. package/src/models/UserProxyBulkRequest.ts +8 -0
  491. package/src/models/UserProxyGetResponse.ts +13 -0
  492. package/src/models/UserProxyPostRequest.ts +12 -0
  493. package/src/models/UserProxyPostResponse.ts +13 -0
  494. package/src/models/UserSearchViewGetResponse.ts +11 -0
  495. package/src/models/UserSkill.ts +27 -0
  496. package/src/models/UserSkillPointsPercentile.ts +13 -0
  497. package/src/models/ValidateSourceResponse.ts +15 -0
  498. package/src/models/Value.ts +9 -0
  499. package/src/models/ValueData.ts +11 -0
  500. package/src/models/VerifyGCPMarketPlaceFailedResponse.ts +16 -0
  501. package/src/models/VerifyGCPMarketPlaceRequest.ts +8 -0
  502. package/src/models/VerifyGCPMarketPlaceResponse.ts +16 -0
  503. package/src/models/VideoBlock.ts +19 -0
  504. package/src/models/VideoEngagementPerCourse.ts +11 -0
  505. package/src/models/VideoEngagementPerCourseData.ts +35 -0
  506. package/src/models/VideosCount.ts +9 -0
  507. package/src/models/VideosCountData.ts +11 -0
  508. package/src/models/VideosInCourseSummary.ts +9 -0
  509. package/src/models/VideosInCourseSummaryData.ts +17 -0
  510. package/src/models/VideosSpecificCourse.ts +9 -0
  511. package/src/models/VideosSpecificCourseData.ts +31 -0
  512. package/src/models/VideosWatchedSubSection.ts +24 -0
  513. package/src/models/WatchedVideosPerCourse.ts +13 -0
  514. package/src/models/WatchedVideosPerCourseData.ts +23 -0
  515. package/src/models/WatchedVideosPerUser.ts +13 -0
  516. package/src/models/WatchedVideosPerUserData.ts +23 -0
  517. package/src/models/WhitelistedDomain.ts +9 -0
  518. package/src/services/AnalyticsService.ts +103 -0
  519. package/src/services/AudienceService.ts +602 -0
  520. package/src/services/CareerService.ts +568 -0
  521. package/src/services/CatalogService.ts +7769 -0
  522. package/src/services/CoreService.ts +1278 -0
  523. package/src/services/CredentialsService.ts +1649 -0
  524. package/src/services/DepartmentsService.ts +85 -0
  525. package/src/services/EngagementService.ts +907 -0
  526. package/src/services/FeaturesService.ts +126 -0
  527. package/src/services/FinanceService.ts +136 -0
  528. package/src/services/MediaResourcesService.ts +319 -0
  529. package/src/services/NotificationBuilderService.ts +133 -0
  530. package/src/services/NotificationService.ts +317 -0
  531. package/src/services/OverviewService.ts +324 -0
  532. package/src/services/PerformanceService.ts +329 -0
  533. package/src/services/PerlearnerService.ts +1009 -0
  534. package/src/services/PlatformService.ts +763 -0
  535. package/src/services/ProvidersService.ts +271 -0
  536. package/src/services/ProvisionService.ts +30 -0
  537. package/src/services/RecommendationsService.ts +31 -0
  538. package/src/services/ReportsService.ts +218 -0
  539. package/src/services/RolesService.ts +87 -0
  540. package/src/services/SearchService.ts +332 -0
  541. package/src/services/ServiceService.ts +320 -0
  542. package/src/services/SkillsService.ts +521 -0
  543. package/src/services/UserGroupsService.ts +91 -0
  544. package/tsconfig.json +15 -0
@@ -0,0 +1,24 @@
1
+ import type { OvertimeMeta } from './OvertimeMeta';
2
+ /**
3
+ * Returns
4
+ * {
5
+ * "data": {
6
+ * "2022-04-26": 0,
7
+ * "2022-04-27": 0,
8
+ * ...
9
+ * "2023-01-01": 0
10
+ * },
11
+ * "total": 0
12
+ * }
13
+ */
14
+ export type OvertimeWithChangeInfo = {
15
+ /**
16
+ * Dates are keys and values are the value for the date in the key. e,g `{"2020-01-01": 30. ...}`
17
+ */
18
+ data?: Record<string, any>;
19
+ /**
20
+ * Total
21
+ */
22
+ total?: number;
23
+ meta: OvertimeMeta;
24
+ };
@@ -0,0 +1,7 @@
1
+ import type { UserApp } from './UserApp';
2
+ export type PaginatedUserAppList = {
3
+ count: number;
4
+ next?: string | null;
5
+ previous?: string | null;
6
+ results: Array<UserApp>;
7
+ };
@@ -0,0 +1,18 @@
1
+ export type Pagination = {
2
+ /**
3
+ * Total records
4
+ */
5
+ totalItems: number;
6
+ /**
7
+ * Current Page
8
+ */
9
+ currentPage: number;
10
+ /**
11
+ * Size of data returned per page
12
+ */
13
+ perPage: number;
14
+ /**
15
+ * Amount of pages
16
+ */
17
+ totalPages: number;
18
+ };
@@ -0,0 +1,71 @@
1
+ import type { ItemTypeEnum } from './ItemTypeEnum';
2
+ import type { MediaTypeEnum } from './MediaTypeEnum';
3
+ export type PatchedMediaResource = {
4
+ readonly id?: number;
5
+ /**
6
+ * Title of the media resource
7
+ */
8
+ title?: string;
9
+ /**
10
+ * Description of the media resource
11
+ */
12
+ description?: string | null;
13
+ /**
14
+ * Type of media
15
+ *
16
+ * * `video` - Video
17
+ * * `image` - Image
18
+ * * `document` - Document
19
+ * * `audio` - Audio
20
+ * * `other` - Other
21
+ */
22
+ media_type?: MediaTypeEnum;
23
+ /**
24
+ * Type of item this media is associated with
25
+ *
26
+ * * `course` - Course
27
+ * * `unit` - Unit
28
+ * * `resource` - Resource
29
+ * * `course_unit` - Course and Unit
30
+ * * `course_resource` - Course and Resource
31
+ * * `unit_resource` - Unit and Resource
32
+ * * `all` - Course, Unit, and Resource
33
+ */
34
+ readonly item_type?: ItemTypeEnum;
35
+ /**
36
+ * ID of the associated course
37
+ */
38
+ course_id?: string | null;
39
+ /**
40
+ * ID of the associated unit
41
+ */
42
+ unit_id?: string | null;
43
+ /**
44
+ * ID of the associated item (resource)
45
+ */
46
+ item_id?: string | null;
47
+ /**
48
+ * The platform this media resource belongs to
49
+ */
50
+ readonly platform?: number;
51
+ /**
52
+ * External URL for the media resource
53
+ */
54
+ file_url?: string | null;
55
+ /**
56
+ * Uploaded media file
57
+ */
58
+ file?: string | null;
59
+ /**
60
+ * User who created this media resource
61
+ */
62
+ readonly created_by?: number | null;
63
+ /**
64
+ * When this record was created
65
+ */
66
+ readonly created_at?: string;
67
+ /**
68
+ * When this record was last updated
69
+ */
70
+ readonly updated_at?: string;
71
+ };
@@ -0,0 +1,14 @@
1
+ import type { BlankEnum } from './BlankEnum';
2
+ import type { NotificationStatusEnum } from './NotificationStatusEnum';
3
+ export type PatchedNotification = {
4
+ readonly id?: string;
5
+ username?: string;
6
+ readonly title?: string;
7
+ readonly body?: string;
8
+ status?: (NotificationStatusEnum | BlankEnum);
9
+ readonly channel?: string | null;
10
+ context?: any;
11
+ readonly short_message?: string;
12
+ created_at?: string;
13
+ readonly updated_at?: string;
14
+ };
@@ -0,0 +1,8 @@
1
+ export type PatchedPlatformPublicMetadata = {
2
+ readonly platform_key?: string;
3
+ readonly platform_name?: string;
4
+ /**
5
+ * The public metadata
6
+ */
7
+ metadata?: any;
8
+ };
@@ -0,0 +1,14 @@
1
+ export type PatchedSkillThreshold = {
2
+ /**
3
+ * The name of the threshold e.g Beginner.
4
+ */
5
+ name?: string;
6
+ /**
7
+ * The threshold for the skill.
8
+ */
9
+ threshold?: number;
10
+ /**
11
+ * The platform key
12
+ */
13
+ platform?: string;
14
+ };
@@ -0,0 +1,30 @@
1
+ export type PerLearnerCourseLastAccessData = {
2
+ /**
3
+ * Edx Course ID
4
+ */
5
+ course_id?: string;
6
+ /**
7
+ * Course Name
8
+ */
9
+ course_name?: string;
10
+ /**
11
+ * Last Block Accessed
12
+ */
13
+ block_id?: string;
14
+ /**
15
+ * Last Block Display Name
16
+ */
17
+ block_display_name?: string;
18
+ /**
19
+ * Course grade
20
+ */
21
+ course_grade?: number;
22
+ /**
23
+ * Course progress
24
+ */
25
+ course_progress?: number;
26
+ /**
27
+ * Last accessed time
28
+ */
29
+ last_accessed?: string;
30
+ };
@@ -0,0 +1,8 @@
1
+ import type { PerLearnerCourseVideosWatchedData } from './PerLearnerCourseVideosWatchedData';
2
+ export type PerLearnerCourseVideosWatched = {
3
+ data: Array<PerLearnerCourseVideosWatchedData>;
4
+ /**
5
+ * videos watched
6
+ */
7
+ total: number;
8
+ };
@@ -0,0 +1,14 @@
1
+ export type PerLearnerCourseVideosWatchedData = {
2
+ /**
3
+ * Video Id
4
+ */
5
+ id: string;
6
+ /**
7
+ * Video Name
8
+ */
9
+ name: string;
10
+ /**
11
+ * Watch status
12
+ */
13
+ watched: boolean;
14
+ };
@@ -0,0 +1,4 @@
1
+ import type { PerLearnerLastAccessData } from './PerLearnerLastAccessData';
2
+ export type PerLearnerLastAccess = {
3
+ data?: PerLearnerLastAccessData;
4
+ };
@@ -0,0 +1,11 @@
1
+ import type { PerLearnerCourseLastAccessData } from './PerLearnerCourseLastAccessData';
2
+ export type PerLearnerLastAccessData = {
3
+ /**
4
+ * Course last accessed metadata
5
+ */
6
+ course_last_accessed?: PerLearnerCourseLastAccessData;
7
+ /**
8
+ * Last accessed time
9
+ */
10
+ last_accessed?: string;
11
+ };
@@ -0,0 +1,8 @@
1
+ import type { TimeChildData } from './TimeChildData';
2
+ export type PerLearnerTimeSpentInCourseTree = {
3
+ data?: Array<TimeChildData>;
4
+ /**
5
+ * Total time spent
6
+ */
7
+ total?: number;
8
+ };
@@ -0,0 +1,6 @@
1
+ import type { Pagination } from './Pagination';
2
+ import type { PerformanceGradesPerCourseData } from './PerformanceGradesPerCourseData';
3
+ export type PerformanceGradesPerCourse = {
4
+ data?: Array<PerformanceGradesPerCourseData>;
5
+ pagination: Pagination;
6
+ };
@@ -0,0 +1,22 @@
1
+ export type PerformanceGradesPerCourseData = {
2
+ /**
3
+ * Course name
4
+ */
5
+ name: string;
6
+ /**
7
+ * Course id
8
+ */
9
+ course_id: string;
10
+ /**
11
+ * Course enrollments
12
+ */
13
+ num_enrollments: number;
14
+ /**
15
+ * Total users who have passed the course
16
+ */
17
+ num_passed: number;
18
+ /**
19
+ * Course Average grade
20
+ */
21
+ avg_grade: number;
22
+ };
@@ -0,0 +1,4 @@
1
+ import type { PerlearnerCourseProgressData } from './PerlearnerCourseProgressData';
2
+ export type PerlearnerCourseProgress = {
3
+ data: PerlearnerCourseProgressData;
4
+ };
@@ -0,0 +1,6 @@
1
+ export type PerlearnerCourseProgressData = {
2
+ /**
3
+ * Perlearner Course progress
4
+ */
5
+ progress: number;
6
+ };
@@ -0,0 +1,30 @@
1
+ export type PerlearnerEngagementVideosData = {
2
+ /**
3
+ * Edx Course ID
4
+ */
5
+ course_id: string;
6
+ /**
7
+ * Course Name
8
+ */
9
+ name: string;
10
+ /**
11
+ * Total course videos
12
+ */
13
+ total_videos: number;
14
+ /**
15
+ * Total videos watched by student
16
+ */
17
+ watched: number;
18
+ /**
19
+ * Total time user watched video
20
+ */
21
+ total_time_watch: number;
22
+ /**
23
+ * Average videos watched by students in course
24
+ */
25
+ average_class_watch: number;
26
+ /**
27
+ * Average time spent by students on this course
28
+ */
29
+ class_time_average: number;
30
+ };
@@ -0,0 +1,4 @@
1
+ import type { PerlearnerEngagementVideosData } from './PerlearnerEngagementVideosData';
2
+ export type PerlearnerEngagementVideosWatchedPerCourse = {
3
+ data: Array<PerlearnerEngagementVideosData>;
4
+ };
@@ -0,0 +1,4 @@
1
+ import type { PerlearnerGradeSummaryData } from './PerlearnerGradeSummaryData';
2
+ export type PerlearnerGradeSummary = {
3
+ data?: Array<PerlearnerGradeSummaryData>;
4
+ };
@@ -0,0 +1,18 @@
1
+ export type PerlearnerGradeSummaryData = {
2
+ /**
3
+ * Assignment Type name
4
+ */
5
+ assignment_type: string;
6
+ /**
7
+ * Assignment weight
8
+ */
9
+ weight: number;
10
+ /**
11
+ * Assignment grade
12
+ */
13
+ weighted_grade: number;
14
+ /**
15
+ * Assignment section grade average in course
16
+ */
17
+ average_section_grade: number;
18
+ };
@@ -0,0 +1,4 @@
1
+ import type { PerlearnerGradeWithCutOffData } from './PerlearnerGradeWithCutOffData';
2
+ export type PerlearnerGradeWithCutOff = {
3
+ data?: PerlearnerGradeWithCutOffData;
4
+ };
@@ -0,0 +1,10 @@
1
+ export type PerlearnerGradeWithCutOffData = {
2
+ /**
3
+ * Dictionary showing grade cutoffs
4
+ */
5
+ grade_cutoffs: Record<string, any>;
6
+ /**
7
+ * Grade
8
+ */
9
+ grade: number;
10
+ };
@@ -0,0 +1,4 @@
1
+ import type { PerlearnerGradingPerCourseAPIData } from './PerlearnerGradingPerCourseAPIData';
2
+ export type PerlearnerGradingPerCourseAPI = {
3
+ data: Array<PerlearnerGradingPerCourseAPIData>;
4
+ };
@@ -0,0 +1,34 @@
1
+ export type PerlearnerGradingPerCourseAPIData = {
2
+ /**
3
+ * Edx Course ID
4
+ */
5
+ course_id: string;
6
+ /**
7
+ * Course Name
8
+ */
9
+ name: string;
10
+ /**
11
+ * Total problems in course
12
+ */
13
+ graded_activities: string;
14
+ /**
15
+ * Cumulative problem submissions
16
+ */
17
+ submissions: number;
18
+ /**
19
+ * Number of problems from total problems attempted
20
+ */
21
+ problems_attempted: number;
22
+ /**
23
+ * Number of problems answered correctly
24
+ */
25
+ assignments_correct: number;
26
+ /**
27
+ * Average grade obtained by all learner in the course
28
+ */
29
+ class_average: number;
30
+ /**
31
+ * Learner course grade
32
+ */
33
+ grade: number;
34
+ };
@@ -0,0 +1,6 @@
1
+ import type { Pagination } from './Pagination';
2
+ import type { PerlearnerUserListData } from './PerlearnerUserListData';
3
+ export type PerlearnerUserList = {
4
+ data?: Array<PerlearnerUserListData>;
5
+ pagination: Pagination;
6
+ };
@@ -0,0 +1,34 @@
1
+ export type PerlearnerUserListData = {
2
+ /**
3
+ * learner username
4
+ */
5
+ username: string;
6
+ /**
7
+ * learner Name
8
+ */
9
+ full_name: string;
10
+ /**
11
+ * Total enrollments
12
+ */
13
+ enrollments: number;
14
+ /**
15
+ * Total completions
16
+ */
17
+ completions: number;
18
+ /**
19
+ * Last active time
20
+ */
21
+ last_active: string;
22
+ /**
23
+ * Time spent formatted in seconds
24
+ */
25
+ time_spent: string;
26
+ /**
27
+ * Engagement index
28
+ */
29
+ engagement_index: number;
30
+ /**
31
+ * Performance index
32
+ */
33
+ performance_index: number;
34
+ };
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Note: Create and update operations deprecated.
3
+ */
4
+ export type Platform = {
5
+ /**
6
+ * The platform key
7
+ */
8
+ key: string;
9
+ /**
10
+ * The name of the platform
11
+ */
12
+ name?: string | null;
13
+ /**
14
+ * The associated edX org code
15
+ */
16
+ org?: string | null;
17
+ /**
18
+ * The LMS URL for the platform
19
+ */
20
+ lms_url?: string | null;
21
+ /**
22
+ * The CMS URL for the platform
23
+ */
24
+ cms_url?: string | null;
25
+ /**
26
+ * The portal URL for the platform
27
+ */
28
+ portal_url?: string | null;
29
+ };
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Serializer for PlatformApiKey's
3
+ */
4
+ export type PlatformApiKey = {
5
+ /**
6
+ * Username that created token
7
+ */
8
+ readonly username: string;
9
+ /**
10
+ * Name of the token. Used by the user to identify the token.
11
+ */
12
+ name: string;
13
+ readonly key: string;
14
+ /**
15
+ * The platform key
16
+ */
17
+ platform_key: string;
18
+ /**
19
+ * When token expires
20
+ */
21
+ readonly expires: string;
22
+ /**
23
+ * Optional duration until key expires. Format: [DD] [HH:[MM:]]ss[.uuuuuu]
24
+ */
25
+ expires_in?: string | null;
26
+ /**
27
+ * When token was created
28
+ */
29
+ readonly created: string;
30
+ };
@@ -0,0 +1,29 @@
1
+ import type { PlatformListStatusEnum } from './PlatformListStatusEnum';
2
+ export type PlatformList = {
3
+ /**
4
+ * The platform key
5
+ */
6
+ key: string;
7
+ /**
8
+ * The name of the platform
9
+ */
10
+ name?: string | null;
11
+ /**
12
+ * The associated edX org code
13
+ */
14
+ org?: string | null;
15
+ /**
16
+ * The LMS URL for the platform
17
+ */
18
+ lms_url?: string | null;
19
+ /**
20
+ * The CMS URL for the platform
21
+ */
22
+ cms_url?: string | null;
23
+ /**
24
+ * The portal URL for the platform
25
+ */
26
+ portal_url?: string | null;
27
+ status?: PlatformListStatusEnum;
28
+ active?: boolean;
29
+ };
@@ -0,0 +1,22 @@
1
+ /**
2
+ * * `-2` - FAILED
3
+ * * `-1` - TERMINATED
4
+ * * `0` - PENDING
5
+ * * `1` - BUILDING
6
+ * * `2` - RUNNING
7
+ * * `3` - PAUSED
8
+ * * `4` - STOPPING
9
+ * * `5` - STOPPED
10
+ * * `6` - REPAIR
11
+ */
12
+ export declare enum PlatformListStatusEnum {
13
+ '_-2' = -2,
14
+ '_-1' = -1,
15
+ '_0' = 0,
16
+ '_1' = 1,
17
+ '_2' = 2,
18
+ '_3' = 3,
19
+ '_4' = 4,
20
+ '_5' = 5,
21
+ '_6' = 6
22
+ }
@@ -0,0 +1,8 @@
1
+ export type PlatformPublicMetadata = {
2
+ readonly platform_key: string;
3
+ readonly platform_name: string;
4
+ /**
5
+ * The public metadata
6
+ */
7
+ metadata?: any;
8
+ };
@@ -0,0 +1,9 @@
1
+ export type PlatformUpdatePostRequest = {
2
+ user_id: number;
3
+ key: string;
4
+ new_key?: string;
5
+ name?: string;
6
+ lms_url?: string;
7
+ cms_url?: string;
8
+ portal_url?: string;
9
+ };
@@ -0,0 +1,8 @@
1
+ export type PointsPercentile = {
2
+ username: string;
3
+ points: number;
4
+ /**
5
+ * Percentile of points for user. If an `org` was provided, this is the percentile of the user relative to users within the org.
6
+ */
7
+ percentile: number;
8
+ };
@@ -0,0 +1,11 @@
1
+ import type { Recipient } from './Recipient';
2
+ /**
3
+ * Response serializer for notification preview
4
+ */
5
+ export type PreviewResponse = {
6
+ status: string;
7
+ build_id: string;
8
+ count: number;
9
+ warning: string | null;
10
+ recipients: Array<Recipient>;
11
+ };
@@ -0,0 +1,22 @@
1
+ export type Product = {
2
+ /**
3
+ * Product Name
4
+ */
5
+ name: string;
6
+ /**
7
+ * Product type (Course or Program)
8
+ */
9
+ type: string;
10
+ /**
11
+ * Product slug
12
+ */
13
+ slug: string;
14
+ /**
15
+ * DateTime product was created
16
+ */
17
+ created_on: string;
18
+ /**
19
+ * Product cost
20
+ */
21
+ price: string;
22
+ };
@@ -0,0 +1,26 @@
1
+ export type ProductTable = {
2
+ /**
3
+ * Product name
4
+ */
5
+ name: string;
6
+ /**
7
+ * Product Type (Course or Program)
8
+ */
9
+ type: string;
10
+ /**
11
+ * Gross sales for product
12
+ */
13
+ total_sales: number;
14
+ /**
15
+ * Total of all coupons for product
16
+ */
17
+ coupons: number;
18
+ /**
19
+ * Net sales for product
20
+ */
21
+ net_sales: number;
22
+ /**
23
+ * Quantity of product purchased
24
+ */
25
+ orders: number;
26
+ };