@airtop/sdk 0.1.13 → 0.1.15-beta0

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

@@ -23,6 +23,114 @@ 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>;
+    /**
+     * @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")
+     */
+    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")
+     */
+    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.
+     *
      * @param {string} sessionId - ID of the session that owns the window.
      * @param {Airtop.CreateWindowInputV1Body} request
      * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
@@ -32,6 +140,8 @@ export declare class Windows {
      */
     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
@@ -44,6 +154,8 @@ export declare class Windows {
      */
     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
@@ -56,6 +168,8 @@ export declare class Windows {
      */
     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.
@@ -65,6 +179,8 @@ export declare class Windows {
      */
     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
@@ -77,6 +193,8 @@ export declare class Windows {
      */
     click(sessionId: string, windowId: string, request: Airtop.SessionClickHandlerRequestBody, 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
@@ -87,6 +205,18 @@ export declare class Windows {
      */
     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")
+     */
+    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
@@ -99,6 +229,8 @@ export declare class Windows {
      */
     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
@@ -123,6 +255,8 @@ export declare class Windows {
      */
     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
@@ -132,6 +266,18 @@ export declare class Windows {
      *     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>;
     /**
      * This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
      *
@@ -145,6 +291,8 @@ export declare class Windows {
      */
     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