npm - musora-content-services - Versions diffs - 2.8.2 → 2.8.3 - Mend

musora-content-services 2.8.2 → 2.8.3

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 (160) hide show

package/.coderabbit.yaml +0 -0
package/.editorconfig +0 -0
package/.github/pull_request_template.md +0 -0
package/.github/workflows/node.js.yml +0 -0
package/.prettierignore +0 -0
package/.prettierrc +0 -0
package/.yarnrc.yml +1 -0
package/CHANGELOG.md +2 -0
package/README.md +0 -0
package/babel.config.cjs +0 -0
package/docs/Content-Organization.html +0 -0
package/docs/ContentOrganization.html +2 -2
package/docs/Gamification.html +2 -2
package/docs/UserManagement.html +0 -0
package/docs/UserManagementSystem.html +2 -2
package/docs/api_types.js.html +2 -2
package/docs/config.js.html +2 -2
package/docs/content-org_content-org.js.html +2 -2
package/docs/content-org_playlists-types.js.html +2 -2
package/docs/content-org_playlists.js.html +14 -2
package/docs/content.js.html +2 -2
package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
package/docs/gamification_awards.js.html +2 -2
package/docs/gamification_gamification.js.html +2 -2
package/docs/gamification_types.js.html +2 -2
package/docs/global.html +2 -2
package/docs/global.html#User +0 -0
package/docs/index.html +2 -2
package/docs/module-Awards.html +2 -2
package/docs/module-Config.html +2 -2
package/docs/module-Content-Services-V2.html +2 -2
package/docs/module-Content-Services.html +763 -0
package/docs/module-Interests.html +2 -2
package/docs/module-Notifications.html +1183 -0
package/docs/module-Permissions.html +2 -2
package/docs/module-Playlists.html +322 -12
package/docs/module-Railcontent-Services.html +2 -2
package/docs/module-Sanity-Services.html +2 -2
package/docs/module-Session-Management.html +0 -0
package/docs/module-Sessions.html +2 -2
package/docs/module-User-Activity.html +0 -0
package/docs/module-User-Management.html +0 -0
package/docs/module-User-Permissions.html +0 -0
package/docs/module-UserActivity.html +4410 -0
package/docs/module-UserManagement.html +2 -2
package/docs/module-UserNotifications.html +1183 -0
package/docs/module-UserProfile.html +2 -2
package/docs/railcontent.js.html +2 -2
package/docs/sanity.js.html +2 -2
package/docs/scripts/collapse.js +0 -0
package/docs/scripts/commonNav.js +0 -0
package/docs/scripts/linenumber.js +0 -0
package/docs/scripts/nav.js +0 -0
package/docs/scripts/polyfill.js +0 -0
package/docs/scripts/prettify/Apache-License-2.0.txt +0 -0
package/docs/scripts/prettify/lang-css.js +0 -0
package/docs/scripts/prettify/prettify.js +0 -0
package/docs/scripts/search.js +0 -0
package/docs/styles/jsdoc.css +0 -0
package/docs/styles/prettify.css +0 -0
package/docs/types.js.html +0 -0
package/docs/userActivity.js.html +197 -46
package/docs/user_interests.js.html +2 -2
package/docs/user_management.js.html +2 -2
package/docs/user_notifications.js.html +189 -0
package/docs/user_permissions.js.html +2 -2
package/docs/user_profile.js.html +2 -2
package/docs/user_sessions.js.html +2 -2
package/docs/user_types.js.html +2 -2
package/docs/user_user-management-system.js.html +2 -2
package/docs/user_user-management.js.html +0 -0
package/jest.config.js +0 -0
package/jsdoc.json +0 -0
package/package.json +1 -1
package/src/contentMetaData.js +0 -0
package/src/filterBuilder.js +0 -0
package/src/index.d.ts +13 -0
package/src/index.js +13 -0
package/src/infrastructure/http/HttpClient.ts +0 -0
package/src/infrastructure/http/executors/FetchRequestExecutor.ts +0 -0
package/src/infrastructure/http/index.ts +0 -0
package/src/infrastructure/http/interfaces/HeaderProvider.ts +0 -0
package/src/infrastructure/http/interfaces/HttpError.ts +0 -0
package/src/infrastructure/http/interfaces/NetworkError.ts +0 -0
package/src/infrastructure/http/interfaces/RequestExecutor.ts +0 -0
package/src/infrastructure/http/interfaces/RequestOptions.ts +0 -0
package/src/infrastructure/http/providers/DefaultHeaderProvider.ts +0 -0
package/src/lib/httpHelper.js +0 -0
package/src/lib/lastUpdated.js +0 -0
package/src/services/api/types.js +0 -0
package/src/services/config.js +0 -0
package/src/services/content-org/content-org.js +0 -0
package/src/services/content-org/playlists-types.js +11 -0
package/src/services/content-org/playlists.js +2 -1
package/src/services/content.js +0 -0
package/src/services/contentAggregator.js +0 -0
package/src/services/contentLikes.js +0 -0
package/src/services/contentProgress.js +0 -0
package/src/services/dataContext.js +0 -0
package/src/services/dateUtils.js +0 -0
package/src/services/forum.js +0 -0
package/src/services/gamification/awards.js +0 -0
package/src/services/gamification/gamification.js +0 -0
package/src/services/gamification/types.js +0 -0
package/src/services/imageSRCBuilder.js +0 -0
package/src/services/imageSRCVerify.js +0 -0
package/src/services/railcontent.js +0 -0
package/src/services/recommendations.js +0 -0
package/src/services/sanity.js +13 -1
package/src/services/types.js +0 -0
package/src/services/user/interests.js +0 -0
package/src/services/user/management.js +0 -0
package/src/services/user/notifications.js +120 -0
package/src/services/user/permissions.js +0 -0
package/src/services/user/profile.js +0 -0
package/src/services/user/sessions.js +0 -0
package/src/services/user/types.js +0 -0
package/src/services/user/user-management-system.js +0 -0
package/src/services/userActivity.js +2 -1
package/test/HttpClient.test.js +0 -0
package/test/content.test.js +0 -0
package/test/contentLikes.test.js +0 -0
package/test/contentProgress.test.js +0 -0
package/test/dataContext.test.js +0 -0
package/test/forum.test.js +0 -0
package/test/imageSRCBuilder.test.js +0 -0
package/test/imageSRCVerify.test.js +0 -0
package/test/initializeTests.js +0 -0
package/test/lib/lastUpdated.test.js +0 -0
package/test/live/contentProgressLive.test.js +0 -0
package/test/live/railcontentLive.test.js +0 -0
package/test/localStorageMock.js +0 -0
package/test/log.js +0 -0
package/test/mockData/mockData_fetchByRailContentIds_one_content.json +0 -0
package/test/mockData/mockData_progress_content.json +0 -0
package/test/mockData/mockData_sanity_progress_content.json +0 -0
package/test/mockData/mockData_user_practices.json +0 -0
package/test/progressRows.test.js +0 -0
package/test/sanityQueryService.test.js +0 -0
package/test/streakMessage.test.js +0 -0
package/test/user/permissions.test.js +0 -0
package/test/userActivity.test.js +0 -0
package/tools/generate-index.cjs +0 -0

package/docs/module-Notifications.html ADDED Viewed

@@ -0,0 +1,1183 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Notifications - Documentation</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <script src="scripts/nav.js" defer></script>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav >
+    <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-Notifications.html">Notifications</a><ul class='methods'><li data-type='method'><a href="module-Notifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-Notifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-Notifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-Notifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-Notifications.html#.markNotificationAsUnread">markNotificationAsUnread</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-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-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>
+</nav>
+<div id="main">
+    <h1 class="page-title">Notifications</h1>
+<section>
+<header>
+</header>
+<article>
+        <div class="container-overview">
+        </div>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id=".deleteNotification"><span class="type-signature type-signature-static">(static) </span>deleteNotification<span class="signature">(notificationId)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li>Deletes a specific notification.</li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line110">line 110</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-examples">Example</h5>
+    <pre class="prettyprint"><code>deleteNotification(123)
+  .then(response => console.log(response))
+  .catch(error => console.error(error));</code></pre>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>notificationId</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+            <td class="description last">The ID of the notification to delete.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws an error if notificationId is not provided.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">Error</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when the notification is successfully deleted.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;any></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li>Fetches unread notifications for a given brand with an optional limit.</li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line25">line 25</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-examples">Example</h5>
+    <pre class="prettyprint"><code>fetchNotifications({ brand: 'drumeo', limit: 5 })
+  .then(notifications => console.log(notifications))
+  .catch(error => console.error(error));</code></pre>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    <code>{}</code>
+                </td>
+            <td class="description last">Options for fetching notifications.
+                <h6>Properties</h6>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>brand</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+                <td class="default">
+                </td>
+            <td class="description last">The brand to filter notifications by. (Required)</td>
+        </tr>
+        <tr>
+                <td class="name"><code>limit</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+                <td class="default">
+                    <code>10</code>
+                </td>
+            <td class="description last">The maximum number of notifications to fetch.</td>
+        </tr>
+    </tbody>
+</table>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws an error if the brand is not provided.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">Error</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves to an array of unread notifications.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;Array.&lt;Object>></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li>Marks all notifications as read for a specific brand.</li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line68">line 68</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-examples">Example</h5>
+    <pre class="prettyprint"><code>markAllNotificationsAsRead('drumeo')
+  .then(response => console.log(response))
+  .catch(error => console.error(error));</code></pre>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>brand</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The brand to filter notifications by.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when all notifications are marked as read.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;any></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li>Marks a specific notification as read.</li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line47">line 47</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-examples">Example</h5>
+    <pre class="prettyprint"><code>markNotificationAsRead(123)
+  .then(response => console.log(response))
+  .catch(error => console.error(error));</code></pre>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>notificationId</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+            <td class="description last">The ID of the notification to mark as read.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws an error if notificationId is not provided.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">Error</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when the notification is successfully marked as read.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;any></span>
+    </dd>
+</dl>
+    <h4 class="name" id=".markNotificationAsUnread"><span class="type-signature type-signature-static">(static) </span>markNotificationAsUnread<span class="signature">(notificationId)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li>Marks a specific notification as unread.</li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_notifications.js.html">user/notifications.js</a>, <a href="user_notifications.js.html#line87">line 87</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="h5-examples">Example</h5>
+    <pre class="prettyprint"><code>markNotificationAsUnread(123)
+  .then(response => console.log(response))
+  .catch(error => console.error(error));</code></pre>
+    <h5 class="h5-parameters">Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>notificationId</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+            <td class="description last">The ID of the notification to mark as unread.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws an error if notificationId is not provided.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">Error</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when the notification is successfully marked as unread.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;any></span>
+    </dd>
+</dl>
+</article>
+</section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Jun 03 2025 12:19:30 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>