npm - musora-content-services - Versions diffs - 1.6.7 → 1.6.9 - Mend

musora-content-services 1.6.7 → 1.6.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (150) hide show

package/.github/workflows/conventional-commits.yaml +0 -0
package/.github/workflows/docs.js.yml +0 -0
package/.github/workflows/sync-docs.yml +0 -0
package/CHANGELOG.md +4 -0
package/README.md +0 -0
package/docs/algolia.js.html +0 -0
package/docs/config.js.html +0 -0
package/docs/index.html +0 -0
package/docs/module-Config.html +0 -0
package/docs/module-Railcontent-Services.html +0 -0
package/docs/module-Sanity-Services.html +0 -0
package/docs/module-Search-Engine-Services.html +0 -0
package/docs/railcontent.js.html +0 -0
package/docs/sanity.js.html +0 -0
package/docs/v2/ContentOrganization.html +2 -2
package/docs/v2/Forums.html +269 -0
package/docs/v2/Gamification.html +2 -2
package/docs/v2/TestUser.html +260 -0
package/docs/v2/UserManagementSystem.html +2 -2
package/docs/v2/api_types.js.html +2 -2
package/docs/v2/config.js.html +2 -8
package/docs/v2/content-org_content-org.js.html +2 -2
package/docs/v2/content-org_guided-courses.ts.html +110 -0
package/docs/v2/content-org_learning-paths.ts.html +123 -0
package/docs/v2/content-org_playlists-types.js.html +14 -2
package/docs/v2/content-org_playlists.js.html +39 -17
package/docs/v2/content.js.html +111 -52
package/docs/v2/fonts/Montserrat/Montserrat-Bold.eot +0 -0
package/docs/v2/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff +0 -0
package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
package/docs/v2/fonts/Montserrat/Montserrat-Regular.eot +0 -0
package/docs/v2/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff +0 -0
package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
package/docs/v2/forums_categories.ts.html +137 -0
package/docs/v2/forums_discussions.js.html +95 -0
package/docs/v2/forums_forum.js.html +95 -0
package/docs/v2/forums_forums.ts.html +160 -0
package/docs/v2/forums_posts.ts.html +258 -0
package/docs/v2/forums_threads.ts.html +271 -0
package/docs/v2/gamification_awards.js.html +35 -534
package/docs/v2/gamification_awards.ts.html +181 -0
package/docs/v2/gamification_gamification.js.html +2 -2
package/docs/v2/gamification_types.js.html +7 -25
package/docs/v2/global.html +849 -690
package/docs/v2/index.html +2 -3
package/docs/v2/liveTesting.ts.html +102 -0
package/docs/v2/module-Accounts.html +2094 -0
package/docs/v2/module-Awards.html +396 -14
package/docs/v2/module-Categories.html +711 -0
package/docs/v2/module-Config.html +4 -8
package/docs/v2/module-Content-Services-V2.html +182 -49
package/docs/v2/module-ForumCategories.html +687 -0
package/docs/v2/module-ForumDiscussions.html +370 -0
package/docs/v2/module-Forums.html +15393 -0
package/docs/v2/module-GuidedCourses.html +1304 -0
package/docs/v2/module-Interests.html +2 -2
package/docs/v2/module-Onboarding.html +670 -0
package/docs/v2/module-Payments.html +250 -0
package/docs/v2/module-Permissions.html +2 -2
package/docs/v2/module-Playlists.html +212 -44
package/docs/v2/module-Railcontent-Services.html +689 -2175
package/docs/v2/module-Sanity-Services.html +480 -925
package/docs/v2/module-Sessions.html +3 -3
package/docs/v2/module-Threads.html +1119 -0
package/docs/v2/module-UserActivity.html +193 -23
package/docs/v2/module-UserChat.html +410 -0
package/docs/v2/module-UserManagement.html +1028 -11
package/docs/v2/module-UserMemberships.html +829 -0
package/docs/v2/module-UserNotifications.html +1399 -27
package/docs/v2/module-UserProfile.html +106 -2
package/docs/v2/railcontent.js.html +87 -236
package/docs/v2/sanity.js.html +342 -415
package/docs/v2/scripts/collapse.js +0 -0
package/docs/v2/scripts/commonNav.js +0 -0
package/docs/v2/scripts/linenumber.js +0 -0
package/docs/v2/scripts/nav.js +0 -0
package/docs/v2/scripts/polyfill.js +0 -0
package/docs/v2/scripts/prettify/Apache-License-2.0.txt +0 -0
package/docs/v2/scripts/prettify/lang-css.js +0 -0
package/docs/v2/scripts/prettify/prettify.js +0 -0
package/docs/v2/scripts/search.js +0 -0
package/docs/v2/styles/jsdoc.css +0 -0
package/docs/v2/styles/prettify.css +0 -0
package/docs/v2/userActivity.js.html +532 -451
package/docs/v2/user_account.ts.html +237 -0
package/docs/v2/user_chat.js.html +98 -0
package/docs/v2/user_interests.js.html +2 -2
package/docs/v2/user_management.js.html +82 -2
package/docs/v2/user_memberships.js.html +144 -0
package/docs/v2/user_memberships.ts.html +292 -0
package/docs/v2/user_notifications.js.html +203 -21
package/docs/v2/user_onboarding.ts.html +183 -0
package/docs/v2/user_payments.ts.html +97 -0
package/docs/v2/user_permissions.js.html +2 -2
package/docs/v2/user_profile.js.html +12 -2
package/docs/v2/user_sessions.js.html +33 -2
package/docs/v2/user_types.js.html +16 -2
package/docs/v2/user_user-management-system.js.html +2 -2
package/jsdoc.json +0 -0
package/link_mcs.sh +0 -0
package/package.json +1 -1
package/src/contentMetaData.js +0 -0
package/src/contentTypeConfig.js +3 -3
package/src/filterBuilder.js +0 -0
package/src/index.d.ts +0 -0
package/src/index.js +0 -0
package/src/services/algolia.js +0 -0
package/src/services/config.js +0 -0
package/src/services/contentLikes.js +0 -0
package/src/services/contentProgress.js +0 -0
package/src/services/dataContext.js +0 -0
package/src/services/imageSRCBuilder.js +1 -1
package/src/services/imageSRCVerify.js +1 -1
package/src/services/lastUpdated.js +0 -0
package/src/services/railcontent.js +0 -0
package/src/services/recommendations.js +0 -0
package/src/services/userPermissions.js +0 -0
package/test/config.test.js +0 -0
package/test/contentLikes.test.js +0 -0
package/test/contentProgress.test.js +0 -0
package/test/imageSRCBuilder.test.js +1 -1
package/test/imageSRCVerify.test.js +4 -4
package/test/initializeTests.js +0 -0
package/test/lastUpdated.test.js +0 -0
package/test/sanityQueryService.test.js +0 -0
package/test/userPermissions.test.js +0 -0
package/tools/generate-index.cjs +0 -0
package/.yarnrc.yml +0 -1
package/docs/v2/Content-Organization.html +0 -245
package/docs/v2/UserManagement.html +0 -269
package/docs/v2/global.html#User +0 -293
package/docs/v2/module-Notifications.html +0 -1183
package/docs/v2/module-Session-Management.html +0 -575
package/docs/v2/module-User-Activity.html +0 -4410
package/docs/v2/module-User-Management.html +0 -490
package/docs/v2/module-User-Permissions.html +0 -406
package/docs/v2/types.js.html +0 -122
package/docs/v2/user_user-management.js.html +0 -78

package/docs/v2/module-Accounts.html ADDED Viewed

@@ -0,0 +1,2094 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Accounts - 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></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getLegacyMethods">getLegacyMethods</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~jumpToPost">jumpToPost</a></li><li data-type='method'><a href="module-Forums.html#~likePost">likePost</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~search">search</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlikePost">unlikePost</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updatePost">updatePost</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a><ul class='methods'><li data-type='method'><a href="module-GuidedCourses.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-GuidedCourses.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-GuidedCourses.html#~updateActivePath">updateActivePath</a></li><li data-type='method'><a href="module-GuidedCourses.html#~updateDailySession">updateDailySession</a></li></ul></li><li></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
+</nav>
+<div id="main">
+    <h1 class="page-title">Accounts</h1>
+<section>
+<header>
+</header>
+<article>
+        <div class="container-overview">
+        </div>
+        <h3 class="subsection-title">Methods</h3>
+    <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>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line133">line 133</a>
+    </li></ul></dd>
+</dl>
+    <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>token</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The token sent to the user's email for verification.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws HttpError if the request fails.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">HttpError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when the email change is confirmed.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;void></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line144">line 144</a>
+    </li></ul></dd>
+</dl>
+    <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>userId</code></td>
+            <td class="type">
+<span class="param-type">number</span>
+            </td>
+            <td class="description last">The ID of the user account to delete.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves with the anonymized user data or an HttpError if the request fails.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;void></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li>Calls a public API endpoint to get the number of active users.</li></ul></dd>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line154">line 154</a>
+    </li></ul></dd>
+</dl>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws HttpError if the request fails.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">HttpError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves to the number of active users.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;number></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line121">line 121</a>
+    </li></ul></dd>
+</dl>
+    <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>email</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The new email address to set for the user.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>password</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The current password of the user for verification.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws HttpError if the request fails.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">HttpError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when the email change request is made.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;void></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line97">line 97</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="subsection-title">Properties:</h5>
+<table class="props">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>email</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The email address for the account.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>password</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The new password for the account.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>passwordConfirmation</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The confirmation of the new password.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>token</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The token sent to the user's email for verification.</td>
+        </tr>
+    </tbody>
+</table>
+    <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>params</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">The parameters for resetting the password.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws an HttpError if the HTTP request fails.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">HttpError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when the password reset is complete or an HttpError if the request fails.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;void></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line22">line 22</a>
+    </li></ul></dd>
+</dl>
+    <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>email</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The email address to send the account setup email to.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws HttpError if the request fails.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">HttpError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when the email is sent or an HttpError if the request fails.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;void></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line79">line 79</a>
+    </li></ul></dd>
+</dl>
+    <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>email</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The email address to send the password reset email to.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws HttpError if the request fails.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">HttpError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when the email change request is made.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;void></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line44">line 44</a>
+    </li></ul></dd>
+</dl>
+    <h5 class="subsection-title">Properties:</h5>
+<table class="props">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Attributes</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>email</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+            <td class="description last">The email address for the account.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>password</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+            <td class="description last">The new password for the account.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>passwordConfirmation</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                </td>
+            <td class="description last">The confirmation of the new password.</td>
+        </tr>
+        <tr>
+                <td class="name"><code>token</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">The token sent to the user's email for verification. Required for web requests</td>
+        </tr>
+        <tr>
+                <td class="name"><code>revenuecatAppUserId</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">The RevenueCat App User ID for MA environments. Required for MA requests</td>
+        </tr>
+        <tr>
+                <td class="name"><code>deviceName</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+                <td class="attributes">
+                    &lt;optional><br>
+                </td>
+            <td class="description last">The device name for MA environments. Required for MA requests</td>
+        </tr>
+    </tbody>
+</table>
+    <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>props</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">The parameters for setting up the account.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<ul>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws an error if required parameters are missing based on the environment.
+        </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>
+</li>
+        <li>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws an HttpError if the HTTP request fails.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">HttpError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+</li>
+    </ul>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves when the account setup is complete or an HttpError if the request fails.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;void></span>
+    </dd>
+</dl>
+    <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>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="user_account.ts.html">user/account.ts</a>, <a href="user_account.ts.html#line8">line 8</a>
+    </li></ul></dd>
+</dl>
+    <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>email</code></td>
+            <td class="type">
+<span class="param-type">string</span>
+            </td>
+            <td class="description last">The email address to check the account status for.</td>
+        </tr>
+    </tbody>
+</table>
+<h5 class="h5-throws">Throws:</h5>
+<dl>
+    <dt>
+        <div class="param-desc usertext">
+        - Throws HttpError if the request fails.
+        </div>
+    </dt>
+    <dd></dd>
+    <dt>
+        <dl class="param-type">
+            <dt>
+                Type
+            </dt>
+            <dd>
+<span class="param-type">HttpError</span>
+            </dd>
+        </dl>
+    </dt>
+    <dd></dd>
+</dl>
+<h5 class="h5-returns">Returns:</h5>
+<div class="param-desc">
+    - A promise that resolves to an object indicating whether account setup is required, or an HttpError if the request fails.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Promise.&lt;{requires_setup: boolean}></span>
+    </dd>
+</dl>
+</article>
+</section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Nov 04 2025 18:21:55 GMT+0000 (Coordinated Universal 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>