musora-content-services 2.92.3 → 2.92.7

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 (121) hide show
  1. package/.github/workflows/docs.js.yml +64 -47
  2. package/CHANGELOG.md +23 -0
  3. package/package.json +1 -1
  4. package/src/index.d.ts +2 -0
  5. package/src/index.js +2 -0
  6. package/src/lib/brands.ts +7 -7
  7. package/src/services/content/artist.ts +10 -7
  8. package/src/services/content/genre.ts +10 -7
  9. package/src/services/content/instructor.ts +7 -7
  10. package/src/services/content-org/learning-paths.ts +3 -3
  11. package/src/services/progress-row/method-card.js +1 -1
  12. package/src/services/reporting/reporting.ts +19 -15
  13. package/src/services/sync/fetch.ts +3 -0
  14. package/src/services/user/onboarding.ts +3 -3
  15. package/docs/Content.html +0 -269
  16. package/docs/ContentOrganization.html +0 -245
  17. package/docs/Forums.html +0 -269
  18. package/docs/Gamification.html +0 -245
  19. package/docs/TestUser.html +0 -260
  20. package/docs/UserManagementSystem.html +0 -317
  21. package/docs/api_types.js.html +0 -97
  22. package/docs/config.js.html +0 -140
  23. package/docs/content-org_content-org.js.html +0 -76
  24. package/docs/content-org_guided-courses.ts.html +0 -110
  25. package/docs/content-org_learning-paths.ts.html +0 -391
  26. package/docs/content-org_playlists-types.js.html +0 -128
  27. package/docs/content-org_playlists.js.html +0 -440
  28. package/docs/content.js.html +0 -603
  29. package/docs/content_artist.ts.html +0 -206
  30. package/docs/content_content.ts.html +0 -77
  31. package/docs/content_genre.ts.html +0 -209
  32. package/docs/content_instructor.ts.html +0 -206
  33. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  34. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  35. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  36. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  37. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  38. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  39. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  40. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  41. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  42. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -978
  43. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  44. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  45. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  46. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  47. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -1049
  48. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  49. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  50. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  51. package/docs/forums_categories.ts.html +0 -156
  52. package/docs/forums_discussions.js.html +0 -95
  53. package/docs/forums_forum.js.html +0 -95
  54. package/docs/forums_forums.ts.html +0 -160
  55. package/docs/forums_posts.ts.html +0 -284
  56. package/docs/forums_threads.ts.html +0 -284
  57. package/docs/gamification_awards.js.html +0 -165
  58. package/docs/gamification_awards.ts.html +0 -195
  59. package/docs/gamification_gamification.js.html +0 -76
  60. package/docs/gamification_types.js.html +0 -80
  61. package/docs/global.html +0 -6019
  62. package/docs/index.html +0 -167
  63. package/docs/liveTesting.ts.html +0 -103
  64. package/docs/module-Accounts.html +0 -2283
  65. package/docs/module-Artist.html +0 -993
  66. package/docs/module-Awards.html +0 -836
  67. package/docs/module-Categories.html +0 -711
  68. package/docs/module-Config.html +0 -431
  69. package/docs/module-Content-Services-V2.html +0 -2998
  70. package/docs/module-ForumCategories.html +0 -687
  71. package/docs/module-ForumDiscussions.html +0 -370
  72. package/docs/module-Forums.html +0 -16599
  73. package/docs/module-Genre.html +0 -981
  74. package/docs/module-GuidedCourses.html +0 -108
  75. package/docs/module-Instructor.html +0 -929
  76. package/docs/module-Interests.html +0 -1066
  77. package/docs/module-LearningPaths.html +0 -2424
  78. package/docs/module-Onboarding.html +0 -882
  79. package/docs/module-Payments.html +0 -392
  80. package/docs/module-Permissions.html +0 -406
  81. package/docs/module-Playlists.html +0 -3030
  82. package/docs/module-ProgressRow.html +0 -108
  83. package/docs/module-Railcontent-Services.html +0 -5876
  84. package/docs/module-Sanity-Services.html +0 -8244
  85. package/docs/module-Sessions.html +0 -575
  86. package/docs/module-Threads.html +0 -1119
  87. package/docs/module-UserActivity.html +0 -4534
  88. package/docs/module-UserChat.html +0 -410
  89. package/docs/module-UserManagement.html +0 -1932
  90. package/docs/module-UserMemberships.html +0 -829
  91. package/docs/module-UserNotifications.html +0 -2595
  92. package/docs/module-UserProfile.html +0 -370
  93. package/docs/progress-row_method-card.js.html +0 -184
  94. package/docs/railcontent.js.html +0 -724
  95. package/docs/sanity.js.html +0 -2322
  96. package/docs/scripts/collapse.js +0 -39
  97. package/docs/scripts/commonNav.js +0 -28
  98. package/docs/scripts/linenumber.js +0 -25
  99. package/docs/scripts/nav.js +0 -12
  100. package/docs/scripts/polyfill.js +0 -4
  101. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
  102. package/docs/scripts/prettify/lang-css.js +0 -2
  103. package/docs/scripts/prettify/prettify.js +0 -28
  104. package/docs/scripts/search.js +0 -99
  105. package/docs/styles/jsdoc.css +0 -776
  106. package/docs/styles/prettify.css +0 -80
  107. package/docs/userActivity.js.html +0 -1512
  108. package/docs/user_account.ts.html +0 -265
  109. package/docs/user_chat.js.html +0 -98
  110. package/docs/user_interests.js.html +0 -150
  111. package/docs/user_management.js.html +0 -258
  112. package/docs/user_memberships.js.html +0 -144
  113. package/docs/user_memberships.ts.html +0 -292
  114. package/docs/user_notifications.js.html +0 -374
  115. package/docs/user_onboarding.ts.html +0 -329
  116. package/docs/user_payments.ts.html +0 -146
  117. package/docs/user_permissions.js.html +0 -110
  118. package/docs/user_profile.js.html +0 -115
  119. package/docs/user_sessions.js.html +0 -170
  120. package/docs/user_types.js.html +0 -224
  121. package/docs/user_user-management-system.js.html +0 -79
@@ -1,2998 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>Content-Services-V2 - Documentation</title>
7
-
8
-
9
- <script src="scripts/prettify/prettify.js"></script>
10
- <script src="scripts/prettify/lang-css.js"></script>
11
- <!--[if lt IE 9]>
12
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
- <![endif]-->
14
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
- <script src="scripts/nav.js" defer></script>
17
-
18
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
- </head>
20
- <body>
21
-
22
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
- <label for="nav-trigger" class="navicon-button x">
24
- <div class="navicon"></div>
25
- </label>
26
-
27
- <label for="nav-trigger" class="overlay"></label>
28
-
29
- <nav >
30
-
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#~deleteAccount">deleteAccount</a></li><li data-type='method'><a href="module-Accounts.html#~numberOfActiveUsers">numberOfActiveUsers</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li><li data-type='method'><a href="module-Accounts.html#~toggleStudentView">toggleStudentView</a></li></ul></li><li><a href="module-Artist.html">Artist</a><ul class='methods'><li data-type='method'><a href="module-Artist.html#~fetchArtistBySlug">fetchArtistBySlug</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtists">fetchArtists</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getLegacyMethods">getLegacyMethods</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getOwnedContent">getOwnedContent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deleteForumCategory">deleteForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~jumpToPost">jumpToPost</a></li><li data-type='method'><a href="module-Forums.html#~likePost">likePost</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~markThreadAsRead">markThreadAsRead</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~search">search</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlikePost">unlikePost</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updatePost">updatePost</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-Genre.html">Genre</a><ul class='methods'><li data-type='method'><a href="module-Genre.html#~fetchGenreBySlug">fetchGenreBySlug</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenres">fetchGenres</a></li></ul></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Instructor.html">Instructor</a><ul class='methods'><li data-type='method'><a href="module-Instructor.html#~fetchInstructorBySlug">fetchInstructorBySlug</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructorLessons">fetchInstructorLessons</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructors">fetchInstructors</a></li></ul></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-LearningPaths.html">LearningPaths</a><ul class='methods'><li data-type='method'><a href="module-LearningPaths.html#~completeLearningPathIntroVideo">completeLearningPathIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~completeMethodIntroVideo">completeMethodIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathLessons">fetchLearningPathLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathProgressCheckLessons">fetchLearningPathProgressCheckLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-LearningPaths.html#~getEnrichedLearningPath">getEnrichedLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getLearningPathLessonsByIds">getLearningPathLessonsByIds</a></li><li data-type='method'><a href="module-LearningPaths.html#~mapContentToParent">mapContentToParent</a></li><li data-type='method'><a href="module-LearningPaths.html#~resetAllLearningPaths">resetAllLearningPaths</a></li><li data-type='method'><a href="module-LearningPaths.html#~startLearningPath">startLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateDailySession">updateDailySession</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~getOnboardingRecommendedContent">getOnboardingRecommendedContent</a></li><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-ProgressRow.html">ProgressRow</a></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2StructureFromId">fetchMethodV2StructureFromId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOwnedContent">fetchOwnedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchTopLevelParentId">fetchTopLevelParentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
33
-
34
- </nav>
35
-
36
- <div id="main">
37
-
38
- <h1 class="page-title">Content-Services-V2</h1>
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
- <section>
47
-
48
- <header>
49
-
50
-
51
-
52
- </header>
53
-
54
- <article>
55
-
56
- <div class="container-overview">
57
-
58
-
59
-
60
-
61
-
62
- </div>
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
- <h3 class="subsection-title">Methods</h3>
81
-
82
-
83
-
84
-
85
-
86
-
87
- <h4 class="name" id=".getContentRows"><span class="type-signature type-signature-static">(static) </span>getContentRows<span class="signature">(brand, pageName, contentRowSlug, params)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
88
-
89
-
90
-
91
-
92
-
93
-
94
- <dl class="details">
95
-
96
- <dt class="tag-description">Description:</dt>
97
- <dd class="tag-description"><ul class="dummy"><li>Fetches content rows for a given brand and page with optional filtering by content row slug.</li></ul></dd>
98
-
99
-
100
-
101
- <dt class="tag-source">Source:</dt>
102
- <dd class="tag-source"><ul class="dummy"><li>
103
- <a href="content.js.html">content.js</a>, <a href="content.js.html#line219">line 219</a>
104
- </li></ul></dd>
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
- </dl>
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
- <h5 class="h5-examples">Example</h5>
149
-
150
- <pre class="prettyprint"><code>getContentRows('drumeo', 'lessons', 'Your-Daily-Warmup', {
151
- page: 1,
152
- limit: 5
153
- })
154
- .then(content => console.log(content))
155
- .catch(error => console.error(error));</code></pre>
156
-
157
-
158
-
159
-
160
- <h5 class="h5-parameters">Parameters:</h5>
161
-
162
-
163
- <table class="params">
164
- <thead>
165
- <tr>
166
-
167
- <th>Name</th>
168
-
169
-
170
- <th>Type</th>
171
-
172
-
173
-
174
-
175
-
176
- <th class="last">Description</th>
177
- </tr>
178
- </thead>
179
-
180
- <tbody>
181
-
182
-
183
- <tr>
184
-
185
- <td class="name"><code>brand</code></td>
186
-
187
-
188
- <td class="type">
189
-
190
-
191
- <span class="param-type">string</span>
192
-
193
-
194
-
195
-
196
- </td>
197
-
198
-
199
-
200
-
201
-
202
- <td class="description last">The brand for which to fetch content rows.</td>
203
- </tr>
204
-
205
-
206
-
207
- <tr>
208
-
209
- <td class="name"><code>pageName</code></td>
210
-
211
-
212
- <td class="type">
213
-
214
-
215
- <span class="param-type">string</span>
216
-
217
-
218
-
219
-
220
- </td>
221
-
222
-
223
-
224
-
225
-
226
- <td class="description last">The page name (e.g., 'lessons', 'songs').</td>
227
- </tr>
228
-
229
-
230
-
231
- <tr>
232
-
233
- <td class="name"><code>contentRowSlug</code></td>
234
-
235
-
236
- <td class="type">
237
-
238
-
239
- <span class="param-type">string</span>
240
- |
241
-
242
- <span class="param-type">null</span>
243
-
244
-
245
-
246
-
247
- </td>
248
-
249
-
250
-
251
-
252
-
253
- <td class="description last">The specific content row ID to fetch.</td>
254
- </tr>
255
-
256
-
257
-
258
- <tr>
259
-
260
- <td class="name"><code>params</code></td>
261
-
262
-
263
- <td class="type">
264
-
265
-
266
- <span class="param-type">Object</span>
267
-
268
-
269
-
270
-
271
- </td>
272
-
273
-
274
-
275
-
276
-
277
- <td class="description last">Parameters for pagination.
278
- <h6>Properties</h6>
279
-
280
-
281
- <table class="params">
282
- <thead>
283
- <tr>
284
-
285
- <th>Name</th>
286
-
287
-
288
- <th>Type</th>
289
-
290
-
291
- <th>Attributes</th>
292
-
293
-
294
-
295
- <th>Default</th>
296
-
297
-
298
- <th class="last">Description</th>
299
- </tr>
300
- </thead>
301
-
302
- <tbody>
303
-
304
-
305
- <tr>
306
-
307
- <td class="name"><code>page</code></td>
308
-
309
-
310
- <td class="type">
311
-
312
-
313
- <span class="param-type">number</span>
314
-
315
-
316
-
317
-
318
- </td>
319
-
320
-
321
- <td class="attributes">
322
-
323
- &lt;optional><br>
324
-
325
-
326
-
327
-
328
-
329
- </td>
330
-
331
-
332
-
333
- <td class="default">
334
-
335
- <code>1</code>
336
-
337
- </td>
338
-
339
-
340
- <td class="description last">The page number for pagination.</td>
341
- </tr>
342
-
343
-
344
-
345
- <tr>
346
-
347
- <td class="name"><code>limit</code></td>
348
-
349
-
350
- <td class="type">
351
-
352
-
353
- <span class="param-type">number</span>
354
-
355
-
356
-
357
-
358
- </td>
359
-
360
-
361
- <td class="attributes">
362
-
363
- &lt;optional><br>
364
-
365
-
366
-
367
-
368
-
369
- </td>
370
-
371
-
372
-
373
- <td class="default">
374
-
375
- <code>10</code>
376
-
377
- </td>
378
-
379
-
380
- <td class="description last">The maximum number of content items per row.</td>
381
- </tr>
382
-
383
-
384
- </tbody>
385
- </table>
386
-
387
- </td>
388
- </tr>
389
-
390
-
391
- </tbody>
392
- </table>
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
- <h5 class="h5-returns">Returns:</h5>
410
-
411
-
412
- <div class="param-desc">
413
- - The fetched content rows with complete Sanity data instead of just content IDs.
414
- When contentRowId is provided, returns an object with type, data, and meta properties.
415
- </div>
416
-
417
-
418
-
419
- <dl class="param-type">
420
- <dt>
421
- Type
422
- </dt>
423
- <dd>
424
-
425
- <span class="param-type">Promise.&lt;Object></span>
426
-
427
-
428
-
429
- </dd>
430
- </dl>
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
- <h4 class="name" id=".getLegacyMethods"><span class="type-signature type-signature-static">(static) </span>getLegacyMethods<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
442
-
443
-
444
-
445
-
446
-
447
-
448
- <dl class="details">
449
-
450
- <dt class="tag-description">Description:</dt>
451
- <dd class="tag-description"><ul class="dummy"><li>Fetches legacy methods for a given brand by permission.</li></ul></dd>
452
-
453
-
454
-
455
- <dt class="tag-source">Source:</dt>
456
- <dd class="tag-source"><ul class="dummy"><li>
457
- <a href="content.js.html">content.js</a>, <a href="content.js.html#line457">line 457</a>
458
- </li></ul></dd>
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
- </dl>
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
- <h5 class="h5-examples">Example</h5>
503
-
504
- <pre class="prettyprint"><code>// Fetch legacy methods for a brand by permission
505
- getLegacyMethods('drumeo')
506
- .then(content => console.log(content))
507
- .catch(error => console.error(error));</code></pre>
508
-
509
-
510
-
511
-
512
- <h5 class="h5-parameters">Parameters:</h5>
513
-
514
-
515
- <table class="params">
516
- <thead>
517
- <tr>
518
-
519
- <th>Name</th>
520
-
521
-
522
- <th>Type</th>
523
-
524
-
525
-
526
-
527
-
528
- <th class="last">Description</th>
529
- </tr>
530
- </thead>
531
-
532
- <tbody>
533
-
534
-
535
- <tr>
536
-
537
- <td class="name"><code>brand</code></td>
538
-
539
-
540
- <td class="type">
541
-
542
-
543
- <span class="param-type">string</span>
544
-
545
-
546
-
547
-
548
- </td>
549
-
550
-
551
-
552
-
553
-
554
- <td class="description last">The brand for which to fetch legacy methods.</td>
555
- </tr>
556
-
557
-
558
- </tbody>
559
- </table>
560
-
561
-
562
-
563
-
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
-
574
-
575
-
576
- <h5 class="h5-returns">Returns:</h5>
577
-
578
-
579
- <div class="param-desc">
580
- - A promise that resolves to an object containing legacy methods.
581
- </div>
582
-
583
-
584
-
585
- <dl class="param-type">
586
- <dt>
587
- Type
588
- </dt>
589
- <dd>
590
-
591
- <span class="param-type">Promise.&lt;Object></span>
592
-
593
-
594
-
595
- </dd>
596
- </dl>
597
-
598
-
599
-
600
-
601
-
602
-
603
-
604
-
605
-
606
-
607
- <h4 class="name" id=".getNewAndUpcoming"><span class="type-signature type-signature-static">(static) </span>getNewAndUpcoming<span class="signature">(brand, params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;({data: Array.&lt;Object>}|null)>}</span></h4>
608
-
609
-
610
-
611
-
612
-
613
-
614
- <dl class="details">
615
-
616
- <dt class="tag-description">Description:</dt>
617
- <dd class="tag-description"><ul class="dummy"><li>Fetches new and upcoming releases for a given brand with pagination options.</li></ul></dd>
618
-
619
-
620
-
621
- <dt class="tag-source">Source:</dt>
622
- <dd class="tag-source"><ul class="dummy"><li>
623
- <a href="content.js.html">content.js</a>, <a href="content.js.html#line279">line 279</a>
624
- </li></ul></dd>
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
- </dl>
657
-
658
-
659
-
660
-
661
-
662
-
663
-
664
-
665
-
666
-
667
-
668
- <h5 class="h5-examples">Examples</h5>
669
-
670
- <pre class="prettyprint"><code>// Fetch the first page with 10 results
671
- getNewAndUpcoming('drumeo')
672
- .then(response => console.log(response))
673
- .catch(error => console.error(error));</code></pre>
674
-
675
- <pre class="prettyprint"><code>// Fetch the second page with 20 results
676
- getNewAndUpcoming('drumeo', { page: 2, limit: 20 })
677
- .then(response => console.log(response))
678
- .catch(error => console.error(error));</code></pre>
679
-
680
-
681
-
682
-
683
- <h5 class="h5-parameters">Parameters:</h5>
684
-
685
-
686
- <table class="params">
687
- <thead>
688
- <tr>
689
-
690
- <th>Name</th>
691
-
692
-
693
- <th>Type</th>
694
-
695
-
696
- <th>Attributes</th>
697
-
698
-
699
-
700
- <th>Default</th>
701
-
702
-
703
- <th class="last">Description</th>
704
- </tr>
705
- </thead>
706
-
707
- <tbody>
708
-
709
-
710
- <tr>
711
-
712
- <td class="name"><code>brand</code></td>
713
-
714
-
715
- <td class="type">
716
-
717
-
718
- <span class="param-type">string</span>
719
-
720
-
721
-
722
-
723
- </td>
724
-
725
-
726
- <td class="attributes">
727
-
728
-
729
-
730
-
731
-
732
- </td>
733
-
734
-
735
-
736
- <td class="default">
737
-
738
- </td>
739
-
740
-
741
- <td class="description last">The brand for which to fetch new and upcoming releases.</td>
742
- </tr>
743
-
744
-
745
-
746
- <tr>
747
-
748
- <td class="name"><code>params</code></td>
749
-
750
-
751
- <td class="type">
752
-
753
-
754
- <span class="param-type">Object</span>
755
-
756
-
757
-
758
-
759
- </td>
760
-
761
-
762
- <td class="attributes">
763
-
764
- &lt;optional><br>
765
-
766
-
767
-
768
-
769
-
770
- </td>
771
-
772
-
773
-
774
- <td class="default">
775
-
776
- <code>{}</code>
777
-
778
- </td>
779
-
780
-
781
- <td class="description last">Pagination parameters.
782
- <h6>Properties</h6>
783
-
784
-
785
- <table class="params">
786
- <thead>
787
- <tr>
788
-
789
- <th>Name</th>
790
-
791
-
792
- <th>Type</th>
793
-
794
-
795
- <th>Attributes</th>
796
-
797
-
798
-
799
- <th>Default</th>
800
-
801
-
802
- <th class="last">Description</th>
803
- </tr>
804
- </thead>
805
-
806
- <tbody>
807
-
808
-
809
- <tr>
810
-
811
- <td class="name"><code>page</code></td>
812
-
813
-
814
- <td class="type">
815
-
816
-
817
- <span class="param-type">number</span>
818
-
819
-
820
-
821
-
822
- </td>
823
-
824
-
825
- <td class="attributes">
826
-
827
- &lt;optional><br>
828
-
829
-
830
-
831
-
832
-
833
- </td>
834
-
835
-
836
-
837
- <td class="default">
838
-
839
- <code>1</code>
840
-
841
- </td>
842
-
843
-
844
- <td class="description last">The page number for pagination.</td>
845
- </tr>
846
-
847
-
848
-
849
- <tr>
850
-
851
- <td class="name"><code>limit</code></td>
852
-
853
-
854
- <td class="type">
855
-
856
-
857
- <span class="param-type">number</span>
858
-
859
-
860
-
861
-
862
- </td>
863
-
864
-
865
- <td class="attributes">
866
-
867
- &lt;optional><br>
868
-
869
-
870
-
871
-
872
-
873
- </td>
874
-
875
-
876
-
877
- <td class="default">
878
-
879
- <code>10</code>
880
-
881
- </td>
882
-
883
-
884
- <td class="description last">The maximum number of content items to fetch.</td>
885
- </tr>
886
-
887
-
888
- </tbody>
889
- </table>
890
-
891
- </td>
892
- </tr>
893
-
894
-
895
- </tbody>
896
- </table>
897
-
898
-
899
-
900
-
901
-
902
-
903
-
904
-
905
-
906
-
907
-
908
-
909
-
910
-
911
-
912
-
913
- <h5 class="h5-returns">Returns:</h5>
914
-
915
-
916
- <div class="param-desc">
917
- - A promise that resolves to the fetched content data or `null` if no data is found.
918
- </div>
919
-
920
-
921
-
922
- <dl class="param-type">
923
- <dt>
924
- Type
925
- </dt>
926
- <dd>
927
-
928
- <span class="param-type">Promise.&lt;({data: Array.&lt;Object>}|null)></span>
929
-
930
-
931
-
932
- </dd>
933
- </dl>
934
-
935
-
936
-
937
-
938
-
939
-
940
-
941
-
942
-
943
-
944
- <h4 class="name" id=".getOwnedContent"><span class="type-signature type-signature-static">(static) </span>getOwnedContent<span class="signature">(brand, params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
945
-
946
-
947
-
948
-
949
-
950
-
951
- <dl class="details">
952
-
953
- <dt class="tag-description">Description:</dt>
954
- <dd class="tag-description"><ul class="dummy"><li>Fetches content owned by the user (excluding membership content).
955
- Shows only content accessible through purchases/entitlements, not through membership.</li></ul></dd>
956
-
957
-
958
-
959
- <dt class="tag-source">Source:</dt>
960
- <dd class="tag-source"><ul class="dummy"><li>
961
- <a href="content.js.html">content.js</a>, <a href="content.js.html#line515">line 515</a>
962
- </li></ul></dd>
963
-
964
-
965
-
966
-
967
-
968
-
969
-
970
-
971
-
972
-
973
-
974
-
975
-
976
-
977
-
978
-
979
-
980
-
981
-
982
-
983
-
984
-
985
-
986
-
987
-
988
-
989
-
990
-
991
-
992
-
993
-
994
- </dl>
995
-
996
-
997
-
998
-
999
-
1000
-
1001
-
1002
-
1003
-
1004
-
1005
-
1006
- <h5 class="h5-examples">Examples</h5>
1007
-
1008
- <pre class="prettyprint"><code>// Fetch all owned content with default pagination
1009
- getOwnedContent('drumeo')
1010
- .then(content => console.log(content))
1011
- .catch(error => console.error(error));</code></pre>
1012
-
1013
- <pre class="prettyprint"><code>// Fetch owned content with custom pagination and sorting
1014
- getOwnedContent('drumeo', {
1015
- page: 2,
1016
- limit: 20,
1017
- sort: '-published_on'
1018
- })
1019
- .then(content => console.log(content))
1020
- .catch(error => console.error(error));</code></pre>
1021
-
1022
- <pre class="prettyprint"><code>// Fetch owned content filtered by types
1023
- getOwnedContent('drumeo', {
1024
- type: ['course', 'pack'],
1025
- page: 1,
1026
- limit: 10
1027
- })
1028
- .then(content => console.log(content))
1029
- .catch(error => console.error(error));</code></pre>
1030
-
1031
-
1032
-
1033
-
1034
- <h5 class="h5-parameters">Parameters:</h5>
1035
-
1036
-
1037
- <table class="params">
1038
- <thead>
1039
- <tr>
1040
-
1041
- <th>Name</th>
1042
-
1043
-
1044
- <th>Type</th>
1045
-
1046
-
1047
- <th>Attributes</th>
1048
-
1049
-
1050
-
1051
- <th>Default</th>
1052
-
1053
-
1054
- <th class="last">Description</th>
1055
- </tr>
1056
- </thead>
1057
-
1058
- <tbody>
1059
-
1060
-
1061
- <tr>
1062
-
1063
- <td class="name"><code>brand</code></td>
1064
-
1065
-
1066
- <td class="type">
1067
-
1068
-
1069
- <span class="param-type">string</span>
1070
-
1071
-
1072
-
1073
-
1074
- </td>
1075
-
1076
-
1077
- <td class="attributes">
1078
-
1079
-
1080
-
1081
-
1082
-
1083
- </td>
1084
-
1085
-
1086
-
1087
- <td class="default">
1088
-
1089
- </td>
1090
-
1091
-
1092
- <td class="description last">The brand for which to fetch owned content.</td>
1093
- </tr>
1094
-
1095
-
1096
-
1097
- <tr>
1098
-
1099
- <td class="name"><code>params</code></td>
1100
-
1101
-
1102
- <td class="type">
1103
-
1104
-
1105
- <span class="param-type">Object</span>
1106
-
1107
-
1108
-
1109
-
1110
- </td>
1111
-
1112
-
1113
- <td class="attributes">
1114
-
1115
- &lt;optional><br>
1116
-
1117
-
1118
-
1119
-
1120
-
1121
- </td>
1122
-
1123
-
1124
-
1125
- <td class="default">
1126
-
1127
- <code>{}</code>
1128
-
1129
- </td>
1130
-
1131
-
1132
- <td class="description last">Parameters for pagination and sorting.
1133
- <h6>Properties</h6>
1134
-
1135
-
1136
- <table class="params">
1137
- <thead>
1138
- <tr>
1139
-
1140
- <th>Name</th>
1141
-
1142
-
1143
- <th>Type</th>
1144
-
1145
-
1146
- <th>Attributes</th>
1147
-
1148
-
1149
-
1150
- <th>Default</th>
1151
-
1152
-
1153
- <th class="last">Description</th>
1154
- </tr>
1155
- </thead>
1156
-
1157
- <tbody>
1158
-
1159
-
1160
- <tr>
1161
-
1162
- <td class="name"><code>type</code></td>
1163
-
1164
-
1165
- <td class="type">
1166
-
1167
-
1168
- <span class="param-type">Array.&lt;string></span>
1169
-
1170
-
1171
-
1172
-
1173
- </td>
1174
-
1175
-
1176
- <td class="attributes">
1177
-
1178
- &lt;optional><br>
1179
-
1180
-
1181
-
1182
-
1183
-
1184
- </td>
1185
-
1186
-
1187
-
1188
- <td class="default">
1189
-
1190
- <code>[]</code>
1191
-
1192
- </td>
1193
-
1194
-
1195
- <td class="description last">Content type(s) to filter (optional array).</td>
1196
- </tr>
1197
-
1198
-
1199
-
1200
- <tr>
1201
-
1202
- <td class="name"><code>page</code></td>
1203
-
1204
-
1205
- <td class="type">
1206
-
1207
-
1208
- <span class="param-type">number</span>
1209
-
1210
-
1211
-
1212
-
1213
- </td>
1214
-
1215
-
1216
- <td class="attributes">
1217
-
1218
- &lt;optional><br>
1219
-
1220
-
1221
-
1222
-
1223
-
1224
- </td>
1225
-
1226
-
1227
-
1228
- <td class="default">
1229
-
1230
- <code>1</code>
1231
-
1232
- </td>
1233
-
1234
-
1235
- <td class="description last">The page number for pagination.</td>
1236
- </tr>
1237
-
1238
-
1239
-
1240
- <tr>
1241
-
1242
- <td class="name"><code>limit</code></td>
1243
-
1244
-
1245
- <td class="type">
1246
-
1247
-
1248
- <span class="param-type">number</span>
1249
-
1250
-
1251
-
1252
-
1253
- </td>
1254
-
1255
-
1256
- <td class="attributes">
1257
-
1258
- &lt;optional><br>
1259
-
1260
-
1261
-
1262
-
1263
-
1264
- </td>
1265
-
1266
-
1267
-
1268
- <td class="default">
1269
-
1270
- <code>10</code>
1271
-
1272
- </td>
1273
-
1274
-
1275
- <td class="description last">The number of items per page.</td>
1276
- </tr>
1277
-
1278
-
1279
-
1280
- <tr>
1281
-
1282
- <td class="name"><code>sort</code></td>
1283
-
1284
-
1285
- <td class="type">
1286
-
1287
-
1288
- <span class="param-type">string</span>
1289
-
1290
-
1291
-
1292
-
1293
- </td>
1294
-
1295
-
1296
- <td class="attributes">
1297
-
1298
- &lt;optional><br>
1299
-
1300
-
1301
-
1302
-
1303
-
1304
- </td>
1305
-
1306
-
1307
-
1308
- <td class="default">
1309
-
1310
- <code>'-published_on'</code>
1311
-
1312
- </td>
1313
-
1314
-
1315
- <td class="description last">The field to sort the data by.</td>
1316
- </tr>
1317
-
1318
-
1319
- </tbody>
1320
- </table>
1321
-
1322
- </td>
1323
- </tr>
1324
-
1325
-
1326
- </tbody>
1327
- </table>
1328
-
1329
-
1330
-
1331
-
1332
-
1333
-
1334
-
1335
-
1336
-
1337
-
1338
-
1339
-
1340
-
1341
-
1342
-
1343
-
1344
- <h5 class="h5-returns">Returns:</h5>
1345
-
1346
-
1347
- <div class="param-desc">
1348
- - The fetched owned content with entity array and total count.
1349
- </div>
1350
-
1351
-
1352
-
1353
- <dl class="param-type">
1354
- <dt>
1355
- Type
1356
- </dt>
1357
- <dd>
1358
-
1359
- <span class="param-type">Promise.&lt;Object></span>
1360
-
1361
-
1362
-
1363
- </dd>
1364
- </dl>
1365
-
1366
-
1367
-
1368
-
1369
-
1370
-
1371
-
1372
-
1373
-
1374
-
1375
- <h4 class="name" id=".getRecent"><span class="type-signature type-signature-static">(static) </span>getRecent<span class="signature">(brand, pageName, tabName<span class="signature-attributes">opt</span>, params)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
1376
-
1377
-
1378
-
1379
-
1380
-
1381
-
1382
- <dl class="details">
1383
-
1384
- <dt class="tag-description">Description:</dt>
1385
- <dd class="tag-description"><ul class="dummy"><li>Fetches recent content for a given brand and page with pagination.</li></ul></dd>
1386
-
1387
-
1388
-
1389
- <dt class="tag-source">Source:</dt>
1390
- <dd class="tag-source"><ul class="dummy"><li>
1391
- <a href="content.js.html">content.js</a>, <a href="content.js.html#line184">line 184</a>
1392
- </li></ul></dd>
1393
-
1394
-
1395
-
1396
-
1397
-
1398
-
1399
-
1400
-
1401
-
1402
-
1403
-
1404
-
1405
-
1406
-
1407
-
1408
-
1409
-
1410
-
1411
-
1412
-
1413
-
1414
-
1415
-
1416
-
1417
-
1418
-
1419
-
1420
-
1421
-
1422
-
1423
-
1424
- </dl>
1425
-
1426
-
1427
-
1428
-
1429
-
1430
-
1431
-
1432
-
1433
-
1434
-
1435
-
1436
- <h5 class="h5-examples">Example</h5>
1437
-
1438
- <pre class="prettyprint"><code>getRecent('drumeo', 'lessons', 'all', {
1439
- page: 2,
1440
- limit: 15,
1441
- sort: '-popularity'
1442
- })
1443
- .then(content => console.log(content))
1444
- .catch(error => console.error(error));</code></pre>
1445
-
1446
-
1447
-
1448
-
1449
- <h5 class="h5-parameters">Parameters:</h5>
1450
-
1451
-
1452
- <table class="params">
1453
- <thead>
1454
- <tr>
1455
-
1456
- <th>Name</th>
1457
-
1458
-
1459
- <th>Type</th>
1460
-
1461
-
1462
- <th>Attributes</th>
1463
-
1464
-
1465
-
1466
- <th>Default</th>
1467
-
1468
-
1469
- <th class="last">Description</th>
1470
- </tr>
1471
- </thead>
1472
-
1473
- <tbody>
1474
-
1475
-
1476
- <tr>
1477
-
1478
- <td class="name"><code>brand</code></td>
1479
-
1480
-
1481
- <td class="type">
1482
-
1483
-
1484
- <span class="param-type">string</span>
1485
-
1486
-
1487
-
1488
-
1489
- </td>
1490
-
1491
-
1492
- <td class="attributes">
1493
-
1494
-
1495
-
1496
-
1497
-
1498
- </td>
1499
-
1500
-
1501
-
1502
- <td class="default">
1503
-
1504
- </td>
1505
-
1506
-
1507
- <td class="description last">The brand for which to fetch data.</td>
1508
- </tr>
1509
-
1510
-
1511
-
1512
- <tr>
1513
-
1514
- <td class="name"><code>pageName</code></td>
1515
-
1516
-
1517
- <td class="type">
1518
-
1519
-
1520
- <span class="param-type">string</span>
1521
-
1522
-
1523
-
1524
-
1525
- </td>
1526
-
1527
-
1528
- <td class="attributes">
1529
-
1530
-
1531
-
1532
-
1533
-
1534
- </td>
1535
-
1536
-
1537
-
1538
- <td class="default">
1539
-
1540
- </td>
1541
-
1542
-
1543
- <td class="description last">The page name (e.g., 'all', 'incomplete', 'completed').</td>
1544
- </tr>
1545
-
1546
-
1547
-
1548
- <tr>
1549
-
1550
- <td class="name"><code>tabName</code></td>
1551
-
1552
-
1553
- <td class="type">
1554
-
1555
-
1556
- <span class="param-type">string</span>
1557
-
1558
-
1559
-
1560
-
1561
- </td>
1562
-
1563
-
1564
- <td class="attributes">
1565
-
1566
- &lt;optional><br>
1567
-
1568
-
1569
-
1570
-
1571
-
1572
- </td>
1573
-
1574
-
1575
-
1576
- <td class="default">
1577
-
1578
- <code>'all'</code>
1579
-
1580
- </td>
1581
-
1582
-
1583
- <td class="description last">The tab name (defaults to 'all' for recent content).</td>
1584
- </tr>
1585
-
1586
-
1587
-
1588
- <tr>
1589
-
1590
- <td class="name"><code>params</code></td>
1591
-
1592
-
1593
- <td class="type">
1594
-
1595
-
1596
- <span class="param-type">Object</span>
1597
-
1598
-
1599
-
1600
-
1601
- </td>
1602
-
1603
-
1604
- <td class="attributes">
1605
-
1606
-
1607
-
1608
-
1609
-
1610
- </td>
1611
-
1612
-
1613
-
1614
- <td class="default">
1615
-
1616
- </td>
1617
-
1618
-
1619
- <td class="description last">Parameters for pagination and sorting.
1620
- <h6>Properties</h6>
1621
-
1622
-
1623
- <table class="params">
1624
- <thead>
1625
- <tr>
1626
-
1627
- <th>Name</th>
1628
-
1629
-
1630
- <th>Type</th>
1631
-
1632
-
1633
- <th>Attributes</th>
1634
-
1635
-
1636
-
1637
- <th>Default</th>
1638
-
1639
-
1640
- <th class="last">Description</th>
1641
- </tr>
1642
- </thead>
1643
-
1644
- <tbody>
1645
-
1646
-
1647
- <tr>
1648
-
1649
- <td class="name"><code>page</code></td>
1650
-
1651
-
1652
- <td class="type">
1653
-
1654
-
1655
- <span class="param-type">number</span>
1656
-
1657
-
1658
-
1659
-
1660
- </td>
1661
-
1662
-
1663
- <td class="attributes">
1664
-
1665
- &lt;optional><br>
1666
-
1667
-
1668
-
1669
-
1670
-
1671
- </td>
1672
-
1673
-
1674
-
1675
- <td class="default">
1676
-
1677
- <code>1</code>
1678
-
1679
- </td>
1680
-
1681
-
1682
- <td class="description last">The page number for pagination.</td>
1683
- </tr>
1684
-
1685
-
1686
-
1687
- <tr>
1688
-
1689
- <td class="name"><code>limit</code></td>
1690
-
1691
-
1692
- <td class="type">
1693
-
1694
-
1695
- <span class="param-type">number</span>
1696
-
1697
-
1698
-
1699
-
1700
- </td>
1701
-
1702
-
1703
- <td class="attributes">
1704
-
1705
- &lt;optional><br>
1706
-
1707
-
1708
-
1709
-
1710
-
1711
- </td>
1712
-
1713
-
1714
-
1715
- <td class="default">
1716
-
1717
- <code>10</code>
1718
-
1719
- </td>
1720
-
1721
-
1722
- <td class="description last">The number of items per page.</td>
1723
- </tr>
1724
-
1725
-
1726
-
1727
- <tr>
1728
-
1729
- <td class="name"><code>sort</code></td>
1730
-
1731
-
1732
- <td class="type">
1733
-
1734
-
1735
- <span class="param-type">string</span>
1736
-
1737
-
1738
-
1739
-
1740
- </td>
1741
-
1742
-
1743
- <td class="attributes">
1744
-
1745
- &lt;optional><br>
1746
-
1747
-
1748
-
1749
-
1750
-
1751
- </td>
1752
-
1753
-
1754
-
1755
- <td class="default">
1756
-
1757
- <code>"-published_on"</code>
1758
-
1759
- </td>
1760
-
1761
-
1762
- <td class="description last">The field to sort the data by.</td>
1763
- </tr>
1764
-
1765
-
1766
- </tbody>
1767
- </table>
1768
-
1769
- </td>
1770
- </tr>
1771
-
1772
-
1773
- </tbody>
1774
- </table>
1775
-
1776
-
1777
-
1778
-
1779
-
1780
-
1781
-
1782
-
1783
-
1784
-
1785
-
1786
-
1787
-
1788
-
1789
-
1790
-
1791
- <h5 class="h5-returns">Returns:</h5>
1792
-
1793
-
1794
- <div class="param-desc">
1795
- - The fetched content data.
1796
- </div>
1797
-
1798
-
1799
-
1800
- <dl class="param-type">
1801
- <dt>
1802
- Type
1803
- </dt>
1804
- <dd>
1805
-
1806
- <span class="param-type">Promise.&lt;Object></span>
1807
-
1808
-
1809
-
1810
- </dd>
1811
- </dl>
1812
-
1813
-
1814
-
1815
-
1816
-
1817
-
1818
-
1819
-
1820
-
1821
-
1822
- <h4 class="name" id=".getRecommendedForYou"><span class="type-signature type-signature-static">(static) </span>getRecommendedForYou<span class="signature">(brand, params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
1823
-
1824
-
1825
-
1826
-
1827
-
1828
-
1829
- <dl class="details">
1830
-
1831
- <dt class="tag-description">Description:</dt>
1832
- <dd class="tag-description"><ul class="dummy"><li>Fetches recommended content for a given brand with pagination support.</li></ul></dd>
1833
-
1834
-
1835
-
1836
- <dt class="tag-source">Source:</dt>
1837
- <dd class="tag-source"><ul class="dummy"><li>
1838
- <a href="content.js.html">content.js</a>, <a href="content.js.html#line415">line 415</a>
1839
- </li></ul></dd>
1840
-
1841
-
1842
-
1843
-
1844
-
1845
-
1846
-
1847
-
1848
-
1849
-
1850
-
1851
-
1852
-
1853
-
1854
-
1855
-
1856
-
1857
-
1858
-
1859
-
1860
-
1861
-
1862
-
1863
-
1864
-
1865
-
1866
-
1867
-
1868
-
1869
-
1870
-
1871
- </dl>
1872
-
1873
-
1874
-
1875
-
1876
-
1877
-
1878
-
1879
-
1880
-
1881
-
1882
-
1883
- <h5 class="h5-examples">Examples</h5>
1884
-
1885
- <pre class="prettyprint"><code>// Fetch recommended content for a brand with default pagination
1886
- getRecommendedForYou('drumeo')
1887
- .then(content => console.log(content))
1888
- .catch(error => console.error(error));</code></pre>
1889
-
1890
- <pre class="prettyprint"><code>// Fetch recommended content for a brand with custom pagination
1891
- getRecommendedForYou('drumeo', { page: 2, limit: 5 })
1892
- .then(content => console.log(content))
1893
- .catch(error => console.error(error));</code></pre>
1894
-
1895
-
1896
-
1897
-
1898
- <h5 class="h5-parameters">Parameters:</h5>
1899
-
1900
-
1901
- <table class="params">
1902
- <thead>
1903
- <tr>
1904
-
1905
- <th>Name</th>
1906
-
1907
-
1908
- <th>Type</th>
1909
-
1910
-
1911
- <th>Attributes</th>
1912
-
1913
-
1914
-
1915
- <th>Default</th>
1916
-
1917
-
1918
- <th class="last">Description</th>
1919
- </tr>
1920
- </thead>
1921
-
1922
- <tbody>
1923
-
1924
-
1925
- <tr>
1926
-
1927
- <td class="name"><code>brand</code></td>
1928
-
1929
-
1930
- <td class="type">
1931
-
1932
-
1933
- <span class="param-type">string</span>
1934
-
1935
-
1936
-
1937
-
1938
- </td>
1939
-
1940
-
1941
- <td class="attributes">
1942
-
1943
-
1944
-
1945
-
1946
-
1947
- </td>
1948
-
1949
-
1950
-
1951
- <td class="default">
1952
-
1953
- </td>
1954
-
1955
-
1956
- <td class="description last">The brand for which to fetch recommended content.</td>
1957
- </tr>
1958
-
1959
-
1960
-
1961
- <tr>
1962
-
1963
- <td class="name"><code>params</code></td>
1964
-
1965
-
1966
- <td class="type">
1967
-
1968
-
1969
- <span class="param-type">Object</span>
1970
-
1971
-
1972
-
1973
-
1974
- </td>
1975
-
1976
-
1977
- <td class="attributes">
1978
-
1979
- &lt;optional><br>
1980
-
1981
-
1982
-
1983
-
1984
-
1985
- </td>
1986
-
1987
-
1988
-
1989
- <td class="default">
1990
-
1991
- <code>{}</code>
1992
-
1993
- </td>
1994
-
1995
-
1996
- <td class="description last">Pagination parameters.
1997
- <h6>Properties</h6>
1998
-
1999
-
2000
- <table class="params">
2001
- <thead>
2002
- <tr>
2003
-
2004
- <th>Name</th>
2005
-
2006
-
2007
- <th>Type</th>
2008
-
2009
-
2010
- <th>Attributes</th>
2011
-
2012
-
2013
-
2014
- <th>Default</th>
2015
-
2016
-
2017
- <th class="last">Description</th>
2018
- </tr>
2019
- </thead>
2020
-
2021
- <tbody>
2022
-
2023
-
2024
- <tr>
2025
-
2026
- <td class="name"><code>page</code></td>
2027
-
2028
-
2029
- <td class="type">
2030
-
2031
-
2032
- <span class="param-type">number</span>
2033
-
2034
-
2035
-
2036
-
2037
- </td>
2038
-
2039
-
2040
- <td class="attributes">
2041
-
2042
- &lt;optional><br>
2043
-
2044
-
2045
-
2046
-
2047
-
2048
- </td>
2049
-
2050
-
2051
-
2052
- <td class="default">
2053
-
2054
- <code>1</code>
2055
-
2056
- </td>
2057
-
2058
-
2059
- <td class="description last">The page number for pagination.</td>
2060
- </tr>
2061
-
2062
-
2063
-
2064
- <tr>
2065
-
2066
- <td class="name"><code>limit</code></td>
2067
-
2068
-
2069
- <td class="type">
2070
-
2071
-
2072
- <span class="param-type">number</span>
2073
-
2074
-
2075
-
2076
-
2077
- </td>
2078
-
2079
-
2080
- <td class="attributes">
2081
-
2082
- &lt;optional><br>
2083
-
2084
-
2085
-
2086
-
2087
-
2088
- </td>
2089
-
2090
-
2091
-
2092
- <td class="default">
2093
-
2094
- <code>10</code>
2095
-
2096
- </td>
2097
-
2098
-
2099
- <td class="description last">The maximum number of recommended content items per page.</td>
2100
- </tr>
2101
-
2102
-
2103
- </tbody>
2104
- </table>
2105
-
2106
- </td>
2107
- </tr>
2108
-
2109
-
2110
- </tbody>
2111
- </table>
2112
-
2113
-
2114
-
2115
-
2116
-
2117
-
2118
-
2119
-
2120
-
2121
-
2122
-
2123
-
2124
-
2125
-
2126
-
2127
-
2128
- <h5 class="h5-returns">Returns:</h5>
2129
-
2130
-
2131
- <div class="param-desc">
2132
- - A promise that resolves to an object containing recommended content.
2133
- </div>
2134
-
2135
-
2136
-
2137
- <dl class="param-type">
2138
- <dt>
2139
- Type
2140
- </dt>
2141
- <dd>
2142
-
2143
- <span class="param-type">Promise.&lt;Object></span>
2144
-
2145
-
2146
-
2147
- </dd>
2148
- </dl>
2149
-
2150
-
2151
-
2152
-
2153
-
2154
-
2155
-
2156
-
2157
-
2158
-
2159
- <h4 class="name" id=".getScheduleContentRows"><span class="type-signature type-signature-static">(static) </span>getScheduleContentRows<span class="signature">(brand, contentRowId<span class="signature-attributes">opt</span>, params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2160
-
2161
-
2162
-
2163
-
2164
-
2165
-
2166
- <dl class="details">
2167
-
2168
- <dt class="tag-description">Description:</dt>
2169
- <dd class="tag-description"><ul class="dummy"><li>Fetches scheduled content rows for a given brand with optional filtering by content row ID.</li></ul></dd>
2170
-
2171
-
2172
-
2173
- <dt class="tag-source">Source:</dt>
2174
- <dd class="tag-source"><ul class="dummy"><li>
2175
- <a href="content.js.html">content.js</a>, <a href="content.js.html#line322">line 322</a>
2176
- </li></ul></dd>
2177
-
2178
-
2179
-
2180
-
2181
-
2182
-
2183
-
2184
-
2185
-
2186
-
2187
-
2188
-
2189
-
2190
-
2191
-
2192
-
2193
-
2194
-
2195
-
2196
-
2197
-
2198
-
2199
-
2200
-
2201
-
2202
-
2203
-
2204
-
2205
-
2206
-
2207
-
2208
- </dl>
2209
-
2210
-
2211
-
2212
-
2213
-
2214
-
2215
-
2216
-
2217
-
2218
-
2219
-
2220
- <h5 class="h5-examples">Examples</h5>
2221
-
2222
- <pre class="prettyprint"><code>// Fetch all sections with default pagination
2223
- getScheduleContentRows('drumeo')
2224
- .then(content => console.log(content))
2225
- .catch(error => console.error(error));</code></pre>
2226
-
2227
- <pre class="prettyprint"><code>// Fetch only the 'New-Releases' section with custom pagination
2228
- getScheduleContentRows('drumeo', 'New-Releases', { page: 1, limit: 30 })
2229
- .then(content => console.log(content))
2230
- .catch(error => console.error(error));</code></pre>
2231
-
2232
- <pre class="prettyprint"><code>// Fetch only the 'Live-Streams' section with unlimited results
2233
- getScheduleContentRows('drumeo', 'Live-Streams')
2234
- .then(content => console.log(content))
2235
- .catch(error => console.error(error));</code></pre>
2236
-
2237
-
2238
-
2239
-
2240
- <h5 class="h5-parameters">Parameters:</h5>
2241
-
2242
-
2243
- <table class="params">
2244
- <thead>
2245
- <tr>
2246
-
2247
- <th>Name</th>
2248
-
2249
-
2250
- <th>Type</th>
2251
-
2252
-
2253
- <th>Attributes</th>
2254
-
2255
-
2256
-
2257
- <th>Default</th>
2258
-
2259
-
2260
- <th class="last">Description</th>
2261
- </tr>
2262
- </thead>
2263
-
2264
- <tbody>
2265
-
2266
-
2267
- <tr>
2268
-
2269
- <td class="name"><code>brand</code></td>
2270
-
2271
-
2272
- <td class="type">
2273
-
2274
-
2275
- <span class="param-type">string</span>
2276
-
2277
-
2278
-
2279
-
2280
- </td>
2281
-
2282
-
2283
- <td class="attributes">
2284
-
2285
-
2286
-
2287
-
2288
-
2289
- </td>
2290
-
2291
-
2292
-
2293
- <td class="default">
2294
-
2295
- </td>
2296
-
2297
-
2298
- <td class="description last">The brand for which to fetch content rows.</td>
2299
- </tr>
2300
-
2301
-
2302
-
2303
- <tr>
2304
-
2305
- <td class="name"><code>contentRowId</code></td>
2306
-
2307
-
2308
- <td class="type">
2309
-
2310
-
2311
- <span class="param-type">string</span>
2312
-
2313
-
2314
-
2315
-
2316
- </td>
2317
-
2318
-
2319
- <td class="attributes">
2320
-
2321
- &lt;optional><br>
2322
-
2323
-
2324
-
2325
-
2326
-
2327
- </td>
2328
-
2329
-
2330
-
2331
- <td class="default">
2332
-
2333
- <code>null</code>
2334
-
2335
- </td>
2336
-
2337
-
2338
- <td class="description last">The specific content row ID to fetch (optional).</td>
2339
- </tr>
2340
-
2341
-
2342
-
2343
- <tr>
2344
-
2345
- <td class="name"><code>params</code></td>
2346
-
2347
-
2348
- <td class="type">
2349
-
2350
-
2351
- <span class="param-type">Object</span>
2352
-
2353
-
2354
-
2355
-
2356
- </td>
2357
-
2358
-
2359
- <td class="attributes">
2360
-
2361
- &lt;optional><br>
2362
-
2363
-
2364
-
2365
-
2366
-
2367
- </td>
2368
-
2369
-
2370
-
2371
- <td class="default">
2372
-
2373
- <code>{}</code>
2374
-
2375
- </td>
2376
-
2377
-
2378
- <td class="description last">Pagination parameters.
2379
- <h6>Properties</h6>
2380
-
2381
-
2382
- <table class="params">
2383
- <thead>
2384
- <tr>
2385
-
2386
- <th>Name</th>
2387
-
2388
-
2389
- <th>Type</th>
2390
-
2391
-
2392
- <th>Attributes</th>
2393
-
2394
-
2395
-
2396
- <th>Default</th>
2397
-
2398
-
2399
- <th class="last">Description</th>
2400
- </tr>
2401
- </thead>
2402
-
2403
- <tbody>
2404
-
2405
-
2406
- <tr>
2407
-
2408
- <td class="name"><code>page</code></td>
2409
-
2410
-
2411
- <td class="type">
2412
-
2413
-
2414
- <span class="param-type">number</span>
2415
-
2416
-
2417
-
2418
-
2419
- </td>
2420
-
2421
-
2422
- <td class="attributes">
2423
-
2424
- &lt;optional><br>
2425
-
2426
-
2427
-
2428
-
2429
-
2430
- </td>
2431
-
2432
-
2433
-
2434
- <td class="default">
2435
-
2436
- <code>1</code>
2437
-
2438
- </td>
2439
-
2440
-
2441
- <td class="description last">The page number for pagination.</td>
2442
- </tr>
2443
-
2444
-
2445
-
2446
- <tr>
2447
-
2448
- <td class="name"><code>limit</code></td>
2449
-
2450
-
2451
- <td class="type">
2452
-
2453
-
2454
- <span class="param-type">number</span>
2455
-
2456
-
2457
-
2458
-
2459
- </td>
2460
-
2461
-
2462
- <td class="attributes">
2463
-
2464
- &lt;optional><br>
2465
-
2466
-
2467
-
2468
-
2469
-
2470
- </td>
2471
-
2472
-
2473
-
2474
- <td class="default">
2475
-
2476
- <code>10</code>
2477
-
2478
- </td>
2479
-
2480
-
2481
- <td class="description last">The maximum number of content items per row.</td>
2482
- </tr>
2483
-
2484
-
2485
- </tbody>
2486
- </table>
2487
-
2488
- </td>
2489
- </tr>
2490
-
2491
-
2492
- </tbody>
2493
- </table>
2494
-
2495
-
2496
-
2497
-
2498
-
2499
-
2500
-
2501
-
2502
-
2503
-
2504
-
2505
-
2506
-
2507
-
2508
-
2509
-
2510
- <h5 class="h5-returns">Returns:</h5>
2511
-
2512
-
2513
- <div class="param-desc">
2514
- - A promise that resolves to the fetched content rows.
2515
- </div>
2516
-
2517
-
2518
-
2519
- <dl class="param-type">
2520
- <dt>
2521
- Type
2522
- </dt>
2523
- <dd>
2524
-
2525
- <span class="param-type">Promise.&lt;Object></span>
2526
-
2527
-
2528
-
2529
- </dd>
2530
- </dl>
2531
-
2532
-
2533
-
2534
-
2535
-
2536
-
2537
-
2538
-
2539
-
2540
-
2541
- <h4 class="name" id=".getTabResults"><span class="type-signature type-signature-static">(static) </span>getTabResults<span class="signature">(brand, pageName, tabName, params)</span><span class="type-signature"> &rarr; {Promise.&lt;(Object|null)>}</span></h4>
2542
-
2543
-
2544
-
2545
-
2546
-
2547
-
2548
- <dl class="details">
2549
-
2550
- <dt class="tag-description">Description:</dt>
2551
- <dd class="tag-description"><ul class="dummy"><li>Get data that should be displayed for a specific tab with pagination</li></ul></dd>
2552
-
2553
-
2554
-
2555
- <dt class="tag-source">Source:</dt>
2556
- <dd class="tag-source"><ul class="dummy"><li>
2557
- <a href="content.js.html">content.js</a>, <a href="content.js.html#line85">line 85</a>
2558
- </li></ul></dd>
2559
-
2560
-
2561
-
2562
-
2563
-
2564
-
2565
-
2566
-
2567
-
2568
-
2569
-
2570
-
2571
-
2572
-
2573
-
2574
-
2575
-
2576
-
2577
-
2578
-
2579
-
2580
-
2581
-
2582
-
2583
-
2584
-
2585
-
2586
-
2587
-
2588
-
2589
-
2590
- </dl>
2591
-
2592
-
2593
-
2594
-
2595
-
2596
-
2597
-
2598
-
2599
-
2600
-
2601
-
2602
- <h5 class="h5-examples">Example</h5>
2603
-
2604
- <pre class="prettyprint"><code>getTabResults('drumeo', 'lessons','Singles', {
2605
- page: 2,
2606
- limit: 20,
2607
- sort: '-popularity',
2608
- includedFields: ['difficulty,Intermediate'],
2609
- })
2610
- .then(content => console.log(content))
2611
- .catch(error => console.error(error));</code></pre>
2612
-
2613
-
2614
-
2615
-
2616
- <h5 class="h5-parameters">Parameters:</h5>
2617
-
2618
-
2619
- <table class="params">
2620
- <thead>
2621
- <tr>
2622
-
2623
- <th>Name</th>
2624
-
2625
-
2626
- <th>Type</th>
2627
-
2628
-
2629
-
2630
-
2631
-
2632
- <th class="last">Description</th>
2633
- </tr>
2634
- </thead>
2635
-
2636
- <tbody>
2637
-
2638
-
2639
- <tr>
2640
-
2641
- <td class="name"><code>brand</code></td>
2642
-
2643
-
2644
- <td class="type">
2645
-
2646
-
2647
- <span class="param-type">string</span>
2648
-
2649
-
2650
-
2651
-
2652
- </td>
2653
-
2654
-
2655
-
2656
-
2657
-
2658
- <td class="description last">The brand for which to fetch data.</td>
2659
- </tr>
2660
-
2661
-
2662
-
2663
- <tr>
2664
-
2665
- <td class="name"><code>pageName</code></td>
2666
-
2667
-
2668
- <td class="type">
2669
-
2670
-
2671
- <span class="param-type">string</span>
2672
-
2673
-
2674
-
2675
-
2676
- </td>
2677
-
2678
-
2679
-
2680
-
2681
-
2682
- <td class="description last">The page name (e.g., 'lessons', 'songs').</td>
2683
- </tr>
2684
-
2685
-
2686
-
2687
- <tr>
2688
-
2689
- <td class="name"><code>tabName</code></td>
2690
-
2691
-
2692
- <td class="type">
2693
-
2694
-
2695
- <span class="param-type">string</span>
2696
-
2697
-
2698
-
2699
-
2700
- </td>
2701
-
2702
-
2703
-
2704
-
2705
-
2706
- <td class="description last">The name for the selected tab. Should be same name received from fetchMetadata (e.g., 'Individuals', 'Collections','For You').</td>
2707
- </tr>
2708
-
2709
-
2710
-
2711
- <tr>
2712
-
2713
- <td class="name"><code>params</code></td>
2714
-
2715
-
2716
- <td class="type">
2717
-
2718
-
2719
- <span class="param-type">Object</span>
2720
-
2721
-
2722
-
2723
-
2724
- </td>
2725
-
2726
-
2727
-
2728
-
2729
-
2730
- <td class="description last">Parameters for pagination, sorting, and filter.
2731
- <h6>Properties</h6>
2732
-
2733
-
2734
- <table class="params">
2735
- <thead>
2736
- <tr>
2737
-
2738
- <th>Name</th>
2739
-
2740
-
2741
- <th>Type</th>
2742
-
2743
-
2744
- <th>Attributes</th>
2745
-
2746
-
2747
-
2748
- <th>Default</th>
2749
-
2750
-
2751
- <th class="last">Description</th>
2752
- </tr>
2753
- </thead>
2754
-
2755
- <tbody>
2756
-
2757
-
2758
- <tr>
2759
-
2760
- <td class="name"><code>page</code></td>
2761
-
2762
-
2763
- <td class="type">
2764
-
2765
-
2766
- <span class="param-type">number</span>
2767
-
2768
-
2769
-
2770
-
2771
- </td>
2772
-
2773
-
2774
- <td class="attributes">
2775
-
2776
- &lt;optional><br>
2777
-
2778
-
2779
-
2780
-
2781
-
2782
- </td>
2783
-
2784
-
2785
-
2786
- <td class="default">
2787
-
2788
- <code>1</code>
2789
-
2790
- </td>
2791
-
2792
-
2793
- <td class="description last">The page number for pagination.</td>
2794
- </tr>
2795
-
2796
-
2797
-
2798
- <tr>
2799
-
2800
- <td class="name"><code>limit</code></td>
2801
-
2802
-
2803
- <td class="type">
2804
-
2805
-
2806
- <span class="param-type">number</span>
2807
-
2808
-
2809
-
2810
-
2811
- </td>
2812
-
2813
-
2814
- <td class="attributes">
2815
-
2816
- &lt;optional><br>
2817
-
2818
-
2819
-
2820
-
2821
-
2822
- </td>
2823
-
2824
-
2825
-
2826
- <td class="default">
2827
-
2828
- <code>10</code>
2829
-
2830
- </td>
2831
-
2832
-
2833
- <td class="description last">The number of items per page.</td>
2834
- </tr>
2835
-
2836
-
2837
-
2838
- <tr>
2839
-
2840
- <td class="name"><code>sort</code></td>
2841
-
2842
-
2843
- <td class="type">
2844
-
2845
-
2846
- <span class="param-type">string</span>
2847
-
2848
-
2849
-
2850
-
2851
- </td>
2852
-
2853
-
2854
- <td class="attributes">
2855
-
2856
- &lt;optional><br>
2857
-
2858
-
2859
-
2860
-
2861
-
2862
- </td>
2863
-
2864
-
2865
-
2866
- <td class="default">
2867
-
2868
- <code>"-published_on"</code>
2869
-
2870
- </td>
2871
-
2872
-
2873
- <td class="description last">The field to sort the data by.</td>
2874
- </tr>
2875
-
2876
-
2877
-
2878
- <tr>
2879
-
2880
- <td class="name"><code>selectedFilters</code></td>
2881
-
2882
-
2883
- <td class="type">
2884
-
2885
-
2886
- <span class="param-type">Array.&lt;string></span>
2887
-
2888
-
2889
-
2890
-
2891
- </td>
2892
-
2893
-
2894
- <td class="attributes">
2895
-
2896
- &lt;optional><br>
2897
-
2898
-
2899
-
2900
-
2901
-
2902
- </td>
2903
-
2904
-
2905
-
2906
- <td class="default">
2907
-
2908
- <code>[]</code>
2909
-
2910
- </td>
2911
-
2912
-
2913
- <td class="description last">The selected filter.</td>
2914
- </tr>
2915
-
2916
-
2917
- </tbody>
2918
- </table>
2919
-
2920
- </td>
2921
- </tr>
2922
-
2923
-
2924
- </tbody>
2925
- </table>
2926
-
2927
-
2928
-
2929
-
2930
-
2931
-
2932
-
2933
-
2934
-
2935
-
2936
-
2937
-
2938
-
2939
-
2940
-
2941
-
2942
- <h5 class="h5-returns">Returns:</h5>
2943
-
2944
-
2945
- <div class="param-desc">
2946
- - The fetched content data or null if not found.
2947
- </div>
2948
-
2949
-
2950
-
2951
- <dl class="param-type">
2952
- <dt>
2953
- Type
2954
- </dt>
2955
- <dd>
2956
-
2957
- <span class="param-type">Promise.&lt;(Object|null)></span>
2958
-
2959
-
2960
-
2961
- </dd>
2962
- </dl>
2963
-
2964
-
2965
-
2966
-
2967
-
2968
-
2969
-
2970
-
2971
-
2972
-
2973
-
2974
- </article>
2975
-
2976
- </section>
2977
-
2978
-
2979
-
2980
-
2981
-
2982
-
2983
- </div>
2984
-
2985
- <br class="clear">
2986
-
2987
- <footer>
2988
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Nov 28 2025 11:22:56 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2989
- </footer>
2990
-
2991
- <script>prettyPrint();</script>
2992
- <script src="scripts/polyfill.js"></script>
2993
- <script src="scripts/linenumber.js"></script>
2994
-
2995
-
2996
-
2997
- </body>
2998
- </html>