musora-content-services 1.6.7 → 1.6.9

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 (150) hide show
  1. package/.github/workflows/conventional-commits.yaml +0 -0
  2. package/.github/workflows/docs.js.yml +0 -0
  3. package/.github/workflows/sync-docs.yml +0 -0
  4. package/CHANGELOG.md +4 -0
  5. package/README.md +0 -0
  6. package/docs/algolia.js.html +0 -0
  7. package/docs/config.js.html +0 -0
  8. package/docs/index.html +0 -0
  9. package/docs/module-Config.html +0 -0
  10. package/docs/module-Railcontent-Services.html +0 -0
  11. package/docs/module-Sanity-Services.html +0 -0
  12. package/docs/module-Search-Engine-Services.html +0 -0
  13. package/docs/railcontent.js.html +0 -0
  14. package/docs/sanity.js.html +0 -0
  15. package/docs/v2/ContentOrganization.html +2 -2
  16. package/docs/v2/Forums.html +269 -0
  17. package/docs/v2/Gamification.html +2 -2
  18. package/docs/v2/TestUser.html +260 -0
  19. package/docs/v2/UserManagementSystem.html +2 -2
  20. package/docs/v2/api_types.js.html +2 -2
  21. package/docs/v2/config.js.html +2 -8
  22. package/docs/v2/content-org_content-org.js.html +2 -2
  23. package/docs/v2/content-org_guided-courses.ts.html +110 -0
  24. package/docs/v2/content-org_learning-paths.ts.html +123 -0
  25. package/docs/v2/content-org_playlists-types.js.html +14 -2
  26. package/docs/v2/content-org_playlists.js.html +39 -17
  27. package/docs/v2/content.js.html +111 -52
  28. package/docs/v2/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  29. package/docs/v2/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  30. package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  31. package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  32. package/docs/v2/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  33. package/docs/v2/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  34. package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  35. package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  36. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  37. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
  38. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  39. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  40. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  41. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  42. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  43. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  44. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  45. package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  46. package/docs/v2/forums_categories.ts.html +137 -0
  47. package/docs/v2/forums_discussions.js.html +95 -0
  48. package/docs/v2/forums_forum.js.html +95 -0
  49. package/docs/v2/forums_forums.ts.html +160 -0
  50. package/docs/v2/forums_posts.ts.html +258 -0
  51. package/docs/v2/forums_threads.ts.html +271 -0
  52. package/docs/v2/gamification_awards.js.html +35 -534
  53. package/docs/v2/gamification_awards.ts.html +181 -0
  54. package/docs/v2/gamification_gamification.js.html +2 -2
  55. package/docs/v2/gamification_types.js.html +7 -25
  56. package/docs/v2/global.html +849 -690
  57. package/docs/v2/index.html +2 -3
  58. package/docs/v2/liveTesting.ts.html +102 -0
  59. package/docs/v2/module-Accounts.html +2094 -0
  60. package/docs/v2/module-Awards.html +396 -14
  61. package/docs/v2/module-Categories.html +711 -0
  62. package/docs/v2/module-Config.html +4 -8
  63. package/docs/v2/module-Content-Services-V2.html +182 -49
  64. package/docs/v2/module-ForumCategories.html +687 -0
  65. package/docs/v2/module-ForumDiscussions.html +370 -0
  66. package/docs/v2/module-Forums.html +15393 -0
  67. package/docs/v2/module-GuidedCourses.html +1304 -0
  68. package/docs/v2/module-Interests.html +2 -2
  69. package/docs/v2/module-Onboarding.html +670 -0
  70. package/docs/v2/module-Payments.html +250 -0
  71. package/docs/v2/module-Permissions.html +2 -2
  72. package/docs/v2/module-Playlists.html +212 -44
  73. package/docs/v2/module-Railcontent-Services.html +689 -2175
  74. package/docs/v2/module-Sanity-Services.html +480 -925
  75. package/docs/v2/module-Sessions.html +3 -3
  76. package/docs/v2/module-Threads.html +1119 -0
  77. package/docs/v2/module-UserActivity.html +193 -23
  78. package/docs/v2/module-UserChat.html +410 -0
  79. package/docs/v2/module-UserManagement.html +1028 -11
  80. package/docs/v2/module-UserMemberships.html +829 -0
  81. package/docs/v2/module-UserNotifications.html +1399 -27
  82. package/docs/v2/module-UserProfile.html +106 -2
  83. package/docs/v2/railcontent.js.html +87 -236
  84. package/docs/v2/sanity.js.html +342 -415
  85. package/docs/v2/scripts/collapse.js +0 -0
  86. package/docs/v2/scripts/commonNav.js +0 -0
  87. package/docs/v2/scripts/linenumber.js +0 -0
  88. package/docs/v2/scripts/nav.js +0 -0
  89. package/docs/v2/scripts/polyfill.js +0 -0
  90. package/docs/v2/scripts/prettify/Apache-License-2.0.txt +0 -0
  91. package/docs/v2/scripts/prettify/lang-css.js +0 -0
  92. package/docs/v2/scripts/prettify/prettify.js +0 -0
  93. package/docs/v2/scripts/search.js +0 -0
  94. package/docs/v2/styles/jsdoc.css +0 -0
  95. package/docs/v2/styles/prettify.css +0 -0
  96. package/docs/v2/userActivity.js.html +532 -451
  97. package/docs/v2/user_account.ts.html +237 -0
  98. package/docs/v2/user_chat.js.html +98 -0
  99. package/docs/v2/user_interests.js.html +2 -2
  100. package/docs/v2/user_management.js.html +82 -2
  101. package/docs/v2/user_memberships.js.html +144 -0
  102. package/docs/v2/user_memberships.ts.html +292 -0
  103. package/docs/v2/user_notifications.js.html +203 -21
  104. package/docs/v2/user_onboarding.ts.html +183 -0
  105. package/docs/v2/user_payments.ts.html +97 -0
  106. package/docs/v2/user_permissions.js.html +2 -2
  107. package/docs/v2/user_profile.js.html +12 -2
  108. package/docs/v2/user_sessions.js.html +33 -2
  109. package/docs/v2/user_types.js.html +16 -2
  110. package/docs/v2/user_user-management-system.js.html +2 -2
  111. package/jsdoc.json +0 -0
  112. package/link_mcs.sh +0 -0
  113. package/package.json +1 -1
  114. package/src/contentMetaData.js +0 -0
  115. package/src/contentTypeConfig.js +3 -3
  116. package/src/filterBuilder.js +0 -0
  117. package/src/index.d.ts +0 -0
  118. package/src/index.js +0 -0
  119. package/src/services/algolia.js +0 -0
  120. package/src/services/config.js +0 -0
  121. package/src/services/contentLikes.js +0 -0
  122. package/src/services/contentProgress.js +0 -0
  123. package/src/services/dataContext.js +0 -0
  124. package/src/services/imageSRCBuilder.js +1 -1
  125. package/src/services/imageSRCVerify.js +1 -1
  126. package/src/services/lastUpdated.js +0 -0
  127. package/src/services/railcontent.js +0 -0
  128. package/src/services/recommendations.js +0 -0
  129. package/src/services/userPermissions.js +0 -0
  130. package/test/config.test.js +0 -0
  131. package/test/contentLikes.test.js +0 -0
  132. package/test/contentProgress.test.js +0 -0
  133. package/test/imageSRCBuilder.test.js +1 -1
  134. package/test/imageSRCVerify.test.js +4 -4
  135. package/test/initializeTests.js +0 -0
  136. package/test/lastUpdated.test.js +0 -0
  137. package/test/sanityQueryService.test.js +0 -0
  138. package/test/userPermissions.test.js +0 -0
  139. package/tools/generate-index.cjs +0 -0
  140. package/.yarnrc.yml +0 -1
  141. package/docs/v2/Content-Organization.html +0 -245
  142. package/docs/v2/UserManagement.html +0 -269
  143. package/docs/v2/global.html#User +0 -293
  144. package/docs/v2/module-Notifications.html +0 -1183
  145. package/docs/v2/module-Session-Management.html +0 -575
  146. package/docs/v2/module-User-Activity.html +0 -4410
  147. package/docs/v2/module-User-Management.html +0 -490
  148. package/docs/v2/module-User-Permissions.html +0 -406
  149. package/docs/v2/types.js.html +0 -122
  150. package/docs/v2/user_user-management.js.html +0 -78
@@ -29,7 +29,7 @@
29
29
  <nav >
30
30
 
31
31
 
32
- <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#.fetchAwardsForUser">fetchAwardsForUser</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#.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-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-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#~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#~togglePlaylistPrivate">togglePlaylistPrivate</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#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</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#.fetchCompletedChallenges">fetchCompletedChallenges</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#.fetchOwnedChallenges">fetchOwnedChallenges</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#.fetchUserChallengeProgress">fetchUserChallengeProgress</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#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSoloNotification">postChallengesSoloNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</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#.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#.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#.fetchParentForDownload">fetchParentForDownload</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#.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#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</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#.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#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</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-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#.fetchNotifications">fetchNotifications</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></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><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="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3><a href="global.html">Global</a></h3>
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><ul class='methods'><li data-type='method'><a href="module-GuidedCourses.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-GuidedCourses.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-GuidedCourses.html#~updateActivePath">updateActivePath</a></li><li data-type='method'><a href="module-GuidedCourses.html#~updateDailySession">updateDailySession</a></li></ul></li><li></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-Onboarding.html">Onboarding</a><ul class='methods'><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
33
 
34
34
  </nav>
35
35
 
@@ -100,7 +100,7 @@
100
100
 
101
101
  <dt class="tag-source">Source:</dt>
102
102
  <dd class="tag-source"><ul class="dummy"><li>
103
- <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line113">line 113</a>
103
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line115">line 115</a>
104
104
  </li></ul></dd>
105
105
 
106
106
 
@@ -279,6 +279,211 @@
279
279
 
280
280
 
281
281
 
282
+ <h4 class="name" id=".fetchLiveEventPollingState"><span class="type-signature type-signature-static">(static) </span>fetchLiveEventPollingState<span class="signature">()</span><span class="type-signature"></span></h4>
283
+
284
+
285
+
286
+
287
+
288
+
289
+ <dl class="details">
290
+
291
+ <dt class="tag-description">Description:</dt>
292
+ <dd class="tag-description"><ul class="dummy"><li>Fetches the current live event polling state.
293
+ + @returns {Promise<Object>} - Promise resolving to the polling state</li></ul></dd>
294
+
295
+
296
+
297
+ <dt class="tag-source">Source:</dt>
298
+ <dd class="tag-source"><ul class="dummy"><li>
299
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line294">line 294</a>
300
+ </li></ul></dd>
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+ </dl>
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+ <h4 class="name" id=".fetchNotificationSettings"><span class="type-signature type-signature-static">(static) </span>fetchNotificationSettings<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
369
+
370
+
371
+
372
+
373
+
374
+
375
+ <dl class="details">
376
+
377
+ <dt class="tag-description">Description:</dt>
378
+ <dd class="tag-description"><ul class="dummy"><li>Fetches the notification settings for the current user grouped by brand.</li></ul></dd>
379
+
380
+
381
+
382
+ <dt class="tag-source">Source:</dt>
383
+ <dd class="tag-source"><ul class="dummy"><li>
384
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line192">line 192</a>
385
+ </li></ul></dd>
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+ </dl>
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+ <h5 class="h5-examples">Example</h5>
430
+
431
+ <pre class="prettyprint"><code>fetchNotificationSetting()
432
+ .then(settings => {
433
+ console.log(settings);
434
+ })
435
+ .catch(error => {
436
+ console.error(error);
437
+ });</code></pre>
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+ <h5 class="h5-returns">Returns:</h5>
457
+
458
+
459
+ <div class="param-desc">
460
+ A promise that resolves to an object where keys are brands and values are arrays of settings objects.
461
+ </div>
462
+
463
+
464
+
465
+ <dl class="param-type">
466
+ <dt>
467
+ Type
468
+ </dt>
469
+ <dd>
470
+
471
+ <span class="param-type">Promise.&lt;Object></span>
472
+
473
+
474
+
475
+ </dd>
476
+ </dl>
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
282
487
  <h4 class="name" id=".fetchNotifications"><span class="type-signature type-signature-static">(static) </span>fetchNotifications<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;Object>>}</span></h4>
283
488
 
284
489
 
@@ -295,7 +500,7 @@
295
500
 
296
501
  <dt class="tag-source">Source:</dt>
297
502
  <dd class="tag-source"><ul class="dummy"><li>
298
- <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line26">line 26</a>
503
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line35">line 35</a>
299
504
  </li></ul></dd>
300
505
 
301
506
 
@@ -342,7 +547,7 @@
342
547
 
343
548
  <h5 class="h5-examples">Example</h5>
344
549
 
345
- <pre class="prettyprint"><code>fetchNotifications({ brand: 'drumeo', limit: 5, onlyUnread: true })
550
+ <pre class="prettyprint"><code>fetchNotifications({ limit: 5, onlyUnread: true, page: 2 })
346
551
  .then(notifications => console.log(notifications))
347
552
  .catch(error => console.error(error));</code></pre>
348
553
 
@@ -441,13 +646,13 @@
441
646
 
442
647
  <tr>
443
648
 
444
- <td class="name"><code>brand</code></td>
649
+ <td class="name"><code>limit</code></td>
445
650
 
446
651
 
447
652
  <td class="type">
448
653
 
449
654
 
450
- <span class="param-type">string</span>
655
+ <span class="param-type">number</span>
451
656
 
452
657
 
453
658
 
@@ -457,6 +662,8 @@
457
662
 
458
663
  <td class="attributes">
459
664
 
665
+ &lt;optional><br>
666
+
460
667
 
461
668
 
462
669
 
@@ -467,17 +674,19 @@
467
674
 
468
675
  <td class="default">
469
676
 
677
+ <code>10</code>
678
+
470
679
  </td>
471
680
 
472
681
 
473
- <td class="description last">The brand to filter notifications by. (Required)</td>
682
+ <td class="description last">The maximum number of notifications to fetch.</td>
474
683
  </tr>
475
684
 
476
685
 
477
686
 
478
687
  <tr>
479
688
 
480
- <td class="name"><code>limit</code></td>
689
+ <td class="name"><code>page</code></td>
481
690
 
482
691
 
483
692
  <td class="type">
@@ -505,12 +714,12 @@
505
714
 
506
715
  <td class="default">
507
716
 
508
- <code>10</code>
717
+ <code>1</code>
509
718
 
510
719
  </td>
511
720
 
512
721
 
513
- <td class="description last">The maximum number of notifications to fetch.</td>
722
+ <td class="description last">The page number for pagination.</td>
514
723
  </tr>
515
724
 
516
725
 
@@ -640,7 +849,7 @@
640
849
 
641
850
 
642
851
 
643
- <h4 class="name" id=".markAllNotificationsAsRead"><span class="type-signature type-signature-static">(static) </span>markAllNotificationsAsRead<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>
852
+ <h4 class="name" id=".fetchUnreadCount"><span class="type-signature type-signature-static">(static) </span>fetchUnreadCount<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
644
853
 
645
854
 
646
855
 
@@ -650,13 +859,17 @@
650
859
  <dl class="details">
651
860
 
652
861
  <dt class="tag-description">Description:</dt>
653
- <dd class="tag-description"><ul class="dummy"><li>Marks all notifications as read for a specific brand.</li></ul></dd>
862
+ <dd class="tag-description"><ul class="dummy"><li>Fetches the count of unread notifications for the current user in a given brand context.
863
+
864
+ This function first checks for standard unread notifications. If none are found,
865
+ it checks if live event polling is active. If so, it will query for any ongoing live events.
866
+ If a live event is active, it counts as an unread item.</li></ul></dd>
654
867
 
655
868
 
656
869
 
657
870
  <dt class="tag-source">Source:</dt>
658
871
  <dd class="tag-source"><ul class="dummy"><li>
659
- <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line71">line 71</a>
872
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line164">line 164</a>
660
873
  </li></ul></dd>
661
874
 
662
875
 
@@ -703,8 +916,8 @@
703
916
 
704
917
  <h5 class="h5-examples">Example</h5>
705
918
 
706
- <pre class="prettyprint"><code>markAllNotificationsAsRead('drumeo')
707
- .then(response => console.log(response))
919
+ <pre class="prettyprint"><code>fetchUnreadCount({ brand: 'drumeo' })
920
+ .then(data => console.log(data.data)) // 0 or 1
708
921
  .catch(error => console.error(error));</code></pre>
709
922
 
710
923
 
@@ -723,8 +936,12 @@
723
936
  <th>Type</th>
724
937
 
725
938
 
939
+ <th>Attributes</th>
940
+
726
941
 
727
942
 
943
+ <th>Default</th>
944
+
728
945
 
729
946
  <th class="last">Description</th>
730
947
  </tr>
@@ -735,13 +952,13 @@
735
952
 
736
953
  <tr>
737
954
 
738
- <td class="name"><code>brand</code></td>
955
+ <td class="name"><code>options</code></td>
739
956
 
740
957
 
741
958
  <td class="type">
742
959
 
743
960
 
744
- <span class="param-type">string</span>
961
+ <span class="param-type">Object</span>
745
962
 
746
963
 
747
964
 
@@ -749,36 +966,132 @@
749
966
  </td>
750
967
 
751
968
 
969
+ <td class="attributes">
970
+
971
+ &lt;optional><br>
972
+
973
+
974
+
752
975
 
976
+
977
+ </td>
753
978
 
754
979
 
755
- <td class="description last">The brand to filter notifications by.</td>
756
- </tr>
980
+
981
+ <td class="default">
982
+
983
+ <code>{}</code>
984
+
985
+ </td>
986
+
757
987
 
758
-
759
- </tbody>
760
- </table>
988
+ <td class="description last">Options for fetching unread count.
989
+ <h6>Properties</h6>
990
+
761
991
 
992
+ <table class="params">
993
+ <thead>
994
+ <tr>
995
+
996
+ <th>Name</th>
997
+
762
998
 
999
+ <th>Type</th>
763
1000
 
1001
+
764
1002
 
1003
+
765
1004
 
1005
+ <th class="last">Description</th>
1006
+ </tr>
1007
+ </thead>
766
1008
 
1009
+ <tbody>
1010
+
767
1011
 
1012
+ <tr>
1013
+
1014
+ <td class="name"><code>brand</code></td>
1015
+
768
1016
 
1017
+ <td class="type">
1018
+
1019
+
1020
+ <span class="param-type">string</span>
769
1021
 
770
1022
 
771
1023
 
1024
+
1025
+ </td>
772
1026
 
1027
+
1028
+
1029
+
1030
+
1031
+ <td class="description last">The brand to filter unread notifications by. Defaults to 'drumeo'.</td>
1032
+ </tr>
1033
+
1034
+
1035
+ </tbody>
1036
+ </table>
1037
+
1038
+ </td>
1039
+ </tr>
1040
+
1041
+
1042
+ </tbody>
1043
+ </table>
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+ <h5 class="h5-throws">Throws:</h5>
1059
+
1060
+
1061
+
1062
+ <dl>
1063
+ <dt>
1064
+ <div class="param-desc usertext">
1065
+ If the brand is not provided or if network requests fail.
1066
+ </div>
1067
+ </dt>
1068
+ <dd></dd>
1069
+ <dt>
1070
+ <dl class="param-type">
1071
+ <dt>
1072
+ Type
1073
+ </dt>
1074
+ <dd>
1075
+
1076
+ <span class="param-type">Error</span>
773
1077
 
774
1078
 
775
1079
 
1080
+ </dd>
1081
+ </dl>
1082
+ </dt>
1083
+ <dd></dd>
1084
+ </dl>
1085
+
1086
+
1087
+
1088
+
776
1089
 
777
1090
  <h5 class="h5-returns">Returns:</h5>
778
1091
 
779
1092
 
780
1093
  <div class="param-desc">
781
- - A promise that resolves when all notifications are marked as read.
1094
+ - A promise that resolves to an object with a `data` property indicating the unread count (0 or 1).
782
1095
  </div>
783
1096
 
784
1097
 
@@ -789,7 +1102,187 @@
789
1102
  </dt>
790
1103
  <dd>
791
1104
 
792
- <span class="param-type">Promise.&lt;any></span>
1105
+ <span class="param-type">Promise.&lt;Object></span>
1106
+
1107
+
1108
+
1109
+ </dd>
1110
+ </dl>
1111
+
1112
+
1113
+
1114
+
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+ <h4 class="name" id=".markAllNotificationsAsRead"><span class="type-signature type-signature-static">(static) </span>markAllNotificationsAsRead<span class="signature">(brand<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+
1128
+ <dl class="details">
1129
+
1130
+ <dt class="tag-description">Description:</dt>
1131
+ <dd class="tag-description"><ul class="dummy"><li>Marks all notifications as read for the current user.
1132
+
1133
+ This also pauses live event polling if there is an active event, to prevent immediate re-polling.</li></ul></dd>
1134
+
1135
+
1136
+
1137
+ <dt class="tag-source">Source:</dt>
1138
+ <dd class="tag-source"><ul class="dummy"><li>
1139
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line72">line 72</a>
1140
+ </li></ul></dd>
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+
1162
+
1163
+
1164
+
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+
1171
+
1172
+ </dl>
1173
+
1174
+
1175
+
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+
1186
+ <h5 class="h5-parameters">Parameters:</h5>
1187
+
1188
+
1189
+ <table class="params">
1190
+ <thead>
1191
+ <tr>
1192
+
1193
+ <th>Name</th>
1194
+
1195
+
1196
+ <th>Type</th>
1197
+
1198
+
1199
+ <th>Attributes</th>
1200
+
1201
+
1202
+
1203
+ <th>Default</th>
1204
+
1205
+
1206
+ <th class="last">Description</th>
1207
+ </tr>
1208
+ </thead>
1209
+
1210
+ <tbody>
1211
+
1212
+
1213
+ <tr>
1214
+
1215
+ <td class="name"><code>brand</code></td>
1216
+
1217
+
1218
+ <td class="type">
1219
+
1220
+
1221
+ <span class="param-type">string</span>
1222
+
1223
+
1224
+
1225
+
1226
+ </td>
1227
+
1228
+
1229
+ <td class="attributes">
1230
+
1231
+ &lt;optional><br>
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+ </td>
1238
+
1239
+
1240
+
1241
+ <td class="default">
1242
+
1243
+ <code>'drumeo'</code>
1244
+
1245
+ </td>
1246
+
1247
+
1248
+ <td class="description last">The brand context for live event handling before marking notifications.</td>
1249
+ </tr>
1250
+
1251
+
1252
+ </tbody>
1253
+ </table>
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+ <h5 class="h5-returns">Returns:</h5>
1271
+
1272
+
1273
+ <div class="param-desc">
1274
+ - A promise resolving to the API response from the notifications read endpoint.
1275
+ </div>
1276
+
1277
+
1278
+
1279
+ <dl class="param-type">
1280
+ <dt>
1281
+ Type
1282
+ </dt>
1283
+ <dd>
1284
+
1285
+ <span class="param-type">Promise.&lt;Object></span>
793
1286
 
794
1287
 
795
1288
 
@@ -821,7 +1314,7 @@
821
1314
 
822
1315
  <dt class="tag-source">Source:</dt>
823
1316
  <dd class="tag-source"><ul class="dummy"><li>
824
- <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line50">line 50</a>
1317
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line55">line 55</a>
825
1318
  </li></ul></dd>
826
1319
 
827
1320
 
@@ -1016,7 +1509,7 @@
1016
1509
 
1017
1510
  <dt class="tag-source">Source:</dt>
1018
1511
  <dd class="tag-source"><ul class="dummy"><li>
1019
- <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line90">line 90</a>
1512
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line92">line 92</a>
1020
1513
  </li></ul></dd>
1021
1514
 
1022
1515
 
@@ -1191,6 +1684,885 @@
1191
1684
 
1192
1685
 
1193
1686
 
1687
+
1688
+
1689
+
1690
+
1691
+ <h4 class="name" id=".pauseLiveEventPolling"><span class="type-signature type-signature-static">(static) </span>pauseLiveEventPolling<span class="signature">(brand<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
1692
+
1693
+
1694
+
1695
+
1696
+
1697
+
1698
+ <dl class="details">
1699
+
1700
+ <dt class="tag-description">Description:</dt>
1701
+ <dd class="tag-description"><ul class="dummy"><li>Pauses live event polling for the current user based on the live event end time.
1702
+
1703
+ If a live event is active, polling will be paused until its end time. If no live event is found,
1704
+ polling is not paused.</li></ul></dd>
1705
+
1706
+
1707
+
1708
+ <dt class="tag-source">Source:</dt>
1709
+ <dd class="tag-source"><ul class="dummy"><li>
1710
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line273">line 273</a>
1711
+ </li></ul></dd>
1712
+
1713
+
1714
+
1715
+
1716
+
1717
+
1718
+
1719
+
1720
+
1721
+
1722
+
1723
+
1724
+
1725
+
1726
+
1727
+
1728
+
1729
+
1730
+
1731
+
1732
+
1733
+
1734
+
1735
+
1736
+
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+
1743
+ </dl>
1744
+
1745
+
1746
+
1747
+
1748
+
1749
+
1750
+
1751
+
1752
+
1753
+
1754
+
1755
+
1756
+
1757
+ <h5 class="h5-parameters">Parameters:</h5>
1758
+
1759
+
1760
+ <table class="params">
1761
+ <thead>
1762
+ <tr>
1763
+
1764
+ <th>Name</th>
1765
+
1766
+
1767
+ <th>Type</th>
1768
+
1769
+
1770
+ <th>Attributes</th>
1771
+
1772
+
1773
+
1774
+ <th>Default</th>
1775
+
1776
+
1777
+ <th class="last">Description</th>
1778
+ </tr>
1779
+ </thead>
1780
+
1781
+ <tbody>
1782
+
1783
+
1784
+ <tr>
1785
+
1786
+ <td class="name"><code>brand</code></td>
1787
+
1788
+
1789
+ <td class="type">
1790
+
1791
+
1792
+ <span class="param-type">string</span>
1793
+
1794
+
1795
+
1796
+
1797
+ </td>
1798
+
1799
+
1800
+ <td class="attributes">
1801
+
1802
+ &lt;optional><br>
1803
+
1804
+
1805
+
1806
+
1807
+
1808
+ </td>
1809
+
1810
+
1811
+
1812
+ <td class="default">
1813
+
1814
+ <code>'drumeo'</code>
1815
+
1816
+ </td>
1817
+
1818
+
1819
+ <td class="description last">The brand context to fetch live event data for.</td>
1820
+ </tr>
1821
+
1822
+
1823
+ </tbody>
1824
+ </table>
1825
+
1826
+
1827
+
1828
+
1829
+
1830
+
1831
+
1832
+
1833
+
1834
+
1835
+
1836
+
1837
+
1838
+
1839
+
1840
+
1841
+ <h5 class="h5-returns">Returns:</h5>
1842
+
1843
+
1844
+ <div class="param-desc">
1845
+ - A promise resolving to the API response from the pause polling endpoint.
1846
+ </div>
1847
+
1848
+
1849
+
1850
+ <dl class="param-type">
1851
+ <dt>
1852
+ Type
1853
+ </dt>
1854
+ <dd>
1855
+
1856
+ <span class="param-type">Promise.&lt;Object></span>
1857
+
1858
+
1859
+
1860
+ </dd>
1861
+ </dl>
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+
1868
+
1869
+
1870
+
1871
+
1872
+ <h4 class="name" id=".restoreNotification"><span class="type-signature type-signature-static">(static) </span>restoreNotification<span class="signature">(notificationId)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>
1873
+
1874
+
1875
+
1876
+
1877
+
1878
+
1879
+ <dl class="details">
1880
+
1881
+ <dt class="tag-description">Description:</dt>
1882
+ <dd class="tag-description"><ul class="dummy"><li>Restores a specific notification.</li></ul></dd>
1883
+
1884
+
1885
+
1886
+ <dt class="tag-source">Source:</dt>
1887
+ <dd class="tag-source"><ul class="dummy"><li>
1888
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line137">line 137</a>
1889
+ </li></ul></dd>
1890
+
1891
+
1892
+
1893
+
1894
+
1895
+
1896
+
1897
+
1898
+
1899
+
1900
+
1901
+
1902
+
1903
+
1904
+
1905
+
1906
+
1907
+
1908
+
1909
+
1910
+
1911
+
1912
+
1913
+
1914
+
1915
+
1916
+
1917
+
1918
+
1919
+
1920
+
1921
+ </dl>
1922
+
1923
+
1924
+
1925
+
1926
+
1927
+
1928
+
1929
+
1930
+
1931
+
1932
+
1933
+ <h5 class="h5-examples">Example</h5>
1934
+
1935
+ <pre class="prettyprint"><code>restoreNotification(123)
1936
+ .then(response => console.log(response))
1937
+ .catch(error => console.error(error));</code></pre>
1938
+
1939
+
1940
+
1941
+
1942
+ <h5 class="h5-parameters">Parameters:</h5>
1943
+
1944
+
1945
+ <table class="params">
1946
+ <thead>
1947
+ <tr>
1948
+
1949
+ <th>Name</th>
1950
+
1951
+
1952
+ <th>Type</th>
1953
+
1954
+
1955
+
1956
+
1957
+
1958
+ <th class="last">Description</th>
1959
+ </tr>
1960
+ </thead>
1961
+
1962
+ <tbody>
1963
+
1964
+
1965
+ <tr>
1966
+
1967
+ <td class="name"><code>notificationId</code></td>
1968
+
1969
+
1970
+ <td class="type">
1971
+
1972
+
1973
+ <span class="param-type">number</span>
1974
+
1975
+
1976
+
1977
+
1978
+ </td>
1979
+
1980
+
1981
+
1982
+
1983
+
1984
+ <td class="description last">The ID of the notification to restore.</td>
1985
+ </tr>
1986
+
1987
+
1988
+ </tbody>
1989
+ </table>
1990
+
1991
+
1992
+
1993
+
1994
+
1995
+
1996
+
1997
+
1998
+
1999
+
2000
+
2001
+
2002
+
2003
+
2004
+ <h5 class="h5-throws">Throws:</h5>
2005
+
2006
+
2007
+
2008
+ <dl>
2009
+ <dt>
2010
+ <div class="param-desc usertext">
2011
+ - Throws an error if notificationId is not provided.
2012
+ </div>
2013
+ </dt>
2014
+ <dd></dd>
2015
+ <dt>
2016
+ <dl class="param-type">
2017
+ <dt>
2018
+ Type
2019
+ </dt>
2020
+ <dd>
2021
+
2022
+ <span class="param-type">Error</span>
2023
+
2024
+
2025
+
2026
+ </dd>
2027
+ </dl>
2028
+ </dt>
2029
+ <dd></dd>
2030
+ </dl>
2031
+
2032
+
2033
+
2034
+
2035
+
2036
+ <h5 class="h5-returns">Returns:</h5>
2037
+
2038
+
2039
+ <div class="param-desc">
2040
+ - A promise that resolves when the notification is successfully restored.
2041
+ </div>
2042
+
2043
+
2044
+
2045
+ <dl class="param-type">
2046
+ <dt>
2047
+ Type
2048
+ </dt>
2049
+ <dd>
2050
+
2051
+ <span class="param-type">Promise.&lt;any></span>
2052
+
2053
+
2054
+
2055
+ </dd>
2056
+ </dl>
2057
+
2058
+
2059
+
2060
+
2061
+
2062
+
2063
+
2064
+
2065
+
2066
+
2067
+ <h4 class="name" id=".startLiveEventPolling"><span class="type-signature type-signature-static">(static) </span>startLiveEventPolling<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2068
+
2069
+
2070
+
2071
+
2072
+
2073
+
2074
+ <dl class="details">
2075
+
2076
+ <dt class="tag-description">Description:</dt>
2077
+ <dd class="tag-description"><ul class="dummy"><li>Start live event polling.</li></ul></dd>
2078
+
2079
+
2080
+
2081
+ <dt class="tag-source">Source:</dt>
2082
+ <dd class="tag-source"><ul class="dummy"><li>
2083
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line284">line 284</a>
2084
+ </li></ul></dd>
2085
+
2086
+
2087
+
2088
+
2089
+
2090
+
2091
+
2092
+
2093
+
2094
+
2095
+
2096
+
2097
+
2098
+
2099
+
2100
+
2101
+
2102
+
2103
+
2104
+
2105
+
2106
+
2107
+
2108
+
2109
+
2110
+
2111
+
2112
+
2113
+
2114
+
2115
+
2116
+ </dl>
2117
+
2118
+
2119
+
2120
+
2121
+
2122
+
2123
+
2124
+
2125
+
2126
+
2127
+
2128
+
2129
+
2130
+
2131
+
2132
+
2133
+
2134
+
2135
+
2136
+
2137
+
2138
+
2139
+
2140
+
2141
+
2142
+
2143
+
2144
+ <h5 class="h5-returns">Returns:</h5>
2145
+
2146
+
2147
+ <div class="param-desc">
2148
+ - Promise resolving to the API response
2149
+ </div>
2150
+
2151
+
2152
+
2153
+ <dl class="param-type">
2154
+ <dt>
2155
+ Type
2156
+ </dt>
2157
+ <dd>
2158
+
2159
+ <span class="param-type">Promise.&lt;Object></span>
2160
+
2161
+
2162
+
2163
+ </dd>
2164
+ </dl>
2165
+
2166
+
2167
+
2168
+
2169
+
2170
+
2171
+
2172
+
2173
+
2174
+
2175
+ <h4 class="name" id=".updateNotificationSetting"><span class="type-signature type-signature-static">(static) </span>updateNotificationSetting<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2176
+
2177
+
2178
+
2179
+
2180
+
2181
+
2182
+ <dl class="details">
2183
+
2184
+ <dt class="tag-description">Description:</dt>
2185
+ <dd class="tag-description"><ul class="dummy"><li>Updates notification settings for specified channels within a given brand.</li></ul></dd>
2186
+
2187
+
2188
+
2189
+ <dt class="tag-source">Source:</dt>
2190
+ <dd class="tag-source"><ul class="dummy"><li>
2191
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line234">line 234</a>
2192
+ </li></ul></dd>
2193
+
2194
+
2195
+
2196
+
2197
+
2198
+
2199
+
2200
+
2201
+
2202
+
2203
+
2204
+
2205
+
2206
+
2207
+
2208
+
2209
+
2210
+
2211
+
2212
+
2213
+
2214
+
2215
+
2216
+
2217
+
2218
+
2219
+
2220
+
2221
+
2222
+
2223
+
2224
+ </dl>
2225
+
2226
+
2227
+
2228
+
2229
+
2230
+
2231
+
2232
+
2233
+
2234
+
2235
+
2236
+ <h5 class="h5-examples">Example</h5>
2237
+
2238
+ <pre class="prettyprint"><code>updateNotificationSetting({
2239
+ brand: 'drumeo',
2240
+ settingName: 'new_lesson',
2241
+ email: true,
2242
+ push: false,
2243
+ bell: true
2244
+ })
2245
+ .then(response => console.log(response))
2246
+ .catch(error => console.error(error));</code></pre>
2247
+
2248
+
2249
+
2250
+
2251
+ <h5 class="h5-parameters">Parameters:</h5>
2252
+
2253
+
2254
+ <table class="params">
2255
+ <thead>
2256
+ <tr>
2257
+
2258
+ <th>Name</th>
2259
+
2260
+
2261
+ <th>Type</th>
2262
+
2263
+
2264
+
2265
+
2266
+
2267
+ <th class="last">Description</th>
2268
+ </tr>
2269
+ </thead>
2270
+
2271
+ <tbody>
2272
+
2273
+
2274
+ <tr>
2275
+
2276
+ <td class="name"><code>options</code></td>
2277
+
2278
+
2279
+ <td class="type">
2280
+
2281
+
2282
+ <span class="param-type">Object</span>
2283
+
2284
+
2285
+
2286
+
2287
+ </td>
2288
+
2289
+
2290
+
2291
+
2292
+
2293
+ <td class="description last">Options to update notification settings.
2294
+ <h6>Properties</h6>
2295
+
2296
+
2297
+ <table class="params">
2298
+ <thead>
2299
+ <tr>
2300
+
2301
+ <th>Name</th>
2302
+
2303
+
2304
+ <th>Type</th>
2305
+
2306
+
2307
+ <th>Attributes</th>
2308
+
2309
+
2310
+
2311
+
2312
+ <th class="last">Description</th>
2313
+ </tr>
2314
+ </thead>
2315
+
2316
+ <tbody>
2317
+
2318
+
2319
+ <tr>
2320
+
2321
+ <td class="name"><code>brand</code></td>
2322
+
2323
+
2324
+ <td class="type">
2325
+
2326
+
2327
+ <span class="param-type">string</span>
2328
+
2329
+
2330
+
2331
+
2332
+ </td>
2333
+
2334
+
2335
+ <td class="attributes">
2336
+
2337
+
2338
+
2339
+
2340
+
2341
+ </td>
2342
+
2343
+
2344
+
2345
+
2346
+ <td class="description last">The brand context for the notification settings.</td>
2347
+ </tr>
2348
+
2349
+
2350
+
2351
+ <tr>
2352
+
2353
+ <td class="name"><code>settingName</code></td>
2354
+
2355
+
2356
+ <td class="type">
2357
+
2358
+
2359
+ <span class="param-type">string</span>
2360
+
2361
+
2362
+
2363
+
2364
+ </td>
2365
+
2366
+
2367
+ <td class="attributes">
2368
+
2369
+
2370
+
2371
+
2372
+
2373
+ </td>
2374
+
2375
+
2376
+
2377
+
2378
+ <td class="description last">The name of the notification setting to update (required).</td>
2379
+ </tr>
2380
+
2381
+
2382
+
2383
+ <tr>
2384
+
2385
+ <td class="name"><code>email</code></td>
2386
+
2387
+
2388
+ <td class="type">
2389
+
2390
+
2391
+ <span class="param-type">boolean</span>
2392
+
2393
+
2394
+
2395
+
2396
+ </td>
2397
+
2398
+
2399
+ <td class="attributes">
2400
+
2401
+ &lt;optional><br>
2402
+
2403
+
2404
+
2405
+
2406
+
2407
+ </td>
2408
+
2409
+
2410
+
2411
+
2412
+ <td class="description last">Whether email notifications are enabled or disabled.</td>
2413
+ </tr>
2414
+
2415
+
2416
+
2417
+ <tr>
2418
+
2419
+ <td class="name"><code>push</code></td>
2420
+
2421
+
2422
+ <td class="type">
2423
+
2424
+
2425
+ <span class="param-type">boolean</span>
2426
+
2427
+
2428
+
2429
+
2430
+ </td>
2431
+
2432
+
2433
+ <td class="attributes">
2434
+
2435
+ &lt;optional><br>
2436
+
2437
+
2438
+
2439
+
2440
+
2441
+ </td>
2442
+
2443
+
2444
+
2445
+
2446
+ <td class="description last">Whether push notifications are enabled or disabled.</td>
2447
+ </tr>
2448
+
2449
+
2450
+
2451
+ <tr>
2452
+
2453
+ <td class="name"><code>bell</code></td>
2454
+
2455
+
2456
+ <td class="type">
2457
+
2458
+
2459
+ <span class="param-type">boolean</span>
2460
+
2461
+
2462
+
2463
+
2464
+ </td>
2465
+
2466
+
2467
+ <td class="attributes">
2468
+
2469
+ &lt;optional><br>
2470
+
2471
+
2472
+
2473
+
2474
+
2475
+ </td>
2476
+
2477
+
2478
+
2479
+
2480
+ <td class="description last">Whether bell notifications are enabled or disabled.</td>
2481
+ </tr>
2482
+
2483
+
2484
+ </tbody>
2485
+ </table>
2486
+
2487
+ </td>
2488
+ </tr>
2489
+
2490
+
2491
+ </tbody>
2492
+ </table>
2493
+
2494
+
2495
+
2496
+
2497
+
2498
+
2499
+
2500
+
2501
+
2502
+
2503
+
2504
+
2505
+
2506
+
2507
+ <h5 class="h5-throws">Throws:</h5>
2508
+
2509
+
2510
+
2511
+ <dl>
2512
+ <dt>
2513
+ <div class="param-desc usertext">
2514
+ Throws an error if `settingName` is not provided or if no channels are specified.
2515
+ </div>
2516
+ </dt>
2517
+ <dd></dd>
2518
+ <dt>
2519
+ <dl class="param-type">
2520
+ <dt>
2521
+ Type
2522
+ </dt>
2523
+ <dd>
2524
+
2525
+ <span class="param-type">Error</span>
2526
+
2527
+
2528
+
2529
+ </dd>
2530
+ </dl>
2531
+ </dt>
2532
+ <dd></dd>
2533
+ </dl>
2534
+
2535
+
2536
+
2537
+
2538
+
2539
+ <h5 class="h5-returns">Returns:</h5>
2540
+
2541
+
2542
+ <div class="param-desc">
2543
+ - A promise that resolves to the server response after updating settings.
2544
+ </div>
2545
+
2546
+
2547
+
2548
+ <dl class="param-type">
2549
+ <dt>
2550
+ Type
2551
+ </dt>
2552
+ <dd>
2553
+
2554
+ <span class="param-type">Promise.&lt;Object></span>
2555
+
2556
+
2557
+
2558
+ </dd>
2559
+ </dl>
2560
+
2561
+
2562
+
2563
+
2564
+
2565
+
1194
2566
 
1195
2567
 
1196
2568
 
@@ -1210,7 +2582,7 @@
1210
2582
  <br class="clear">
1211
2583
 
1212
2584
  <footer>
1213
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Jun 16 2025 14:26:22 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2585
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Nov 04 2025 18:21:55 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1214
2586
  </footer>
1215
2587
 
1216
2588
  <script>prettyPrint();</script>