musora-content-services 1.6.8 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/docs/v2/ContentOrganization.html +2 -2
  3. package/docs/v2/Forums.html +3 -3
  4. package/docs/v2/Gamification.html +2 -2
  5. package/docs/v2/TestUser.html +260 -0
  6. package/docs/v2/UserManagementSystem.html +2 -2
  7. package/docs/v2/api_types.js.html +2 -2
  8. package/docs/v2/config.js.html +2 -2
  9. package/docs/v2/content-org_content-org.js.html +2 -2
  10. package/docs/v2/content-org_guided-courses.ts.html +2 -2
  11. package/docs/v2/content-org_learning-paths.ts.html +256 -0
  12. package/docs/v2/content-org_playlists-types.js.html +2 -2
  13. package/docs/v2/content-org_playlists.js.html +2 -2
  14. package/docs/v2/content.js.html +57 -54
  15. package/docs/v2/forums_categories.ts.html +2 -2
  16. package/docs/v2/forums_forums.ts.html +86 -3
  17. package/docs/v2/forums_posts.ts.html +120 -13
  18. package/docs/v2/forums_threads.ts.html +2 -2
  19. package/docs/v2/gamification_awards.ts.html +2 -2
  20. package/docs/v2/gamification_gamification.js.html +2 -2
  21. package/docs/v2/global.html +357 -2
  22. package/docs/v2/index.html +2 -2
  23. package/docs/v2/liveTesting.ts.html +103 -0
  24. package/docs/v2/module-Accounts.html +648 -25
  25. package/docs/v2/module-Awards.html +2 -2
  26. package/docs/v2/module-Config.html +2 -2
  27. package/docs/v2/module-Content-Services-V2.html +37 -318
  28. package/docs/v2/module-Forums.html +4161 -729
  29. package/docs/v2/module-GuidedCourses.html +2 -2
  30. package/docs/v2/module-Interests.html +2 -2
  31. package/docs/v2/module-LearningPaths.html +1330 -0
  32. package/docs/v2/module-Onboarding.html +858 -0
  33. package/docs/v2/module-Payments.html +148 -6
  34. package/docs/v2/module-Permissions.html +2 -2
  35. package/docs/v2/module-Playlists.html +2 -2
  36. package/docs/v2/module-ProgressRow.html +108 -0
  37. package/docs/v2/module-Railcontent-Services.html +6 -6
  38. package/docs/v2/module-Sanity-Services.html +339 -43
  39. package/docs/v2/module-Sessions.html +2 -2
  40. package/docs/v2/module-UserActivity.html +22 -22
  41. package/docs/v2/module-UserChat.html +2 -2
  42. package/docs/v2/module-UserManagement.html +448 -4
  43. package/docs/v2/module-UserMemberships.html +284 -11
  44. package/docs/v2/module-UserNotifications.html +2 -2
  45. package/docs/v2/module-UserProfile.html +2 -2
  46. package/docs/v2/progress-row_method-card.js.html +185 -0
  47. package/docs/v2/railcontent.js.html +2 -21
  48. package/docs/v2/sanity.js.html +135 -47
  49. package/docs/v2/userActivity.js.html +120 -64
  50. package/docs/v2/user_account.ts.html +84 -37
  51. package/docs/v2/user_chat.js.html +2 -2
  52. package/docs/v2/user_interests.js.html +2 -2
  53. package/docs/v2/user_management.js.html +42 -5
  54. package/docs/v2/user_memberships.js.html +2 -2
  55. package/docs/v2/user_memberships.ts.html +292 -0
  56. package/docs/v2/user_notifications.js.html +2 -2
  57. package/docs/v2/user_onboarding.ts.html +234 -0
  58. package/docs/v2/user_payments.ts.html +55 -6
  59. package/docs/v2/user_permissions.js.html +2 -2
  60. package/docs/v2/user_profile.js.html +2 -2
  61. package/docs/v2/user_sessions.js.html +2 -2
  62. package/docs/v2/user_types.js.html +8 -2
  63. package/docs/v2/user_user-management-system.js.html +2 -2
  64. package/package.json +1 -1
  65. package/src/contentTypeConfig.js +2 -0
  66. package/src/filterBuilder.js +3 -1
  67. package/src/services/imageSRCBuilder.js +1 -1
  68. package/src/services/imageSRCVerify.js +1 -1
  69. package/src/services/sanity.js +12 -3
  70. package/test/imageSRCBuilder.test.js +1 -1
  71. package/test/imageSRCVerify.test.js +4 -4
@@ -29,7 +29,7 @@
29
29
  <nav >
30
30
 
31
31
 
32
- <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-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#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.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#.getRecentForTab">getRecentForTab</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</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#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.isDisplayNameAvailable">isDisplayNameAvailable</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#.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><a href="global.html">Global</a></h3>
32
+ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~deleteAccount">deleteAccount</a></li><li data-type='method'><a href="module-Accounts.html#~numberOfActiveUsers">numberOfActiveUsers</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getLegacyMethods">getLegacyMethods</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~jumpToPost">jumpToPost</a></li><li data-type='method'><a href="module-Forums.html#~likePost">likePost</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~search">search</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlikePost">unlikePost</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updatePost">updatePost</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-LearningPaths.html">LearningPaths</a><ul class='methods'><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathLessons">fetchLearningPathLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-LearningPaths.html#~resetAllLearningPaths">resetAllLearningPaths</a></li><li data-type='method'><a href="module-LearningPaths.html#~startLearningPath">startLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateActivePath">updateActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateDailySession">updateDailySession</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~getOnboardingRecommendedContent">getOnboardingRecommendedContent</a></li><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-ProgressRow.html">ProgressRow</a></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
33
33
 
34
34
  </nav>
35
35
 
@@ -84,7 +84,7 @@
84
84
 
85
85
 
86
86
 
87
- <h4 class="name" id="~confirmEmailChange"><span class="type-signature type-signature-async, inner">(async, inner) </span>confirmEmailChange<span class="signature">(token)</span><span class="type-signature"> &rarr; {Promise.&lt;(void|HttpError)>}</span></h4>
87
+ <h4 class="name" id="~confirmEmailChange"><span class="type-signature type-signature-async, inner">(async, inner) </span>confirmEmailChange<span class="signature">(token)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
88
88
 
89
89
 
90
90
 
@@ -97,7 +97,7 @@
97
97
 
98
98
  <dt class="tag-source">Source:</dt>
99
99
  <dd class="tag-source"><ul class="dummy"><li>
100
- <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line110">line 110</a>
100
+ <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line133">line 133</a>
101
101
  </li></ul></dd>
102
102
 
103
103
 
@@ -206,6 +206,36 @@
206
206
 
207
207
 
208
208
 
209
+ <h5 class="h5-throws">Throws:</h5>
210
+
211
+
212
+
213
+ <dl>
214
+ <dt>
215
+ <div class="param-desc usertext">
216
+ - Throws HttpError if the request fails.
217
+ </div>
218
+ </dt>
219
+ <dd></dd>
220
+ <dt>
221
+ <dl class="param-type">
222
+ <dt>
223
+ Type
224
+ </dt>
225
+ <dd>
226
+
227
+ <span class="param-type">HttpError</span>
228
+
229
+
230
+
231
+ </dd>
232
+ </dl>
233
+ </dt>
234
+ <dd></dd>
235
+ </dl>
236
+
237
+
238
+
209
239
 
210
240
 
211
241
  <h5 class="h5-returns">Returns:</h5>
@@ -223,7 +253,7 @@
223
253
  </dt>
224
254
  <dd>
225
255
 
226
- <span class="param-type">Promise.&lt;(void|HttpError)></span>
256
+ <span class="param-type">Promise.&lt;void></span>
227
257
 
228
258
 
229
259
 
@@ -239,7 +269,7 @@
239
269
 
240
270
 
241
271
 
242
- <h4 class="name" id="~requestEmailChange"><span class="type-signature type-signature-async, inner">(async, inner) </span>requestEmailChange<span class="signature">(email, password)</span><span class="type-signature"> &rarr; {Promise.&lt;(void|HttpError)>}</span></h4>
272
+ <h4 class="name" id="~deleteAccount"><span class="type-signature type-signature-async, inner">(async, inner) </span>deleteAccount<span class="signature">(userId)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
243
273
 
244
274
 
245
275
 
@@ -252,7 +282,300 @@
252
282
 
253
283
  <dt class="tag-source">Source:</dt>
254
284
  <dd class="tag-source"><ul class="dummy"><li>
255
- <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line96">line 96</a>
285
+ <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line144">line 144</a>
286
+ </li></ul></dd>
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+ </dl>
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+ <h5 class="h5-parameters">Parameters:</h5>
333
+
334
+
335
+ <table class="params">
336
+ <thead>
337
+ <tr>
338
+
339
+ <th>Name</th>
340
+
341
+
342
+ <th>Type</th>
343
+
344
+
345
+
346
+
347
+
348
+ <th class="last">Description</th>
349
+ </tr>
350
+ </thead>
351
+
352
+ <tbody>
353
+
354
+
355
+ <tr>
356
+
357
+ <td class="name"><code>userId</code></td>
358
+
359
+
360
+ <td class="type">
361
+
362
+
363
+ <span class="param-type">number</span>
364
+
365
+
366
+
367
+
368
+ </td>
369
+
370
+
371
+
372
+
373
+
374
+ <td class="description last">The ID of the user account to delete.</td>
375
+ </tr>
376
+
377
+
378
+ </tbody>
379
+ </table>
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+ <h5 class="h5-returns">Returns:</h5>
397
+
398
+
399
+ <div class="param-desc">
400
+ - A promise that resolves with the anonymized user data or an HttpError if the request fails.
401
+ </div>
402
+
403
+
404
+
405
+ <dl class="param-type">
406
+ <dt>
407
+ Type
408
+ </dt>
409
+ <dd>
410
+
411
+ <span class="param-type">Promise.&lt;void></span>
412
+
413
+
414
+
415
+ </dd>
416
+ </dl>
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+ <h4 class="name" id="~numberOfActiveUsers"><span class="type-signature type-signature-async, inner">(async, inner) </span>numberOfActiveUsers<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;number>}</span></h4>
428
+
429
+
430
+
431
+
432
+
433
+
434
+ <dl class="details">
435
+
436
+ <dt class="tag-description">Description:</dt>
437
+ <dd class="tag-description"><ul class="dummy"><li>Calls a public API endpoint to get the number of active users.</li></ul></dd>
438
+
439
+
440
+
441
+ <dt class="tag-source">Source:</dt>
442
+ <dd class="tag-source"><ul class="dummy"><li>
443
+ <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line154">line 154</a>
444
+ </li></ul></dd>
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+ </dl>
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+ <h5 class="h5-throws">Throws:</h5>
503
+
504
+
505
+
506
+ <dl>
507
+ <dt>
508
+ <div class="param-desc usertext">
509
+ - Throws HttpError if the request fails.
510
+ </div>
511
+ </dt>
512
+ <dd></dd>
513
+ <dt>
514
+ <dl class="param-type">
515
+ <dt>
516
+ Type
517
+ </dt>
518
+ <dd>
519
+
520
+ <span class="param-type">HttpError</span>
521
+
522
+
523
+
524
+ </dd>
525
+ </dl>
526
+ </dt>
527
+ <dd></dd>
528
+ </dl>
529
+
530
+
531
+
532
+
533
+
534
+ <h5 class="h5-returns">Returns:</h5>
535
+
536
+
537
+ <div class="param-desc">
538
+ - A promise that resolves to the number of active users.
539
+ </div>
540
+
541
+
542
+
543
+ <dl class="param-type">
544
+ <dt>
545
+ Type
546
+ </dt>
547
+ <dd>
548
+
549
+ <span class="param-type">Promise.&lt;number></span>
550
+
551
+
552
+
553
+ </dd>
554
+ </dl>
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+ <h4 class="name" id="~requestEmailChange"><span class="type-signature type-signature-async, inner">(async, inner) </span>requestEmailChange<span class="signature">(email, password)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
566
+
567
+
568
+
569
+
570
+
571
+
572
+ <dl class="details">
573
+
574
+
575
+
576
+ <dt class="tag-source">Source:</dt>
577
+ <dd class="tag-source"><ul class="dummy"><li>
578
+ <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line121">line 121</a>
256
579
  </li></ul></dd>
257
580
 
258
581
 
@@ -385,6 +708,36 @@
385
708
 
386
709
 
387
710
 
711
+ <h5 class="h5-throws">Throws:</h5>
712
+
713
+
714
+
715
+ <dl>
716
+ <dt>
717
+ <div class="param-desc usertext">
718
+ - Throws HttpError if the request fails.
719
+ </div>
720
+ </dt>
721
+ <dd></dd>
722
+ <dt>
723
+ <dl class="param-type">
724
+ <dt>
725
+ Type
726
+ </dt>
727
+ <dd>
728
+
729
+ <span class="param-type">HttpError</span>
730
+
731
+
732
+
733
+ </dd>
734
+ </dl>
735
+ </dt>
736
+ <dd></dd>
737
+ </dl>
738
+
739
+
740
+
388
741
 
389
742
 
390
743
  <h5 class="h5-returns">Returns:</h5>
@@ -402,7 +755,7 @@
402
755
  </dt>
403
756
  <dd>
404
757
 
405
- <span class="param-type">Promise.&lt;(void|HttpError)></span>
758
+ <span class="param-type">Promise.&lt;void></span>
406
759
 
407
760
 
408
761
 
@@ -418,7 +771,7 @@
418
771
 
419
772
 
420
773
 
421
- <h4 class="name" id="~resetPassword"><span class="type-signature type-signature-async, inner">(async, inner) </span>resetPassword<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;(void|HttpError)>}</span></h4>
774
+ <h4 class="name" id="~resetPassword"><span class="type-signature type-signature-async, inner">(async, inner) </span>resetPassword<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
422
775
 
423
776
 
424
777
 
@@ -431,7 +784,7 @@
431
784
 
432
785
  <dt class="tag-source">Source:</dt>
433
786
  <dd class="tag-source"><ul class="dummy"><li>
434
- <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line73">line 73</a>
787
+ <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line97">line 97</a>
435
788
  </li></ul></dd>
436
789
 
437
790
 
@@ -665,6 +1018,36 @@
665
1018
 
666
1019
 
667
1020
 
1021
+ <h5 class="h5-throws">Throws:</h5>
1022
+
1023
+
1024
+
1025
+ <dl>
1026
+ <dt>
1027
+ <div class="param-desc usertext">
1028
+ - Throws an HttpError if the HTTP request fails.
1029
+ </div>
1030
+ </dt>
1031
+ <dd></dd>
1032
+ <dt>
1033
+ <dl class="param-type">
1034
+ <dt>
1035
+ Type
1036
+ </dt>
1037
+ <dd>
1038
+
1039
+ <span class="param-type">HttpError</span>
1040
+
1041
+
1042
+
1043
+ </dd>
1044
+ </dl>
1045
+ </dt>
1046
+ <dd></dd>
1047
+ </dl>
1048
+
1049
+
1050
+
668
1051
 
669
1052
 
670
1053
  <h5 class="h5-returns">Returns:</h5>
@@ -682,7 +1065,7 @@
682
1065
  </dt>
683
1066
  <dd>
684
1067
 
685
- <span class="param-type">Promise.&lt;(void|HttpError)></span>
1068
+ <span class="param-type">Promise.&lt;void></span>
686
1069
 
687
1070
 
688
1071
 
@@ -698,7 +1081,7 @@
698
1081
 
699
1082
 
700
1083
 
701
- <h4 class="name" id="~sendAccountSetupEmail"><span class="type-signature type-signature-async, inner">(async, inner) </span>sendAccountSetupEmail<span class="signature">(email)</span><span class="type-signature"> &rarr; {Promise.&lt;(void|HttpError)>}</span></h4>
1084
+ <h4 class="name" id="~sendAccountSetupEmail"><span class="type-signature type-signature-async, inner">(async, inner) </span>sendAccountSetupEmail<span class="signature">(email)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
702
1085
 
703
1086
 
704
1087
 
@@ -711,7 +1094,7 @@
711
1094
 
712
1095
  <dt class="tag-source">Source:</dt>
713
1096
  <dd class="tag-source"><ul class="dummy"><li>
714
- <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line27">line 27</a>
1097
+ <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line22">line 22</a>
715
1098
  </li></ul></dd>
716
1099
 
717
1100
 
@@ -820,6 +1203,36 @@
820
1203
 
821
1204
 
822
1205
 
1206
+ <h5 class="h5-throws">Throws:</h5>
1207
+
1208
+
1209
+
1210
+ <dl>
1211
+ <dt>
1212
+ <div class="param-desc usertext">
1213
+ - Throws HttpError if the request fails.
1214
+ </div>
1215
+ </dt>
1216
+ <dd></dd>
1217
+ <dt>
1218
+ <dl class="param-type">
1219
+ <dt>
1220
+ Type
1221
+ </dt>
1222
+ <dd>
1223
+
1224
+ <span class="param-type">HttpError</span>
1225
+
1226
+
1227
+
1228
+ </dd>
1229
+ </dl>
1230
+ </dt>
1231
+ <dd></dd>
1232
+ </dl>
1233
+
1234
+
1235
+
823
1236
 
824
1237
 
825
1238
  <h5 class="h5-returns">Returns:</h5>
@@ -837,7 +1250,7 @@
837
1250
  </dt>
838
1251
  <dd>
839
1252
 
840
- <span class="param-type">Promise.&lt;(void|HttpError)></span>
1253
+ <span class="param-type">Promise.&lt;void></span>
841
1254
 
842
1255
 
843
1256
 
@@ -853,7 +1266,7 @@
853
1266
 
854
1267
 
855
1268
 
856
- <h4 class="name" id="~sendPasswordResetEmail"><span class="type-signature type-signature-async, inner">(async, inner) </span>sendPasswordResetEmail<span class="signature">(email)</span><span class="type-signature"> &rarr; {Promise.&lt;(void|HttpError)>}</span></h4>
1269
+ <h4 class="name" id="~sendPasswordResetEmail"><span class="type-signature type-signature-async, inner">(async, inner) </span>sendPasswordResetEmail<span class="signature">(email)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
857
1270
 
858
1271
 
859
1272
 
@@ -866,7 +1279,7 @@
866
1279
 
867
1280
  <dt class="tag-source">Source:</dt>
868
1281
  <dd class="tag-source"><ul class="dummy"><li>
869
- <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line62">line 62</a>
1282
+ <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line79">line 79</a>
870
1283
  </li></ul></dd>
871
1284
 
872
1285
 
@@ -975,6 +1388,36 @@
975
1388
 
976
1389
 
977
1390
 
1391
+ <h5 class="h5-throws">Throws:</h5>
1392
+
1393
+
1394
+
1395
+ <dl>
1396
+ <dt>
1397
+ <div class="param-desc usertext">
1398
+ - Throws HttpError if the request fails.
1399
+ </div>
1400
+ </dt>
1401
+ <dd></dd>
1402
+ <dt>
1403
+ <dl class="param-type">
1404
+ <dt>
1405
+ Type
1406
+ </dt>
1407
+ <dd>
1408
+
1409
+ <span class="param-type">HttpError</span>
1410
+
1411
+
1412
+
1413
+ </dd>
1414
+ </dl>
1415
+ </dt>
1416
+ <dd></dd>
1417
+ </dl>
1418
+
1419
+
1420
+
978
1421
 
979
1422
 
980
1423
  <h5 class="h5-returns">Returns:</h5>
@@ -992,7 +1435,7 @@
992
1435
  </dt>
993
1436
  <dd>
994
1437
 
995
- <span class="param-type">Promise.&lt;(void|HttpError)></span>
1438
+ <span class="param-type">Promise.&lt;void></span>
996
1439
 
997
1440
 
998
1441
 
@@ -1008,7 +1451,7 @@
1008
1451
 
1009
1452
 
1010
1453
 
1011
- <h4 class="name" id="~setupAccount"><span class="type-signature type-signature-async, inner">(async, inner) </span>setupAccount<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;(void|HttpError)>}</span></h4>
1454
+ <h4 class="name" id="~setupAccount"><span class="type-signature type-signature-async, inner">(async, inner) </span>setupAccount<span class="signature">(props)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1012
1455
 
1013
1456
 
1014
1457
 
@@ -1021,7 +1464,7 @@
1021
1464
 
1022
1465
  <dt class="tag-source">Source:</dt>
1023
1466
  <dd class="tag-source"><ul class="dummy"><li>
1024
- <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line39">line 39</a>
1467
+ <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line44">line 44</a>
1025
1468
  </li></ul></dd>
1026
1469
 
1027
1470
 
@@ -1072,6 +1515,8 @@
1072
1515
  <th>Type</th>
1073
1516
 
1074
1517
 
1518
+ <th>Attributes</th>
1519
+
1075
1520
 
1076
1521
 
1077
1522
 
@@ -1098,6 +1543,12 @@
1098
1543
  </td>
1099
1544
 
1100
1545
 
1546
+ <td class="attributes">
1547
+
1548
+
1549
+
1550
+ </td>
1551
+
1101
1552
 
1102
1553
 
1103
1554
 
@@ -1122,6 +1573,12 @@
1122
1573
  </td>
1123
1574
 
1124
1575
 
1576
+ <td class="attributes">
1577
+
1578
+
1579
+
1580
+ </td>
1581
+
1125
1582
 
1126
1583
 
1127
1584
 
@@ -1146,6 +1603,12 @@
1146
1603
  </td>
1147
1604
 
1148
1605
 
1606
+ <td class="attributes">
1607
+
1608
+
1609
+
1610
+ </td>
1611
+
1149
1612
 
1150
1613
 
1151
1614
 
@@ -1170,10 +1633,82 @@
1170
1633
  </td>
1171
1634
 
1172
1635
 
1636
+ <td class="attributes">
1637
+
1638
+ &lt;optional><br>
1639
+
1173
1640
 
1641
+
1642
+ </td>
1174
1643
 
1175
1644
 
1176
- <td class="description last">The token sent to the user's email for verification.</td>
1645
+
1646
+
1647
+ <td class="description last">The token sent to the user's email for verification. Required for web requests</td>
1648
+ </tr>
1649
+
1650
+
1651
+
1652
+ <tr>
1653
+
1654
+ <td class="name"><code>revenuecatAppUserId</code></td>
1655
+
1656
+
1657
+ <td class="type">
1658
+
1659
+
1660
+ <span class="param-type">string</span>
1661
+
1662
+
1663
+
1664
+
1665
+ </td>
1666
+
1667
+
1668
+ <td class="attributes">
1669
+
1670
+ &lt;optional><br>
1671
+
1672
+
1673
+
1674
+ </td>
1675
+
1676
+
1677
+
1678
+
1679
+ <td class="description last">The RevenueCat App User ID for MA environments. Required for MA requests</td>
1680
+ </tr>
1681
+
1682
+
1683
+
1684
+ <tr>
1685
+
1686
+ <td class="name"><code>deviceName</code></td>
1687
+
1688
+
1689
+ <td class="type">
1690
+
1691
+
1692
+ <span class="param-type">string</span>
1693
+
1694
+
1695
+
1696
+
1697
+ </td>
1698
+
1699
+
1700
+ <td class="attributes">
1701
+
1702
+ &lt;optional><br>
1703
+
1704
+
1705
+
1706
+ </td>
1707
+
1708
+
1709
+
1710
+
1711
+ <td class="description last">The device name for MA environments. Required for MA requests</td>
1177
1712
  </tr>
1178
1713
 
1179
1714
 
@@ -1218,7 +1753,7 @@
1218
1753
 
1219
1754
  <tr>
1220
1755
 
1221
- <td class="name"><code>params</code></td>
1756
+ <td class="name"><code>props</code></td>
1222
1757
 
1223
1758
 
1224
1759
  <td class="type">
@@ -1255,6 +1790,64 @@
1255
1790
 
1256
1791
 
1257
1792
 
1793
+ <h5 class="h5-throws">Throws:</h5>
1794
+ <ul>
1795
+ <li>
1796
+
1797
+ <dl>
1798
+ <dt>
1799
+ <div class="param-desc usertext">
1800
+ - Throws an error if required parameters are missing based on the environment.
1801
+ </div>
1802
+ </dt>
1803
+ <dd></dd>
1804
+ <dt>
1805
+ <dl class="param-type">
1806
+ <dt>
1807
+ Type
1808
+ </dt>
1809
+ <dd>
1810
+
1811
+ <span class="param-type">Error</span>
1812
+
1813
+
1814
+
1815
+ </dd>
1816
+ </dl>
1817
+ </dt>
1818
+ <dd></dd>
1819
+ </dl>
1820
+
1821
+ </li>
1822
+
1823
+ <li>
1824
+
1825
+ <dl>
1826
+ <dt>
1827
+ <div class="param-desc usertext">
1828
+ - Throws an HttpError if the HTTP request fails.
1829
+ </div>
1830
+ </dt>
1831
+ <dd></dd>
1832
+ <dt>
1833
+ <dl class="param-type">
1834
+ <dt>
1835
+ Type
1836
+ </dt>
1837
+ <dd>
1838
+
1839
+ <span class="param-type">HttpError</span>
1840
+
1841
+
1842
+
1843
+ </dd>
1844
+ </dl>
1845
+ </dt>
1846
+ <dd></dd>
1847
+ </dl>
1848
+
1849
+ </li>
1850
+ </ul>
1258
1851
 
1259
1852
 
1260
1853
  <h5 class="h5-returns">Returns:</h5>
@@ -1272,7 +1865,7 @@
1272
1865
  </dt>
1273
1866
  <dd>
1274
1867
 
1275
- <span class="param-type">Promise.&lt;(void|HttpError)></span>
1868
+ <span class="param-type">Promise.&lt;void></span>
1276
1869
 
1277
1870
 
1278
1871
 
@@ -1288,7 +1881,7 @@
1288
1881
 
1289
1882
 
1290
1883
 
1291
- <h4 class="name" id="~status"><span class="type-signature type-signature-async, inner">(async, inner) </span>status<span class="signature">(email)</span><span class="type-signature"> &rarr; {Promise.&lt;({requires_setup: boolean}|HttpError)>}</span></h4>
1884
+ <h4 class="name" id="~status"><span class="type-signature type-signature-async, inner">(async, inner) </span>status<span class="signature">(email)</span><span class="type-signature"> &rarr; {Promise.&lt;{requires_setup: boolean}>}</span></h4>
1292
1885
 
1293
1886
 
1294
1887
 
@@ -1301,7 +1894,7 @@
1301
1894
 
1302
1895
  <dt class="tag-source">Source:</dt>
1303
1896
  <dd class="tag-source"><ul class="dummy"><li>
1304
- <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line15">line 15</a>
1897
+ <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line8">line 8</a>
1305
1898
  </li></ul></dd>
1306
1899
 
1307
1900
 
@@ -1410,6 +2003,36 @@
1410
2003
 
1411
2004
 
1412
2005
 
2006
+ <h5 class="h5-throws">Throws:</h5>
2007
+
2008
+
2009
+
2010
+ <dl>
2011
+ <dt>
2012
+ <div class="param-desc usertext">
2013
+ - Throws HttpError if the request fails.
2014
+ </div>
2015
+ </dt>
2016
+ <dd></dd>
2017
+ <dt>
2018
+ <dl class="param-type">
2019
+ <dt>
2020
+ Type
2021
+ </dt>
2022
+ <dd>
2023
+
2024
+ <span class="param-type">HttpError</span>
2025
+
2026
+
2027
+
2028
+ </dd>
2029
+ </dl>
2030
+ </dt>
2031
+ <dd></dd>
2032
+ </dl>
2033
+
2034
+
2035
+
1413
2036
 
1414
2037
 
1415
2038
  <h5 class="h5-returns">Returns:</h5>
@@ -1427,7 +2050,7 @@
1427
2050
  </dt>
1428
2051
  <dd>
1429
2052
 
1430
- <span class="param-type">Promise.&lt;({requires_setup: boolean}|HttpError)></span>
2053
+ <span class="param-type">Promise.&lt;{requires_setup: boolean}></span>
1431
2054
 
1432
2055
 
1433
2056
 
@@ -1458,7 +2081,7 @@
1458
2081
  <br class="clear">
1459
2082
 
1460
2083
  <footer>
1461
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Oct 02 2025 11:46:05 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2084
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Nov 10 2025 16:22:45 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1462
2085
  </footer>
1463
2086
 
1464
2087
  <script>prettyPrint();</script>