musora-content-services 1.6.9 → 1.7.2

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 (190) hide show
  1. package/.github/workflows/conventional-commits.yaml +0 -0
  2. package/.github/workflows/docs.js.yml +0 -0
  3. package/.github/workflows/node.js.yml +0 -0
  4. package/.github/workflows/sync-docs.yml +0 -0
  5. package/.prettierignore +0 -0
  6. package/.prettierrc +0 -0
  7. package/CHANGELOG.md +16 -0
  8. package/README.md +0 -0
  9. package/babel.config.cjs +0 -0
  10. package/docs/algolia.js.html +0 -0
  11. package/docs/config.js.html +0 -0
  12. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  13. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  14. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  15. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  16. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  17. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  18. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  19. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  20. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  21. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
  22. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  23. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  24. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  25. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  26. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  27. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  28. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  29. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  30. package/docs/index.html +0 -0
  31. package/docs/module-Config.html +0 -0
  32. package/docs/module-Railcontent-Services.html +0 -0
  33. package/docs/module-Sanity-Services.html +0 -0
  34. package/docs/module-Search-Engine-Services.html +0 -0
  35. package/docs/railcontent.js.html +0 -0
  36. package/docs/sanity.js.html +0 -0
  37. package/docs/scripts/collapse.js +0 -0
  38. package/docs/scripts/commonNav.js +0 -0
  39. package/docs/scripts/linenumber.js +0 -0
  40. package/docs/scripts/nav.js +0 -0
  41. package/docs/scripts/polyfill.js +0 -0
  42. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -0
  43. package/docs/scripts/prettify/lang-css.js +0 -0
  44. package/docs/scripts/prettify/prettify.js +0 -0
  45. package/docs/scripts/search.js +0 -0
  46. package/docs/styles/jsdoc.css +0 -0
  47. package/docs/styles/prettify.css +0 -0
  48. package/docs/v2/Content.html +269 -0
  49. package/docs/v2/ContentOrganization.html +2 -2
  50. package/docs/v2/Forums.html +2 -2
  51. package/docs/v2/Gamification.html +2 -2
  52. package/docs/v2/TestUser.html +3 -3
  53. package/docs/v2/UserManagementSystem.html +2 -2
  54. package/docs/v2/api_types.js.html +2 -2
  55. package/docs/v2/config.js.html +5 -2
  56. package/docs/v2/content-org_content-org.js.html +2 -2
  57. package/docs/v2/content-org_guided-courses.ts.html +2 -2
  58. package/docs/v2/content-org_learning-paths.ts.html +286 -18
  59. package/docs/v2/content-org_playlists-types.js.html +2 -2
  60. package/docs/v2/content-org_playlists.js.html +2 -2
  61. package/docs/v2/content.js.html +94 -16
  62. package/docs/v2/content_artist.ts.html +206 -0
  63. package/docs/v2/content_content.ts.html +77 -0
  64. package/docs/v2/content_genre.ts.html +209 -0
  65. package/docs/v2/content_instructor.ts.html +206 -0
  66. package/docs/v2/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  67. package/docs/v2/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  68. package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  69. package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  70. package/docs/v2/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  71. package/docs/v2/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  72. package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  73. package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  74. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  75. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
  76. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  77. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  78. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  79. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  80. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  81. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  82. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  83. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  84. package/docs/v2/forums_categories.ts.html +22 -3
  85. package/docs/v2/forums_discussions.js.html +0 -0
  86. package/docs/v2/forums_forum.js.html +0 -0
  87. package/docs/v2/forums_forums.ts.html +41 -41
  88. package/docs/v2/forums_posts.ts.html +54 -28
  89. package/docs/v2/forums_threads.ts.html +23 -10
  90. package/docs/v2/gamification_awards.js.html +0 -0
  91. package/docs/v2/gamification_awards.ts.html +26 -12
  92. package/docs/v2/gamification_gamification.js.html +2 -2
  93. package/docs/v2/gamification_types.js.html +0 -0
  94. package/docs/v2/global.html +57 -9
  95. package/docs/v2/index.html +2 -2
  96. package/docs/v2/liveTesting.ts.html +4 -3
  97. package/docs/v2/module-Accounts.html +202 -13
  98. package/docs/v2/module-Artist.html +993 -0
  99. package/docs/v2/module-Awards.html +106 -6
  100. package/docs/v2/module-Categories.html +0 -0
  101. package/docs/v2/module-Config.html +5 -4
  102. package/docs/v2/module-Content-Services-V2.html +440 -9
  103. package/docs/v2/module-ForumCategories.html +0 -0
  104. package/docs/v2/module-ForumDiscussions.html +0 -0
  105. package/docs/v2/module-Forums.html +1398 -192
  106. package/docs/v2/module-Genre.html +981 -0
  107. package/docs/v2/module-GuidedCourses.html +2 -1198
  108. package/docs/v2/module-Instructor.html +929 -0
  109. package/docs/v2/module-Interests.html +2 -2
  110. package/docs/v2/module-LearningPaths.html +2424 -0
  111. package/docs/v2/module-Onboarding.html +217 -5
  112. package/docs/v2/module-Payments.html +148 -6
  113. package/docs/v2/module-Permissions.html +2 -2
  114. package/docs/v2/module-Playlists.html +2 -2
  115. package/docs/v2/module-ProgressRow.html +108 -0
  116. package/docs/v2/module-Railcontent-Services.html +34 -626
  117. package/docs/v2/module-Sanity-Services.html +803 -1722
  118. package/docs/v2/module-Sessions.html +2 -2
  119. package/docs/v2/module-Threads.html +0 -0
  120. package/docs/v2/module-UserActivity.html +70 -116
  121. package/docs/v2/module-UserChat.html +2 -2
  122. package/docs/v2/module-UserManagement.html +2 -2
  123. package/docs/v2/module-UserMemberships.html +2 -2
  124. package/docs/v2/module-UserNotifications.html +2 -2
  125. package/docs/v2/module-UserProfile.html +2 -2
  126. package/docs/v2/progress-row_method-card.js.html +184 -0
  127. package/docs/v2/railcontent.js.html +14 -125
  128. package/docs/v2/sanity.js.html +261 -325
  129. package/docs/v2/scripts/collapse.js +0 -0
  130. package/docs/v2/scripts/commonNav.js +0 -0
  131. package/docs/v2/scripts/linenumber.js +0 -0
  132. package/docs/v2/scripts/nav.js +0 -0
  133. package/docs/v2/scripts/polyfill.js +0 -0
  134. package/docs/v2/scripts/prettify/Apache-License-2.0.txt +0 -0
  135. package/docs/v2/scripts/prettify/lang-css.js +0 -0
  136. package/docs/v2/scripts/prettify/prettify.js +0 -0
  137. package/docs/v2/scripts/search.js +0 -0
  138. package/docs/v2/styles/jsdoc.css +0 -0
  139. package/docs/v2/styles/prettify.css +0 -0
  140. package/docs/v2/userActivity.js.html +191 -211
  141. package/docs/v2/user_account.ts.html +42 -14
  142. package/docs/v2/user_chat.js.html +2 -2
  143. package/docs/v2/user_interests.js.html +2 -2
  144. package/docs/v2/user_management.js.html +2 -2
  145. package/docs/v2/user_memberships.js.html +0 -0
  146. package/docs/v2/user_memberships.ts.html +2 -2
  147. package/docs/v2/user_notifications.js.html +2 -2
  148. package/docs/v2/user_onboarding.ts.html +148 -2
  149. package/docs/v2/user_payments.ts.html +54 -5
  150. package/docs/v2/user_permissions.js.html +3 -3
  151. package/docs/v2/user_profile.js.html +2 -2
  152. package/docs/v2/user_sessions.js.html +2 -2
  153. package/docs/v2/user_types.js.html +4 -2
  154. package/docs/v2/user_user-management-system.js.html +2 -2
  155. package/jest.config.js +0 -0
  156. package/jsdoc.json +0 -0
  157. package/link_mcs.sh +0 -0
  158. package/package.json +1 -1
  159. package/src/contentMetaData.js +0 -0
  160. package/src/contentTypeConfig.js +2 -0
  161. package/src/filterBuilder.js +3 -1
  162. package/src/index.d.ts +0 -0
  163. package/src/index.js +0 -0
  164. package/src/services/algolia.js +0 -0
  165. package/src/services/config.js +0 -0
  166. package/src/services/contentLikes.js +0 -0
  167. package/src/services/contentProgress.js +0 -0
  168. package/src/services/dataContext.js +0 -0
  169. package/src/services/imageSRCBuilder.js +0 -0
  170. package/src/services/imageSRCVerify.js +0 -0
  171. package/src/services/lastUpdated.js +0 -0
  172. package/src/services/railcontent.js +0 -0
  173. package/src/services/recommendations.js +0 -0
  174. package/src/services/sanity.js +15 -6
  175. package/src/services/userPermissions.js +0 -0
  176. package/test/config.test.js +0 -0
  177. package/test/contentLikes.test.js +0 -0
  178. package/test/contentProgress.test.js +0 -0
  179. package/test/dataContext.test.js +0 -0
  180. package/test/imageSRCBuilder.test.js +0 -0
  181. package/test/imageSRCVerify.test.js +0 -0
  182. package/test/initializeTests.js +0 -0
  183. package/test/lastUpdated.test.js +0 -0
  184. package/test/live/contentProgressLive.test.js +0 -0
  185. package/test/live/railcontentLive.test.js +0 -0
  186. package/test/localStorageMock.js +0 -0
  187. package/test/log.js +0 -0
  188. package/test/sanityQueryService.test.js +0 -0
  189. package/test/userPermissions.test.js +0 -0
  190. package/tools/generate-index.cjs +0 -0
@@ -0,0 +1,2424 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>LearningPaths - Documentation</title>
7
+
8
+
9
+ <script src="scripts/prettify/prettify.js"></script>
10
+ <script src="scripts/prettify/lang-css.js"></script>
11
+ <!--[if lt IE 9]>
12
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
+ <![endif]-->
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
+ <script src="scripts/nav.js" defer></script>
17
+
18
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
+ </head>
20
+ <body>
21
+
22
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
+ <label for="nav-trigger" class="navicon-button x">
24
+ <div class="navicon"></div>
25
+ </label>
26
+
27
+ <label for="nav-trigger" class="overlay"></label>
28
+
29
+ <nav >
30
+
31
+
32
+ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~deleteAccount">deleteAccount</a></li><li data-type='method'><a href="module-Accounts.html#~numberOfActiveUsers">numberOfActiveUsers</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li><li data-type='method'><a href="module-Accounts.html#~toggleStudentView">toggleStudentView</a></li></ul></li><li><a href="module-Artist.html">Artist</a><ul class='methods'><li data-type='method'><a href="module-Artist.html#~fetchArtistBySlug">fetchArtistBySlug</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtists">fetchArtists</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getLegacyMethods">getLegacyMethods</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getOwnedContent">getOwnedContent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deleteForumCategory">deleteForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~jumpToPost">jumpToPost</a></li><li data-type='method'><a href="module-Forums.html#~likePost">likePost</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~markThreadAsRead">markThreadAsRead</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~search">search</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlikePost">unlikePost</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updatePost">updatePost</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-Genre.html">Genre</a><ul class='methods'><li data-type='method'><a href="module-Genre.html#~fetchGenreBySlug">fetchGenreBySlug</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenres">fetchGenres</a></li></ul></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Instructor.html">Instructor</a><ul class='methods'><li data-type='method'><a href="module-Instructor.html#~fetchInstructorBySlug">fetchInstructorBySlug</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructorLessons">fetchInstructorLessons</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructors">fetchInstructors</a></li></ul></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-LearningPaths.html">LearningPaths</a><ul class='methods'><li data-type='method'><a href="module-LearningPaths.html#~completeLearningPathIntroVideo">completeLearningPathIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~completeMethodIntroVideo">completeMethodIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathLessons">fetchLearningPathLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathProgressCheckLessons">fetchLearningPathProgressCheckLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-LearningPaths.html#~getEnrichedLearningPath">getEnrichedLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getLearningPathLessonsByIds">getLearningPathLessonsByIds</a></li><li data-type='method'><a href="module-LearningPaths.html#~mapContentToParent">mapContentToParent</a></li><li data-type='method'><a href="module-LearningPaths.html#~resetAllLearningPaths">resetAllLearningPaths</a></li><li data-type='method'><a href="module-LearningPaths.html#~startLearningPath">startLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateDailySession">updateDailySession</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~getOnboardingRecommendedContent">getOnboardingRecommendedContent</a></li><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-ProgressRow.html">ProgressRow</a></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2StructureFromId">fetchMethodV2StructureFromId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOwnedContent">fetchOwnedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchTopLevelParentId">fetchTopLevelParentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
33
+
34
+ </nav>
35
+
36
+ <div id="main">
37
+
38
+ <h1 class="page-title">LearningPaths</h1>
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+ <section>
47
+
48
+ <header>
49
+
50
+
51
+
52
+ </header>
53
+
54
+ <article>
55
+
56
+ <div class="container-overview">
57
+
58
+
59
+
60
+
61
+
62
+ </div>
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <h3 class="subsection-title">Methods</h3>
81
+
82
+
83
+
84
+
85
+
86
+
87
+ <h4 class="name" id="~completeLearningPathIntroVideo"><span class="type-signature type-signature-async, inner">(async, inner) </span>completeLearningPathIntroVideo<span class="signature">(introVideoId, learningPathId, lessonsToImport)</span><span class="type-signature"> &rarr; {Promise.&lt;Array>|Promise.&lt;(Object|null)>|Promise.&lt;void>|Promise.&lt;Array.&lt;Object>>}</span></h4>
88
+
89
+
90
+
91
+
92
+
93
+
94
+ <dl class="details">
95
+
96
+ <dt class="tag-description">Description:</dt>
97
+ <dd class="tag-description"><ul class="dummy"><li>Handles completion of learning path intro video and other related actions.</li></ul></dd>
98
+
99
+
100
+
101
+ <dt class="tag-source">Source:</dt>
102
+ <dd class="tag-source"><ul class="dummy"><li>
103
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line283">line 283</a>
104
+ </li></ul></dd>
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ </dl>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <h5 class="h5-parameters">Parameters:</h5>
151
+
152
+
153
+ <table class="params">
154
+ <thead>
155
+ <tr>
156
+
157
+ <th>Name</th>
158
+
159
+
160
+ <th>Type</th>
161
+
162
+
163
+
164
+
165
+
166
+ <th class="last">Description</th>
167
+ </tr>
168
+ </thead>
169
+
170
+ <tbody>
171
+
172
+
173
+ <tr>
174
+
175
+ <td class="name"><code>introVideoId</code></td>
176
+
177
+
178
+ <td class="type">
179
+
180
+ </td>
181
+
182
+
183
+
184
+
185
+
186
+ <td class="description last">The learning path intro video content ID.</td>
187
+ </tr>
188
+
189
+
190
+
191
+ <tr>
192
+
193
+ <td class="name"><code>learningPathId</code></td>
194
+
195
+
196
+ <td class="type">
197
+
198
+ </td>
199
+
200
+
201
+
202
+
203
+
204
+ <td class="description last">The content_id of the learning path that this learning path intro video belongs to.</td>
205
+ </tr>
206
+
207
+
208
+
209
+ <tr>
210
+
211
+ <td class="name"><code>lessonsToImport</code></td>
212
+
213
+
214
+ <td class="type">
215
+
216
+ </td>
217
+
218
+
219
+
220
+
221
+
222
+ <td class="description last">content ids for all lessons with progress found during intro video progress check. empty if user chose not to keep learning path progress.</td>
223
+ </tr>
224
+
225
+
226
+ </tbody>
227
+ </table>
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+ <h5 class="h5-returns">Returns:</h5>
245
+ <ul>
246
+ <li>
247
+ <div class="param-desc">
248
+ response - The response object.
249
+ </div>
250
+
251
+
252
+
253
+ <dl class="param-type">
254
+ <dt>
255
+ Type
256
+ </dt>
257
+ <dd>
258
+
259
+ <span class="param-type">Promise.&lt;Array></span>
260
+
261
+
262
+
263
+ </dd>
264
+ </dl>
265
+ </li>
266
+
267
+ <li>
268
+ <div class="param-desc">
269
+ response.intro_video_response - The intro video completion response or null if already completed.
270
+ </div>
271
+
272
+
273
+
274
+ <dl class="param-type">
275
+ <dt>
276
+ Type
277
+ </dt>
278
+ <dd>
279
+
280
+ <span class="param-type">Promise.&lt;(Object|null)></span>
281
+
282
+
283
+
284
+ </dd>
285
+ </dl>
286
+ </li>
287
+
288
+ <li>
289
+ <div class="param-desc">
290
+ response.learning_path_reset_response - The reset learning path response.
291
+ </div>
292
+
293
+
294
+
295
+ <dl class="param-type">
296
+ <dt>
297
+ Type
298
+ </dt>
299
+ <dd>
300
+
301
+ <span class="param-type">Promise.&lt;void></span>
302
+
303
+
304
+
305
+ </dd>
306
+ </dl>
307
+ </li>
308
+
309
+ <li>
310
+ <div class="param-desc">
311
+ response.lesson_import_response - The responses for completing each content_id within the learning path.
312
+ </div>
313
+
314
+
315
+
316
+ <dl class="param-type">
317
+ <dt>
318
+ Type
319
+ </dt>
320
+ <dd>
321
+
322
+ <span class="param-type">Promise.&lt;Array.&lt;Object>></span>
323
+
324
+
325
+
326
+ </dd>
327
+ </dl>
328
+ </li>
329
+ </ul>
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+ <h4 class="name" id="~completeMethodIntroVideo"><span class="type-signature type-signature-async, inner">(async, inner) </span>completeMethodIntroVideo<span class="signature">(introVideoId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;Array>|Promise.&lt;(Object|null)>|Promise.&lt;Object>}</span></h4>
339
+
340
+
341
+
342
+
343
+
344
+
345
+ <dl class="details">
346
+
347
+ <dt class="tag-description">Description:</dt>
348
+ <dd class="tag-description"><ul class="dummy"><li>Handles completion of method intro video and other related actions.</li></ul></dd>
349
+
350
+
351
+
352
+ <dt class="tag-source">Source:</dt>
353
+ <dd class="tag-source"><ul class="dummy"><li>
354
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line256">line 256</a>
355
+ </li></ul></dd>
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+ </dl>
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+ <h5 class="h5-parameters">Parameters:</h5>
402
+
403
+
404
+ <table class="params">
405
+ <thead>
406
+ <tr>
407
+
408
+ <th>Name</th>
409
+
410
+
411
+ <th>Type</th>
412
+
413
+
414
+
415
+
416
+
417
+ <th class="last">Description</th>
418
+ </tr>
419
+ </thead>
420
+
421
+ <tbody>
422
+
423
+
424
+ <tr>
425
+
426
+ <td class="name"><code>introVideoId</code></td>
427
+
428
+
429
+ <td class="type">
430
+
431
+ </td>
432
+
433
+
434
+
435
+
436
+
437
+ <td class="description last">The method intro video content ID.</td>
438
+ </tr>
439
+
440
+
441
+
442
+ <tr>
443
+
444
+ <td class="name"><code>brand</code></td>
445
+
446
+
447
+ <td class="type">
448
+
449
+ </td>
450
+
451
+
452
+
453
+
454
+
455
+ <td class="description last"></td>
456
+ </tr>
457
+
458
+
459
+ </tbody>
460
+ </table>
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+ <h5 class="h5-returns">Returns:</h5>
478
+ <ul>
479
+ <li>
480
+ <div class="param-desc">
481
+ response - The response object.
482
+ </div>
483
+
484
+
485
+
486
+ <dl class="param-type">
487
+ <dt>
488
+ Type
489
+ </dt>
490
+ <dd>
491
+
492
+ <span class="param-type">Promise.&lt;Array></span>
493
+
494
+
495
+
496
+ </dd>
497
+ </dl>
498
+ </li>
499
+
500
+ <li>
501
+ <div class="param-desc">
502
+ response.intro_video_response - The intro video completion response or null if already completed.
503
+ </div>
504
+
505
+
506
+
507
+ <dl class="param-type">
508
+ <dt>
509
+ Type
510
+ </dt>
511
+ <dd>
512
+
513
+ <span class="param-type">Promise.&lt;(Object|null)></span>
514
+
515
+
516
+
517
+ </dd>
518
+ </dl>
519
+ </li>
520
+
521
+ <li>
522
+ <div class="param-desc">
523
+ response.active_path_response - The set active learning path response.
524
+ </div>
525
+
526
+
527
+
528
+ <dl class="param-type">
529
+ <dt>
530
+ Type
531
+ </dt>
532
+ <dd>
533
+
534
+ <span class="param-type">Promise.&lt;Object></span>
535
+
536
+
537
+
538
+ </dd>
539
+ </dl>
540
+ </li>
541
+ </ul>
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+ <h4 class="name" id="~fetchLearningPathLessons"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchLearningPathLessons<span class="signature">(learningPathId, brand, userDate)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>|number|string|string|boolean|Array|Array|Array|Array|Array|Array}</span></h4>
551
+
552
+
553
+
554
+
555
+
556
+
557
+ <dl class="details">
558
+
559
+ <dt class="tag-description">Description:</dt>
560
+ <dd class="tag-description"><ul class="dummy"><li>Fetches and organizes learning path lessons.</li></ul></dd>
561
+
562
+
563
+
564
+ <dt class="tag-source">Source:</dt>
565
+ <dd class="tag-source"><ul class="dummy"><li>
566
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line158">line 158</a>
567
+ </li></ul></dd>
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+
580
+
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+ </dl>
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+ <h5 class="h5-parameters">Parameters:</h5>
614
+
615
+
616
+ <table class="params">
617
+ <thead>
618
+ <tr>
619
+
620
+ <th>Name</th>
621
+
622
+
623
+ <th>Type</th>
624
+
625
+
626
+
627
+
628
+
629
+ <th class="last">Description</th>
630
+ </tr>
631
+ </thead>
632
+
633
+ <tbody>
634
+
635
+
636
+ <tr>
637
+
638
+ <td class="name"><code>learningPathId</code></td>
639
+
640
+
641
+ <td class="type">
642
+
643
+
644
+ <span class="param-type">number</span>
645
+
646
+
647
+
648
+
649
+ </td>
650
+
651
+
652
+
653
+
654
+
655
+ <td class="description last">The learning path ID.</td>
656
+ </tr>
657
+
658
+
659
+
660
+ <tr>
661
+
662
+ <td class="name"><code>brand</code></td>
663
+
664
+
665
+ <td class="type">
666
+
667
+
668
+ <span class="param-type">string</span>
669
+
670
+
671
+
672
+
673
+ </td>
674
+
675
+
676
+
677
+
678
+
679
+ <td class="description last"></td>
680
+ </tr>
681
+
682
+
683
+
684
+ <tr>
685
+
686
+ <td class="name"><code>userDate</code></td>
687
+
688
+
689
+ <td class="type">
690
+
691
+
692
+ <span class="param-type">Date</span>
693
+
694
+
695
+
696
+
697
+ </td>
698
+
699
+
700
+
701
+
702
+
703
+ <td class="description last">Users local date - format 2025-10-31</td>
704
+ </tr>
705
+
706
+
707
+ </tbody>
708
+ </table>
709
+
710
+
711
+
712
+
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+ <h5 class="h5-returns">Returns:</h5>
726
+ <ul>
727
+ <li>
728
+ <div class="param-desc">
729
+ result - The result object.
730
+ </div>
731
+
732
+
733
+
734
+ <dl class="param-type">
735
+ <dt>
736
+ Type
737
+ </dt>
738
+ <dd>
739
+
740
+ <span class="param-type">Promise.&lt;Object></span>
741
+
742
+
743
+
744
+ </dd>
745
+ </dl>
746
+ </li>
747
+
748
+ <li>
749
+ <div class="param-desc">
750
+ result.id - The learning path ID.
751
+ </div>
752
+
753
+
754
+
755
+ <dl class="param-type">
756
+ <dt>
757
+ Type
758
+ </dt>
759
+ <dd>
760
+
761
+ <span class="param-type">number</span>
762
+
763
+
764
+
765
+ </dd>
766
+ </dl>
767
+ </li>
768
+
769
+ <li>
770
+ <div class="param-desc">
771
+ result.thumbnail - Optional thumbnail URL for the learning path.
772
+ </div>
773
+
774
+
775
+
776
+ <dl class="param-type">
777
+ <dt>
778
+ Type
779
+ </dt>
780
+ <dd>
781
+
782
+ <span class="param-type">string</span>
783
+
784
+
785
+
786
+ </dd>
787
+ </dl>
788
+ </li>
789
+
790
+ <li>
791
+ <div class="param-desc">
792
+ result.title - The title of the learning path.
793
+ </div>
794
+
795
+
796
+
797
+ <dl class="param-type">
798
+ <dt>
799
+ Type
800
+ </dt>
801
+ <dd>
802
+
803
+ <span class="param-type">string</span>
804
+
805
+
806
+
807
+ </dd>
808
+ </dl>
809
+ </li>
810
+
811
+ <li>
812
+ <div class="param-desc">
813
+ result.is_active_learning_path - Whether the learning path is currently active.
814
+ </div>
815
+
816
+
817
+
818
+ <dl class="param-type">
819
+ <dt>
820
+ Type
821
+ </dt>
822
+ <dd>
823
+
824
+ <span class="param-type">boolean</span>
825
+
826
+
827
+
828
+ </dd>
829
+ </dl>
830
+ </li>
831
+
832
+ <li>
833
+ <div class="param-desc">
834
+ result.children - Array of all lessons.
835
+ </div>
836
+
837
+
838
+
839
+ <dl class="param-type">
840
+ <dt>
841
+ Type
842
+ </dt>
843
+ <dd>
844
+
845
+ <span class="param-type">Array</span>
846
+
847
+
848
+
849
+ </dd>
850
+ </dl>
851
+ </li>
852
+
853
+ <li>
854
+ <div class="param-desc">
855
+ result.upcoming_lessons - Array of upcoming/additional lessons.
856
+ </div>
857
+
858
+
859
+
860
+ <dl class="param-type">
861
+ <dt>
862
+ Type
863
+ </dt>
864
+ <dd>
865
+
866
+ <span class="param-type">Array</span>
867
+
868
+
869
+
870
+ </dd>
871
+ </dl>
872
+ </li>
873
+
874
+ <li>
875
+ <div class="param-desc">
876
+ result.todays_lessons - Array of today's lessons (max 3).
877
+ </div>
878
+
879
+
880
+
881
+ <dl class="param-type">
882
+ <dt>
883
+ Type
884
+ </dt>
885
+ <dd>
886
+
887
+ <span class="param-type">Array</span>
888
+
889
+
890
+
891
+ </dd>
892
+ </dl>
893
+ </li>
894
+
895
+ <li>
896
+ <div class="param-desc">
897
+ result.next_learning_path_lessons - Array of next lessons to be taken.
898
+ </div>
899
+
900
+
901
+
902
+ <dl class="param-type">
903
+ <dt>
904
+ Type
905
+ </dt>
906
+ <dd>
907
+
908
+ <span class="param-type">Array</span>
909
+
910
+
911
+
912
+ </dd>
913
+ </dl>
914
+ </li>
915
+
916
+ <li>
917
+ <div class="param-desc">
918
+ result.completed_lessons - Array of completed lessons.
919
+ </div>
920
+
921
+
922
+
923
+ <dl class="param-type">
924
+ <dt>
925
+ Type
926
+ </dt>
927
+ <dd>
928
+
929
+ <span class="param-type">Array</span>
930
+
931
+
932
+
933
+ </dd>
934
+ </dl>
935
+ </li>
936
+
937
+ <li>
938
+ <div class="param-desc">
939
+ result.previous_learning_path_todays - Array of completed lessons.
940
+ </div>
941
+
942
+
943
+
944
+ <dl class="param-type">
945
+ <dt>
946
+ Type
947
+ </dt>
948
+ <dd>
949
+
950
+ <span class="param-type">Array</span>
951
+
952
+
953
+
954
+ </dd>
955
+ </dl>
956
+ </li>
957
+ </ul>
958
+
959
+
960
+
961
+
962
+
963
+
964
+
965
+
966
+ <h4 class="name" id="~fetchLearningPathProgressCheckLessons"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchLearningPathProgressCheckLessons<span class="signature">(contentIds, learningPathId)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>|Array|Array|Array|Array}</span></h4>
967
+
968
+
969
+
970
+
971
+
972
+
973
+ <dl class="details">
974
+
975
+ <dt class="tag-description">Description:</dt>
976
+ <dd class="tag-description"><ul class="dummy"><li>For an array of contentIds, fetch any content progress with state=completed,
977
+ including other learning paths and a la carte progress.</li></ul></dd>
978
+
979
+
980
+
981
+ <dt class="tag-source">Source:</dt>
982
+ <dd class="tag-source"><ul class="dummy"><li>
983
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line224">line 224</a>
984
+ </li></ul></dd>
985
+
986
+
987
+
988
+
989
+
990
+
991
+
992
+
993
+
994
+
995
+
996
+
997
+
998
+
999
+
1000
+
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+ </dl>
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+
1024
+
1025
+
1026
+
1027
+
1028
+
1029
+
1030
+ <h5 class="h5-parameters">Parameters:</h5>
1031
+
1032
+
1033
+ <table class="params">
1034
+ <thead>
1035
+ <tr>
1036
+
1037
+ <th>Name</th>
1038
+
1039
+
1040
+ <th>Type</th>
1041
+
1042
+
1043
+
1044
+
1045
+
1046
+ <th class="last">Description</th>
1047
+ </tr>
1048
+ </thead>
1049
+
1050
+ <tbody>
1051
+
1052
+
1053
+ <tr>
1054
+
1055
+ <td class="name"><code>contentIds</code></td>
1056
+
1057
+
1058
+ <td class="type">
1059
+
1060
+ </td>
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+ <td class="description last">The array of content IDs within the learning path</td>
1067
+ </tr>
1068
+
1069
+
1070
+
1071
+ <tr>
1072
+
1073
+ <td class="name"><code>learningPathId</code></td>
1074
+
1075
+
1076
+ <td class="type">
1077
+
1078
+ </td>
1079
+
1080
+
1081
+
1082
+
1083
+
1084
+ <td class="description last">The learning path ID</td>
1085
+ </tr>
1086
+
1087
+
1088
+ </tbody>
1089
+ </table>
1090
+
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+
1102
+
1103
+
1104
+
1105
+
1106
+ <h5 class="h5-returns">Returns:</h5>
1107
+ <ul>
1108
+ <li>
1109
+ <div class="param-desc">
1110
+ Response object
1111
+ </div>
1112
+
1113
+
1114
+
1115
+ <dl class="param-type">
1116
+ <dt>
1117
+ Type
1118
+ </dt>
1119
+ <dd>
1120
+
1121
+ <span class="param-type">Promise.&lt;Object></span>
1122
+
1123
+
1124
+
1125
+ </dd>
1126
+ </dl>
1127
+ </li>
1128
+
1129
+ <li>
1130
+ <div class="param-desc">
1131
+ result.lessons - Array of all learning path lesson contentIds.
1132
+ </div>
1133
+
1134
+
1135
+
1136
+ <dl class="param-type">
1137
+ <dt>
1138
+ Type
1139
+ </dt>
1140
+ <dd>
1141
+
1142
+ <span class="param-type">Array</span>
1143
+
1144
+
1145
+
1146
+ </dd>
1147
+ </dl>
1148
+ </li>
1149
+
1150
+ <li>
1151
+ <div class="param-desc">
1152
+ result.completed_lessons - Array of learning path lesson contentIds that are completed.
1153
+ </div>
1154
+
1155
+
1156
+
1157
+ <dl class="param-type">
1158
+ <dt>
1159
+ Type
1160
+ </dt>
1161
+ <dd>
1162
+
1163
+ <span class="param-type">Array</span>
1164
+
1165
+
1166
+
1167
+ </dd>
1168
+ </dl>
1169
+ </li>
1170
+
1171
+ <li>
1172
+ <div class="param-desc">
1173
+ result.lessons_count - Count of learning path lessons.
1174
+ </div>
1175
+
1176
+
1177
+
1178
+ <dl class="param-type">
1179
+ <dt>
1180
+ Type
1181
+ </dt>
1182
+ <dd>
1183
+
1184
+ <span class="param-type">Array</span>
1185
+
1186
+
1187
+
1188
+ </dd>
1189
+ </dl>
1190
+ </li>
1191
+
1192
+ <li>
1193
+ <div class="param-desc">
1194
+ result.completed_lessons_count - Count of learning path completed lessons.
1195
+ </div>
1196
+
1197
+
1198
+
1199
+ <dl class="param-type">
1200
+ <dt>
1201
+ Type
1202
+ </dt>
1203
+ <dd>
1204
+
1205
+ <span class="param-type">Array</span>
1206
+
1207
+
1208
+
1209
+ </dd>
1210
+ </dl>
1211
+ </li>
1212
+ </ul>
1213
+
1214
+
1215
+
1216
+
1217
+
1218
+
1219
+
1220
+
1221
+ <h4 class="name" id="~getActivePath"><span class="type-signature type-signature-async, inner">(async, inner) </span>getActivePath<span class="signature">(brand)</span><span class="type-signature"></span></h4>
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+
1228
+ <dl class="details">
1229
+
1230
+ <dt class="tag-description">Description:</dt>
1231
+ <dd class="tag-description"><ul class="dummy"><li>Gets user's active learning path.</li></ul></dd>
1232
+
1233
+
1234
+
1235
+ <dt class="tag-source">Source:</dt>
1236
+ <dd class="tag-source"><ul class="dummy"><li>
1237
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line52">line 52</a>
1238
+ </li></ul></dd>
1239
+
1240
+
1241
+
1242
+
1243
+
1244
+
1245
+
1246
+
1247
+
1248
+
1249
+
1250
+
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+ </dl>
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+ <h5 class="h5-parameters">Parameters:</h5>
1285
+
1286
+
1287
+ <table class="params">
1288
+ <thead>
1289
+ <tr>
1290
+
1291
+ <th>Name</th>
1292
+
1293
+
1294
+ <th>Type</th>
1295
+
1296
+
1297
+
1298
+
1299
+
1300
+ <th class="last">Description</th>
1301
+ </tr>
1302
+ </thead>
1303
+
1304
+ <tbody>
1305
+
1306
+
1307
+ <tr>
1308
+
1309
+ <td class="name"><code>brand</code></td>
1310
+
1311
+
1312
+ <td class="type">
1313
+
1314
+ </td>
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+ <td class="description last"></td>
1321
+ </tr>
1322
+
1323
+
1324
+ </tbody>
1325
+ </table>
1326
+
1327
+
1328
+
1329
+
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+
1342
+
1343
+
1344
+
1345
+
1346
+
1347
+
1348
+
1349
+
1350
+ <h4 class="name" id="~getDailySession"><span class="type-signature type-signature-async, inner">(async, inner) </span>getDailySession<span class="signature">(brand, userDate)</span><span class="type-signature"></span></h4>
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+ <dl class="details">
1358
+
1359
+ <dt class="tag-description">Description:</dt>
1360
+ <dd class="tag-description"><ul class="dummy"><li>Gets today's daily session for the user.</li></ul></dd>
1361
+
1362
+
1363
+
1364
+ <dt class="tag-source">Source:</dt>
1365
+ <dd class="tag-source"><ul class="dummy"><li>
1366
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line24">line 24</a>
1367
+ </li></ul></dd>
1368
+
1369
+
1370
+
1371
+
1372
+
1373
+
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+
1382
+
1383
+
1384
+
1385
+
1386
+
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+
1398
+
1399
+ </dl>
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+
1406
+
1407
+
1408
+
1409
+
1410
+
1411
+
1412
+
1413
+ <h5 class="h5-parameters">Parameters:</h5>
1414
+
1415
+
1416
+ <table class="params">
1417
+ <thead>
1418
+ <tr>
1419
+
1420
+ <th>Name</th>
1421
+
1422
+
1423
+ <th>Type</th>
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+ <th class="last">Description</th>
1430
+ </tr>
1431
+ </thead>
1432
+
1433
+ <tbody>
1434
+
1435
+
1436
+ <tr>
1437
+
1438
+ <td class="name"><code>brand</code></td>
1439
+
1440
+
1441
+ <td class="type">
1442
+
1443
+ </td>
1444
+
1445
+
1446
+
1447
+
1448
+
1449
+ <td class="description last"></td>
1450
+ </tr>
1451
+
1452
+
1453
+
1454
+ <tr>
1455
+
1456
+ <td class="name"><code>userDate</code></td>
1457
+
1458
+
1459
+ <td class="type">
1460
+
1461
+ </td>
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+ <td class="description last"></td>
1468
+ </tr>
1469
+
1470
+
1471
+ </tbody>
1472
+ </table>
1473
+
1474
+
1475
+
1476
+
1477
+
1478
+
1479
+
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+
1486
+
1487
+
1488
+
1489
+
1490
+
1491
+
1492
+
1493
+
1494
+
1495
+
1496
+
1497
+ <h4 class="name" id="~getEnrichedLearningPath"><span class="type-signature type-signature-async, inner">(async, inner) </span>getEnrichedLearningPath<span class="signature">(learningPathId)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+ <dl class="details">
1505
+
1506
+ <dt class="tag-description">Description:</dt>
1507
+ <dd class="tag-description"><ul class="dummy"><li>Returns learning path with lessons and progress data</li></ul></dd>
1508
+
1509
+
1510
+
1511
+ <dt class="tag-source">Source:</dt>
1512
+ <dd class="tag-source"><ul class="dummy"><li>
1513
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line80">line 80</a>
1514
+ </li></ul></dd>
1515
+
1516
+
1517
+
1518
+
1519
+
1520
+
1521
+
1522
+
1523
+
1524
+
1525
+
1526
+
1527
+
1528
+
1529
+
1530
+
1531
+
1532
+
1533
+
1534
+
1535
+
1536
+
1537
+
1538
+
1539
+
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+ </dl>
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+ <h5 class="h5-parameters">Parameters:</h5>
1561
+
1562
+
1563
+ <table class="params">
1564
+ <thead>
1565
+ <tr>
1566
+
1567
+ <th>Name</th>
1568
+
1569
+
1570
+ <th>Type</th>
1571
+
1572
+
1573
+
1574
+
1575
+
1576
+ <th class="last">Description</th>
1577
+ </tr>
1578
+ </thead>
1579
+
1580
+ <tbody>
1581
+
1582
+
1583
+ <tr>
1584
+
1585
+ <td class="name"><code>learningPathId</code></td>
1586
+
1587
+
1588
+ <td class="type">
1589
+
1590
+
1591
+ <span class="param-type">number</span>
1592
+
1593
+
1594
+
1595
+
1596
+ </td>
1597
+
1598
+
1599
+
1600
+
1601
+
1602
+ <td class="description last">The learning path ID</td>
1603
+ </tr>
1604
+
1605
+
1606
+ </tbody>
1607
+ </table>
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+
1615
+
1616
+
1617
+
1618
+
1619
+
1620
+
1621
+
1622
+
1623
+
1624
+ <h5 class="h5-returns">Returns:</h5>
1625
+
1626
+
1627
+ <div class="param-desc">
1628
+ Learning path with enriched lesson data
1629
+ </div>
1630
+
1631
+
1632
+
1633
+ <dl class="param-type">
1634
+ <dt>
1635
+ Type
1636
+ </dt>
1637
+ <dd>
1638
+
1639
+ <span class="param-type">Promise.&lt;Object></span>
1640
+
1641
+
1642
+
1643
+ </dd>
1644
+ </dl>
1645
+
1646
+
1647
+
1648
+
1649
+
1650
+
1651
+
1652
+
1653
+
1654
+
1655
+ <h4 class="name" id="~getLearningPathLessonsByIds"><span class="type-signature type-signature-async, inner">(async, inner) </span>getLearningPathLessonsByIds<span class="signature">(contentIds, learningPathId)</span><span class="type-signature"> &rarr; {Promise.&lt;Array>}</span></h4>
1656
+
1657
+
1658
+
1659
+
1660
+
1661
+
1662
+ <dl class="details">
1663
+
1664
+ <dt class="tag-description">Description:</dt>
1665
+ <dd class="tag-description"><ul class="dummy"><li>Get specific learning path lessons by content IDs</li></ul></dd>
1666
+
1667
+
1668
+
1669
+ <dt class="tag-source">Source:</dt>
1670
+ <dd class="tag-source"><ul class="dummy"><li>
1671
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line110">line 110</a>
1672
+ </li></ul></dd>
1673
+
1674
+
1675
+
1676
+
1677
+
1678
+
1679
+
1680
+
1681
+
1682
+
1683
+
1684
+
1685
+
1686
+
1687
+
1688
+
1689
+
1690
+
1691
+
1692
+
1693
+
1694
+
1695
+
1696
+
1697
+
1698
+
1699
+
1700
+
1701
+
1702
+
1703
+
1704
+ </dl>
1705
+
1706
+
1707
+
1708
+
1709
+
1710
+
1711
+
1712
+
1713
+
1714
+
1715
+
1716
+
1717
+
1718
+ <h5 class="h5-parameters">Parameters:</h5>
1719
+
1720
+
1721
+ <table class="params">
1722
+ <thead>
1723
+ <tr>
1724
+
1725
+ <th>Name</th>
1726
+
1727
+
1728
+ <th>Type</th>
1729
+
1730
+
1731
+
1732
+
1733
+
1734
+ <th class="last">Description</th>
1735
+ </tr>
1736
+ </thead>
1737
+
1738
+ <tbody>
1739
+
1740
+
1741
+ <tr>
1742
+
1743
+ <td class="name"><code>contentIds</code></td>
1744
+
1745
+
1746
+ <td class="type">
1747
+
1748
+
1749
+ <span class="param-type">Array.&lt;number></span>
1750
+
1751
+
1752
+
1753
+
1754
+ </td>
1755
+
1756
+
1757
+
1758
+
1759
+
1760
+ <td class="description last">Array of content IDs to filter</td>
1761
+ </tr>
1762
+
1763
+
1764
+
1765
+ <tr>
1766
+
1767
+ <td class="name"><code>learningPathId</code></td>
1768
+
1769
+
1770
+ <td class="type">
1771
+
1772
+
1773
+ <span class="param-type">number</span>
1774
+
1775
+
1776
+
1777
+
1778
+ </td>
1779
+
1780
+
1781
+
1782
+
1783
+
1784
+ <td class="description last">The learning path ID</td>
1785
+ </tr>
1786
+
1787
+
1788
+ </tbody>
1789
+ </table>
1790
+
1791
+
1792
+
1793
+
1794
+
1795
+
1796
+
1797
+
1798
+
1799
+
1800
+
1801
+
1802
+
1803
+
1804
+
1805
+
1806
+ <h5 class="h5-returns">Returns:</h5>
1807
+
1808
+
1809
+ <div class="param-desc">
1810
+ Filtered lessons
1811
+ </div>
1812
+
1813
+
1814
+
1815
+ <dl class="param-type">
1816
+ <dt>
1817
+ Type
1818
+ </dt>
1819
+ <dd>
1820
+
1821
+ <span class="param-type">Promise.&lt;Array></span>
1822
+
1823
+
1824
+
1825
+ </dd>
1826
+ </dl>
1827
+
1828
+
1829
+
1830
+
1831
+
1832
+
1833
+
1834
+
1835
+
1836
+
1837
+ <h4 class="name" id="~mapContentToParent"><span class="type-signature type-signature-inner">(inner) </span>mapContentToParent<span class="signature">(lessons, parentContentType, parentContentId)</span><span class="type-signature"></span></h4>
1838
+
1839
+
1840
+
1841
+
1842
+
1843
+
1844
+ <dl class="details">
1845
+
1846
+ <dt class="tag-description">Description:</dt>
1847
+ <dd class="tag-description"><ul class="dummy"><li>Maps content to its parent learning path - fixes multi-parent problems for cta when lessons have a special collection.</li></ul></dd>
1848
+
1849
+
1850
+
1851
+ <dt class="tag-source">Source:</dt>
1852
+ <dd class="tag-source"><ul class="dummy"><li>
1853
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line123">line 123</a>
1854
+ </li></ul></dd>
1855
+
1856
+
1857
+
1858
+
1859
+
1860
+
1861
+
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+
1868
+
1869
+
1870
+
1871
+
1872
+
1873
+
1874
+
1875
+
1876
+
1877
+
1878
+
1879
+
1880
+
1881
+
1882
+
1883
+
1884
+
1885
+
1886
+ </dl>
1887
+
1888
+
1889
+
1890
+
1891
+
1892
+
1893
+
1894
+
1895
+
1896
+
1897
+
1898
+
1899
+
1900
+ <h5 class="h5-parameters">Parameters:</h5>
1901
+
1902
+
1903
+ <table class="params">
1904
+ <thead>
1905
+ <tr>
1906
+
1907
+ <th>Name</th>
1908
+
1909
+
1910
+ <th>Type</th>
1911
+
1912
+
1913
+
1914
+
1915
+
1916
+ <th class="last">Description</th>
1917
+ </tr>
1918
+ </thead>
1919
+
1920
+ <tbody>
1921
+
1922
+
1923
+ <tr>
1924
+
1925
+ <td class="name"><code>lessons</code></td>
1926
+
1927
+
1928
+ <td class="type">
1929
+
1930
+ </td>
1931
+
1932
+
1933
+
1934
+
1935
+
1936
+ <td class="description last"></td>
1937
+ </tr>
1938
+
1939
+
1940
+
1941
+ <tr>
1942
+
1943
+ <td class="name"><code>parentContentType</code></td>
1944
+
1945
+
1946
+ <td class="type">
1947
+
1948
+ </td>
1949
+
1950
+
1951
+
1952
+
1953
+
1954
+ <td class="description last"></td>
1955
+ </tr>
1956
+
1957
+
1958
+
1959
+ <tr>
1960
+
1961
+ <td class="name"><code>parentContentId</code></td>
1962
+
1963
+
1964
+ <td class="type">
1965
+
1966
+ </td>
1967
+
1968
+
1969
+
1970
+
1971
+
1972
+ <td class="description last"></td>
1973
+ </tr>
1974
+
1975
+
1976
+ </tbody>
1977
+ </table>
1978
+
1979
+
1980
+
1981
+
1982
+
1983
+
1984
+
1985
+
1986
+
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+
1994
+
1995
+
1996
+
1997
+
1998
+
1999
+
2000
+
2001
+
2002
+ <h4 class="name" id="~resetAllLearningPaths"><span class="type-signature type-signature-async, inner">(async, inner) </span>resetAllLearningPaths<span class="signature">()</span><span class="type-signature"></span></h4>
2003
+
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+ <dl class="details">
2010
+
2011
+ <dt class="tag-description">Description:</dt>
2012
+ <dd class="tag-description"><ul class="dummy"><li>Resets the user's learning path.</li></ul></dd>
2013
+
2014
+
2015
+
2016
+ <dt class="tag-source">Source:</dt>
2017
+ <dd class="tag-source"><ul class="dummy"><li>
2018
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line72">line 72</a>
2019
+ </li></ul></dd>
2020
+
2021
+
2022
+
2023
+
2024
+
2025
+
2026
+
2027
+
2028
+
2029
+
2030
+
2031
+
2032
+
2033
+
2034
+
2035
+
2036
+
2037
+
2038
+
2039
+
2040
+
2041
+
2042
+
2043
+
2044
+
2045
+
2046
+
2047
+
2048
+
2049
+
2050
+
2051
+ </dl>
2052
+
2053
+
2054
+
2055
+
2056
+
2057
+
2058
+
2059
+
2060
+
2061
+
2062
+
2063
+
2064
+
2065
+
2066
+
2067
+
2068
+
2069
+
2070
+
2071
+
2072
+
2073
+
2074
+
2075
+
2076
+
2077
+
2078
+
2079
+
2080
+
2081
+
2082
+
2083
+
2084
+
2085
+
2086
+
2087
+ <h4 class="name" id="~startLearningPath"><span class="type-signature type-signature-async, inner">(async, inner) </span>startLearningPath<span class="signature">(brand, learningPathId)</span><span class="type-signature"></span></h4>
2088
+
2089
+
2090
+
2091
+
2092
+
2093
+
2094
+ <dl class="details">
2095
+
2096
+ <dt class="tag-description">Description:</dt>
2097
+ <dd class="tag-description"><ul class="dummy"><li>Sets a new learning path as the user's active learning path.</li></ul></dd>
2098
+
2099
+
2100
+
2101
+ <dt class="tag-source">Source:</dt>
2102
+ <dd class="tag-source"><ul class="dummy"><li>
2103
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line61">line 61</a>
2104
+ </li></ul></dd>
2105
+
2106
+
2107
+
2108
+
2109
+
2110
+
2111
+
2112
+
2113
+
2114
+
2115
+
2116
+
2117
+
2118
+
2119
+
2120
+
2121
+
2122
+
2123
+
2124
+
2125
+
2126
+
2127
+
2128
+
2129
+
2130
+
2131
+
2132
+
2133
+
2134
+
2135
+
2136
+ </dl>
2137
+
2138
+
2139
+
2140
+
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+
2147
+
2148
+
2149
+
2150
+ <h5 class="h5-parameters">Parameters:</h5>
2151
+
2152
+
2153
+ <table class="params">
2154
+ <thead>
2155
+ <tr>
2156
+
2157
+ <th>Name</th>
2158
+
2159
+
2160
+ <th>Type</th>
2161
+
2162
+
2163
+
2164
+
2165
+
2166
+ <th class="last">Description</th>
2167
+ </tr>
2168
+ </thead>
2169
+
2170
+ <tbody>
2171
+
2172
+
2173
+ <tr>
2174
+
2175
+ <td class="name"><code>brand</code></td>
2176
+
2177
+
2178
+ <td class="type">
2179
+
2180
+ </td>
2181
+
2182
+
2183
+
2184
+
2185
+
2186
+ <td class="description last"></td>
2187
+ </tr>
2188
+
2189
+
2190
+
2191
+ <tr>
2192
+
2193
+ <td class="name"><code>learningPathId</code></td>
2194
+
2195
+
2196
+ <td class="type">
2197
+
2198
+ </td>
2199
+
2200
+
2201
+
2202
+
2203
+
2204
+ <td class="description last"></td>
2205
+ </tr>
2206
+
2207
+
2208
+ </tbody>
2209
+ </table>
2210
+
2211
+
2212
+
2213
+
2214
+
2215
+
2216
+
2217
+
2218
+
2219
+
2220
+
2221
+
2222
+
2223
+
2224
+
2225
+
2226
+
2227
+
2228
+
2229
+
2230
+
2231
+
2232
+
2233
+
2234
+ <h4 class="name" id="~updateDailySession"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateDailySession<span class="signature">(brand, userDate, keepFirstLearningPath)</span><span class="type-signature"></span></h4>
2235
+
2236
+
2237
+
2238
+
2239
+
2240
+
2241
+ <dl class="details">
2242
+
2243
+ <dt class="tag-description">Description:</dt>
2244
+ <dd class="tag-description"><ul class="dummy"><li>Updates the daily session for the user. Optionally, keeps the first learning path's dailies from a matching day's session.</li></ul></dd>
2245
+
2246
+
2247
+
2248
+ <dt class="tag-source">Source:</dt>
2249
+ <dd class="tag-source"><ul class="dummy"><li>
2250
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line35">line 35</a>
2251
+ </li></ul></dd>
2252
+
2253
+
2254
+
2255
+
2256
+
2257
+
2258
+
2259
+
2260
+
2261
+
2262
+
2263
+
2264
+
2265
+
2266
+
2267
+
2268
+
2269
+
2270
+
2271
+
2272
+
2273
+
2274
+
2275
+
2276
+
2277
+
2278
+
2279
+
2280
+
2281
+
2282
+
2283
+ </dl>
2284
+
2285
+
2286
+
2287
+
2288
+
2289
+
2290
+
2291
+
2292
+
2293
+
2294
+
2295
+
2296
+
2297
+ <h5 class="h5-parameters">Parameters:</h5>
2298
+
2299
+
2300
+ <table class="params">
2301
+ <thead>
2302
+ <tr>
2303
+
2304
+ <th>Name</th>
2305
+
2306
+
2307
+ <th>Type</th>
2308
+
2309
+
2310
+
2311
+
2312
+
2313
+ <th class="last">Description</th>
2314
+ </tr>
2315
+ </thead>
2316
+
2317
+ <tbody>
2318
+
2319
+
2320
+ <tr>
2321
+
2322
+ <td class="name"><code>brand</code></td>
2323
+
2324
+
2325
+ <td class="type">
2326
+
2327
+ </td>
2328
+
2329
+
2330
+
2331
+
2332
+
2333
+ <td class="description last"></td>
2334
+ </tr>
2335
+
2336
+
2337
+
2338
+ <tr>
2339
+
2340
+ <td class="name"><code>userDate</code></td>
2341
+
2342
+
2343
+ <td class="type">
2344
+
2345
+ </td>
2346
+
2347
+
2348
+
2349
+
2350
+
2351
+ <td class="description last">format 2025-10-31</td>
2352
+ </tr>
2353
+
2354
+
2355
+
2356
+ <tr>
2357
+
2358
+ <td class="name"><code>keepFirstLearningPath</code></td>
2359
+
2360
+
2361
+ <td class="type">
2362
+
2363
+ </td>
2364
+
2365
+
2366
+
2367
+
2368
+
2369
+ <td class="description last"></td>
2370
+ </tr>
2371
+
2372
+
2373
+ </tbody>
2374
+ </table>
2375
+
2376
+
2377
+
2378
+
2379
+
2380
+
2381
+
2382
+
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+
2392
+
2393
+
2394
+
2395
+
2396
+
2397
+
2398
+
2399
+
2400
+ </article>
2401
+
2402
+ </section>
2403
+
2404
+
2405
+
2406
+
2407
+
2408
+
2409
+ </div>
2410
+
2411
+ <br class="clear">
2412
+
2413
+ <footer>
2414
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Nov 28 2025 11:22:56 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2415
+ </footer>
2416
+
2417
+ <script>prettyPrint();</script>
2418
+ <script src="scripts/polyfill.js"></script>
2419
+ <script src="scripts/linenumber.js"></script>
2420
+
2421
+
2422
+
2423
+ </body>
2424
+ </html>