musora-content-services 2.31.1 → 2.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/docs/ContentOrganization.html +2 -2
- package/docs/Gamification.html +2 -2
- package/docs/UserManagementSystem.html +2 -2
- package/docs/api_types.js.html +2 -2
- package/docs/config.js.html +2 -8
- package/docs/content-org_content-org.js.html +2 -2
- package/docs/content-org_playlists-types.js.html +12 -2
- package/docs/content-org_playlists.js.html +16 -16
- package/docs/content.js.html +71 -39
- package/docs/gamification_awards.js.html +54 -35
- package/docs/gamification_gamification.js.html +2 -2
- package/docs/gamification_types.js.html +7 -25
- package/docs/global.html +298 -322
- package/docs/index.html +2 -2
- package/docs/module-Awards.html +2 -2
- package/docs/module-Config.html +4 -8
- package/docs/module-Content-Services-V2.html +455 -8
- package/docs/module-Interests.html +2 -2
- package/docs/module-Permissions.html +2 -2
- package/docs/module-Playlists.html +18 -17
- package/docs/module-Railcontent-Services.html +479 -35
- package/docs/module-Sanity-Services.html +45 -173
- package/docs/module-Sessions.html +2 -2
- package/docs/module-UserActivity.html +189 -21
- package/docs/module-UserChat.html +2 -2
- package/docs/module-UserManagement.html +410 -8
- package/docs/module-UserNotifications.html +203 -8
- package/docs/module-UserProfile.html +2 -2
- package/docs/railcontent.js.html +65 -37
- package/docs/sanity.js.html +120 -185
- package/docs/userActivity.js.html +448 -466
- package/docs/user_chat.js.html +2 -2
- package/docs/user_interests.js.html +2 -2
- package/docs/user_management.js.html +32 -2
- package/docs/user_notifications.js.html +27 -5
- package/docs/user_permissions.js.html +2 -2
- package/docs/user_profile.js.html +3 -9
- package/docs/user_sessions.js.html +2 -2
- package/docs/user_types.js.html +10 -2
- package/docs/user_user-management-system.js.html +2 -2
- package/package.json +1 -1
- package/src/contentTypeConfig.js +6 -1
- package/src/index.d.ts +6 -0
- package/src/index.js +6 -0
- package/src/services/content.js +1 -1
- package/src/services/sanity.js +14 -19
- package/src/services/user/management.js +30 -0
- package/src/services/user/types.js +8 -0
package/docs/global.html
CHANGED
|
@@ -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#~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#.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#.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#.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#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</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#.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#.getUserData">getUserData</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#.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#.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="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-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#.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-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#~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#.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#.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#.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-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="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
|
|
|
@@ -141,7 +141,7 @@
|
|
|
141
141
|
|
|
142
142
|
<dt class="tag-source">Source:</dt>
|
|
143
143
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
144
|
-
<a href="content-org_playlists-types.js.html">content-org/playlists-types.js</a>, <a href="content-org_playlists-types.js.html#
|
|
144
|
+
<a href="content-org_playlists-types.js.html">content-org/playlists-types.js</a>, <a href="content-org_playlists-types.js.html#line48">line 48</a>
|
|
145
145
|
</li></ul></dd>
|
|
146
146
|
|
|
147
147
|
|
|
@@ -585,55 +585,7 @@
|
|
|
585
585
|
|
|
586
586
|
<tr>
|
|
587
587
|
|
|
588
|
-
<td class="name"><code>
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
<td class="type">
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
<span class="param-type">string</span>
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
</td>
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
<td class="description last">The username of the user.</td>
|
|
606
|
-
</tr>
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
<tr>
|
|
611
|
-
|
|
612
|
-
<td class="name"><code>streak</code></td>
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
<td class="type">
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
<span class="param-type">number</span>
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
</td>
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
<td class="description last">The name of the award.</td>
|
|
630
|
-
</tr>
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
<tr>
|
|
635
|
-
|
|
636
|
-
<td class="name"><code>minutes_practiced</code></td>
|
|
588
|
+
<td class="name"><code>id</code></td>
|
|
637
589
|
|
|
638
590
|
|
|
639
591
|
<td class="type">
|
|
@@ -650,38 +602,14 @@
|
|
|
650
602
|
|
|
651
603
|
|
|
652
604
|
|
|
653
|
-
<td class="description last">
|
|
605
|
+
<td class="description last">Unique identifier for the award.</td>
|
|
654
606
|
</tr>
|
|
655
607
|
|
|
656
608
|
|
|
657
609
|
|
|
658
610
|
<tr>
|
|
659
611
|
|
|
660
|
-
<td class="name"><code>
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
<td class="type">
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
<span class="param-type">Date</span>
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
</td>
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
<td class="description last">Date of completion</td>
|
|
678
|
-
</tr>
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
<tr>
|
|
683
|
-
|
|
684
|
-
<td class="name"><code>challenge_title</code></td>
|
|
612
|
+
<td class="name"><code>title</code></td>
|
|
685
613
|
|
|
686
614
|
|
|
687
615
|
<td class="type">
|
|
@@ -698,14 +626,14 @@
|
|
|
698
626
|
|
|
699
627
|
|
|
700
628
|
|
|
701
|
-
<td class="description last">The
|
|
629
|
+
<td class="description last">The title of the award.</td>
|
|
702
630
|
</tr>
|
|
703
631
|
|
|
704
632
|
|
|
705
633
|
|
|
706
634
|
<tr>
|
|
707
635
|
|
|
708
|
-
<td class="name"><code>
|
|
636
|
+
<td class="name"><code>badge</code></td>
|
|
709
637
|
|
|
710
638
|
|
|
711
639
|
<td class="type">
|
|
@@ -722,14 +650,14 @@
|
|
|
722
650
|
|
|
723
651
|
|
|
724
652
|
|
|
725
|
-
<td class="description last">
|
|
653
|
+
<td class="description last">URL of the award badge image.</td>
|
|
726
654
|
</tr>
|
|
727
655
|
|
|
728
656
|
|
|
729
657
|
|
|
730
658
|
<tr>
|
|
731
659
|
|
|
732
|
-
<td class="name"><code>
|
|
660
|
+
<td class="name"><code>description</code></td>
|
|
733
661
|
|
|
734
662
|
|
|
735
663
|
<td class="type">
|
|
@@ -746,20 +674,20 @@
|
|
|
746
674
|
|
|
747
675
|
|
|
748
676
|
|
|
749
|
-
<td class="description last">
|
|
677
|
+
<td class="description last">Description of the award.</td>
|
|
750
678
|
</tr>
|
|
751
679
|
|
|
752
680
|
|
|
753
681
|
|
|
754
682
|
<tr>
|
|
755
683
|
|
|
756
|
-
<td class="name"><code>
|
|
684
|
+
<td class="name"><code>date_completed</code></td>
|
|
757
685
|
|
|
758
686
|
|
|
759
687
|
<td class="type">
|
|
760
688
|
|
|
761
689
|
|
|
762
|
-
<span class="param-type">
|
|
690
|
+
<span class="param-type">Date</span>
|
|
763
691
|
|
|
764
692
|
|
|
765
693
|
|
|
@@ -770,308 +698,120 @@
|
|
|
770
698
|
|
|
771
699
|
|
|
772
700
|
|
|
773
|
-
<td class="description last">
|
|
701
|
+
<td class="description last">Date when the award was completed.</td>
|
|
774
702
|
</tr>
|
|
775
703
|
|
|
776
704
|
|
|
705
|
+
</tbody>
|
|
706
|
+
</table>
|
|
777
707
|
|
|
778
|
-
<tr>
|
|
779
|
-
|
|
780
|
-
<td class="name"><code>award_64</code></td>
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
<td class="type">
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
<span class="param-type">string</span>
|
|
787
708
|
|
|
788
709
|
|
|
789
710
|
|
|
790
|
-
|
|
791
|
-
</td>
|
|
792
711
|
|
|
793
|
-
|
|
794
712
|
|
|
795
|
-
|
|
796
713
|
|
|
797
|
-
<td class="description last">Award image in base64</td>
|
|
798
|
-
</tr>
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
<tr>
|
|
803
|
-
|
|
804
|
-
<td class="name"><code>instructor_signature</code></td>
|
|
805
|
-
|
|
806
714
|
|
|
807
|
-
|
|
715
|
+
<h5 class="h5-types">Type:</h5>
|
|
716
|
+
<ul>
|
|
717
|
+
<li>
|
|
808
718
|
|
|
809
|
-
|
|
810
|
-
<span class="param-type">string</span>
|
|
719
|
+
<span class="param-type">Object</span>
|
|
811
720
|
|
|
812
721
|
|
|
813
722
|
|
|
814
|
-
|
|
815
|
-
|
|
723
|
+
</li>
|
|
724
|
+
</ul>
|
|
816
725
|
|
|
817
|
-
|
|
818
726
|
|
|
819
|
-
|
|
820
727
|
|
|
821
|
-
<td class="description last">Instructor signature image URL</td>
|
|
822
|
-
</tr>
|
|
823
728
|
|
|
824
|
-
|
|
825
729
|
|
|
826
|
-
<tr>
|
|
827
|
-
|
|
828
|
-
<td class="name"><code>instructor_signature_64</code></td>
|
|
829
|
-
|
|
830
730
|
|
|
831
|
-
<td class="type">
|
|
832
731
|
|
|
833
732
|
|
|
834
|
-
<
|
|
835
|
-
|
|
733
|
+
<h4 class="name" id="BlockedUsersDTO">BlockedUsersDTO</h4>
|
|
836
734
|
|
|
837
735
|
|
|
838
|
-
|
|
839
|
-
</td>
|
|
840
|
-
|
|
841
|
-
|
|
842
736
|
|
|
843
|
-
|
|
844
737
|
|
|
845
|
-
<td class="description last">Instructor signature image in base64</td>
|
|
846
|
-
</tr>
|
|
847
738
|
|
|
739
|
+
<dl class="details">
|
|
848
740
|
|
|
849
741
|
|
|
850
|
-
<tr>
|
|
851
|
-
|
|
852
|
-
<td class="name"><code>musora_logo</code></td>
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
<td class="type">
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
<span class="param-type">string</span>
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
</td>
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
<td class="description last">Musora logo image URL</td>
|
|
870
|
-
</tr>
|
|
871
|
-
|
|
872
742
|
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
<td class="type">
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
<span class="param-type">string</span>
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
</td>
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
<td class="description last">Musora logo image in base64</td>
|
|
894
|
-
</tr>
|
|
895
|
-
|
|
743
|
+
<dt class="tag-source">Source:</dt>
|
|
744
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
745
|
+
<a href="user_types.js.html">user/types.js</a>, <a href="user_types.js.html#line138">line 138</a>
|
|
746
|
+
</li></ul></dd>
|
|
896
747
|
|
|
897
748
|
|
|
898
|
-
<tr>
|
|
899
|
-
|
|
900
|
-
<td class="name"><code>brand_logo</code></td>
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
<td class="type">
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
<span class="param-type">string</span>
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
</td>
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
<td class="description last">Brand logo image URL</td>
|
|
918
|
-
</tr>
|
|
919
|
-
|
|
920
749
|
|
|
921
750
|
|
|
922
|
-
<tr>
|
|
923
|
-
|
|
924
|
-
<td class="name"><code>brand_logo_64</code></td>
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
<td class="type">
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
<span class="param-type">string</span>
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
</td>
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
<td class="description last">Brand logo image in base64</td>
|
|
942
|
-
</tr>
|
|
943
|
-
|
|
944
751
|
|
|
945
752
|
|
|
946
|
-
<tr>
|
|
947
|
-
|
|
948
|
-
<td class="name"><code>ribbon_image</code></td>
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
<td class="type">
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
<span class="param-type">string</span>
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
</td>
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
<td class="description last">Ribbon image URL</td>
|
|
966
|
-
</tr>
|
|
967
|
-
|
|
968
753
|
|
|
969
754
|
|
|
970
|
-
<tr>
|
|
971
|
-
|
|
972
|
-
<td class="name"><code>ribbon_image_64</code></td>
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
<td class="type">
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
<span class="param-type">string</span>
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
</td>
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
<td class="description last">Ribbon image in base64</td>
|
|
990
|
-
</tr>
|
|
991
|
-
|
|
992
755
|
|
|
993
756
|
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
<td class="name"><code>id</code></td>
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
<td class="type">
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
<span class="param-type">number</span>
|
|
1003
|
-
|
|
1004
|
-
|
|
757
|
+
|
|
1005
758
|
|
|
1006
|
-
|
|
1007
|
-
</td>
|
|
759
|
+
|
|
1008
760
|
|
|
1009
|
-
|
|
761
|
+
|
|
1010
762
|
|
|
1011
|
-
|
|
763
|
+
|
|
1012
764
|
|
|
1013
|
-
|
|
1014
|
-
</tr>
|
|
765
|
+
|
|
1015
766
|
|
|
1016
767
|
|
|
1017
768
|
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
<td class="name"><code>artist_name</code></td>
|
|
1021
|
-
|
|
769
|
+
|
|
1022
770
|
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
<span class="param-type">string</span>
|
|
771
|
+
|
|
1027
772
|
|
|
773
|
+
|
|
1028
774
|
|
|
775
|
+
|
|
1029
776
|
|
|
1030
|
-
|
|
1031
|
-
|
|
777
|
+
|
|
778
|
+
</dl>
|
|
1032
779
|
|
|
1033
|
-
|
|
1034
780
|
|
|
1035
|
-
|
|
1036
781
|
|
|
1037
|
-
|
|
1038
|
-
</tr>
|
|
782
|
+
<h5 class="subsection-title">Properties:</h5>
|
|
1039
783
|
|
|
1040
784
|
|
|
1041
785
|
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
<span class="param-type">string</span>
|
|
1051
|
-
|
|
1052
|
-
|
|
786
|
+
<table class="props">
|
|
787
|
+
<thead>
|
|
788
|
+
<tr>
|
|
789
|
+
|
|
790
|
+
<th>Name</th>
|
|
791
|
+
|
|
1053
792
|
|
|
1054
|
-
|
|
1055
|
-
</td>
|
|
793
|
+
<th>Type</th>
|
|
1056
794
|
|
|
1057
|
-
|
|
795
|
+
|
|
1058
796
|
|
|
1059
|
-
|
|
797
|
+
|
|
1060
798
|
|
|
1061
|
-
|
|
1062
|
-
|
|
799
|
+
<th class="last">Description</th>
|
|
800
|
+
</tr>
|
|
801
|
+
</thead>
|
|
1063
802
|
|
|
803
|
+
<tbody>
|
|
1064
804
|
|
|
1065
805
|
|
|
1066
806
|
<tr>
|
|
1067
807
|
|
|
1068
|
-
<td class="name"><code>
|
|
808
|
+
<td class="name"><code>id</code></td>
|
|
1069
809
|
|
|
1070
810
|
|
|
1071
811
|
<td class="type">
|
|
1072
812
|
|
|
1073
813
|
|
|
1074
|
-
<span class="param-type">
|
|
814
|
+
<span class="param-type">number</span>
|
|
1075
815
|
|
|
1076
816
|
|
|
1077
817
|
|
|
@@ -1082,14 +822,14 @@
|
|
|
1082
822
|
|
|
1083
823
|
|
|
1084
824
|
|
|
1085
|
-
<td class="description last"
|
|
825
|
+
<td class="description last"></td>
|
|
1086
826
|
</tr>
|
|
1087
827
|
|
|
1088
828
|
|
|
1089
829
|
|
|
1090
830
|
<tr>
|
|
1091
831
|
|
|
1092
|
-
<td class="name"><code>
|
|
832
|
+
<td class="name"><code>display_name</code></td>
|
|
1093
833
|
|
|
1094
834
|
|
|
1095
835
|
<td class="type">
|
|
@@ -1106,20 +846,23 @@
|
|
|
1106
846
|
|
|
1107
847
|
|
|
1108
848
|
|
|
1109
|
-
<td class="description last"
|
|
849
|
+
<td class="description last"></td>
|
|
1110
850
|
</tr>
|
|
1111
851
|
|
|
1112
852
|
|
|
1113
853
|
|
|
1114
854
|
<tr>
|
|
1115
855
|
|
|
1116
|
-
<td class="name"><code>
|
|
856
|
+
<td class="name"><code>profile_picture_url</code></td>
|
|
1117
857
|
|
|
1118
858
|
|
|
1119
859
|
<td class="type">
|
|
1120
860
|
|
|
1121
861
|
|
|
1122
862
|
<span class="param-type">string</span>
|
|
863
|
+
|
|
|
864
|
+
|
|
865
|
+
<span class="param-type">null</span>
|
|
1123
866
|
|
|
1124
867
|
|
|
1125
868
|
|
|
@@ -1130,7 +873,7 @@
|
|
|
1130
873
|
|
|
1131
874
|
|
|
1132
875
|
|
|
1133
|
-
<td class="description last"
|
|
876
|
+
<td class="description last"></td>
|
|
1134
877
|
</tr>
|
|
1135
878
|
|
|
1136
879
|
|
|
@@ -1995,7 +1738,7 @@
|
|
|
1995
1738
|
|
|
1996
1739
|
<dt class="tag-source">Source:</dt>
|
|
1997
1740
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1998
|
-
<a href="content-org_playlists-types.js.html">content-org/playlists-types.js</a>, <a href="content-org_playlists-types.js.html#
|
|
1741
|
+
<a href="content-org_playlists-types.js.html">content-org/playlists-types.js</a>, <a href="content-org_playlists-types.js.html#line21">line 21</a>
|
|
1999
1742
|
</li></ul></dd>
|
|
2000
1743
|
|
|
2001
1744
|
|
|
@@ -3132,7 +2875,7 @@
|
|
|
3132
2875
|
|
|
3133
2876
|
<dt class="tag-source">Source:</dt>
|
|
3134
2877
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3135
|
-
<a href="content-org_playlists-types.js.html">content-org/playlists-types.js</a>, <a href="content-org_playlists-types.js.html#
|
|
2878
|
+
<a href="content-org_playlists-types.js.html">content-org/playlists-types.js</a>, <a href="content-org_playlists-types.js.html#line32">line 32</a>
|
|
3136
2879
|
</li></ul></dd>
|
|
3137
2880
|
|
|
3138
2881
|
|
|
@@ -3699,6 +3442,239 @@
|
|
|
3699
3442
|
|
|
3700
3443
|
|
|
3701
3444
|
|
|
3445
|
+
<h4 class="name" id="UpdatePlaylistDTO">UpdatePlaylistDTO</h4>
|
|
3446
|
+
|
|
3447
|
+
|
|
3448
|
+
|
|
3449
|
+
|
|
3450
|
+
|
|
3451
|
+
<dl class="details">
|
|
3452
|
+
|
|
3453
|
+
|
|
3454
|
+
|
|
3455
|
+
<dt class="tag-source">Source:</dt>
|
|
3456
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3457
|
+
<a href="content-org_playlists-types.js.html">content-org/playlists-types.js</a>, <a href="content-org_playlists-types.js.html#line11">line 11</a>
|
|
3458
|
+
</li></ul></dd>
|
|
3459
|
+
|
|
3460
|
+
|
|
3461
|
+
|
|
3462
|
+
|
|
3463
|
+
|
|
3464
|
+
|
|
3465
|
+
|
|
3466
|
+
|
|
3467
|
+
|
|
3468
|
+
|
|
3469
|
+
|
|
3470
|
+
|
|
3471
|
+
|
|
3472
|
+
|
|
3473
|
+
|
|
3474
|
+
|
|
3475
|
+
|
|
3476
|
+
|
|
3477
|
+
|
|
3478
|
+
|
|
3479
|
+
|
|
3480
|
+
|
|
3481
|
+
|
|
3482
|
+
|
|
3483
|
+
|
|
3484
|
+
|
|
3485
|
+
|
|
3486
|
+
|
|
3487
|
+
|
|
3488
|
+
|
|
3489
|
+
|
|
3490
|
+
</dl>
|
|
3491
|
+
|
|
3492
|
+
|
|
3493
|
+
|
|
3494
|
+
<h5 class="subsection-title">Properties:</h5>
|
|
3495
|
+
|
|
3496
|
+
|
|
3497
|
+
|
|
3498
|
+
<table class="props">
|
|
3499
|
+
<thead>
|
|
3500
|
+
<tr>
|
|
3501
|
+
|
|
3502
|
+
<th>Name</th>
|
|
3503
|
+
|
|
3504
|
+
|
|
3505
|
+
<th>Type</th>
|
|
3506
|
+
|
|
3507
|
+
|
|
3508
|
+
|
|
3509
|
+
|
|
3510
|
+
|
|
3511
|
+
<th class="last">Description</th>
|
|
3512
|
+
</tr>
|
|
3513
|
+
</thead>
|
|
3514
|
+
|
|
3515
|
+
<tbody>
|
|
3516
|
+
|
|
3517
|
+
|
|
3518
|
+
<tr>
|
|
3519
|
+
|
|
3520
|
+
<td class="name"><code>name</code></td>
|
|
3521
|
+
|
|
3522
|
+
|
|
3523
|
+
<td class="type">
|
|
3524
|
+
|
|
3525
|
+
|
|
3526
|
+
<span class="param-type">string</span>
|
|
3527
|
+
|
|
3528
|
+
|
|
3529
|
+
|
|
3530
|
+
|
|
3531
|
+
</td>
|
|
3532
|
+
|
|
3533
|
+
|
|
3534
|
+
|
|
3535
|
+
|
|
3536
|
+
|
|
3537
|
+
<td class="description last">The name of the new playlist. (required, max 255 characters)</td>
|
|
3538
|
+
</tr>
|
|
3539
|
+
|
|
3540
|
+
|
|
3541
|
+
|
|
3542
|
+
<tr>
|
|
3543
|
+
|
|
3544
|
+
<td class="name"><code>description</code></td>
|
|
3545
|
+
|
|
3546
|
+
|
|
3547
|
+
<td class="type">
|
|
3548
|
+
|
|
3549
|
+
|
|
3550
|
+
<span class="param-type">string</span>
|
|
3551
|
+
|
|
3552
|
+
|
|
3553
|
+
|
|
3554
|
+
|
|
3555
|
+
</td>
|
|
3556
|
+
|
|
3557
|
+
|
|
3558
|
+
|
|
3559
|
+
|
|
3560
|
+
|
|
3561
|
+
<td class="description last">A description of the playlist. (optional, max 1000 characters)</td>
|
|
3562
|
+
</tr>
|
|
3563
|
+
|
|
3564
|
+
|
|
3565
|
+
|
|
3566
|
+
<tr>
|
|
3567
|
+
|
|
3568
|
+
<td class="name"><code>category</code></td>
|
|
3569
|
+
|
|
3570
|
+
|
|
3571
|
+
<td class="type">
|
|
3572
|
+
|
|
3573
|
+
|
|
3574
|
+
<span class="param-type">string</span>
|
|
3575
|
+
|
|
3576
|
+
|
|
3577
|
+
|
|
3578
|
+
|
|
3579
|
+
</td>
|
|
3580
|
+
|
|
3581
|
+
|
|
3582
|
+
|
|
3583
|
+
|
|
3584
|
+
|
|
3585
|
+
<td class="description last">The category of the playlist. (optional, max 255 characters)</td>
|
|
3586
|
+
</tr>
|
|
3587
|
+
|
|
3588
|
+
|
|
3589
|
+
|
|
3590
|
+
<tr>
|
|
3591
|
+
|
|
3592
|
+
<td class="name"><code>is_private</code></td>
|
|
3593
|
+
|
|
3594
|
+
|
|
3595
|
+
<td class="type">
|
|
3596
|
+
|
|
3597
|
+
|
|
3598
|
+
<span class="param-type">boolean</span>
|
|
3599
|
+
|
|
3600
|
+
|
|
3601
|
+
|
|
3602
|
+
|
|
3603
|
+
</td>
|
|
3604
|
+
|
|
3605
|
+
|
|
3606
|
+
|
|
3607
|
+
|
|
3608
|
+
|
|
3609
|
+
<td class="description last">Whether the playlist is private. (optional, defaults to false)</td>
|
|
3610
|
+
</tr>
|
|
3611
|
+
|
|
3612
|
+
|
|
3613
|
+
|
|
3614
|
+
<tr>
|
|
3615
|
+
|
|
3616
|
+
<td class="name"><code>deleted_items</code></td>
|
|
3617
|
+
|
|
3618
|
+
|
|
3619
|
+
<td class="type">
|
|
3620
|
+
|
|
3621
|
+
|
|
3622
|
+
<span class="param-type">Array.<number></span>
|
|
3623
|
+
|
|
3624
|
+
|
|
3625
|
+
|
|
3626
|
+
|
|
3627
|
+
</td>
|
|
3628
|
+
|
|
3629
|
+
|
|
3630
|
+
|
|
3631
|
+
|
|
3632
|
+
|
|
3633
|
+
<td class="description last">List of playlist items to be deleted. (optional)</td>
|
|
3634
|
+
</tr>
|
|
3635
|
+
|
|
3636
|
+
|
|
3637
|
+
|
|
3638
|
+
<tr>
|
|
3639
|
+
|
|
3640
|
+
<td class="name"><code>item_order</code></td>
|
|
3641
|
+
|
|
3642
|
+
|
|
3643
|
+
<td class="type">
|
|
3644
|
+
|
|
3645
|
+
|
|
3646
|
+
<span class="param-type">Array.<number></span>
|
|
3647
|
+
|
|
3648
|
+
|
|
3649
|
+
|
|
3650
|
+
|
|
3651
|
+
</td>
|
|
3652
|
+
|
|
3653
|
+
|
|
3654
|
+
|
|
3655
|
+
|
|
3656
|
+
|
|
3657
|
+
<td class="description last">List of all remaining playlist item ids (not content_ids) provided in the new order. (optional)</td>
|
|
3658
|
+
</tr>
|
|
3659
|
+
|
|
3660
|
+
|
|
3661
|
+
</tbody>
|
|
3662
|
+
</table>
|
|
3663
|
+
|
|
3664
|
+
|
|
3665
|
+
|
|
3666
|
+
|
|
3667
|
+
|
|
3668
|
+
|
|
3669
|
+
|
|
3670
|
+
|
|
3671
|
+
|
|
3672
|
+
|
|
3673
|
+
|
|
3674
|
+
|
|
3675
|
+
|
|
3676
|
+
|
|
3677
|
+
|
|
3702
3678
|
<h4 class="name" id="User">User</h4>
|
|
3703
3679
|
|
|
3704
3680
|
|
|
@@ -5847,7 +5823,7 @@
|
|
|
5847
5823
|
<br class="clear">
|
|
5848
5824
|
|
|
5849
5825
|
<footer>
|
|
5850
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on
|
|
5826
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Aug 19 2025 17:54:03 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
5851
5827
|
</footer>
|
|
5852
5828
|
|
|
5853
5829
|
<script>prettyPrint();</script>
|