@appwrite.io/console 9.0.0 → 10.0.0

package/types/services/webhooks.d.ts

@@ -36,6 +36,7 @@ export declare class Webhooks {
      * @param {boolean} params.tls - Certificate verification, false for disabled or true for enabled.
      * @param {string} params.authUsername - Webhook HTTP user. Max length: 256 chars.
      * @param {string} params.authPassword - Webhook HTTP password. Max length: 256 chars.
+     * @param {string} params.secret - Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Webhook>}
      */
@@ -48,6 +49,7 @@ export declare class Webhooks {
         tls?: boolean;
         authUsername?: string;
         authPassword?: string;
+        secret?: string;
     }): Promise<Models.Webhook>;
     /**
      * Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
@@ -60,11 +62,12 @@ export declare class Webhooks {
      * @param {boolean} tls - Certificate verification, false for disabled or true for enabled.
      * @param {string} authUsername - Webhook HTTP user. Max length: 256 chars.
      * @param {string} authPassword - Webhook HTTP password. Max length: 256 chars.
+     * @param {string} secret - Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Webhook>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create(webhookId: string, url: string, name: string, events: string[], enabled?: boolean, tls?: boolean, authUsername?: string, authPassword?: string): Promise<Models.Webhook>;
+    create(webhookId: string, url: string, name: string, events: string[], enabled?: boolean, tls?: boolean, authUsername?: string, authPassword?: string, secret?: string): Promise<Models.Webhook>;
     /**
      * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
      *
@@ -147,19 +150,22 @@ export declare class Webhooks {
      * Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.
      *
      * @param {string} params.webhookId - Webhook ID.
+     * @param {string} params.secret - Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Webhook>}
      */
     updateSecret(params: {
         webhookId: string;
+        secret?: string;
     }): Promise<Models.Webhook>;
     /**
      * Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.
      *
      * @param {string} webhookId - Webhook ID.
+     * @param {string} secret - Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Webhook>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateSecret(webhookId: string): Promise<Models.Webhook>;
+    updateSecret(webhookId: string, secret?: string): Promise<Models.Webhook>;
 }