musora-content-services 1.6.8 → 1.7.0

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 (71) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/docs/v2/ContentOrganization.html +2 -2
  3. package/docs/v2/Forums.html +3 -3
  4. package/docs/v2/Gamification.html +2 -2
  5. package/docs/v2/TestUser.html +260 -0
  6. package/docs/v2/UserManagementSystem.html +2 -2
  7. package/docs/v2/api_types.js.html +2 -2
  8. package/docs/v2/config.js.html +2 -2
  9. package/docs/v2/content-org_content-org.js.html +2 -2
  10. package/docs/v2/content-org_guided-courses.ts.html +2 -2
  11. package/docs/v2/content-org_learning-paths.ts.html +256 -0
  12. package/docs/v2/content-org_playlists-types.js.html +2 -2
  13. package/docs/v2/content-org_playlists.js.html +2 -2
  14. package/docs/v2/content.js.html +57 -54
  15. package/docs/v2/forums_categories.ts.html +2 -2
  16. package/docs/v2/forums_forums.ts.html +86 -3
  17. package/docs/v2/forums_posts.ts.html +120 -13
  18. package/docs/v2/forums_threads.ts.html +2 -2
  19. package/docs/v2/gamification_awards.ts.html +2 -2
  20. package/docs/v2/gamification_gamification.js.html +2 -2
  21. package/docs/v2/global.html +357 -2
  22. package/docs/v2/index.html +2 -2
  23. package/docs/v2/liveTesting.ts.html +103 -0
  24. package/docs/v2/module-Accounts.html +648 -25
  25. package/docs/v2/module-Awards.html +2 -2
  26. package/docs/v2/module-Config.html +2 -2
  27. package/docs/v2/module-Content-Services-V2.html +37 -318
  28. package/docs/v2/module-Forums.html +4161 -729
  29. package/docs/v2/module-GuidedCourses.html +2 -2
  30. package/docs/v2/module-Interests.html +2 -2
  31. package/docs/v2/module-LearningPaths.html +1330 -0
  32. package/docs/v2/module-Onboarding.html +858 -0
  33. package/docs/v2/module-Payments.html +148 -6
  34. package/docs/v2/module-Permissions.html +2 -2
  35. package/docs/v2/module-Playlists.html +2 -2
  36. package/docs/v2/module-ProgressRow.html +108 -0
  37. package/docs/v2/module-Railcontent-Services.html +6 -6
  38. package/docs/v2/module-Sanity-Services.html +339 -43
  39. package/docs/v2/module-Sessions.html +2 -2
  40. package/docs/v2/module-UserActivity.html +22 -22
  41. package/docs/v2/module-UserChat.html +2 -2
  42. package/docs/v2/module-UserManagement.html +448 -4
  43. package/docs/v2/module-UserMemberships.html +284 -11
  44. package/docs/v2/module-UserNotifications.html +2 -2
  45. package/docs/v2/module-UserProfile.html +2 -2
  46. package/docs/v2/progress-row_method-card.js.html +185 -0
  47. package/docs/v2/railcontent.js.html +2 -21
  48. package/docs/v2/sanity.js.html +135 -47
  49. package/docs/v2/userActivity.js.html +120 -64
  50. package/docs/v2/user_account.ts.html +84 -37
  51. package/docs/v2/user_chat.js.html +2 -2
  52. package/docs/v2/user_interests.js.html +2 -2
  53. package/docs/v2/user_management.js.html +42 -5
  54. package/docs/v2/user_memberships.js.html +2 -2
  55. package/docs/v2/user_memberships.ts.html +292 -0
  56. package/docs/v2/user_notifications.js.html +2 -2
  57. package/docs/v2/user_onboarding.ts.html +234 -0
  58. package/docs/v2/user_payments.ts.html +55 -6
  59. package/docs/v2/user_permissions.js.html +2 -2
  60. package/docs/v2/user_profile.js.html +2 -2
  61. package/docs/v2/user_sessions.js.html +2 -2
  62. package/docs/v2/user_types.js.html +8 -2
  63. package/docs/v2/user_user-management-system.js.html +2 -2
  64. package/package.json +1 -1
  65. package/src/contentTypeConfig.js +2 -0
  66. package/src/filterBuilder.js +3 -1
  67. package/src/services/imageSRCBuilder.js +1 -1
  68. package/src/services/imageSRCVerify.js +1 -1
  69. package/src/services/sanity.js +12 -3
  70. package/test/imageSRCBuilder.test.js +1 -1
  71. package/test/imageSRCVerify.test.js +4 -4
package/docs/v2/module-Onboarding.html ADDED
@@ -0,0 +1,858 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>Onboarding - 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#~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#~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-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#.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">Onboarding</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="~getOnboardingRecommendedContent"><span class="type-signature type-signature-async, inner">(async, inner) </span>getOnboardingRecommendedContent<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;OnboardingRecommendedContent>}</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 recommended content for onboarding based on the specified brand.</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="user_onboarding.ts.html">user/onboarding.ts</a>, <a href="user_onboarding.ts.html#line134">line 134</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>brand</code></td>
176
+
177
+
178
+ <td class="type">
179
+
180
+
181
+ <span class="param-type">string</span>
182
+
183
+
184
+
185
+
186
+ </td>
187
+
188
+
189
+
190
+
191
+
192
+ <td class="description last">The brand identifier.</td>
193
+ </tr>
194
+
195
+
196
+ </tbody>
197
+ </table>
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <h5 class="h5-throws">Throws:</h5>
213
+
214
+
215
+
216
+ <dl>
217
+ <dt>
218
+ <div class="param-desc usertext">
219
+ - If the HTTP request fails.
220
+ </div>
221
+ </dt>
222
+ <dd></dd>
223
+ <dt>
224
+ <dl class="param-type">
225
+ <dt>
226
+ Type
227
+ </dt>
228
+ <dd>
229
+
230
+ <span class="param-type">HttpError</span>
231
+
232
+
233
+
234
+ </dd>
235
+ </dl>
236
+ </dt>
237
+ <dd></dd>
238
+ </dl>
239
+
240
+
241
+
242
+
243
+
244
+ <h5 class="h5-returns">Returns:</h5>
245
+
246
+
247
+ <div class="param-desc">
248
+ - A promise that resolves with the recommended content.
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;OnboardingRecommendedContent></span>
260
+
261
+
262
+
263
+ </dd>
264
+ </dl>
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+ <h4 class="name" id="~startOnboarding"><span class="type-signature type-signature-async, inner">(async, inner) </span>startOnboarding<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;Onboarding>}</span></h4>
276
+
277
+
278
+
279
+
280
+
281
+
282
+ <dl class="details">
283
+
284
+
285
+
286
+ <dt class="tag-source">Source:</dt>
287
+ <dd class="tag-source"><ul class="dummy"><li>
288
+ <a href="user_onboarding.ts.html">user/onboarding.ts</a>, <a href="user_onboarding.ts.html#line44">line 44</a>
289
+ </li></ul></dd>
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+ </dl>
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+ <h5 class="h5-parameters">Parameters:</h5>
336
+
337
+
338
+ <table class="params">
339
+ <thead>
340
+ <tr>
341
+
342
+ <th>Name</th>
343
+
344
+
345
+ <th>Type</th>
346
+
347
+
348
+
349
+
350
+
351
+ <th class="last">Description</th>
352
+ </tr>
353
+ </thead>
354
+
355
+ <tbody>
356
+
357
+
358
+ <tr>
359
+
360
+ <td class="name"><code>params</code></td>
361
+
362
+
363
+ <td class="type">
364
+
365
+
366
+ <span class="param-type">StartOnboardingParams</span>
367
+
368
+
369
+
370
+
371
+ </td>
372
+
373
+
374
+
375
+
376
+
377
+ <td class="description last">The parameters for starting the onboarding process.</td>
378
+ </tr>
379
+
380
+
381
+ </tbody>
382
+ </table>
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+ <h5 class="h5-throws">Throws:</h5>
398
+
399
+
400
+
401
+ <dl>
402
+ <dt>
403
+ <div class="param-desc usertext">
404
+ - If the HTTP request fails.
405
+ </div>
406
+ </dt>
407
+ <dd></dd>
408
+ <dt>
409
+ <dl class="param-type">
410
+ <dt>
411
+ Type
412
+ </dt>
413
+ <dd>
414
+
415
+ <span class="param-type">HttpError</span>
416
+
417
+
418
+
419
+ </dd>
420
+ </dl>
421
+ </dt>
422
+ <dd></dd>
423
+ </dl>
424
+
425
+
426
+
427
+
428
+
429
+ <h5 class="h5-returns">Returns:</h5>
430
+
431
+
432
+ <div class="param-desc">
433
+ - A promise that resolves when the onboarding process is started.
434
+ </div>
435
+
436
+
437
+
438
+ <dl class="param-type">
439
+ <dt>
440
+ Type
441
+ </dt>
442
+ <dd>
443
+
444
+ <span class="param-type">Promise.&lt;Onboarding></span>
445
+
446
+
447
+
448
+ </dd>
449
+ </dl>
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+ <h4 class="name" id="~updateOnboarding"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateOnboarding<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;Onboarding>}</span></h4>
461
+
462
+
463
+
464
+
465
+
466
+
467
+ <dl class="details">
468
+
469
+
470
+
471
+ <dt class="tag-source">Source:</dt>
472
+ <dd class="tag-source"><ul class="dummy"><li>
473
+ <a href="user_onboarding.ts.html">user/onboarding.ts</a>, <a href="user_onboarding.ts.html#line78">line 78</a>
474
+ </li></ul></dd>
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+ </dl>
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+ <h5 class="h5-parameters">Parameters:</h5>
521
+
522
+
523
+ <table class="params">
524
+ <thead>
525
+ <tr>
526
+
527
+ <th>Name</th>
528
+
529
+
530
+ <th>Type</th>
531
+
532
+
533
+
534
+
535
+
536
+ <th class="last">Description</th>
537
+ </tr>
538
+ </thead>
539
+
540
+ <tbody>
541
+
542
+
543
+ <tr>
544
+
545
+ <td class="name"><code>params</code></td>
546
+
547
+
548
+ <td class="type">
549
+
550
+
551
+ <span class="param-type">UpdateOnboardingParams</span>
552
+
553
+
554
+
555
+
556
+ </td>
557
+
558
+
559
+
560
+
561
+
562
+ <td class="description last">The parameters for updating the onboarding process.</td>
563
+ </tr>
564
+
565
+
566
+ </tbody>
567
+ </table>
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+
580
+
581
+
582
+ <h5 class="h5-throws">Throws:</h5>
583
+
584
+
585
+
586
+ <dl>
587
+ <dt>
588
+ <div class="param-desc usertext">
589
+ - If the HTTP request fails.
590
+ </div>
591
+ </dt>
592
+ <dd></dd>
593
+ <dt>
594
+ <dl class="param-type">
595
+ <dt>
596
+ Type
597
+ </dt>
598
+ <dd>
599
+
600
+ <span class="param-type">HttpError</span>
601
+
602
+
603
+
604
+ </dd>
605
+ </dl>
606
+ </dt>
607
+ <dd></dd>
608
+ </dl>
609
+
610
+
611
+
612
+
613
+
614
+ <h5 class="h5-returns">Returns:</h5>
615
+
616
+
617
+ <div class="param-desc">
618
+ - A promise that resolves when the onboarding process is updated.
619
+ </div>
620
+
621
+
622
+
623
+ <dl class="param-type">
624
+ <dt>
625
+ Type
626
+ </dt>
627
+ <dd>
628
+
629
+ <span class="param-type">Promise.&lt;Onboarding></span>
630
+
631
+
632
+
633
+ </dd>
634
+ </dl>
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+ <h4 class="name" id="~userOnboardingForBrand"><span class="type-signature type-signature-async, inner">(async, inner) </span>userOnboardingForBrand<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;Onboarding>}</span></h4>
646
+
647
+
648
+
649
+
650
+
651
+
652
+ <dl class="details">
653
+
654
+ <dt class="tag-description">Description:</dt>
655
+ <dd class="tag-description"><ul class="dummy"><li>Fetches the onboardings for the current user and specified brand.</li></ul></dd>
656
+
657
+
658
+
659
+ <dt class="tag-source">Source:</dt>
660
+ <dd class="tag-source"><ul class="dummy"><li>
661
+ <a href="user_onboarding.ts.html">user/onboarding.ts</a>, <a href="user_onboarding.ts.html#line104">line 104</a>
662
+ </li></ul></dd>
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+ </dl>
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+ <h5 class="h5-parameters">Parameters:</h5>
709
+
710
+
711
+ <table class="params">
712
+ <thead>
713
+ <tr>
714
+
715
+ <th>Name</th>
716
+
717
+
718
+ <th>Type</th>
719
+
720
+
721
+
722
+
723
+
724
+ <th class="last">Description</th>
725
+ </tr>
726
+ </thead>
727
+
728
+ <tbody>
729
+
730
+
731
+ <tr>
732
+
733
+ <td class="name"><code>brand</code></td>
734
+
735
+
736
+ <td class="type">
737
+
738
+
739
+ <span class="param-type">string</span>
740
+
741
+
742
+
743
+
744
+ </td>
745
+
746
+
747
+
748
+
749
+
750
+ <td class="description last">The brand identifier.</td>
751
+ </tr>
752
+
753
+
754
+ </tbody>
755
+ </table>
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+ <h5 class="h5-throws">Throws:</h5>
771
+
772
+
773
+
774
+ <dl>
775
+ <dt>
776
+ <div class="param-desc usertext">
777
+ - If the HTTP request fails.
778
+ </div>
779
+ </dt>
780
+ <dd></dd>
781
+ <dt>
782
+ <dl class="param-type">
783
+ <dt>
784
+ Type
785
+ </dt>
786
+ <dd>
787
+
788
+ <span class="param-type">HttpError</span>
789
+
790
+
791
+
792
+ </dd>
793
+ </dl>
794
+ </dt>
795
+ <dd></dd>
796
+ </dl>
797
+
798
+
799
+
800
+
801
+
802
+ <h5 class="h5-returns">Returns:</h5>
803
+
804
+
805
+ <div class="param-desc">
806
+ - A promise that resolves with the onboarding data.
807
+ </div>
808
+
809
+
810
+
811
+ <dl class="param-type">
812
+ <dt>
813
+ Type
814
+ </dt>
815
+ <dd>
816
+
817
+ <span class="param-type">Promise.&lt;Onboarding></span>
818
+
819
+
820
+
821
+ </dd>
822
+ </dl>
823
+
824
+
825
+
826
+
827
+
828
+
829
+
830
+
831
+
832
+
833
+
834
+ </article>
835
+
836
+ </section>
837
+
838
+
839
+
840
+
841
+
842
+
843
+ </div>
844
+
845
+ <br class="clear">
846
+
847
+ <footer>
848
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Nov 10 2025 16:22:45 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
849
+ </footer>
850
+
851
+ <script>prettyPrint();</script>
852
+ <script src="scripts/polyfill.js"></script>
853
+ <script src="scripts/linenumber.js"></script>
854
+
855
+
856
+
857
+ </body>
858
+ </html>