guilded-api-typings - npm Package Compare versions

Comparing version 0.0.0-dev-20220904203556 to 0.0.0-dev-20220919203430

CHANGELOG.md

 # guilded-api-typings
 
-## 0.0.0-dev-20220904203556
+## 0.0.0-dev-20220919203430
 
 ### Minor Changes
 
+-   88420fe: feat: webhook `username` and `avatar_url` support
+
+## 0.11.0
+
+### Minor Changes
+
 -   2d36b59: feat: forum topic pinning
@@ -8,0 +14,0 @@

dist/REST.js

@@ -333,4 +333,13 @@ "use strict";
     }
+    /**
+     * The endpoint for a webhook execution on Guilded.
+     * @param webhookId The ID of the webhook.
+     * @param webhookToken The ID of the webhook.
+     * @example Routes.webhookExecute('abc', 'abc'); // '/webhooks/abc/abc'
+     */
+    static webhookExecute(webhookId, webhookToken) {
+        return `/webhooks/${webhookId}/${webhookToken}`;
+    }
 }
 exports.Routes = Routes;
 //# sourceMappingURL=REST.js.map

package.json

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

typings/REST.d.ts

@@ -279,3 +279,10 @@ /** Represents a error that occurred while interacting with the Guilded REST API. */
     static webhook(serverId: string, webhookId: string): `/servers/${string}/webhooks/${string}`;
+    /**
+     * The endpoint for a webhook execution on Guilded.
+     * @param webhookId The ID of the webhook.
+     * @param webhookToken The ID of the webhook.
+     * @example Routes.webhookExecute('abc', 'abc'); // '/webhooks/abc/abc'
+     */
+    static webhookExecute(webhookId: string, webhookToken: string): `/webhooks/${string}/${string}`;
 }
 //# sourceMappingURL=REST.d.ts.map

typings/structures/Webhook.d.ts

@@ -0,1 +1,3 @@
+import { APIEmbed } from './Embed';
+import { APIMessageEditPayload } from './Message';
 /**
@@ -32,2 +34,14 @@ * Represents a webhook on Guilded.
 /**
+ * The payload for creating a webhook message.
+ * @see https://guildedapi.com/resources/webhook/#execute-webhook
+ */
+export interface APIWebhookMessagePayload extends APIMessageEditPayload {
+    /** The name of the webhook. */
+    username?: string;
+    /** The avatar URL of the webhook. */
+    avatar_url?: string;
+}
+/** The resolvable payload for creating a webhook message. */
+export declare type APIWebhookMessagePayloadResolvable = string | APIEmbed[] | APIWebhookMessagePayload;
+/**
  * The payload for editing a webhook.
@@ -34,0 +48,0 @@ * @see https://www.guilded.gg/docs/api/webhook/WebhookUpdate

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

129013

increased by1.49%

Lines of code

2023

increased by1.51%

No dependency changes