@airtop/sdk 0.1.37-beta1 → 0.1.37

package/reference.md

@@ -2,619 +2,25 @@
 
 ## Windows
 
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncClick</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Execute a click interaction in a specific browser window asynchronously
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-    elementDescription: "The login button",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — The session id for the window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**windowId:** `string` — The Airtop window id of the browser window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Airtop.AsyncClickRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Windows.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Create an automation of a browser window asynchronously
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.asyncCreateAutomation(
-    "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
-    "0334da2a-91b0-42c5-6156-76a5eba87430",
-);
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — The session id for the window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**windowId:** `string` — The Airtop window id of the browser window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Airtop.AsyncCreateAutomationRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Windows.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Create a form filler automation asynchronously
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.asyncCreateFormFiller(
-    "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
-    "0334da2a-91b0-42c5-6156-76a5eba87430",
-);
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — The session id for the window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**windowId:** `string` — The Airtop window id of the browser window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Airtop.AsyncCreateFormFillerRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Windows.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Execute an automation of a browser window asynchronously
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.asyncExecuteAutomation(
-    "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
-    "0334da2a-91b0-42c5-6156-76a5eba87430",
-    {
-        automationId: "automationId",
-    },
-);
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — The session id for the window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**windowId:** `string` — The Airtop window id of the browser window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Airtop.AsyncExecuteAutomationRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Windows.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Fill a form of a browser window asynchronously using a form-filler automation
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-    automationId: "automationId",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — The session id for the window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**windowId:** `string` — The Airtop window id of the browser window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Airtop.AsyncFillFormRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Windows.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-    elementDescription: "The search box input in the top right corner",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — The session id for the window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**windowId:** `string` — The Airtop window id of the browser window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Airtop.AsyncHoverRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Windows.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-    condition: "Determine if the user appears to be signed in to the website",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — The session id for the window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**windowId:** `string` — The Airtop window id of the browser window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Airtop.AsyncMonitorRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Windows.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-    prompt: "What is the main idea of this page?",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — The session id for the window.
-
-</dd>
-</dl>
-
+<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
 <dl>
 <dd>
 
-**windowId:** `string` — The Airtop window id of the browser window.
-
-</dd>
-</dl>
+#### 📝 Description
 
 <dl>
 <dd>
 
-**request:** `Airtop.AsyncPageQueryRequest`
-
-</dd>
-</dl>
-
 <dl>
 <dd>
 
-**requestOptions:** `Windows.RequestOptions`
+Create an automation of a browser window asynchronously
 
 </dd>
 </dl>
 </dd>
 </dl>
 
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
 #### 🔌 Usage
 
 <dl>
@@ -624,12 +30,9 @@ await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "033
 <dd>
 
 ```typescript
-await client.windows.asyncPaginatedExtraction(
+await client.windows.asyncCreateAutomation(
     "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.",
-    },
 );
 ```
 
@@ -662,7 +65,7 @@ await client.windows.asyncPaginatedExtraction(
 <dl>
 <dd>
 
-**request:** `Airtop.AsyncPaginatedExtractionRequest`
+**request:** `Airtop.AsyncCreateAutomationRequest`
 
 </dd>
 </dl>
@@ -681,7 +84,7 @@ await client.windows.asyncPaginatedExtraction(
 </dl>
 </details>
 
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
+<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
 <dl>
 <dd>
 
@@ -693,7 +96,7 @@ await client.windows.asyncPaginatedExtraction(
 <dl>
 <dd>
 
-This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
+Create a form filler automation asynchronously
 
 </dd>
 </dl>
@@ -709,12 +112,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
 <dd>
 
 ```typescript
-await client.windows.asyncPromptContent(
+await client.windows.asyncCreateFormFiller(
     "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
     "0334da2a-91b0-42c5-6156-76a5eba87430",
-    {
-        prompt: "What is the main idea of this page?",
-    },
 );
 ```
 
@@ -747,7 +147,7 @@ await client.windows.asyncPromptContent(
 <dl>
 <dd>
 
-**request:** `Airtop.AsyncPromptContentRequest`
+**request:** `Airtop.AsyncCreateFormFillerRequest`
 
 </dd>
 </dl>
@@ -766,7 +166,7 @@ await client.windows.asyncPromptContent(
 </dl>
 </details>
 
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
+<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
 <dl>
 <dd>
 
@@ -778,7 +178,7 @@ await client.windows.asyncPromptContent(
 <dl>
 <dd>
 
-Take a screenshot of the current viewport of a browser window asynchronously
+Execute an automation of a browser window asynchronously
 
 </dd>
 </dl>
@@ -794,7 +194,13 @@ Take a screenshot of the current viewport of a browser window asynchronously
 <dd>
 
 ```typescript
-await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
+await client.windows.asyncExecuteAutomation(
+    "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
+    "0334da2a-91b0-42c5-6156-76a5eba87430",
+    {
+        automationId: "automationId",
+    },
+);
 ```
 
 </dd>
@@ -826,7 +232,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
 <dl>
 <dd>
 
-**request:** `Airtop.AsyncScreenshotRequest`
+**request:** `Airtop.AsyncExecuteAutomationRequest`
 
 </dd>
 </dl>
@@ -845,7 +251,7 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
 </dl>
 </details>
 
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
+<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
 <dl>
 <dd>
 
@@ -857,80 +263,13 @@ await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "03
 <dl>
 <dd>
 
-This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.asyncSummarizeContent(
-    "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
-    "0334da2a-91b0-42c5-6156-76a5eba87430",
-);
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — The session id for the window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**windowId:** `string` — The Airtop window id of the browser window to summarize.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Airtop.AsyncSummarizeContentRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Windows.RequestOptions`
+Fill a form of a browser window asynchronously using a form-filler automation
 
 </dd>
 </dl>
 </dd>
 </dl>
 
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
-<dl>
-<dd>
-
 #### 🔌 Usage
 
 <dl>
@@ -940,8 +279,8 @@ await client.windows.asyncSummarizeContent(
 <dd>
 
 ```typescript
-await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-    text: "Example text",
+await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+    automationId: "automationId",
 });
 ```
 
@@ -974,7 +313,7 @@ await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
 <dl>
 <dd>
 
-**request:** `Airtop.AsyncTypeRequest`
+**request:** `Airtop.AsyncFillFormRequest`
 
 </dd>
 </dl>
@@ -1685,87 +1024,6 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
 </dl>
 </details>
 
-<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">operatorPrompt</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncOperatorPromptResponseEnvelope</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Prompt OpenAI Operator
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.windows.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
-    prompt: "What is the latest news about OpenAI?",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**sessionId:** `string` — ID of the session that owns the window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**windowId:** `string` — Airtop window ID of the browser window.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Airtop.OperatorPromptV1Body`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Windows.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
 <dl>
 <dd>