@airtop/sdk 0.1.36 → 1.0.0-alpha2.1

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

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

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

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Airtop from "../../../index";
-export interface SessionsEventsResponseError {
-    data: Airtop.ErrorMessage;
-    /** The event ID. */
-    id?: number;
-    /** The retry time in milliseconds. */
-    retry?: number;
-}

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

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

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

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Airtop from "../../../index";
-export interface SessionsEventsResponseSessionEvent {
-    data: Airtop.SessionEventMessage;
-    /** The event ID. */
-    id?: number;
-    /** The retry time in milliseconds. */
-    retry?: number;
-}

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

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

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

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Airtop from "../../../index";
-export interface SessionsEventsResponseStatus {
-    data: Airtop.StatusMessage;
-    /** The event ID. */
-    id?: number;
-    /** The retry time in milliseconds. */
-    retry?: number;
-}

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

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

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

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Airtop from "../../../index";
-export interface SessionsEventsResponseWindowEvent {
-    data: Airtop.WindowEventMessage;
-    /** The event ID. */
-    id?: number;
-    /** The retry time in milliseconds. */
-    retry?: number;
-}

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

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

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

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Status of the session to get.
- */
-export type SessionsListRequestStatus = "awaitingCapacity" | "initializing" | "running" | "ended" | "completed" | "cancelled" | "all";
-export declare const SessionsListRequestStatus: {
-    readonly AwaitingCapacity: "awaitingCapacity";
-    readonly Initializing: "initializing";
-    readonly Running: "running";
-    readonly Ended: "ended";
-    readonly Completed: "completed";
-    readonly Cancelled: "cancelled";
-    readonly All: "all";
-};

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

@@ -1,15 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SessionsListRequestStatus = void 0;
-exports.SessionsListRequestStatus = {
-    AwaitingCapacity: "awaitingCapacity",
-    Initializing: "initializing",
-    Running: "running",
-    Ended: "ended",
-    Completed: "completed",
-    Cancelled: "cancelled",
-    All: "all",
-};

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

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

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

@@ -1,22 +0,0 @@
-"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("./SessionsListRequestStatus"), exports);
-__exportStar(require("./SessionsEventsResponseStatus"), exports);
-__exportStar(require("./SessionsEventsResponseError"), exports);
-__exportStar(require("./SessionsEventsResponseWindowEvent"), exports);
-__exportStar(require("./SessionsEventsResponseSessionEvent"), exports);
-__exportStar(require("./SessionsEventsResponse"), exports);

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

@@ -1,302 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments";
-import * as core from "../../../../core";
-import * as Airtop from "../../../index";
-export declare namespace Windows {
-    interface Options {
-        environment?: core.Supplier<environments.AirtopEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<core.BearerToken>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
-    }
-}
-export declare class Windows {
-    protected readonly _options: Windows.Options;
-    constructor(_options: Windows.Options);
-    /**
-     * 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>;
-    /**
-     * Create a form filler automation asynchronously
-     *
-     * @param {string} sessionId - The session id for the window.
-     * @param {string} windowId - The Airtop window id of the browser window.
-     * @param {Airtop.AsyncCreateFormFillerRequest} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.windows.asyncCreateFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
-     */
-    asyncCreateFormFiller(sessionId: string, windowId: string, request?: Airtop.AsyncCreateFormFillerRequest, 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>;
-    /**
-     * Fill a form of a browser window asynchronously using a form-filler automation
-     *
-     * @param {string} sessionId - The session id for the window.
-     * @param {string} windowId - The Airtop window id of the browser window.
-     * @param {Airtop.AsyncFillFormRequest} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-     *         automationId: "automationId"
-     *     })
-     */
-    asyncFillForm(sessionId: string, windowId: string, request: Airtop.AsyncFillFormRequest, 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.
-     *
-     * @param {string} sessionId - ID of the session that owns the window.
-     * @param {Airtop.CreateWindowInputV1Body} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
-     */
-    create(sessionId: string, request?: Airtop.CreateWindowInputV1Body, requestOptions?: Windows.RequestOptions): Promise<Airtop.WindowIdResponse>;
-    /**
-     * Get information about a browser window in a session, including the live view url.
-     *
-     * @param {string} sessionId - ID of the session that owns the window.
-     * @param {string} windowId - ID of the browser window, which can either be a normal AirTop windowId or a [CDP TargetId](https://chromedevtools.github.io/devtools-protocol/tot/Target/#type-TargetID) from a browser automation library like Puppeteer (typically associated with the page or main frame). Our SDKs will handle retrieving a TargetId for you from various popular browser automation libraries, but we also have details in our guides on how to do it manually.
-     * @param {Airtop.GetWindowInfoRequest} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
-     *         screenResolution: "1280x720"
-     *     })
-     */
-    getWindowInfo(sessionId: string, windowId: string, request?: Airtop.GetWindowInfoRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.WindowResponse>;
-    /**
-     * Loads a specified url on a given window
-     *
-     * @param {string} sessionId - ID of the session that owns the window.
-     * @param {string} windowId - Airtop window ID of the browser window.
-     * @param {Airtop.WindowLoadUrlV1Body} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
-     *         url: "https://www.airtop.ai"
-     *     })
-     */
-    loadUrl(sessionId: string, windowId: string, request: Airtop.WindowLoadUrlV1Body, requestOptions?: Windows.RequestOptions): Promise<Airtop.OperationOutcomeResponse>;
-    /**
-     * Closes a browser window in a session
-     *
-     * @param {string} sessionId - ID of the session that owns the window.
-     * @param {string} windowId - Airtop window ID of the browser window.
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     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>;
-    /**
-     * Execute a click 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.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>;
-    /**
-     * Create a form-filler automation synchronously for the form loaded in the browser window
-     *
-     * @param {string} sessionId - The session id for the window.
-     * @param {string} windowId - The Airtop window id of the browser window.
-     * @param {Airtop.CreateFormFillerRequest} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
-     */
-    createFormFiller(sessionId: string, windowId: string, request?: Airtop.CreateFormFillerRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
-    /**
-     * Fill a form of a browser window synchronously using a form-filler automation
-     *
-     * @param {string} sessionId - The session id for the window.
-     * @param {string} windowId - The Airtop window id of the browser window.
-     * @param {Airtop.FillFormRequest} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-     *         automationId: "automationId"
-     *     })
-     */
-    fillForm(sessionId: string, windowId: string, request: Airtop.FillFormRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
-    /**
-     * Execute a hover 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.SessionHoverHandlerRequestBody} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     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", {
-     *         condition: "Determine if the user appears to be signed in to the website"
-     *     })
-     */
-    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?).
-     *
-     * @param {string} sessionId - The session id for the window.
-     * @param {string} windowId - The Airtop window id of the browser window.
-     * @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>;
-    /**
-     * Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
-     *
-     * @param {string} sessionId - The session id for the window.
-     * @param {string} windowId - The Airtop window id of the browser window.
-     * @param {Airtop.SessionPaginatedExtractionHandlerRequestBody} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     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>;
-    /**
-     * 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.SessionPageQueryHandlerRequestBody} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-     *         prompt: "What is the main idea of this page?"
-     *     })
-     */
-    promptContent(sessionId: string, windowId: string, request: Airtop.SessionPageQueryHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
-    /**
-     * Scrape a window and return the content as markdown
-     *
-     * @param {string} sessionId - The session id for the window.
-     * @param {string} windowId - The Airtop window id of the browser window to scrape.
-     * @param {Airtop.ScrapeContentRequest} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
-     */
-    scrapeContent(sessionId: string, windowId: string, request?: Airtop.ScrapeContentRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.ScrapeResponse>;
-    /**
-     * Take a screenshot of a browser window
-     *
-     * @param {string} sessionId - The session id for the window.
-     * @param {string} windowId - The Airtop window id of the browser window.
-     * @param {Airtop.SessionScreenshotHandlerRequestBody} request
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     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.
-     *
-     * @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
-     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     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>;
-    /**
-     * Execute a type 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.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>;
-}