@composio/client 0.1.0-alpha.10 → 0.1.0-alpha.11

package/resources/org/project/webhook.d.ts

@@ -3,89 +3,160 @@ import { APIPromise } from "../../../core/api-promise.js";
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Webhook extends APIResource {
     /**
-     * Get the webhook URL for a project
+     * Retrieves the webhook URL and secret for the current project. Webhooks come in
+     * two types: "trigger" webhooks are used for integration trigger events, while
+     * "event" webhooks receive system notifications about project events. The response
+     * includes both the URL and the secret key used to verify webhook signatures.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.org.project.webhook.retrieve({
+     *   type: 'trigger',
+     * });
+     * ```
      */
     retrieve(query: WebhookRetrieveParams, options?: RequestOptions): APIPromise<WebhookRetrieveResponse>;
+    /**
+     * Updates the webhook URL for the current project based on the specified type
+     * (trigger or event). Webhook URLs are endpoints that receive notifications about
+     * events in your project. "Trigger" webhooks receive integration trigger events,
+     * while "event" webhooks receive system notifications. This endpoint allows you to
+     * set or change these notification destinations.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.org.project.webhook.update({
+     *   type: 'trigger',
+     *   webhook_url: 'https://example.com/api/webhooks/triggers',
+     * });
+     * ```
+     */
     update(body: WebhookUpdateParams, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
     /**
-     * Remove a webhook URL (trigger or event) from the project configuration
+     * Removes a webhook URL (trigger or event) from the project configuration. This
+     * operation sets the specified webhook URL to null in the database but preserves
+     * the webhook secret. After deletion, the project will no longer receive webhook
+     * notifications of the specified type until a new URL is configured.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.org.project.webhook.delete({
+     *   type: 'trigger',
+     * });
+     * ```
      */
     delete(body: WebhookDeleteParams, options?: RequestOptions): APIPromise<WebhookDeleteResponse>;
+    /**
+     * Generates a new webhook secret for the project, invalidating the previous one.
+     * Webhook secrets are used to verify the authenticity of incoming webhook payloads
+     * through signature verification. This endpoint should be used when you need to
+     * rotate your webhook secret for security purposes. After refreshing, you must
+     * update your webhook verification logic to use the new secret.
+     *
+     * @example
+     * ```ts
+     * const response = await client.org.project.webhook.refresh();
+     * ```
+     */
     refresh(options?: RequestOptions): APIPromise<WebhookRefreshResponse>;
 }
+/**
+ * Response containing webhook URL configuration and secret
+ */
 export interface WebhookRetrieveResponse {
     /**
-     * Status of the webhook
+     * Indicates whether the webhook was found and retrieved successfully
      */
     status: 'success' | 'not found';
+    /**
+     * The webhook configuration containing either trigger or event webhook URL
+     */
     url: WebhookRetrieveResponse.UnionMember0 | WebhookRetrieveResponse.UnionMember1;
     /**
-     * Webhook secret
+     * The secret key that should be used to verify webhook signatures
      */
     webhook_secret: string;
 }
 export declare namespace WebhookRetrieveResponse {
     interface UnionMember0 {
+        /**
+         * Identifies this as a trigger webhook response
+         */
         type: 'trigger';
         /**
-         * Webhook URL
+         * The URL endpoint where trigger notifications will be delivered
          */
         webhook_url?: string;
     }
     interface UnionMember1 {
+        /**
+         * Identifies this as an event webhook response
+         */
         type: 'event';
         /**
-         * Event webhook URL
+         * The URL endpoint where event notifications will be delivered
          */
         event_webhook_url?: string;
     }
 }
+/**
+ * Response indicating the status of the webhook URL update operation
+ */
 export interface WebhookUpdateResponse {
     /**
-     * Status message
+     * Human-readable description of the update operation result
      */
     message: string;
     /**
-     * Whether the operation was successful
+     * Indicates if the webhook URL update was completed successfully
      */
     success: boolean;
 }
+/**
+ * Response indicating successful webhook URL deletion
+ */
 export interface WebhookDeleteResponse {
+    /**
+     * Indicates the webhook URL was successfully removed
+     */
     status: 'success';
 }
+/**
+ * Response containing the newly generated webhook secret
+ */
 export interface WebhookRefreshResponse {
     /**
-     * Status message
+     * Human-readable description of the refresh operation result
      */
     message: string;
     /**
-     * Whether the operation was successful
+     * Indicates if the webhook secret was successfully refreshed
      */
     success: boolean;
     /**
-     * Webhook secret
+     * The new secret key that should be used to verify incoming webhook payloads
      */
     webhook_secret: string;
 }
 export interface WebhookRetrieveParams {
     /**
-     * Type of the webhook
+     * Type of webhook to retrieve (trigger or event)
      */
     type: 'trigger' | 'event';
 }
 export interface WebhookUpdateParams {
     /**
-     * Type of the webhook
+     * Specifies which webhook type to update (trigger or event)
      */
     type: 'trigger' | 'event';
     /**
-     * Webhook URL
+     * Valid URL that will receive webhook payloads. Must include https:// protocol.
      */
     webhook_url: string;
 }
 export interface WebhookDeleteParams {
     /**
-     * Type of the webhook
+     * Specifies which webhook type to remove from the project configuration
      */
     type: 'trigger' | 'event';
 }

package/resources/org/project/webhook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIrG,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAEhC,GAAG,EAAE,uBAAuB,CAAC,YAAY,GAAG,uBAAuB,CAAC,YAAY,CAAC;IAEjF;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B,IAAI,EAAE,SAAS,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,YAAY;QAC3B,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIrG;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGtE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAEhC;;OAEG;IACH,GAAG,EAAE,uBAAuB,CAAC,YAAY,GAAG,uBAAuB,CAAC,YAAY,CAAC;IAEjF;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,SAAS,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/org/project/webhook.js

@@ -5,20 +5,67 @@ exports.Webhook = void 0;
 const resource_1 = require("../../../core/resource.js");
 class Webhook extends resource_1.APIResource {
     /**
-     * Get the webhook URL for a project
+     * Retrieves the webhook URL and secret for the current project. Webhooks come in
+     * two types: "trigger" webhooks are used for integration trigger events, while
+     * "event" webhooks receive system notifications about project events. The response
+     * includes both the URL and the secret key used to verify webhook signatures.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.org.project.webhook.retrieve({
+     *   type: 'trigger',
+     * });
+     * ```
      */
     retrieve(query, options) {
         return this._client.get('/api/v3/org/project/webhook', { query, ...options });
     }
+    /**
+     * Updates the webhook URL for the current project based on the specified type
+     * (trigger or event). Webhook URLs are endpoints that receive notifications about
+     * events in your project. "Trigger" webhooks receive integration trigger events,
+     * while "event" webhooks receive system notifications. This endpoint allows you to
+     * set or change these notification destinations.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.org.project.webhook.update({
+     *   type: 'trigger',
+     *   webhook_url: 'https://example.com/api/webhooks/triggers',
+     * });
+     * ```
+     */
     update(body, options) {
         return this._client.post('/api/v3/org/project/webhook/update', { body, ...options });
     }
     /**
-     * Remove a webhook URL (trigger or event) from the project configuration
+     * Removes a webhook URL (trigger or event) from the project configuration. This
+     * operation sets the specified webhook URL to null in the database but preserves
+     * the webhook secret. After deletion, the project will no longer receive webhook
+     * notifications of the specified type until a new URL is configured.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.org.project.webhook.delete({
+     *   type: 'trigger',
+     * });
+     * ```
      */
     delete(body, options) {
         return this._client.delete('/api/v3/org/project/webhook', { body, ...options });
     }
+    /**
+     * Generates a new webhook secret for the project, invalidating the previous one.
+     * Webhook secrets are used to verify the authenticity of incoming webhook payloads
+     * through signature verification. This endpoint should be used when you need to
+     * rotate your webhook secret for security purposes. After refreshing, you must
+     * update your webhook verification logic to use the new secret.
+     *
+     * @example
+     * ```ts
+     * const response = await client.org.project.webhook.refresh();
+     * ```
+     */
     refresh(options) {
         return this._client.post('/api/v3/org/project/webhook/refresh', options);
     }

package/resources/org/project/webhook.js.map

@@ -1 +1 @@
-{"version":3,"file":"webhook.js","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,KAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,OAAO,CAAC,OAAwB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;CACF;AAtBD,0BAsBC"}
+{"version":3,"file":"webhook.js","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,KAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAwB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;CACF;AArED,0BAqEC"}

package/resources/org/project/webhook.mjs

@@ -2,20 +2,67 @@
 import { APIResource } from "../../../core/resource.mjs";
 export class Webhook extends APIResource {
     /**
-     * Get the webhook URL for a project
+     * Retrieves the webhook URL and secret for the current project. Webhooks come in
+     * two types: "trigger" webhooks are used for integration trigger events, while
+     * "event" webhooks receive system notifications about project events. The response
+     * includes both the URL and the secret key used to verify webhook signatures.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.org.project.webhook.retrieve({
+     *   type: 'trigger',
+     * });
+     * ```
      */
     retrieve(query, options) {
         return this._client.get('/api/v3/org/project/webhook', { query, ...options });
     }
+    /**
+     * Updates the webhook URL for the current project based on the specified type
+     * (trigger or event). Webhook URLs are endpoints that receive notifications about
+     * events in your project. "Trigger" webhooks receive integration trigger events,
+     * while "event" webhooks receive system notifications. This endpoint allows you to
+     * set or change these notification destinations.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.org.project.webhook.update({
+     *   type: 'trigger',
+     *   webhook_url: 'https://example.com/api/webhooks/triggers',
+     * });
+     * ```
+     */
     update(body, options) {
         return this._client.post('/api/v3/org/project/webhook/update', { body, ...options });
     }
     /**
-     * Remove a webhook URL (trigger or event) from the project configuration
+     * Removes a webhook URL (trigger or event) from the project configuration. This
+     * operation sets the specified webhook URL to null in the database but preserves
+     * the webhook secret. After deletion, the project will no longer receive webhook
+     * notifications of the specified type until a new URL is configured.
+     *
+     * @example
+     * ```ts
+     * const webhook = await client.org.project.webhook.delete({
+     *   type: 'trigger',
+     * });
+     * ```
      */
     delete(body, options) {
         return this._client.delete('/api/v3/org/project/webhook', { body, ...options });
     }
+    /**
+     * Generates a new webhook secret for the project, invalidating the previous one.
+     * Webhook secrets are used to verify the authenticity of incoming webhook payloads
+     * through signature verification. This endpoint should be used when you need to
+     * rotate your webhook secret for security purposes. After refreshing, you must
+     * update your webhook verification logic to use the new secret.
+     *
+     * @example
+     * ```ts
+     * const response = await client.org.project.webhook.refresh();
+     * ```
+     */
     refresh(options) {
         return this._client.post('/api/v3/org/project/webhook/refresh', options);
     }

package/resources/org/project/webhook.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"webhook.mjs","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,QAAQ,CAAC,KAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,OAAO,CAAC,OAAwB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;CACF"}
+{"version":3,"file":"webhook.mjs","sourceRoot":"","sources":["../../../src/resources/org/project/webhook.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,KAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAwB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;CACF"}

package/resources/toolkits.d.mts

@@ -3,57 +3,153 @@ import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Toolkits extends APIResource {
     /**
-     * Retrieve detailed information about a specific toolkit using its slug identifier
+     * Retrieves comprehensive information about a specific toolkit using its unique
+     * slug identifier. This endpoint provides detailed metadata, authentication
+     * configuration options, and feature counts for the requested toolkit.
      */
     retrieve(slug: string, options?: RequestOptions): APIPromise<ToolkitRetrieveResponse>;
     /**
-     * Retrieve a list of available toolkits with optional filtering and sorting
-     * options
+     * Retrieves a comprehensive list of toolkits that are available to the
+     * authenticated project. Toolkits represent integration points with external
+     * services and applications, each containing a collection of tools and triggers.
+     * This endpoint supports filtering by category, management type, and local
+     * availability, as well as different sorting options.
      */
     list(query?: ToolkitListParams | null | undefined, options?: RequestOptions): APIPromise<ToolkitListResponse>;
     /**
-     * Retrieve a list of all available toolkit categories for filtering toolkits
+     * Retrieves a comprehensive list of all available toolkit categories. These
+     * categories can be used to filter toolkits by type or purpose when using the
+     * toolkit listing endpoint. Categories help organize toolkits into logical groups
+     * based on their functionality or industry focus.
      */
-    retrieveCategories(options?: RequestOptions): APIPromise<ToolkitRetrieveCategoriesResponse>;
+    retrieveCategories(query?: ToolkitRetrieveCategoriesParams | null | undefined, options?: RequestOptions): APIPromise<ToolkitRetrieveCategoriesResponse>;
 }
+/**
+ * Detailed information about a single toolkit
+ */
 export interface ToolkitRetrieveResponse {
+    /**
+     * Indicates if this toolkit is currently enabled and available for use
+     */
     enabled: boolean;
+    /**
+     * Indicates if this toolkit is specific to the current project or globally
+     * available
+     */
     is_local_toolkit: boolean;
+    /**
+     * Comprehensive metadata for the toolkit including dates, descriptions, and
+     * statistics
+     */
     meta: ToolkitRetrieveResponse.Meta;
+    /**
+     * Human-readable name of the toolkit
+     */
     name: string;
+    /**
+     * URL-friendly unique identifier for the toolkit
+     */
     slug: string;
+    /**
+     * Complete authentication configuration details for each supported auth method
+     */
     auth_config_details?: Array<ToolkitRetrieveResponse.AuthConfigDetail>;
+    /**
+     * List of authentication methods that Composio manages for this toolkit
+     */
     composio_managed_auth_schemes?: Array<string>;
 }
 export declare namespace ToolkitRetrieveResponse {
+    /**
+     * Comprehensive metadata for the toolkit including dates, descriptions, and
+     * statistics
+     */
     interface Meta {
+        /**
+         * List of categories associated with this toolkit
+         */
         categories: Array<Meta.Category>;
+        /**
+         * Creation date and time of the toolkit
+         */
         created_at: string;
+        /**
+         * Human-readable description explaining the toolkit's purpose and functionality
+         */
         description: string;
+        /**
+         * Image URL for the toolkit's branding
+         */
         logo: string;
+        /**
+         * Count of available tools in this toolkit
+         */
         tools_count: number;
+        /**
+         * Count of available triggers in this toolkit
+         */
         triggers_count: number;
+        /**
+         * Last modification date and time of the toolkit
+         */
         updated_at: string;
+        /**
+         * Link to the toolkit's main application or service website
+         */
         app_url?: string | null;
     }
     namespace Meta {
         interface Category {
+            /**
+             * Human-readable category name
+             */
             name: string;
+            /**
+             * URL-friendly identifier for the category
+             */
             slug: string;
         }
     }
+    /**
+     * Detailed configuration for an authentication method
+     */
     interface AuthConfigDetail {
+        /**
+         * Field groups required for different authentication stages
+         */
         fields: AuthConfigDetail.Fields;
+        /**
+         * The type of authentication mode (e.g., oauth2, basic_auth, api_key)
+         */
         mode: string;
+        /**
+         * Display name for this authentication method
+         */
         name: string;
+        /**
+         * Configuration for proxying authentication requests to external services
+         */
         proxy?: AuthConfigDetail.Proxy;
     }
     namespace AuthConfigDetail {
+        /**
+         * Field groups required for different authentication stages
+         */
         interface Fields {
+            /**
+             * Form fields needed when creating an authentication configuration
+             */
             auth_config_creation: Fields.AuthConfigCreation;
+            /**
+             * Form fields needed when connecting a user account with this authentication
+             * method
+             */
             connected_account_initiation: Fields.ConnectedAccountInitiation;
         }
         namespace Fields {
+            /**
+             * Form fields needed when creating an authentication configuration
+             */
             interface AuthConfigCreation {
                 optional: Array<AuthConfigCreation.Optional>;
                 required: Array<AuthConfigCreation.Required>;
@@ -76,6 +172,10 @@ export declare namespace ToolkitRetrieveResponse {
                     default?: string | null;
                 }
             }
+            /**
+             * Form fields needed when connecting a user account with this authentication
+             * method
+             */
             interface ConnectedAccountInitiation {
                 optional: Array<ConnectedAccountInitiation.Optional>;
                 required: Array<ConnectedAccountInitiation.Required>;
@@ -99,7 +199,13 @@ export declare namespace ToolkitRetrieveResponse {
                 }
             }
         }
+        /**
+         * Configuration for proxying authentication requests to external services
+         */
         interface Proxy {
+            /**
+             * URL to which authentication requests will be proxied
+             */
             base_url: string;
         }
     }
@@ -110,29 +216,87 @@ export interface ToolkitListResponse {
     total_pages: number;
 }
 export declare namespace ToolkitListResponse {
+    /**
+     * Detailed information about a toolkit
+     */
     interface Item {
+        /**
+         * Indicates if this toolkit is specific to the current project or globally
+         * available
+         */
         is_local_toolkit: boolean;
+        /**
+         * Additional metadata about the toolkit
+         */
         meta: Item.Meta;
+        /**
+         * Human-readable name of the toolkit
+         */
         name: string;
+        /**
+         * URL-friendly unique identifier for the toolkit
+         */
         slug: string;
+        /**
+         * List of authentication methods supported by this toolkit
+         */
         auth_schemes?: Array<string>;
+        /**
+         * List of authentication methods that Composio manages for this toolkit
+         */
         composio_managed_auth_schemes?: Array<string>;
+        /**
+         * When true, this toolkit can be used without authentication
+         */
         no_auth?: boolean;
     }
     namespace Item {
+        /**
+         * Additional metadata about the toolkit
+         */
         interface Meta {
+            /**
+             * List of categories associated with this toolkit
+             */
             categories: Array<Meta.Category>;
+            /**
+             * Creation date and time of the toolkit
+             */
             created_at: string;
+            /**
+             * Human-readable description explaining the toolkit's purpose and functionality
+             */
             description: string;
+            /**
+             * Image URL for the toolkit's branding
+             */
             logo: string;
+            /**
+             * Count of available tools in this toolkit
+             */
             tools_count: number;
+            /**
+             * Count of available triggers in this toolkit
+             */
             triggers_count: number;
+            /**
+             * Last modification date and time of the toolkit
+             */
             updated_at: string;
+            /**
+             * Link to the toolkit's main application or service website
+             */
             app_url?: string | null;
         }
         namespace Meta {
             interface Category {
+                /**
+                 * Category identifier
+                 */
                 id: string;
+                /**
+                 * Human-readable category name
+                 */
                 name: string;
             }
         }
@@ -144,21 +308,45 @@ export interface ToolkitRetrieveCategoriesResponse {
     total_pages: number;
 }
 export declare namespace ToolkitRetrieveCategoriesResponse {
+    /**
+     * Information about a single toolkit category
+     */
     interface Item {
+        /**
+         * URL-friendly unique identifier for the category, used for filtering toolkits
+         */
         id: string;
+        /**
+         * Display name of the toolkit category
+         */
         name: string;
     }
 }
 export interface ToolkitListParams {
+    /**
+     * Filter toolkits by category
+     */
     category?: string;
     /**
-     * Whether to include local toolkits
+     * Whether to include local toolkits in the results
      */
     is_local?: boolean | null;
+    /**
+     * Filter toolkits by who manages them
+     */
     managed_by?: 'composio' | 'all' | 'project';
+    /**
+     * Sort order for returned toolkits
+     */
     sort_by?: 'usage' | 'alphabetically';
 }
+export interface ToolkitRetrieveCategoriesParams {
+    /**
+     * Cache control parameter
+     */
+    cache?: string;
+}
 export declare namespace Toolkits {
-    export { type ToolkitRetrieveResponse as ToolkitRetrieveResponse, type ToolkitListResponse as ToolkitListResponse, type ToolkitRetrieveCategoriesResponse as ToolkitRetrieveCategoriesResponse, type ToolkitListParams as ToolkitListParams, };
+    export { type ToolkitRetrieveResponse as ToolkitRetrieveResponse, type ToolkitListResponse as ToolkitListResponse, type ToolkitRetrieveCategoriesResponse as ToolkitRetrieveCategoriesResponse, type ToolkitListParams as ToolkitListParams, type ToolkitRetrieveCategoriesParams as ToolkitRetrieveCategoriesParams, };
 }
 //# sourceMappingURL=toolkits.d.mts.map