@airtop/sdk 0.1.4 → 0.1.6

package/api/resources/windows/client/requests/index.d.ts

@@ -1,6 +1,8 @@
 export { type CreateWindowInputV1Body } from "./CreateWindowInputV1Body";
 export { type GetWindowInfoRequest } from "./GetWindowInfoRequest";
 export { type WindowLoadUrlV1Body } from "./WindowLoadUrlV1Body";
-export { type SessionContentPromptHandlerRequestBody } from "./SessionContentPromptHandlerRequestBody";
+export { type SessionClickHandlerRequestBody } from "./SessionClickHandlerRequestBody";
+export { type SessionHoverHandlerRequestBody } from "./SessionHoverHandlerRequestBody";
 export { type ScrapeContentRequest } from "./ScrapeContentRequest";
 export { type SessionSummaryHandlerRequestBody } from "./SessionSummaryHandlerRequestBody";
+export { type SessionTypeHandlerRequestBody } from "./SessionTypeHandlerRequestBody";

package/api/types/ClickConfig.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ClickConfig = Record<string, unknown>;

package/api/types/CustomProxy.d.ts

@@ -7,7 +7,7 @@ import * as Airtop from "../index";
  */
 export declare type CustomProxy = 
 /**
- * Url of the proxy. */
+ * url of the proxy. Or "default" to use airtop provided proxy. */
 string
 /**
  * Proxy object with url of the proxy as a parameter. Takes optional username and password. */

package/api/types/PageQueryConfig.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PageQueryConfig {
+    /** JSON schema defining the structure of the output. If not provided, the format of the output might vary. */
+    outputSchema?: string;
+}

package/api/types/{PromptContentExperimentalConfig.d.ts → PageQueryExperimentalConfig.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface PromptContentExperimentalConfig {
+export interface PageQueryExperimentalConfig {
     /** If set to 'enabled', Airtop AI will also analyze the web page visually when fulfilling the request. Note that this can add to both the execution time and cost of the operation. If the page is too large, the context window can be exceeded and the request will fail. If set to 'auto' or 'disabled', no visual analysis will be conducted. If 'followPaginationLinks' is set to true, visual analysis will be conducted unless 'includeVisualAnalysis' is explicitly set to 'disabled'. */
     includeVisualAnalysis?: string;
 }

package/api/types/SessionConfigV1Proxy.d.ts

@@ -6,9 +6,12 @@ import * as Airtop from "../index";
  * Proxy configuration.
  */
 export declare type SessionConfigV1Proxy = 
+/**
+ * True to use airtop provided proxy */
+boolean
 /**
  * Configuration for a single custom proxy. */
-Airtop.CustomProxy
+ | Airtop.CustomProxy
 /**
  * Array of proxy configurations. Includes a domain pattern and a proxy configuration to assign proxies to specific domains. */
  | Airtop.SessionConfigV1ProxyItem[];

package/api/{resources/windows/client/requests/SessionContentPromptHandlerRequestBody.d.ts → types/SessionPageQueryHandlerRequestBody.d.ts}

@@ -1,22 +1,19 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * @example
- *     {
- *         prompt: "What is the main idea of this page?"
- *     }
- */
-export interface SessionContentPromptHandlerRequestBody {
+import * as Airtop from "../index";
+export interface SessionPageQueryHandlerRequestBody {
     clientRequestId?: string;
-    /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
+    /** Request configuration */
+    configuration?: Airtop.PageQueryConfig;
+    /** A credit threshold that, once exceeded, will cause the operation to be cancelled. Note that this is _not_ a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended). */
     costThresholdCredits?: number;
     /** Make a best effort attempt to load more content items than are originally displayed on the page, e.g. by following pagination links, clicking controls to load more content, utilizing infinite scrolling, etc. This can be quite a bit more costly, but may be necessary for sites that require additional interaction to show the needed results. You can provide constraints in your prompt (e.g. on the total number of pages or results to consider). */
     followPaginationLinks?: boolean;
     /** The prompt to submit about the content in the browser window. */
     prompt: string;
     /**
-     * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is *not* a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
+     * A time threshold in seconds that, once exceeded, will cause the operation to be cancelled. Note that this is _not_ a hard limit, but a threshold that is checked periodically during the course of fulfilling the request. A default threshold is used if not specified, but you can use this option to increase or decrease as needed. Set to 0 to disable this feature entirely (not recommended).
      *
      * This setting does not extend the maximum session duration provided at the time of session creation.
      */

package/api/types/SessionPageQueryHandlerRequestBody.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SummaryConfig.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Airtop from "../index";
 export interface SummaryConfig {
-    experimental?: Airtop.SummaryExperimentalConfig;
+    /** JSON schema defining the structure of the output. If not provided, the format of the output might vary. */
+    outputSchema?: string;
 }

package/api/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./AiPromptResponse";
 export * from "./AiResponseEnvelope";
+export * from "./ClickConfig";
 export * from "./ClientProvidedResponseMetadata";
 export * from "./EmptyResponse";
 export * from "./EmptyResponseJson";
@@ -16,10 +17,10 @@ export * from "./ExternalSessionAiResponseMetadataUsage";
 export * from "./ExternalSessionConfig";
 export * from "./ExternalSessionWithConnectionInfo";
 export * from "./Issue";
+export * from "./PageQueryConfig";
+export * from "./PageQueryExperimentalConfig";
 export * from "./Pagination";
 export * from "./ProfilesResponse";
-export * from "./PromptContentConfig";
-export * from "./PromptContentExperimentalConfig";
 export * from "./ScrapeResponse";
 export * from "./ScrapeResponseContent";
 export * from "./ScrapeResponseEnvelope";
@@ -29,6 +30,7 @@ export * from "./CustomProxy";
 export * from "./SessionConfigV1ProxyItem";
 export * from "./SessionConfigV1Proxy";
 export * from "./SessionConfigV1";
+export * from "./SessionPageQueryHandlerRequestBody";
 export * from "./SessionResponse";
 export * from "./SessionsResponse";
 export * from "./SessionsWithPagination";

package/api/types/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AiPromptResponse"), exports);
 __exportStar(require("./AiResponseEnvelope"), exports);
+__exportStar(require("./ClickConfig"), exports);
 __exportStar(require("./ClientProvidedResponseMetadata"), exports);
 __exportStar(require("./EmptyResponse"), exports);
 __exportStar(require("./EmptyResponseJson"), exports);
@@ -32,10 +33,10 @@ __exportStar(require("./ExternalSessionAiResponseMetadataUsage"), exports);
 __exportStar(require("./ExternalSessionConfig"), exports);
 __exportStar(require("./ExternalSessionWithConnectionInfo"), exports);
 __exportStar(require("./Issue"), exports);
+__exportStar(require("./PageQueryConfig"), exports);
+__exportStar(require("./PageQueryExperimentalConfig"), exports);
 __exportStar(require("./Pagination"), exports);
 __exportStar(require("./ProfilesResponse"), exports);
-__exportStar(require("./PromptContentConfig"), exports);
-__exportStar(require("./PromptContentExperimentalConfig"), exports);
 __exportStar(require("./ScrapeResponse"), exports);
 __exportStar(require("./ScrapeResponseContent"), exports);
 __exportStar(require("./ScrapeResponseEnvelope"), exports);
@@ -45,6 +46,7 @@ __exportStar(require("./CustomProxy"), exports);
 __exportStar(require("./SessionConfigV1ProxyItem"), exports);
 __exportStar(require("./SessionConfigV1Proxy"), exports);
 __exportStar(require("./SessionConfigV1"), exports);
+__exportStar(require("./SessionPageQueryHandlerRequestBody"), exports);
 __exportStar(require("./SessionResponse"), exports);
 __exportStar(require("./SessionsResponse"), exports);
 __exportStar(require("./SessionsWithPagination"), exports);

package/dist/api/resources/profiles/client/Client.js

@@ -77,8 +77,8 @@ class Profiles {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.4",
-                    "User-Agent": "@airtop/sdk/0.1.4",
+                    "X-Fern-SDK-Version": "0.1.6",
+                    "User-Agent": "@airtop/sdk/0.1.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -148,8 +148,8 @@ class Profiles {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.4",
-                    "User-Agent": "@airtop/sdk/0.1.4",
+                    "X-Fern-SDK-Version": "0.1.6",
+                    "User-Agent": "@airtop/sdk/0.1.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/dist/api/resources/sessions/client/Client.d.ts

@@ -58,9 +58,9 @@ export declare class Sessions {
      * @throws {@link Airtop.InternalServerError}
      *
      * @example
-     *     await client.sessions.getinfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
+     *     await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
      */
-    getinfo(id: string, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionResponse>;
+    getInfo(id: string, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionResponse>;
     /**
      * Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
      *

package/dist/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.4",
-                    "User-Agent": "@airtop/sdk/0.1.4",
+                    "X-Fern-SDK-Version": "0.1.6",
+                    "User-Agent": "@airtop/sdk/0.1.6",
                     "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.4",
-                    "User-Agent": "@airtop/sdk/0.1.4",
+                    "X-Fern-SDK-Version": "0.1.6",
+                    "User-Agent": "@airtop/sdk/0.1.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -233,9 +233,9 @@ class Sessions {
      * @throws {@link Airtop.InternalServerError}
      *
      * @example
-     *     await client.sessions.getinfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
+     *     await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
      */
-    getinfo(id, requestOptions) {
+    getInfo(id, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
@@ -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.4",
-                    "User-Agent": "@airtop/sdk/0.1.4",
+                    "X-Fern-SDK-Version": "0.1.6",
+                    "User-Agent": "@airtop/sdk/0.1.6",
                     "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.4",
-                    "User-Agent": "@airtop/sdk/0.1.4",
+                    "X-Fern-SDK-Version": "0.1.6",
+                    "User-Agent": "@airtop/sdk/0.1.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -380,8 +380,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.4",
-                    "User-Agent": "@airtop/sdk/0.1.4",
+                    "X-Fern-SDK-Version": "0.1.6",
+                    "User-Agent": "@airtop/sdk/0.1.6",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

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

@@ -64,10 +64,46 @@ export declare class Windows {
      *     await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430")
      */
     close(sessionId: string, windowId: string, requestOptions?: Windows.RequestOptions): Promise<Airtop.WindowIdResponse>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window.
+     * @param {Airtop.SessionClickHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         elementDescription: "The login button"
+     *     })
+     */
+    click(sessionId: string, windowId: string, request: Airtop.SessionClickHandlerRequestBody, 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.SessionHoverHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
+    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 to target with an Airtop AI prompt.
-     * @param {Airtop.SessionContentPromptHandlerRequestBody} request
+     * @param {Airtop.SessionPageQueryHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         prompt: "What is the main idea of this page?"
+     *     })
+     */
+    pageQuery(sessionId: string, windowId: string, request: Airtop.SessionPageQueryHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    /**
+     * 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 to target with an Airtop AI prompt.
+     * @param {Airtop.SessionPageQueryHandlerRequestBody} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -75,7 +111,7 @@ export declare class Windows {
      *         prompt: "What is the main idea of this page?"
      *     })
      */
-    promptContent(sessionId: string, windowId: string, request: Airtop.SessionContentPromptHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    promptContent(sessionId: string, windowId: string, request: Airtop.SessionPageQueryHandlerRequestBody, 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 to scrape.
@@ -87,6 +123,8 @@ export declare class Windows {
      */
     scrapeContent(sessionId: string, windowId: string, request?: Airtop.ScrapeContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.ScrapeResponse>;
     /**
+     * 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.SessionSummaryHandlerRequestBody} request
@@ -96,5 +134,17 @@ export declare class Windows {
      *     await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
      */
     summarizeContent(sessionId: string, windowId: string, request?: Airtop.SessionSummaryHandlerRequestBody, 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.SessionTypeHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         text: "Example text"
+     *     })
+     */
+    type(sessionId: string, windowId: string, request: Airtop.SessionTypeHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
     protected _getAuthorizationHeader(): Promise<string>;
 }