musora-content-services 2.42.0 → 2.44.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 (64) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/docs/ContentOrganization.html +2 -2
  3. package/docs/Forums.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 -2
  8. package/docs/content-org_content-org.js.html +2 -2
  9. package/docs/content-org_guided-courses.ts.html +2 -2
  10. package/docs/content-org_playlists-types.js.html +2 -2
  11. package/docs/content-org_playlists.js.html +2 -2
  12. package/docs/content.js.html +2 -2
  13. package/docs/forums_categories.ts.html +2 -2
  14. package/docs/forums_forums.ts.html +2 -2
  15. package/docs/forums_threads.ts.html +76 -5
  16. package/docs/gamification_awards.ts.html +2 -2
  17. package/docs/gamification_gamification.js.html +2 -2
  18. package/docs/global.html +2 -2
  19. package/docs/index.html +2 -2
  20. package/docs/module-Accounts.html +2 -2
  21. package/docs/module-Awards.html +2 -2
  22. package/docs/module-Categories.html +24 -0
  23. package/docs/module-Config.html +2 -2
  24. package/docs/module-Content-Services-V2.html +2 -2
  25. package/docs/module-ForumCategories.html +0 -0
  26. package/docs/module-Forums.html +2271 -151
  27. package/docs/module-GuidedCourses.html +2 -2
  28. package/docs/module-Interests.html +2 -2
  29. package/docs/module-Payments.html +2 -2
  30. package/docs/module-Permissions.html +2 -2
  31. package/docs/module-Playlists.html +2 -2
  32. package/docs/module-Railcontent-Services.html +2 -2
  33. package/docs/module-Sanity-Services.html +10 -175
  34. package/docs/module-Sessions.html +2 -2
  35. package/docs/module-Threads.html +176 -1
  36. package/docs/module-UserActivity.html +2 -2
  37. package/docs/module-UserChat.html +2 -2
  38. package/docs/module-UserManagement.html +2 -2
  39. package/docs/module-UserMemberships.html +2 -2
  40. package/docs/module-UserNotifications.html +2 -2
  41. package/docs/module-UserProfile.html +2 -2
  42. package/docs/railcontent.js.html +2 -2
  43. package/docs/sanity.js.html +3 -25
  44. package/docs/userActivity.js.html +2 -2
  45. package/docs/user_account.ts.html +2 -2
  46. package/docs/user_chat.js.html +2 -2
  47. package/docs/user_interests.js.html +2 -2
  48. package/docs/user_management.js.html +2 -2
  49. package/docs/user_memberships.js.html +2 -2
  50. package/docs/user_notifications.js.html +2 -2
  51. package/docs/user_payments.ts.html +2 -2
  52. package/docs/user_permissions.js.html +2 -2
  53. package/docs/user_profile.js.html +2 -2
  54. package/docs/user_sessions.js.html +2 -2
  55. package/docs/user_types.js.html +2 -2
  56. package/docs/user_user-management-system.js.html +2 -2
  57. package/package.json +1 -1
  58. package/src/contentTypeConfig.js +51 -42
  59. package/src/index.d.ts +11 -3
  60. package/src/index.js +11 -3
  61. package/src/services/contentProgress.js +0 -0
  62. package/src/services/forums/threads.ts +74 -3
  63. package/src/services/sanity.js +1 -23
  64. package/src/services/user/memberships.js +0 -0
@@ -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-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecentForTab">getRecentForTab</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li></ul></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.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-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#.fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#.fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#.upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3><a href="global.html">Global</a></h3>
32
+ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecentForTab">getRecentForTab</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.isDisplayNameAvailable">isDisplayNameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#.fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#.fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#.upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3><a href="global.html">Global</a></h3>
33
33
 
34
34
  </nav>
35
35
 
@@ -288,7 +288,7 @@
288
288
 
289
289
  <dt class="tag-source">Source:</dt>
290
290
  <dd class="tag-source"><ul class="dummy"><li>
291
- <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line18">line 18</a>
291
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
292
292
  </li></ul></dd>
293
293
 
294
294
 
@@ -667,7 +667,7 @@
667
667
 
668
668
  <dt class="tag-source">Source:</dt>
669
669
  <dd class="tag-source"><ul class="dummy"><li>
670
- <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
670
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line84">line 84</a>
671
671
  </li></ul></dd>
672
672
 
673
673
 
@@ -903,7 +903,7 @@
903
903
 
904
904
  <dt class="tag-source">Source:</dt>
905
905
  <dd class="tag-source"><ul class="dummy"><li>
906
- <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line33">line 33</a>
906
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line52">line 52</a>
907
907
  </li></ul></dd>
908
908
 
909
909
 
@@ -1099,7 +1099,7 @@
1099
1099
 
1100
1100
 
1101
1101
 
1102
- <h4 class="name" id="~unfollowThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unfollowThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1102
+ <h4 class="name" id="~lockThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>lockThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1103
1103
 
1104
1104
 
1105
1105
 
@@ -1109,13 +1109,13 @@
1109
1109
  <dl class="details">
1110
1110
 
1111
1111
  <dt class="tag-description">Description:</dt>
1112
- <dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
1112
+ <dd class="tag-description"><ul class="dummy"><li>Locks a thread to prevent further posts.</li></ul></dd>
1113
1113
 
1114
1114
 
1115
1115
 
1116
1116
  <dt class="tag-source">Source:</dt>
1117
1117
  <dd class="tag-source"><ul class="dummy"><li>
1118
- <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line46">line 46</a>
1118
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
1119
1119
  </li></ul></dd>
1120
1120
 
1121
1121
 
@@ -1204,7 +1204,7 @@
1204
1204
 
1205
1205
 
1206
1206
 
1207
- <td class="description last">The ID of the thread to unlock.</td>
1207
+ <td class="description last">The ID of the thread to lock.</td>
1208
1208
  </tr>
1209
1209
 
1210
1210
 
@@ -1228,7 +1228,7 @@
1228
1228
 
1229
1229
 
1230
1230
 
1231
- <td class="description last">The brand associated with the unlock action.</td>
1231
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
1232
1232
  </tr>
1233
1233
 
1234
1234
 
@@ -1284,7 +1284,7 @@
1284
1284
 
1285
1285
 
1286
1286
  <div class="param-desc">
1287
- - A promise that resolves when the thread is unlocked.
1287
+ - A promise that resolves when the thread is locked.
1288
1288
  </div>
1289
1289
 
1290
1290
 
@@ -1311,7 +1311,7 @@
1311
1311
 
1312
1312
 
1313
1313
 
1314
- <h4 class="name" id="~updateForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
1314
+ <h4 class="name" id="~pinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>pinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1315
1315
 
1316
1316
 
1317
1317
 
@@ -1321,13 +1321,13 @@
1321
1321
  <dl class="details">
1322
1322
 
1323
1323
  <dt class="tag-description">Description:</dt>
1324
- <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
1324
+ <dd class="tag-description"><ul class="dummy"><li>Pins a thread to the top of its category.</li></ul></dd>
1325
1325
 
1326
1326
 
1327
1327
 
1328
1328
  <dt class="tag-source">Source:</dt>
1329
1329
  <dd class="tag-source"><ul class="dummy"><li>
1330
- <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line53">line 53</a>
1330
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line108">line 108</a>
1331
1331
  </li></ul></dd>
1332
1332
 
1333
1333
 
@@ -1399,13 +1399,13 @@
1399
1399
 
1400
1400
  <tr>
1401
1401
 
1402
- <td class="name"><code>params</code></td>
1402
+ <td class="name"><code>threadId</code></td>
1403
1403
 
1404
1404
 
1405
1405
  <td class="type">
1406
1406
 
1407
1407
 
1408
- <span class="param-type">UpdateForumCategoryParams</span>
1408
+ <span class="param-type">number</span>
1409
1409
 
1410
1410
 
1411
1411
 
@@ -1416,7 +1416,31 @@
1416
1416
 
1417
1417
 
1418
1418
 
1419
- <td class="description last">The parameters for creating the forum category.</td>
1419
+ <td class="description last">The ID of the thread to pin.</td>
1420
+ </tr>
1421
+
1422
+
1423
+
1424
+ <tr>
1425
+
1426
+ <td class="name"><code>brand</code></td>
1427
+
1428
+
1429
+ <td class="type">
1430
+
1431
+
1432
+ <span class="param-type">string</span>
1433
+
1434
+
1435
+
1436
+
1437
+ </td>
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
1420
1444
  </tr>
1421
1445
 
1422
1446
 
@@ -1472,7 +1496,7 @@
1472
1496
 
1473
1497
 
1474
1498
  <div class="param-desc">
1475
- - A promise that resolves to the created forum category.
1499
+ - A promise that resolves when the thread is pinned.
1476
1500
  </div>
1477
1501
 
1478
1502
 
@@ -1483,7 +1507,7 @@
1483
1507
  </dt>
1484
1508
  <dd>
1485
1509
 
1486
- <span class="param-type">Promise.&lt;ForumCategory></span>
1510
+ <span class="param-type">Promise.&lt;void></span>
1487
1511
 
1488
1512
 
1489
1513
 
@@ -1495,63 +1519,11 @@
1495
1519
 
1496
1520
 
1497
1521
 
1498
-
1499
-
1500
-
1501
-
1502
-
1503
- </article>
1504
-
1505
- </section>
1506
-
1507
-
1508
-
1509
-
1510
-
1511
-
1512
-
1513
- <section>
1514
-
1515
- <header>
1516
-
1517
-
1518
-
1519
- </header>
1520
-
1521
- <article>
1522
-
1523
- <div class="container-overview">
1524
-
1525
-
1526
-
1527
-
1528
-
1529
- </div>
1530
-
1531
-
1532
-
1533
-
1534
-
1535
-
1536
-
1537
-
1538
-
1539
-
1540
-
1541
-
1542
-
1543
-
1544
-
1545
-
1546
-
1547
- <h3 class="subsection-title">Methods</h3>
1548
-
1549
-
1550
1522
 
1551
1523
 
1552
1524
 
1553
1525
 
1554
- <h4 class="name" id="~createForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>createForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
1526
+ <h4 class="name" id="~unfollowThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unfollowThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1555
1527
 
1556
1528
 
1557
1529
 
@@ -1561,13 +1533,13 @@
1561
1533
  <dl class="details">
1562
1534
 
1563
1535
  <dt class="tag-description">Description:</dt>
1564
- <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
1536
+ <dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
1565
1537
 
1566
1538
 
1567
1539
 
1568
1540
  <dt class="tag-source">Source:</dt>
1569
1541
  <dd class="tag-source"><ul class="dummy"><li>
1570
- <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
1542
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
1571
1543
  </li></ul></dd>
1572
1544
 
1573
1545
 
@@ -1639,13 +1611,13 @@
1639
1611
 
1640
1612
  <tr>
1641
1613
 
1642
- <td class="name"><code>params</code></td>
1614
+ <td class="name"><code>threadId</code></td>
1643
1615
 
1644
1616
 
1645
1617
  <td class="type">
1646
1618
 
1647
1619
 
1648
- <span class="param-type">CreateForumCategoryParams</span>
1620
+ <span class="param-type">number</span>
1649
1621
 
1650
1622
 
1651
1623
 
@@ -1656,7 +1628,31 @@
1656
1628
 
1657
1629
 
1658
1630
 
1659
- <td class="description last">The parameters for creating the forum category.</td>
1631
+ <td class="description last">The ID of the thread to unlock.</td>
1632
+ </tr>
1633
+
1634
+
1635
+
1636
+ <tr>
1637
+
1638
+ <td class="name"><code>brand</code></td>
1639
+
1640
+
1641
+ <td class="type">
1642
+
1643
+
1644
+ <span class="param-type">string</span>
1645
+
1646
+
1647
+
1648
+
1649
+ </td>
1650
+
1651
+
1652
+
1653
+
1654
+
1655
+ <td class="description last">The brand associated with the unlock action.</td>
1660
1656
  </tr>
1661
1657
 
1662
1658
 
@@ -1712,7 +1708,7 @@
1712
1708
 
1713
1709
 
1714
1710
  <div class="param-desc">
1715
- - A promise that resolves to the created forum category.
1711
+ - A promise that resolves when the thread is unlocked.
1716
1712
  </div>
1717
1713
 
1718
1714
 
@@ -1723,7 +1719,7 @@
1723
1719
  </dt>
1724
1720
  <dd>
1725
1721
 
1726
- <span class="param-type">Promise.&lt;ForumCategory></span>
1722
+ <span class="param-type">Promise.&lt;void></span>
1727
1723
 
1728
1724
 
1729
1725
 
@@ -1739,7 +1735,7 @@
1739
1735
 
1740
1736
 
1741
1737
 
1742
- <h4 class="name" id="~createThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>createThread<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumThread>}</span></h4>
1738
+ <h4 class="name" id="~unlockThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unlockThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1743
1739
 
1744
1740
 
1745
1741
 
@@ -1749,13 +1745,13 @@
1749
1745
  <dl class="details">
1750
1746
 
1751
1747
  <dt class="tag-description">Description:</dt>
1752
- <dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
1748
+ <dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
1753
1749
 
1754
1750
 
1755
1751
 
1756
1752
  <dt class="tag-source">Source:</dt>
1757
1753
  <dd class="tag-source"><ul class="dummy"><li>
1758
- <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line18">line 18</a>
1754
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
1759
1755
  </li></ul></dd>
1760
1756
 
1761
1757
 
@@ -1827,13 +1823,13 @@
1827
1823
 
1828
1824
  <tr>
1829
1825
 
1830
- <td class="name"><code>params</code></td>
1826
+ <td class="name"><code>threadId</code></td>
1831
1827
 
1832
1828
 
1833
1829
  <td class="type">
1834
1830
 
1835
1831
 
1836
- <span class="param-type">CreateThreadParams</span>
1832
+ <span class="param-type">number</span>
1837
1833
 
1838
1834
 
1839
1835
 
@@ -1844,7 +1840,31 @@
1844
1840
 
1845
1841
 
1846
1842
 
1847
- <td class="description last">The parameters for creating the thread.</td>
1843
+ <td class="description last">The ID of the thread to unlock.</td>
1844
+ </tr>
1845
+
1846
+
1847
+
1848
+ <tr>
1849
+
1850
+ <td class="name"><code>brand</code></td>
1851
+
1852
+
1853
+ <td class="type">
1854
+
1855
+
1856
+ <span class="param-type">string</span>
1857
+
1858
+
1859
+
1860
+
1861
+ </td>
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
1848
1868
  </tr>
1849
1869
 
1850
1870
 
@@ -1900,7 +1920,7 @@
1900
1920
 
1901
1921
 
1902
1922
  <div class="param-desc">
1903
- - A promise that resolves to the created thread.
1923
+ - A promise that resolves when the thread is unlocked.
1904
1924
  </div>
1905
1925
 
1906
1926
 
@@ -1911,7 +1931,7 @@
1911
1931
  </dt>
1912
1932
  <dd>
1913
1933
 
1914
- <span class="param-type">Promise.&lt;ForumThread></span>
1934
+ <span class="param-type">Promise.&lt;void></span>
1915
1935
 
1916
1936
 
1917
1937
 
@@ -1927,7 +1947,7 @@
1927
1947
 
1928
1948
 
1929
1949
 
1930
- <h4 class="name" id="~fetchForumCategories"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchForumCategories<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
1950
+ <h4 class="name" id="~unpinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unpinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1931
1951
 
1932
1952
 
1933
1953
 
@@ -1937,13 +1957,13 @@
1937
1957
  <dl class="details">
1938
1958
 
1939
1959
  <dt class="tag-description">Description:</dt>
1940
- <dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
1960
+ <dd class="tag-description"><ul class="dummy"><li>Unpins a thread from the top of its category.</li></ul></dd>
1941
1961
 
1942
1962
 
1943
1963
 
1944
1964
  <dt class="tag-source">Source:</dt>
1945
1965
  <dd class="tag-source"><ul class="dummy"><li>
1946
- <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
1966
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
1947
1967
  </li></ul></dd>
1948
1968
 
1949
1969
 
@@ -2013,6 +2033,30 @@
2013
2033
  <tbody>
2014
2034
 
2015
2035
 
2036
+ <tr>
2037
+
2038
+ <td class="name"><code>threadId</code></td>
2039
+
2040
+
2041
+ <td class="type">
2042
+
2043
+
2044
+ <span class="param-type">number</span>
2045
+
2046
+
2047
+
2048
+
2049
+ </td>
2050
+
2051
+
2052
+
2053
+
2054
+
2055
+ <td class="description last">The ID of the thread to unpin.</td>
2056
+ </tr>
2057
+
2058
+
2059
+
2016
2060
  <tr>
2017
2061
 
2018
2062
  <td class="name"><code>brand</code></td>
@@ -2022,9 +2066,6 @@
2022
2066
 
2023
2067
 
2024
2068
  <span class="param-type">string</span>
2025
- |
2026
-
2027
- <span class="param-type">null</span>
2028
2069
 
2029
2070
 
2030
2071
 
@@ -2091,7 +2132,7 @@
2091
2132
 
2092
2133
 
2093
2134
  <div class="param-desc">
2094
- - A promise that resolves to the list of forum categories.
2135
+ - A promise that resolves when the thread is unpinned.
2095
2136
  </div>
2096
2137
 
2097
2138
 
@@ -2102,7 +2143,7 @@
2102
2143
  </dt>
2103
2144
  <dd>
2104
2145
 
2105
- <span class="param-type">Promise.&lt;ForumCategory></span>
2146
+ <span class="param-type">Promise.&lt;void></span>
2106
2147
 
2107
2148
 
2108
2149
 
@@ -2118,7 +2159,7 @@
2118
2159
 
2119
2160
 
2120
2161
 
2121
- <h4 class="name" id="~fetchThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchThreads<span class="signature">(categoryId, brand, params)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumThread>>}</span></h4>
2162
+ <h4 class="name" id="~updateForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
2122
2163
 
2123
2164
 
2124
2165
 
@@ -2128,13 +2169,13 @@
2128
2169
  <dl class="details">
2129
2170
 
2130
2171
  <dt class="tag-description">Description:</dt>
2131
- <dd class="tag-description"><ul class="dummy"><li>Fetches forum threads for the given category.</li></ul></dd>
2172
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
2132
2173
 
2133
2174
 
2134
2175
 
2135
2176
  <dt class="tag-source">Source:</dt>
2136
2177
  <dd class="tag-source"><ul class="dummy"><li>
2137
- <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
2178
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line53">line 53</a>
2138
2179
  </li></ul></dd>
2139
2180
 
2140
2181
 
@@ -2206,13 +2247,13 @@
2206
2247
 
2207
2248
  <tr>
2208
2249
 
2209
- <td class="name"><code>categoryId</code></td>
2250
+ <td class="name"><code>params</code></td>
2210
2251
 
2211
2252
 
2212
2253
  <td class="type">
2213
2254
 
2214
2255
 
2215
- <span class="param-type">number</span>
2256
+ <span class="param-type">UpdateForumCategoryParams</span>
2216
2257
 
2217
2258
 
2218
2259
 
@@ -2223,60 +2264,1927 @@
2223
2264
 
2224
2265
 
2225
2266
 
2226
- <td class="description last">The ID of the forum category.</td>
2267
+ <td class="description last">The parameters for creating the forum category.</td>
2227
2268
  </tr>
2228
2269
 
2229
2270
 
2230
-
2231
- <tr>
2232
-
2233
- <td class="name"><code>brand</code></td>
2234
-
2235
-
2236
- <td class="type">
2237
-
2238
-
2239
- <span class="param-type">string</span>
2240
-
2271
+ </tbody>
2272
+ </table>
2241
2273
 
2242
2274
 
2243
-
2244
- </td>
2245
2275
 
2246
-
2247
2276
 
2248
-
2249
2277
 
2250
- <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
2251
- </tr>
2252
2278
 
2253
-
2254
2279
 
2255
- <tr>
2256
-
2257
- <td class="name"><code>params</code></td>
2258
-
2259
2280
 
2260
- <td class="type">
2261
-
2262
-
2263
- <span class="param-type">FetchThreadParams</span>
2264
2281
 
2265
2282
 
2266
2283
 
2267
-
2268
- </td>
2269
2284
 
2270
-
2271
2285
 
2272
-
2273
2286
 
2274
- <td class="description last">Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")).</td>
2275
- </tr>
2287
+ <h5 class="h5-throws">Throws:</h5>
2276
2288
 
2277
-
2278
- </tbody>
2279
- </table>
2289
+
2290
+
2291
+ <dl>
2292
+ <dt>
2293
+ <div class="param-desc usertext">
2294
+ - If the request fails.
2295
+ </div>
2296
+ </dt>
2297
+ <dd></dd>
2298
+ <dt>
2299
+ <dl class="param-type">
2300
+ <dt>
2301
+ Type
2302
+ </dt>
2303
+ <dd>
2304
+
2305
+ <span class="param-type">HttpError</span>
2306
+
2307
+
2308
+
2309
+ </dd>
2310
+ </dl>
2311
+ </dt>
2312
+ <dd></dd>
2313
+ </dl>
2314
+
2315
+
2316
+
2317
+
2318
+
2319
+ <h5 class="h5-returns">Returns:</h5>
2320
+
2321
+
2322
+ <div class="param-desc">
2323
+ - A promise that resolves to the created forum category.
2324
+ </div>
2325
+
2326
+
2327
+
2328
+ <dl class="param-type">
2329
+ <dt>
2330
+ Type
2331
+ </dt>
2332
+ <dd>
2333
+
2334
+ <span class="param-type">Promise.&lt;ForumCategory></span>
2335
+
2336
+
2337
+
2338
+ </dd>
2339
+ </dl>
2340
+
2341
+
2342
+
2343
+
2344
+
2345
+
2346
+
2347
+
2348
+
2349
+
2350
+ <h4 class="name" id="~updateThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateThread<span class="signature">(threadId, params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumThread>}</span></h4>
2351
+
2352
+
2353
+
2354
+
2355
+
2356
+
2357
+ <dl class="details">
2358
+
2359
+ <dt class="tag-description">Description:</dt>
2360
+ <dd class="tag-description"><ul class="dummy"><li>Updates an existing thread under a forum category.</li></ul></dd>
2361
+
2362
+
2363
+
2364
+ <dt class="tag-source">Source:</dt>
2365
+ <dd class="tag-source"><ul class="dummy"><li>
2366
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line36">line 36</a>
2367
+ </li></ul></dd>
2368
+
2369
+
2370
+
2371
+
2372
+
2373
+
2374
+
2375
+
2376
+
2377
+
2378
+
2379
+
2380
+
2381
+
2382
+
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+
2392
+
2393
+
2394
+
2395
+
2396
+
2397
+
2398
+
2399
+ </dl>
2400
+
2401
+
2402
+
2403
+
2404
+
2405
+
2406
+
2407
+
2408
+
2409
+
2410
+
2411
+
2412
+
2413
+ <h5 class="h5-parameters">Parameters:</h5>
2414
+
2415
+
2416
+ <table class="params">
2417
+ <thead>
2418
+ <tr>
2419
+
2420
+ <th>Name</th>
2421
+
2422
+
2423
+ <th>Type</th>
2424
+
2425
+
2426
+
2427
+
2428
+
2429
+ <th class="last">Description</th>
2430
+ </tr>
2431
+ </thead>
2432
+
2433
+ <tbody>
2434
+
2435
+
2436
+ <tr>
2437
+
2438
+ <td class="name"><code>threadId</code></td>
2439
+
2440
+
2441
+ <td class="type">
2442
+
2443
+
2444
+ <span class="param-type">number</span>
2445
+
2446
+
2447
+
2448
+
2449
+ </td>
2450
+
2451
+
2452
+
2453
+
2454
+
2455
+ <td class="description last">The ID of the thread to update.</td>
2456
+ </tr>
2457
+
2458
+
2459
+
2460
+ <tr>
2461
+
2462
+ <td class="name"><code>params</code></td>
2463
+
2464
+
2465
+ <td class="type">
2466
+
2467
+
2468
+ <span class="param-type">UpdateThreadParams</span>
2469
+
2470
+
2471
+
2472
+
2473
+ </td>
2474
+
2475
+
2476
+
2477
+
2478
+
2479
+ <td class="description last">The parameters for updating the thread.</td>
2480
+ </tr>
2481
+
2482
+
2483
+ </tbody>
2484
+ </table>
2485
+
2486
+
2487
+
2488
+
2489
+
2490
+
2491
+
2492
+
2493
+
2494
+
2495
+
2496
+
2497
+
2498
+
2499
+ <h5 class="h5-throws">Throws:</h5>
2500
+
2501
+
2502
+
2503
+ <dl>
2504
+ <dt>
2505
+ <div class="param-desc usertext">
2506
+ - If the request fails.
2507
+ </div>
2508
+ </dt>
2509
+ <dd></dd>
2510
+ <dt>
2511
+ <dl class="param-type">
2512
+ <dt>
2513
+ Type
2514
+ </dt>
2515
+ <dd>
2516
+
2517
+ <span class="param-type">HttpError</span>
2518
+
2519
+
2520
+
2521
+ </dd>
2522
+ </dl>
2523
+ </dt>
2524
+ <dd></dd>
2525
+ </dl>
2526
+
2527
+
2528
+
2529
+
2530
+
2531
+ <h5 class="h5-returns">Returns:</h5>
2532
+
2533
+
2534
+ <div class="param-desc">
2535
+ - A promise that resolves to the updated thread.
2536
+ </div>
2537
+
2538
+
2539
+
2540
+ <dl class="param-type">
2541
+ <dt>
2542
+ Type
2543
+ </dt>
2544
+ <dd>
2545
+
2546
+ <span class="param-type">Promise.&lt;ForumThread></span>
2547
+
2548
+
2549
+
2550
+ </dd>
2551
+ </dl>
2552
+
2553
+
2554
+
2555
+
2556
+
2557
+
2558
+
2559
+
2560
+
2561
+
2562
+
2563
+ </article>
2564
+
2565
+ </section>
2566
+
2567
+
2568
+
2569
+
2570
+
2571
+
2572
+
2573
+ <section>
2574
+
2575
+ <header>
2576
+
2577
+
2578
+
2579
+ </header>
2580
+
2581
+ <article>
2582
+
2583
+ <div class="container-overview">
2584
+
2585
+
2586
+
2587
+
2588
+
2589
+ </div>
2590
+
2591
+
2592
+
2593
+
2594
+
2595
+
2596
+
2597
+
2598
+
2599
+
2600
+
2601
+
2602
+
2603
+
2604
+
2605
+
2606
+
2607
+ <h3 class="subsection-title">Methods</h3>
2608
+
2609
+
2610
+
2611
+
2612
+
2613
+
2614
+ <h4 class="name" id="~createForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>createForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
2615
+
2616
+
2617
+
2618
+
2619
+
2620
+
2621
+ <dl class="details">
2622
+
2623
+ <dt class="tag-description">Description:</dt>
2624
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
2625
+
2626
+
2627
+
2628
+ <dt class="tag-source">Source:</dt>
2629
+ <dd class="tag-source"><ul class="dummy"><li>
2630
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
2631
+ </li></ul></dd>
2632
+
2633
+
2634
+
2635
+
2636
+
2637
+
2638
+
2639
+
2640
+
2641
+
2642
+
2643
+
2644
+
2645
+
2646
+
2647
+
2648
+
2649
+
2650
+
2651
+
2652
+
2653
+
2654
+
2655
+
2656
+
2657
+
2658
+
2659
+
2660
+
2661
+
2662
+
2663
+ </dl>
2664
+
2665
+
2666
+
2667
+
2668
+
2669
+
2670
+
2671
+
2672
+
2673
+
2674
+
2675
+
2676
+
2677
+ <h5 class="h5-parameters">Parameters:</h5>
2678
+
2679
+
2680
+ <table class="params">
2681
+ <thead>
2682
+ <tr>
2683
+
2684
+ <th>Name</th>
2685
+
2686
+
2687
+ <th>Type</th>
2688
+
2689
+
2690
+
2691
+
2692
+
2693
+ <th class="last">Description</th>
2694
+ </tr>
2695
+ </thead>
2696
+
2697
+ <tbody>
2698
+
2699
+
2700
+ <tr>
2701
+
2702
+ <td class="name"><code>params</code></td>
2703
+
2704
+
2705
+ <td class="type">
2706
+
2707
+
2708
+ <span class="param-type">CreateForumCategoryParams</span>
2709
+
2710
+
2711
+
2712
+
2713
+ </td>
2714
+
2715
+
2716
+
2717
+
2718
+
2719
+ <td class="description last">The parameters for creating the forum category.</td>
2720
+ </tr>
2721
+
2722
+
2723
+ </tbody>
2724
+ </table>
2725
+
2726
+
2727
+
2728
+
2729
+
2730
+
2731
+
2732
+
2733
+
2734
+
2735
+
2736
+
2737
+
2738
+
2739
+ <h5 class="h5-throws">Throws:</h5>
2740
+
2741
+
2742
+
2743
+ <dl>
2744
+ <dt>
2745
+ <div class="param-desc usertext">
2746
+ - If the request fails.
2747
+ </div>
2748
+ </dt>
2749
+ <dd></dd>
2750
+ <dt>
2751
+ <dl class="param-type">
2752
+ <dt>
2753
+ Type
2754
+ </dt>
2755
+ <dd>
2756
+
2757
+ <span class="param-type">HttpError</span>
2758
+
2759
+
2760
+
2761
+ </dd>
2762
+ </dl>
2763
+ </dt>
2764
+ <dd></dd>
2765
+ </dl>
2766
+
2767
+
2768
+
2769
+
2770
+
2771
+ <h5 class="h5-returns">Returns:</h5>
2772
+
2773
+
2774
+ <div class="param-desc">
2775
+ - A promise that resolves to the created forum category.
2776
+ </div>
2777
+
2778
+
2779
+
2780
+ <dl class="param-type">
2781
+ <dt>
2782
+ Type
2783
+ </dt>
2784
+ <dd>
2785
+
2786
+ <span class="param-type">Promise.&lt;ForumCategory></span>
2787
+
2788
+
2789
+
2790
+ </dd>
2791
+ </dl>
2792
+
2793
+
2794
+
2795
+
2796
+
2797
+
2798
+
2799
+
2800
+
2801
+
2802
+ <h4 class="name" id="~createThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>createThread<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumThread>}</span></h4>
2803
+
2804
+
2805
+
2806
+
2807
+
2808
+
2809
+ <dl class="details">
2810
+
2811
+ <dt class="tag-description">Description:</dt>
2812
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
2813
+
2814
+
2815
+
2816
+ <dt class="tag-source">Source:</dt>
2817
+ <dd class="tag-source"><ul class="dummy"><li>
2818
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
2819
+ </li></ul></dd>
2820
+
2821
+
2822
+
2823
+
2824
+
2825
+
2826
+
2827
+
2828
+
2829
+
2830
+
2831
+
2832
+
2833
+
2834
+
2835
+
2836
+
2837
+
2838
+
2839
+
2840
+
2841
+
2842
+
2843
+
2844
+
2845
+
2846
+
2847
+
2848
+
2849
+
2850
+
2851
+ </dl>
2852
+
2853
+
2854
+
2855
+
2856
+
2857
+
2858
+
2859
+
2860
+
2861
+
2862
+
2863
+
2864
+
2865
+ <h5 class="h5-parameters">Parameters:</h5>
2866
+
2867
+
2868
+ <table class="params">
2869
+ <thead>
2870
+ <tr>
2871
+
2872
+ <th>Name</th>
2873
+
2874
+
2875
+ <th>Type</th>
2876
+
2877
+
2878
+
2879
+
2880
+
2881
+ <th class="last">Description</th>
2882
+ </tr>
2883
+ </thead>
2884
+
2885
+ <tbody>
2886
+
2887
+
2888
+ <tr>
2889
+
2890
+ <td class="name"><code>params</code></td>
2891
+
2892
+
2893
+ <td class="type">
2894
+
2895
+
2896
+ <span class="param-type">CreateThreadParams</span>
2897
+
2898
+
2899
+
2900
+
2901
+ </td>
2902
+
2903
+
2904
+
2905
+
2906
+
2907
+ <td class="description last">The parameters for creating the thread.</td>
2908
+ </tr>
2909
+
2910
+
2911
+ </tbody>
2912
+ </table>
2913
+
2914
+
2915
+
2916
+
2917
+
2918
+
2919
+
2920
+
2921
+
2922
+
2923
+
2924
+
2925
+
2926
+
2927
+ <h5 class="h5-throws">Throws:</h5>
2928
+
2929
+
2930
+
2931
+ <dl>
2932
+ <dt>
2933
+ <div class="param-desc usertext">
2934
+ - If the request fails.
2935
+ </div>
2936
+ </dt>
2937
+ <dd></dd>
2938
+ <dt>
2939
+ <dl class="param-type">
2940
+ <dt>
2941
+ Type
2942
+ </dt>
2943
+ <dd>
2944
+
2945
+ <span class="param-type">HttpError</span>
2946
+
2947
+
2948
+
2949
+ </dd>
2950
+ </dl>
2951
+ </dt>
2952
+ <dd></dd>
2953
+ </dl>
2954
+
2955
+
2956
+
2957
+
2958
+
2959
+ <h5 class="h5-returns">Returns:</h5>
2960
+
2961
+
2962
+ <div class="param-desc">
2963
+ - A promise that resolves to the created thread.
2964
+ </div>
2965
+
2966
+
2967
+
2968
+ <dl class="param-type">
2969
+ <dt>
2970
+ Type
2971
+ </dt>
2972
+ <dd>
2973
+
2974
+ <span class="param-type">Promise.&lt;ForumThread></span>
2975
+
2976
+
2977
+
2978
+ </dd>
2979
+ </dl>
2980
+
2981
+
2982
+
2983
+
2984
+
2985
+
2986
+
2987
+
2988
+
2989
+
2990
+ <h4 class="name" id="~fetchForumCategories"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchForumCategories<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
2991
+
2992
+
2993
+
2994
+
2995
+
2996
+
2997
+ <dl class="details">
2998
+
2999
+ <dt class="tag-description">Description:</dt>
3000
+ <dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
3001
+
3002
+
3003
+
3004
+ <dt class="tag-source">Source:</dt>
3005
+ <dd class="tag-source"><ul class="dummy"><li>
3006
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
3007
+ </li></ul></dd>
3008
+
3009
+
3010
+
3011
+
3012
+
3013
+
3014
+
3015
+
3016
+
3017
+
3018
+
3019
+
3020
+
3021
+
3022
+
3023
+
3024
+
3025
+
3026
+
3027
+
3028
+
3029
+
3030
+
3031
+
3032
+
3033
+
3034
+
3035
+
3036
+
3037
+
3038
+
3039
+ </dl>
3040
+
3041
+
3042
+
3043
+
3044
+
3045
+
3046
+
3047
+
3048
+
3049
+
3050
+
3051
+
3052
+
3053
+ <h5 class="h5-parameters">Parameters:</h5>
3054
+
3055
+
3056
+ <table class="params">
3057
+ <thead>
3058
+ <tr>
3059
+
3060
+ <th>Name</th>
3061
+
3062
+
3063
+ <th>Type</th>
3064
+
3065
+
3066
+
3067
+
3068
+
3069
+ <th class="last">Description</th>
3070
+ </tr>
3071
+ </thead>
3072
+
3073
+ <tbody>
3074
+
3075
+
3076
+ <tr>
3077
+
3078
+ <td class="name"><code>brand</code></td>
3079
+
3080
+
3081
+ <td class="type">
3082
+
3083
+
3084
+ <span class="param-type">string</span>
3085
+ |
3086
+
3087
+ <span class="param-type">null</span>
3088
+
3089
+
3090
+
3091
+
3092
+ </td>
3093
+
3094
+
3095
+
3096
+
3097
+
3098
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
3099
+ </tr>
3100
+
3101
+
3102
+ </tbody>
3103
+ </table>
3104
+
3105
+
3106
+
3107
+
3108
+
3109
+
3110
+
3111
+
3112
+
3113
+
3114
+
3115
+
3116
+
3117
+
3118
+ <h5 class="h5-throws">Throws:</h5>
3119
+
3120
+
3121
+
3122
+ <dl>
3123
+ <dt>
3124
+ <div class="param-desc usertext">
3125
+ - If the request fails.
3126
+ </div>
3127
+ </dt>
3128
+ <dd></dd>
3129
+ <dt>
3130
+ <dl class="param-type">
3131
+ <dt>
3132
+ Type
3133
+ </dt>
3134
+ <dd>
3135
+
3136
+ <span class="param-type">HttpError</span>
3137
+
3138
+
3139
+
3140
+ </dd>
3141
+ </dl>
3142
+ </dt>
3143
+ <dd></dd>
3144
+ </dl>
3145
+
3146
+
3147
+
3148
+
3149
+
3150
+ <h5 class="h5-returns">Returns:</h5>
3151
+
3152
+
3153
+ <div class="param-desc">
3154
+ - A promise that resolves to the list of forum categories.
3155
+ </div>
3156
+
3157
+
3158
+
3159
+ <dl class="param-type">
3160
+ <dt>
3161
+ Type
3162
+ </dt>
3163
+ <dd>
3164
+
3165
+ <span class="param-type">Promise.&lt;ForumCategory></span>
3166
+
3167
+
3168
+
3169
+ </dd>
3170
+ </dl>
3171
+
3172
+
3173
+
3174
+
3175
+
3176
+
3177
+
3178
+
3179
+
3180
+
3181
+ <h4 class="name" id="~fetchThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchThreads<span class="signature">(categoryId, brand, params)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumThread>>}</span></h4>
3182
+
3183
+
3184
+
3185
+
3186
+
3187
+
3188
+ <dl class="details">
3189
+
3190
+ <dt class="tag-description">Description:</dt>
3191
+ <dd class="tag-description"><ul class="dummy"><li>Fetches forum threads for the given category.</li></ul></dd>
3192
+
3193
+
3194
+
3195
+ <dt class="tag-source">Source:</dt>
3196
+ <dd class="tag-source"><ul class="dummy"><li>
3197
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line84">line 84</a>
3198
+ </li></ul></dd>
3199
+
3200
+
3201
+
3202
+
3203
+
3204
+
3205
+
3206
+
3207
+
3208
+
3209
+
3210
+
3211
+
3212
+
3213
+
3214
+
3215
+
3216
+
3217
+
3218
+
3219
+
3220
+
3221
+
3222
+
3223
+
3224
+
3225
+
3226
+
3227
+
3228
+
3229
+
3230
+ </dl>
3231
+
3232
+
3233
+
3234
+
3235
+
3236
+
3237
+
3238
+
3239
+
3240
+
3241
+
3242
+
3243
+
3244
+ <h5 class="h5-parameters">Parameters:</h5>
3245
+
3246
+
3247
+ <table class="params">
3248
+ <thead>
3249
+ <tr>
3250
+
3251
+ <th>Name</th>
3252
+
3253
+
3254
+ <th>Type</th>
3255
+
3256
+
3257
+
3258
+
3259
+
3260
+ <th class="last">Description</th>
3261
+ </tr>
3262
+ </thead>
3263
+
3264
+ <tbody>
3265
+
3266
+
3267
+ <tr>
3268
+
3269
+ <td class="name"><code>categoryId</code></td>
3270
+
3271
+
3272
+ <td class="type">
3273
+
3274
+
3275
+ <span class="param-type">number</span>
3276
+
3277
+
3278
+
3279
+
3280
+ </td>
3281
+
3282
+
3283
+
3284
+
3285
+
3286
+ <td class="description last">The ID of the forum category.</td>
3287
+ </tr>
3288
+
3289
+
3290
+
3291
+ <tr>
3292
+
3293
+ <td class="name"><code>brand</code></td>
3294
+
3295
+
3296
+ <td class="type">
3297
+
3298
+
3299
+ <span class="param-type">string</span>
3300
+
3301
+
3302
+
3303
+
3304
+ </td>
3305
+
3306
+
3307
+
3308
+
3309
+
3310
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
3311
+ </tr>
3312
+
3313
+
3314
+
3315
+ <tr>
3316
+
3317
+ <td class="name"><code>params</code></td>
3318
+
3319
+
3320
+ <td class="type">
3321
+
3322
+
3323
+ <span class="param-type">FetchThreadParams</span>
3324
+
3325
+
3326
+
3327
+
3328
+ </td>
3329
+
3330
+
3331
+
3332
+
3333
+
3334
+ <td class="description last">Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")).</td>
3335
+ </tr>
3336
+
3337
+
3338
+ </tbody>
3339
+ </table>
3340
+
3341
+
3342
+
3343
+
3344
+
3345
+
3346
+
3347
+
3348
+
3349
+
3350
+
3351
+
3352
+
3353
+
3354
+ <h5 class="h5-throws">Throws:</h5>
3355
+
3356
+
3357
+
3358
+ <dl>
3359
+ <dt>
3360
+ <div class="param-desc usertext">
3361
+ - If the HTTP request fails.
3362
+ </div>
3363
+ </dt>
3364
+ <dd></dd>
3365
+ <dt>
3366
+ <dl class="param-type">
3367
+ <dt>
3368
+ Type
3369
+ </dt>
3370
+ <dd>
3371
+
3372
+ <span class="param-type">HttpError</span>
3373
+
3374
+
3375
+
3376
+ </dd>
3377
+ </dl>
3378
+ </dt>
3379
+ <dd></dd>
3380
+ </dl>
3381
+
3382
+
3383
+
3384
+
3385
+
3386
+ <h5 class="h5-returns">Returns:</h5>
3387
+
3388
+
3389
+ <div class="param-desc">
3390
+ - A promise that resolves to a paginated list of forum threads.
3391
+ </div>
3392
+
3393
+
3394
+
3395
+ <dl class="param-type">
3396
+ <dt>
3397
+ Type
3398
+ </dt>
3399
+ <dd>
3400
+
3401
+ <span class="param-type">Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumThread>></span>
3402
+
3403
+
3404
+
3405
+ </dd>
3406
+ </dl>
3407
+
3408
+
3409
+
3410
+
3411
+
3412
+
3413
+
3414
+
3415
+
3416
+
3417
+ <h4 class="name" id="~followThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>followThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
3418
+
3419
+
3420
+
3421
+
3422
+
3423
+
3424
+ <dl class="details">
3425
+
3426
+ <dt class="tag-description">Description:</dt>
3427
+ <dd class="tag-description"><ul class="dummy"><li>Follow a thread.</li></ul></dd>
3428
+
3429
+
3430
+
3431
+ <dt class="tag-source">Source:</dt>
3432
+ <dd class="tag-source"><ul class="dummy"><li>
3433
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line52">line 52</a>
3434
+ </li></ul></dd>
3435
+
3436
+
3437
+
3438
+
3439
+
3440
+
3441
+
3442
+
3443
+
3444
+
3445
+
3446
+
3447
+
3448
+
3449
+
3450
+
3451
+
3452
+
3453
+
3454
+
3455
+
3456
+
3457
+
3458
+
3459
+
3460
+
3461
+
3462
+
3463
+
3464
+
3465
+
3466
+ </dl>
3467
+
3468
+
3469
+
3470
+
3471
+
3472
+
3473
+
3474
+
3475
+
3476
+
3477
+
3478
+
3479
+
3480
+ <h5 class="h5-parameters">Parameters:</h5>
3481
+
3482
+
3483
+ <table class="params">
3484
+ <thead>
3485
+ <tr>
3486
+
3487
+ <th>Name</th>
3488
+
3489
+
3490
+ <th>Type</th>
3491
+
3492
+
3493
+
3494
+
3495
+
3496
+ <th class="last">Description</th>
3497
+ </tr>
3498
+ </thead>
3499
+
3500
+ <tbody>
3501
+
3502
+
3503
+ <tr>
3504
+
3505
+ <td class="name"><code>threadId</code></td>
3506
+
3507
+
3508
+ <td class="type">
3509
+
3510
+
3511
+ <span class="param-type">number</span>
3512
+
3513
+
3514
+
3515
+
3516
+ </td>
3517
+
3518
+
3519
+
3520
+
3521
+
3522
+ <td class="description last">The ID of the thread to lock.</td>
3523
+ </tr>
3524
+
3525
+
3526
+
3527
+ <tr>
3528
+
3529
+ <td class="name"><code>brand</code></td>
3530
+
3531
+
3532
+ <td class="type">
3533
+
3534
+
3535
+ <span class="param-type">string</span>
3536
+
3537
+
3538
+
3539
+
3540
+ </td>
3541
+
3542
+
3543
+
3544
+
3545
+
3546
+ <td class="description last">The brand associated with the follow action.</td>
3547
+ </tr>
3548
+
3549
+
3550
+ </tbody>
3551
+ </table>
3552
+
3553
+
3554
+
3555
+
3556
+
3557
+
3558
+
3559
+
3560
+
3561
+
3562
+
3563
+
3564
+
3565
+
3566
+ <h5 class="h5-throws">Throws:</h5>
3567
+
3568
+
3569
+
3570
+ <dl>
3571
+ <dt>
3572
+ <div class="param-desc usertext">
3573
+ - If the request fails.
3574
+ </div>
3575
+ </dt>
3576
+ <dd></dd>
3577
+ <dt>
3578
+ <dl class="param-type">
3579
+ <dt>
3580
+ Type
3581
+ </dt>
3582
+ <dd>
3583
+
3584
+ <span class="param-type">HttpError</span>
3585
+
3586
+
3587
+
3588
+ </dd>
3589
+ </dl>
3590
+ </dt>
3591
+ <dd></dd>
3592
+ </dl>
3593
+
3594
+
3595
+
3596
+
3597
+
3598
+ <h5 class="h5-returns">Returns:</h5>
3599
+
3600
+
3601
+ <div class="param-desc">
3602
+ - A promise that resolves when the thread is locked.
3603
+ </div>
3604
+
3605
+
3606
+
3607
+ <dl class="param-type">
3608
+ <dt>
3609
+ Type
3610
+ </dt>
3611
+ <dd>
3612
+
3613
+ <span class="param-type">Promise.&lt;void></span>
3614
+
3615
+
3616
+
3617
+ </dd>
3618
+ </dl>
3619
+
3620
+
3621
+
3622
+
3623
+
3624
+
3625
+
3626
+
3627
+
3628
+
3629
+ <h4 class="name" id="~lockThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>lockThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
3630
+
3631
+
3632
+
3633
+
3634
+
3635
+
3636
+ <dl class="details">
3637
+
3638
+ <dt class="tag-description">Description:</dt>
3639
+ <dd class="tag-description"><ul class="dummy"><li>Locks a thread to prevent further posts.</li></ul></dd>
3640
+
3641
+
3642
+
3643
+ <dt class="tag-source">Source:</dt>
3644
+ <dd class="tag-source"><ul class="dummy"><li>
3645
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
3646
+ </li></ul></dd>
3647
+
3648
+
3649
+
3650
+
3651
+
3652
+
3653
+
3654
+
3655
+
3656
+
3657
+
3658
+
3659
+
3660
+
3661
+
3662
+
3663
+
3664
+
3665
+
3666
+
3667
+
3668
+
3669
+
3670
+
3671
+
3672
+
3673
+
3674
+
3675
+
3676
+
3677
+
3678
+ </dl>
3679
+
3680
+
3681
+
3682
+
3683
+
3684
+
3685
+
3686
+
3687
+
3688
+
3689
+
3690
+
3691
+
3692
+ <h5 class="h5-parameters">Parameters:</h5>
3693
+
3694
+
3695
+ <table class="params">
3696
+ <thead>
3697
+ <tr>
3698
+
3699
+ <th>Name</th>
3700
+
3701
+
3702
+ <th>Type</th>
3703
+
3704
+
3705
+
3706
+
3707
+
3708
+ <th class="last">Description</th>
3709
+ </tr>
3710
+ </thead>
3711
+
3712
+ <tbody>
3713
+
3714
+
3715
+ <tr>
3716
+
3717
+ <td class="name"><code>threadId</code></td>
3718
+
3719
+
3720
+ <td class="type">
3721
+
3722
+
3723
+ <span class="param-type">number</span>
3724
+
3725
+
3726
+
3727
+
3728
+ </td>
3729
+
3730
+
3731
+
3732
+
3733
+
3734
+ <td class="description last">The ID of the thread to lock.</td>
3735
+ </tr>
3736
+
3737
+
3738
+
3739
+ <tr>
3740
+
3741
+ <td class="name"><code>brand</code></td>
3742
+
3743
+
3744
+ <td class="type">
3745
+
3746
+
3747
+ <span class="param-type">string</span>
3748
+
3749
+
3750
+
3751
+
3752
+ </td>
3753
+
3754
+
3755
+
3756
+
3757
+
3758
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
3759
+ </tr>
3760
+
3761
+
3762
+ </tbody>
3763
+ </table>
3764
+
3765
+
3766
+
3767
+
3768
+
3769
+
3770
+
3771
+
3772
+
3773
+
3774
+
3775
+
3776
+
3777
+
3778
+ <h5 class="h5-throws">Throws:</h5>
3779
+
3780
+
3781
+
3782
+ <dl>
3783
+ <dt>
3784
+ <div class="param-desc usertext">
3785
+ - If the request fails.
3786
+ </div>
3787
+ </dt>
3788
+ <dd></dd>
3789
+ <dt>
3790
+ <dl class="param-type">
3791
+ <dt>
3792
+ Type
3793
+ </dt>
3794
+ <dd>
3795
+
3796
+ <span class="param-type">HttpError</span>
3797
+
3798
+
3799
+
3800
+ </dd>
3801
+ </dl>
3802
+ </dt>
3803
+ <dd></dd>
3804
+ </dl>
3805
+
3806
+
3807
+
3808
+
3809
+
3810
+ <h5 class="h5-returns">Returns:</h5>
3811
+
3812
+
3813
+ <div class="param-desc">
3814
+ - A promise that resolves when the thread is locked.
3815
+ </div>
3816
+
3817
+
3818
+
3819
+ <dl class="param-type">
3820
+ <dt>
3821
+ Type
3822
+ </dt>
3823
+ <dd>
3824
+
3825
+ <span class="param-type">Promise.&lt;void></span>
3826
+
3827
+
3828
+
3829
+ </dd>
3830
+ </dl>
3831
+
3832
+
3833
+
3834
+
3835
+
3836
+
3837
+
3838
+
3839
+
3840
+
3841
+ <h4 class="name" id="~pinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>pinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
3842
+
3843
+
3844
+
3845
+
3846
+
3847
+
3848
+ <dl class="details">
3849
+
3850
+ <dt class="tag-description">Description:</dt>
3851
+ <dd class="tag-description"><ul class="dummy"><li>Pins a thread to the top of its category.</li></ul></dd>
3852
+
3853
+
3854
+
3855
+ <dt class="tag-source">Source:</dt>
3856
+ <dd class="tag-source"><ul class="dummy"><li>
3857
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line108">line 108</a>
3858
+ </li></ul></dd>
3859
+
3860
+
3861
+
3862
+
3863
+
3864
+
3865
+
3866
+
3867
+
3868
+
3869
+
3870
+
3871
+
3872
+
3873
+
3874
+
3875
+
3876
+
3877
+
3878
+
3879
+
3880
+
3881
+
3882
+
3883
+
3884
+
3885
+
3886
+
3887
+
3888
+
3889
+
3890
+ </dl>
3891
+
3892
+
3893
+
3894
+
3895
+
3896
+
3897
+
3898
+
3899
+
3900
+
3901
+
3902
+
3903
+
3904
+ <h5 class="h5-parameters">Parameters:</h5>
3905
+
3906
+
3907
+ <table class="params">
3908
+ <thead>
3909
+ <tr>
3910
+
3911
+ <th>Name</th>
3912
+
3913
+
3914
+ <th>Type</th>
3915
+
3916
+
3917
+
3918
+
3919
+
3920
+ <th class="last">Description</th>
3921
+ </tr>
3922
+ </thead>
3923
+
3924
+ <tbody>
3925
+
3926
+
3927
+ <tr>
3928
+
3929
+ <td class="name"><code>threadId</code></td>
3930
+
3931
+
3932
+ <td class="type">
3933
+
3934
+
3935
+ <span class="param-type">number</span>
3936
+
3937
+
3938
+
3939
+
3940
+ </td>
3941
+
3942
+
3943
+
3944
+
3945
+
3946
+ <td class="description last">The ID of the thread to pin.</td>
3947
+ </tr>
3948
+
3949
+
3950
+
3951
+ <tr>
3952
+
3953
+ <td class="name"><code>brand</code></td>
3954
+
3955
+
3956
+ <td class="type">
3957
+
3958
+
3959
+ <span class="param-type">string</span>
3960
+
3961
+
3962
+
3963
+
3964
+ </td>
3965
+
3966
+
3967
+
3968
+
3969
+
3970
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
3971
+ </tr>
3972
+
3973
+
3974
+ </tbody>
3975
+ </table>
3976
+
3977
+
3978
+
3979
+
3980
+
3981
+
3982
+
3983
+
3984
+
3985
+
3986
+
3987
+
3988
+
3989
+
3990
+ <h5 class="h5-throws">Throws:</h5>
3991
+
3992
+
3993
+
3994
+ <dl>
3995
+ <dt>
3996
+ <div class="param-desc usertext">
3997
+ - If the request fails.
3998
+ </div>
3999
+ </dt>
4000
+ <dd></dd>
4001
+ <dt>
4002
+ <dl class="param-type">
4003
+ <dt>
4004
+ Type
4005
+ </dt>
4006
+ <dd>
4007
+
4008
+ <span class="param-type">HttpError</span>
4009
+
4010
+
4011
+
4012
+ </dd>
4013
+ </dl>
4014
+ </dt>
4015
+ <dd></dd>
4016
+ </dl>
4017
+
4018
+
4019
+
4020
+
4021
+
4022
+ <h5 class="h5-returns">Returns:</h5>
4023
+
4024
+
4025
+ <div class="param-desc">
4026
+ - A promise that resolves when the thread is pinned.
4027
+ </div>
4028
+
4029
+
4030
+
4031
+ <dl class="param-type">
4032
+ <dt>
4033
+ Type
4034
+ </dt>
4035
+ <dd>
4036
+
4037
+ <span class="param-type">Promise.&lt;void></span>
4038
+
4039
+
4040
+
4041
+ </dd>
4042
+ </dl>
4043
+
4044
+
4045
+
4046
+
4047
+
4048
+
4049
+
4050
+
4051
+
4052
+
4053
+ <h4 class="name" id="~unfollowThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unfollowThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
4054
+
4055
+
4056
+
4057
+
4058
+
4059
+
4060
+ <dl class="details">
4061
+
4062
+ <dt class="tag-description">Description:</dt>
4063
+ <dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
4064
+
4065
+
4066
+
4067
+ <dt class="tag-source">Source:</dt>
4068
+ <dd class="tag-source"><ul class="dummy"><li>
4069
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
4070
+ </li></ul></dd>
4071
+
4072
+
4073
+
4074
+
4075
+
4076
+
4077
+
4078
+
4079
+
4080
+
4081
+
4082
+
4083
+
4084
+
4085
+
4086
+
4087
+
4088
+
4089
+
4090
+
4091
+
4092
+
4093
+
4094
+
4095
+
4096
+
4097
+
4098
+
4099
+
4100
+
4101
+
4102
+ </dl>
4103
+
4104
+
4105
+
4106
+
4107
+
4108
+
4109
+
4110
+
4111
+
4112
+
4113
+
4114
+
4115
+
4116
+ <h5 class="h5-parameters">Parameters:</h5>
4117
+
4118
+
4119
+ <table class="params">
4120
+ <thead>
4121
+ <tr>
4122
+
4123
+ <th>Name</th>
4124
+
4125
+
4126
+ <th>Type</th>
4127
+
4128
+
4129
+
4130
+
4131
+
4132
+ <th class="last">Description</th>
4133
+ </tr>
4134
+ </thead>
4135
+
4136
+ <tbody>
4137
+
4138
+
4139
+ <tr>
4140
+
4141
+ <td class="name"><code>threadId</code></td>
4142
+
4143
+
4144
+ <td class="type">
4145
+
4146
+
4147
+ <span class="param-type">number</span>
4148
+
4149
+
4150
+
4151
+
4152
+ </td>
4153
+
4154
+
4155
+
4156
+
4157
+
4158
+ <td class="description last">The ID of the thread to unlock.</td>
4159
+ </tr>
4160
+
4161
+
4162
+
4163
+ <tr>
4164
+
4165
+ <td class="name"><code>brand</code></td>
4166
+
4167
+
4168
+ <td class="type">
4169
+
4170
+
4171
+ <span class="param-type">string</span>
4172
+
4173
+
4174
+
4175
+
4176
+ </td>
4177
+
4178
+
4179
+
4180
+
4181
+
4182
+ <td class="description last">The brand associated with the unlock action.</td>
4183
+ </tr>
4184
+
4185
+
4186
+ </tbody>
4187
+ </table>
2280
4188
 
2281
4189
 
2282
4190
 
@@ -2298,7 +4206,7 @@
2298
4206
  <dl>
2299
4207
  <dt>
2300
4208
  <div class="param-desc usertext">
2301
- - If the HTTP request fails.
4209
+ - If the request fails.
2302
4210
  </div>
2303
4211
  </dt>
2304
4212
  <dd></dd>
@@ -2327,7 +4235,7 @@
2327
4235
 
2328
4236
 
2329
4237
  <div class="param-desc">
2330
- - A promise that resolves to a paginated list of forum threads.
4238
+ - A promise that resolves when the thread is unlocked.
2331
4239
  </div>
2332
4240
 
2333
4241
 
@@ -2338,7 +4246,7 @@
2338
4246
  </dt>
2339
4247
  <dd>
2340
4248
 
2341
- <span class="param-type">Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumThread>></span>
4249
+ <span class="param-type">Promise.&lt;void></span>
2342
4250
 
2343
4251
 
2344
4252
 
@@ -2354,7 +4262,7 @@
2354
4262
 
2355
4263
 
2356
4264
 
2357
- <h4 class="name" id="~followThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>followThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
4265
+ <h4 class="name" id="~unlockThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unlockThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
2358
4266
 
2359
4267
 
2360
4268
 
@@ -2364,13 +4272,13 @@
2364
4272
  <dl class="details">
2365
4273
 
2366
4274
  <dt class="tag-description">Description:</dt>
2367
- <dd class="tag-description"><ul class="dummy"><li>Follow a thread.</li></ul></dd>
4275
+ <dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
2368
4276
 
2369
4277
 
2370
4278
 
2371
4279
  <dt class="tag-source">Source:</dt>
2372
4280
  <dd class="tag-source"><ul class="dummy"><li>
2373
- <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line33">line 33</a>
4281
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
2374
4282
  </li></ul></dd>
2375
4283
 
2376
4284
 
@@ -2459,7 +4367,7 @@
2459
4367
 
2460
4368
 
2461
4369
 
2462
- <td class="description last">The ID of the thread to lock.</td>
4370
+ <td class="description last">The ID of the thread to unlock.</td>
2463
4371
  </tr>
2464
4372
 
2465
4373
 
@@ -2483,7 +4391,7 @@
2483
4391
 
2484
4392
 
2485
4393
 
2486
- <td class="description last">The brand associated with the follow action.</td>
4394
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
2487
4395
  </tr>
2488
4396
 
2489
4397
 
@@ -2539,7 +4447,7 @@
2539
4447
 
2540
4448
 
2541
4449
  <div class="param-desc">
2542
- - A promise that resolves when the thread is locked.
4450
+ - A promise that resolves when the thread is unlocked.
2543
4451
  </div>
2544
4452
 
2545
4453
 
@@ -2566,7 +4474,7 @@
2566
4474
 
2567
4475
 
2568
4476
 
2569
- <h4 class="name" id="~unfollowThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unfollowThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
4477
+ <h4 class="name" id="~unpinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unpinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
2570
4478
 
2571
4479
 
2572
4480
 
@@ -2576,13 +4484,13 @@
2576
4484
  <dl class="details">
2577
4485
 
2578
4486
  <dt class="tag-description">Description:</dt>
2579
- <dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
4487
+ <dd class="tag-description"><ul class="dummy"><li>Unpins a thread from the top of its category.</li></ul></dd>
2580
4488
 
2581
4489
 
2582
4490
 
2583
4491
  <dt class="tag-source">Source:</dt>
2584
4492
  <dd class="tag-source"><ul class="dummy"><li>
2585
- <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line46">line 46</a>
4493
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
2586
4494
  </li></ul></dd>
2587
4495
 
2588
4496
 
@@ -2671,7 +4579,7 @@
2671
4579
 
2672
4580
 
2673
4581
 
2674
- <td class="description last">The ID of the thread to unlock.</td>
4582
+ <td class="description last">The ID of the thread to unpin.</td>
2675
4583
  </tr>
2676
4584
 
2677
4585
 
@@ -2695,7 +4603,7 @@
2695
4603
 
2696
4604
 
2697
4605
 
2698
- <td class="description last">The brand associated with the unlock action.</td>
4606
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
2699
4607
  </tr>
2700
4608
 
2701
4609
 
@@ -2751,7 +4659,7 @@
2751
4659
 
2752
4660
 
2753
4661
  <div class="param-desc">
2754
- - A promise that resolves when the thread is unlocked.
4662
+ - A promise that resolves when the thread is unpinned.
2755
4663
  </div>
2756
4664
 
2757
4665
 
@@ -2962,6 +4870,218 @@
2962
4870
 
2963
4871
 
2964
4872
 
4873
+
4874
+
4875
+
4876
+
4877
+ <h4 class="name" id="~updateThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateThread<span class="signature">(threadId, params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumThread>}</span></h4>
4878
+
4879
+
4880
+
4881
+
4882
+
4883
+
4884
+ <dl class="details">
4885
+
4886
+ <dt class="tag-description">Description:</dt>
4887
+ <dd class="tag-description"><ul class="dummy"><li>Updates an existing thread under a forum category.</li></ul></dd>
4888
+
4889
+
4890
+
4891
+ <dt class="tag-source">Source:</dt>
4892
+ <dd class="tag-source"><ul class="dummy"><li>
4893
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line36">line 36</a>
4894
+ </li></ul></dd>
4895
+
4896
+
4897
+
4898
+
4899
+
4900
+
4901
+
4902
+
4903
+
4904
+
4905
+
4906
+
4907
+
4908
+
4909
+
4910
+
4911
+
4912
+
4913
+
4914
+
4915
+
4916
+
4917
+
4918
+
4919
+
4920
+
4921
+
4922
+
4923
+
4924
+
4925
+
4926
+ </dl>
4927
+
4928
+
4929
+
4930
+
4931
+
4932
+
4933
+
4934
+
4935
+
4936
+
4937
+
4938
+
4939
+
4940
+ <h5 class="h5-parameters">Parameters:</h5>
4941
+
4942
+
4943
+ <table class="params">
4944
+ <thead>
4945
+ <tr>
4946
+
4947
+ <th>Name</th>
4948
+
4949
+
4950
+ <th>Type</th>
4951
+
4952
+
4953
+
4954
+
4955
+
4956
+ <th class="last">Description</th>
4957
+ </tr>
4958
+ </thead>
4959
+
4960
+ <tbody>
4961
+
4962
+
4963
+ <tr>
4964
+
4965
+ <td class="name"><code>threadId</code></td>
4966
+
4967
+
4968
+ <td class="type">
4969
+
4970
+
4971
+ <span class="param-type">number</span>
4972
+
4973
+
4974
+
4975
+
4976
+ </td>
4977
+
4978
+
4979
+
4980
+
4981
+
4982
+ <td class="description last">The ID of the thread to update.</td>
4983
+ </tr>
4984
+
4985
+
4986
+
4987
+ <tr>
4988
+
4989
+ <td class="name"><code>params</code></td>
4990
+
4991
+
4992
+ <td class="type">
4993
+
4994
+
4995
+ <span class="param-type">UpdateThreadParams</span>
4996
+
4997
+
4998
+
4999
+
5000
+ </td>
5001
+
5002
+
5003
+
5004
+
5005
+
5006
+ <td class="description last">The parameters for updating the thread.</td>
5007
+ </tr>
5008
+
5009
+
5010
+ </tbody>
5011
+ </table>
5012
+
5013
+
5014
+
5015
+
5016
+
5017
+
5018
+
5019
+
5020
+
5021
+
5022
+
5023
+
5024
+
5025
+
5026
+ <h5 class="h5-throws">Throws:</h5>
5027
+
5028
+
5029
+
5030
+ <dl>
5031
+ <dt>
5032
+ <div class="param-desc usertext">
5033
+ - If the request fails.
5034
+ </div>
5035
+ </dt>
5036
+ <dd></dd>
5037
+ <dt>
5038
+ <dl class="param-type">
5039
+ <dt>
5040
+ Type
5041
+ </dt>
5042
+ <dd>
5043
+
5044
+ <span class="param-type">HttpError</span>
5045
+
5046
+
5047
+
5048
+ </dd>
5049
+ </dl>
5050
+ </dt>
5051
+ <dd></dd>
5052
+ </dl>
5053
+
5054
+
5055
+
5056
+
5057
+
5058
+ <h5 class="h5-returns">Returns:</h5>
5059
+
5060
+
5061
+ <div class="param-desc">
5062
+ - A promise that resolves to the updated thread.
5063
+ </div>
5064
+
5065
+
5066
+
5067
+ <dl class="param-type">
5068
+ <dt>
5069
+ Type
5070
+ </dt>
5071
+ <dd>
5072
+
5073
+ <span class="param-type">Promise.&lt;ForumThread></span>
5074
+
5075
+
5076
+
5077
+ </dd>
5078
+ </dl>
5079
+
5080
+
5081
+
5082
+
5083
+
5084
+
2965
5085
 
2966
5086
 
2967
5087
 
@@ -2981,7 +5101,7 @@
2981
5101
  <br class="clear">
2982
5102
 
2983
5103
  <footer>
2984
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Sep 22 2025 12:44:47 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
5104
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Wed Sep 24 2025 13:39:02 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2985
5105
  </footer>
2986
5106
 
2987
5107
  <script>prettyPrint();</script>