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

package/resources/org/project/api-keys.d.mts

@@ -2,104 +2,196 @@ import { APIResource } from "../../../core/resource.mjs";
 import { APIPromise } from "../../../core/api-promise.mjs";
 import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare class APIKeys extends APIResource {
+    /**
+     * Creates a new API key for the specified project. API keys are used for
+     * authenticating requests to the API. This endpoint generates a new key with the
+     * provided name and returns the complete key details including the actual key
+     * value. Note that the full API key value is only returned once at creation time
+     * and cannot be retrieved later, so it should be securely stored immediately.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.project.apiKeys.create(
+     *   'proj_abc123xyz456',
+     *   { name: 'Production API Key' },
+     * );
+     * ```
+     */
     create(projectID: string, body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKeyCreateResponse>;
+    /**
+     * Retrieves all API keys associated with the specified project. This endpoint
+     * returns details about each API key including its name, creation date, and last
+     * used information. Use this endpoint to audit which keys exist for a project or
+     * to manage key rotation policies.
+     *
+     * @example
+     * ```ts
+     * const apiKeys = await client.org.project.apiKeys.list(
+     *   'proj_abc123xyz456',
+     * );
+     * ```
+     */
     list(projectID: string, options?: RequestOptions): APIPromise<APIKeyListResponse>;
+    /**
+     * Permanently deletes an API key from the specified project. Once deleted, the API
+     * key can no longer be used for authentication and any services using it will need
+     * to be updated with a new key. This operation cannot be undone, so it should be
+     * used with caution.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.project.apiKeys.delete(
+     *   '01H4DKRF5SMP7NQCA3BWT0JYB6',
+     *   { projectId: 'proj_abc123xyz456' },
+     * );
+     * ```
+     */
     delete(id: string, params: APIKeyDeleteParams, options?: RequestOptions): APIPromise<APIKeyDeleteResponse>;
+    /**
+     * Retrieves an existing API key for the project or creates a new one if none
+     * exists. This endpoint is useful for ensuring a project always has at least one
+     * API key without the risk of creating duplicates. If an API key already exists,
+     * it returns the existing key. If no API keys exist for the project, it creates a
+     * new one with an automatically generated name.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.org.project.apiKeys.createAPIKey(
+     *     'proj_abc123xyz456',
+     *   );
+     * ```
+     */
     createAPIKey(projectID: string, options?: RequestOptions): APIPromise<APIKeyCreateAPIKeyResponse>;
 }
+/**
+ * API key object containing the key details
+ */
 export interface APIKeyCreateResponse {
     /**
-     * API key ID
+     * Database record identifier for the API key
      */
     id: string;
     /**
-     * Creation timestamp
+     * UTC timestamp indicating when the API key was created
+     */
+    created_at: string;
+    /**
+     * @deprecated UTC timestamp indicating when the API key was created. DEPRECATED:
+     * Use created_at instead.
      */
     createdAt: string;
     /**
-     * API key value
+     * The API key string value that should be included in API requests. This value is
+     * only shown once at creation time.
      */
     key: string;
     /**
-     * API key name
+     * Descriptive name assigned to help identify the key's purpose
      */
     name: string;
     /**
-     * Last used timestamp
+     * UTC timestamp indicating when the API key was last used for authentication. Will
+     * be null for newly created keys.
      */
-    lastUsed?: string;
+    last_used_at?: string;
 }
+/**
+ * Response containing the list of API keys for a project
+ */
 export interface APIKeyListResponse {
     /**
-     * List of API keys
+     * List of all API keys for the specified project, including their properties and
+     * usage information
      */
     items: Array<APIKeyListResponse.Item>;
 }
 export declare namespace APIKeyListResponse {
     interface Item {
         /**
-         * API key ID
+         * Unique identifier for the API key record
          */
         id: string;
         /**
-         * Creation timestamp
+         * UTC timestamp indicating when the API key was created
          */
         created_at: string;
         /**
-         * API key value
+         * The API key string that should be included in API requests for authentication
          */
         key: string;
         /**
-         * API key name
+         * Descriptive name assigned to the API key for identification purposes
          */
         name: string;
         /**
-         * Last used timestamp
+         * UTC timestamp indicating when the API key was last used for authentication. Will
+         * be null if the key has never been used.
          */
         last_used?: string;
     }
 }
+/**
+ * Response indicating the status of the API key deletion operation
+ */
 export interface APIKeyDeleteResponse {
     /**
-     * Status message
+     * Status message providing details about the deletion operation
      */
     message: string;
     /**
-     * Whether the operation was successful
+     * Boolean flag indicating if the deletion operation was successful
      */
     success: boolean;
 }
+/**
+ * API key object containing the key details
+ */
 export interface APIKeyCreateAPIKeyResponse {
     /**
-     * API key ID
+     * Database record identifier for the API key
      */
     id: string;
     /**
-     * Creation timestamp
+     * UTC timestamp indicating when the API key was created
+     */
+    created_at: string;
+    /**
+     * @deprecated UTC timestamp indicating when the API key was created. Use
+     * created_at instead.
      */
     createdAt: string;
     /**
-     * API key value
+     * The API key string value that should be included in API requests. This value is
+     * only shown once.
      */
     key: string;
     /**
-     * API key name
+     * @deprecated UTC timestamp indicating when the API key was created. Use
+     * last_used_at instead.
+     */
+    lastUsedAt: string;
+    /**
+     * Name assigned to help identify the key's purpose. For auto-generated keys, this
+     * will be a random name.
      */
     name: string;
     /**
-     * Last used timestamp
+     * UTC timestamp indicating when the API key was last used for authentication. Will
+     * be null for newly created keys.
      */
-    lastUsed?: string;
+    last_used_at?: string;
 }
 export interface APIKeyCreateParams {
     /**
-     * API key name
+     * A user-friendly name to identify the API key's purpose (e.g., "Production
+     * Server", "Test Environment")
      */
     name: string;
 }
 export interface APIKeyDeleteParams {
     /**
-     * Project ID
+     * The project Nano ID that owns the API key to be deleted
      */
     projectId: string;
 }

package/resources/org/project/api-keys.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"api-keys.d.mts","sourceRoot":"","sources":["../../../src/resources/org/project/api-keys.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIjF,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAK1G,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGlG;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
+{"version":3,"file":"api-keys.d.mts","sourceRoot":"","sources":["../../../src/resources/org/project/api-keys.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIjF;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAK1G;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGlG;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/org/project/api-keys.d.ts

@@ -2,104 +2,196 @@ import { APIResource } from "../../../core/resource.js";
 import { APIPromise } from "../../../core/api-promise.js";
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare class APIKeys extends APIResource {
+    /**
+     * Creates a new API key for the specified project. API keys are used for
+     * authenticating requests to the API. This endpoint generates a new key with the
+     * provided name and returns the complete key details including the actual key
+     * value. Note that the full API key value is only returned once at creation time
+     * and cannot be retrieved later, so it should be securely stored immediately.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.project.apiKeys.create(
+     *   'proj_abc123xyz456',
+     *   { name: 'Production API Key' },
+     * );
+     * ```
+     */
     create(projectID: string, body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKeyCreateResponse>;
+    /**
+     * Retrieves all API keys associated with the specified project. This endpoint
+     * returns details about each API key including its name, creation date, and last
+     * used information. Use this endpoint to audit which keys exist for a project or
+     * to manage key rotation policies.
+     *
+     * @example
+     * ```ts
+     * const apiKeys = await client.org.project.apiKeys.list(
+     *   'proj_abc123xyz456',
+     * );
+     * ```
+     */
     list(projectID: string, options?: RequestOptions): APIPromise<APIKeyListResponse>;
+    /**
+     * Permanently deletes an API key from the specified project. Once deleted, the API
+     * key can no longer be used for authentication and any services using it will need
+     * to be updated with a new key. This operation cannot be undone, so it should be
+     * used with caution.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.project.apiKeys.delete(
+     *   '01H4DKRF5SMP7NQCA3BWT0JYB6',
+     *   { projectId: 'proj_abc123xyz456' },
+     * );
+     * ```
+     */
     delete(id: string, params: APIKeyDeleteParams, options?: RequestOptions): APIPromise<APIKeyDeleteResponse>;
+    /**
+     * Retrieves an existing API key for the project or creates a new one if none
+     * exists. This endpoint is useful for ensuring a project always has at least one
+     * API key without the risk of creating duplicates. If an API key already exists,
+     * it returns the existing key. If no API keys exist for the project, it creates a
+     * new one with an automatically generated name.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.org.project.apiKeys.createAPIKey(
+     *     'proj_abc123xyz456',
+     *   );
+     * ```
+     */
     createAPIKey(projectID: string, options?: RequestOptions): APIPromise<APIKeyCreateAPIKeyResponse>;
 }
+/**
+ * API key object containing the key details
+ */
 export interface APIKeyCreateResponse {
     /**
-     * API key ID
+     * Database record identifier for the API key
      */
     id: string;
     /**
-     * Creation timestamp
+     * UTC timestamp indicating when the API key was created
+     */
+    created_at: string;
+    /**
+     * @deprecated UTC timestamp indicating when the API key was created. DEPRECATED:
+     * Use created_at instead.
      */
     createdAt: string;
     /**
-     * API key value
+     * The API key string value that should be included in API requests. This value is
+     * only shown once at creation time.
      */
     key: string;
     /**
-     * API key name
+     * Descriptive name assigned to help identify the key's purpose
      */
     name: string;
     /**
-     * Last used timestamp
+     * UTC timestamp indicating when the API key was last used for authentication. Will
+     * be null for newly created keys.
      */
-    lastUsed?: string;
+    last_used_at?: string;
 }
+/**
+ * Response containing the list of API keys for a project
+ */
 export interface APIKeyListResponse {
     /**
-     * List of API keys
+     * List of all API keys for the specified project, including their properties and
+     * usage information
      */
     items: Array<APIKeyListResponse.Item>;
 }
 export declare namespace APIKeyListResponse {
     interface Item {
         /**
-         * API key ID
+         * Unique identifier for the API key record
          */
         id: string;
         /**
-         * Creation timestamp
+         * UTC timestamp indicating when the API key was created
          */
         created_at: string;
         /**
-         * API key value
+         * The API key string that should be included in API requests for authentication
          */
         key: string;
         /**
-         * API key name
+         * Descriptive name assigned to the API key for identification purposes
          */
         name: string;
         /**
-         * Last used timestamp
+         * UTC timestamp indicating when the API key was last used for authentication. Will
+         * be null if the key has never been used.
          */
         last_used?: string;
     }
 }
+/**
+ * Response indicating the status of the API key deletion operation
+ */
 export interface APIKeyDeleteResponse {
     /**
-     * Status message
+     * Status message providing details about the deletion operation
      */
     message: string;
     /**
-     * Whether the operation was successful
+     * Boolean flag indicating if the deletion operation was successful
      */
     success: boolean;
 }
+/**
+ * API key object containing the key details
+ */
 export interface APIKeyCreateAPIKeyResponse {
     /**
-     * API key ID
+     * Database record identifier for the API key
      */
     id: string;
     /**
-     * Creation timestamp
+     * UTC timestamp indicating when the API key was created
+     */
+    created_at: string;
+    /**
+     * @deprecated UTC timestamp indicating when the API key was created. Use
+     * created_at instead.
      */
     createdAt: string;
     /**
-     * API key value
+     * The API key string value that should be included in API requests. This value is
+     * only shown once.
      */
     key: string;
     /**
-     * API key name
+     * @deprecated UTC timestamp indicating when the API key was created. Use
+     * last_used_at instead.
+     */
+    lastUsedAt: string;
+    /**
+     * Name assigned to help identify the key's purpose. For auto-generated keys, this
+     * will be a random name.
      */
     name: string;
     /**
-     * Last used timestamp
+     * UTC timestamp indicating when the API key was last used for authentication. Will
+     * be null for newly created keys.
      */
-    lastUsed?: string;
+    last_used_at?: string;
 }
 export interface APIKeyCreateParams {
     /**
-     * API key name
+     * A user-friendly name to identify the API key's purpose (e.g., "Production
+     * Server", "Test Environment")
      */
     name: string;
 }
 export interface APIKeyDeleteParams {
     /**
-     * Project ID
+     * The project Nano ID that owns the API key to be deleted
      */
     projectId: string;
 }

package/resources/org/project/api-keys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/api-keys.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIjF,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAK1G,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGlG;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
+{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../../../src/resources/org/project/api-keys.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIjF;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAK1G;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGlG;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;CACvC;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/org/project/api-keys.js

@@ -5,16 +5,73 @@ exports.APIKeys = void 0;
 const resource_1 = require("../../../core/resource.js");
 const path_1 = require("../../../internal/utils/path.js");
 class APIKeys extends resource_1.APIResource {
+    /**
+     * Creates a new API key for the specified project. API keys are used for
+     * authenticating requests to the API. This endpoint generates a new key with the
+     * provided name and returns the complete key details including the actual key
+     * value. Note that the full API key value is only returned once at creation time
+     * and cannot be retrieved later, so it should be securely stored immediately.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.project.apiKeys.create(
+     *   'proj_abc123xyz456',
+     *   { name: 'Production API Key' },
+     * );
+     * ```
+     */
     create(projectID, body, options) {
         return this._client.post((0, path_1.path) `/api/v3/org/project/${projectID}/api_keys/create`, { body, ...options });
     }
+    /**
+     * Retrieves all API keys associated with the specified project. This endpoint
+     * returns details about each API key including its name, creation date, and last
+     * used information. Use this endpoint to audit which keys exist for a project or
+     * to manage key rotation policies.
+     *
+     * @example
+     * ```ts
+     * const apiKeys = await client.org.project.apiKeys.list(
+     *   'proj_abc123xyz456',
+     * );
+     * ```
+     */
     list(projectID, options) {
         return this._client.get((0, path_1.path) `/api/v3/org/project/${projectID}/api_keys/list`, options);
     }
+    /**
+     * Permanently deletes an API key from the specified project. Once deleted, the API
+     * key can no longer be used for authentication and any services using it will need
+     * to be updated with a new key. This operation cannot be undone, so it should be
+     * used with caution.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.project.apiKeys.delete(
+     *   '01H4DKRF5SMP7NQCA3BWT0JYB6',
+     *   { projectId: 'proj_abc123xyz456' },
+     * );
+     * ```
+     */
     delete(id, params, options) {
         const { projectId } = params;
         return this._client.delete((0, path_1.path) `/api/v3/org/project/${projectId}/api_keys/remove/${id}`, options);
     }
+    /**
+     * Retrieves an existing API key for the project or creates a new one if none
+     * exists. This endpoint is useful for ensuring a project always has at least one
+     * API key without the risk of creating duplicates. If an API key already exists,
+     * it returns the existing key. If no API keys exist for the project, it creates a
+     * new one with an automatically generated name.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.org.project.apiKeys.createAPIKey(
+     *     'proj_abc123xyz456',
+     *   );
+     * ```
+     */
     createAPIKey(projectID, options) {
         return this._client.post((0, path_1.path) `/api/v3/org/project/${projectID}/api_keys/create-api-key`, options);
     }

package/resources/org/project/api-keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-keys.js","sourceRoot":"","sources":["../../../src/resources/org/project/api-keys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD,MAAa,OAAQ,SAAQ,sBAAW;IACtC,MAAM,CACJ,SAAiB,EACjB,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED,IAAI,CAAC,SAAiB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAAwB;QACrE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAED,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,0BAA0B,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;CACF;AArBD,0BAqBC"}
+{"version":3,"file":"api-keys.js","sourceRoot":"","sources":["../../../src/resources/org/project/api-keys.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,SAAiB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAAwB;QACrE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,uBAAuB,SAAS,0BAA0B,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;CACF;AA9ED,0BA8EC"}

package/resources/org/project/api-keys.mjs

@@ -2,16 +2,73 @@
 import { APIResource } from "../../../core/resource.mjs";
 import { path } from "../../../internal/utils/path.mjs";
 export class APIKeys extends APIResource {
+    /**
+     * Creates a new API key for the specified project. API keys are used for
+     * authenticating requests to the API. This endpoint generates a new key with the
+     * provided name and returns the complete key details including the actual key
+     * value. Note that the full API key value is only returned once at creation time
+     * and cannot be retrieved later, so it should be securely stored immediately.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.project.apiKeys.create(
+     *   'proj_abc123xyz456',
+     *   { name: 'Production API Key' },
+     * );
+     * ```
+     */
     create(projectID, body, options) {
         return this._client.post(path `/api/v3/org/project/${projectID}/api_keys/create`, { body, ...options });
     }
+    /**
+     * Retrieves all API keys associated with the specified project. This endpoint
+     * returns details about each API key including its name, creation date, and last
+     * used information. Use this endpoint to audit which keys exist for a project or
+     * to manage key rotation policies.
+     *
+     * @example
+     * ```ts
+     * const apiKeys = await client.org.project.apiKeys.list(
+     *   'proj_abc123xyz456',
+     * );
+     * ```
+     */
     list(projectID, options) {
         return this._client.get(path `/api/v3/org/project/${projectID}/api_keys/list`, options);
     }
+    /**
+     * Permanently deletes an API key from the specified project. Once deleted, the API
+     * key can no longer be used for authentication and any services using it will need
+     * to be updated with a new key. This operation cannot be undone, so it should be
+     * used with caution.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.project.apiKeys.delete(
+     *   '01H4DKRF5SMP7NQCA3BWT0JYB6',
+     *   { projectId: 'proj_abc123xyz456' },
+     * );
+     * ```
+     */
     delete(id, params, options) {
         const { projectId } = params;
         return this._client.delete(path `/api/v3/org/project/${projectId}/api_keys/remove/${id}`, options);
     }
+    /**
+     * Retrieves an existing API key for the project or creates a new one if none
+     * exists. This endpoint is useful for ensuring a project always has at least one
+     * API key without the risk of creating duplicates. If an API key already exists,
+     * it returns the existing key. If no API keys exist for the project, it creates a
+     * new one with an automatically generated name.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.org.project.apiKeys.createAPIKey(
+     *     'proj_abc123xyz456',
+     *   );
+     * ```
+     */
     createAPIKey(projectID, options) {
         return this._client.post(path `/api/v3/org/project/${projectID}/api_keys/create-api-key`, options);
     }

package/resources/org/project/api-keys.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"api-keys.mjs","sourceRoot":"","sources":["../../../src/resources/org/project/api-keys.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC,MAAM,CACJ,SAAiB,EACjB,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,uBAAuB,SAAS,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED,IAAI,CAAC,SAAiB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,SAAS,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAAwB;QACrE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,uBAAuB,SAAS,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAED,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,uBAAuB,SAAS,0BAA0B,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;CACF"}
+{"version":3,"file":"api-keys.mjs","sourceRoot":"","sources":["../../../src/resources/org/project/api-keys.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,uBAAuB,SAAS,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,SAAiB,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,SAAS,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,MAA0B,EAAE,OAAwB;QACrE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,uBAAuB,SAAS,oBAAoB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,uBAAuB,SAAS,0BAA0B,EAAE,OAAO,CAAC,CAAC;IACpG,CAAC;CACF"}