@composio/client 0.1.0-alpha.5 → 0.1.0-alpha.50

package/resources/connected-accounts.js

@@ -5,21 +5,96 @@ exports.ConnectedAccounts = void 0;
 const resource_1 = require("../core/resource.js");
 const path_1 = require("../internal/utils/path.js");
 class ConnectedAccounts extends resource_1.APIResource {
+    /**
+     * Create a new connected account
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.create({
+     *     auth_config: { id: 'id' },
+     *     connection: {},
+     *   });
+     * ```
+     */
     create(body, options) {
         return this._client.post('/api/v3/connected_accounts', { body, ...options });
     }
+    /**
+     * Retrieves comprehensive details of a connected account, including authentication
+     * configuration, connection status, and all parameters needed for API requests.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.retrieve(
+     *     'con_1a2b3c4d5e6f',
+     *   );
+     * ```
+     */
     retrieve(nanoid, options) {
         return this._client.get((0, path_1.path) `/api/v3/connected_accounts/${nanoid}`, options);
     }
+    /**
+     * List connected accounts with optional filters
+     *
+     * @example
+     * ```ts
+     * const connectedAccounts =
+     *   await client.connectedAccounts.list();
+     * ```
+     */
     list(query = {}, options) {
         return this._client.get('/api/v3/connected_accounts', { query, ...options });
     }
+    /**
+     * Soft-deletes a connected account by marking it as deleted in the database. This
+     * prevents the account from being used for API calls but preserves the record for
+     * audit purposes.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.delete('con_1a2b3c4d5e6f');
+     * ```
+     */
     delete(nanoid, options) {
         return this._client.delete((0, path_1.path) `/api/v3/connected_accounts/${nanoid}`, options);
     }
-    refresh(nanoid, options) {
-        return this._client.post((0, path_1.path) `/api/v3/connected_accounts/${nanoid}/refresh`, options);
+    /**
+     * Initiates a new authentication flow for a connected account when credentials
+     * have expired or become invalid. This may generate a new authentication URL for
+     * OAuth flows or refresh tokens for other auth schemes.
+     *
+     * @example
+     * ```ts
+     * const response = await client.connectedAccounts.refresh(
+     *   'con_1a2b3c4d5e6f',
+     * );
+     * ```
+     */
+    refresh(nanoid, params = {}, options) {
+        const { query_redirect_url, ...body } = params ?? {};
+        return this._client.post((0, path_1.path) `/api/v3/connected_accounts/${nanoid}/refresh`, {
+            query: { redirect_url: query_redirect_url },
+            body,
+            ...options,
+        });
     }
+    /**
+     * Updates the status of a connected account to either enabled (active) or disabled
+     * (inactive). Disabled accounts cannot be used for API calls but remain in the
+     * database.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.connectedAccounts.updateStatus(
+     *     'con_1a2b3c4d5e6f',
+     *     { enabled: true },
+     *   );
+     * ```
+     */
     updateStatus(nanoID, body, options) {
         return this._client.patch((0, path_1.path) `/api/v3/connected_accounts/${nanoID}/status`, { body, ...options });
     }

package/resources/connected-accounts.js.map

@@ -1 +1 @@
-{"version":3,"file":"connected-accounts.js","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,iBAAkB,SAAQ,sBAAW;IAChD,MAAM,CACJ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,YAAY,CACV,MAAc,EACd,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF;AAlCD,8CAkCC"}
+{"version":3,"file":"connected-accounts.js","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,iBAAkB,SAAQ,sBAAW;IAChD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,MAAc,EACd,SAA2D,EAAE,EAC7D,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,UAAU,EAAE;YAC3E,KAAK,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE;YAC3C,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,MAAc,EACd,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,8BAA8B,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF;AAjHD,8CAiHC"}

package/resources/connected-accounts.mjs

@@ -2,21 +2,96 @@
 import { APIResource } from "../core/resource.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class ConnectedAccounts extends APIResource {
+    /**
+     * Create a new connected account
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.create({
+     *     auth_config: { id: 'id' },
+     *     connection: {},
+     *   });
+     * ```
+     */
     create(body, options) {
         return this._client.post('/api/v3/connected_accounts', { body, ...options });
     }
+    /**
+     * Retrieves comprehensive details of a connected account, including authentication
+     * configuration, connection status, and all parameters needed for API requests.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.retrieve(
+     *     'con_1a2b3c4d5e6f',
+     *   );
+     * ```
+     */
     retrieve(nanoid, options) {
         return this._client.get(path `/api/v3/connected_accounts/${nanoid}`, options);
     }
+    /**
+     * List connected accounts with optional filters
+     *
+     * @example
+     * ```ts
+     * const connectedAccounts =
+     *   await client.connectedAccounts.list();
+     * ```
+     */
     list(query = {}, options) {
         return this._client.get('/api/v3/connected_accounts', { query, ...options });
     }
+    /**
+     * Soft-deletes a connected account by marking it as deleted in the database. This
+     * prevents the account from being used for API calls but preserves the record for
+     * audit purposes.
+     *
+     * @example
+     * ```ts
+     * const connectedAccount =
+     *   await client.connectedAccounts.delete('con_1a2b3c4d5e6f');
+     * ```
+     */
     delete(nanoid, options) {
         return this._client.delete(path `/api/v3/connected_accounts/${nanoid}`, options);
     }
-    refresh(nanoid, options) {
-        return this._client.post(path `/api/v3/connected_accounts/${nanoid}/refresh`, options);
+    /**
+     * Initiates a new authentication flow for a connected account when credentials
+     * have expired or become invalid. This may generate a new authentication URL for
+     * OAuth flows or refresh tokens for other auth schemes.
+     *
+     * @example
+     * ```ts
+     * const response = await client.connectedAccounts.refresh(
+     *   'con_1a2b3c4d5e6f',
+     * );
+     * ```
+     */
+    refresh(nanoid, params = {}, options) {
+        const { query_redirect_url, ...body } = params ?? {};
+        return this._client.post(path `/api/v3/connected_accounts/${nanoid}/refresh`, {
+            query: { redirect_url: query_redirect_url },
+            body,
+            ...options,
+        });
     }
+    /**
+     * Updates the status of a connected account to either enabled (active) or disabled
+     * (inactive). Disabled accounts cannot be used for API calls but remain in the
+     * database.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.connectedAccounts.updateStatus(
+     *     'con_1a2b3c4d5e6f',
+     *     { enabled: true },
+     *   );
+     * ```
+     */
     updateStatus(nanoID, body, options) {
         return this._client.patch(path `/api/v3/connected_accounts/${nanoID}/status`, { body, ...options });
     }

package/resources/connected-accounts.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"connected-accounts.mjs","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD,MAAM,CACJ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,8BAA8B,MAAM,UAAU,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,YAAY,CACV,MAAc,EACd,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,8BAA8B,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF"}
+{"version":3,"file":"connected-accounts.mjs","sourceRoot":"","sources":["../src/resources/connected-accounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,8BAA8B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,MAAc,EACd,SAA2D,EAAE,EAC7D,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,8BAA8B,MAAM,UAAU,EAAE;YAC3E,KAAK,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE;YAC3C,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,MAAc,EACd,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,8BAA8B,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;CACF"}

package/resources/files.d.mts

@@ -0,0 +1,218 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Files extends APIResource {
+    /**
+     * Retrieves a list of files associated with the authenticated project. Results can
+     * be filtered by toolkit and tool slugs.
+     *
+     * @example
+     * ```ts
+     * const files = await client.files.list();
+     * ```
+     */
+    list(query?: FileListParams | null | undefined, options?: RequestOptions): APIPromise<FileListResponse>;
+    /**
+     * Generates a presigned URL for uploading a file to S3. This endpoint handles
+     * deduplication by checking if a file with the same MD5 hash already exists.
+     *
+     * @example
+     * ```ts
+     * const response = await client.files.createPresignedURL({
+     *   filename: 'photo.jpg',
+     *   md5: 'd41d8cd98f00b204e9800998ecf8427e',
+     *   mimetype: 'image/jpeg',
+     *   tool_slug: 'resize-image',
+     *   toolkit_slug: 'image-processing',
+     * });
+     * ```
+     */
+    createPresignedURL(body: FileCreatePresignedURLParams, options?: RequestOptions): APIPromise<FileCreatePresignedURLResponse>;
+}
+export interface FileListResponse {
+    current_page: number;
+    items: Array<FileListResponse.Item>;
+    total_items: number;
+    total_pages: number;
+    next_cursor?: string | null;
+}
+export declare namespace FileListResponse {
+    interface Item {
+        /**
+         * Name of the original file. Example: "document.docx"
+         */
+        filename: string;
+        /**
+         * MD5 hash of the file for integrity verification. Example:
+         * "d41d8cd98f00b204e9800998ecf8427e"
+         */
+        md5: string;
+        /**
+         * Mime type of the original file. Example:
+         * "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
+         */
+        mimetype: string;
+        /**
+         * Slug of the action where this file belongs to. Example: "convert-to-pdf"
+         */
+        tool_slug: string;
+        /**
+         * Slug of the app where this file belongs to. Example: "file-converter"
+         */
+        toolkit_slug: string;
+    }
+}
+export type FileCreatePresignedURLResponse = FileCreatePresignedURLResponse.UnionMember0 | FileCreatePresignedURLResponse.UnionMember1 | FileCreatePresignedURLResponse.UnionMember2;
+export declare namespace FileCreatePresignedURLResponse {
+    interface UnionMember0 {
+        /**
+         * ID of the request file. Example: "f1e2d3c4b5a6"
+         */
+        id: string;
+        /**
+         * URL of the existing request file. Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg"
+         */
+        existing_url: string;
+        /**
+         * [DEPRECATED] Use existing_url instead. URL of the existing request file.
+         * Example: "https://storage.example.com/projects/123/files/photo-1234.jpg"
+         */
+        existingUrl: string;
+        /**
+         * S3 upload location. Example: "projects/123/files/photo-1234.jpg"
+         */
+        key: string;
+        metadata: UnionMember0.Metadata;
+        /**
+         * Indicates the file already exists and does not need to be uploaded again
+         */
+        type: 'existing';
+    }
+    namespace UnionMember0 {
+        interface Metadata {
+            /**
+             * Storage backend used for the file. If this is azure, use `x-ms-blob-type` header
+             * to set the blob type to `BlockBlob` while uploading the file
+             */
+            storage_backend: 's3' | 'azure_blob_storage';
+        }
+    }
+    interface UnionMember1 {
+        /**
+         * ID of the request file. Example: "f1e2d3c4b5a6"
+         */
+        id: string;
+        /**
+         * S3 upload location. Example: "projects/123/files/photo-1234.jpg"
+         */
+        key: string;
+        metadata: UnionMember1.Metadata;
+        /**
+         * Presigned URL for upload. Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
+         */
+        new_presigned_url: string;
+        /**
+         * [DEPRECATED] Use new_presigned_url instead. Presigned URL for upload. Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
+         */
+        newPresignedUrl: string;
+        /**
+         * Indicates this is a new file that needs to be uploaded
+         */
+        type: 'new';
+    }
+    namespace UnionMember1 {
+        interface Metadata {
+            /**
+             * Storage backend used for the file. If this is azure, use `x-ms-blob-type` header
+             * to set the blob type to `BlockBlob` while uploading the file
+             */
+            storage_backend: 's3' | 'azure_blob_storage';
+        }
+    }
+    interface UnionMember2 {
+        /**
+         * ID of the request file. Example: "f1e2d3c4b5a6"
+         */
+        id: string;
+        /**
+         * S3 upload location. Example: "projects/123/files/photo-1234.jpg"
+         */
+        key: string;
+        metadata: UnionMember2.Metadata;
+        /**
+         * Indicates this file exists but needs to be updated with a new version
+         */
+        type: 'update';
+        /**
+         * Presigned URL for upload. Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
+         */
+        update_presigned_url: string;
+        /**
+         * [DEPRECATED] Use update_presigned_url instead. Presigned URL for upload.
+         * Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
+         */
+        updatePresignedUrl: string;
+    }
+    namespace UnionMember2 {
+        interface Metadata {
+            /**
+             * Storage backend used for the file. If this is azure, use `x-ms-blob-type` header
+             * to set the blob type to `BlockBlob` while uploading the file
+             */
+            storage_backend: 's3' | 'azure_blob_storage';
+        }
+    }
+}
+export interface FileListParams {
+    /**
+     * Cursor for pagination. The cursor is a base64 encoded string of the page and
+     * limit. The page is the page number and the limit is the number of items per
+     * page. The cursor is used to paginate through the items. The cursor is not
+     * required for the first page.
+     */
+    cursor?: string;
+    /**
+     * Number of items per page, max allowed is 1000
+     */
+    limit?: number | null;
+    /**
+     * Filter files by action slug. Example: "convert-to-pdf"
+     */
+    tool_slug?: string;
+    /**
+     * Filter files by app slug. Example: "file-converter"
+     */
+    toolkit_slug?: string;
+}
+export interface FileCreatePresignedURLParams {
+    /**
+     * Name of the original file. Example: "photo.jpg"
+     */
+    filename: string;
+    /**
+     * MD5 hash of the file for deduplication and integrity verification. Example:
+     * "d41d8cd98f00b204e9800998ecf8427e"
+     */
+    md5: string;
+    /**
+     * Mime type of the original file. Example: "image/jpeg"
+     */
+    mimetype: string;
+    /**
+     * Slug of the action where this file belongs to. Example: "resize-image"
+     */
+    tool_slug: string;
+    /**
+     * Slug of the app where this file belongs to. Example: "image-processing"
+     */
+    toolkit_slug: string;
+}
+export declare namespace Files {
+    export { type FileListResponse as FileListResponse, type FileCreatePresignedURLResponse as FileCreatePresignedURLResponse, type FileListParams as FileListParams, type FileCreatePresignedURLParams as FileCreatePresignedURLParams, };
+}
+//# sourceMappingURL=files.d.mts.map

package/resources/files.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAChB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,CAAC;IAErB,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAEpC,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,MAAM,8BAA8B,GACtC,8BAA8B,CAAC,YAAY,GAC3C,8BAA8B,CAAC,YAAY,GAC3C,8BAA8B,CAAC,YAAY,CAAC;AAEhD,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;QAEhC;;WAEG;QACH,IAAI,EAAE,UAAU,CAAC;KAClB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,QAAQ;YACvB;;;eAGG;YACH,eAAe,EAAE,IAAI,GAAG,oBAAoB,CAAC;SAC9C;KACF;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;QAEhC;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;KACb;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,QAAQ;YACvB;;;eAGG;YACH,eAAe,EAAE,IAAI,GAAG,oBAAoB,CAAC;SAC9C;KACF;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;QAEhC;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;QAEf;;;WAGG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;;WAIG;QACH,kBAAkB,EAAE,MAAM,CAAC;KAC5B;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,QAAQ;YACvB;;;eAGG;YACH,eAAe,EAAE,IAAI,GAAG,oBAAoB,CAAC;SAC9C;KACF;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/files.d.ts

@@ -0,0 +1,218 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Files extends APIResource {
+    /**
+     * Retrieves a list of files associated with the authenticated project. Results can
+     * be filtered by toolkit and tool slugs.
+     *
+     * @example
+     * ```ts
+     * const files = await client.files.list();
+     * ```
+     */
+    list(query?: FileListParams | null | undefined, options?: RequestOptions): APIPromise<FileListResponse>;
+    /**
+     * Generates a presigned URL for uploading a file to S3. This endpoint handles
+     * deduplication by checking if a file with the same MD5 hash already exists.
+     *
+     * @example
+     * ```ts
+     * const response = await client.files.createPresignedURL({
+     *   filename: 'photo.jpg',
+     *   md5: 'd41d8cd98f00b204e9800998ecf8427e',
+     *   mimetype: 'image/jpeg',
+     *   tool_slug: 'resize-image',
+     *   toolkit_slug: 'image-processing',
+     * });
+     * ```
+     */
+    createPresignedURL(body: FileCreatePresignedURLParams, options?: RequestOptions): APIPromise<FileCreatePresignedURLResponse>;
+}
+export interface FileListResponse {
+    current_page: number;
+    items: Array<FileListResponse.Item>;
+    total_items: number;
+    total_pages: number;
+    next_cursor?: string | null;
+}
+export declare namespace FileListResponse {
+    interface Item {
+        /**
+         * Name of the original file. Example: "document.docx"
+         */
+        filename: string;
+        /**
+         * MD5 hash of the file for integrity verification. Example:
+         * "d41d8cd98f00b204e9800998ecf8427e"
+         */
+        md5: string;
+        /**
+         * Mime type of the original file. Example:
+         * "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
+         */
+        mimetype: string;
+        /**
+         * Slug of the action where this file belongs to. Example: "convert-to-pdf"
+         */
+        tool_slug: string;
+        /**
+         * Slug of the app where this file belongs to. Example: "file-converter"
+         */
+        toolkit_slug: string;
+    }
+}
+export type FileCreatePresignedURLResponse = FileCreatePresignedURLResponse.UnionMember0 | FileCreatePresignedURLResponse.UnionMember1 | FileCreatePresignedURLResponse.UnionMember2;
+export declare namespace FileCreatePresignedURLResponse {
+    interface UnionMember0 {
+        /**
+         * ID of the request file. Example: "f1e2d3c4b5a6"
+         */
+        id: string;
+        /**
+         * URL of the existing request file. Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg"
+         */
+        existing_url: string;
+        /**
+         * [DEPRECATED] Use existing_url instead. URL of the existing request file.
+         * Example: "https://storage.example.com/projects/123/files/photo-1234.jpg"
+         */
+        existingUrl: string;
+        /**
+         * S3 upload location. Example: "projects/123/files/photo-1234.jpg"
+         */
+        key: string;
+        metadata: UnionMember0.Metadata;
+        /**
+         * Indicates the file already exists and does not need to be uploaded again
+         */
+        type: 'existing';
+    }
+    namespace UnionMember0 {
+        interface Metadata {
+            /**
+             * Storage backend used for the file. If this is azure, use `x-ms-blob-type` header
+             * to set the blob type to `BlockBlob` while uploading the file
+             */
+            storage_backend: 's3' | 'azure_blob_storage';
+        }
+    }
+    interface UnionMember1 {
+        /**
+         * ID of the request file. Example: "f1e2d3c4b5a6"
+         */
+        id: string;
+        /**
+         * S3 upload location. Example: "projects/123/files/photo-1234.jpg"
+         */
+        key: string;
+        metadata: UnionMember1.Metadata;
+        /**
+         * Presigned URL for upload. Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
+         */
+        new_presigned_url: string;
+        /**
+         * [DEPRECATED] Use new_presigned_url instead. Presigned URL for upload. Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
+         */
+        newPresignedUrl: string;
+        /**
+         * Indicates this is a new file that needs to be uploaded
+         */
+        type: 'new';
+    }
+    namespace UnionMember1 {
+        interface Metadata {
+            /**
+             * Storage backend used for the file. If this is azure, use `x-ms-blob-type` header
+             * to set the blob type to `BlockBlob` while uploading the file
+             */
+            storage_backend: 's3' | 'azure_blob_storage';
+        }
+    }
+    interface UnionMember2 {
+        /**
+         * ID of the request file. Example: "f1e2d3c4b5a6"
+         */
+        id: string;
+        /**
+         * S3 upload location. Example: "projects/123/files/photo-1234.jpg"
+         */
+        key: string;
+        metadata: UnionMember2.Metadata;
+        /**
+         * Indicates this file exists but needs to be updated with a new version
+         */
+        type: 'update';
+        /**
+         * Presigned URL for upload. Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
+         */
+        update_presigned_url: string;
+        /**
+         * [DEPRECATED] Use update_presigned_url instead. Presigned URL for upload.
+         * Example:
+         * "https://storage.example.com/projects/123/files/photo-1234.jpg?X-Amz-Algorithm=..."
+         */
+        updatePresignedUrl: string;
+    }
+    namespace UnionMember2 {
+        interface Metadata {
+            /**
+             * Storage backend used for the file. If this is azure, use `x-ms-blob-type` header
+             * to set the blob type to `BlockBlob` while uploading the file
+             */
+            storage_backend: 's3' | 'azure_blob_storage';
+        }
+    }
+}
+export interface FileListParams {
+    /**
+     * Cursor for pagination. The cursor is a base64 encoded string of the page and
+     * limit. The page is the page number and the limit is the number of items per
+     * page. The cursor is used to paginate through the items. The cursor is not
+     * required for the first page.
+     */
+    cursor?: string;
+    /**
+     * Number of items per page, max allowed is 1000
+     */
+    limit?: number | null;
+    /**
+     * Filter files by action slug. Example: "convert-to-pdf"
+     */
+    tool_slug?: string;
+    /**
+     * Filter files by app slug. Example: "file-converter"
+     */
+    toolkit_slug?: string;
+}
+export interface FileCreatePresignedURLParams {
+    /**
+     * Name of the original file. Example: "photo.jpg"
+     */
+    filename: string;
+    /**
+     * MD5 hash of the file for deduplication and integrity verification. Example:
+     * "d41d8cd98f00b204e9800998ecf8427e"
+     */
+    md5: string;
+    /**
+     * Mime type of the original file. Example: "image/jpeg"
+     */
+    mimetype: string;
+    /**
+     * Slug of the action where this file belongs to. Example: "resize-image"
+     */
+    tool_slug: string;
+    /**
+     * Slug of the app where this file belongs to. Example: "image-processing"
+     */
+    toolkit_slug: string;
+}
+export declare namespace Files {
+    export { type FileListResponse as FileListResponse, type FileCreatePresignedURLResponse as FileCreatePresignedURLResponse, type FileListParams as FileListParams, type FileCreatePresignedURLParams as FileCreatePresignedURLParams, };
+}
+//# sourceMappingURL=files.d.ts.map

package/resources/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAChB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,CAAC;IAErB,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAEpC,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,MAAM,8BAA8B,GACtC,8BAA8B,CAAC,YAAY,GAC3C,8BAA8B,CAAC,YAAY,GAC3C,8BAA8B,CAAC,YAAY,CAAC;AAEhD,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;QAEhC;;WAEG;QACH,IAAI,EAAE,UAAU,CAAC;KAClB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,QAAQ;YACvB;;;eAGG;YACH,eAAe,EAAE,IAAI,GAAG,oBAAoB,CAAC;SAC9C;KACF;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;QAEhC;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;;WAGG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;KACb;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,QAAQ;YACvB;;;eAGG;YACH,eAAe,EAAE,IAAI,GAAG,oBAAoB,CAAC;SAC9C;KACF;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;QAEhC;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;QAEf;;;WAGG;QACH,oBAAoB,EAAE,MAAM,CAAC;QAE7B;;;;WAIG;QACH,kBAAkB,EAAE,MAAM,CAAC;KAC5B;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,QAAQ;YACvB;;;eAGG;YACH,eAAe,EAAE,IAAI,GAAG,oBAAoB,CAAC;SAC9C;KACF;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}