guilded-api-typings - npm Package Compare versions

Comparing version 0.0.0-dev-20220928193632 to 0.0.0-dev-20220928210644

CHANGELOG.md

 # guilded-api-typings
 
-## 0.0.0-dev-20220928193632
+## 0.0.0-dev-20220928210644
 
@@ -8,2 +8,3 @@ ### Patch Changes
 -   34c82fd: feat: generic typings
+-   0423e02: feat: forum topic lock and unlock
 
@@ -10,0 +11,0 @@ ## 0.12.0

dist/REST.js

@@ -139,2 +139,13 @@ "use strict";
     /**
+     * The endpoint for a forum topic lock.
+     * @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/ForumTopicLock
+     * @see https://www.guilded.gg/docs/api/forums/ForumTopicUnlock
+     * @example Routes.forumTopicLock('abc', 123); // '/channels/abc/topics/123/lock'
+     */
+    static forumTopicLock(channelId, forumTopicId) {
+        return `/channels/${channelId}/topics/${forumTopicId}/lock`;
+    }
+    /**
      * The endpoint for list items on Guilded.
@@ -141,0 +152,0 @@ * @param channelId The ID of the channel the list items belongs to.

package.json

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

typings/REST.d.ts

@@ -121,2 +121,11 @@ /** Represents a error that occurred while interacting with the Guilded REST API. */
     /**
+     * The endpoint for a forum topic lock.
+     * @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/ForumTopicLock
+     * @see https://www.guilded.gg/docs/api/forums/ForumTopicUnlock
+     * @example Routes.forumTopicLock('abc', 123); // '/channels/abc/topics/123/lock'
+     */
+    static forumTopicLock<C extends string, F extends number>(channelId: C, forumTopicId: F): `/channels/${C}/topics/${F}/lock`;
+    /**
      * The endpoint for list items on Guilded.
@@ -123,0 +132,0 @@ * @param channelId The ID of the channel the list items belongs to.

typings/WS.d.ts

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

No alert changes

Improved metrics

Total package byte prevSize

131931

1.73%

Lines of code

2063

1.98%

No dependency changes