musora-content-services 2.13.0 → 2.15.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 (92) hide show
  1. package/.github/workflows/node.js.yml +0 -0
  2. package/.prettierignore +0 -0
  3. package/.prettierrc +0 -0
  4. package/.yarnrc.yml +1 -0
  5. package/CHANGELOG.md +17 -0
  6. package/babel.config.cjs +0 -0
  7. package/docs/ContentOrganization.html +2 -2
  8. package/docs/Gamification.html +2 -2
  9. package/docs/UserManagementSystem.html +2 -2
  10. package/docs/api_types.js.html +2 -2
  11. package/docs/config.js.html +2 -2
  12. package/docs/content-org_content-org.js.html +2 -2
  13. package/docs/content-org_playlists-types.js.html +4 -2
  14. package/docs/content-org_playlists.js.html +25 -3
  15. package/docs/content.js.html +3 -3
  16. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  17. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  18. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  19. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  20. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  21. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  22. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  23. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  24. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  25. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
  26. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  27. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  28. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  29. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  30. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  31. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  32. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  33. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  34. package/docs/gamification_awards.js.html +2 -2
  35. package/docs/gamification_gamification.js.html +2 -2
  36. package/docs/gamification_types.js.html +2 -2
  37. package/docs/global.html +51 -3
  38. package/docs/index.html +2 -3
  39. package/docs/module-Awards.html +2 -2
  40. package/docs/module-Config.html +2 -2
  41. package/docs/module-Content-Services-V2.html +2 -2
  42. package/docs/module-Interests.html +2 -2
  43. package/docs/module-Permissions.html +2 -2
  44. package/docs/module-Playlists.html +198 -31
  45. package/docs/module-Railcontent-Services.html +168 -17
  46. package/docs/module-Sanity-Services.html +25 -21
  47. package/docs/module-Sessions.html +2 -2
  48. package/docs/module-UserActivity.html +15 -15
  49. package/docs/module-UserChat.html +410 -0
  50. package/docs/module-UserManagement.html +2 -2
  51. package/docs/module-UserNotifications.html +838 -19
  52. package/docs/module-UserProfile.html +2 -2
  53. package/docs/railcontent.js.html +15 -3
  54. package/docs/sanity.js.html +93 -33
  55. package/docs/scripts/collapse.js +0 -0
  56. package/docs/scripts/commonNav.js +0 -0
  57. package/docs/scripts/linenumber.js +0 -0
  58. package/docs/scripts/nav.js +0 -0
  59. package/docs/scripts/polyfill.js +0 -0
  60. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -0
  61. package/docs/scripts/prettify/lang-css.js +0 -0
  62. package/docs/scripts/prettify/prettify.js +0 -0
  63. package/docs/scripts/search.js +0 -0
  64. package/docs/styles/jsdoc.css +0 -0
  65. package/docs/styles/prettify.css +0 -0
  66. package/docs/userActivity.js.html +27 -17
  67. package/docs/user_chat.js.html +98 -0
  68. package/docs/user_interests.js.html +2 -2
  69. package/docs/user_management.js.html +2 -2
  70. package/docs/user_notifications.js.html +125 -5
  71. package/docs/user_permissions.js.html +2 -2
  72. package/docs/user_profile.js.html +2 -2
  73. package/docs/user_sessions.js.html +2 -2
  74. package/docs/user_types.js.html +2 -2
  75. package/docs/user_user-management-system.js.html +2 -2
  76. package/jest.config.js +0 -0
  77. package/link_mcs.sh +0 -0
  78. package/package.json +1 -1
  79. package/src/index.d.ts +14 -1
  80. package/src/index.js +14 -1
  81. package/src/services/content-org/guided-courses.ts +26 -0
  82. package/src/services/contentProgress.js +2 -2
  83. package/src/services/sanity.js +1 -1
  84. package/src/services/user/notifications.js +97 -0
  85. package/test/dataContext.test.js +0 -0
  86. package/test/imageSRCBuilder.test.js +0 -0
  87. package/test/imageSRCVerify.test.js +0 -0
  88. package/test/live/contentProgressLive.test.js +0 -0
  89. package/test/live/railcontentLive.test.js +0 -0
  90. package/test/localStorageMock.js +0 -0
  91. package/test/log.js +0 -0
  92. package/test/notifications.test.js +178 -0
@@ -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-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#~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#.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#.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#.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#.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#.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#.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>
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#line120">line 120</a>
104
104
  </li></ul></dd>
105
105
 
106
106
 
@@ -279,6 +279,125 @@
279
279
 
280
280
 
281
281
 
282
+ <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>
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 notification settings for the current user grouped by brand.</li></ul></dd>
293
+
294
+
295
+
296
+ <dt class="tag-source">Source:</dt>
297
+ <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#line165">line 165</a>
299
+ </li></ul></dd>
300
+
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
+ </dl>
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+ <h5 class="h5-examples">Example</h5>
344
+
345
+ <pre class="prettyprint"><code>fetchNotificationSetting()
346
+ .then(settings => {
347
+ console.log(settings);
348
+ })
349
+ .catch(error => {
350
+ console.error(error);
351
+ });</code></pre>
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+ <h5 class="h5-returns">Returns:</h5>
371
+
372
+
373
+ <div class="param-desc">
374
+ A promise that resolves to an object where keys are brands and values are arrays of settings objects.
375
+ </div>
376
+
377
+
378
+
379
+ <dl class="param-type">
380
+ <dt>
381
+ Type
382
+ </dt>
383
+ <dd>
384
+
385
+ <span class="param-type">Promise.&lt;Object></span>
386
+
387
+
388
+
389
+ </dd>
390
+ </dl>
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
282
401
  <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
402
 
284
403
 
@@ -295,7 +414,7 @@
295
414
 
296
415
  <dt class="tag-source">Source:</dt>
297
416
  <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>
417
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line33">line 33</a>
299
418
  </li></ul></dd>
300
419
 
301
420
 
@@ -342,7 +461,7 @@
342
461
 
343
462
  <h5 class="h5-examples">Example</h5>
344
463
 
345
- <pre class="prettyprint"><code>fetchNotifications({ brand: 'drumeo', limit: 5, onlyUnread: true })
464
+ <pre class="prettyprint"><code>fetchNotifications({ brand: 'drumeo', limit: 5, onlyUnread: true, page: 2 })
346
465
  .then(notifications => console.log(notifications))
347
466
  .catch(error => console.error(error));</code></pre>
348
467
 
@@ -515,6 +634,46 @@
515
634
 
516
635
 
517
636
 
637
+ <tr>
638
+
639
+ <td class="name"><code>page</code></td>
640
+
641
+
642
+ <td class="type">
643
+
644
+
645
+ <span class="param-type">number</span>
646
+
647
+
648
+
649
+
650
+ </td>
651
+
652
+
653
+ <td class="attributes">
654
+
655
+ &lt;optional><br>
656
+
657
+
658
+
659
+
660
+
661
+ </td>
662
+
663
+
664
+
665
+ <td class="default">
666
+
667
+ <code>1</code>
668
+
669
+ </td>
670
+
671
+
672
+ <td class="description last">The page number for pagination.</td>
673
+ </tr>
674
+
675
+
676
+
518
677
  <tr>
519
678
 
520
679
  <td class="name"><code>onlyUnread</code></td>
@@ -640,7 +799,7 @@
640
799
 
641
800
 
642
801
 
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>
802
+ <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
803
 
645
804
 
646
805
 
@@ -650,13 +809,13 @@
650
809
  <dl class="details">
651
810
 
652
811
  <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>
812
+ <dd class="tag-description"><ul class="dummy"><li>Fetches the count of unread notifications for the current user in a given brand context.</li></ul></dd>
654
813
 
655
814
 
656
815
 
657
816
  <dt class="tag-source">Source:</dt>
658
817
  <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>
818
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line143">line 143</a>
660
819
  </li></ul></dd>
661
820
 
662
821
 
@@ -703,8 +862,8 @@
703
862
 
704
863
  <h5 class="h5-examples">Example</h5>
705
864
 
706
- <pre class="prettyprint"><code>markAllNotificationsAsRead('drumeo')
707
- .then(response => console.log(response))
865
+ <pre class="prettyprint"><code>fetchUnreadCount({ brand: 'drumeo' })
866
+ .then(data => console.log(data.unread_count))
708
867
  .catch(error => console.error(error));</code></pre>
709
868
 
710
869
 
@@ -723,6 +882,69 @@
723
882
  <th>Type</th>
724
883
 
725
884
 
885
+ <th>Attributes</th>
886
+
887
+
888
+
889
+ <th>Default</th>
890
+
891
+
892
+ <th class="last">Description</th>
893
+ </tr>
894
+ </thead>
895
+
896
+ <tbody>
897
+
898
+
899
+ <tr>
900
+
901
+ <td class="name"><code>options</code></td>
902
+
903
+
904
+ <td class="type">
905
+
906
+
907
+ <span class="param-type">Object</span>
908
+
909
+
910
+
911
+
912
+ </td>
913
+
914
+
915
+ <td class="attributes">
916
+
917
+ &lt;optional><br>
918
+
919
+
920
+
921
+
922
+
923
+ </td>
924
+
925
+
926
+
927
+ <td class="default">
928
+
929
+ <code>{}</code>
930
+
931
+ </td>
932
+
933
+
934
+ <td class="description last">Options for fetching unread count.
935
+ <h6>Properties</h6>
936
+
937
+
938
+ <table class="params">
939
+ <thead>
940
+ <tr>
941
+
942
+ <th>Name</th>
943
+
944
+
945
+ <th>Type</th>
946
+
947
+
726
948
 
727
949
 
728
950
 
@@ -752,7 +974,14 @@
752
974
 
753
975
 
754
976
 
755
- <td class="description last">The brand to filter notifications by.</td>
977
+ <td class="description last">The brand to filter unread notifications by (required).</td>
978
+ </tr>
979
+
980
+
981
+ </tbody>
982
+ </table>
983
+
984
+ </td>
756
985
  </tr>
757
986
 
758
987
 
@@ -772,13 +1001,43 @@
772
1001
 
773
1002
 
774
1003
 
1004
+ <h5 class="h5-throws">Throws:</h5>
1005
+
1006
+
1007
+
1008
+ <dl>
1009
+ <dt>
1010
+ <div class="param-desc usertext">
1011
+ If the brand is not provided.
1012
+ </div>
1013
+ </dt>
1014
+ <dd></dd>
1015
+ <dt>
1016
+ <dl class="param-type">
1017
+ <dt>
1018
+ Type
1019
+ </dt>
1020
+ <dd>
1021
+
1022
+ <span class="param-type">Error</span>
1023
+
1024
+
1025
+
1026
+ </dd>
1027
+ </dl>
1028
+ </dt>
1029
+ <dd></dd>
1030
+ </dl>
1031
+
1032
+
1033
+
775
1034
 
776
1035
 
777
1036
  <h5 class="h5-returns">Returns:</h5>
778
1037
 
779
1038
 
780
1039
  <div class="param-desc">
781
- - A promise that resolves when all notifications are marked as read.
1040
+ - A promise that resolves to an object with the unread count.
782
1041
  </div>
783
1042
 
784
1043
 
@@ -789,7 +1048,7 @@
789
1048
  </dt>
790
1049
  <dd>
791
1050
 
792
- <span class="param-type">Promise.&lt;any></span>
1051
+ <span class="param-type">Promise.&lt;Object></span>
793
1052
 
794
1053
 
795
1054
 
@@ -805,7 +1064,7 @@
805
1064
 
806
1065
 
807
1066
 
808
- <h4 class="name" id=".markNotificationAsRead"><span class="type-signature type-signature-static">(static) </span>markNotificationAsRead<span class="signature">(notificationId)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>
1067
+ <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>
809
1068
 
810
1069
 
811
1070
 
@@ -815,13 +1074,13 @@
815
1074
  <dl class="details">
816
1075
 
817
1076
  <dt class="tag-description">Description:</dt>
818
- <dd class="tag-description"><ul class="dummy"><li>Marks a specific notification as read.</li></ul></dd>
1077
+ <dd class="tag-description"><ul class="dummy"><li>Marks all notifications as read for a specific brand.</li></ul></dd>
819
1078
 
820
1079
 
821
1080
 
822
1081
  <dt class="tag-source">Source:</dt>
823
1082
  <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>
1083
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line78">line 78</a>
825
1084
  </li></ul></dd>
826
1085
 
827
1086
 
@@ -868,7 +1127,7 @@
868
1127
 
869
1128
  <h5 class="h5-examples">Example</h5>
870
1129
 
871
- <pre class="prettyprint"><code>markNotificationAsRead(123)
1130
+ <pre class="prettyprint"><code>markAllNotificationsAsRead('drumeo')
872
1131
  .then(response => console.log(response))
873
1132
  .catch(error => console.error(error));</code></pre>
874
1133
 
@@ -900,7 +1159,172 @@
900
1159
 
901
1160
  <tr>
902
1161
 
903
- <td class="name"><code>notificationId</code></td>
1162
+ <td class="name"><code>brand</code></td>
1163
+
1164
+
1165
+ <td class="type">
1166
+
1167
+
1168
+ <span class="param-type">string</span>
1169
+
1170
+
1171
+
1172
+
1173
+ </td>
1174
+
1175
+
1176
+
1177
+
1178
+
1179
+ <td class="description last">The brand to filter notifications by.</td>
1180
+ </tr>
1181
+
1182
+
1183
+ </tbody>
1184
+ </table>
1185
+
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+
1196
+
1197
+
1198
+
1199
+
1200
+
1201
+ <h5 class="h5-returns">Returns:</h5>
1202
+
1203
+
1204
+ <div class="param-desc">
1205
+ - A promise that resolves when all notifications are marked as read.
1206
+ </div>
1207
+
1208
+
1209
+
1210
+ <dl class="param-type">
1211
+ <dt>
1212
+ Type
1213
+ </dt>
1214
+ <dd>
1215
+
1216
+ <span class="param-type">Promise.&lt;any></span>
1217
+
1218
+
1219
+
1220
+ </dd>
1221
+ </dl>
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+
1228
+
1229
+
1230
+
1231
+
1232
+ <h4 class="name" id=".markNotificationAsRead"><span class="type-signature type-signature-static">(static) </span>markNotificationAsRead<span class="signature">(notificationId)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>
1233
+
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+ <dl class="details">
1240
+
1241
+ <dt class="tag-description">Description:</dt>
1242
+ <dd class="tag-description"><ul class="dummy"><li>Marks a specific notification as read.</li></ul></dd>
1243
+
1244
+
1245
+
1246
+ <dt class="tag-source">Source:</dt>
1247
+ <dd class="tag-source"><ul class="dummy"><li>
1248
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line57">line 57</a>
1249
+ </li></ul></dd>
1250
+
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+ </dl>
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+
1288
+
1289
+
1290
+
1291
+
1292
+
1293
+ <h5 class="h5-examples">Example</h5>
1294
+
1295
+ <pre class="prettyprint"><code>markNotificationAsRead(123)
1296
+ .then(response => console.log(response))
1297
+ .catch(error => console.error(error));</code></pre>
1298
+
1299
+
1300
+
1301
+
1302
+ <h5 class="h5-parameters">Parameters:</h5>
1303
+
1304
+
1305
+ <table class="params">
1306
+ <thead>
1307
+ <tr>
1308
+
1309
+ <th>Name</th>
1310
+
1311
+
1312
+ <th>Type</th>
1313
+
1314
+
1315
+
1316
+
1317
+
1318
+ <th class="last">Description</th>
1319
+ </tr>
1320
+ </thead>
1321
+
1322
+ <tbody>
1323
+
1324
+
1325
+ <tr>
1326
+
1327
+ <td class="name"><code>notificationId</code></td>
904
1328
 
905
1329
 
906
1330
  <td class="type">
@@ -1016,7 +1440,7 @@
1016
1440
 
1017
1441
  <dt class="tag-source">Source:</dt>
1018
1442
  <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>
1443
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line97">line 97</a>
1020
1444
  </li></ul></dd>
1021
1445
 
1022
1446
 
@@ -1191,6 +1615,401 @@
1191
1615
 
1192
1616
 
1193
1617
 
1618
+
1619
+
1620
+
1621
+
1622
+ <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>
1623
+
1624
+
1625
+
1626
+
1627
+
1628
+
1629
+ <dl class="details">
1630
+
1631
+ <dt class="tag-description">Description:</dt>
1632
+ <dd class="tag-description"><ul class="dummy"><li>Updates notification settings for specified channels within a given brand.</li></ul></dd>
1633
+
1634
+
1635
+
1636
+ <dt class="tag-source">Source:</dt>
1637
+ <dd class="tag-source"><ul class="dummy"><li>
1638
+ <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line207">line 207</a>
1639
+ </li></ul></dd>
1640
+
1641
+
1642
+
1643
+
1644
+
1645
+
1646
+
1647
+
1648
+
1649
+
1650
+
1651
+
1652
+
1653
+
1654
+
1655
+
1656
+
1657
+
1658
+
1659
+
1660
+
1661
+
1662
+
1663
+
1664
+
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+
1671
+ </dl>
1672
+
1673
+
1674
+
1675
+
1676
+
1677
+
1678
+
1679
+
1680
+
1681
+
1682
+
1683
+ <h5 class="h5-examples">Example</h5>
1684
+
1685
+ <pre class="prettyprint"><code>updateNotificationSetting({
1686
+ brand: 'drumeo',
1687
+ settingName: 'new_lesson',
1688
+ email: true,
1689
+ push: false,
1690
+ bell: true
1691
+ })
1692
+ .then(response => console.log(response))
1693
+ .catch(error => console.error(error));</code></pre>
1694
+
1695
+
1696
+
1697
+
1698
+ <h5 class="h5-parameters">Parameters:</h5>
1699
+
1700
+
1701
+ <table class="params">
1702
+ <thead>
1703
+ <tr>
1704
+
1705
+ <th>Name</th>
1706
+
1707
+
1708
+ <th>Type</th>
1709
+
1710
+
1711
+
1712
+
1713
+
1714
+ <th class="last">Description</th>
1715
+ </tr>
1716
+ </thead>
1717
+
1718
+ <tbody>
1719
+
1720
+
1721
+ <tr>
1722
+
1723
+ <td class="name"><code>options</code></td>
1724
+
1725
+
1726
+ <td class="type">
1727
+
1728
+
1729
+ <span class="param-type">Object</span>
1730
+
1731
+
1732
+
1733
+
1734
+ </td>
1735
+
1736
+
1737
+
1738
+
1739
+
1740
+ <td class="description last">Options to update notification settings.
1741
+ <h6>Properties</h6>
1742
+
1743
+
1744
+ <table class="params">
1745
+ <thead>
1746
+ <tr>
1747
+
1748
+ <th>Name</th>
1749
+
1750
+
1751
+ <th>Type</th>
1752
+
1753
+
1754
+ <th>Attributes</th>
1755
+
1756
+
1757
+
1758
+
1759
+ <th class="last">Description</th>
1760
+ </tr>
1761
+ </thead>
1762
+
1763
+ <tbody>
1764
+
1765
+
1766
+ <tr>
1767
+
1768
+ <td class="name"><code>brand</code></td>
1769
+
1770
+
1771
+ <td class="type">
1772
+
1773
+
1774
+ <span class="param-type">string</span>
1775
+
1776
+
1777
+
1778
+
1779
+ </td>
1780
+
1781
+
1782
+ <td class="attributes">
1783
+
1784
+
1785
+
1786
+
1787
+
1788
+ </td>
1789
+
1790
+
1791
+
1792
+
1793
+ <td class="description last">The brand context for the notification settings.</td>
1794
+ </tr>
1795
+
1796
+
1797
+
1798
+ <tr>
1799
+
1800
+ <td class="name"><code>settingName</code></td>
1801
+
1802
+
1803
+ <td class="type">
1804
+
1805
+
1806
+ <span class="param-type">string</span>
1807
+
1808
+
1809
+
1810
+
1811
+ </td>
1812
+
1813
+
1814
+ <td class="attributes">
1815
+
1816
+
1817
+
1818
+
1819
+
1820
+ </td>
1821
+
1822
+
1823
+
1824
+
1825
+ <td class="description last">The name of the notification setting to update (required).</td>
1826
+ </tr>
1827
+
1828
+
1829
+
1830
+ <tr>
1831
+
1832
+ <td class="name"><code>email</code></td>
1833
+
1834
+
1835
+ <td class="type">
1836
+
1837
+
1838
+ <span class="param-type">boolean</span>
1839
+
1840
+
1841
+
1842
+
1843
+ </td>
1844
+
1845
+
1846
+ <td class="attributes">
1847
+
1848
+ &lt;optional><br>
1849
+
1850
+
1851
+
1852
+
1853
+
1854
+ </td>
1855
+
1856
+
1857
+
1858
+
1859
+ <td class="description last">Whether email notifications are enabled or disabled.</td>
1860
+ </tr>
1861
+
1862
+
1863
+
1864
+ <tr>
1865
+
1866
+ <td class="name"><code>push</code></td>
1867
+
1868
+
1869
+ <td class="type">
1870
+
1871
+
1872
+ <span class="param-type">boolean</span>
1873
+
1874
+
1875
+
1876
+
1877
+ </td>
1878
+
1879
+
1880
+ <td class="attributes">
1881
+
1882
+ &lt;optional><br>
1883
+
1884
+
1885
+
1886
+
1887
+
1888
+ </td>
1889
+
1890
+
1891
+
1892
+
1893
+ <td class="description last">Whether push notifications are enabled or disabled.</td>
1894
+ </tr>
1895
+
1896
+
1897
+
1898
+ <tr>
1899
+
1900
+ <td class="name"><code>bell</code></td>
1901
+
1902
+
1903
+ <td class="type">
1904
+
1905
+
1906
+ <span class="param-type">boolean</span>
1907
+
1908
+
1909
+
1910
+
1911
+ </td>
1912
+
1913
+
1914
+ <td class="attributes">
1915
+
1916
+ &lt;optional><br>
1917
+
1918
+
1919
+
1920
+
1921
+
1922
+ </td>
1923
+
1924
+
1925
+
1926
+
1927
+ <td class="description last">Whether bell notifications are enabled or disabled.</td>
1928
+ </tr>
1929
+
1930
+
1931
+ </tbody>
1932
+ </table>
1933
+
1934
+ </td>
1935
+ </tr>
1936
+
1937
+
1938
+ </tbody>
1939
+ </table>
1940
+
1941
+
1942
+
1943
+
1944
+
1945
+
1946
+
1947
+
1948
+
1949
+
1950
+
1951
+
1952
+
1953
+
1954
+ <h5 class="h5-throws">Throws:</h5>
1955
+
1956
+
1957
+
1958
+ <dl>
1959
+ <dt>
1960
+ <div class="param-desc usertext">
1961
+ Throws an error if `settingName` is not provided or if no channels are specified.
1962
+ </div>
1963
+ </dt>
1964
+ <dd></dd>
1965
+ <dt>
1966
+ <dl class="param-type">
1967
+ <dt>
1968
+ Type
1969
+ </dt>
1970
+ <dd>
1971
+
1972
+ <span class="param-type">Error</span>
1973
+
1974
+
1975
+
1976
+ </dd>
1977
+ </dl>
1978
+ </dt>
1979
+ <dd></dd>
1980
+ </dl>
1981
+
1982
+
1983
+
1984
+
1985
+
1986
+ <h5 class="h5-returns">Returns:</h5>
1987
+
1988
+
1989
+ <div class="param-desc">
1990
+ - A promise that resolves to the server response after updating settings.
1991
+ </div>
1992
+
1993
+
1994
+
1995
+ <dl class="param-type">
1996
+ <dt>
1997
+ Type
1998
+ </dt>
1999
+ <dd>
2000
+
2001
+ <span class="param-type">Promise.&lt;Object></span>
2002
+
2003
+
2004
+
2005
+ </dd>
2006
+ </dl>
2007
+
2008
+
2009
+
2010
+
2011
+
2012
+
1194
2013
 
1195
2014
 
1196
2015
 
@@ -1210,7 +2029,7 @@
1210
2029
  <br class="clear">
1211
2030
 
1212
2031
  <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.
2032
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Jul 01 2025 13:29:46 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1214
2033
  </footer>
1215
2034
 
1216
2035
  <script>prettyPrint();</script>