@iblai/iblai-api 3.34.5-core

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (382) hide show
  1. package/README.md +222 -0
  2. package/dist/index.cjs.js +7291 -0
  3. package/dist/index.cjs.js.map +1 -0
  4. package/dist/index.esm.js +7267 -0
  5. package/dist/index.esm.js.map +1 -0
  6. package/dist/index.umd.js +7297 -0
  7. package/dist/index.umd.js.map +1 -0
  8. package/dist/types/core/ApiError.d.ts +10 -0
  9. package/dist/types/core/ApiRequestOptions.d.ts +13 -0
  10. package/dist/types/core/ApiResult.d.ts +7 -0
  11. package/dist/types/core/CancelablePromise.d.ts +20 -0
  12. package/dist/types/core/OpenAPI.d.ts +16 -0
  13. package/dist/types/core/request.d.ts +30 -0
  14. package/dist/types/index.d.ts +183 -0
  15. package/dist/types/models/AcceptanceEnum.d.ts +10 -0
  16. package/dist/types/models/ActiveUsersData.d.ts +18 -0
  17. package/dist/types/models/ActiveUsersList.d.ts +6 -0
  18. package/dist/types/models/ActiveUsersPerCourse.d.ts +10 -0
  19. package/dist/types/models/ActiveUsersPerCourseData.d.ts +14 -0
  20. package/dist/types/models/ActivityAPI.d.ts +8 -0
  21. package/dist/types/models/ActivityData.d.ts +38 -0
  22. package/dist/types/models/Assertion.d.ts +15 -0
  23. package/dist/types/models/Average.d.ts +4 -0
  24. package/dist/types/models/AverageData.d.ts +6 -0
  25. package/dist/types/models/AverageOvertime.d.ts +22 -0
  26. package/dist/types/models/AvgCourseGradeWithCutoff.d.ts +4 -0
  27. package/dist/types/models/AvgCourseGradeWithCutoffData.d.ts +10 -0
  28. package/dist/types/models/BlankEnum.d.ts +2 -0
  29. package/dist/types/models/BulkCreateAssertion.d.ts +4 -0
  30. package/dist/types/models/CampaignEnablement.d.ts +8 -0
  31. package/dist/types/models/CampaignExclusion.d.ts +8 -0
  32. package/dist/types/models/Company.d.ts +23 -0
  33. package/dist/types/models/ContextResponse.d.ts +7 -0
  34. package/dist/types/models/Count.d.ts +4 -0
  35. package/dist/types/models/CountData.d.ts +6 -0
  36. package/dist/types/models/CourseCompletionPerCourse.d.ts +6 -0
  37. package/dist/types/models/CourseCompletionPerCourseData.d.ts +22 -0
  38. package/dist/types/models/CourseCompletionSummaryDataOvertime.d.ts +18 -0
  39. package/dist/types/models/CourseCompletionSummaryOvertime.d.ts +6 -0
  40. package/dist/types/models/CourseGradeDetailBlock.d.ts +18 -0
  41. package/dist/types/models/CourseGradeDetailSubSection.d.ts +23 -0
  42. package/dist/types/models/CourseGradeSummary.d.ts +4 -0
  43. package/dist/types/models/CourseGradeSummaryData.d.ts +18 -0
  44. package/dist/types/models/CourseGradingDetail.d.ts +4 -0
  45. package/dist/types/models/CourseGradingDetailData.d.ts +12 -0
  46. package/dist/types/models/CoursePoint.d.ts +7 -0
  47. package/dist/types/models/CourseSkill.d.ts +8 -0
  48. package/dist/types/models/Credential.d.ts +28 -0
  49. package/dist/types/models/DesiredSkill.d.ts +4 -0
  50. package/dist/types/models/DetailedGradeSubsection.d.ts +22 -0
  51. package/dist/types/models/DetailedGradeView.d.ts +4 -0
  52. package/dist/types/models/DetailedGradeViewData.d.ts +12 -0
  53. package/dist/types/models/Education.d.ts +30 -0
  54. package/dist/types/models/EngagementPerCourse.d.ts +6 -0
  55. package/dist/types/models/EngagementPerCourseData.d.ts +26 -0
  56. package/dist/types/models/Enrollments.d.ts +8 -0
  57. package/dist/types/models/EnrollmentsData.d.ts +18 -0
  58. package/dist/types/models/EnrollmentsPerUser.d.ts +6 -0
  59. package/dist/types/models/EnrollmentsPerUserData.d.ts +18 -0
  60. package/dist/types/models/ErrorResponse.d.ts +8 -0
  61. package/dist/types/models/Experience.d.ts +29 -0
  62. package/dist/types/models/FloatOverTime.d.ts +10 -0
  63. package/dist/types/models/GradingPerUser.d.ts +8 -0
  64. package/dist/types/models/GradingPerUserData.d.ts +26 -0
  65. package/dist/types/models/GroupList.d.ts +6 -0
  66. package/dist/types/models/GroupListData.d.ts +16 -0
  67. package/dist/types/models/ImageUpload.d.ts +3 -0
  68. package/dist/types/models/Institution.d.ts +20 -0
  69. package/dist/types/models/InstitutionTypeEnum.d.ts +14 -0
  70. package/dist/types/models/Issuer.d.ts +9 -0
  71. package/dist/types/models/IssuerAuthority.d.ts +5 -0
  72. package/dist/types/models/LearnerInformationAPI.d.ts +4 -0
  73. package/dist/types/models/LearnerInformationAPIData.d.ts +83 -0
  74. package/dist/types/models/LtiKey.d.ts +19 -0
  75. package/dist/types/models/LtiLaunchGate.d.ts +8 -0
  76. package/dist/types/models/LtiTool.d.ts +46 -0
  77. package/dist/types/models/NetRevenueOverTime.d.ts +8 -0
  78. package/dist/types/models/NewPerLearnerList.d.ts +6 -0
  79. package/dist/types/models/NewPerLearnerListData.d.ts +17 -0
  80. package/dist/types/models/Notification.d.ts +13 -0
  81. package/dist/types/models/NotificationCount.d.ts +4 -0
  82. package/dist/types/models/NotificationPreview.d.ts +31 -0
  83. package/dist/types/models/NotificationSource.d.ts +8 -0
  84. package/dist/types/models/NotificationTemplateData.d.ts +26 -0
  85. package/dist/types/models/Order.d.ts +22 -0
  86. package/dist/types/models/OverTime.d.ts +3 -0
  87. package/dist/types/models/OverTimeWithTotal.d.ts +22 -0
  88. package/dist/types/models/OvertimeMeta.d.ts +30 -0
  89. package/dist/types/models/OvertimeWithChangeInfo.d.ts +24 -0
  90. package/dist/types/models/Pagination.d.ts +18 -0
  91. package/dist/types/models/PatchedNotification.d.ts +13 -0
  92. package/dist/types/models/PatchedPlatformPublicMetadata.d.ts +8 -0
  93. package/dist/types/models/PatchedSkillThreshold.d.ts +14 -0
  94. package/dist/types/models/PerLearnerCourseLastAccessData.d.ts +30 -0
  95. package/dist/types/models/PerLearnerCourseVideosWatched.d.ts +8 -0
  96. package/dist/types/models/PerLearnerCourseVideosWatchedData.d.ts +14 -0
  97. package/dist/types/models/PerLearnerLastAccess.d.ts +4 -0
  98. package/dist/types/models/PerLearnerLastAccessData.d.ts +11 -0
  99. package/dist/types/models/PerLearnerTimeSpentInCourseTree.d.ts +8 -0
  100. package/dist/types/models/PerformanceGradesPerCourse.d.ts +6 -0
  101. package/dist/types/models/PerformanceGradesPerCourseData.d.ts +22 -0
  102. package/dist/types/models/PerlearnerCourseProgress.d.ts +4 -0
  103. package/dist/types/models/PerlearnerCourseProgressData.d.ts +6 -0
  104. package/dist/types/models/PerlearnerEngagementVideosData.d.ts +30 -0
  105. package/dist/types/models/PerlearnerEngagementVideosWatchedPerCourse.d.ts +4 -0
  106. package/dist/types/models/PerlearnerGradeSummary.d.ts +4 -0
  107. package/dist/types/models/PerlearnerGradeSummaryData.d.ts +18 -0
  108. package/dist/types/models/PerlearnerGradeWithCutOff.d.ts +4 -0
  109. package/dist/types/models/PerlearnerGradeWithCutOffData.d.ts +10 -0
  110. package/dist/types/models/PerlearnerGradingPerCourseAPI.d.ts +4 -0
  111. package/dist/types/models/PerlearnerGradingPerCourseAPIData.d.ts +34 -0
  112. package/dist/types/models/PerlearnerUserList.d.ts +6 -0
  113. package/dist/types/models/PerlearnerUserListData.d.ts +34 -0
  114. package/dist/types/models/PlatformPublicMetadata.d.ts +8 -0
  115. package/dist/types/models/PointsPercentile.d.ts +8 -0
  116. package/dist/types/models/PreviewResponse.d.ts +11 -0
  117. package/dist/types/models/Product.d.ts +22 -0
  118. package/dist/types/models/ProductTable.d.ts +26 -0
  119. package/dist/types/models/Program.d.ts +24 -0
  120. package/dist/types/models/ProgramTypeEnum.d.ts +18 -0
  121. package/dist/types/models/Recipient.d.ts +8 -0
  122. package/dist/types/models/RecommendationSearchAPI.d.ts +3 -0
  123. package/dist/types/models/RedirectTokenRequest.d.ts +3 -0
  124. package/dist/types/models/RedirectTokenResponse.d.ts +5 -0
  125. package/dist/types/models/ReportCreate.d.ts +7 -0
  126. package/dist/types/models/ReportData.d.ts +28 -0
  127. package/dist/types/models/ReportDetail.d.ts +4 -0
  128. package/dist/types/models/ReportList.d.ts +4 -0
  129. package/dist/types/models/ReportRequest.d.ts +21 -0
  130. package/dist/types/models/ReportStatus.d.ts +41 -0
  131. package/dist/types/models/ReportedSkill.d.ts +4 -0
  132. package/dist/types/models/ResourcePoint.d.ts +7 -0
  133. package/dist/types/models/RevenueByProduct.d.ts +6 -0
  134. package/dist/types/models/SendNotification.d.ts +6 -0
  135. package/dist/types/models/SendResponse.d.ts +9 -0
  136. package/dist/types/models/Skill.d.ts +7 -0
  137. package/dist/types/models/SkillDetail.d.ts +9 -0
  138. package/dist/types/models/SkillInfo.d.ts +23 -0
  139. package/dist/types/models/SkillThreshold.d.ts +14 -0
  140. package/dist/types/models/StateEnum.d.ts +22 -0
  141. package/dist/types/models/StatusEnum.d.ts +10 -0
  142. package/dist/types/models/SubTimeChild.d.ts +18 -0
  143. package/dist/types/models/Summary.d.ts +18 -0
  144. package/dist/types/models/TimeChildData.d.ts +20 -0
  145. package/dist/types/models/TimeDetail.d.ts +8 -0
  146. package/dist/types/models/TimeDetailChild.d.ts +26 -0
  147. package/dist/types/models/TimeDetailData.d.ts +24 -0
  148. package/dist/types/models/TimeSpentByUsersInCourse.d.ts +6 -0
  149. package/dist/types/models/TimeSpentByUsersInCourseData.d.ts +22 -0
  150. package/dist/types/models/TimeSpentPerCourse.d.ts +6 -0
  151. package/dist/types/models/TimeSpentPerCourseData.d.ts +26 -0
  152. package/dist/types/models/TimeSpentPerUserResponse.d.ts +3 -0
  153. package/dist/types/models/TimeSpentUpdateRequest.d.ts +11 -0
  154. package/dist/types/models/TimeSpentUpdateResponse.d.ts +4 -0
  155. package/dist/types/models/TypeEnum.d.ts +18 -0
  156. package/dist/types/models/UploadedImage.d.ts +5 -0
  157. package/dist/types/models/UserInfo.d.ts +13 -0
  158. package/dist/types/models/UserSkill.d.ts +22 -0
  159. package/dist/types/models/UserSkillPointsPercentile.d.ts +8 -0
  160. package/dist/types/models/ValidateSourceResponse.d.ts +10 -0
  161. package/dist/types/models/Value.d.ts +4 -0
  162. package/dist/types/models/ValueData.d.ts +6 -0
  163. package/dist/types/models/VideoBlock.d.ts +14 -0
  164. package/dist/types/models/VideoEngagementPerCourse.d.ts +6 -0
  165. package/dist/types/models/VideoEngagementPerCourseData.d.ts +30 -0
  166. package/dist/types/models/VideosCount.d.ts +4 -0
  167. package/dist/types/models/VideosCountData.d.ts +6 -0
  168. package/dist/types/models/VideosInCourseSummary.d.ts +4 -0
  169. package/dist/types/models/VideosInCourseSummaryData.d.ts +12 -0
  170. package/dist/types/models/VideosSpecificCourse.d.ts +4 -0
  171. package/dist/types/models/VideosSpecificCourseData.d.ts +26 -0
  172. package/dist/types/models/VideosWatchedSubSection.d.ts +19 -0
  173. package/dist/types/models/WatchedVideosPerUser.d.ts +8 -0
  174. package/dist/types/models/WatchedVideosPerUserData.d.ts +18 -0
  175. package/dist/types/services/AnalyticsService.d.ts +51 -0
  176. package/dist/types/services/AudienceService.d.ts +348 -0
  177. package/dist/types/services/CareerService.d.ts +210 -0
  178. package/dist/types/services/CoreService.d.ts +196 -0
  179. package/dist/types/services/CredentialsService.d.ts +1184 -0
  180. package/dist/types/services/DepartmentsService.d.ts +43 -0
  181. package/dist/types/services/EngagementService.d.ts +467 -0
  182. package/dist/types/services/FinanceService.d.ts +52 -0
  183. package/dist/types/services/NotificationBuilderService.d.ts +58 -0
  184. package/dist/types/services/NotificationService.d.ts +118 -0
  185. package/dist/types/services/OverviewService.d.ts +184 -0
  186. package/dist/types/services/PerformanceService.d.ts +183 -0
  187. package/dist/types/services/PerlearnerService.d.ts +501 -0
  188. package/dist/types/services/PlatformService.d.ts +77 -0
  189. package/dist/types/services/RecommendationsService.d.ts +13 -0
  190. package/dist/types/services/ReportsService.d.ts +142 -0
  191. package/dist/types/services/SearchService.d.ts +276 -0
  192. package/dist/types/services/SkillsService.d.ts +377 -0
  193. package/dist/types/services/UserGroupsService.d.ts +49 -0
  194. package/package.json +39 -0
  195. package/rollup.config.js +113 -0
  196. package/src/core/ApiError.ts +25 -0
  197. package/src/core/ApiRequestOptions.ts +17 -0
  198. package/src/core/ApiResult.ts +11 -0
  199. package/src/core/CancelablePromise.ts +131 -0
  200. package/src/core/OpenAPI.ts +32 -0
  201. package/src/core/request.ts +322 -0
  202. package/src/index.ts +189 -0
  203. package/src/models/AcceptanceEnum.ts +14 -0
  204. package/src/models/ActiveUsersData.ts +23 -0
  205. package/src/models/ActiveUsersList.ts +11 -0
  206. package/src/models/ActiveUsersPerCourse.ts +15 -0
  207. package/src/models/ActiveUsersPerCourseData.ts +19 -0
  208. package/src/models/ActivityAPI.ts +13 -0
  209. package/src/models/ActivityData.ts +43 -0
  210. package/src/models/Assertion.ts +20 -0
  211. package/src/models/Average.ts +9 -0
  212. package/src/models/AverageData.ts +11 -0
  213. package/src/models/AverageOvertime.ts +27 -0
  214. package/src/models/AvgCourseGradeWithCutoff.ts +9 -0
  215. package/src/models/AvgCourseGradeWithCutoffData.ts +15 -0
  216. package/src/models/BlankEnum.ts +7 -0
  217. package/src/models/BulkCreateAssertion.ts +9 -0
  218. package/src/models/CampaignEnablement.ts +13 -0
  219. package/src/models/CampaignExclusion.ts +13 -0
  220. package/src/models/Company.ts +28 -0
  221. package/src/models/ContextResponse.ts +12 -0
  222. package/src/models/Count.ts +9 -0
  223. package/src/models/CountData.ts +11 -0
  224. package/src/models/CourseCompletionPerCourse.ts +11 -0
  225. package/src/models/CourseCompletionPerCourseData.ts +27 -0
  226. package/src/models/CourseCompletionSummaryDataOvertime.ts +23 -0
  227. package/src/models/CourseCompletionSummaryOvertime.ts +11 -0
  228. package/src/models/CourseGradeDetailBlock.ts +23 -0
  229. package/src/models/CourseGradeDetailSubSection.ts +28 -0
  230. package/src/models/CourseGradeSummary.ts +9 -0
  231. package/src/models/CourseGradeSummaryData.ts +23 -0
  232. package/src/models/CourseGradingDetail.ts +9 -0
  233. package/src/models/CourseGradingDetailData.ts +17 -0
  234. package/src/models/CoursePoint.ts +12 -0
  235. package/src/models/CourseSkill.ts +13 -0
  236. package/src/models/Credential.ts +33 -0
  237. package/src/models/DesiredSkill.ts +9 -0
  238. package/src/models/DetailedGradeSubsection.ts +27 -0
  239. package/src/models/DetailedGradeView.ts +9 -0
  240. package/src/models/DetailedGradeViewData.ts +17 -0
  241. package/src/models/Education.ts +35 -0
  242. package/src/models/EngagementPerCourse.ts +11 -0
  243. package/src/models/EngagementPerCourseData.ts +31 -0
  244. package/src/models/Enrollments.ts +13 -0
  245. package/src/models/EnrollmentsData.ts +23 -0
  246. package/src/models/EnrollmentsPerUser.ts +11 -0
  247. package/src/models/EnrollmentsPerUserData.ts +23 -0
  248. package/src/models/ErrorResponse.ts +13 -0
  249. package/src/models/Experience.ts +34 -0
  250. package/src/models/FloatOverTime.ts +15 -0
  251. package/src/models/GradingPerUser.ts +13 -0
  252. package/src/models/GradingPerUserData.ts +31 -0
  253. package/src/models/GroupList.ts +11 -0
  254. package/src/models/GroupListData.ts +21 -0
  255. package/src/models/ImageUpload.ts +8 -0
  256. package/src/models/Institution.ts +25 -0
  257. package/src/models/InstitutionTypeEnum.ts +18 -0
  258. package/src/models/Issuer.ts +14 -0
  259. package/src/models/IssuerAuthority.ts +10 -0
  260. package/src/models/LearnerInformationAPI.ts +9 -0
  261. package/src/models/LearnerInformationAPIData.ts +88 -0
  262. package/src/models/LtiKey.ts +24 -0
  263. package/src/models/LtiLaunchGate.ts +13 -0
  264. package/src/models/LtiTool.ts +51 -0
  265. package/src/models/NetRevenueOverTime.ts +13 -0
  266. package/src/models/NewPerLearnerList.ts +11 -0
  267. package/src/models/NewPerLearnerListData.ts +22 -0
  268. package/src/models/Notification.ts +18 -0
  269. package/src/models/NotificationCount.ts +9 -0
  270. package/src/models/NotificationPreview.ts +36 -0
  271. package/src/models/NotificationSource.ts +13 -0
  272. package/src/models/NotificationTemplateData.ts +31 -0
  273. package/src/models/Order.ts +27 -0
  274. package/src/models/OverTime.ts +8 -0
  275. package/src/models/OverTimeWithTotal.ts +27 -0
  276. package/src/models/OvertimeMeta.ts +35 -0
  277. package/src/models/OvertimeWithChangeInfo.ts +29 -0
  278. package/src/models/Pagination.ts +23 -0
  279. package/src/models/PatchedNotification.ts +18 -0
  280. package/src/models/PatchedPlatformPublicMetadata.ts +13 -0
  281. package/src/models/PatchedSkillThreshold.ts +19 -0
  282. package/src/models/PerLearnerCourseLastAccessData.ts +35 -0
  283. package/src/models/PerLearnerCourseVideosWatched.ts +13 -0
  284. package/src/models/PerLearnerCourseVideosWatchedData.ts +19 -0
  285. package/src/models/PerLearnerLastAccess.ts +9 -0
  286. package/src/models/PerLearnerLastAccessData.ts +16 -0
  287. package/src/models/PerLearnerTimeSpentInCourseTree.ts +13 -0
  288. package/src/models/PerformanceGradesPerCourse.ts +11 -0
  289. package/src/models/PerformanceGradesPerCourseData.ts +27 -0
  290. package/src/models/PerlearnerCourseProgress.ts +9 -0
  291. package/src/models/PerlearnerCourseProgressData.ts +11 -0
  292. package/src/models/PerlearnerEngagementVideosData.ts +35 -0
  293. package/src/models/PerlearnerEngagementVideosWatchedPerCourse.ts +9 -0
  294. package/src/models/PerlearnerGradeSummary.ts +9 -0
  295. package/src/models/PerlearnerGradeSummaryData.ts +23 -0
  296. package/src/models/PerlearnerGradeWithCutOff.ts +9 -0
  297. package/src/models/PerlearnerGradeWithCutOffData.ts +15 -0
  298. package/src/models/PerlearnerGradingPerCourseAPI.ts +9 -0
  299. package/src/models/PerlearnerGradingPerCourseAPIData.ts +39 -0
  300. package/src/models/PerlearnerUserList.ts +11 -0
  301. package/src/models/PerlearnerUserListData.ts +39 -0
  302. package/src/models/PlatformPublicMetadata.ts +13 -0
  303. package/src/models/PointsPercentile.ts +13 -0
  304. package/src/models/PreviewResponse.ts +16 -0
  305. package/src/models/Product.ts +27 -0
  306. package/src/models/ProductTable.ts +31 -0
  307. package/src/models/Program.ts +29 -0
  308. package/src/models/ProgramTypeEnum.ts +22 -0
  309. package/src/models/Recipient.ts +13 -0
  310. package/src/models/RecommendationSearchAPI.ts +8 -0
  311. package/src/models/RedirectTokenRequest.ts +8 -0
  312. package/src/models/RedirectTokenResponse.ts +10 -0
  313. package/src/models/ReportCreate.ts +12 -0
  314. package/src/models/ReportData.ts +33 -0
  315. package/src/models/ReportDetail.ts +9 -0
  316. package/src/models/ReportList.ts +9 -0
  317. package/src/models/ReportRequest.ts +26 -0
  318. package/src/models/ReportStatus.ts +46 -0
  319. package/src/models/ReportedSkill.ts +9 -0
  320. package/src/models/ResourcePoint.ts +12 -0
  321. package/src/models/RevenueByProduct.ts +11 -0
  322. package/src/models/SendNotification.ts +11 -0
  323. package/src/models/SendResponse.ts +14 -0
  324. package/src/models/Skill.ts +12 -0
  325. package/src/models/SkillDetail.ts +14 -0
  326. package/src/models/SkillInfo.ts +28 -0
  327. package/src/models/SkillThreshold.ts +19 -0
  328. package/src/models/StateEnum.ts +26 -0
  329. package/src/models/StatusEnum.ts +14 -0
  330. package/src/models/SubTimeChild.ts +23 -0
  331. package/src/models/Summary.ts +23 -0
  332. package/src/models/TimeChildData.ts +25 -0
  333. package/src/models/TimeDetail.ts +13 -0
  334. package/src/models/TimeDetailChild.ts +31 -0
  335. package/src/models/TimeDetailData.ts +29 -0
  336. package/src/models/TimeSpentByUsersInCourse.ts +11 -0
  337. package/src/models/TimeSpentByUsersInCourseData.ts +27 -0
  338. package/src/models/TimeSpentPerCourse.ts +11 -0
  339. package/src/models/TimeSpentPerCourseData.ts +31 -0
  340. package/src/models/TimeSpentPerUserResponse.ts +8 -0
  341. package/src/models/TimeSpentUpdateRequest.ts +16 -0
  342. package/src/models/TimeSpentUpdateResponse.ts +9 -0
  343. package/src/models/TypeEnum.ts +22 -0
  344. package/src/models/UploadedImage.ts +10 -0
  345. package/src/models/UserInfo.ts +18 -0
  346. package/src/models/UserSkill.ts +27 -0
  347. package/src/models/UserSkillPointsPercentile.ts +13 -0
  348. package/src/models/ValidateSourceResponse.ts +15 -0
  349. package/src/models/Value.ts +9 -0
  350. package/src/models/ValueData.ts +11 -0
  351. package/src/models/VideoBlock.ts +19 -0
  352. package/src/models/VideoEngagementPerCourse.ts +11 -0
  353. package/src/models/VideoEngagementPerCourseData.ts +35 -0
  354. package/src/models/VideosCount.ts +9 -0
  355. package/src/models/VideosCountData.ts +11 -0
  356. package/src/models/VideosInCourseSummary.ts +9 -0
  357. package/src/models/VideosInCourseSummaryData.ts +17 -0
  358. package/src/models/VideosSpecificCourse.ts +9 -0
  359. package/src/models/VideosSpecificCourseData.ts +31 -0
  360. package/src/models/VideosWatchedSubSection.ts +24 -0
  361. package/src/models/WatchedVideosPerUser.ts +13 -0
  362. package/src/models/WatchedVideosPerUserData.ts +23 -0
  363. package/src/services/AnalyticsService.ts +94 -0
  364. package/src/services/AudienceService.ts +602 -0
  365. package/src/services/CareerService.ts +568 -0
  366. package/src/services/CoreService.ts +487 -0
  367. package/src/services/CredentialsService.ts +1647 -0
  368. package/src/services/DepartmentsService.ts +85 -0
  369. package/src/services/EngagementService.ts +907 -0
  370. package/src/services/FinanceService.ts +136 -0
  371. package/src/services/NotificationBuilderService.ts +133 -0
  372. package/src/services/NotificationService.ts +294 -0
  373. package/src/services/OverviewService.ts +324 -0
  374. package/src/services/PerformanceService.ts +329 -0
  375. package/src/services/PerlearnerService.ts +1009 -0
  376. package/src/services/PlatformService.ts +181 -0
  377. package/src/services/RecommendationsService.ts +31 -0
  378. package/src/services/ReportsService.ts +218 -0
  379. package/src/services/SearchService.ts +309 -0
  380. package/src/services/SkillsService.ts +521 -0
  381. package/src/services/UserGroupsService.ts +91 -0
  382. package/tsconfig.json +15 -0
@@ -0,0 +1,501 @@
1
+ import type { ActivityAPI } from '../models/ActivityAPI';
2
+ import type { Average } from '../models/Average';
3
+ import type { DetailedGradeView } from '../models/DetailedGradeView';
4
+ import type { LearnerInformationAPI } from '../models/LearnerInformationAPI';
5
+ import type { NewPerLearnerList } from '../models/NewPerLearnerList';
6
+ import type { OverTimeWithTotal } from '../models/OverTimeWithTotal';
7
+ import type { PerLearnerCourseVideosWatched } from '../models/PerLearnerCourseVideosWatched';
8
+ import type { PerlearnerEngagementVideosWatchedPerCourse } from '../models/PerlearnerEngagementVideosWatchedPerCourse';
9
+ import type { PerlearnerGradeSummary } from '../models/PerlearnerGradeSummary';
10
+ import type { PerlearnerGradeWithCutOff } from '../models/PerlearnerGradeWithCutOff';
11
+ import type { PerlearnerGradingPerCourseAPI } from '../models/PerlearnerGradingPerCourseAPI';
12
+ import type { PerLearnerLastAccess } from '../models/PerLearnerLastAccess';
13
+ import type { PerlearnerUserList } from '../models/PerlearnerUserList';
14
+ import type { Value } from '../models/Value';
15
+ import type { CancelablePromise } from '../core/CancelablePromise';
16
+ export declare class PerlearnerService {
17
+ /**
18
+ * Enhanced API endpoint for listing learners with comprehensive filtering.
19
+ *
20
+ * This endpoint provides a paginated list of learners with detailed metrics
21
+ * and supports advanced filtering options. It uses DM token authentication
22
+ * and respects department-based access controls.
23
+ *
24
+ * Query Parameters:
25
+ * page (int): Page number for pagination
26
+ * length (int): Number of items per page
27
+ * search (str): Filter by username, email, or full name
28
+ * program (str): Filter by program
29
+ * location (str): Filter by location
30
+ * is_enrolled (bool): Filter for users with enrollments
31
+ * platform (str): Filter by platform
32
+ * start_date (date): Filter by join date (start range)
33
+ * end_date (date): Filter by join date (end range)
34
+ *
35
+ * Returns:
36
+ * A paginated list of learners with comprehensive metrics including:
37
+ * - Course enrollments and completions
38
+ * - Time spent on platform
39
+ * - Pathway progress
40
+ * - Certificate and skill information
41
+ * - Location data
42
+ *
43
+ * Access Control:
44
+ * - Platform admins can see all learners
45
+ * - Department admins can only see learners in their departments
46
+ * @param org
47
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
48
+ * @param endDate Learner date_joined end date. ISO 8601
49
+ * @param format Format
50
+ *
51
+ * * `json` - json
52
+ * @param includeMainPlatform Include main platform data
53
+ * @param isEnrolled Filter for users who have at least an enrollment
54
+ * @param length Size of data to return
55
+ * @param location Location search string
56
+ * @param page Page offset
57
+ * @param platform Platform search string
58
+ * @param program Program search string
59
+ * @param search Search string for learner. email, username or full name
60
+ * @param startDate Learner date_joined start date. ISO 8601
61
+ * @returns NewPerLearnerList
62
+ * @throws ApiError
63
+ */
64
+ static perlearnerOrgsLearnersRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, isEnrolled?: boolean | null, length?: number, location?: string, page?: number, platform?: string, program?: string, search?: string, startDate?: string): CancelablePromise<NewPerLearnerList>;
65
+ /**
66
+ * List all learners on the platform with aggregated metrics.
67
+ *
68
+ * This endpoint returns a paginated list of all learners with key metrics including:
69
+ * - Enrollment counts
70
+ * - Completion counts
71
+ * - Time spent on platform
72
+ *
73
+ * Query Parameters:
74
+ * page (int): Page number for pagination
75
+ * length (int): Number of items per page
76
+ * search (str): Filter learners by username, email, or name
77
+ *
78
+ * Returns:
79
+ * A paginated list of learners with their associated metrics.
80
+ * @param org
81
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
82
+ * @param format Format
83
+ *
84
+ * * `json` - json
85
+ * @param includeMainPlatform Include main platform data
86
+ * @param length Size of data to return
87
+ * @param page Page offset
88
+ * @param search Search string for learner
89
+ * @returns PerlearnerUserList
90
+ * @throws ApiError
91
+ */
92
+ static perlearnerOrgsUsersRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, length?: number, page?: number, search?: string): CancelablePromise<PerlearnerUserList>;
93
+ /**
94
+ * Provides information on user enrollments
95
+ *
96
+ * Params
97
+ * user_id e.g developer@ibleducation.com| developer
98
+ * @param org
99
+ * @param userId
100
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
101
+ * @param format Format
102
+ *
103
+ * * `json` - json
104
+ * @param includeMainPlatform Include main platform data
105
+ * @returns ActivityAPI
106
+ * @throws ApiError
107
+ */
108
+ static perlearnerOrgsUsersActivityRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<ActivityAPI>;
109
+ /**
110
+ * Provides about a learner current grade in a course with the course cut
111
+ * Kwargs
112
+ * 1. course_id e.g course-v1:Org+Course4+Run
113
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
114
+ * @param courseId
115
+ * @param org
116
+ * @param userId
117
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
118
+ * @param endDate end date. ISO 8601
119
+ * @param format Format
120
+ *
121
+ * * `json` - json
122
+ * @param includeMainPlatform Include main platform data
123
+ * @param startDate start date. ISO 8601
124
+ * @returns PerlearnerGradeWithCutOff
125
+ * @throws ApiError
126
+ */
127
+ static perlearnerOrgsUsersCoursesGradingCutoffsRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerGradeWithCutOff>;
128
+ /**
129
+ * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
130
+ * @param courseId
131
+ * @param org
132
+ * @param userId
133
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
134
+ * @param endDate end date. ISO 8601
135
+ * @param format Format
136
+ *
137
+ * * `json` - json
138
+ * @param includeMainPlatform Include main platform data
139
+ * @param startDate start date. ISO 8601
140
+ * @returns DetailedGradeView
141
+ * @throws ApiError
142
+ */
143
+ static perlearnerOrgsUsersCoursesGradingDetailRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<DetailedGradeView>;
144
+ /**
145
+ * Query Params
146
+ * 1. course_id e.g course-v1:Org+Course4+Run
147
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
148
+ * @param courseId
149
+ * @param org
150
+ * @param userId
151
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
152
+ * @param endDate end date. ISO 8601
153
+ * @param format Format
154
+ *
155
+ * * `json` - json
156
+ * @param includeMainPlatform Include main platform data
157
+ * @param startDate start date. ISO 8601
158
+ * @returns PerlearnerGradeSummary
159
+ * @throws ApiError
160
+ */
161
+ static perlearnerOrgsUsersCoursesGradingSummaryRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerGradeSummary>;
162
+ /**
163
+ * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
164
+ * @param courseId
165
+ * @param org
166
+ * @param userId
167
+ * @returns Value
168
+ * @throws ApiError
169
+ */
170
+ static perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve(courseId: string, org: string, userId: string): CancelablePromise<Value>;
171
+ /**
172
+ * Provides about a learner current grade in a course with the course cut
173
+ * Kwargs
174
+ * 1. course_id e.g course-v1:Org+Course4+Run
175
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
176
+ * @param courseId
177
+ * @param org
178
+ * @param userId
179
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
180
+ * @param endDate end date. ISO 8601
181
+ * @param format Format
182
+ *
183
+ * * `json` - json
184
+ * @param includeMainPlatform Include main platform data
185
+ * @param startDate start date. ISO 8601
186
+ * @returns PerlearnerGradeWithCutOff
187
+ * @throws ApiError
188
+ */
189
+ static perlearnerOrgsUsersCoursesOverviewGradeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerGradeWithCutOff>;
190
+ /**
191
+ * Evaluates performance index for platform, per course, per user and per user-per course
192
+ *
193
+ * Query Params
194
+ * course_id <optional>
195
+ * learner_id <optional>
196
+ * @param courseId
197
+ * @param org
198
+ * @param userId
199
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
200
+ * @param endDate end date. ISO 8601
201
+ * @param format Format
202
+ *
203
+ * * `json` - json
204
+ * @param includeMainPlatform Include main platform data
205
+ * @param startDate start date. ISO 8601
206
+ * @returns Value
207
+ * @throws ApiError
208
+ */
209
+ static perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Value>;
210
+ /**
211
+ * Time spent within a course in secs on a per-day basis
212
+ *
213
+ * Kwargs
214
+ * 1. course_id e.g course-v1:Org+Course4+Run
215
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
216
+ * Query Params
217
+ * 3. start_date e.g 2020-10-01
218
+ * 4. end_date e.g 2020-10-10
219
+ *
220
+ * Default result when no query param is added is last_7_days (today inclusive)
221
+ * @param courseId
222
+ * @param org
223
+ * @param userId
224
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
225
+ * @param endDate end date. ISO 8601
226
+ * @param format Format
227
+ *
228
+ * * `json` - json
229
+ * @param includeMainPlatform Include main platform data
230
+ * @param startDate start date. ISO 8601
231
+ * @returns OverTimeWithTotal
232
+ * @throws ApiError
233
+ */
234
+ static perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
235
+ /**
236
+ * List of videos within a course a learner has watched
237
+ *
238
+ * Kwargs
239
+ * 1. course_id e.g course-v1:Org+Course4+Run
240
+ * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
241
+ *
242
+ * Default result when no query param is added is [], 0
243
+ * @param courseId
244
+ * @param org
245
+ * @param userId
246
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
247
+ * @param format Format
248
+ *
249
+ * * `json` - json
250
+ * @param includeMainPlatform Include main platform data
251
+ * @returns PerLearnerCourseVideosWatched
252
+ * @throws ApiError
253
+ */
254
+ static perlearnerOrgsUsersCoursesVideosRetrieve(courseId: string, org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerLearnerCourseVideosWatched>;
255
+ /**
256
+ * Get video watch counts over time.
257
+ *
258
+ * This endpoint provides daily counts of videos watched over a specified time period,
259
+ * with options to filter by course or user.
260
+ *
261
+ * Query Parameters:
262
+ * start_date (str, optional): Start date for the time range (ISO format)
263
+ * end_date (str, optional): End date for the time range (ISO format)
264
+ * course_id (str, optional): Filter by course ID
265
+ * user_id (str, optional): Filter by username or email
266
+ *
267
+ * Returns:
268
+ * Daily video watch counts over the specified time period.
269
+ *
270
+ * Default time range is the last 7 days if no dates are specified.
271
+ *
272
+ * Access Control:
273
+ * - Platform admins can access any video watch data
274
+ * - Learners can access their own video watch data
275
+ * @param courseId
276
+ * @param org
277
+ * @param userId
278
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
279
+ * @param endDate end date. ISO 8601
280
+ * @param format Format
281
+ *
282
+ * * `json` - json
283
+ * @param includeMainPlatform Include main platform data
284
+ * @param startDate start date. ISO 8601
285
+ * @returns OverTimeWithTotal
286
+ * @throws ApiError
287
+ */
288
+ static perlearnerOrgsUsersCoursesVideosOverTimeRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
289
+ /**
290
+ * Summary Grading Information for a learner on a per-enrollment basis
291
+ *
292
+ * Query Params
293
+ * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
294
+ * @param org
295
+ * @param userId
296
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
297
+ * @param format Format
298
+ *
299
+ * * `json` - json
300
+ * @param includeMainPlatform Include main platform data
301
+ * @returns PerlearnerGradingPerCourseAPI
302
+ * @throws ApiError
303
+ */
304
+ static perlearnerOrgsUsersGradesPerCourseRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerlearnerGradingPerCourseAPI>;
305
+ /**
306
+ * Retrieve detailed information about a specific learner.
307
+ *
308
+ * This endpoint returns personal and activity information about a learner,
309
+ * including profile data, activity metrics, and location information.
310
+ *
311
+ * Path Parameters:
312
+ * user_id (str): The username or email of the learner
313
+ *
314
+ * Query Parameters:
315
+ * meta (bool): Include additional analytics information when true
316
+ *
317
+ * Returns:
318
+ * Detailed learner information including:
319
+ * - Profile data (username, name, email)
320
+ * - Registration and activity dates
321
+ * - Activity metrics (assessments, time spent, videos watched)
322
+ * - Location and browser information (when available)
323
+ *
324
+ * Access Control:
325
+ * - Platform admins can access any learner
326
+ * - Learners can access their own information
327
+ * - Department admins can access learners in their departments
328
+ * @param org
329
+ * @param userId
330
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
331
+ * @param format Format
332
+ *
333
+ * * `json` - json
334
+ * @param includeMainPlatform Include main platform data
335
+ * @param meta Include extra analytics information?
336
+ *
337
+ * * `y` - y
338
+ * * `yes` - yes
339
+ * * `true` - true
340
+ * * `True` - True
341
+ * * `n` - n
342
+ * * `no` - no
343
+ * * `false` - false
344
+ * * `False` - False
345
+ * @param search
346
+ * @returns LearnerInformationAPI
347
+ * @throws ApiError
348
+ */
349
+ static perlearnerOrgsUsersInfoRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean, meta?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False', search?: string): CancelablePromise<LearnerInformationAPI>;
350
+ /**
351
+ * Last course accessed by a learner, includes upto unit information as well
352
+ * @param org
353
+ * @param userId
354
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
355
+ * @param format Format
356
+ *
357
+ * * `json` - json
358
+ * @param includeMainPlatform Include main platform data
359
+ * @returns PerLearnerLastAccess
360
+ * @throws ApiError
361
+ */
362
+ static perlearnerOrgsUsersLastAccessRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerLearnerLastAccess>;
363
+ /**
364
+ * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
365
+ * @param org
366
+ * @param userId
367
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
368
+ * @param endDate end date. ISO 8601
369
+ * @param format Format
370
+ *
371
+ * * `json` - json
372
+ * @param includeMainPlatform Include main platform data
373
+ * @param startDate start date. ISO 8601
374
+ * @returns Value
375
+ * @throws ApiError
376
+ */
377
+ static perlearnerOrgsUsersOverviewEngagementIndexRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Value>;
378
+ /**
379
+ * Get average grade value for platform, course, or user.
380
+ *
381
+ * This endpoint returns the average grade at different levels:
382
+ * - Platform level: Average grade across all courses
383
+ * - Course level: Average grade for a specific course
384
+ * - Learner level: Average grade for a specific learner
385
+ * - Course-learner level: Grade for a specific learner in a specific course
386
+ *
387
+ * Query Parameters:
388
+ * course_id (str, optional): Filter by course ID
389
+ * learner_id (str, optional): Filter by username or email
390
+ *
391
+ * Returns:
392
+ * The average grade value based on the specified filters.
393
+ *
394
+ * Access Control:
395
+ * - Platform admins can access any grade data
396
+ * - Learners can access their own grade data
397
+ * @param org
398
+ * @param userId
399
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
400
+ * @param format Format
401
+ *
402
+ * * `json` - json
403
+ * @param includeMainPlatform Include main platform data
404
+ * @returns Average
405
+ * @throws ApiError
406
+ */
407
+ static perlearnerOrgsUsersOverviewGradesAverageRetrieve(org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Average>;
408
+ /**
409
+ * Evaluates performance index for platform, per course, per user and per user-per course
410
+ *
411
+ * Query Params
412
+ * course_id <optional>
413
+ * learner_id <optional>
414
+ * @param org
415
+ * @param userId
416
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
417
+ * @param endDate end date. ISO 8601
418
+ * @param format Format
419
+ *
420
+ * * `json` - json
421
+ * @param includeMainPlatform Include main platform data
422
+ * @param startDate start date. ISO 8601
423
+ * @returns Value
424
+ * @throws ApiError
425
+ */
426
+ static perlearnerOrgsUsersOverviewPerformanceIndexRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Value>;
427
+ /**
428
+ * Time spent in secs on a per-day basis
429
+ *
430
+ * Query Params
431
+ * 1. course_id <optional> e.g course-v1:Org+Course4+Run
432
+ * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
433
+ * 3. start_date e.g 2020-10-01
434
+ * 4. end_date e.g 2020-10-10
435
+ *
436
+ * Default result when no query param is added is last_7_days (today inclusive)
437
+ * @param org
438
+ * @param userId
439
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
440
+ * @param endDate end date. ISO 8601
441
+ * @param format Format
442
+ *
443
+ * * `json` - json
444
+ * @param includeMainPlatform Include main platform data
445
+ * @param startDate start date. ISO 8601
446
+ * @returns OverTimeWithTotal
447
+ * @throws ApiError
448
+ */
449
+ static perlearnerOrgsUsersOverviewTimeOverTimeRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
450
+ /**
451
+ * Get video watch counts over time.
452
+ *
453
+ * This endpoint provides daily counts of videos watched over a specified time period,
454
+ * with options to filter by course or user.
455
+ *
456
+ * Query Parameters:
457
+ * start_date (str, optional): Start date for the time range (ISO format)
458
+ * end_date (str, optional): End date for the time range (ISO format)
459
+ * course_id (str, optional): Filter by course ID
460
+ * user_id (str, optional): Filter by username or email
461
+ *
462
+ * Returns:
463
+ * Daily video watch counts over the specified time period.
464
+ *
465
+ * Default time range is the last 7 days if no dates are specified.
466
+ *
467
+ * Access Control:
468
+ * - Platform admins can access any video watch data
469
+ * - Learners can access their own video watch data
470
+ * @param org
471
+ * @param userId
472
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
473
+ * @param endDate end date. ISO 8601
474
+ * @param format Format
475
+ *
476
+ * * `json` - json
477
+ * @param includeMainPlatform Include main platform data
478
+ * @param startDate start date. ISO 8601
479
+ * @returns OverTimeWithTotal
480
+ * @throws ApiError
481
+ */
482
+ static perlearnerOrgsUsersVideosOverTimeRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
483
+ /**
484
+ * Summary Videos watched data for a learner per enrollment
485
+ *
486
+ * Query Params
487
+ * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
488
+ * @param org
489
+ * @param userId
490
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
491
+ * @param endDate end date. ISO 8601
492
+ * @param format Format
493
+ *
494
+ * * `json` - json
495
+ * @param includeMainPlatform Include main platform data
496
+ * @param startDate start date. ISO 8601
497
+ * @returns PerlearnerEngagementVideosWatchedPerCourse
498
+ * @throws ApiError
499
+ */
500
+ static perlearnerOrgsUsersVideosPerCourseRetrieve(org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<PerlearnerEngagementVideosWatchedPerCourse>;
501
+ }
@@ -0,0 +1,77 @@
1
+ import type { Count } from '../models/Count';
2
+ import type { PerlearnerCourseProgress } from '../models/PerlearnerCourseProgress';
3
+ import type { VideosCount } from '../models/VideosCount';
4
+ import type { CancelablePromise } from '../core/CancelablePromise';
5
+ export declare class PlatformService {
6
+ /**
7
+ * Base class for API views that return a single count value.
8
+ *
9
+ * This class formats the response as {"data": {value_key: count}} where
10
+ * value_key is configurable (defaults to "count").
11
+ *
12
+ * Attributes:
13
+ * value_key: The key used in the response for the count value
14
+ * @param courseId
15
+ * @param org
16
+ * @param userId
17
+ * @returns any No response body
18
+ * @throws ApiError
19
+ */
20
+ static platformOrgsCoursesUsersGradesPassedRetrieve(courseId: string, org: string, userId: string): CancelablePromise<any>;
21
+ /**
22
+ * Gives Percentage of units completed in course for a specific learner
23
+ * @param courseId
24
+ * @param org
25
+ * @param userId
26
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
27
+ * @param format Format
28
+ *
29
+ * * `json` - json
30
+ * @param includeMainPlatform Include main platform data
31
+ * @returns PerlearnerCourseProgress
32
+ * @throws ApiError
33
+ */
34
+ static platformOrgsCoursesUsersProgressRetrieve(courseId: string, org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerlearnerCourseProgress>;
35
+ /**
36
+ * Average days used to complete a course
37
+ *
38
+ * Query Params
39
+ * 1. course_id <optional> e.g course-v1:Org+Course4+Run
40
+ * @param courseId
41
+ * @param org
42
+ * @param userId
43
+ * @returns any No response body
44
+ * @throws ApiError
45
+ */
46
+ static platformOrgsCoursesUsersProgressDaysToCompleteRetrieve(courseId: string, org: string, userId: string): CancelablePromise<any>;
47
+ /**
48
+ * Time spent count in seconds within a course by a learner
49
+ * @param courseId
50
+ * @param org
51
+ * @param userId
52
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
53
+ * @param endDate end date. ISO 8601
54
+ * @param format Format
55
+ *
56
+ * * `json` - json
57
+ * @param includeMainPlatform Include main platform data
58
+ * @param startDate start date. ISO 8601
59
+ * @returns Count
60
+ * @throws ApiError
61
+ */
62
+ static platformOrgsCoursesUsersTimeCountRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Count>;
63
+ /**
64
+ * (Total videos watched / Total Course Videos) or Total Videos watched in a course by a learner
65
+ * @param courseId
66
+ * @param org
67
+ * @param userId
68
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
69
+ * @param format Format
70
+ *
71
+ * * `json` - json
72
+ * @param includeMainPlatform Include main platform data
73
+ * @returns VideosCount
74
+ * @throws ApiError
75
+ */
76
+ static platformOrgsCoursesUsersVideosCountRetrieve(courseId: string, org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<VideosCount>;
77
+ }
@@ -0,0 +1,13 @@
1
+ import type { RecommendationSearchAPI } from '../models/RecommendationSearchAPI';
2
+ import type { CancelablePromise } from '../core/CancelablePromise';
3
+ export declare class RecommendationsService {
4
+ /**
5
+ * API endpoint that returns a search api url prepopulated with context data
6
+ * See http://localhost:8000/api/schema/swagger-ui/#/recommendations
7
+ * @param org
8
+ * @param userId
9
+ * @returns RecommendationSearchAPI
10
+ * @throws ApiError
11
+ */
12
+ static recommendationsOrgsUsersRetrieve(org: string, userId: string): CancelablePromise<RecommendationSearchAPI>;
13
+ }