@airtop/sdk 0.1.36 → 0.1.37-beta0

package/serialization/types/GetFileV1FileType.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../index";
+import * as Airtop from "../../api/index";
+import * as core from "../../core";
+export declare const GetFileV1FileType: core.serialization.Schema<serializers.GetFileV1FileType.Raw, Airtop.GetFileV1FileType>;
+export declare namespace GetFileV1FileType {
+    type Raw = "browser_download" | "screenshot" | "video" | "customer_upload";
+}

package/serialization/types/GetFileV1FileType.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetFileV1FileType = void 0;
+const core = __importStar(require("../../core"));
+exports.GetFileV1FileType = core.serialization.enum_(["browser_download", "screenshot", "video", "customer_upload"]);

package/serialization/types/GetFileV1Status.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../index";
+import * as Airtop from "../../api/index";
+import * as core from "../../core";
+export declare const GetFileV1Status: core.serialization.Schema<serializers.GetFileV1Status.Raw, Airtop.GetFileV1Status>;
+export declare namespace GetFileV1Status {
+    type Raw = "available" | "uploading" | "upload_failed" | "deleted";
+}

package/serialization/types/GetFileV1Status.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetFileV1Status = void 0;
+const core = __importStar(require("../../core"));
+exports.GetFileV1Status = core.serialization.enum_(["available", "uploading", "upload_failed", "deleted"]);

package/serialization/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./AiPromptResponse";
 export * from "./AiResponseEnvelope";
 export * from "./AsyncConfig";
+export * from "./AsyncOperatorPromptResponseEnvelope";
 export * from "./AsyncSessionAiResponseEnvelope";
 export * from "./AutomationOutput";
 export * from "./BrowserWaitNavigationConfigWaitUntil";
@@ -9,17 +10,30 @@ export * from "./ClickConfigClickType";
 export * from "./ClickConfig";
 export * from "./ClientProvidedResponseMetadata";
 export * from "./CreateAutomationRequestBodyConfiguration";
+export * from "./CreateFileV1FileType";
+export * from "./CreateFileV1Status";
+export * from "./CreateFileV1";
 export * from "./DeleteAutomationOutputWrapperBody";
+export * from "./EnvelopeCreateFileV1EnvelopeDefaultMeta";
 export * from "./EnvelopeDefaultMeta";
+export * from "./EnvelopeGetFileV1EnvelopeDefaultMeta";
 export * from "./ErrorBody";
 export * from "./ErrorDetail";
 export * from "./ErrorMessage";
 export * from "./ErrorModel";
+export * from "./ExternalFile";
 export * from "./ExternalSessionAiResponseMetadataStatus";
 export * from "./ExternalSessionAiResponseMetadata";
 export * from "./ExternalSessionAiResponseMetadataUsage";
 export * from "./ExternalSessionConfig";
 export * from "./ExternalSessionWithConnectionInfo";
+export * from "./FileEventMessageStatus";
+export * from "./FileEventMessage";
+export * from "./FilesResponse";
+export * from "./FilesWithPagination";
+export * from "./GetFileV1FileType";
+export * from "./GetFileV1Status";
+export * from "./GetFileV1";
 export * from "./IntervalMonitorConfig";
 export * from "./Issue";
 export * from "./ListAutomationsOutput";

package/serialization/types/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AiPromptResponse"), exports);
 __exportStar(require("./AiResponseEnvelope"), exports);
 __exportStar(require("./AsyncConfig"), exports);
+__exportStar(require("./AsyncOperatorPromptResponseEnvelope"), exports);
 __exportStar(require("./AsyncSessionAiResponseEnvelope"), exports);
 __exportStar(require("./AutomationOutput"), exports);
 __exportStar(require("./BrowserWaitNavigationConfigWaitUntil"), exports);
@@ -25,17 +26,30 @@ __exportStar(require("./ClickConfigClickType"), exports);
 __exportStar(require("./ClickConfig"), exports);
 __exportStar(require("./ClientProvidedResponseMetadata"), exports);
 __exportStar(require("./CreateAutomationRequestBodyConfiguration"), exports);
+__exportStar(require("./CreateFileV1FileType"), exports);
+__exportStar(require("./CreateFileV1Status"), exports);
+__exportStar(require("./CreateFileV1"), exports);
 __exportStar(require("./DeleteAutomationOutputWrapperBody"), exports);
+__exportStar(require("./EnvelopeCreateFileV1EnvelopeDefaultMeta"), exports);
 __exportStar(require("./EnvelopeDefaultMeta"), exports);
+__exportStar(require("./EnvelopeGetFileV1EnvelopeDefaultMeta"), exports);
 __exportStar(require("./ErrorBody"), exports);
 __exportStar(require("./ErrorDetail"), exports);
 __exportStar(require("./ErrorMessage"), exports);
 __exportStar(require("./ErrorModel"), exports);
+__exportStar(require("./ExternalFile"), exports);
 __exportStar(require("./ExternalSessionAiResponseMetadataStatus"), exports);
 __exportStar(require("./ExternalSessionAiResponseMetadata"), exports);
 __exportStar(require("./ExternalSessionAiResponseMetadataUsage"), exports);
 __exportStar(require("./ExternalSessionConfig"), exports);
 __exportStar(require("./ExternalSessionWithConnectionInfo"), exports);
+__exportStar(require("./FileEventMessageStatus"), exports);
+__exportStar(require("./FileEventMessage"), exports);
+__exportStar(require("./FilesResponse"), exports);
+__exportStar(require("./FilesWithPagination"), exports);
+__exportStar(require("./GetFileV1FileType"), exports);
+__exportStar(require("./GetFileV1Status"), exports);
+__exportStar(require("./GetFileV1"), exports);
 __exportStar(require("./IntervalMonitorConfig"), exports);
 __exportStar(require("./Issue"), exports);
 __exportStar(require("./ListAutomationsOutput"), exports);

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.36";
+export declare const SDK_VERSION = "0.1.37-beta0";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.1.36";
+exports.SDK_VERSION = "0.1.37-beta0";

package/wrapper/AirtopClient.d.ts

@@ -3,6 +3,7 @@ import { type BatchOperateConfig, type BatchOperationInput, type BatchOperationR
 import { AirtopSessions } from './AirtopSessions';
 import { AirtopWindows } from './AirtopWindows';
 import { AirtopRequests } from './AirtopRequests';
+import { AirtopFiles } from './AirtopFiles';
 type AugmentedOptions = FernClient.Options & {
     debug?: boolean;
 };
@@ -13,6 +14,7 @@ export declare class AirtopClient {
     private _windows;
     private _sessions;
     private _requests;
+    private _files;
     constructor(_options: AugmentedOptions);
     setApiKey(apiKey: string): void;
     setEnvironment(environment: string): void;
@@ -21,6 +23,7 @@ export declare class AirtopClient {
     get requests(): AirtopRequests;
     get profiles(): import("../api/resources/profiles/client/Client").Profiles;
     get automations(): import("../api/resources/automations/client/Client").Automations;
+    get files(): AirtopFiles;
     log(message: string): void;
     warn(message: string): void;
     error(err: any): void;

package/wrapper/AirtopClient.js

@@ -49,6 +49,7 @@ const utils_1 = require("../utils");
 const AirtopSessions_1 = require("./AirtopSessions");
 const AirtopWindows_1 = require("./AirtopWindows");
 const AirtopRequests_1 = require("./AirtopRequests");
+const AirtopFiles_1 = require("./AirtopFiles");
 const version_1 = require("../version");
 class AirtopClient {
     constructor(_options) {
@@ -89,6 +90,10 @@ class AirtopClient {
     get automations() {
         return this._client.automations;
     }
+    get files() {
+        var _a;
+        return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new AirtopFiles_1.AirtopFiles(this._options)));
+    }
     log(message) {
         if (this.debug) {
             console.log(message);

package/wrapper/AirtopFiles.d.ts

@@ -0,0 +1,50 @@
+import type * as Airtop from '../api';
+import { Files as FilesClass, type Files as FilesNamespace } from '../api/resources/files/client/Client';
+export declare class AirtopFiles extends FilesClass {
+    readonly _options: FilesNamespace.Options;
+    constructor(_options: FilesNamespace.Options);
+    /**
+     * Uploads a file to Airtop by first creating a file entry and then uploading the contents
+     * If @options is not provided, the fileName will be calculated from the filePath.
+     * @options.fileType defaults to `customer_upload`
+     *
+     * @param filePath - Path to the local file to upload
+     * @param options - Optional API request configuration
+     * @returns The created file entry response
+     *
+     * @example
+     *     const result = await client.files.upload("/path/to/file.pdf")
+     */
+    upload(filePath: string, options?: Airtop.CreateFileRestInputV1): Promise<Airtop.EnvelopeGetFileV1EnvelopeDefaultMeta>;
+    /**
+     * Downloads a file from Airtop to a local path
+     *
+     * @param fileId - The ID of the file to download
+     * @param destinationPath - Local path where the file should be saved
+     * @param options - Optional API request configuration
+     * @param onProgress - Optional callback to monitor download progress
+     *
+     * @example
+     *     await client.files.download(
+     *       "123e4567-e89b-12d3-a456-426614174000",
+     *       "/path/to/save/file.pdf",
+     *       (downloaded, total) => {
+     *         const percent = Math.round((downloaded / total) * 100);
+     *         console.log(`Downloaded: ${downloaded} / ${total} bytes (${percent}%)`);
+     *       }
+     *     )
+     */
+    download(fileId: string, destinationPath: string, onProgress?: (downloadedBytes: number, totalBytes: number) => void, options?: FilesNamespace.RequestOptions): Promise<void>;
+    /**
+     * Waits for a file to become available for download
+     *
+     * @param fileId - The ID of the file to wait for
+     * @param options - Optional request configuration including timeout
+     * @returns The file entry once it becomes available
+     * @throws Error if the file doesn't become available within the timeout period
+     *
+     * @example
+     *     const fileEntry = await client.files.waitForDownloadAvailable("123e4567-e89b-12d3-a456-426614174000")
+     */
+    waitForDownloadAvailable(fileId: string, options?: FilesNamespace.RequestOptions): Promise<Airtop.EnvelopeGetFileV1EnvelopeDefaultMeta>;
+}

package/wrapper/AirtopFiles.js

@@ -0,0 +1,180 @@
+"use strict";
+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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AirtopFiles = void 0;
+const Client_1 = require("../api/resources/files/client/Client");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const readable_stream_1 = require("readable-stream");
+class AirtopFiles extends Client_1.Files {
+    constructor(_options) {
+        super(_options);
+        this._options = _options;
+    }
+    /**
+     * Uploads a file to Airtop by first creating a file entry and then uploading the contents
+     * If @options is not provided, the fileName will be calculated from the filePath.
+     * @options.fileType defaults to `customer_upload`
+     *
+     * @param filePath - Path to the local file to upload
+     * @param options - Optional API request configuration
+     * @returns The created file entry response
+     *
+     * @example
+     *     const result = await client.files.upload("/path/to/file.pdf")
+     */
+    upload(filePath, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const fileName = (_a = options === null || options === void 0 ? void 0 : options.fileName) !== null && _a !== void 0 ? _a : path.basename(filePath);
+            const fileType = (_b = options === null || options === void 0 ? void 0 : options.fileType) !== null && _b !== void 0 ? _b : 'customer_upload';
+            const fileEntry = yield this.create(Object.assign(Object.assign({}, options), { fileName,
+                fileType }));
+            const fileContent = fs.readFileSync(filePath);
+            const uploadResponse = yield (0, node_fetch_1.default)(fileEntry.data.uploadUrl, {
+                method: 'PUT',
+                body: fileContent,
+                headers: {
+                    'Content-Type': 'application/octet-stream',
+                },
+            });
+            if (!uploadResponse.ok) {
+                throw new Error(`Failed to upload file content: ${uploadResponse.statusText}`);
+            }
+            const updatedFileEntry = yield this.get(fileEntry.data.id);
+            return updatedFileEntry;
+        });
+    }
+    /**
+     * Downloads a file from Airtop to a local path
+     *
+     * @param fileId - The ID of the file to download
+     * @param destinationPath - Local path where the file should be saved
+     * @param options - Optional API request configuration
+     * @param onProgress - Optional callback to monitor download progress
+     *
+     * @example
+     *     await client.files.download(
+     *       "123e4567-e89b-12d3-a456-426614174000",
+     *       "/path/to/save/file.pdf",
+     *       (downloaded, total) => {
+     *         const percent = Math.round((downloaded / total) * 100);
+     *         console.log(`Downloaded: ${downloaded} / ${total} bytes (${percent}%)`);
+     *       }
+     *     )
+     */
+    download(fileId, destinationPath, onProgress, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            // Get the file entry to get the download URL
+            const fileEntry = yield this.get(fileId, options);
+            //*****
+            //TODO: get file status, and return error if upload not complete
+            //*****
+            // Download the file content
+            const downloadResponse = yield (0, node_fetch_1.default)(fileEntry.data.downloadUrl);
+            if (!downloadResponse.ok) {
+                throw new Error(`Failed to download file: ${downloadResponse.statusText}`);
+            }
+            const totalBytes = Number.parseInt((_a = downloadResponse.headers.get('content-length')) !== null && _a !== void 0 ? _a : '0', 10);
+            let downloadedBytes = 0;
+            fs.mkdirSync(path.dirname(destinationPath), { recursive: true });
+            const fileStream = fs.createWriteStream(destinationPath);
+            yield new Promise((resolve, reject) => {
+                var _a, _b;
+                if (onProgress && downloadResponse.body) {
+                    // Create a transform stream to track progress
+                    const progressStream = new readable_stream_1.Transform({
+                        transform(chunk, encoding, callback) {
+                            downloadedBytes += chunk.length;
+                            onProgress(downloadedBytes, totalBytes);
+                            callback(null, chunk);
+                        },
+                    });
+                    downloadResponse.body.pipe(progressStream).pipe(fileStream);
+                    progressStream.on('error', reject);
+                }
+                else {
+                    // If no progress callback, pipe directly
+                    (_a = downloadResponse.body) === null || _a === void 0 ? void 0 : _a.pipe(fileStream);
+                }
+                (_b = downloadResponse.body) === null || _b === void 0 ? void 0 : _b.on('error', reject);
+                fileStream.on('finish', resolve);
+            });
+        });
+    }
+    /**
+     * Waits for a file to become available for download
+     *
+     * @param fileId - The ID of the file to wait for
+     * @param options - Optional request configuration including timeout
+     * @returns The file entry once it becomes available
+     * @throws Error if the file doesn't become available within the timeout period
+     *
+     * @example
+     *     const fileEntry = await client.files.waitForDownloadAvailable("123e4567-e89b-12d3-a456-426614174000")
+     */
+    waitForDownloadAvailable(fileId, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const timeoutSeconds = (options === null || options === void 0 ? void 0 : options.timeoutInSeconds) || 120;
+            const intervalMs = 5000; // 5 seconds
+            const startTime = Date.now();
+            while (Date.now() - startTime < timeoutSeconds * 1000) {
+                const fileEntry = yield this.get(fileId, options);
+                // Check if the file has a valid download URL and size, which indicates it's available
+                if (fileEntry.data.downloadUrl && fileEntry.data.fileBytes > 0) {
+                    return fileEntry;
+                }
+                // Wait before checking again
+                yield new Promise((resolve) => setTimeout(resolve, intervalMs));
+            }
+            throw new Error(`Timeout waiting for file ${fileId} to become available`);
+        });
+    }
+}
+exports.AirtopFiles = AirtopFiles;

package/wrapper/AirtopSessions.d.ts

@@ -20,5 +20,44 @@ export declare class AirtopSessions extends SessionsClass {
      *     await client.sessions.create()
      */
     create(request?: AirtopSessionRestInputV1, requestOptions?: SessionsNamespace.RequestOptions): Promise<Airtop.SessionResponse>;
+    /**
+     * Waits for a session to enter the 'running' status
+     *
+     * @param id - The ID of the session to wait for
+     * @param requestOptions - Optional request configuration including timeout
+     * @returns The session event indicating the session is ready, or null if timed out
+     */
     waitForSessionReady(id: string, requestOptions?: SessionsNamespace.RequestOptions): Promise<Airtop.SessionsEventsResponse | null>;
+    /**
+     * Waits for a file to be downloaded in a session and reach 'available' status
+     *
+     * @param sessionId - The ID of the session to monitor
+     * @param requestOptions - Optional request configuration including timeout
+     * @returns Object containing file's id and downloadUrl, or null if timed out
+     */
+    waitForDownload(sessionId: string, requestOptions?: SessionsNamespace.RequestOptions): Promise<{
+        id: string;
+        downloadUrl: string;
+    } | null>;
+    /**
+     * Waits for a file download to start in a session
+     *
+     * @param sessionId - The ID of the session to monitor
+     * @param requestOptions - Optional request configuration including timeout
+     * @returns Object containing file's id and downloadUrl, or null if timed out
+     */
+    waitForDownloadStart(sessionId: string, requestOptions?: SessionsNamespace.RequestOptions): Promise<{
+        id: string;
+        downloadUrl: string;
+    } | null>;
+    /**
+     * Downloads the next file from a session as soon as it starts to become available
+     *
+     * @param sessionId - The ID of the session to download from
+     * @param destinationPath - The local path where the file should be saved
+     * @param onProgress - Optional callback to track download progress
+     * @param requestOptions - Optional request configuration including timeout
+     * @throws Error if no file is available to download within the timeout period
+     */
+    downloadNextFile(sessionId: string, destinationPath: string, onProgress?: (downloadedBytes: number, totalBytes: number) => void, requestOptions?: SessionsNamespace.RequestOptions): Promise<void>;
 }