musora-content-services 1.6.6 → 1.6.8

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 (76) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/docs/v2/ContentOrganization.html +2 -2
  3. package/docs/v2/Forums.html +269 -0
  4. package/docs/v2/Gamification.html +2 -2
  5. package/docs/v2/UserManagementSystem.html +2 -2
  6. package/docs/v2/api_types.js.html +2 -2
  7. package/docs/v2/config.js.html +2 -8
  8. package/docs/v2/content-org_content-org.js.html +2 -2
  9. package/docs/v2/content-org_guided-courses.ts.html +110 -0
  10. package/docs/v2/content-org_playlists-types.js.html +14 -2
  11. package/docs/v2/content-org_playlists.js.html +39 -17
  12. package/docs/v2/content.js.html +120 -64
  13. package/docs/v2/forums_categories.ts.html +137 -0
  14. package/docs/v2/forums_discussions.js.html +95 -0
  15. package/docs/v2/forums_forum.js.html +95 -0
  16. package/docs/v2/forums_forums.ts.html +77 -0
  17. package/docs/v2/forums_posts.ts.html +158 -0
  18. package/docs/v2/forums_threads.ts.html +271 -0
  19. package/docs/v2/gamification_awards.js.html +35 -534
  20. package/docs/v2/gamification_awards.ts.html +181 -0
  21. package/docs/v2/gamification_gamification.js.html +2 -2
  22. package/docs/v2/gamification_types.js.html +7 -25
  23. package/docs/v2/global.html +296 -492
  24. package/docs/v2/index.html +2 -3
  25. package/docs/v2/module-Accounts.html +1471 -0
  26. package/docs/v2/module-Awards.html +396 -14
  27. package/docs/v2/module-Categories.html +711 -0
  28. package/docs/v2/module-Config.html +4 -8
  29. package/docs/v2/module-Content-Services-V2.html +460 -46
  30. package/docs/v2/module-ForumCategories.html +687 -0
  31. package/docs/v2/module-ForumDiscussions.html +370 -0
  32. package/docs/v2/module-Forums.html +11961 -0
  33. package/docs/v2/module-GuidedCourses.html +108 -0
  34. package/docs/v2/module-Interests.html +2 -2
  35. package/docs/v2/module-Payments.html +250 -0
  36. package/docs/v2/module-Permissions.html +2 -2
  37. package/docs/v2/module-Playlists.html +212 -44
  38. package/docs/v2/module-Railcontent-Services.html +691 -2177
  39. package/docs/v2/module-Sanity-Services.html +200 -941
  40. package/docs/v2/module-Sessions.html +3 -3
  41. package/docs/v2/module-Threads.html +1119 -0
  42. package/docs/v2/module-UserActivity.html +193 -23
  43. package/docs/v2/module-UserChat.html +410 -0
  44. package/docs/v2/module-UserManagement.html +585 -12
  45. package/docs/v2/module-UserMemberships.html +556 -0
  46. package/docs/v2/module-UserNotifications.html +1399 -27
  47. package/docs/v2/module-UserProfile.html +106 -2
  48. package/docs/v2/railcontent.js.html +105 -235
  49. package/docs/v2/sanity.js.html +263 -415
  50. package/docs/v2/userActivity.js.html +532 -451
  51. package/docs/v2/user_account.ts.html +190 -0
  52. package/docs/v2/user_chat.js.html +98 -0
  53. package/docs/v2/user_interests.js.html +2 -2
  54. package/docs/v2/user_management.js.html +45 -2
  55. package/docs/v2/user_memberships.js.html +144 -0
  56. package/docs/v2/user_notifications.js.html +203 -21
  57. package/docs/v2/user_payments.ts.html +97 -0
  58. package/docs/v2/user_permissions.js.html +2 -2
  59. package/docs/v2/user_profile.js.html +12 -2
  60. package/docs/v2/user_sessions.js.html +33 -2
  61. package/docs/v2/user_types.js.html +10 -2
  62. package/docs/v2/user_user-management-system.js.html +2 -2
  63. package/link_mcs.sh +0 -0
  64. package/package.json +1 -1
  65. package/src/contentTypeConfig.js +3 -3
  66. package/src/services/sanity.js +5 -2
  67. package/docs/v2/Content-Organization.html +0 -245
  68. package/docs/v2/UserManagement.html +0 -269
  69. package/docs/v2/global.html#User +0 -293
  70. package/docs/v2/module-Notifications.html +0 -1183
  71. package/docs/v2/module-Session-Management.html +0 -575
  72. package/docs/v2/module-User-Activity.html +0 -4410
  73. package/docs/v2/module-User-Management.html +0 -490
  74. package/docs/v2/module-User-Permissions.html +0 -406
  75. package/docs/v2/types.js.html +0 -122
  76. package/docs/v2/user_user-management.js.html +0 -78
@@ -29,7 +29,7 @@
29
29
  <nav >
30
30
 
31
31
 
32
- <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#.fetchAwardsForUser">fetchAwardsForUser</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedChallenges">fetchCompletedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchOwnedChallenges">fetchOwnedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSoloNotification">postChallengesSoloNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-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#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-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#.fetchNotifications">fetchNotifications</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></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3><a href="global.html">Global</a></h3>
32
+ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecentForTab">getRecentForTab</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.isDisplayNameAvailable">isDisplayNameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#.fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#.fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#.upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3><a href="global.html">Global</a></h3>
33
33
 
34
34
  </nav>
35
35
 
@@ -94,7 +94,7 @@
94
94
 
95
95
  <dt class="tag-source">Source:</dt>
96
96
  <dd class="tag-source"><ul class="dummy"><li>
97
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line13">line 13</a>
97
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line14">line 14</a>
98
98
  </li></ul></dd>
99
99
 
100
100
 
@@ -182,7 +182,7 @@
182
182
 
183
183
  <dt class="tag-source">Source:</dt>
184
184
  <dd class="tag-source"><ul class="dummy"><li>
185
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line199">line 199</a>
185
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line200">line 200</a>
186
186
  </li></ul></dd>
187
187
 
188
188
 
@@ -401,7 +401,7 @@ the new playlist with the authenticated user. The `name` field is required, whil
401
401
 
402
402
  <dt class="tag-source">Source:</dt>
403
403
  <dd class="tag-source"><ul class="dummy"><li>
404
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line68">line 68</a>
404
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line69">line 69</a>
405
405
  </li></ul></dd>
406
406
 
407
407
 
@@ -572,7 +572,7 @@ playlist content) and last engaged that have this playlist id</li></ul></dd>
572
572
 
573
573
  <dt class="tag-source">Source:</dt>
574
574
  <dd class="tag-source"><ul class="dummy"><li>
575
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line79">line 79</a>
575
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line80">line 80</a>
576
576
  </li></ul></dd>
577
577
 
578
578
 
@@ -726,7 +726,7 @@ playlist content) and last engaged that have this playlist id</li></ul></dd>
726
726
 
727
727
  <dt class="tag-source">Source:</dt>
728
728
  <dd class="tag-source"><ul class="dummy"><li>
729
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line302">line 302</a>
729
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line324">line 324</a>
730
730
  </li></ul></dd>
731
731
 
732
732
 
@@ -923,7 +923,7 @@ The server validates the user's access to the playlist and returns playlist deta
923
923
 
924
924
  <dt class="tag-source">Source:</dt>
925
925
  <dd class="tag-source"><ul class="dummy"><li>
926
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line323">line 323</a>
926
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line345">line 345</a>
927
927
  </li></ul></dd>
928
928
 
929
929
 
@@ -1095,7 +1095,7 @@ The server combines data from the playlist and additional metadata from Sanity t
1095
1095
 
1096
1096
  <dt class="tag-source">Source:</dt>
1097
1097
  <dd class="tag-source"><ul class="dummy"><li>
1098
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line343">line 343</a>
1098
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line365">line 365</a>
1099
1099
  </li></ul></dd>
1100
1100
 
1101
1101
 
@@ -1265,7 +1265,7 @@ Allows optional pagination, sorting, and search parameters to control the result
1265
1265
 
1266
1266
  <dt class="tag-source">Source:</dt>
1267
1267
  <dd class="tag-source"><ul class="dummy"><li>
1268
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line35">line 35</a>
1268
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line36">line 36</a>
1269
1269
  </li></ul></dd>
1270
1270
 
1271
1271
 
@@ -1607,7 +1607,7 @@ Allows optional pagination, sorting, and search parameters to control the result
1607
1607
 
1608
1608
  <dt class="tag-source">Source:</dt>
1609
1609
  <dd class="tag-source"><ul class="dummy"><li>
1610
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line217">line 217</a>
1610
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line218">line 218</a>
1611
1611
  </li></ul></dd>
1612
1612
 
1613
1613
 
@@ -1800,7 +1800,7 @@ playlist content) and last engaged that have this playlist id</li></ul></dd>
1800
1800
 
1801
1801
  <dt class="tag-source">Source:</dt>
1802
1802
  <dd class="tag-source"><ul class="dummy"><li>
1803
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line90">line 90</a>
1803
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line91">line 91</a>
1804
1804
  </li></ul></dd>
1805
1805
 
1806
1806
 
@@ -1954,7 +1954,7 @@ playlist content) and last engaged that have this playlist id</li></ul></dd>
1954
1954
 
1955
1955
  <dt class="tag-source">Source:</dt>
1956
1956
  <dd class="tag-source"><ul class="dummy"><li>
1957
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line245">line 245</a>
1957
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line247">line 247</a>
1958
1958
  </li></ul></dd>
1959
1959
 
1960
1960
 
@@ -2066,7 +2066,7 @@ playlist content) and last engaged that have this playlist id</li></ul></dd>
2066
2066
  <td class="type">
2067
2067
 
2068
2068
 
2069
- <span class="param-type">Object</span>
2069
+ <span class="param-type"><a href="global.html#UpdatePlaylistDTO">UpdatePlaylistDTO</a></span>
2070
2070
 
2071
2071
 
2072
2072
 
@@ -2080,9 +2080,10 @@ playlist content) and last engaged that have this playlist id</li></ul></dd>
2080
2080
  <td class="description last">An object containing fields to update on the playlist:
2081
2081
  - `name` (string): The name of the new playlist (required, max 255 characters).
2082
2082
  - `description` (string): A description of the playlist (optional, max 1000 characters).
2083
- - `category` (string): The category of the playlist.
2084
- + * - `deleted_items` (array): List of playlist item IDs to delete.
2085
- + * - `item_order` (array): Updated order of playlist items (ids, not railcontent_ids).</td>
2083
+ - `category` (string): The category of the playlist (optional).
2084
+ - `is_private` (boolean): Whether the playlist is private (optional, defaults to false).
2085
+ - `deleted_items` (array): List of playlist item IDs to delete (optional).
2086
+ - `item_order` (array): Updated order of playlist items (ids, not railcontent_ids) (optional).</td>
2086
2087
  </tr>
2087
2088
 
2088
2089
 
@@ -2139,7 +2140,7 @@ The server response includes:
2139
2140
 
2140
2141
 
2141
2142
 
2142
- <h4 class="name" id="~likePlaylist"><span class="type-signature type-signature-async, inner">(async, inner) </span>likePlaylist<span class="signature">(playlistId)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2143
+ <h4 class="name" id="~deleteItemsFromPlaylist"><span class="type-signature type-signature-async, inner">(async, inner) </span>deleteItemsFromPlaylist<span class="signature">(playlistId, deleted_items)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2143
2144
 
2144
2145
 
2145
2146
 
@@ -2149,13 +2150,13 @@ The server response includes:
2149
2150
  <dl class="details">
2150
2151
 
2151
2152
  <dt class="tag-description">Description:</dt>
2152
- <dd class="tag-description"><ul class="dummy"><li>Likes a playlist for the current user.</li></ul></dd>
2153
+ <dd class="tag-description"><ul class="dummy"><li>Delete Items from playlist</li></ul></dd>
2153
2154
 
2154
2155
 
2155
2156
 
2156
2157
  <dt class="tag-source">Source:</dt>
2157
2158
  <dd class="tag-source"><ul class="dummy"><li>
2158
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line96">line 96</a>
2159
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line262">line 262</a>
2159
2160
  </li></ul></dd>
2160
2161
 
2161
2162
 
@@ -2202,12 +2203,11 @@ The server response includes:
2202
2203
 
2203
2204
  <h5 class="h5-examples">Example</h5>
2204
2205
 
2205
- <pre class="prettyprint"><code>// Like playlist with ID '123'
2206
+ <pre class="prettyprint"><code>// Delete items 8462221 and 8462222 from playlist 81111
2206
2207
  try {
2207
- const response = await likePlaylist('123');
2208
- console.log('Playlist liked successfully:', response);
2208
+ const response = await deleteItemsFromPlaylist(81111, [8462221, 8462222]);
2209
2209
  } catch (error) {
2210
- console.error('Failed to like playlist:', error);
2210
+ console.error('Failed to delete playlist items:', error);
2211
2211
  }</code></pre>
2212
2212
 
2213
2213
 
@@ -2258,7 +2258,31 @@ try {
2258
2258
 
2259
2259
 
2260
2260
 
2261
- <td class="description last">The unique identifier of the playlist to like.</td>
2261
+ <td class="description last">The unique identifier of the playlist to update.</td>
2262
+ </tr>
2263
+
2264
+
2265
+
2266
+ <tr>
2267
+
2268
+ <td class="name"><code>deleted_items</code></td>
2269
+
2270
+
2271
+ <td class="type">
2272
+
2273
+
2274
+ <span class="param-type">array</span>
2275
+
2276
+
2277
+
2278
+
2279
+ </td>
2280
+
2281
+
2282
+
2283
+
2284
+
2285
+ <td class="description last">list of playlist ids to delete (user_playlist_item_id, not the railcontent_id)</td>
2262
2286
  </tr>
2263
2287
 
2264
2288
 
@@ -2307,7 +2331,7 @@ try {
2307
2331
 
2308
2332
 
2309
2333
 
2310
- <h4 class="name" id="~reportPlaylist"><span class="type-signature type-signature-async, inner">(async, inner) </span>reportPlaylist<span class="signature">(playlistId)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2334
+ <h4 class="name" id="~likePlaylist"><span class="type-signature type-signature-async, inner">(async, inner) </span>likePlaylist<span class="signature">(playlistId)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2311
2335
 
2312
2336
 
2313
2337
 
@@ -2317,13 +2341,13 @@ try {
2317
2341
  <dl class="details">
2318
2342
 
2319
2343
  <dt class="tag-description">Description:</dt>
2320
- <dd class="tag-description"><ul class="dummy"><li>Reports a playlist</li></ul></dd>
2344
+ <dd class="tag-description"><ul class="dummy"><li>Likes a playlist for the current user.</li></ul></dd>
2321
2345
 
2322
2346
 
2323
2347
 
2324
2348
  <dt class="tag-source">Source:</dt>
2325
2349
  <dd class="tag-source"><ul class="dummy"><li>
2326
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line142">line 142</a>
2350
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line97">line 97</a>
2327
2351
  </li></ul></dd>
2328
2352
 
2329
2353
 
@@ -2370,12 +2394,12 @@ try {
2370
2394
 
2371
2395
  <h5 class="h5-examples">Example</h5>
2372
2396
 
2373
- <pre class="prettyprint"><code>// Report playlist with ID '123'
2397
+ <pre class="prettyprint"><code>// Like playlist with ID '123'
2374
2398
  try {
2375
- const response = await reportPlaylist('123');
2376
- console.log('Playlist reported successfully:', response);
2399
+ const response = await likePlaylist('123');
2400
+ console.log('Playlist liked successfully:', response);
2377
2401
  } catch (error) {
2378
- console.error('Failed to report playlist:', error);
2402
+ console.error('Failed to like playlist:', error);
2379
2403
  }</code></pre>
2380
2404
 
2381
2405
 
@@ -2426,7 +2450,7 @@ try {
2426
2450
 
2427
2451
 
2428
2452
 
2429
- <td class="description last">The unique identifier of the playlist to report.</td>
2453
+ <td class="description last">The unique identifier of the playlist to like.</td>
2430
2454
  </tr>
2431
2455
 
2432
2456
 
@@ -2475,7 +2499,7 @@ try {
2475
2499
 
2476
2500
 
2477
2501
 
2478
- <h4 class="name" id="~togglePlaylistPrivate"><span class="type-signature type-signature-async, inner">(async, inner) </span>togglePlaylistPrivate<span class="signature">(playlistId, deleted_items)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2502
+ <h4 class="name" id="~reportPlaylist"><span class="type-signature type-signature-async, inner">(async, inner) </span>reportPlaylist<span class="signature">(playlistId)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2479
2503
 
2480
2504
 
2481
2505
 
@@ -2485,13 +2509,13 @@ try {
2485
2509
  <dl class="details">
2486
2510
 
2487
2511
  <dt class="tag-description">Description:</dt>
2488
- <dd class="tag-description"><ul class="dummy"><li>Delete Items from playlist</li></ul></dd>
2512
+ <dd class="tag-description"><ul class="dummy"><li>Reports a playlist</li></ul></dd>
2489
2513
 
2490
2514
 
2491
2515
 
2492
2516
  <dt class="tag-source">Source:</dt>
2493
2517
  <dd class="tag-source"><ul class="dummy"><li>
2494
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line262">line 262</a>
2518
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line143">line 143</a>
2495
2519
  </li></ul></dd>
2496
2520
 
2497
2521
 
@@ -2538,11 +2562,12 @@ try {
2538
2562
 
2539
2563
  <h5 class="h5-examples">Example</h5>
2540
2564
 
2541
- <pre class="prettyprint"><code>// Delete items 8462221 and 8462222 from playlist 81111
2565
+ <pre class="prettyprint"><code>// Report playlist with ID '123'
2542
2566
  try {
2543
- const response = await deleteItemsFromPlaylist(81111, [8462221, 8462222]);
2567
+ const response = await reportPlaylist('123');
2568
+ console.log('Playlist reported successfully:', response);
2544
2569
  } catch (error) {
2545
- console.error('Failed to delete playlist items:', error);
2570
+ console.error('Failed to report playlist:', error);
2546
2571
  }</code></pre>
2547
2572
 
2548
2573
 
@@ -2593,20 +2618,163 @@ try {
2593
2618
 
2594
2619
 
2595
2620
 
2596
- <td class="description last">The unique identifier of the playlist to update.</td>
2621
+ <td class="description last">The unique identifier of the playlist to report.</td>
2597
2622
  </tr>
2598
2623
 
2599
2624
 
2625
+ </tbody>
2626
+ </table>
2627
+
2628
+
2629
+
2630
+
2631
+
2632
+
2633
+
2634
+
2635
+
2636
+
2637
+
2638
+
2639
+
2640
+
2641
+
2642
+
2643
+ <h5 class="h5-returns">Returns:</h5>
2644
+
2645
+
2646
+
2647
+
2648
+ <dl class="param-type">
2649
+ <dt>
2650
+ Type
2651
+ </dt>
2652
+ <dd>
2653
+
2654
+ <span class="param-type">Promise.&lt;Object></span>
2655
+
2656
+
2657
+
2658
+ </dd>
2659
+ </dl>
2660
+
2661
+
2662
+
2663
+
2664
+
2665
+
2666
+
2667
+
2668
+
2669
+
2670
+ <h4 class="name" id="~restoreItemFromPlaylist"><span class="type-signature type-signature-async, inner">(async, inner) </span>restoreItemFromPlaylist<span class="signature">(playlistItemId)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
2671
+
2672
+
2673
+
2674
+
2675
+
2676
+
2677
+ <dl class="details">
2678
+
2679
+ <dt class="tag-description">Description:</dt>
2680
+ <dd class="tag-description"><ul class="dummy"><li>Restore items</li></ul></dd>
2681
+
2682
+
2683
+
2684
+ <dt class="tag-source">Source:</dt>
2685
+ <dd class="tag-source"><ul class="dummy"><li>
2686
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line284">line 284</a>
2687
+ </li></ul></dd>
2688
+
2689
+
2690
+
2691
+
2692
+
2693
+
2694
+
2695
+
2696
+
2697
+
2698
+
2699
+
2700
+
2701
+
2702
+
2703
+
2704
+
2705
+
2706
+
2707
+
2708
+
2709
+
2710
+
2711
+
2712
+
2713
+
2714
+
2715
+
2716
+
2717
+
2718
+
2719
+ </dl>
2720
+
2721
+
2722
+
2723
+
2724
+
2725
+
2726
+
2727
+
2728
+
2729
+
2730
+
2731
+ <h5 class="h5-examples">Example</h5>
2732
+
2733
+ <pre class="prettyprint"><code>// Restore item 8462221
2734
+ try {
2735
+ const response = await restoreItemFromPlaylist(8462221);
2736
+ } catch (error) {
2737
+ console.error('Failed to restore playlist item:', error);
2738
+ }</code></pre>
2739
+
2740
+
2741
+
2742
+
2743
+ <h5 class="h5-parameters">Parameters:</h5>
2744
+
2745
+
2746
+ <table class="params">
2747
+ <thead>
2748
+ <tr>
2749
+
2750
+ <th>Name</th>
2751
+
2752
+
2753
+ <th>Type</th>
2754
+
2755
+
2756
+
2757
+
2758
+
2759
+ <th class="last">Description</th>
2760
+ </tr>
2761
+ </thead>
2762
+
2763
+ <tbody>
2764
+
2600
2765
 
2601
2766
  <tr>
2602
2767
 
2603
- <td class="name"><code>deleted_items</code></td>
2768
+ <td class="name"><code>playlistItemId</code></td>
2604
2769
 
2605
2770
 
2606
2771
  <td class="type">
2607
2772
 
2608
2773
 
2609
- <span class="param-type">array</span>
2774
+ <span class="param-type">string</span>
2775
+ |
2776
+
2777
+ <span class="param-type">number</span>
2610
2778
 
2611
2779
 
2612
2780
 
@@ -2617,7 +2785,7 @@ try {
2617
2785
 
2618
2786
 
2619
2787
 
2620
- <td class="description last">list of playlist ids to delete (user_playlist_item_id, not the railcontent_id)</td>
2788
+ <td class="description last">The unique identifier of the playlist ite to restore.</td>
2621
2789
  </tr>
2622
2790
 
2623
2791
 
@@ -2682,7 +2850,7 @@ try {
2682
2850
 
2683
2851
  <dt class="tag-source">Source:</dt>
2684
2852
  <dd class="tag-source"><ul class="dummy"><li>
2685
- <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line119">line 119</a>
2853
+ <a href="content-org_playlists.js.html">content-org/playlists.js</a>, <a href="content-org_playlists.js.html#line120">line 120</a>
2686
2854
  </li></ul></dd>
2687
2855
 
2688
2856
 
@@ -2849,7 +3017,7 @@ try {
2849
3017
  <br class="clear">
2850
3018
 
2851
3019
  <footer>
2852
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Jun 16 2025 14:26:22 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
3020
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Oct 02 2025 11:46:05 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2853
3021
  </footer>
2854
3022
 
2855
3023
  <script>prettyPrint();</script>