@airtop/sdk 0.1.28 → 0.1.30-beta0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +6 -0
- package/Client.js +14 -4
- package/README.md +8 -6
- package/api/resources/extensionConfigurations/client/Client.d.ts +50 -0
- package/api/resources/extensionConfigurations/client/Client.js +214 -0
- package/api/resources/extensionConfigurations/client/index.d.ts +1 -0
- package/api/resources/extensionConfigurations/client/index.js +17 -0
- package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +13 -0
- package/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +5 -0
- package/api/resources/extensionConfigurations/client/requests/index.d.ts +1 -0
- package/api/resources/extensionConfigurations/client/requests/index.js +2 -0
- package/api/resources/extensionConfigurations/index.d.ts +1 -0
- package/api/resources/extensionConfigurations/index.js +17 -0
- package/api/resources/index.d.ts +3 -0
- package/api/resources/index.js +4 -1
- package/api/resources/profiles/client/Client.js +2 -2
- package/api/resources/requests/client/Client.d.ts +34 -0
- package/api/resources/requests/client/Client.js +115 -0
- package/api/resources/requests/client/index.d.ts +1 -0
- package/api/resources/requests/client/index.js +2 -0
- package/api/resources/requests/index.d.ts +1 -0
- package/api/resources/requests/index.js +17 -0
- package/api/resources/sessions/client/Client.js +14 -14
- package/api/resources/windows/client/Client.d.ts +146 -0
- package/api/resources/windows/client/Client.js +788 -28
- package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +23 -0
- package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
- package/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
- package/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
- package/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
- package/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
- package/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +25 -0
- package/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +5 -0
- package/api/resources/windows/client/requests/SessionScrollHandlerRequestBody.d.ts +2 -0
- package/api/resources/windows/client/requests/index.d.ts +12 -0
- package/api/types/AsyncConfig.d.ts +7 -0
- package/api/types/AsyncConfig.js +5 -0
- package/api/types/AsyncSessionAiResponseEnvelope.d.ts +9 -0
- package/api/types/AsyncSessionAiResponseEnvelope.js +5 -0
- package/api/types/BrowserWaitSelectorConfig.d.ts +11 -0
- package/api/types/BrowserWaitSelectorConfig.js +5 -0
- package/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
- package/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
- package/api/types/ExtensionConfigurationOutput.d.ts +13 -0
- package/api/types/ExtensionConfigurationOutput.js +5 -0
- package/api/types/IntervalMonitorConfig.d.ts +9 -0
- package/api/types/IntervalMonitorConfig.js +5 -0
- package/api/types/MonitorConfig.d.ts +14 -0
- package/api/types/MonitorConfig.js +5 -0
- package/api/types/MonitorConfigIncludeVisualAnalysis.d.ts +12 -0
- package/api/types/MonitorConfigIncludeVisualAnalysis.js +11 -0
- package/api/types/MonitorConfigMonitorType.d.ts +11 -0
- package/api/types/MonitorConfigMonitorType.js +10 -0
- package/api/types/RequestStatusResponse.d.ts +8 -0
- package/api/types/RequestStatusResponse.js +5 -0
- package/api/types/SessionConfigV1.d.ts +4 -0
- package/api/types/index.d.ts +10 -0
- package/api/types/index.js +10 -0
- package/dist/Client.d.ts +6 -0
- package/dist/Client.js +14 -4
- package/dist/api/resources/extensionConfigurations/client/Client.d.ts +50 -0
- package/dist/api/resources/extensionConfigurations/client/Client.js +214 -0
- package/dist/api/resources/extensionConfigurations/client/index.d.ts +1 -0
- package/dist/api/resources/extensionConfigurations/client/index.js +17 -0
- package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.d.ts +13 -0
- package/dist/api/resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js +5 -0
- package/dist/api/resources/extensionConfigurations/client/requests/index.d.ts +1 -0
- package/dist/api/resources/extensionConfigurations/client/requests/index.js +2 -0
- package/dist/api/resources/extensionConfigurations/index.d.ts +1 -0
- package/dist/api/resources/extensionConfigurations/index.js +17 -0
- package/dist/api/resources/index.d.ts +3 -0
- package/dist/api/resources/index.js +4 -1
- package/dist/api/resources/profiles/client/Client.js +2 -2
- package/dist/api/resources/requests/client/Client.d.ts +34 -0
- package/dist/api/resources/requests/client/Client.js +115 -0
- package/dist/api/resources/requests/client/index.d.ts +1 -0
- package/dist/api/resources/requests/client/index.js +2 -0
- package/dist/api/resources/requests/index.d.ts +1 -0
- package/dist/api/resources/requests/index.js +17 -0
- package/dist/api/resources/sessions/client/Client.js +14 -14
- package/dist/api/resources/windows/client/Client.d.ts +146 -0
- package/dist/api/resources/windows/client/Client.js +788 -28
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncMonitorRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncPageQueryRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncPromptContentRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/AsyncScreenshotRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/AsyncSummarizeContentRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncTypeRequest.d.ts +37 -0
- package/dist/api/resources/windows/client/requests/AsyncTypeRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionScrollHandlerRequestBody.d.ts +2 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +12 -0
- package/dist/api/types/AsyncConfig.d.ts +7 -0
- package/dist/api/types/AsyncConfig.js +5 -0
- package/dist/api/types/AsyncSessionAiResponseEnvelope.d.ts +9 -0
- package/dist/api/types/AsyncSessionAiResponseEnvelope.js +5 -0
- package/dist/api/types/BrowserWaitSelectorConfig.d.ts +11 -0
- package/dist/api/types/BrowserWaitSelectorConfig.js +5 -0
- package/dist/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
- package/dist/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
- package/dist/api/types/ExtensionConfigurationOutput.d.ts +13 -0
- package/dist/api/types/ExtensionConfigurationOutput.js +5 -0
- package/dist/api/types/IntervalMonitorConfig.d.ts +9 -0
- package/dist/api/types/IntervalMonitorConfig.js +5 -0
- package/dist/api/types/MonitorConfig.d.ts +14 -0
- package/dist/api/types/MonitorConfig.js +5 -0
- package/dist/api/types/MonitorConfigIncludeVisualAnalysis.d.ts +12 -0
- package/dist/api/types/MonitorConfigIncludeVisualAnalysis.js +11 -0
- package/dist/api/types/MonitorConfigMonitorType.d.ts +11 -0
- package/dist/api/types/MonitorConfigMonitorType.js +10 -0
- package/dist/api/types/RequestStatusResponse.d.ts +8 -0
- package/dist/api/types/RequestStatusResponse.js +5 -0
- package/dist/api/types/SessionConfigV1.d.ts +4 -0
- package/dist/api/types/index.d.ts +10 -0
- package/dist/api/types/index.js +10 -0
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +41 -0
- package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +39 -0
- package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +39 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +40 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +41 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +41 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +40 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +41 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +39 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +40 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +45 -0
- package/dist/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +39 -0
- package/dist/serialization/resources/windows/client/requests/SessionScrollHandlerRequestBody.d.ts +1 -0
- package/dist/serialization/resources/windows/client/requests/SessionScrollHandlerRequestBody.js +1 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +12 -0
- package/dist/serialization/resources/windows/client/requests/index.js +25 -1
- package/dist/serialization/types/AsyncConfig.d.ts +12 -0
- package/dist/serialization/types/AsyncConfig.js +33 -0
- package/dist/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
- package/dist/serialization/types/AsyncSessionAiResponseEnvelope.js +36 -0
- package/dist/serialization/types/BrowserWaitSelectorConfig.d.ts +14 -0
- package/dist/serialization/types/BrowserWaitSelectorConfig.js +35 -0
- package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
- package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.js +31 -0
- package/dist/serialization/types/ExtensionConfigurationOutput.d.ts +15 -0
- package/dist/serialization/types/ExtensionConfigurationOutput.js +36 -0
- package/dist/serialization/types/IntervalMonitorConfig.d.ts +13 -0
- package/dist/serialization/types/IntervalMonitorConfig.js +34 -0
- package/dist/serialization/types/MonitorConfig.d.ts +19 -0
- package/dist/serialization/types/MonitorConfig.js +40 -0
- package/dist/serialization/types/MonitorConfigIncludeVisualAnalysis.d.ts +10 -0
- package/dist/serialization/types/MonitorConfigIncludeVisualAnalysis.js +31 -0
- package/dist/serialization/types/MonitorConfigMonitorType.d.ts +10 -0
- package/dist/serialization/types/MonitorConfigMonitorType.js +31 -0
- package/dist/serialization/types/RequestStatusResponse.d.ts +13 -0
- package/dist/serialization/types/RequestStatusResponse.js +34 -0
- package/dist/serialization/types/SessionConfigV1.d.ts +2 -0
- package/dist/serialization/types/SessionConfigV1.js +2 -0
- package/dist/serialization/types/index.d.ts +10 -0
- package/dist/serialization/types/index.js +10 -0
- package/dist/wrapper/AirtopClient.d.ts +1 -0
- package/dist/wrapper/AirtopClient.js +3 -0
- package/dist/wrapper/AirtopWindows.d.ts +13 -3
- package/dist/wrapper/AirtopWindows.js +17 -0
- package/package.json +1 -1
- package/reference.md +1047 -38
- package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncClickRequest.js +41 -0
- package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +39 -0
- package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +39 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +40 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +41 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +41 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +40 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +41 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +39 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +40 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +45 -0
- package/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.d.ts +18 -0
- package/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +39 -0
- package/serialization/resources/windows/client/requests/SessionScrollHandlerRequestBody.d.ts +1 -0
- package/serialization/resources/windows/client/requests/SessionScrollHandlerRequestBody.js +1 -0
- package/serialization/resources/windows/client/requests/index.d.ts +12 -0
- package/serialization/resources/windows/client/requests/index.js +25 -1
- package/serialization/types/AsyncConfig.d.ts +12 -0
- package/serialization/types/AsyncConfig.js +33 -0
- package/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
- package/serialization/types/AsyncSessionAiResponseEnvelope.js +36 -0
- package/serialization/types/BrowserWaitSelectorConfig.d.ts +14 -0
- package/serialization/types/BrowserWaitSelectorConfig.js +35 -0
- package/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
- package/serialization/types/CreateAutomationRequestBodyConfiguration.js +31 -0
- package/serialization/types/ExtensionConfigurationOutput.d.ts +15 -0
- package/serialization/types/ExtensionConfigurationOutput.js +36 -0
- package/serialization/types/IntervalMonitorConfig.d.ts +13 -0
- package/serialization/types/IntervalMonitorConfig.js +34 -0
- package/serialization/types/MonitorConfig.d.ts +19 -0
- package/serialization/types/MonitorConfig.js +40 -0
- package/serialization/types/MonitorConfigIncludeVisualAnalysis.d.ts +10 -0
- package/serialization/types/MonitorConfigIncludeVisualAnalysis.js +31 -0
- package/serialization/types/MonitorConfigMonitorType.d.ts +10 -0
- package/serialization/types/MonitorConfigMonitorType.js +31 -0
- package/serialization/types/RequestStatusResponse.d.ts +13 -0
- package/serialization/types/RequestStatusResponse.js +34 -0
- package/serialization/types/SessionConfigV1.d.ts +2 -0
- package/serialization/types/SessionConfigV1.js +2 -0
- package/serialization/types/index.d.ts +10 -0
- package/serialization/types/index.js +10 -0
- package/wrapper/AirtopClient.d.ts +1 -0
- package/wrapper/AirtopClient.js +3 -0
- package/wrapper/AirtopWindows.d.ts +13 -3
- package/wrapper/AirtopWindows.js +17 -0
package/reference.md
CHANGED
@@ -2,6 +2,832 @@
|
|
2
2
|
|
3
3
|
## Windows
|
4
4
|
|
5
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncClick</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
6
|
+
<dl>
|
7
|
+
<dd>
|
8
|
+
|
9
|
+
#### 📝 Description
|
10
|
+
|
11
|
+
<dl>
|
12
|
+
<dd>
|
13
|
+
|
14
|
+
<dl>
|
15
|
+
<dd>
|
16
|
+
|
17
|
+
Execute a click interaction in a specific browser window asynchronously
|
18
|
+
|
19
|
+
</dd>
|
20
|
+
</dl>
|
21
|
+
</dd>
|
22
|
+
</dl>
|
23
|
+
|
24
|
+
#### 🔌 Usage
|
25
|
+
|
26
|
+
<dl>
|
27
|
+
<dd>
|
28
|
+
|
29
|
+
<dl>
|
30
|
+
<dd>
|
31
|
+
|
32
|
+
```typescript
|
33
|
+
await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
34
|
+
elementDescription: "The login button",
|
35
|
+
});
|
36
|
+
```
|
37
|
+
|
38
|
+
</dd>
|
39
|
+
</dl>
|
40
|
+
</dd>
|
41
|
+
</dl>
|
42
|
+
|
43
|
+
#### ⚙️ Parameters
|
44
|
+
|
45
|
+
<dl>
|
46
|
+
<dd>
|
47
|
+
|
48
|
+
<dl>
|
49
|
+
<dd>
|
50
|
+
|
51
|
+
**sessionId:** `string` — The session id for the window.
|
52
|
+
|
53
|
+
</dd>
|
54
|
+
</dl>
|
55
|
+
|
56
|
+
<dl>
|
57
|
+
<dd>
|
58
|
+
|
59
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
60
|
+
|
61
|
+
</dd>
|
62
|
+
</dl>
|
63
|
+
|
64
|
+
<dl>
|
65
|
+
<dd>
|
66
|
+
|
67
|
+
**request:** `Airtop.AsyncClickRequest`
|
68
|
+
|
69
|
+
</dd>
|
70
|
+
</dl>
|
71
|
+
|
72
|
+
<dl>
|
73
|
+
<dd>
|
74
|
+
|
75
|
+
**requestOptions:** `Windows.RequestOptions`
|
76
|
+
|
77
|
+
</dd>
|
78
|
+
</dl>
|
79
|
+
</dd>
|
80
|
+
</dl>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
</details>
|
85
|
+
|
86
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
87
|
+
<dl>
|
88
|
+
<dd>
|
89
|
+
|
90
|
+
#### 📝 Description
|
91
|
+
|
92
|
+
<dl>
|
93
|
+
<dd>
|
94
|
+
|
95
|
+
<dl>
|
96
|
+
<dd>
|
97
|
+
|
98
|
+
Create an automation of a browser window asynchronously
|
99
|
+
|
100
|
+
</dd>
|
101
|
+
</dl>
|
102
|
+
</dd>
|
103
|
+
</dl>
|
104
|
+
|
105
|
+
#### 🔌 Usage
|
106
|
+
|
107
|
+
<dl>
|
108
|
+
<dd>
|
109
|
+
|
110
|
+
<dl>
|
111
|
+
<dd>
|
112
|
+
|
113
|
+
```typescript
|
114
|
+
await client.windows.asyncCreateAutomation(
|
115
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
116
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
117
|
+
);
|
118
|
+
```
|
119
|
+
|
120
|
+
</dd>
|
121
|
+
</dl>
|
122
|
+
</dd>
|
123
|
+
</dl>
|
124
|
+
|
125
|
+
#### ⚙️ Parameters
|
126
|
+
|
127
|
+
<dl>
|
128
|
+
<dd>
|
129
|
+
|
130
|
+
<dl>
|
131
|
+
<dd>
|
132
|
+
|
133
|
+
**sessionId:** `string` — The session id for the window.
|
134
|
+
|
135
|
+
</dd>
|
136
|
+
</dl>
|
137
|
+
|
138
|
+
<dl>
|
139
|
+
<dd>
|
140
|
+
|
141
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
142
|
+
|
143
|
+
</dd>
|
144
|
+
</dl>
|
145
|
+
|
146
|
+
<dl>
|
147
|
+
<dd>
|
148
|
+
|
149
|
+
**request:** `Airtop.AsyncCreateAutomationRequest`
|
150
|
+
|
151
|
+
</dd>
|
152
|
+
</dl>
|
153
|
+
|
154
|
+
<dl>
|
155
|
+
<dd>
|
156
|
+
|
157
|
+
**requestOptions:** `Windows.RequestOptions`
|
158
|
+
|
159
|
+
</dd>
|
160
|
+
</dl>
|
161
|
+
</dd>
|
162
|
+
</dl>
|
163
|
+
|
164
|
+
</dd>
|
165
|
+
</dl>
|
166
|
+
</details>
|
167
|
+
|
168
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
169
|
+
<dl>
|
170
|
+
<dd>
|
171
|
+
|
172
|
+
#### 📝 Description
|
173
|
+
|
174
|
+
<dl>
|
175
|
+
<dd>
|
176
|
+
|
177
|
+
<dl>
|
178
|
+
<dd>
|
179
|
+
|
180
|
+
Execute an automation of a browser window asynchronously
|
181
|
+
|
182
|
+
</dd>
|
183
|
+
</dl>
|
184
|
+
</dd>
|
185
|
+
</dl>
|
186
|
+
|
187
|
+
#### 🔌 Usage
|
188
|
+
|
189
|
+
<dl>
|
190
|
+
<dd>
|
191
|
+
|
192
|
+
<dl>
|
193
|
+
<dd>
|
194
|
+
|
195
|
+
```typescript
|
196
|
+
await client.windows.asyncExecuteAutomation(
|
197
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
198
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
199
|
+
{
|
200
|
+
automationId: "automationId",
|
201
|
+
}
|
202
|
+
);
|
203
|
+
```
|
204
|
+
|
205
|
+
</dd>
|
206
|
+
</dl>
|
207
|
+
</dd>
|
208
|
+
</dl>
|
209
|
+
|
210
|
+
#### ⚙️ Parameters
|
211
|
+
|
212
|
+
<dl>
|
213
|
+
<dd>
|
214
|
+
|
215
|
+
<dl>
|
216
|
+
<dd>
|
217
|
+
|
218
|
+
**sessionId:** `string` — The session id for the window.
|
219
|
+
|
220
|
+
</dd>
|
221
|
+
</dl>
|
222
|
+
|
223
|
+
<dl>
|
224
|
+
<dd>
|
225
|
+
|
226
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
227
|
+
|
228
|
+
</dd>
|
229
|
+
</dl>
|
230
|
+
|
231
|
+
<dl>
|
232
|
+
<dd>
|
233
|
+
|
234
|
+
**request:** `Airtop.AsyncExecuteAutomationRequest`
|
235
|
+
|
236
|
+
</dd>
|
237
|
+
</dl>
|
238
|
+
|
239
|
+
<dl>
|
240
|
+
<dd>
|
241
|
+
|
242
|
+
**requestOptions:** `Windows.RequestOptions`
|
243
|
+
|
244
|
+
</dd>
|
245
|
+
</dl>
|
246
|
+
</dd>
|
247
|
+
</dl>
|
248
|
+
|
249
|
+
</dd>
|
250
|
+
</dl>
|
251
|
+
</details>
|
252
|
+
|
253
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
254
|
+
<dl>
|
255
|
+
<dd>
|
256
|
+
|
257
|
+
#### 🔌 Usage
|
258
|
+
|
259
|
+
<dl>
|
260
|
+
<dd>
|
261
|
+
|
262
|
+
<dl>
|
263
|
+
<dd>
|
264
|
+
|
265
|
+
```typescript
|
266
|
+
await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
267
|
+
elementDescription: "The search box input in the top right corner",
|
268
|
+
});
|
269
|
+
```
|
270
|
+
|
271
|
+
</dd>
|
272
|
+
</dl>
|
273
|
+
</dd>
|
274
|
+
</dl>
|
275
|
+
|
276
|
+
#### ⚙️ Parameters
|
277
|
+
|
278
|
+
<dl>
|
279
|
+
<dd>
|
280
|
+
|
281
|
+
<dl>
|
282
|
+
<dd>
|
283
|
+
|
284
|
+
**sessionId:** `string` — The session id for the window.
|
285
|
+
|
286
|
+
</dd>
|
287
|
+
</dl>
|
288
|
+
|
289
|
+
<dl>
|
290
|
+
<dd>
|
291
|
+
|
292
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
293
|
+
|
294
|
+
</dd>
|
295
|
+
</dl>
|
296
|
+
|
297
|
+
<dl>
|
298
|
+
<dd>
|
299
|
+
|
300
|
+
**request:** `Airtop.AsyncHoverRequest`
|
301
|
+
|
302
|
+
</dd>
|
303
|
+
</dl>
|
304
|
+
|
305
|
+
<dl>
|
306
|
+
<dd>
|
307
|
+
|
308
|
+
**requestOptions:** `Windows.RequestOptions`
|
309
|
+
|
310
|
+
</dd>
|
311
|
+
</dl>
|
312
|
+
</dd>
|
313
|
+
</dl>
|
314
|
+
|
315
|
+
</dd>
|
316
|
+
</dl>
|
317
|
+
</details>
|
318
|
+
|
319
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
320
|
+
<dl>
|
321
|
+
<dd>
|
322
|
+
|
323
|
+
#### 🔌 Usage
|
324
|
+
|
325
|
+
<dl>
|
326
|
+
<dd>
|
327
|
+
|
328
|
+
<dl>
|
329
|
+
<dd>
|
330
|
+
|
331
|
+
```typescript
|
332
|
+
await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
333
|
+
```
|
334
|
+
|
335
|
+
</dd>
|
336
|
+
</dl>
|
337
|
+
</dd>
|
338
|
+
</dl>
|
339
|
+
|
340
|
+
#### ⚙️ Parameters
|
341
|
+
|
342
|
+
<dl>
|
343
|
+
<dd>
|
344
|
+
|
345
|
+
<dl>
|
346
|
+
<dd>
|
347
|
+
|
348
|
+
**sessionId:** `string` — The session id for the window.
|
349
|
+
|
350
|
+
</dd>
|
351
|
+
</dl>
|
352
|
+
|
353
|
+
<dl>
|
354
|
+
<dd>
|
355
|
+
|
356
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
357
|
+
|
358
|
+
</dd>
|
359
|
+
</dl>
|
360
|
+
|
361
|
+
<dl>
|
362
|
+
<dd>
|
363
|
+
|
364
|
+
**request:** `Airtop.AsyncMonitorRequest`
|
365
|
+
|
366
|
+
</dd>
|
367
|
+
</dl>
|
368
|
+
|
369
|
+
<dl>
|
370
|
+
<dd>
|
371
|
+
|
372
|
+
**requestOptions:** `Windows.RequestOptions`
|
373
|
+
|
374
|
+
</dd>
|
375
|
+
</dl>
|
376
|
+
</dd>
|
377
|
+
</dl>
|
378
|
+
|
379
|
+
</dd>
|
380
|
+
</dl>
|
381
|
+
</details>
|
382
|
+
|
383
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
384
|
+
<dl>
|
385
|
+
<dd>
|
386
|
+
|
387
|
+
#### 🔌 Usage
|
388
|
+
|
389
|
+
<dl>
|
390
|
+
<dd>
|
391
|
+
|
392
|
+
<dl>
|
393
|
+
<dd>
|
394
|
+
|
395
|
+
```typescript
|
396
|
+
await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
397
|
+
prompt: "What is the main idea of this page?",
|
398
|
+
});
|
399
|
+
```
|
400
|
+
|
401
|
+
</dd>
|
402
|
+
</dl>
|
403
|
+
</dd>
|
404
|
+
</dl>
|
405
|
+
|
406
|
+
#### ⚙️ Parameters
|
407
|
+
|
408
|
+
<dl>
|
409
|
+
<dd>
|
410
|
+
|
411
|
+
<dl>
|
412
|
+
<dd>
|
413
|
+
|
414
|
+
**sessionId:** `string` — The session id for the window.
|
415
|
+
|
416
|
+
</dd>
|
417
|
+
</dl>
|
418
|
+
|
419
|
+
<dl>
|
420
|
+
<dd>
|
421
|
+
|
422
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
423
|
+
|
424
|
+
</dd>
|
425
|
+
</dl>
|
426
|
+
|
427
|
+
<dl>
|
428
|
+
<dd>
|
429
|
+
|
430
|
+
**request:** `Airtop.AsyncPageQueryRequest`
|
431
|
+
|
432
|
+
</dd>
|
433
|
+
</dl>
|
434
|
+
|
435
|
+
<dl>
|
436
|
+
<dd>
|
437
|
+
|
438
|
+
**requestOptions:** `Windows.RequestOptions`
|
439
|
+
|
440
|
+
</dd>
|
441
|
+
</dl>
|
442
|
+
</dd>
|
443
|
+
</dl>
|
444
|
+
|
445
|
+
</dd>
|
446
|
+
</dl>
|
447
|
+
</details>
|
448
|
+
|
449
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
450
|
+
<dl>
|
451
|
+
<dd>
|
452
|
+
|
453
|
+
#### 🔌 Usage
|
454
|
+
|
455
|
+
<dl>
|
456
|
+
<dd>
|
457
|
+
|
458
|
+
<dl>
|
459
|
+
<dd>
|
460
|
+
|
461
|
+
```typescript
|
462
|
+
await client.windows.asyncPaginatedExtraction(
|
463
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
464
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
465
|
+
{
|
466
|
+
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.",
|
467
|
+
}
|
468
|
+
);
|
469
|
+
```
|
470
|
+
|
471
|
+
</dd>
|
472
|
+
</dl>
|
473
|
+
</dd>
|
474
|
+
</dl>
|
475
|
+
|
476
|
+
#### ⚙️ Parameters
|
477
|
+
|
478
|
+
<dl>
|
479
|
+
<dd>
|
480
|
+
|
481
|
+
<dl>
|
482
|
+
<dd>
|
483
|
+
|
484
|
+
**sessionId:** `string` — The session id for the window.
|
485
|
+
|
486
|
+
</dd>
|
487
|
+
</dl>
|
488
|
+
|
489
|
+
<dl>
|
490
|
+
<dd>
|
491
|
+
|
492
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
493
|
+
|
494
|
+
</dd>
|
495
|
+
</dl>
|
496
|
+
|
497
|
+
<dl>
|
498
|
+
<dd>
|
499
|
+
|
500
|
+
**request:** `Airtop.AsyncPaginatedExtractionRequest`
|
501
|
+
|
502
|
+
</dd>
|
503
|
+
</dl>
|
504
|
+
|
505
|
+
<dl>
|
506
|
+
<dd>
|
507
|
+
|
508
|
+
**requestOptions:** `Windows.RequestOptions`
|
509
|
+
|
510
|
+
</dd>
|
511
|
+
</dl>
|
512
|
+
</dd>
|
513
|
+
</dl>
|
514
|
+
|
515
|
+
</dd>
|
516
|
+
</dl>
|
517
|
+
</details>
|
518
|
+
|
519
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
520
|
+
<dl>
|
521
|
+
<dd>
|
522
|
+
|
523
|
+
#### 📝 Description
|
524
|
+
|
525
|
+
<dl>
|
526
|
+
<dd>
|
527
|
+
|
528
|
+
<dl>
|
529
|
+
<dd>
|
530
|
+
|
531
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
532
|
+
|
533
|
+
</dd>
|
534
|
+
</dl>
|
535
|
+
</dd>
|
536
|
+
</dl>
|
537
|
+
|
538
|
+
#### 🔌 Usage
|
539
|
+
|
540
|
+
<dl>
|
541
|
+
<dd>
|
542
|
+
|
543
|
+
<dl>
|
544
|
+
<dd>
|
545
|
+
|
546
|
+
```typescript
|
547
|
+
await client.windows.asyncPromptContent(
|
548
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
549
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
550
|
+
{
|
551
|
+
prompt: "What is the main idea of this page?",
|
552
|
+
}
|
553
|
+
);
|
554
|
+
```
|
555
|
+
|
556
|
+
</dd>
|
557
|
+
</dl>
|
558
|
+
</dd>
|
559
|
+
</dl>
|
560
|
+
|
561
|
+
#### ⚙️ Parameters
|
562
|
+
|
563
|
+
<dl>
|
564
|
+
<dd>
|
565
|
+
|
566
|
+
<dl>
|
567
|
+
<dd>
|
568
|
+
|
569
|
+
**sessionId:** `string` — The session id for the window.
|
570
|
+
|
571
|
+
</dd>
|
572
|
+
</dl>
|
573
|
+
|
574
|
+
<dl>
|
575
|
+
<dd>
|
576
|
+
|
577
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
578
|
+
|
579
|
+
</dd>
|
580
|
+
</dl>
|
581
|
+
|
582
|
+
<dl>
|
583
|
+
<dd>
|
584
|
+
|
585
|
+
**request:** `Airtop.AsyncPromptContentRequest`
|
586
|
+
|
587
|
+
</dd>
|
588
|
+
</dl>
|
589
|
+
|
590
|
+
<dl>
|
591
|
+
<dd>
|
592
|
+
|
593
|
+
**requestOptions:** `Windows.RequestOptions`
|
594
|
+
|
595
|
+
</dd>
|
596
|
+
</dl>
|
597
|
+
</dd>
|
598
|
+
</dl>
|
599
|
+
|
600
|
+
</dd>
|
601
|
+
</dl>
|
602
|
+
</details>
|
603
|
+
|
604
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
605
|
+
<dl>
|
606
|
+
<dd>
|
607
|
+
|
608
|
+
#### 📝 Description
|
609
|
+
|
610
|
+
<dl>
|
611
|
+
<dd>
|
612
|
+
|
613
|
+
<dl>
|
614
|
+
<dd>
|
615
|
+
|
616
|
+
Take a screenshot of the current viewport of a browser window asynchronously
|
617
|
+
|
618
|
+
</dd>
|
619
|
+
</dl>
|
620
|
+
</dd>
|
621
|
+
</dl>
|
622
|
+
|
623
|
+
#### 🔌 Usage
|
624
|
+
|
625
|
+
<dl>
|
626
|
+
<dd>
|
627
|
+
|
628
|
+
<dl>
|
629
|
+
<dd>
|
630
|
+
|
631
|
+
```typescript
|
632
|
+
await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
633
|
+
```
|
634
|
+
|
635
|
+
</dd>
|
636
|
+
</dl>
|
637
|
+
</dd>
|
638
|
+
</dl>
|
639
|
+
|
640
|
+
#### ⚙️ Parameters
|
641
|
+
|
642
|
+
<dl>
|
643
|
+
<dd>
|
644
|
+
|
645
|
+
<dl>
|
646
|
+
<dd>
|
647
|
+
|
648
|
+
**sessionId:** `string` — The session id for the window.
|
649
|
+
|
650
|
+
</dd>
|
651
|
+
</dl>
|
652
|
+
|
653
|
+
<dl>
|
654
|
+
<dd>
|
655
|
+
|
656
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
657
|
+
|
658
|
+
</dd>
|
659
|
+
</dl>
|
660
|
+
|
661
|
+
<dl>
|
662
|
+
<dd>
|
663
|
+
|
664
|
+
**request:** `Airtop.AsyncScreenshotRequest`
|
665
|
+
|
666
|
+
</dd>
|
667
|
+
</dl>
|
668
|
+
|
669
|
+
<dl>
|
670
|
+
<dd>
|
671
|
+
|
672
|
+
**requestOptions:** `Windows.RequestOptions`
|
673
|
+
|
674
|
+
</dd>
|
675
|
+
</dl>
|
676
|
+
</dd>
|
677
|
+
</dl>
|
678
|
+
|
679
|
+
</dd>
|
680
|
+
</dl>
|
681
|
+
</details>
|
682
|
+
|
683
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
684
|
+
<dl>
|
685
|
+
<dd>
|
686
|
+
|
687
|
+
#### 📝 Description
|
688
|
+
|
689
|
+
<dl>
|
690
|
+
<dd>
|
691
|
+
|
692
|
+
<dl>
|
693
|
+
<dd>
|
694
|
+
|
695
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
696
|
+
|
697
|
+
</dd>
|
698
|
+
</dl>
|
699
|
+
</dd>
|
700
|
+
</dl>
|
701
|
+
|
702
|
+
#### 🔌 Usage
|
703
|
+
|
704
|
+
<dl>
|
705
|
+
<dd>
|
706
|
+
|
707
|
+
<dl>
|
708
|
+
<dd>
|
709
|
+
|
710
|
+
```typescript
|
711
|
+
await client.windows.asyncSummarizeContent(
|
712
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
713
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
714
|
+
);
|
715
|
+
```
|
716
|
+
|
717
|
+
</dd>
|
718
|
+
</dl>
|
719
|
+
</dd>
|
720
|
+
</dl>
|
721
|
+
|
722
|
+
#### ⚙️ Parameters
|
723
|
+
|
724
|
+
<dl>
|
725
|
+
<dd>
|
726
|
+
|
727
|
+
<dl>
|
728
|
+
<dd>
|
729
|
+
|
730
|
+
**sessionId:** `string` — The session id for the window.
|
731
|
+
|
732
|
+
</dd>
|
733
|
+
</dl>
|
734
|
+
|
735
|
+
<dl>
|
736
|
+
<dd>
|
737
|
+
|
738
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
739
|
+
|
740
|
+
</dd>
|
741
|
+
</dl>
|
742
|
+
|
743
|
+
<dl>
|
744
|
+
<dd>
|
745
|
+
|
746
|
+
**request:** `Airtop.AsyncSummarizeContentRequest`
|
747
|
+
|
748
|
+
</dd>
|
749
|
+
</dl>
|
750
|
+
|
751
|
+
<dl>
|
752
|
+
<dd>
|
753
|
+
|
754
|
+
**requestOptions:** `Windows.RequestOptions`
|
755
|
+
|
756
|
+
</dd>
|
757
|
+
</dl>
|
758
|
+
</dd>
|
759
|
+
</dl>
|
760
|
+
|
761
|
+
</dd>
|
762
|
+
</dl>
|
763
|
+
</details>
|
764
|
+
|
765
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
766
|
+
<dl>
|
767
|
+
<dd>
|
768
|
+
|
769
|
+
#### 🔌 Usage
|
770
|
+
|
771
|
+
<dl>
|
772
|
+
<dd>
|
773
|
+
|
774
|
+
<dl>
|
775
|
+
<dd>
|
776
|
+
|
777
|
+
```typescript
|
778
|
+
await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
779
|
+
text: "Example text",
|
780
|
+
});
|
781
|
+
```
|
782
|
+
|
783
|
+
</dd>
|
784
|
+
</dl>
|
785
|
+
</dd>
|
786
|
+
</dl>
|
787
|
+
|
788
|
+
#### ⚙️ Parameters
|
789
|
+
|
790
|
+
<dl>
|
791
|
+
<dd>
|
792
|
+
|
793
|
+
<dl>
|
794
|
+
<dd>
|
795
|
+
|
796
|
+
**sessionId:** `string` — The session id for the window.
|
797
|
+
|
798
|
+
</dd>
|
799
|
+
</dl>
|
800
|
+
|
801
|
+
<dl>
|
802
|
+
<dd>
|
803
|
+
|
804
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
805
|
+
|
806
|
+
</dd>
|
807
|
+
</dl>
|
808
|
+
|
809
|
+
<dl>
|
810
|
+
<dd>
|
811
|
+
|
812
|
+
**request:** `Airtop.AsyncTypeRequest`
|
813
|
+
|
814
|
+
</dd>
|
815
|
+
</dl>
|
816
|
+
|
817
|
+
<dl>
|
818
|
+
<dd>
|
819
|
+
|
820
|
+
**requestOptions:** `Windows.RequestOptions`
|
821
|
+
|
822
|
+
</dd>
|
823
|
+
</dl>
|
824
|
+
</dd>
|
825
|
+
</dl>
|
826
|
+
|
827
|
+
</dd>
|
828
|
+
</dl>
|
829
|
+
</details>
|
830
|
+
|
5
831
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
|
6
832
|
<dl>
|
7
833
|
<dd>
|
@@ -468,6 +1294,70 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
468
1294
|
</dl>
|
469
1295
|
</details>
|
470
1296
|
|
1297
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1298
|
+
<dl>
|
1299
|
+
<dd>
|
1300
|
+
|
1301
|
+
#### 🔌 Usage
|
1302
|
+
|
1303
|
+
<dl>
|
1304
|
+
<dd>
|
1305
|
+
|
1306
|
+
<dl>
|
1307
|
+
<dd>
|
1308
|
+
|
1309
|
+
```typescript
|
1310
|
+
await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1311
|
+
```
|
1312
|
+
|
1313
|
+
</dd>
|
1314
|
+
</dl>
|
1315
|
+
</dd>
|
1316
|
+
</dl>
|
1317
|
+
|
1318
|
+
#### ⚙️ Parameters
|
1319
|
+
|
1320
|
+
<dl>
|
1321
|
+
<dd>
|
1322
|
+
|
1323
|
+
<dl>
|
1324
|
+
<dd>
|
1325
|
+
|
1326
|
+
**sessionId:** `string` — The session id for the window.
|
1327
|
+
|
1328
|
+
</dd>
|
1329
|
+
</dl>
|
1330
|
+
|
1331
|
+
<dl>
|
1332
|
+
<dd>
|
1333
|
+
|
1334
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1335
|
+
|
1336
|
+
</dd>
|
1337
|
+
</dl>
|
1338
|
+
|
1339
|
+
<dl>
|
1340
|
+
<dd>
|
1341
|
+
|
1342
|
+
**request:** `Airtop.SessionMonitorHandlerRequestBody`
|
1343
|
+
|
1344
|
+
</dd>
|
1345
|
+
</dl>
|
1346
|
+
|
1347
|
+
<dl>
|
1348
|
+
<dd>
|
1349
|
+
|
1350
|
+
**requestOptions:** `Windows.RequestOptions`
|
1351
|
+
|
1352
|
+
</dd>
|
1353
|
+
</dl>
|
1354
|
+
</dd>
|
1355
|
+
</dl>
|
1356
|
+
|
1357
|
+
</dd>
|
1358
|
+
</dl>
|
1359
|
+
</details>
|
1360
|
+
|
471
1361
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
472
1362
|
<dl>
|
473
1363
|
<dd>
|
@@ -1112,9 +2002,9 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1112
2002
|
</dl>
|
1113
2003
|
</details>
|
1114
2004
|
|
1115
|
-
##
|
2005
|
+
## ExtensionConfigurations
|
1116
2006
|
|
1117
|
-
<details><summary><code>client.
|
2007
|
+
<details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationDelete</a>({ ...params }) -> void</code></summary>
|
1118
2008
|
<dl>
|
1119
2009
|
<dd>
|
1120
2010
|
|
@@ -1126,7 +2016,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1126
2016
|
<dl>
|
1127
2017
|
<dd>
|
1128
2018
|
|
1129
|
-
Delete
|
2019
|
+
Delete extension configurations matching by name
|
1130
2020
|
|
1131
2021
|
</dd>
|
1132
2022
|
</dl>
|
@@ -1142,7 +2032,7 @@ Delete profiles matching by id
|
|
1142
2032
|
<dd>
|
1143
2033
|
|
1144
2034
|
```typescript
|
1145
|
-
await client.
|
2035
|
+
await client.extensionConfigurations.extensionConfigurationDelete();
|
1146
2036
|
```
|
1147
2037
|
|
1148
2038
|
</dd>
|
@@ -1158,7 +2048,7 @@ await client.profiles.delete();
|
|
1158
2048
|
<dl>
|
1159
2049
|
<dd>
|
1160
2050
|
|
1161
|
-
**request:** `Airtop.
|
2051
|
+
**request:** `Airtop.ExtensionConfigurationDeleteRequest`
|
1162
2052
|
|
1163
2053
|
</dd>
|
1164
2054
|
</dl>
|
@@ -1166,7 +2056,7 @@ await client.profiles.delete();
|
|
1166
2056
|
<dl>
|
1167
2057
|
<dd>
|
1168
2058
|
|
1169
|
-
**requestOptions:** `
|
2059
|
+
**requestOptions:** `ExtensionConfigurations.RequestOptions`
|
1170
2060
|
|
1171
2061
|
</dd>
|
1172
2062
|
</dl>
|
@@ -1177,9 +2067,72 @@ await client.profiles.delete();
|
|
1177
2067
|
</dl>
|
1178
2068
|
</details>
|
1179
2069
|
|
1180
|
-
|
2070
|
+
<details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationGetInfo</a>(name) -> Airtop.ExtensionConfigurationOutput</code></summary>
|
2071
|
+
<dl>
|
2072
|
+
<dd>
|
1181
2073
|
|
1182
|
-
|
2074
|
+
#### 📝 Description
|
2075
|
+
|
2076
|
+
<dl>
|
2077
|
+
<dd>
|
2078
|
+
|
2079
|
+
<dl>
|
2080
|
+
<dd>
|
2081
|
+
|
2082
|
+
Get an extension configuration by name
|
2083
|
+
|
2084
|
+
</dd>
|
2085
|
+
</dl>
|
2086
|
+
</dd>
|
2087
|
+
</dl>
|
2088
|
+
|
2089
|
+
#### 🔌 Usage
|
2090
|
+
|
2091
|
+
<dl>
|
2092
|
+
<dd>
|
2093
|
+
|
2094
|
+
<dl>
|
2095
|
+
<dd>
|
2096
|
+
|
2097
|
+
```typescript
|
2098
|
+
await client.extensionConfigurations.extensionConfigurationGetInfo("my-configuration");
|
2099
|
+
```
|
2100
|
+
|
2101
|
+
</dd>
|
2102
|
+
</dl>
|
2103
|
+
</dd>
|
2104
|
+
</dl>
|
2105
|
+
|
2106
|
+
#### ⚙️ Parameters
|
2107
|
+
|
2108
|
+
<dl>
|
2109
|
+
<dd>
|
2110
|
+
|
2111
|
+
<dl>
|
2112
|
+
<dd>
|
2113
|
+
|
2114
|
+
**name:** `string` — Name of the extension configuration to get
|
2115
|
+
|
2116
|
+
</dd>
|
2117
|
+
</dl>
|
2118
|
+
|
2119
|
+
<dl>
|
2120
|
+
<dd>
|
2121
|
+
|
2122
|
+
**requestOptions:** `ExtensionConfigurations.RequestOptions`
|
2123
|
+
|
2124
|
+
</dd>
|
2125
|
+
</dl>
|
2126
|
+
</dd>
|
2127
|
+
</dl>
|
2128
|
+
|
2129
|
+
</dd>
|
2130
|
+
</dl>
|
2131
|
+
</details>
|
2132
|
+
|
2133
|
+
## Profiles
|
2134
|
+
|
2135
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
1183
2136
|
<dl>
|
1184
2137
|
<dd>
|
1185
2138
|
|
@@ -1191,7 +2144,7 @@ await client.profiles.delete();
|
|
1191
2144
|
<dl>
|
1192
2145
|
<dd>
|
1193
2146
|
|
1194
|
-
|
2147
|
+
Delete profiles matching by id
|
1195
2148
|
|
1196
2149
|
</dd>
|
1197
2150
|
</dl>
|
@@ -1207,10 +2160,7 @@ Get a list of sessions by ID
|
|
1207
2160
|
<dd>
|
1208
2161
|
|
1209
2162
|
```typescript
|
1210
|
-
await client.
|
1211
|
-
offset: 1,
|
1212
|
-
limit: 10,
|
1213
|
-
});
|
2163
|
+
await client.profiles.delete();
|
1214
2164
|
```
|
1215
2165
|
|
1216
2166
|
</dd>
|
@@ -1226,7 +2176,7 @@ await client.sessions.list({
|
|
1226
2176
|
<dl>
|
1227
2177
|
<dd>
|
1228
2178
|
|
1229
|
-
**request:** `Airtop.
|
2179
|
+
**request:** `Airtop.ProfilesDeleteRequest`
|
1230
2180
|
|
1231
2181
|
</dd>
|
1232
2182
|
</dl>
|
@@ -1234,7 +2184,7 @@ await client.sessions.list({
|
|
1234
2184
|
<dl>
|
1235
2185
|
<dd>
|
1236
2186
|
|
1237
|
-
**requestOptions:** `
|
2187
|
+
**requestOptions:** `Profiles.RequestOptions`
|
1238
2188
|
|
1239
2189
|
</dd>
|
1240
2190
|
</dl>
|
@@ -1245,7 +2195,9 @@ await client.sessions.list({
|
|
1245
2195
|
</dl>
|
1246
2196
|
</details>
|
1247
2197
|
|
1248
|
-
|
2198
|
+
## Requests
|
2199
|
+
|
2200
|
+
<details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
|
1249
2201
|
<dl>
|
1250
2202
|
<dd>
|
1251
2203
|
|
@@ -1258,7 +2210,7 @@ await client.sessions.list({
|
|
1258
2210
|
<dd>
|
1259
2211
|
|
1260
2212
|
```typescript
|
1261
|
-
await client.
|
2213
|
+
await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
1262
2214
|
```
|
1263
2215
|
|
1264
2216
|
</dd>
|
@@ -1274,7 +2226,7 @@ await client.sessions.create();
|
|
1274
2226
|
<dl>
|
1275
2227
|
<dd>
|
1276
2228
|
|
1277
|
-
**
|
2229
|
+
**requestId:** `string` — The ID of the request to check.
|
1278
2230
|
|
1279
2231
|
</dd>
|
1280
2232
|
</dl>
|
@@ -1282,7 +2234,7 @@ await client.sessions.create();
|
|
1282
2234
|
<dl>
|
1283
2235
|
<dd>
|
1284
2236
|
|
1285
|
-
**requestOptions:** `
|
2237
|
+
**requestOptions:** `Requests.RequestOptions`
|
1286
2238
|
|
1287
2239
|
</dd>
|
1288
2240
|
</dl>
|
@@ -1293,7 +2245,9 @@ await client.sessions.create();
|
|
1293
2245
|
</dl>
|
1294
2246
|
</details>
|
1295
2247
|
|
1296
|
-
|
2248
|
+
## Sessions
|
2249
|
+
|
2250
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
|
1297
2251
|
<dl>
|
1298
2252
|
<dd>
|
1299
2253
|
|
@@ -1305,7 +2259,7 @@ await client.sessions.create();
|
|
1305
2259
|
<dl>
|
1306
2260
|
<dd>
|
1307
2261
|
|
1308
|
-
Get a
|
2262
|
+
Get a list of sessions by ID
|
1309
2263
|
|
1310
2264
|
</dd>
|
1311
2265
|
</dl>
|
@@ -1321,7 +2275,10 @@ Get a session by ID
|
|
1321
2275
|
<dd>
|
1322
2276
|
|
1323
2277
|
```typescript
|
1324
|
-
await client.sessions.
|
2278
|
+
await client.sessions.list({
|
2279
|
+
offset: 1,
|
2280
|
+
limit: 10,
|
2281
|
+
});
|
1325
2282
|
```
|
1326
2283
|
|
1327
2284
|
</dd>
|
@@ -1337,7 +2294,7 @@ await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
1337
2294
|
<dl>
|
1338
2295
|
<dd>
|
1339
2296
|
|
1340
|
-
**
|
2297
|
+
**request:** `Airtop.SessionsListRequest`
|
1341
2298
|
|
1342
2299
|
</dd>
|
1343
2300
|
</dl>
|
@@ -1356,7 +2313,55 @@ await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
1356
2313
|
</dl>
|
1357
2314
|
</details>
|
1358
2315
|
|
1359
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">
|
2316
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">create</a>({ ...params }) -> Airtop.SessionResponse</code></summary>
|
2317
|
+
<dl>
|
2318
|
+
<dd>
|
2319
|
+
|
2320
|
+
#### 🔌 Usage
|
2321
|
+
|
2322
|
+
<dl>
|
2323
|
+
<dd>
|
2324
|
+
|
2325
|
+
<dl>
|
2326
|
+
<dd>
|
2327
|
+
|
2328
|
+
```typescript
|
2329
|
+
await client.sessions.create();
|
2330
|
+
```
|
2331
|
+
|
2332
|
+
</dd>
|
2333
|
+
</dl>
|
2334
|
+
</dd>
|
2335
|
+
</dl>
|
2336
|
+
|
2337
|
+
#### ⚙️ Parameters
|
2338
|
+
|
2339
|
+
<dl>
|
2340
|
+
<dd>
|
2341
|
+
|
2342
|
+
<dl>
|
2343
|
+
<dd>
|
2344
|
+
|
2345
|
+
**request:** `Airtop.SessionRestInputV1`
|
2346
|
+
|
2347
|
+
</dd>
|
2348
|
+
</dl>
|
2349
|
+
|
2350
|
+
<dl>
|
2351
|
+
<dd>
|
2352
|
+
|
2353
|
+
**requestOptions:** `Sessions.RequestOptions`
|
2354
|
+
|
2355
|
+
</dd>
|
2356
|
+
</dl>
|
2357
|
+
</dd>
|
2358
|
+
</dl>
|
2359
|
+
|
2360
|
+
</dd>
|
2361
|
+
</dl>
|
2362
|
+
</details>
|
2363
|
+
|
2364
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getInfo</a>(id) -> Airtop.SessionResponse</code></summary>
|
1360
2365
|
<dl>
|
1361
2366
|
<dd>
|
1362
2367
|
|
@@ -1368,7 +2373,7 @@ await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
1368
2373
|
<dl>
|
1369
2374
|
<dd>
|
1370
2375
|
|
1371
|
-
|
2376
|
+
Get a session by ID
|
1372
2377
|
|
1373
2378
|
</dd>
|
1374
2379
|
</dl>
|
@@ -1384,7 +2389,7 @@ Ends a session by ID. If a given session id does not exist within the organizati
|
|
1384
2389
|
<dd>
|
1385
2390
|
|
1386
2391
|
```typescript
|
1387
|
-
await client.sessions.
|
2392
|
+
await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
1388
2393
|
```
|
1389
2394
|
|
1390
2395
|
</dd>
|
@@ -1400,7 +2405,7 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
1400
2405
|
<dl>
|
1401
2406
|
<dd>
|
1402
2407
|
|
1403
|
-
**id:** `string` —
|
2408
|
+
**id:** `string` — Id of the session to get
|
1404
2409
|
|
1405
2410
|
</dd>
|
1406
2411
|
</dl>
|
@@ -1419,11 +2424,11 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
1419
2424
|
</dl>
|
1420
2425
|
</details>
|
1421
2426
|
|
1422
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">
|
2427
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">terminate</a>(id) -> void</code></summary>
|
1423
2428
|
<dl>
|
1424
2429
|
<dd>
|
1425
2430
|
|
1426
|
-
####
|
2431
|
+
#### 📝 Description
|
1427
2432
|
|
1428
2433
|
<dl>
|
1429
2434
|
<dd>
|
@@ -1431,19 +2436,14 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
1431
2436
|
<dl>
|
1432
2437
|
<dd>
|
1433
2438
|
|
1434
|
-
|
1435
|
-
await client.sessions.saveExtensionConfigurationOnTermination(
|
1436
|
-
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
1437
|
-
"myExtensionConfiguration"
|
1438
|
-
);
|
1439
|
-
```
|
2439
|
+
Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
|
1440
2440
|
|
1441
2441
|
</dd>
|
1442
2442
|
</dl>
|
1443
2443
|
</dd>
|
1444
2444
|
</dl>
|
1445
2445
|
|
1446
|
-
####
|
2446
|
+
#### 🔌 Usage
|
1447
2447
|
|
1448
2448
|
<dl>
|
1449
2449
|
<dd>
|
@@ -1451,15 +2451,24 @@ await client.sessions.saveExtensionConfigurationOnTermination(
|
|
1451
2451
|
<dl>
|
1452
2452
|
<dd>
|
1453
2453
|
|
1454
|
-
|
2454
|
+
```typescript
|
2455
|
+
await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
2456
|
+
```
|
1455
2457
|
|
1456
2458
|
</dd>
|
1457
2459
|
</dl>
|
2460
|
+
</dd>
|
2461
|
+
</dl>
|
2462
|
+
|
2463
|
+
#### ⚙️ Parameters
|
1458
2464
|
|
1459
2465
|
<dl>
|
1460
2466
|
<dd>
|
1461
2467
|
|
1462
|
-
|
2468
|
+
<dl>
|
2469
|
+
<dd>
|
2470
|
+
|
2471
|
+
**id:** `string` — ID of the session to delete.
|
1463
2472
|
|
1464
2473
|
</dd>
|
1465
2474
|
</dl>
|