musora-content-services 2.71.0 → 2.72.1

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 (70) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/docs/ContentOrganization.html +2 -2
  3. package/docs/Forums.html +2 -2
  4. package/docs/Gamification.html +2 -2
  5. package/docs/TestUser.html +3 -3
  6. package/docs/UserManagementSystem.html +2 -2
  7. package/docs/api_types.js.html +2 -2
  8. package/docs/config.js.html +2 -2
  9. package/docs/content-org_content-org.js.html +2 -2
  10. package/docs/content-org_guided-courses.ts.html +2 -2
  11. package/docs/content-org_learning-paths.ts.html +94 -5
  12. package/docs/content-org_playlists-types.js.html +2 -2
  13. package/docs/content-org_playlists.js.html +2 -2
  14. package/docs/content.js.html +2 -2
  15. package/docs/forums_categories.ts.html +2 -2
  16. package/docs/forums_forums.ts.html +41 -41
  17. package/docs/forums_posts.ts.html +34 -27
  18. package/docs/forums_threads.ts.html +2 -2
  19. package/docs/gamification_awards.ts.html +2 -2
  20. package/docs/gamification_gamification.js.html +2 -2
  21. package/docs/global.html +3 -3
  22. package/docs/index.html +2 -2
  23. package/docs/liveTesting.ts.html +4 -3
  24. package/docs/module-Accounts.html +2 -2
  25. package/docs/module-Awards.html +2 -2
  26. package/docs/module-Config.html +2 -2
  27. package/docs/module-Content-Services-V2.html +2 -2
  28. package/docs/module-Forums.html +26 -26
  29. package/docs/module-GuidedCourses.html +2 -1198
  30. package/docs/module-Interests.html +2 -2
  31. package/docs/module-LearningPaths.html +1077 -0
  32. package/docs/module-Onboarding.html +2 -2
  33. package/docs/module-Payments.html +2 -2
  34. package/docs/module-Permissions.html +2 -2
  35. package/docs/module-Playlists.html +2 -2
  36. package/docs/module-Railcontent-Services.html +2 -2
  37. package/docs/module-Sanity-Services.html +32 -32
  38. package/docs/module-Sessions.html +2 -2
  39. package/docs/module-UserActivity.html +2 -2
  40. package/docs/module-UserChat.html +2 -2
  41. package/docs/module-UserManagement.html +2 -2
  42. package/docs/module-UserMemberships.html +2 -2
  43. package/docs/module-UserNotifications.html +2 -2
  44. package/docs/module-UserProfile.html +2 -2
  45. package/docs/railcontent.js.html +2 -2
  46. package/docs/sanity.js.html +5 -7
  47. package/docs/userActivity.js.html +2 -2
  48. package/docs/user_account.ts.html +2 -2
  49. package/docs/user_chat.js.html +2 -2
  50. package/docs/user_interests.js.html +2 -2
  51. package/docs/user_management.js.html +2 -2
  52. package/docs/user_memberships.ts.html +2 -2
  53. package/docs/user_notifications.js.html +2 -2
  54. package/docs/user_onboarding.ts.html +2 -2
  55. package/docs/user_payments.ts.html +2 -2
  56. package/docs/user_permissions.js.html +2 -2
  57. package/docs/user_profile.js.html +2 -2
  58. package/docs/user_sessions.js.html +2 -2
  59. package/docs/user_types.js.html +2 -2
  60. package/docs/user_user-management-system.js.html +2 -2
  61. package/package.json +1 -1
  62. package/src/contentTypeConfig.js +162 -105
  63. package/src/index.d.ts +2 -0
  64. package/src/index.js +2 -0
  65. package/src/lib/httpHelper.js +5 -0
  66. package/src/services/content-org/learning-paths.ts +92 -3
  67. package/src/services/forums/forums.ts +38 -38
  68. package/src/services/forums/posts.ts +32 -25
  69. package/test/initializeTests.js +21 -36
  70. package/test/learningPaths.test.js +19 -0
@@ -0,0 +1,1077 @@
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></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#.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#~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#~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-GuidedCourses.html">GuidedCourses</a></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#~fetchLearningPathLessons">fetchLearningPathLessons</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#~updateActivePath">updateActivePath</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-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#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</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#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</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#.fetchCoachLessons">fetchCoachLessons</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#.fetchGenreLessons">fetchGenreLessons</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#.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#.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#.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="~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}</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>Fetches and organizes learning path lessons.</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#line91">line 91</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>learningPathId</code></td>
176
+
177
+
178
+ <td class="type">
179
+
180
+
181
+ <span class="param-type">number</span>
182
+
183
+
184
+
185
+
186
+ </td>
187
+
188
+
189
+
190
+
191
+
192
+ <td class="description last">The learning path ID.</td>
193
+ </tr>
194
+
195
+
196
+
197
+ <tr>
198
+
199
+ <td class="name"><code>brand</code></td>
200
+
201
+
202
+ <td class="type">
203
+
204
+
205
+ <span class="param-type">string</span>
206
+
207
+
208
+
209
+
210
+ </td>
211
+
212
+
213
+
214
+
215
+
216
+ <td class="description last"></td>
217
+ </tr>
218
+
219
+
220
+
221
+ <tr>
222
+
223
+ <td class="name"><code>userDate</code></td>
224
+
225
+
226
+ <td class="type">
227
+
228
+
229
+ <span class="param-type">Date</span>
230
+
231
+
232
+
233
+
234
+ </td>
235
+
236
+
237
+
238
+
239
+
240
+ <td class="description last">Users local date - format 2025-10-31</td>
241
+ </tr>
242
+
243
+
244
+ </tbody>
245
+ </table>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ <h5 class="h5-returns">Returns:</h5>
263
+ <ul>
264
+ <li>
265
+ <div class="param-desc">
266
+ result - The result object.
267
+ </div>
268
+
269
+
270
+
271
+ <dl class="param-type">
272
+ <dt>
273
+ Type
274
+ </dt>
275
+ <dd>
276
+
277
+ <span class="param-type">Promise.&lt;Object></span>
278
+
279
+
280
+
281
+ </dd>
282
+ </dl>
283
+ </li>
284
+
285
+ <li>
286
+ <div class="param-desc">
287
+ result.id - The learning path ID.
288
+ </div>
289
+
290
+
291
+
292
+ <dl class="param-type">
293
+ <dt>
294
+ Type
295
+ </dt>
296
+ <dd>
297
+
298
+ <span class="param-type">number</span>
299
+
300
+
301
+
302
+ </dd>
303
+ </dl>
304
+ </li>
305
+
306
+ <li>
307
+ <div class="param-desc">
308
+ result.thumbnail - Optional thumbnail URL for the learning path.
309
+ </div>
310
+
311
+
312
+
313
+ <dl class="param-type">
314
+ <dt>
315
+ Type
316
+ </dt>
317
+ <dd>
318
+
319
+ <span class="param-type">string</span>
320
+
321
+
322
+
323
+ </dd>
324
+ </dl>
325
+ </li>
326
+
327
+ <li>
328
+ <div class="param-desc">
329
+ result.title - The title of the learning path.
330
+ </div>
331
+
332
+
333
+
334
+ <dl class="param-type">
335
+ <dt>
336
+ Type
337
+ </dt>
338
+ <dd>
339
+
340
+ <span class="param-type">string</span>
341
+
342
+
343
+
344
+ </dd>
345
+ </dl>
346
+ </li>
347
+
348
+ <li>
349
+ <div class="param-desc">
350
+ result.is_active_learning_path - Whether the learning path is currently active.
351
+ </div>
352
+
353
+
354
+
355
+ <dl class="param-type">
356
+ <dt>
357
+ Type
358
+ </dt>
359
+ <dd>
360
+
361
+ <span class="param-type">boolean</span>
362
+
363
+
364
+
365
+ </dd>
366
+ </dl>
367
+ </li>
368
+
369
+ <li>
370
+ <div class="param-desc">
371
+ result.all_lessons - Array of all lessons.
372
+ </div>
373
+
374
+
375
+
376
+ <dl class="param-type">
377
+ <dt>
378
+ Type
379
+ </dt>
380
+ <dd>
381
+
382
+ <span class="param-type">Array</span>
383
+
384
+
385
+
386
+ </dd>
387
+ </dl>
388
+ </li>
389
+
390
+ <li>
391
+ <div class="param-desc">
392
+ result.upcoming_lessons - Array of upcoming/additional lessons.
393
+ </div>
394
+
395
+
396
+
397
+ <dl class="param-type">
398
+ <dt>
399
+ Type
400
+ </dt>
401
+ <dd>
402
+
403
+ <span class="param-type">Array</span>
404
+
405
+
406
+
407
+ </dd>
408
+ </dl>
409
+ </li>
410
+
411
+ <li>
412
+ <div class="param-desc">
413
+ result.todays_lessons - Array of today's lessons (max 3).
414
+ </div>
415
+
416
+
417
+
418
+ <dl class="param-type">
419
+ <dt>
420
+ Type
421
+ </dt>
422
+ <dd>
423
+
424
+ <span class="param-type">Array</span>
425
+
426
+
427
+
428
+ </dd>
429
+ </dl>
430
+ </li>
431
+
432
+ <li>
433
+ <div class="param-desc">
434
+ result.next_learning_path_lessons - Array of next lessons to be taken.
435
+ </div>
436
+
437
+
438
+
439
+ <dl class="param-type">
440
+ <dt>
441
+ Type
442
+ </dt>
443
+ <dd>
444
+
445
+ <span class="param-type">Array</span>
446
+
447
+
448
+
449
+ </dd>
450
+ </dl>
451
+ </li>
452
+
453
+ <li>
454
+ <div class="param-desc">
455
+ result.completed_lessons - Array of completed lessons.
456
+ </div>
457
+
458
+
459
+
460
+ <dl class="param-type">
461
+ <dt>
462
+ Type
463
+ </dt>
464
+ <dd>
465
+
466
+ <span class="param-type">Array</span>
467
+
468
+
469
+
470
+ </dd>
471
+ </dl>
472
+ </li>
473
+ </ul>
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+ <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>
483
+
484
+
485
+
486
+
487
+
488
+
489
+ <dl class="details">
490
+
491
+ <dt class="tag-description">Description:</dt>
492
+ <dd class="tag-description"><ul class="dummy"><li>Gets user's active learning path.</li></ul></dd>
493
+
494
+
495
+
496
+ <dt class="tag-source">Source:</dt>
497
+ <dd class="tag-source"><ul class="dummy"><li>
498
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line39">line 39</a>
499
+ </li></ul></dd>
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+ </dl>
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+ <h5 class="h5-parameters">Parameters:</h5>
546
+
547
+
548
+ <table class="params">
549
+ <thead>
550
+ <tr>
551
+
552
+ <th>Name</th>
553
+
554
+
555
+ <th>Type</th>
556
+
557
+
558
+
559
+
560
+
561
+ <th class="last">Description</th>
562
+ </tr>
563
+ </thead>
564
+
565
+ <tbody>
566
+
567
+
568
+ <tr>
569
+
570
+ <td class="name"><code>brand</code></td>
571
+
572
+
573
+ <td class="type">
574
+
575
+ </td>
576
+
577
+
578
+
579
+
580
+
581
+ <td class="description last"></td>
582
+ </tr>
583
+
584
+
585
+ </tbody>
586
+ </table>
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+ <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>
612
+
613
+
614
+
615
+
616
+
617
+
618
+ <dl class="details">
619
+
620
+ <dt class="tag-description">Description:</dt>
621
+ <dd class="tag-description"><ul class="dummy"><li>Gets today's daily session for the user.</li></ul></dd>
622
+
623
+
624
+
625
+ <dt class="tag-source">Source:</dt>
626
+ <dd class="tag-source"><ul class="dummy"><li>
627
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line10">line 10</a>
628
+ </li></ul></dd>
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+ </dl>
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+ <h5 class="h5-parameters">Parameters:</h5>
675
+
676
+
677
+ <table class="params">
678
+ <thead>
679
+ <tr>
680
+
681
+ <th>Name</th>
682
+
683
+
684
+ <th>Type</th>
685
+
686
+
687
+
688
+
689
+
690
+ <th class="last">Description</th>
691
+ </tr>
692
+ </thead>
693
+
694
+ <tbody>
695
+
696
+
697
+ <tr>
698
+
699
+ <td class="name"><code>brand</code></td>
700
+
701
+
702
+ <td class="type">
703
+
704
+ </td>
705
+
706
+
707
+
708
+
709
+
710
+ <td class="description last"></td>
711
+ </tr>
712
+
713
+
714
+
715
+ <tr>
716
+
717
+ <td class="name"><code>userDate</code></td>
718
+
719
+
720
+ <td class="type">
721
+
722
+ </td>
723
+
724
+
725
+
726
+
727
+
728
+ <td class="description last"></td>
729
+ </tr>
730
+
731
+
732
+ </tbody>
733
+ </table>
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+ <h4 class="name" id="~updateActivePath"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateActivePath<span class="signature">(brand)</span><span class="type-signature"></span></h4>
759
+
760
+
761
+
762
+
763
+
764
+
765
+ <dl class="details">
766
+
767
+ <dt class="tag-description">Description:</dt>
768
+ <dd class="tag-description"><ul class="dummy"><li>Updates user's active learning path.</li></ul></dd>
769
+
770
+
771
+
772
+ <dt class="tag-source">Source:</dt>
773
+ <dd class="tag-source"><ul class="dummy"><li>
774
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line49">line 49</a>
775
+ </li></ul></dd>
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+
785
+
786
+
787
+
788
+
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+ </dl>
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+
818
+
819
+
820
+
821
+ <h5 class="h5-parameters">Parameters:</h5>
822
+
823
+
824
+ <table class="params">
825
+ <thead>
826
+ <tr>
827
+
828
+ <th>Name</th>
829
+
830
+
831
+ <th>Type</th>
832
+
833
+
834
+
835
+
836
+
837
+ <th class="last">Description</th>
838
+ </tr>
839
+ </thead>
840
+
841
+ <tbody>
842
+
843
+
844
+ <tr>
845
+
846
+ <td class="name"><code>brand</code></td>
847
+
848
+
849
+ <td class="type">
850
+
851
+ </td>
852
+
853
+
854
+
855
+
856
+
857
+ <td class="description last"></td>
858
+ </tr>
859
+
860
+
861
+ </tbody>
862
+ </table>
863
+
864
+
865
+
866
+
867
+
868
+
869
+
870
+
871
+
872
+
873
+
874
+
875
+
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+ <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>
888
+
889
+
890
+
891
+
892
+
893
+
894
+ <dl class="details">
895
+
896
+ <dt class="tag-description">Description:</dt>
897
+ <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>
898
+
899
+
900
+
901
+ <dt class="tag-source">Source:</dt>
902
+ <dd class="tag-source"><ul class="dummy"><li>
903
+ <a href="content-org_learning-paths.ts.html">content-org/learning-paths.ts</a>, <a href="content-org_learning-paths.ts.html#line22">line 22</a>
904
+ </li></ul></dd>
905
+
906
+
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+
935
+
936
+ </dl>
937
+
938
+
939
+
940
+
941
+
942
+
943
+
944
+
945
+
946
+
947
+
948
+
949
+
950
+ <h5 class="h5-parameters">Parameters:</h5>
951
+
952
+
953
+ <table class="params">
954
+ <thead>
955
+ <tr>
956
+
957
+ <th>Name</th>
958
+
959
+
960
+ <th>Type</th>
961
+
962
+
963
+
964
+
965
+
966
+ <th class="last">Description</th>
967
+ </tr>
968
+ </thead>
969
+
970
+ <tbody>
971
+
972
+
973
+ <tr>
974
+
975
+ <td class="name"><code>brand</code></td>
976
+
977
+
978
+ <td class="type">
979
+
980
+ </td>
981
+
982
+
983
+
984
+
985
+
986
+ <td class="description last"></td>
987
+ </tr>
988
+
989
+
990
+
991
+ <tr>
992
+
993
+ <td class="name"><code>userDate</code></td>
994
+
995
+
996
+ <td class="type">
997
+
998
+ </td>
999
+
1000
+
1001
+
1002
+
1003
+
1004
+ <td class="description last">format 2025-10-31</td>
1005
+ </tr>
1006
+
1007
+
1008
+
1009
+ <tr>
1010
+
1011
+ <td class="name"><code>keepFirstLearningPath</code></td>
1012
+
1013
+
1014
+ <td class="type">
1015
+
1016
+ </td>
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+ <td class="description last"></td>
1023
+ </tr>
1024
+
1025
+
1026
+ </tbody>
1027
+ </table>
1028
+
1029
+
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+
1042
+
1043
+
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+ </article>
1054
+
1055
+ </section>
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+ </div>
1063
+
1064
+ <br class="clear">
1065
+
1066
+ <footer>
1067
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Nov 06 2025 17:14:22 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1068
+ </footer>
1069
+
1070
+ <script>prettyPrint();</script>
1071
+ <script src="scripts/polyfill.js"></script>
1072
+ <script src="scripts/linenumber.js"></script>
1073
+
1074
+
1075
+
1076
+ </body>
1077
+ </html>