npm - musora-content-services - Versions diffs - 2.92.3 → 2.92.6 - Mend

musora-content-services 2.92.3 → 2.92.6

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

package/CHANGELOG.md +16 -0
package/package.json +1 -1
package/src/index.d.ts +2 -0
package/src/index.js +2 -0
package/src/services/content-org/learning-paths.ts +3 -3
package/src/services/progress-row/method-card.js +1 -1
package/src/services/sync/fetch.ts +3 -0
package/docs/Content.html +0 -269
package/docs/ContentOrganization.html +0 -245
package/docs/Forums.html +0 -269
package/docs/Gamification.html +0 -245
package/docs/TestUser.html +0 -260
package/docs/UserManagementSystem.html +0 -317
package/docs/api_types.js.html +0 -97
package/docs/config.js.html +0 -140
package/docs/content-org_content-org.js.html +0 -76
package/docs/content-org_guided-courses.ts.html +0 -110
package/docs/content-org_learning-paths.ts.html +0 -391
package/docs/content-org_playlists-types.js.html +0 -128
package/docs/content-org_playlists.js.html +0 -440
package/docs/content.js.html +0 -603
package/docs/content_artist.ts.html +0 -206
package/docs/content_content.ts.html +0 -77
package/docs/content_genre.ts.html +0 -209
package/docs/content_instructor.ts.html +0 -206
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 -978
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 -1049
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/forums_categories.ts.html +0 -156
package/docs/forums_discussions.js.html +0 -95
package/docs/forums_forum.js.html +0 -95
package/docs/forums_forums.ts.html +0 -160
package/docs/forums_posts.ts.html +0 -284
package/docs/forums_threads.ts.html +0 -284
package/docs/gamification_awards.js.html +0 -165
package/docs/gamification_awards.ts.html +0 -195
package/docs/gamification_gamification.js.html +0 -76
package/docs/gamification_types.js.html +0 -80
package/docs/global.html +0 -6019
package/docs/index.html +0 -167
package/docs/liveTesting.ts.html +0 -103
package/docs/module-Accounts.html +0 -2283
package/docs/module-Artist.html +0 -993
package/docs/module-Awards.html +0 -836
package/docs/module-Categories.html +0 -711
package/docs/module-Config.html +0 -431
package/docs/module-Content-Services-V2.html +0 -2998
package/docs/module-ForumCategories.html +0 -687
package/docs/module-ForumDiscussions.html +0 -370
package/docs/module-Forums.html +0 -16599
package/docs/module-Genre.html +0 -981
package/docs/module-GuidedCourses.html +0 -108
package/docs/module-Instructor.html +0 -929
package/docs/module-Interests.html +0 -1066
package/docs/module-LearningPaths.html +0 -2424
package/docs/module-Onboarding.html +0 -882
package/docs/module-Payments.html +0 -392
package/docs/module-Permissions.html +0 -406
package/docs/module-Playlists.html +0 -3030
package/docs/module-ProgressRow.html +0 -108
package/docs/module-Railcontent-Services.html +0 -5876
package/docs/module-Sanity-Services.html +0 -8244
package/docs/module-Sessions.html +0 -575
package/docs/module-Threads.html +0 -1119
package/docs/module-UserActivity.html +0 -4534
package/docs/module-UserChat.html +0 -410
package/docs/module-UserManagement.html +0 -1932
package/docs/module-UserMemberships.html +0 -829
package/docs/module-UserNotifications.html +0 -2595
package/docs/module-UserProfile.html +0 -370
package/docs/progress-row_method-card.js.html +0 -184
package/docs/railcontent.js.html +0 -724
package/docs/sanity.js.html +0 -2322
package/docs/scripts/collapse.js +0 -39
package/docs/scripts/commonNav.js +0 -28
package/docs/scripts/linenumber.js +0 -25
package/docs/scripts/nav.js +0 -12
package/docs/scripts/polyfill.js +0 -4
package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docs/scripts/prettify/lang-css.js +0 -2
package/docs/scripts/prettify/prettify.js +0 -28
package/docs/scripts/search.js +0 -99
package/docs/styles/jsdoc.css +0 -776
package/docs/styles/prettify.css +0 -80
package/docs/userActivity.js.html +0 -1512
package/docs/user_account.ts.html +0 -265
package/docs/user_chat.js.html +0 -98
package/docs/user_interests.js.html +0 -150
package/docs/user_management.js.html +0 -258
package/docs/user_memberships.js.html +0 -144
package/docs/user_memberships.ts.html +0 -292
package/docs/user_notifications.js.html +0 -374
package/docs/user_onboarding.ts.html +0 -329
package/docs/user_payments.ts.html +0 -146
package/docs/user_permissions.js.html +0 -110
package/docs/user_profile.js.html +0 -115
package/docs/user_sessions.js.html +0 -170
package/docs/user_types.js.html +0 -224
package/docs/user_user-management-system.js.html +0 -79

package/docs/module-UserNotifications.html DELETED Viewed

@@ -1,2595 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>UserNotifications - 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-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~deleteAccount">deleteAccount</a></li><li data-type='method'><a href="module-Accounts.html#~numberOfActiveUsers">numberOfActiveUsers</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li><li data-type='method'><a href="module-Accounts.html#~toggleStudentView">toggleStudentView</a></li></ul></li><li><a href="module-Artist.html">Artist</a><ul class='methods'><li data-type='method'><a href="module-Artist.html#~fetchArtistBySlug">fetchArtistBySlug</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtists">fetchArtists</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getLegacyMethods">getLegacyMethods</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getOwnedContent">getOwnedContent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deleteForumCategory">deleteForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~jumpToPost">jumpToPost</a></li><li data-type='method'><a href="module-Forums.html#~likePost">likePost</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~markThreadAsRead">markThreadAsRead</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~search">search</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlikePost">unlikePost</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updatePost">updatePost</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-Genre.html">Genre</a><ul class='methods'><li data-type='method'><a href="module-Genre.html#~fetchGenreBySlug">fetchGenreBySlug</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenres">fetchGenres</a></li></ul></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Instructor.html">Instructor</a><ul class='methods'><li data-type='method'><a href="module-Instructor.html#~fetchInstructorBySlug">fetchInstructorBySlug</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructorLessons">fetchInstructorLessons</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructors">fetchInstructors</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-LearningPaths.html">LearningPaths</a><ul class='methods'><li data-type='method'><a href="module-LearningPaths.html#~completeLearningPathIntroVideo">completeLearningPathIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~completeMethodIntroVideo">completeMethodIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathLessons">fetchLearningPathLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathProgressCheckLessons">fetchLearningPathProgressCheckLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-LearningPaths.html#~getEnrichedLearningPath">getEnrichedLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getLearningPathLessonsByIds">getLearningPathLessonsByIds</a></li><li data-type='method'><a href="module-LearningPaths.html#~mapContentToParent">mapContentToParent</a></li><li data-type='method'><a href="module-LearningPaths.html#~resetAllLearningPaths">resetAllLearningPaths</a></li><li data-type='method'><a href="module-LearningPaths.html#~startLearningPath">startLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateDailySession">updateDailySession</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~getOnboardingRecommendedContent">getOnboardingRecommendedContent</a></li><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-ProgressRow.html">ProgressRow</a></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.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#.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#.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#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2StructureFromId">fetchMethodV2StructureFromId</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#.fetchOwnedContent">fetchOwnedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchTopLevelParentId">fetchTopLevelParentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
-</nav>
-<div id="main">
-    <h1 class="page-title">UserNotifications</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#line115">line 115</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=".fetchLiveEventPollingState"><span class="type-signature type-signature-static">(static) </span>fetchLiveEventPollingState<span class="signature">()</span><span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Fetches the current live event polling state.
- + @returns {Promise<Object>} - Promise resolving to the polling state</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#line294">line 294</a>
-    </li></ul></dd>
-</dl>
-    <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>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Fetches the notification settings for the current user grouped by 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#line192">line 192</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-examples">Example</h5>
-    <pre class="prettyprint"><code>fetchNotificationSetting()
-  .then(settings => {
-    console.log(settings);
-  })
-  .catch(error => {
-    console.error(error);
-  });</code></pre>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    A promise that resolves to an object where keys are brands and values are arrays of settings objects.
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;Object></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 notifications for a given brand with optional filters for unread status and 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#line35">line 35</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-examples">Example</h5>
-    <pre class="prettyprint"><code>fetchNotifications({ limit: 5, onlyUnread: true,  page: 2  })
-  .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>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>
-        <tr>
-                <td class="name"><code>page</code></td>
-            <td class="type">
-<span class="param-type">number</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    <code>1</code>
-                </td>
-            <td class="description last">The page number for pagination.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>onlyUnread</code></td>
-            <td class="type">
-<span class="param-type">boolean</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    <code>false</code>
-                </td>
-            <td class="description last">Whether to fetch only unread notifications. If true, adds `unread=1` to the query.</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 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=".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>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Fetches the count of unread notifications for the current user in a given brand context.
-This function first checks for standard unread notifications. If none are found,
-it checks if live event polling is active. If so, it will query for any ongoing live events.
-If a live event is active, it counts as an unread item.</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#line164">line 164</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-examples">Example</h5>
-    <pre class="prettyprint"><code>fetchUnreadCount({ brand: 'drumeo' })
-  .then(data => console.log(data.data)) // 0 or 1
-  .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 unread count.
-                <h6>Properties</h6>
-<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 unread notifications by. Defaults to 'drumeo'.</td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<h5 class="h5-throws">Throws:</h5>
-<dl>
-    <dt>
-        <div class="param-desc usertext">
-        If the brand is not provided or if network requests fail.
-        </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 object with a `data` property indicating the unread count (0 or 1).
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&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 class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</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 the current user.
-This also pauses live event polling if there is an active event, to prevent immediate re-polling.</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#line72">line 72</a>
-    </li></ul></dd>
-</dl>
-    <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>brand</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    <code>'drumeo'</code>
-                </td>
-            <td class="description last">The brand context for live event handling before marking notifications.</td>
-        </tr>
-    </tbody>
-</table>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    - A promise resolving to the API response from the notifications read endpoint.
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;Object></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#line55">line 55</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#line92">line 92</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>
-    <h4 class="name" id=".pauseLiveEventPolling"><span class="type-signature type-signature-static">(static) </span>pauseLiveEventPolling<span class="signature">(brand<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Pauses live event polling for the current user based on the live event end time.
-If a live event is active, polling will be paused until its end time. If no live event is found,
-polling is not paused.</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#line273">line 273</a>
-    </li></ul></dd>
-</dl>
-    <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>brand</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    <code>'drumeo'</code>
-                </td>
-            <td class="description last">The brand context to fetch live event data for.</td>
-        </tr>
-    </tbody>
-</table>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    - A promise resolving to the API response from the pause polling endpoint.
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;Object></span>
-    </dd>
-</dl>
-    <h4 class="name" id=".restoreNotification"><span class="type-signature type-signature-static">(static) </span>restoreNotification<span class="signature">(notificationId)</span><span class="type-signature"> &rarr; {Promise.&lt;any>}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Restores 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#line137">line 137</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-examples">Example</h5>
-    <pre class="prettyprint"><code>restoreNotification(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 restore.</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 restored.
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;any></span>
-    </dd>
-</dl>
-    <h4 class="name" id=".startLiveEventPolling"><span class="type-signature type-signature-static">(static) </span>startLiveEventPolling<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Start live event polling.</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#line284">line 284</a>
-    </li></ul></dd>
-</dl>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    - Promise resolving to the API response
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;Object></span>
-    </dd>
-</dl>
-    <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>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Updates notification settings for specified channels within a given 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#line234">line 234</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-examples">Example</h5>
-    <pre class="prettyprint"><code>updateNotificationSetting({
-  brand: 'drumeo',
-  settingName: 'new_lesson',
-  email: true,
-  push: false,
-  bell: true
-})
-.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>options</code></td>
-            <td class="type">
-<span class="param-type">Object</span>
-            </td>
-            <td class="description last">Options to update notification settings.
-                <h6>Properties</h6>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</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="description last">The brand context for the notification settings.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>settingName</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                </td>
-            <td class="description last">The name of the notification setting to update (required).</td>
-        </tr>
-        <tr>
-                <td class="name"><code>email</code></td>
-            <td class="type">
-<span class="param-type">boolean</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">Whether email notifications are enabled or disabled.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>push</code></td>
-            <td class="type">
-<span class="param-type">boolean</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">Whether push notifications are enabled or disabled.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>bell</code></td>
-            <td class="type">
-<span class="param-type">boolean</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">Whether bell notifications are enabled or disabled.</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 `settingName` is not provided or if no channels are specified.
-        </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 the server response after updating settings.
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;Object></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 Fri Nov 28 2025 11:22:56 GMT-0800 (Pacific Standard 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>