musora-content-services 2.31.2 → 2.33.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/.coderabbit.yaml +5 -0
  2. package/CHANGELOG.md +27 -0
  3. package/docs/ContentOrganization.html +2 -2
  4. package/docs/Gamification.html +2 -2
  5. package/docs/UserManagementSystem.html +2 -2
  6. package/docs/api_types.js.html +2 -2
  7. package/docs/config.js.html +2 -8
  8. package/docs/content-org_content-org.js.html +2 -2
  9. package/docs/content-org_guided-courses.ts.html +118 -0
  10. package/docs/content-org_playlists-types.js.html +12 -2
  11. package/docs/content-org_playlists.js.html +16 -16
  12. package/docs/content.js.html +71 -39
  13. package/docs/gamification_awards.js.html +54 -35
  14. package/docs/gamification_awards.ts.html +160 -0
  15. package/docs/gamification_gamification.js.html +2 -2
  16. package/docs/gamification_types.js.html +7 -25
  17. package/docs/global.html +250 -494
  18. package/docs/index.html +2 -2
  19. package/docs/module-Accounts.html +108 -0
  20. package/docs/module-Awards.html +196 -11
  21. package/docs/module-Config.html +4 -8
  22. package/docs/module-Content-Services-V2.html +455 -8
  23. package/docs/module-GuidedCourses.html +108 -0
  24. package/docs/module-Interests.html +2 -2
  25. package/docs/module-Permissions.html +2 -2
  26. package/docs/module-Playlists.html +18 -17
  27. package/docs/module-Railcontent-Services.html +479 -35
  28. package/docs/module-Sanity-Services.html +45 -173
  29. package/docs/module-Sessions.html +2 -2
  30. package/docs/module-UserActivity.html +189 -21
  31. package/docs/module-UserChat.html +2 -2
  32. package/docs/module-UserManagement.html +410 -8
  33. package/docs/module-UserNotifications.html +203 -8
  34. package/docs/module-UserProfile.html +2 -2
  35. package/docs/railcontent.js.html +65 -37
  36. package/docs/sanity.js.html +120 -185
  37. package/docs/userActivity.js.html +448 -466
  38. package/docs/user_account.ts.html +138 -0
  39. package/docs/user_chat.js.html +2 -2
  40. package/docs/user_interests.js.html +2 -2
  41. package/docs/user_management.js.html +33 -2
  42. package/docs/user_notifications.js.html +27 -5
  43. package/docs/user_permissions.js.html +2 -2
  44. package/docs/user_profile.js.html +3 -9
  45. package/docs/user_sessions.js.html +2 -2
  46. package/docs/user_types.js.html +10 -2
  47. package/docs/user_user-management-system.js.html +2 -2
  48. package/jsdoc.json +11 -1
  49. package/package.json +5 -1
  50. package/src/contentTypeConfig.js +6 -1
  51. package/src/index.d.ts +14 -2
  52. package/src/index.js +14 -2
  53. package/src/services/api/types.ts +22 -0
  54. package/src/services/gamification/awards.ts +86 -0
  55. package/src/services/sanity.js +14 -19
  56. package/src/services/user/account.ts +24 -0
  57. package/src/services/user/management.js +31 -0
  58. package/src/services/user/types.js +8 -0
  59. package/src/services/userActivity.js +5 -5
  60. package/src/services/gamification/awards.js +0 -93
  61. package/src/services/gamification/types.js +0 -8
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-Accounts.html">Accounts</a></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></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-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-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#line38">line 38</a>
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
 
@@ -510,7 +510,7 @@
510
510
 
511
511
 
512
512
 
513
- <h4 class="name" id="Award">Award</h4>
513
+ <h4 class="name" id="BlockedUsersDTO">BlockedUsersDTO</h4>
514
514
 
515
515
 
516
516
 
@@ -522,7 +522,7 @@
522
522
 
523
523
  <dt class="tag-source">Source:</dt>
524
524
  <dd class="tag-source"><ul class="dummy"><li>
525
- <a href="gamification_types.js.html">gamification/types.js</a>, <a href="gamification_types.js.html#line1">line 1</a>
525
+ <a href="user_types.js.html">user/types.js</a>, <a href="user_types.js.html#line138">line 138</a>
526
526
  </li></ul></dd>
527
527
 
528
528
 
@@ -585,493 +585,13 @@
585
585
 
586
586
  <tr>
587
587
 
588
- <td class="name"><code>username</code></td>
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>
637
-
638
-
639
- <td class="type">
640
-
641
-
642
- <span class="param-type">number</span>
643
-
644
-
645
-
646
-
647
- </td>
648
-
649
-
650
-
651
-
652
-
653
- <td class="description last">The name of the award.</td>
654
- </tr>
655
-
656
-
657
-
658
- <tr>
659
-
660
- <td class="name"><code>date_completed</code></td>
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>
685
-
686
-
687
- <td class="type">
688
-
689
-
690
- <span class="param-type">string</span>
691
-
692
-
693
-
694
-
695
- </td>
696
-
697
-
698
-
699
-
700
-
701
- <td class="description last">The name of the challenge completed.</td>
702
- </tr>
703
-
704
-
705
-
706
- <tr>
707
-
708
- <td class="name"><code>award_text</code></td>
709
-
710
-
711
- <td class="type">
712
-
713
-
714
- <span class="param-type">string</span>
715
-
716
-
717
-
718
-
719
- </td>
720
-
721
-
722
-
723
-
724
-
725
- <td class="description last">Award description</td>
726
- </tr>
727
-
728
-
729
-
730
- <tr>
731
-
732
- <td class="name"><code>tier</code></td>
733
-
734
-
735
- <td class="type">
736
-
737
-
738
- <span class="param-type">string</span>
739
-
740
-
741
-
742
-
743
- </td>
744
-
745
-
746
-
747
-
748
-
749
- <td class="description last">Award tier [bronze, silver, gold]</td>
750
- </tr>
751
-
752
-
753
-
754
- <tr>
755
-
756
- <td class="name"><code>award</code></td>
757
-
758
-
759
- <td class="type">
760
-
761
-
762
- <span class="param-type">string</span>
763
-
764
-
765
-
766
-
767
- </td>
768
-
769
-
770
-
771
-
772
-
773
- <td class="description last">Award image URL</td>
774
- </tr>
775
-
776
-
777
-
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
-
788
-
789
-
790
-
791
- </td>
792
-
793
-
794
-
795
-
796
-
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
-
807
- <td class="type">
808
-
809
-
810
- <span class="param-type">string</span>
811
-
812
-
813
-
814
-
815
- </td>
816
-
817
-
818
-
819
-
820
-
821
- <td class="description last">Instructor signature image URL</td>
822
- </tr>
823
-
824
-
825
-
826
- <tr>
827
-
828
- <td class="name"><code>instructor_signature_64</code></td>
829
-
830
-
831
- <td class="type">
832
-
833
-
834
- <span class="param-type">string</span>
835
-
836
-
837
-
838
-
839
- </td>
840
-
841
-
842
-
843
-
844
-
845
- <td class="description last">Instructor signature image in base64</td>
846
- </tr>
847
-
848
-
849
-
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
-
873
-
874
- <tr>
875
-
876
- <td class="name"><code>musora_logo_64</code></td>
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
-
896
-
897
-
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
-
921
-
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
-
945
-
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
-
969
-
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
-
993
-
994
- <tr>
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
-
1005
-
1006
-
1007
- </td>
1008
-
1009
-
1010
-
1011
-
1012
-
1013
- <td class="description last">ID of the challenge completed</td>
1014
- </tr>
1015
-
1016
-
1017
-
1018
- <tr>
1019
-
1020
- <td class="name"><code>artist_name</code></td>
1021
-
1022
-
1023
- <td class="type">
1024
-
1025
-
1026
- <span class="param-type">string</span>
1027
-
1028
-
1029
-
1030
-
1031
- </td>
1032
-
1033
-
1034
-
1035
-
1036
-
1037
- <td class="description last">Name of the artist featured in the challenge</td>
1038
- </tr>
1039
-
1040
-
1041
-
1042
- <tr>
1043
-
1044
- <td class="name"><code>dark_mode_logo_url</code></td>
1045
-
1046
-
1047
- <td class="type">
1048
-
1049
-
1050
- <span class="param-type">string</span>
1051
-
1052
-
1053
-
1054
-
1055
- </td>
1056
-
1057
-
1058
-
1059
-
1060
-
1061
- <td class="description last">Dark mode logo image URL</td>
1062
- </tr>
1063
-
1064
-
1065
-
1066
- <tr>
1067
-
1068
- <td class="name"><code>light_mode_logo_url</code></td>
588
+ <td class="name"><code>id</code></td>
1069
589
 
1070
590
 
1071
591
  <td class="type">
1072
592
 
1073
593
 
1074
- <span class="param-type">string</span>
594
+ <span class="param-type">number</span>
1075
595
 
1076
596
 
1077
597
 
@@ -1082,14 +602,14 @@
1082
602
 
1083
603
 
1084
604
 
1085
- <td class="description last">Light mode logo image URL</td>
605
+ <td class="description last"></td>
1086
606
  </tr>
1087
607
 
1088
608
 
1089
609
 
1090
610
  <tr>
1091
611
 
1092
- <td class="name"><code>logo_image_url</code></td>
612
+ <td class="name"><code>display_name</code></td>
1093
613
 
1094
614
 
1095
615
  <td class="type">
@@ -1106,20 +626,23 @@
1106
626
 
1107
627
 
1108
628
 
1109
- <td class="description last">Name of the artist featured in the challenge</td>
629
+ <td class="description last"></td>
1110
630
  </tr>
1111
631
 
1112
632
 
1113
633
 
1114
634
  <tr>
1115
635
 
1116
- <td class="name"><code>web_url_path</code></td>
636
+ <td class="name"><code>profile_picture_url</code></td>
1117
637
 
1118
638
 
1119
639
  <td class="type">
1120
640
 
1121
641
 
1122
642
  <span class="param-type">string</span>
643
+ |
644
+
645
+ <span class="param-type">null</span>
1123
646
 
1124
647
 
1125
648
 
@@ -1130,7 +653,7 @@
1130
653
 
1131
654
 
1132
655
 
1133
- <td class="description last">URL path for the challenge</td>
656
+ <td class="description last"></td>
1134
657
  </tr>
1135
658
 
1136
659
 
@@ -1995,7 +1518,7 @@
1995
1518
 
1996
1519
  <dt class="tag-source">Source:</dt>
1997
1520
  <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#line11">line 11</a>
1521
+ <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
1522
  </li></ul></dd>
2000
1523
 
2001
1524
 
@@ -3132,7 +2655,7 @@
3132
2655
 
3133
2656
  <dt class="tag-source">Source:</dt>
3134
2657
  <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#line22">line 22</a>
2658
+ <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
2659
  </li></ul></dd>
3137
2660
 
3138
2661
 
@@ -3699,6 +3222,239 @@
3699
3222
 
3700
3223
 
3701
3224
 
3225
+ <h4 class="name" id="UpdatePlaylistDTO">UpdatePlaylistDTO</h4>
3226
+
3227
+
3228
+
3229
+
3230
+
3231
+ <dl class="details">
3232
+
3233
+
3234
+
3235
+ <dt class="tag-source">Source:</dt>
3236
+ <dd class="tag-source"><ul class="dummy"><li>
3237
+ <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>
3238
+ </li></ul></dd>
3239
+
3240
+
3241
+
3242
+
3243
+
3244
+
3245
+
3246
+
3247
+
3248
+
3249
+
3250
+
3251
+
3252
+
3253
+
3254
+
3255
+
3256
+
3257
+
3258
+
3259
+
3260
+
3261
+
3262
+
3263
+
3264
+
3265
+
3266
+
3267
+
3268
+
3269
+
3270
+ </dl>
3271
+
3272
+
3273
+
3274
+ <h5 class="subsection-title">Properties:</h5>
3275
+
3276
+
3277
+
3278
+ <table class="props">
3279
+ <thead>
3280
+ <tr>
3281
+
3282
+ <th>Name</th>
3283
+
3284
+
3285
+ <th>Type</th>
3286
+
3287
+
3288
+
3289
+
3290
+
3291
+ <th class="last">Description</th>
3292
+ </tr>
3293
+ </thead>
3294
+
3295
+ <tbody>
3296
+
3297
+
3298
+ <tr>
3299
+
3300
+ <td class="name"><code>name</code></td>
3301
+
3302
+
3303
+ <td class="type">
3304
+
3305
+
3306
+ <span class="param-type">string</span>
3307
+
3308
+
3309
+
3310
+
3311
+ </td>
3312
+
3313
+
3314
+
3315
+
3316
+
3317
+ <td class="description last">The name of the new playlist. (required, max 255 characters)</td>
3318
+ </tr>
3319
+
3320
+
3321
+
3322
+ <tr>
3323
+
3324
+ <td class="name"><code>description</code></td>
3325
+
3326
+
3327
+ <td class="type">
3328
+
3329
+
3330
+ <span class="param-type">string</span>
3331
+
3332
+
3333
+
3334
+
3335
+ </td>
3336
+
3337
+
3338
+
3339
+
3340
+
3341
+ <td class="description last">A description of the playlist. (optional, max 1000 characters)</td>
3342
+ </tr>
3343
+
3344
+
3345
+
3346
+ <tr>
3347
+
3348
+ <td class="name"><code>category</code></td>
3349
+
3350
+
3351
+ <td class="type">
3352
+
3353
+
3354
+ <span class="param-type">string</span>
3355
+
3356
+
3357
+
3358
+
3359
+ </td>
3360
+
3361
+
3362
+
3363
+
3364
+
3365
+ <td class="description last">The category of the playlist. (optional, max 255 characters)</td>
3366
+ </tr>
3367
+
3368
+
3369
+
3370
+ <tr>
3371
+
3372
+ <td class="name"><code>is_private</code></td>
3373
+
3374
+
3375
+ <td class="type">
3376
+
3377
+
3378
+ <span class="param-type">boolean</span>
3379
+
3380
+
3381
+
3382
+
3383
+ </td>
3384
+
3385
+
3386
+
3387
+
3388
+
3389
+ <td class="description last">Whether the playlist is private. (optional, defaults to false)</td>
3390
+ </tr>
3391
+
3392
+
3393
+
3394
+ <tr>
3395
+
3396
+ <td class="name"><code>deleted_items</code></td>
3397
+
3398
+
3399
+ <td class="type">
3400
+
3401
+
3402
+ <span class="param-type">Array.&lt;number></span>
3403
+
3404
+
3405
+
3406
+
3407
+ </td>
3408
+
3409
+
3410
+
3411
+
3412
+
3413
+ <td class="description last">List of playlist items to be deleted. (optional)</td>
3414
+ </tr>
3415
+
3416
+
3417
+
3418
+ <tr>
3419
+
3420
+ <td class="name"><code>item_order</code></td>
3421
+
3422
+
3423
+ <td class="type">
3424
+
3425
+
3426
+ <span class="param-type">Array.&lt;number></span>
3427
+
3428
+
3429
+
3430
+
3431
+ </td>
3432
+
3433
+
3434
+
3435
+
3436
+
3437
+ <td class="description last">List of all remaining playlist item ids (not content_ids) provided in the new order. (optional)</td>
3438
+ </tr>
3439
+
3440
+
3441
+ </tbody>
3442
+ </table>
3443
+
3444
+
3445
+
3446
+
3447
+
3448
+
3449
+
3450
+
3451
+
3452
+
3453
+
3454
+
3455
+
3456
+
3457
+
3702
3458
  <h4 class="name" id="User">User</h4>
3703
3459
 
3704
3460
 
@@ -5847,7 +5603,7 @@
5847
5603
  <br class="clear">
5848
5604
 
5849
5605
  <footer>
5850
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Jul 25 2025 21:19:12 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
5606
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Aug 26 2025 21:32:22 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
5851
5607
  </footer>
5852
5608
 
5853
5609
  <script>prettyPrint();</script>