@airtop/sdk 0.1.26 → 0.1.27-beta0

package/api/resources/requests/index.js

@@ -0,0 +1,17 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);

package/api/resources/sessions/client/Client.js

@@ -94,8 +94,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.26",
-                    "User-Agent": "@airtop/sdk/0.1.26",
+                    "X-Fern-SDK-Version": "0.1.27-beta0",
+                    "User-Agent": "@airtop/sdk/0.1.27-beta0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -180,8 +180,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.26",
-                    "User-Agent": "@airtop/sdk/0.1.26",
+                    "X-Fern-SDK-Version": "0.1.27-beta0",
+                    "User-Agent": "@airtop/sdk/0.1.27-beta0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -245,8 +245,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.26",
-                    "User-Agent": "@airtop/sdk/0.1.26",
+                    "X-Fern-SDK-Version": "0.1.27-beta0",
+                    "User-Agent": "@airtop/sdk/0.1.27-beta0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -332,8 +332,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.26",
-                    "User-Agent": "@airtop/sdk/0.1.26",
+                    "X-Fern-SDK-Version": "0.1.27-beta0",
+                    "User-Agent": "@airtop/sdk/0.1.27-beta0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -388,8 +388,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.26",
-                    "User-Agent": "@airtop/sdk/0.1.26",
+                    "X-Fern-SDK-Version": "0.1.27-beta0",
+                    "User-Agent": "@airtop/sdk/0.1.27-beta0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -486,8 +486,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.26",
-                    "User-Agent": "@airtop/sdk/0.1.26",
+                    "X-Fern-SDK-Version": "0.1.27-beta0",
+                    "User-Agent": "@airtop/sdk/0.1.27-beta0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -539,8 +539,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.26",
-                    "User-Agent": "@airtop/sdk/0.1.26",
+                    "X-Fern-SDK-Version": "0.1.27-beta0",
+                    "User-Agent": "@airtop/sdk/0.1.27-beta0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/sessions/types/SessionsEventsResponse.d.ts

@@ -5,8 +5,11 @@ import * as Airtop from "../../../index";
 /**
  * Each oneOf object in the array represents one possible Server Sent Events (SSE) message, serialized as UTF-8 text according to the SSE specification.
  */
-export declare type SessionsEventsResponse = Airtop.SessionsEventsResponse.Error_ | Airtop.SessionsEventsResponse.WindowEvent | Airtop.SessionsEventsResponse.SessionEvent | Airtop.SessionsEventsResponse.Status;
+export declare type SessionsEventsResponse = Airtop.SessionsEventsResponse.Status | Airtop.SessionsEventsResponse.Error_ | Airtop.SessionsEventsResponse.WindowEvent | Airtop.SessionsEventsResponse.SessionEvent;
 export declare namespace SessionsEventsResponse {
+    interface Status extends Airtop.SessionsEventsResponseStatus {
+        event: "status";
+    }
     interface Error_ extends Airtop.SessionsEventsResponseError {
         event: "error";
     }
@@ -16,7 +19,4 @@ export declare namespace SessionsEventsResponse {
     interface SessionEvent extends Airtop.SessionsEventsResponseSessionEvent {
         event: "sessionEvent";
     }
-    interface Status extends Airtop.SessionsEventsResponseStatus {
-        event: "status";
-    }
 }

package/api/resources/sessions/types/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./SessionsListRequestStatus";
+export * from "./SessionsEventsResponseStatus";
 export * from "./SessionsEventsResponseError";
 export * from "./SessionsEventsResponseWindowEvent";
 export * from "./SessionsEventsResponseSessionEvent";
-export * from "./SessionsEventsResponseStatus";
 export * from "./SessionsEventsResponse";

package/api/resources/sessions/types/index.js

@@ -15,8 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./SessionsListRequestStatus"), exports);
+__exportStar(require("./SessionsEventsResponseStatus"), exports);
 __exportStar(require("./SessionsEventsResponseError"), exports);
 __exportStar(require("./SessionsEventsResponseWindowEvent"), exports);
 __exportStar(require("./SessionsEventsResponseSessionEvent"), exports);
-__exportStar(require("./SessionsEventsResponseStatus"), exports);
 __exportStar(require("./SessionsEventsResponse"), exports);

package/api/resources/windows/client/Client.d.ts

@@ -22,6 +22,142 @@ export declare namespace Windows {
 export declare class Windows {
     protected readonly _options: Windows.Options;
     constructor(_options: Windows.Options);
+    /**
+     * Execute a click interaction in a specific browser window asynchronously
+     *
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncClickRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         elementDescription: "The login button"
+     *     })
+     */
+    asyncClick(sessionId: string, windowId: string, request: Airtop.AsyncClickRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * Create an automation of a browser window asynchronously
+     *
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncCreateAutomationRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncCreateAutomation("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
+    asyncCreateAutomation(sessionId: string, windowId: string, request?: Airtop.AsyncCreateAutomationRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * Execute an automation of a browser window asynchronously
+     *
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncExecuteAutomationRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncExecuteAutomation("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         automationId: "automationId"
+     *     })
+     */
+    asyncExecuteAutomation(sessionId: string, windowId: string, request: Airtop.AsyncExecuteAutomationRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncHoverRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         elementDescription: "The search box input in the top right corner"
+     *     })
+     */
+    asyncHover(sessionId: string, windowId: string, request: Airtop.AsyncHoverRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncMonitorRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
+    asyncMonitor(sessionId: string, windowId: string, request?: Airtop.AsyncMonitorRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncPageQueryRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         prompt: "What is the main idea of this page?"
+     *     })
+     */
+    asyncPageQuery(sessionId: string, windowId: string, request: Airtop.AsyncPageQueryRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncPaginatedExtractionRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncPaginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list."
+     *     })
+     */
+    asyncPaginatedExtraction(sessionId: string, windowId: string, request: Airtop.AsyncPaginatedExtractionRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
+     *
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncPromptContentRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncPromptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         prompt: "What is the main idea of this page?"
+     *     })
+     */
+    asyncPromptContent(sessionId: string, windowId: string, request: Airtop.AsyncPromptContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * Take a screenshot of the current viewport of a browser window asynchronously
+     *
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncScreenshotRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
+    asyncScreenshot(sessionId: string, windowId: string, request?: Airtop.AsyncScreenshotRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
+     *
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to summarize.
+     * @param {Airtop.AsyncSummarizeContentRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncSummarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
+    asyncSummarizeContent(sessionId: string, windowId: string, request?: Airtop.AsyncSummarizeContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.AsyncTypeRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         text: "Example text"
+     *     })
+     */
+    asyncType(sessionId: string, windowId: string, request: Airtop.AsyncTypeRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
     /**
      * Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
      *
@@ -95,9 +231,21 @@ export declare class Windows {
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     *     await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         elementDescription: "The search box input in the top right corner"
+     *     })
+     */
+    hover(sessionId: string, windowId: string, request: Airtop.SessionHoverHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.SessionMonitorHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
      */
-    hover(sessionId: string, windowId: string, request?: Airtop.SessionHoverHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    monitor(sessionId: string, windowId: string, request?: Airtop.SessionMonitorHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
     /**
      * Submit a prompt that queries the content of a specific browser window. You may extract content from the page, or ask a question about the page and allow the AI to answer it (ex. Is the user logged in?).
      *
@@ -121,9 +269,11 @@ export declare class Windows {
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.windows.paginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     *     await client.windows.paginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         prompt: "This site contains a list of results about <provide details about the list>. Navigate through 3 pages of results and return the title and <provide details about the data you want to extract> about each result in this list."
+     *     })
      */
-    paginatedExtraction(sessionId: string, windowId: string, request?: Airtop.SessionPaginatedExtractionHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    paginatedExtraction(sessionId: string, windowId: string, request: Airtop.SessionPaginatedExtractionHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
     /**
      * This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
      *
@@ -162,6 +312,18 @@ export declare class Windows {
      *     await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
      */
     screenshot(sessionId: string, windowId: string, request?: Airtop.SessionScreenshotHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    /**
+     * Execute a scroll interaction in a specific browser window
+     *
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.SessionScrollHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
+    scroll(sessionId: string, windowId: string, request?: Airtop.SessionScrollHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
     /**
      * This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
      *