guilded-api-typings - npm Package Compare versions

Comparing version 0.0.0-dev-20220901105754 to 0.0.0-dev-20220904203556

CHANGELOG.md

 # guilded-api-typings
 
-## 0.0.0-dev-20220901105754
+## 0.0.0-dev-20220904203556
 
 ### Minor Changes
 
+-   2d36b59: feat: forum topic pinning
+
+## 0.10.0
+
+### Minor Changes
+
 -   bb54674: feat: set server member XP
@@ -8,0 +14,0 @@

dist/REST.js

@@ -118,3 +118,3 @@ "use strict";
      * @param channelId The ID of the channel the forum topic belongs to.
-     * @param topicId The ID of the forum topic.
+     * @param forumTopicId The ID of the forum topic.
      * @see https://www.guilded.gg/docs/api/forums/ForumTopicRead
@@ -125,6 +125,17 @@ * @see https://www.guilded.gg/docs/api/forums/ForumTopicUpdate
      */
-    static forumTopic(channelId, topicId) {
-        return `/channels/${channelId}/topics/${topicId}`;
+    static forumTopic(channelId, forumTopicId) {
+        return `/channels/${channelId}/topics/${forumTopicId}`;
     }
     /**
+     * The endpoint for a forum topic pin.
+     * @param channelId The ID of the channel the forum topic belongs to.
+     * @param forumTopicId The ID of the forum topic.
+     * @see https://www.guilded.gg/docs/api/forums/ForumTopicPin
+     * @see https://www.guilded.gg/docs/api/forums/ForumTopicUnpin
+     * @example Routes.forumTopicPin('abc', 123); // '/channels/abc/topics/123/pin'
+     */
+    static forumTopicPin(channelId, forumTopicId) {
+        return `/channels/${channelId}/topics/${forumTopicId}/pin`;
+    }
+    /**
      * The endpoint for list items on Guilded.
@@ -131,0 +142,0 @@ * @param channelId The ID of the channel the list items belongs to.

package.json

 {
   "name": "guilded-api-typings",
-  "version": "0.0.0-dev-20220901105754",
+  "version": "0.0.0-dev-20220904203556",
   "description": "Type definitions for the Guilded API.",
@@ -5,0 +5,0 @@ "repository": {

typings/REST.d.ts

@@ -104,3 +104,3 @@ /** Represents a error that occurred while interacting with the Guilded REST API. */
      * @param channelId The ID of the channel the forum topic belongs to.
-     * @param topicId The ID of the forum topic.
+     * @param forumTopicId The ID of the forum topic.
      * @see https://www.guilded.gg/docs/api/forums/ForumTopicRead
@@ -111,4 +111,13 @@ * @see https://www.guilded.gg/docs/api/forums/ForumTopicUpdate
      */
-    static forumTopic(channelId: string, topicId: number): `/channels/${string}/topics/${number}`;
+    static forumTopic(channelId: string, forumTopicId: number): `/channels/${string}/topics/${number}`;
     /**
+     * The endpoint for a forum topic pin.
+     * @param channelId The ID of the channel the forum topic belongs to.
+     * @param forumTopicId The ID of the forum topic.
+     * @see https://www.guilded.gg/docs/api/forums/ForumTopicPin
+     * @see https://www.guilded.gg/docs/api/forums/ForumTopicUnpin
+     * @example Routes.forumTopicPin('abc', 123); // '/channels/abc/topics/123/pin'
+     */
+    static forumTopicPin(channelId: string, forumTopicId: number): `/channels/${string}/topics/${number}/pin`;
+    /**
      * The endpoint for list items on Guilded.
@@ -115,0 +124,0 @@ * @param channelId The ID of the channel the list items belongs to.

typings/WS.d.ts

@@ -289,2 +289,22 @@ import { APIChannel } from './structures/Channel';
     /**
+     * Emitted when a forum topic is pinned.
+     * @see https://www.guilded.gg/docs/api/websockets/ForumTopicPinned
+     */
+    ForumTopicPinned: {
+        /** The ID of the server the forum topic belongs to. */
+        serverId: string;
+        /** The pinned forum topic. */
+        forumTopic: APIForumTopic;
+    };
+    /**
+     * Emitted when a forum topic is unpinned.
+     * @see https://www.guilded.gg/docs/api/websockets/ForumTopicUnpinned
+     */
+    ForumTopicUnpinned: {
+        /** The ID of the server the forum topic belongs to. */
+        serverId: string;
+        /** The unpinned forum topic. */
+        forumTopic: APIForumTopic;
+    };
+    /**
      * Emitted when a calendar event RSVP is edited.
@@ -291,0 +311,0 @@ * @see https://www.guilded.gg/docs/api/websockets/CalendarEventRsvpUpdated

No alert changes

Improved metrics

Total package byte prevSize

127119

increased by1.81%

Lines of code

1993

increased by2.05%

No dependency changes