musora-content-services 2.1.1 → 2.2.1
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 +9 -0
- package/docs/Content-Organization.html +2 -2
- package/docs/Gamification.html +245 -0
- package/docs/api_types.js.html +97 -0
- package/docs/config.js.html +2 -2
- package/docs/content-org_playlists-types.js.html +3 -5
- package/docs/content-org_playlists.js.html +8 -9
- package/docs/content.js.html +2 -2
- package/docs/gamification_awards.js.html +664 -0
- package/docs/gamification_gamification.js.html +76 -0
- package/docs/gamification_types.js.html +98 -0
- package/docs/global.html +1441 -153
- package/docs/index.html +2 -2
- package/docs/module-Awards.html +354 -0
- package/docs/module-Config.html +2 -2
- package/docs/module-Content-Services-V2.html +2 -2
- package/docs/module-Playlists.html +6 -6
- package/docs/module-Railcontent-Services.html +33 -194
- package/docs/module-Sanity-Services.html +885 -90
- package/docs/module-Session-Management.html +2 -2
- package/docs/module-User-Permissions.html +2 -2
- package/docs/railcontent.js.html +13 -25
- package/docs/sanity.js.html +76 -5
- package/docs/user_permissions.js.html +3 -3
- package/docs/user_sessions.js.html +4 -4
- package/docs/user_types.js.html +2 -2
- package/jsdoc.json +4 -2
- package/package.json +1 -1
- package/src/contentTypeConfig.js +1 -0
- package/src/index.d.ts +40 -3
- package/src/index.js +40 -2
- package/src/services/api/types.js +25 -0
- package/src/services/dataContext.js +15 -2
- package/src/services/gamification/awards.js +592 -0
- package/src/services/gamification/gamification.js +4 -0
- package/src/services/gamification/types.js +26 -0
- package/src/services/railcontent.js +60 -0
- package/src/services/sanity.js +22 -21
- package/src/services/userActivity.js +377 -23
- package/test/contentLikes.test.js +2 -0
- package/test/mockData/mockData_fetchByRailContentIds_one_content.json +35 -0
- package/test/userActivity.test.js +118 -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-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-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#.fetchUserPlaylists">fetchUserPlaylists</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#.countAssignmentsAndLessons">countAssignmentsAndLessons</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#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistItem">deletePlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistLike">deletePlaylistLike</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedChallenges">fetchCompletedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchOwnedChallenges">fetchOwnedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPinnedPlaylists">fetchPinnedPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItem">fetchPlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likePlaylist">likePlaylist</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#.pinPlaylist">pinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCompleteLesson">postChallengesCompleteLesson</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSoloNotification">postChallengesSoloNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportPlaylist">reportPlaylist</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#.unpinPlaylist">unpinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylistItem">updatePlaylistItem</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#.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#.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#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</a></li></ul></li><li><a href="module-Session-Management.html">Session-Management</a><ul class='methods'><li data-type='method'><a href="module-Session-Management.html#.login">login</a></li><li data-type='method'><a href="module-Session-Management.html#.logout">logout</a></li></ul></li><li><a href="module-User-Permissions.html">User-Permissions</a><ul class='methods'><li data-type='method'><a href="module-User-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-User-Permissions.html#.reset">reset</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="Content-Organization.html">Content-Organization</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#.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-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#.fetchUserPlaylists">fetchUserPlaylists</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#.countAssignmentsAndLessons">countAssignmentsAndLessons</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#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistItem">deletePlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistLike">deletePlaylistLike</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedChallenges">fetchCompletedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchOwnedChallenges">fetchOwnedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPinnedPlaylists">fetchPinnedPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItem">fetchPlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likePlaylist">likePlaylist</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#.pinPlaylist">pinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSoloNotification">postChallengesSoloNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportPlaylist">reportPlaylist</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#.unpinPlaylist">unpinPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylistItem">updatePlaylistItem</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</a></li></ul></li><li><a href="module-Session-Management.html">Session-Management</a><ul class='methods'><li data-type='method'><a href="module-Session-Management.html#.login">login</a></li><li data-type='method'><a href="module-Session-Management.html#.logout">logout</a></li></ul></li><li><a href="module-User-Permissions.html">User-Permissions</a><ul class='methods'><li data-type='method'><a href="module-User-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-User-Permissions.html#.reset">reset</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="Content-Organization.html">Content-Organization</a></li><li><a href="Gamification.html">Gamification</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#line26">line 26</a>
|
|
145
145
|
</li></ul></dd>
|
|
146
146
|
|
|
147
147
|
|
|
@@ -534,6 +534,658 @@
|
|
|
534
534
|
|
|
535
535
|
|
|
536
536
|
|
|
537
|
+
<h4 class="name" id="Award">Award</h4>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
<dl class="details">
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<dt class="tag-source">Source:</dt>
|
|
548
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
549
|
+
<a href="gamification_types.js.html">gamification/types.js</a>, <a href="gamification_types.js.html#line1">line 1</a>
|
|
550
|
+
</li></ul></dd>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</dl>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
<h5 class="subsection-title">Properties:</h5>
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
<table class="props">
|
|
591
|
+
<thead>
|
|
592
|
+
<tr>
|
|
593
|
+
|
|
594
|
+
<th>Name</th>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
<th>Type</th>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
<th class="last">Description</th>
|
|
604
|
+
</tr>
|
|
605
|
+
</thead>
|
|
606
|
+
|
|
607
|
+
<tbody>
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
<tr>
|
|
611
|
+
|
|
612
|
+
<td class="name"><code>username</code></td>
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
<td class="type">
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
<span class="param-type">string</span>
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
</td>
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
<td class="description last">The username of the user.</td>
|
|
630
|
+
</tr>
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
<tr>
|
|
635
|
+
|
|
636
|
+
<td class="name"><code>streak</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>minutes_practiced</code></td>
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
<td class="type">
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
<span class="param-type">number</span>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
</td>
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
<td class="description last">The name of the award.</td>
|
|
678
|
+
</tr>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
<tr>
|
|
683
|
+
|
|
684
|
+
<td class="name"><code>date_completed</code></td>
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
<td class="type">
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
<span class="param-type">Date</span>
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
</td>
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
<td class="description last">Date of completion</td>
|
|
702
|
+
</tr>
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
<tr>
|
|
707
|
+
|
|
708
|
+
<td class="name"><code>challenge_title</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">The name of the challenge completed.</td>
|
|
726
|
+
</tr>
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
<tr>
|
|
731
|
+
|
|
732
|
+
<td class="name"><code>award_text</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 description</td>
|
|
750
|
+
</tr>
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
<tr>
|
|
755
|
+
|
|
756
|
+
<td class="name"><code>tier</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 tier [bronze, silver, gold]</td>
|
|
774
|
+
</tr>
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
<tr>
|
|
779
|
+
|
|
780
|
+
<td class="name"><code>award</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 URL</td>
|
|
798
|
+
</tr>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
<tr>
|
|
803
|
+
|
|
804
|
+
<td class="name"><code>award_64</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">Award image in base64</td>
|
|
822
|
+
</tr>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
<tr>
|
|
827
|
+
|
|
828
|
+
<td class="name"><code>instructor_signature</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 URL</td>
|
|
846
|
+
</tr>
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
<tr>
|
|
851
|
+
|
|
852
|
+
<td class="name"><code>instructor_signature_64</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">Instructor signature image in base64</td>
|
|
870
|
+
</tr>
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
<tr>
|
|
875
|
+
|
|
876
|
+
<td class="name"><code>musora_logo</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 URL</td>
|
|
894
|
+
</tr>
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
<tr>
|
|
899
|
+
|
|
900
|
+
<td class="name"><code>musora_logo_64</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">Musora logo image in base64</td>
|
|
918
|
+
</tr>
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
<tr>
|
|
923
|
+
|
|
924
|
+
<td class="name"><code>brand_logo</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 URL</td>
|
|
942
|
+
</tr>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
<tr>
|
|
947
|
+
|
|
948
|
+
<td class="name"><code>brand_logo_64</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">Brand logo image in base64</td>
|
|
966
|
+
</tr>
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
<tr>
|
|
971
|
+
|
|
972
|
+
<td class="name"><code>ribbon_image</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 URL</td>
|
|
990
|
+
</tr>
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
<tr>
|
|
995
|
+
|
|
996
|
+
<td class="name"><code>ribbon_image_64</code></td>
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
<td class="type">
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
<span class="param-type">string</span>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
</td>
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
<td class="description last">Ribbon image in base64</td>
|
|
1014
|
+
</tr>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
<tr>
|
|
1019
|
+
|
|
1020
|
+
<td class="name"><code>id</code></td>
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
<td class="type">
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
<span class="param-type">number</span>
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
</td>
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
<td class="description last">ID of the challenge completed</td>
|
|
1038
|
+
</tr>
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
<tr>
|
|
1043
|
+
|
|
1044
|
+
<td class="name"><code>artist_name</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">Name of the artist featured in the challenge</td>
|
|
1062
|
+
</tr>
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
<tr>
|
|
1067
|
+
|
|
1068
|
+
<td class="name"><code>dark_mode_logo_url</code></td>
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
<td class="type">
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
<span class="param-type">string</span>
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
</td>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
<td class="description last">Dark mode logo image URL</td>
|
|
1086
|
+
</tr>
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
<tr>
|
|
1091
|
+
|
|
1092
|
+
<td class="name"><code>light_mode_logo_url</code></td>
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
<td class="type">
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
<span class="param-type">string</span>
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
</td>
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
<td class="description last">Light mode logo image URL</td>
|
|
1110
|
+
</tr>
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
<tr>
|
|
1115
|
+
|
|
1116
|
+
<td class="name"><code>logo_image_url</code></td>
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
<td class="type">
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
<span class="param-type">string</span>
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
</td>
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
<td class="description last">Name of the artist featured in the challenge</td>
|
|
1134
|
+
</tr>
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
<tr>
|
|
1139
|
+
|
|
1140
|
+
<td class="name"><code>web_url_path</code></td>
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
<td class="type">
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
<span class="param-type">string</span>
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
</td>
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
<td class="description last">URL path for the challenge</td>
|
|
1158
|
+
</tr>
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
</tbody>
|
|
1162
|
+
</table>
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
<h5 class="h5-types">Type:</h5>
|
|
1172
|
+
<ul>
|
|
1173
|
+
<li>
|
|
1174
|
+
|
|
1175
|
+
<span class="param-type">Object</span>
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
</li>
|
|
1180
|
+
</ul>
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
|
|
537
1189
|
<h4 class="name" id="BrandMethodLevels">BrandMethodLevels</h4>
|
|
538
1190
|
|
|
539
1191
|
|
|
@@ -546,7 +1198,595 @@
|
|
|
546
1198
|
|
|
547
1199
|
<dt class="tag-source">Source:</dt>
|
|
548
1200
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
549
|
-
<a href="user_types.js.html">user/types.js</a>, <a href="user_types.js.html#line1">line 1</a>
|
|
1201
|
+
<a href="user_types.js.html">user/types.js</a>, <a href="user_types.js.html#line1">line 1</a>
|
|
1202
|
+
</li></ul></dd>
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
</dl>
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
<h5 class="subsection-title">Properties:</h5>
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
<table class="props">
|
|
1243
|
+
<thead>
|
|
1244
|
+
<tr>
|
|
1245
|
+
|
|
1246
|
+
<th>Name</th>
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
<th>Type</th>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
<th class="last">Description</th>
|
|
1256
|
+
</tr>
|
|
1257
|
+
</thead>
|
|
1258
|
+
|
|
1259
|
+
<tbody>
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
<tr>
|
|
1263
|
+
|
|
1264
|
+
<td class="name"><code>drumeo</code></td>
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
<td class="type">
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
<span class="param-type">string</span>
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
</td>
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
<td class="description last"></td>
|
|
1282
|
+
</tr>
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
<tr>
|
|
1287
|
+
|
|
1288
|
+
<td class="name"><code>pianote</code></td>
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
<td class="type">
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
<span class="param-type">string</span>
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
</td>
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
<td class="description last"></td>
|
|
1306
|
+
</tr>
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
<tr>
|
|
1311
|
+
|
|
1312
|
+
<td class="name"><code>guitareo</code></td>
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
<td class="type">
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
<span class="param-type">string</span>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
</td>
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
<td class="description last"></td>
|
|
1330
|
+
</tr>
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
<tr>
|
|
1335
|
+
|
|
1336
|
+
<td class="name"><code>singeo</code></td>
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
<td class="type">
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
<span class="param-type">string</span>
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
</td>
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
<td class="description last"></td>
|
|
1354
|
+
</tr>
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
</tbody>
|
|
1358
|
+
</table>
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
<h5 class="h5-types">Type:</h5>
|
|
1368
|
+
<ul>
|
|
1369
|
+
<li>
|
|
1370
|
+
|
|
1371
|
+
<span class="param-type">object</span>
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
</li>
|
|
1376
|
+
</ul>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
<h4 class="name" id="BrandTimePracticed">BrandTimePracticed</h4>
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
<dl class="details">
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
<dt class="tag-source">Source:</dt>
|
|
1396
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1397
|
+
<a href="user_types.js.html">user/types.js</a>, <a href="user_types.js.html#line17">line 17</a>
|
|
1398
|
+
</li></ul></dd>
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
</dl>
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
<h5 class="subsection-title">Properties:</h5>
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
<table class="props">
|
|
1439
|
+
<thead>
|
|
1440
|
+
<tr>
|
|
1441
|
+
|
|
1442
|
+
<th>Name</th>
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
<th>Type</th>
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
<th class="last">Description</th>
|
|
1452
|
+
</tr>
|
|
1453
|
+
</thead>
|
|
1454
|
+
|
|
1455
|
+
<tbody>
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
<tr>
|
|
1459
|
+
|
|
1460
|
+
<td class="name"><code>drumeo</code></td>
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
<td class="type">
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
<span class="param-type">number</span>
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
</td>
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
<td class="description last"></td>
|
|
1478
|
+
</tr>
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
<tr>
|
|
1483
|
+
|
|
1484
|
+
<td class="name"><code>pianote</code></td>
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
<td class="type">
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
<span class="param-type">number</span>
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
</td>
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
<td class="description last"></td>
|
|
1502
|
+
</tr>
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
<tr>
|
|
1507
|
+
|
|
1508
|
+
<td class="name"><code>guitareo</code></td>
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
<td class="type">
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
<span class="param-type">number</span>
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
</td>
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
<td class="description last"></td>
|
|
1526
|
+
</tr>
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
<tr>
|
|
1531
|
+
|
|
1532
|
+
<td class="name"><code>singeo</code></td>
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
<td class="type">
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
<span class="param-type">number</span>
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
</td>
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
|
|
1549
|
+
<td class="description last"></td>
|
|
1550
|
+
</tr>
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
</tbody>
|
|
1554
|
+
</table>
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
<h5 class="h5-types">Type:</h5>
|
|
1564
|
+
<ul>
|
|
1565
|
+
<li>
|
|
1566
|
+
|
|
1567
|
+
<span class="param-type">object</span>
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
</li>
|
|
1572
|
+
</ul>
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
|
|
1581
|
+
<h4 class="name" id="BrandTotalXp">BrandTotalXp</h4>
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
<dl class="details">
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
<dt class="tag-source">Source:</dt>
|
|
1592
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1593
|
+
<a href="user_types.js.html">user/types.js</a>, <a href="user_types.js.html#line9">line 9</a>
|
|
1594
|
+
</li></ul></dd>
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
</dl>
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
<h5 class="subsection-title">Properties:</h5>
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
<table class="props">
|
|
1635
|
+
<thead>
|
|
1636
|
+
<tr>
|
|
1637
|
+
|
|
1638
|
+
<th>Name</th>
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
<th>Type</th>
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
<th class="last">Description</th>
|
|
1648
|
+
</tr>
|
|
1649
|
+
</thead>
|
|
1650
|
+
|
|
1651
|
+
<tbody>
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
<tr>
|
|
1655
|
+
|
|
1656
|
+
<td class="name"><code>drumeo</code></td>
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
<td class="type">
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
<span class="param-type">string</span>
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
</td>
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
<td class="description last"></td>
|
|
1674
|
+
</tr>
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
<tr>
|
|
1679
|
+
|
|
1680
|
+
<td class="name"><code>pianote</code></td>
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
<td class="type">
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
<span class="param-type">string</span>
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
</td>
|
|
1692
|
+
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
<td class="description last"></td>
|
|
1698
|
+
</tr>
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
<tr>
|
|
1703
|
+
|
|
1704
|
+
<td class="name"><code>guitareo</code></td>
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
<td class="type">
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
<span class="param-type">string</span>
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
</td>
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
<td class="description last"></td>
|
|
1722
|
+
</tr>
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
<tr>
|
|
1727
|
+
|
|
1728
|
+
<td class="name"><code>singeo</code></td>
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
<td class="type">
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
<span class="param-type">string</span>
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
</td>
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
<td class="description last"></td>
|
|
1746
|
+
</tr>
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
</tbody>
|
|
1750
|
+
</table>
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
<h5 class="h5-types">Type:</h5>
|
|
1760
|
+
<ul>
|
|
1761
|
+
<li>
|
|
1762
|
+
|
|
1763
|
+
<span class="param-type">object</span>
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
</li>
|
|
1768
|
+
</ul>
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
<h4 class="name" id="CreatePlaylistDTO">CreatePlaylistDTO</h4>
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
<dl class="details">
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
<dt class="tag-source">Source:</dt>
|
|
1788
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1789
|
+
<a href="content-org_playlists-types.js.html">content-org/playlists-types.js</a>, <a href="content-org_playlists-types.js.html#line1">line 1</a>
|
|
550
1790
|
</li></ul></dd>
|
|
551
1791
|
|
|
552
1792
|
|
|
@@ -574,42 +1814,90 @@
|
|
|
574
1814
|
|
|
575
1815
|
|
|
576
1816
|
|
|
577
|
-
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
|
|
1822
|
+
</dl>
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
<h5 class="subsection-title">Properties:</h5>
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
<table class="props">
|
|
1831
|
+
<thead>
|
|
1832
|
+
<tr>
|
|
1833
|
+
|
|
1834
|
+
<th>Name</th>
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
<th>Type</th>
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
<th class="last">Description</th>
|
|
1844
|
+
</tr>
|
|
1845
|
+
</thead>
|
|
1846
|
+
|
|
1847
|
+
<tbody>
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
<tr>
|
|
1851
|
+
|
|
1852
|
+
<td class="name"><code>name</code></td>
|
|
1853
|
+
|
|
1854
|
+
|
|
1855
|
+
<td class="type">
|
|
1856
|
+
|
|
1857
|
+
|
|
1858
|
+
<span class="param-type">string</span>
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
|
|
1862
|
+
|
|
1863
|
+
</td>
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
|
|
578
1868
|
|
|
579
|
-
|
|
1869
|
+
<td class="description last">The name of the new playlist. (required, max 255 characters)</td>
|
|
1870
|
+
</tr>
|
|
580
1871
|
|
|
581
1872
|
|
|
582
|
-
</dl>
|
|
583
|
-
|
|
584
1873
|
|
|
1874
|
+
<tr>
|
|
1875
|
+
|
|
1876
|
+
<td class="name"><code>description</code></td>
|
|
1877
|
+
|
|
585
1878
|
|
|
586
|
-
|
|
1879
|
+
<td class="type">
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
<span class="param-type">string</span>
|
|
587
1883
|
|
|
588
|
-
|
|
589
1884
|
|
|
590
|
-
<table class="props">
|
|
591
|
-
<thead>
|
|
592
|
-
<tr>
|
|
593
|
-
|
|
594
|
-
<th>Name</th>
|
|
595
|
-
|
|
596
1885
|
|
|
597
|
-
|
|
1886
|
+
|
|
1887
|
+
</td>
|
|
598
1888
|
|
|
599
|
-
|
|
1889
|
+
|
|
600
1890
|
|
|
601
|
-
|
|
1891
|
+
|
|
602
1892
|
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
</thead>
|
|
1893
|
+
<td class="description last">A description of the playlist. (optional, max 1000 characters)</td>
|
|
1894
|
+
</tr>
|
|
606
1895
|
|
|
607
|
-
<tbody>
|
|
608
1896
|
|
|
609
1897
|
|
|
610
1898
|
<tr>
|
|
611
1899
|
|
|
612
|
-
<td class="name"><code>
|
|
1900
|
+
<td class="name"><code>category</code></td>
|
|
613
1901
|
|
|
614
1902
|
|
|
615
1903
|
<td class="type">
|
|
@@ -626,14 +1914,14 @@
|
|
|
626
1914
|
|
|
627
1915
|
|
|
628
1916
|
|
|
629
|
-
<td class="description last"
|
|
1917
|
+
<td class="description last">The category of the playlist.</td>
|
|
630
1918
|
</tr>
|
|
631
1919
|
|
|
632
1920
|
|
|
633
1921
|
|
|
634
1922
|
<tr>
|
|
635
1923
|
|
|
636
|
-
<td class="name"><code>
|
|
1924
|
+
<td class="name"><code>thumbnail_url</code></td>
|
|
637
1925
|
|
|
638
1926
|
|
|
639
1927
|
<td class="type">
|
|
@@ -650,20 +1938,20 @@
|
|
|
650
1938
|
|
|
651
1939
|
|
|
652
1940
|
|
|
653
|
-
<td class="description last"
|
|
1941
|
+
<td class="description last">The URL of the playlist thumbnail. (optional, must be a valid URL)</td>
|
|
654
1942
|
</tr>
|
|
655
1943
|
|
|
656
1944
|
|
|
657
1945
|
|
|
658
1946
|
<tr>
|
|
659
1947
|
|
|
660
|
-
<td class="name"><code>
|
|
1948
|
+
<td class="name"><code>private</code></td>
|
|
661
1949
|
|
|
662
1950
|
|
|
663
1951
|
<td class="type">
|
|
664
1952
|
|
|
665
1953
|
|
|
666
|
-
<span class="param-type">
|
|
1954
|
+
<span class="param-type">boolean</span>
|
|
667
1955
|
|
|
668
1956
|
|
|
669
1957
|
|
|
@@ -674,14 +1962,14 @@
|
|
|
674
1962
|
|
|
675
1963
|
|
|
676
1964
|
|
|
677
|
-
<td class="description last"
|
|
1965
|
+
<td class="description last">Whether the playlist is private. (optional, defaults to true)</td>
|
|
678
1966
|
</tr>
|
|
679
1967
|
|
|
680
1968
|
|
|
681
1969
|
|
|
682
1970
|
<tr>
|
|
683
1971
|
|
|
684
|
-
<td class="name"><code>
|
|
1972
|
+
<td class="name"><code>brand</code></td>
|
|
685
1973
|
|
|
686
1974
|
|
|
687
1975
|
<td class="type">
|
|
@@ -698,7 +1986,7 @@
|
|
|
698
1986
|
|
|
699
1987
|
|
|
700
1988
|
|
|
701
|
-
<td class="description last"
|
|
1989
|
+
<td class="description last">Brand identifier for the playlist.</td>
|
|
702
1990
|
</tr>
|
|
703
1991
|
|
|
704
1992
|
|
|
@@ -712,17 +2000,6 @@
|
|
|
712
2000
|
|
|
713
2001
|
|
|
714
2002
|
|
|
715
|
-
<h5 class="h5-types">Type:</h5>
|
|
716
|
-
<ul>
|
|
717
|
-
<li>
|
|
718
|
-
|
|
719
|
-
<span class="param-type">object</span>
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
</li>
|
|
724
|
-
</ul>
|
|
725
|
-
|
|
726
2003
|
|
|
727
2004
|
|
|
728
2005
|
|
|
@@ -730,7 +2007,7 @@
|
|
|
730
2007
|
|
|
731
2008
|
|
|
732
2009
|
|
|
733
|
-
<h4 class="name" id="
|
|
2010
|
+
<h4 class="name" id="PaginatedLinks">PaginatedLinks</h4>
|
|
734
2011
|
|
|
735
2012
|
|
|
736
2013
|
|
|
@@ -742,7 +2019,7 @@
|
|
|
742
2019
|
|
|
743
2020
|
<dt class="tag-source">Source:</dt>
|
|
744
2021
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
745
|
-
<a href="
|
|
2022
|
+
<a href="api_types.js.html">api/types.js</a>, <a href="api_types.js.html#line12">line 12</a>
|
|
746
2023
|
</li></ul></dd>
|
|
747
2024
|
|
|
748
2025
|
|
|
@@ -805,13 +2082,13 @@
|
|
|
805
2082
|
|
|
806
2083
|
<tr>
|
|
807
2084
|
|
|
808
|
-
<td class="name"><code>
|
|
2085
|
+
<td class="name"><code>first</code></td>
|
|
809
2086
|
|
|
810
2087
|
|
|
811
2088
|
<td class="type">
|
|
812
2089
|
|
|
813
2090
|
|
|
814
|
-
<span class="param-type">
|
|
2091
|
+
<span class="param-type">string</span>
|
|
815
2092
|
|
|
816
2093
|
|
|
817
2094
|
|
|
@@ -822,20 +2099,20 @@
|
|
|
822
2099
|
|
|
823
2100
|
|
|
824
2101
|
|
|
825
|
-
<td class="description last"
|
|
2102
|
+
<td class="description last">URL of the first page</td>
|
|
826
2103
|
</tr>
|
|
827
2104
|
|
|
828
2105
|
|
|
829
2106
|
|
|
830
2107
|
<tr>
|
|
831
2108
|
|
|
832
|
-
<td class="name"><code>
|
|
2109
|
+
<td class="name"><code>last</code></td>
|
|
833
2110
|
|
|
834
2111
|
|
|
835
2112
|
<td class="type">
|
|
836
2113
|
|
|
837
2114
|
|
|
838
|
-
<span class="param-type">
|
|
2115
|
+
<span class="param-type">string</span>
|
|
839
2116
|
|
|
840
2117
|
|
|
841
2118
|
|
|
@@ -846,20 +2123,20 @@
|
|
|
846
2123
|
|
|
847
2124
|
|
|
848
2125
|
|
|
849
|
-
<td class="description last"
|
|
2126
|
+
<td class="description last">URL of the last page</td>
|
|
850
2127
|
</tr>
|
|
851
2128
|
|
|
852
2129
|
|
|
853
2130
|
|
|
854
2131
|
<tr>
|
|
855
2132
|
|
|
856
|
-
<td class="name"><code>
|
|
2133
|
+
<td class="name"><code>next</code></td>
|
|
857
2134
|
|
|
858
2135
|
|
|
859
2136
|
<td class="type">
|
|
860
2137
|
|
|
861
2138
|
|
|
862
|
-
<span class="param-type">
|
|
2139
|
+
<span class="param-type">string</span>
|
|
863
2140
|
|
|
864
2141
|
|
|
865
2142
|
|
|
@@ -870,20 +2147,20 @@
|
|
|
870
2147
|
|
|
871
2148
|
|
|
872
2149
|
|
|
873
|
-
<td class="description last"
|
|
2150
|
+
<td class="description last">URL of the next page</td>
|
|
874
2151
|
</tr>
|
|
875
2152
|
|
|
876
2153
|
|
|
877
2154
|
|
|
878
2155
|
<tr>
|
|
879
2156
|
|
|
880
|
-
<td class="name"><code>
|
|
2157
|
+
<td class="name"><code>prev</code></td>
|
|
881
2158
|
|
|
882
2159
|
|
|
883
2160
|
<td class="type">
|
|
884
2161
|
|
|
885
2162
|
|
|
886
|
-
<span class="param-type">
|
|
2163
|
+
<span class="param-type">string</span>
|
|
887
2164
|
|
|
888
2165
|
|
|
889
2166
|
|
|
@@ -894,7 +2171,7 @@
|
|
|
894
2171
|
|
|
895
2172
|
|
|
896
2173
|
|
|
897
|
-
<td class="description last"
|
|
2174
|
+
<td class="description last">URL of the previous page</td>
|
|
898
2175
|
</tr>
|
|
899
2176
|
|
|
900
2177
|
|
|
@@ -912,7 +2189,7 @@
|
|
|
912
2189
|
<ul>
|
|
913
2190
|
<li>
|
|
914
2191
|
|
|
915
|
-
<span class="param-type">
|
|
2192
|
+
<span class="param-type">Object</span>
|
|
916
2193
|
|
|
917
2194
|
|
|
918
2195
|
|
|
@@ -926,7 +2203,7 @@
|
|
|
926
2203
|
|
|
927
2204
|
|
|
928
2205
|
|
|
929
|
-
<h4 class="name" id="
|
|
2206
|
+
<h4 class="name" id="PaginatedMeta">PaginatedMeta</h4>
|
|
930
2207
|
|
|
931
2208
|
|
|
932
2209
|
|
|
@@ -938,7 +2215,7 @@
|
|
|
938
2215
|
|
|
939
2216
|
<dt class="tag-source">Source:</dt>
|
|
940
2217
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
941
|
-
<a href="
|
|
2218
|
+
<a href="api_types.js.html">api/types.js</a>, <a href="api_types.js.html#line1">line 1</a>
|
|
942
2219
|
</li></ul></dd>
|
|
943
2220
|
|
|
944
2221
|
|
|
@@ -1001,13 +2278,13 @@
|
|
|
1001
2278
|
|
|
1002
2279
|
<tr>
|
|
1003
2280
|
|
|
1004
|
-
<td class="name"><code>
|
|
2281
|
+
<td class="name"><code>current_page</code></td>
|
|
1005
2282
|
|
|
1006
2283
|
|
|
1007
2284
|
<td class="type">
|
|
1008
2285
|
|
|
1009
2286
|
|
|
1010
|
-
<span class="param-type">
|
|
2287
|
+
<span class="param-type">number</span>
|
|
1011
2288
|
|
|
1012
2289
|
|
|
1013
2290
|
|
|
@@ -1018,20 +2295,20 @@
|
|
|
1018
2295
|
|
|
1019
2296
|
|
|
1020
2297
|
|
|
1021
|
-
<td class="description last"
|
|
2298
|
+
<td class="description last">Total number of items</td>
|
|
1022
2299
|
</tr>
|
|
1023
2300
|
|
|
1024
2301
|
|
|
1025
2302
|
|
|
1026
2303
|
<tr>
|
|
1027
2304
|
|
|
1028
|
-
<td class="name"><code>
|
|
2305
|
+
<td class="name"><code>from</code></td>
|
|
1029
2306
|
|
|
1030
2307
|
|
|
1031
2308
|
<td class="type">
|
|
1032
2309
|
|
|
1033
2310
|
|
|
1034
|
-
<span class="param-type">
|
|
2311
|
+
<span class="param-type">number</span>
|
|
1035
2312
|
|
|
1036
2313
|
|
|
1037
2314
|
|
|
@@ -1042,20 +2319,20 @@
|
|
|
1042
2319
|
|
|
1043
2320
|
|
|
1044
2321
|
|
|
1045
|
-
<td class="description last"
|
|
2322
|
+
<td class="description last">First index of returned data</td>
|
|
1046
2323
|
</tr>
|
|
1047
2324
|
|
|
1048
2325
|
|
|
1049
2326
|
|
|
1050
2327
|
<tr>
|
|
1051
2328
|
|
|
1052
|
-
<td class="name"><code>
|
|
2329
|
+
<td class="name"><code>to</code></td>
|
|
1053
2330
|
|
|
1054
2331
|
|
|
1055
2332
|
<td class="type">
|
|
1056
2333
|
|
|
1057
2334
|
|
|
1058
|
-
<span class="param-type">
|
|
2335
|
+
<span class="param-type">number</span>
|
|
1059
2336
|
|
|
1060
2337
|
|
|
1061
2338
|
|
|
@@ -1066,14 +2343,86 @@
|
|
|
1066
2343
|
|
|
1067
2344
|
|
|
1068
2345
|
|
|
1069
|
-
<td class="description last"
|
|
2346
|
+
<td class="description last">Last index of returned data</td>
|
|
1070
2347
|
</tr>
|
|
1071
2348
|
|
|
1072
2349
|
|
|
1073
2350
|
|
|
1074
2351
|
<tr>
|
|
1075
2352
|
|
|
1076
|
-
<td class="name"><code>
|
|
2353
|
+
<td class="name"><code>per_page</code></td>
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
<td class="type">
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
<span class="param-type">number</span>
|
|
2360
|
+
|
|
2361
|
+
|
|
2362
|
+
|
|
2363
|
+
|
|
2364
|
+
</td>
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
<td class="description last">Total number of items per page</td>
|
|
2371
|
+
</tr>
|
|
2372
|
+
|
|
2373
|
+
|
|
2374
|
+
|
|
2375
|
+
<tr>
|
|
2376
|
+
|
|
2377
|
+
<td class="name"><code>last_page</code></td>
|
|
2378
|
+
|
|
2379
|
+
|
|
2380
|
+
<td class="type">
|
|
2381
|
+
|
|
2382
|
+
|
|
2383
|
+
<span class="param-type">number</span>
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
</td>
|
|
2389
|
+
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
<td class="description last">Last page accessed</td>
|
|
2395
|
+
</tr>
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
<tr>
|
|
2400
|
+
|
|
2401
|
+
<td class="name"><code>total</code></td>
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
<td class="type">
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
<span class="param-type">number</span>
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
|
|
2411
|
+
|
|
2412
|
+
</td>
|
|
2413
|
+
|
|
2414
|
+
|
|
2415
|
+
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
<td class="description last">Total number of items</td>
|
|
2419
|
+
</tr>
|
|
2420
|
+
|
|
2421
|
+
|
|
2422
|
+
|
|
2423
|
+
<tr>
|
|
2424
|
+
|
|
2425
|
+
<td class="name"><code>path</code></td>
|
|
1077
2426
|
|
|
1078
2427
|
|
|
1079
2428
|
<td class="type">
|
|
@@ -1090,7 +2439,7 @@
|
|
|
1090
2439
|
|
|
1091
2440
|
|
|
1092
2441
|
|
|
1093
|
-
<td class="description last"
|
|
2442
|
+
<td class="description last">Url of the current page</td>
|
|
1094
2443
|
</tr>
|
|
1095
2444
|
|
|
1096
2445
|
|
|
@@ -1108,7 +2457,7 @@
|
|
|
1108
2457
|
<ul>
|
|
1109
2458
|
<li>
|
|
1110
2459
|
|
|
1111
|
-
<span class="param-type">
|
|
2460
|
+
<span class="param-type">Object</span>
|
|
1112
2461
|
|
|
1113
2462
|
|
|
1114
2463
|
|
|
@@ -1122,7 +2471,7 @@
|
|
|
1122
2471
|
|
|
1123
2472
|
|
|
1124
2473
|
|
|
1125
|
-
<h4 class="name" id="
|
|
2474
|
+
<h4 class="name" id="PaginatedResponse">PaginatedResponse</h4>
|
|
1126
2475
|
|
|
1127
2476
|
|
|
1128
2477
|
|
|
@@ -1134,7 +2483,7 @@
|
|
|
1134
2483
|
|
|
1135
2484
|
<dt class="tag-source">Source:</dt>
|
|
1136
2485
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1137
|
-
<a href="
|
|
2486
|
+
<a href="api_types.js.html">api/types.js</a>, <a href="api_types.js.html#line20">line 20</a>
|
|
1138
2487
|
</li></ul></dd>
|
|
1139
2488
|
|
|
1140
2489
|
|
|
@@ -1197,37 +2546,13 @@
|
|
|
1197
2546
|
|
|
1198
2547
|
<tr>
|
|
1199
2548
|
|
|
1200
|
-
<td class="name"><code>
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
<td class="type">
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
<span class="param-type">string</span>
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
</td>
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
<td class="description last">The name of the new playlist. (required, max 255 characters)</td>
|
|
1218
|
-
</tr>
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
<tr>
|
|
1223
|
-
|
|
1224
|
-
<td class="name"><code>description</code></td>
|
|
2549
|
+
<td class="name"><code>meta</code></td>
|
|
1225
2550
|
|
|
1226
2551
|
|
|
1227
2552
|
<td class="type">
|
|
1228
2553
|
|
|
1229
2554
|
|
|
1230
|
-
<span class="param-type">
|
|
2555
|
+
<span class="param-type"><a href="global.html#PaginatedMeta">PaginatedMeta</a></span>
|
|
1231
2556
|
|
|
1232
2557
|
|
|
1233
2558
|
|
|
@@ -1238,20 +2563,20 @@
|
|
|
1238
2563
|
|
|
1239
2564
|
|
|
1240
2565
|
|
|
1241
|
-
<td class="description last">
|
|
2566
|
+
<td class="description last">Meta information</td>
|
|
1242
2567
|
</tr>
|
|
1243
2568
|
|
|
1244
2569
|
|
|
1245
2570
|
|
|
1246
2571
|
<tr>
|
|
1247
2572
|
|
|
1248
|
-
<td class="name"><code>
|
|
2573
|
+
<td class="name"><code>links</code></td>
|
|
1249
2574
|
|
|
1250
2575
|
|
|
1251
2576
|
<td class="type">
|
|
1252
2577
|
|
|
1253
2578
|
|
|
1254
|
-
<span class="param-type">
|
|
2579
|
+
<span class="param-type"><a href="global.html#PaginatedLinks">PaginatedLinks</a></span>
|
|
1255
2580
|
|
|
1256
2581
|
|
|
1257
2582
|
|
|
@@ -1262,20 +2587,20 @@
|
|
|
1262
2587
|
|
|
1263
2588
|
|
|
1264
2589
|
|
|
1265
|
-
<td class="description last">
|
|
2590
|
+
<td class="description last">Links information</td>
|
|
1266
2591
|
</tr>
|
|
1267
2592
|
|
|
1268
2593
|
|
|
1269
2594
|
|
|
1270
2595
|
<tr>
|
|
1271
2596
|
|
|
1272
|
-
<td class="name"><code>
|
|
2597
|
+
<td class="name"><code>data</code></td>
|
|
1273
2598
|
|
|
1274
2599
|
|
|
1275
2600
|
<td class="type">
|
|
1276
2601
|
|
|
1277
2602
|
|
|
1278
|
-
<span class="param-type">
|
|
2603
|
+
<span class="param-type">Array.<T></span>
|
|
1279
2604
|
|
|
1280
2605
|
|
|
1281
2606
|
|
|
@@ -1286,67 +2611,30 @@
|
|
|
1286
2611
|
|
|
1287
2612
|
|
|
1288
2613
|
|
|
1289
|
-
<td class="description last">
|
|
2614
|
+
<td class="description last">Data</td>
|
|
1290
2615
|
</tr>
|
|
1291
2616
|
|
|
1292
2617
|
|
|
2618
|
+
</tbody>
|
|
2619
|
+
</table>
|
|
1293
2620
|
|
|
1294
|
-
<tr>
|
|
1295
|
-
|
|
1296
|
-
<td class="name"><code>private</code></td>
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
<td class="type">
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
<span class="param-type">boolean</span>
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
</td>
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
<td class="description last">Whether the playlist is private. (optional, defaults to true)</td>
|
|
1314
|
-
</tr>
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
2621
|
|
|
1318
|
-
<tr>
|
|
1319
|
-
|
|
1320
|
-
<td class="name"><code>brand</code></td>
|
|
1321
|
-
|
|
1322
2622
|
|
|
1323
|
-
<td class="type">
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
<span class="param-type">string</span>
|
|
1327
2623
|
|
|
1328
2624
|
|
|
1329
2625
|
|
|
1330
|
-
|
|
1331
|
-
</td>
|
|
1332
2626
|
|
|
1333
|
-
|
|
1334
2627
|
|
|
2628
|
+
<h5 class="h5-types">Type:</h5>
|
|
2629
|
+
<ul>
|
|
2630
|
+
<li>
|
|
1335
2631
|
|
|
1336
|
-
|
|
1337
|
-
<td class="description last">Brand identifier for the playlist.</td>
|
|
1338
|
-
</tr>
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
</tbody>
|
|
1342
|
-
</table>
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
2632
|
+
<span class="param-type">Object.<T></span>
|
|
1347
2633
|
|
|
1348
2634
|
|
|
1349
2635
|
|
|
2636
|
+
</li>
|
|
2637
|
+
</ul>
|
|
1350
2638
|
|
|
1351
2639
|
|
|
1352
2640
|
|
|
@@ -1367,7 +2655,7 @@
|
|
|
1367
2655
|
|
|
1368
2656
|
<dt class="tag-source">Source:</dt>
|
|
1369
2657
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1370
|
-
<a href="content-org_playlists-types.js.html">content-org/playlists-types.js</a>, <a href="content-org_playlists-types.js.html#
|
|
2658
|
+
<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>
|
|
1371
2659
|
</li></ul></dd>
|
|
1372
2660
|
|
|
1373
2661
|
|
|
@@ -3865,7 +5153,7 @@
|
|
|
3865
5153
|
<br class="clear">
|
|
3866
5154
|
|
|
3867
5155
|
<footer>
|
|
3868
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Mar
|
|
5156
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Mar 27 2025 03:14:21 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
3869
5157
|
</footer>
|
|
3870
5158
|
|
|
3871
5159
|
<script>prettyPrint();</script>
|