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

package/resources/migration.d.mts

@@ -0,0 +1,32 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Migration extends APIResource {
+    /**
+     * Convert a legacy UUID to its corresponding NanoId for migration purposes. This
+     * endpoint facilitates the transition from UUID-based identifiers to the more
+     * compact NanoId format used in the v3 API.
+     */
+    retrieveNanoid(query: MigrationRetrieveNanoidParams, options?: RequestOptions): APIPromise<MigrationRetrieveNanoidResponse>;
+}
+export interface MigrationRetrieveNanoidResponse {
+    /**
+     * The NanoId corresponding to the provided UUID. This is the new identifier that
+     * should be used in place of the legacy UUID.
+     */
+    nanoid: string;
+}
+export interface MigrationRetrieveNanoidParams {
+    /**
+     * The type of resource that the UUID belongs to
+     */
+    type: 'CONNECTED_ACCOUNT' | 'AUTH_CONFIG' | 'TRIGGER_INSTANCE';
+    /**
+     * The legacy UUID that needs to be converted to a NanoId
+     */
+    uuid: string;
+}
+export declare namespace Migration {
+    export { type MigrationRetrieveNanoidResponse as MigrationRetrieveNanoidResponse, type MigrationRetrieveNanoidParams as MigrationRetrieveNanoidParams, };
+}
+//# sourceMappingURL=migration.d.mts.map

package/resources/migration.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.d.mts","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,cAAc,CACZ,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAG/C;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,mBAAmB,GAAG,aAAa,GAAG,kBAAkB,CAAC;IAE/D;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/migration.d.ts

@@ -0,0 +1,32 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Migration extends APIResource {
+    /**
+     * Convert a legacy UUID to its corresponding NanoId for migration purposes. This
+     * endpoint facilitates the transition from UUID-based identifiers to the more
+     * compact NanoId format used in the v3 API.
+     */
+    retrieveNanoid(query: MigrationRetrieveNanoidParams, options?: RequestOptions): APIPromise<MigrationRetrieveNanoidResponse>;
+}
+export interface MigrationRetrieveNanoidResponse {
+    /**
+     * The NanoId corresponding to the provided UUID. This is the new identifier that
+     * should be used in place of the legacy UUID.
+     */
+    nanoid: string;
+}
+export interface MigrationRetrieveNanoidParams {
+    /**
+     * The type of resource that the UUID belongs to
+     */
+    type: 'CONNECTED_ACCOUNT' | 'AUTH_CONFIG' | 'TRIGGER_INSTANCE';
+    /**
+     * The legacy UUID that needs to be converted to a NanoId
+     */
+    uuid: string;
+}
+export declare namespace Migration {
+    export { type MigrationRetrieveNanoidResponse as MigrationRetrieveNanoidResponse, type MigrationRetrieveNanoidParams as MigrationRetrieveNanoidParams, };
+}
+//# sourceMappingURL=migration.d.ts.map

package/resources/migration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,cAAc,CACZ,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAG/C;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,mBAAmB,GAAG,aAAa,GAAG,kBAAkB,CAAC;IAE/D;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/migration.js

@@ -0,0 +1,17 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Migration = void 0;
+const resource_1 = require("../core/resource.js");
+class Migration extends resource_1.APIResource {
+    /**
+     * Convert a legacy UUID to its corresponding NanoId for migration purposes. This
+     * endpoint facilitates the transition from UUID-based identifiers to the more
+     * compact NanoId format used in the v3 API.
+     */
+    retrieveNanoid(query, options) {
+        return this._client.get('/api/v3/migration/get-nanoid', { query, ...options });
+    }
+}
+exports.Migration = Migration;
+//# sourceMappingURL=migration.js.map

package/resources/migration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.js","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;OAIG;IACH,cAAc,CACZ,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAZD,8BAYC"}

package/resources/migration.mjs

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export class Migration extends APIResource {
+    /**
+     * Convert a legacy UUID to its corresponding NanoId for migration purposes. This
+     * endpoint facilitates the transition from UUID-based identifiers to the more
+     * compact NanoId format used in the v3 API.
+     */
+    retrieveNanoid(query, options) {
+        return this._client.get('/api/v3/migration/get-nanoid', { query, ...options });
+    }
+}
+//# sourceMappingURL=migration.mjs.map

package/resources/migration.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"migration.mjs","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,cAAc,CACZ,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF"}

package/resources/org/api-key.d.mts

@@ -2,13 +2,41 @@ import { APIResource } from "../../core/resource.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class APIKey extends APIResource {
+    /**
+     * Retrieve the API key for the current organization. This endpoint is restricted
+     * to organization administrators only. The returned API key can be used for
+     * authenticating organization-level API requests.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.apiKey.retrieve();
+     * ```
+     */
     retrieve(options?: RequestOptions): APIPromise<APIKeyRetrieveResponse>;
+    /**
+     * Generate a new API key for the organization, invalidating the previous one
+     * (admin only). This operation cannot be undone and will immediately invalidate
+     * the previous API key.
+     *
+     * @example
+     * ```ts
+     * const response = await client.org.apiKey.regenerate();
+     * ```
+     */
     regenerate(options?: RequestOptions): APIPromise<APIKeyRegenerateResponse>;
 }
 export interface APIKeyRetrieveResponse {
+    /**
+     * The API key for the organization that can be used for authentication. Format:
+     * org_xxx
+     */
     org_api_key: string;
 }
 export interface APIKeyRegenerateResponse {
+    /**
+     * The newly generated API key for the organization that can be used for
+     * authentication. Format: org_xxx
+     */
     org_api_key: string;
 }
 export declare namespace APIKey {

package/resources/org/api-key.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"api-key.d.mts","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItE,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3E;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"api-key.d.mts","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItE;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3E;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/org/api-key.d.ts

@@ -2,13 +2,41 @@ import { APIResource } from "../../core/resource.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
 export declare class APIKey extends APIResource {
+    /**
+     * Retrieve the API key for the current organization. This endpoint is restricted
+     * to organization administrators only. The returned API key can be used for
+     * authenticating organization-level API requests.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.apiKey.retrieve();
+     * ```
+     */
     retrieve(options?: RequestOptions): APIPromise<APIKeyRetrieveResponse>;
+    /**
+     * Generate a new API key for the organization, invalidating the previous one
+     * (admin only). This operation cannot be undone and will immediately invalidate
+     * the previous API key.
+     *
+     * @example
+     * ```ts
+     * const response = await client.org.apiKey.regenerate();
+     * ```
+     */
     regenerate(options?: RequestOptions): APIPromise<APIKeyRegenerateResponse>;
 }
 export interface APIKeyRetrieveResponse {
+    /**
+     * The API key for the organization that can be used for authentication. Format:
+     * org_xxx
+     */
     org_api_key: string;
 }
 export interface APIKeyRegenerateResponse {
+    /**
+     * The newly generated API key for the organization that can be used for
+     * authentication. Format: org_xxx
+     */
     org_api_key: string;
 }
 export declare namespace APIKey {

package/resources/org/api-key.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItE,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3E;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItE;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3E;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/org/api-key.js

@@ -4,9 +4,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.APIKey = void 0;
 const resource_1 = require("../../core/resource.js");
 class APIKey extends resource_1.APIResource {
+    /**
+     * Retrieve the API key for the current organization. This endpoint is restricted
+     * to organization administrators only. The returned API key can be used for
+     * authenticating organization-level API requests.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.apiKey.retrieve();
+     * ```
+     */
     retrieve(options) {
         return this._client.get('/api/v3/org/api_key', options);
     }
+    /**
+     * Generate a new API key for the organization, invalidating the previous one
+     * (admin only). This operation cannot be undone and will immediately invalidate
+     * the previous API key.
+     *
+     * @example
+     * ```ts
+     * const response = await client.org.apiKey.regenerate();
+     * ```
+     */
     regenerate(options) {
         return this._client.post('/api/v3/org/api_key/regenerate', options);
     }

package/resources/org/api-key.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,MAAa,MAAO,SAAQ,sBAAW;IACrC,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AARD,wBAQC"}
+{"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AA5BD,wBA4BC"}

package/resources/org/api-key.mjs

@@ -1,9 +1,29 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../core/resource.mjs";
 export class APIKey extends APIResource {
+    /**
+     * Retrieve the API key for the current organization. This endpoint is restricted
+     * to organization administrators only. The returned API key can be used for
+     * authenticating organization-level API requests.
+     *
+     * @example
+     * ```ts
+     * const apiKey = await client.org.apiKey.retrieve();
+     * ```
+     */
     retrieve(options) {
         return this._client.get('/api/v3/org/api_key', options);
     }
+    /**
+     * Generate a new API key for the organization, invalidating the previous one
+     * (admin only). This operation cannot be undone and will immediately invalidate
+     * the previous API key.
+     *
+     * @example
+     * ```ts
+     * const response = await client.org.apiKey.regenerate();
+     * ```
+     */
     regenerate(options) {
         return this._client.post('/api/v3/org/api_key/regenerate', options);
     }

package/resources/org/api-key.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"api-key.mjs","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF"}
+{"version":3,"file":"api-key.mjs","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF"}

package/resources/org/org.js

@@ -1,34 +1,12 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Org = void 0;
+const tslib_1 = require("../../internal/tslib.js");
 const resource_1 = require("../../core/resource.js");
-const APIKeyAPI = __importStar(require("./api-key.js"));
+const APIKeyAPI = tslib_1.__importStar(require("./api-key.js"));
 const api_key_1 = require("./api-key.js");
-const ProjectAPI = __importStar(require("./project/project.js"));
+const ProjectAPI = tslib_1.__importStar(require("./project/project.js"));
 const project_1 = require("./project/project.js");
 class Org extends resource_1.APIResource {
     constructor() {

package/resources/org/org.js.map

@@ -1 +1 @@
-{"version":3,"file":"org.js","sourceRoot":"","sources":["../../src/resources/org/org.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,qDAAkD;AAClD,wDAAuC;AACvC,0CAAqF;AACrF,iEAAgD;AAChD,kDAO2B;AAE3B,MAAa,GAAI,SAAQ,sBAAW;IAApC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;CAAA;AAHD,kBAGC;AAED,GAAG,CAAC,MAAM,GAAG,gBAAM,CAAC;AACpB,GAAG,CAAC,OAAO,GAAG,iBAAO,CAAC"}
+{"version":3,"file":"org.js","sourceRoot":"","sources":["../../src/resources/org/org.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,gEAAuC;AACvC,0CAAqF;AACrF,yEAAgD;AAChD,kDAO2B;AAE3B,MAAa,GAAI,SAAQ,sBAAW;IAApC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;CAAA;AAHD,kBAGC;AAED,GAAG,CAAC,MAAM,GAAG,gBAAM,CAAC;AACpB,GAAG,CAAC,OAAO,GAAG,iBAAO,CAAC"}

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

@@ -2,104 +2,181 @@ 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
      */
     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;
 }
+/**
+ * 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
      */
     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
+     * 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;
 }
 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,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;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,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;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"}