@airtop/sdk 0.1.18 → 0.1.26-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/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 +128 -0
- package/api/resources/windows/client/Client.js +717 -26
- package/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
- package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +25 -0
- package/api/resources/windows/client/requests/AsyncMonitorRequest.d.ts +27 -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 +25 -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 +27 -0
- package/api/resources/windows/client/requests/SessionScrollHandlerRequestBody.js +5 -0
- package/api/resources/windows/client/requests/index.d.ts +11 -0
- package/api/types/AirtopProxyConfiguration.d.ts +9 -0
- package/api/types/AirtopProxyConfiguration.js +5 -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/ExtensionConfigurationOutput.d.ts +13 -0
- package/api/types/ExtensionConfigurationOutput.js +5 -0
- package/api/types/ExternalSessionWithConnectionInfo.d.ts +1 -1
- 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/PageQueryConfig.d.ts +2 -0
- package/api/types/PaginatedExtractionConfig.d.ts +3 -0
- package/api/types/Proxy.d.ts +9 -6
- package/api/types/ProxyConfigurationKind.d.ts +9 -0
- package/api/types/ProxyConfigurationKind.js +5 -0
- package/api/types/ProxyCredentials.d.ts +11 -0
- package/api/types/ProxyCredentials.js +5 -0
- package/api/types/RequestStatusResponse.d.ts +8 -0
- package/api/types/RequestStatusResponse.js +5 -0
- package/api/types/ScrapeConfig.d.ts +7 -0
- package/api/types/ScrapeConfig.js +5 -0
- package/api/types/ScrollByConfig.d.ts +9 -0
- package/api/types/ScrollByConfig.js +5 -0
- package/api/types/ScrollToEdgeConfig.d.ts +9 -0
- package/api/types/ScrollToEdgeConfig.js +5 -0
- package/api/types/SessionConfigV1.d.ts +5 -1
- package/api/types/SessionConfigV1Proxy.d.ts +4 -4
- package/api/types/VisualAnalysisConfig.d.ts +1 -1
- package/api/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +3 -2
- package/api/types/VisualAnalysisConfigResultSelectionStrategy.js +1 -0
- package/api/types/Window.d.ts +2 -0
- package/api/types/index.d.ts +15 -2
- package/api/types/index.js +15 -2
- package/biome.json +66 -0
- package/config/tsconfig-nobase.json +16 -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 +128 -0
- package/dist/api/resources/windows/client/Client.js +717 -26
- 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/AsyncHoverRequest.d.ts +25 -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 +25 -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 +27 -0
- package/dist/api/resources/windows/client/requests/SessionScrollHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +11 -0
- package/dist/api/types/AirtopProxyConfiguration.d.ts +9 -0
- package/dist/api/types/AirtopProxyConfiguration.js +5 -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/ExtensionConfigurationOutput.d.ts +13 -0
- package/dist/api/types/ExtensionConfigurationOutput.js +5 -0
- package/dist/api/types/ExternalSessionWithConnectionInfo.d.ts +1 -1
- 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/PageQueryConfig.d.ts +2 -0
- package/dist/api/types/PaginatedExtractionConfig.d.ts +3 -0
- package/dist/api/types/Proxy.d.ts +9 -6
- package/dist/api/types/ProxyConfigurationKind.d.ts +9 -0
- package/dist/api/types/ProxyConfigurationKind.js +5 -0
- package/dist/api/types/ProxyCredentials.d.ts +11 -0
- package/dist/api/types/ProxyCredentials.js +5 -0
- package/dist/api/types/RequestStatusResponse.d.ts +8 -0
- package/dist/api/types/RequestStatusResponse.js +5 -0
- package/dist/api/types/ScrapeConfig.d.ts +7 -0
- package/dist/api/types/ScrapeConfig.js +5 -0
- package/dist/api/types/ScrollByConfig.d.ts +9 -0
- package/dist/api/types/ScrollByConfig.js +5 -0
- package/dist/api/types/ScrollToEdgeConfig.d.ts +9 -0
- package/dist/api/types/ScrollToEdgeConfig.js +5 -0
- package/dist/api/types/SessionConfigV1.d.ts +5 -1
- package/dist/api/types/SessionConfigV1Proxy.d.ts +4 -4
- package/dist/api/types/VisualAnalysisConfig.d.ts +1 -1
- package/dist/api/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +3 -2
- package/dist/api/types/VisualAnalysisConfigResultSelectionStrategy.js +1 -0
- package/dist/api/types/Window.d.ts +2 -0
- package/dist/api/types/index.d.ts +15 -2
- package/dist/api/types/index.js +15 -2
- 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/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 +21 -0
- package/dist/serialization/resources/windows/client/requests/SessionScrollHandlerRequestBody.js +42 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +11 -0
- package/dist/serialization/resources/windows/client/requests/index.js +23 -1
- package/dist/serialization/types/AirtopProxyConfiguration.d.ts +13 -0
- package/dist/serialization/types/{SessionConfigV1ProxyItem.js → AirtopProxyConfiguration.js} +4 -5
- package/dist/serialization/types/AsyncConfig.d.ts +12 -0
- package/{serialization/types/SessionConfigV1ProxyItem.js → dist/serialization/types/AsyncConfig.js} +3 -5
- 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/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/PageQueryConfig.d.ts +2 -0
- package/dist/serialization/types/PageQueryConfig.js +2 -0
- package/dist/serialization/types/PaginatedExtractionConfig.d.ts +2 -0
- package/dist/serialization/types/PaginatedExtractionConfig.js +2 -0
- package/dist/serialization/types/Proxy.d.ts +4 -6
- package/dist/serialization/types/Proxy.js +3 -5
- package/dist/serialization/types/ProxyConfigurationKind.d.ts +14 -0
- package/dist/serialization/types/{CustomProxy.js → ProxyConfigurationKind.js} +5 -2
- package/dist/serialization/types/ProxyCredentials.d.ts +14 -0
- package/dist/serialization/types/ProxyCredentials.js +35 -0
- package/dist/serialization/types/RequestStatusResponse.d.ts +13 -0
- package/dist/serialization/types/RequestStatusResponse.js +34 -0
- package/dist/serialization/types/ScrapeConfig.d.ts +12 -0
- package/dist/serialization/types/ScrapeConfig.js +33 -0
- package/dist/serialization/types/ScrollByConfig.d.ts +13 -0
- package/dist/serialization/types/ScrollByConfig.js +34 -0
- package/dist/serialization/types/ScrollToEdgeConfig.d.ts +13 -0
- package/dist/serialization/types/ScrollToEdgeConfig.js +34 -0
- package/dist/serialization/types/SessionConfigV1.d.ts +2 -0
- package/dist/serialization/types/SessionConfigV1.js +2 -0
- package/dist/serialization/types/SessionConfigV1Proxy.d.ts +3 -3
- package/dist/serialization/types/SessionConfigV1Proxy.js +4 -4
- package/dist/serialization/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +1 -1
- package/dist/serialization/types/VisualAnalysisConfigResultSelectionStrategy.js +1 -1
- package/dist/serialization/types/Window.d.ts +1 -0
- package/dist/serialization/types/Window.js +1 -0
- package/dist/serialization/types/index.d.ts +15 -2
- package/dist/serialization/types/index.js +15 -2
- package/dist/utils/batch-operate/SessionQueue.d.ts +4 -4
- package/dist/utils/batch-operate/SessionQueue.js +11 -12
- package/dist/utils/batch-operate/WindowQueue.d.ts +3 -3
- package/dist/utils/batch-operate/WindowQueue.js +23 -11
- package/dist/utils/batch-operate/batch-util.d.ts +2 -2
- package/dist/utils/batch-operate/batch-util.js +5 -5
- package/dist/utils/batch-operate/helpers.d.ts +1 -1
- package/dist/utils/batch-operate/types.d.ts +1 -1
- package/dist/utils/index.d.ts +3 -3
- package/dist/utils/process-screenshots.d.ts +1 -1
- package/dist/utils/process-screenshots.js +4 -4
- package/dist/wrapper/AirtopClient.d.ts +2 -1
- package/dist/wrapper/AirtopClient.js +6 -3
- package/dist/wrapper/AirtopSessions.d.ts +2 -2
- package/dist/wrapper/AirtopSessions.js +4 -4
- package/dist/wrapper/AirtopWindows.d.ts +19 -9
- package/dist/wrapper/AirtopWindows.js +28 -11
- package/lefthook.yml +23 -0
- package/package.json +9 -3
- package/reference.md +1059 -84
- 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/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 +21 -0
- package/serialization/resources/windows/client/requests/SessionScrollHandlerRequestBody.js +42 -0
- package/serialization/resources/windows/client/requests/index.d.ts +11 -0
- package/serialization/resources/windows/client/requests/index.js +23 -1
- package/serialization/types/AirtopProxyConfiguration.d.ts +13 -0
- package/serialization/types/AirtopProxyConfiguration.js +34 -0
- 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/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/PageQueryConfig.d.ts +2 -0
- package/serialization/types/PageQueryConfig.js +2 -0
- package/serialization/types/PaginatedExtractionConfig.d.ts +2 -0
- package/serialization/types/PaginatedExtractionConfig.js +2 -0
- package/serialization/types/Proxy.d.ts +4 -6
- package/serialization/types/Proxy.js +3 -5
- package/serialization/types/ProxyConfigurationKind.d.ts +14 -0
- package/serialization/types/{CustomProxy.js → ProxyConfigurationKind.js} +5 -2
- package/serialization/types/ProxyCredentials.d.ts +14 -0
- package/serialization/types/ProxyCredentials.js +35 -0
- package/serialization/types/RequestStatusResponse.d.ts +13 -0
- package/serialization/types/RequestStatusResponse.js +34 -0
- package/serialization/types/ScrapeConfig.d.ts +12 -0
- package/serialization/types/ScrapeConfig.js +33 -0
- package/serialization/types/ScrollByConfig.d.ts +13 -0
- package/serialization/types/ScrollByConfig.js +34 -0
- package/serialization/types/ScrollToEdgeConfig.d.ts +13 -0
- package/serialization/types/ScrollToEdgeConfig.js +34 -0
- package/serialization/types/SessionConfigV1.d.ts +2 -0
- package/serialization/types/SessionConfigV1.js +2 -0
- package/serialization/types/SessionConfigV1Proxy.d.ts +3 -3
- package/serialization/types/SessionConfigV1Proxy.js +4 -4
- package/serialization/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +1 -1
- package/serialization/types/VisualAnalysisConfigResultSelectionStrategy.js +1 -1
- package/serialization/types/Window.d.ts +1 -0
- package/serialization/types/Window.js +1 -0
- package/serialization/types/index.d.ts +15 -2
- package/serialization/types/index.js +15 -2
- package/utils/batch-operate/SessionQueue.d.ts +4 -4
- package/utils/batch-operate/SessionQueue.js +11 -12
- package/utils/batch-operate/WindowQueue.d.ts +3 -3
- package/utils/batch-operate/WindowQueue.js +23 -11
- package/utils/batch-operate/batch-util.d.ts +2 -2
- package/utils/batch-operate/batch-util.js +5 -5
- package/utils/batch-operate/helpers.d.ts +1 -1
- package/utils/batch-operate/types.d.ts +1 -1
- package/utils/index.d.ts +3 -3
- package/utils/process-screenshots.d.ts +1 -1
- package/utils/process-screenshots.js +4 -4
- package/wrapper/AirtopClient.d.ts +2 -1
- package/wrapper/AirtopClient.js +6 -3
- package/wrapper/AirtopSessions.d.ts +2 -2
- package/wrapper/AirtopSessions.js +4 -4
- package/wrapper/AirtopWindows.d.ts +19 -9
- package/wrapper/AirtopWindows.js +28 -11
- package/api/types/CustomProxy.d.ts +0 -14
- package/api/types/SessionConfigV1ProxyItem.d.ts +0 -12
- package/dist/api/types/CustomProxy.d.ts +0 -14
- package/dist/api/types/SessionConfigV1ProxyItem.d.ts +0 -12
- package/dist/serialization/types/CustomProxy.d.ts +0 -11
- package/dist/serialization/types/SessionConfigV1ProxyItem.d.ts +0 -14
- package/serialization/types/CustomProxy.d.ts +0 -11
- package/serialization/types/SessionConfigV1ProxyItem.d.ts +0 -14
- /package/api/{types/CustomProxy.js → resources/extensionConfigurations/client/requests/ExtensionConfigurationDeleteRequest.js} +0 -0
- /package/api/{types/SessionConfigV1ProxyItem.js → resources/windows/client/requests/AsyncClickRequest.js} +0 -0
- /package/{dist/api/types/CustomProxy.js → api/resources/windows/client/requests/AsyncHoverRequest.js} +0 -0
- /package/{dist/api/types/SessionConfigV1ProxyItem.js → api/resources/windows/client/requests/AsyncMonitorRequest.js} +0 -0
package/reference.md
CHANGED
@@ -2,6 +2,660 @@
|
|
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">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
87
|
+
<dl>
|
88
|
+
<dd>
|
89
|
+
|
90
|
+
#### 🔌 Usage
|
91
|
+
|
92
|
+
<dl>
|
93
|
+
<dd>
|
94
|
+
|
95
|
+
<dl>
|
96
|
+
<dd>
|
97
|
+
|
98
|
+
```typescript
|
99
|
+
await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
100
|
+
```
|
101
|
+
|
102
|
+
</dd>
|
103
|
+
</dl>
|
104
|
+
</dd>
|
105
|
+
</dl>
|
106
|
+
|
107
|
+
#### ⚙️ Parameters
|
108
|
+
|
109
|
+
<dl>
|
110
|
+
<dd>
|
111
|
+
|
112
|
+
<dl>
|
113
|
+
<dd>
|
114
|
+
|
115
|
+
**sessionId:** `string` — The session id for the window.
|
116
|
+
|
117
|
+
</dd>
|
118
|
+
</dl>
|
119
|
+
|
120
|
+
<dl>
|
121
|
+
<dd>
|
122
|
+
|
123
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
124
|
+
|
125
|
+
</dd>
|
126
|
+
</dl>
|
127
|
+
|
128
|
+
<dl>
|
129
|
+
<dd>
|
130
|
+
|
131
|
+
**request:** `Airtop.AsyncHoverRequest`
|
132
|
+
|
133
|
+
</dd>
|
134
|
+
</dl>
|
135
|
+
|
136
|
+
<dl>
|
137
|
+
<dd>
|
138
|
+
|
139
|
+
**requestOptions:** `Windows.RequestOptions`
|
140
|
+
|
141
|
+
</dd>
|
142
|
+
</dl>
|
143
|
+
</dd>
|
144
|
+
</dl>
|
145
|
+
|
146
|
+
</dd>
|
147
|
+
</dl>
|
148
|
+
</details>
|
149
|
+
|
150
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
151
|
+
<dl>
|
152
|
+
<dd>
|
153
|
+
|
154
|
+
#### 🔌 Usage
|
155
|
+
|
156
|
+
<dl>
|
157
|
+
<dd>
|
158
|
+
|
159
|
+
<dl>
|
160
|
+
<dd>
|
161
|
+
|
162
|
+
```typescript
|
163
|
+
await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
164
|
+
```
|
165
|
+
|
166
|
+
</dd>
|
167
|
+
</dl>
|
168
|
+
</dd>
|
169
|
+
</dl>
|
170
|
+
|
171
|
+
#### ⚙️ Parameters
|
172
|
+
|
173
|
+
<dl>
|
174
|
+
<dd>
|
175
|
+
|
176
|
+
<dl>
|
177
|
+
<dd>
|
178
|
+
|
179
|
+
**sessionId:** `string` — The session id for the window.
|
180
|
+
|
181
|
+
</dd>
|
182
|
+
</dl>
|
183
|
+
|
184
|
+
<dl>
|
185
|
+
<dd>
|
186
|
+
|
187
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
188
|
+
|
189
|
+
</dd>
|
190
|
+
</dl>
|
191
|
+
|
192
|
+
<dl>
|
193
|
+
<dd>
|
194
|
+
|
195
|
+
**request:** `Airtop.AsyncMonitorRequest`
|
196
|
+
|
197
|
+
</dd>
|
198
|
+
</dl>
|
199
|
+
|
200
|
+
<dl>
|
201
|
+
<dd>
|
202
|
+
|
203
|
+
**requestOptions:** `Windows.RequestOptions`
|
204
|
+
|
205
|
+
</dd>
|
206
|
+
</dl>
|
207
|
+
</dd>
|
208
|
+
</dl>
|
209
|
+
|
210
|
+
</dd>
|
211
|
+
</dl>
|
212
|
+
</details>
|
213
|
+
|
214
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
215
|
+
<dl>
|
216
|
+
<dd>
|
217
|
+
|
218
|
+
#### 🔌 Usage
|
219
|
+
|
220
|
+
<dl>
|
221
|
+
<dd>
|
222
|
+
|
223
|
+
<dl>
|
224
|
+
<dd>
|
225
|
+
|
226
|
+
```typescript
|
227
|
+
await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
228
|
+
prompt: "What is the main idea of this page?",
|
229
|
+
});
|
230
|
+
```
|
231
|
+
|
232
|
+
</dd>
|
233
|
+
</dl>
|
234
|
+
</dd>
|
235
|
+
</dl>
|
236
|
+
|
237
|
+
#### ⚙️ Parameters
|
238
|
+
|
239
|
+
<dl>
|
240
|
+
<dd>
|
241
|
+
|
242
|
+
<dl>
|
243
|
+
<dd>
|
244
|
+
|
245
|
+
**sessionId:** `string` — The session id for the window.
|
246
|
+
|
247
|
+
</dd>
|
248
|
+
</dl>
|
249
|
+
|
250
|
+
<dl>
|
251
|
+
<dd>
|
252
|
+
|
253
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
254
|
+
|
255
|
+
</dd>
|
256
|
+
</dl>
|
257
|
+
|
258
|
+
<dl>
|
259
|
+
<dd>
|
260
|
+
|
261
|
+
**request:** `Airtop.AsyncPageQueryRequest`
|
262
|
+
|
263
|
+
</dd>
|
264
|
+
</dl>
|
265
|
+
|
266
|
+
<dl>
|
267
|
+
<dd>
|
268
|
+
|
269
|
+
**requestOptions:** `Windows.RequestOptions`
|
270
|
+
|
271
|
+
</dd>
|
272
|
+
</dl>
|
273
|
+
</dd>
|
274
|
+
</dl>
|
275
|
+
|
276
|
+
</dd>
|
277
|
+
</dl>
|
278
|
+
</details>
|
279
|
+
|
280
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
281
|
+
<dl>
|
282
|
+
<dd>
|
283
|
+
|
284
|
+
#### 🔌 Usage
|
285
|
+
|
286
|
+
<dl>
|
287
|
+
<dd>
|
288
|
+
|
289
|
+
<dl>
|
290
|
+
<dd>
|
291
|
+
|
292
|
+
```typescript
|
293
|
+
await client.windows.asyncPaginatedExtraction(
|
294
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
295
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
296
|
+
);
|
297
|
+
```
|
298
|
+
|
299
|
+
</dd>
|
300
|
+
</dl>
|
301
|
+
</dd>
|
302
|
+
</dl>
|
303
|
+
|
304
|
+
#### ⚙️ Parameters
|
305
|
+
|
306
|
+
<dl>
|
307
|
+
<dd>
|
308
|
+
|
309
|
+
<dl>
|
310
|
+
<dd>
|
311
|
+
|
312
|
+
**sessionId:** `string` — The session id for the window.
|
313
|
+
|
314
|
+
</dd>
|
315
|
+
</dl>
|
316
|
+
|
317
|
+
<dl>
|
318
|
+
<dd>
|
319
|
+
|
320
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
321
|
+
|
322
|
+
</dd>
|
323
|
+
</dl>
|
324
|
+
|
325
|
+
<dl>
|
326
|
+
<dd>
|
327
|
+
|
328
|
+
**request:** `Airtop.AsyncPaginatedExtractionRequest`
|
329
|
+
|
330
|
+
</dd>
|
331
|
+
</dl>
|
332
|
+
|
333
|
+
<dl>
|
334
|
+
<dd>
|
335
|
+
|
336
|
+
**requestOptions:** `Windows.RequestOptions`
|
337
|
+
|
338
|
+
</dd>
|
339
|
+
</dl>
|
340
|
+
</dd>
|
341
|
+
</dl>
|
342
|
+
|
343
|
+
</dd>
|
344
|
+
</dl>
|
345
|
+
</details>
|
346
|
+
|
347
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
348
|
+
<dl>
|
349
|
+
<dd>
|
350
|
+
|
351
|
+
#### 📝 Description
|
352
|
+
|
353
|
+
<dl>
|
354
|
+
<dd>
|
355
|
+
|
356
|
+
<dl>
|
357
|
+
<dd>
|
358
|
+
|
359
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
360
|
+
|
361
|
+
</dd>
|
362
|
+
</dl>
|
363
|
+
</dd>
|
364
|
+
</dl>
|
365
|
+
|
366
|
+
#### 🔌 Usage
|
367
|
+
|
368
|
+
<dl>
|
369
|
+
<dd>
|
370
|
+
|
371
|
+
<dl>
|
372
|
+
<dd>
|
373
|
+
|
374
|
+
```typescript
|
375
|
+
await client.windows.asyncPromptContent(
|
376
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
377
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
378
|
+
{
|
379
|
+
prompt: "What is the main idea of this page?",
|
380
|
+
}
|
381
|
+
);
|
382
|
+
```
|
383
|
+
|
384
|
+
</dd>
|
385
|
+
</dl>
|
386
|
+
</dd>
|
387
|
+
</dl>
|
388
|
+
|
389
|
+
#### ⚙️ Parameters
|
390
|
+
|
391
|
+
<dl>
|
392
|
+
<dd>
|
393
|
+
|
394
|
+
<dl>
|
395
|
+
<dd>
|
396
|
+
|
397
|
+
**sessionId:** `string` — The session id for the window.
|
398
|
+
|
399
|
+
</dd>
|
400
|
+
</dl>
|
401
|
+
|
402
|
+
<dl>
|
403
|
+
<dd>
|
404
|
+
|
405
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
406
|
+
|
407
|
+
</dd>
|
408
|
+
</dl>
|
409
|
+
|
410
|
+
<dl>
|
411
|
+
<dd>
|
412
|
+
|
413
|
+
**request:** `Airtop.AsyncPromptContentRequest`
|
414
|
+
|
415
|
+
</dd>
|
416
|
+
</dl>
|
417
|
+
|
418
|
+
<dl>
|
419
|
+
<dd>
|
420
|
+
|
421
|
+
**requestOptions:** `Windows.RequestOptions`
|
422
|
+
|
423
|
+
</dd>
|
424
|
+
</dl>
|
425
|
+
</dd>
|
426
|
+
</dl>
|
427
|
+
|
428
|
+
</dd>
|
429
|
+
</dl>
|
430
|
+
</details>
|
431
|
+
|
432
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
433
|
+
<dl>
|
434
|
+
<dd>
|
435
|
+
|
436
|
+
#### 📝 Description
|
437
|
+
|
438
|
+
<dl>
|
439
|
+
<dd>
|
440
|
+
|
441
|
+
<dl>
|
442
|
+
<dd>
|
443
|
+
|
444
|
+
Take a screenshot of the current viewport of a browser window asynchronously
|
445
|
+
|
446
|
+
</dd>
|
447
|
+
</dl>
|
448
|
+
</dd>
|
449
|
+
</dl>
|
450
|
+
|
451
|
+
#### 🔌 Usage
|
452
|
+
|
453
|
+
<dl>
|
454
|
+
<dd>
|
455
|
+
|
456
|
+
<dl>
|
457
|
+
<dd>
|
458
|
+
|
459
|
+
```typescript
|
460
|
+
await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
461
|
+
```
|
462
|
+
|
463
|
+
</dd>
|
464
|
+
</dl>
|
465
|
+
</dd>
|
466
|
+
</dl>
|
467
|
+
|
468
|
+
#### ⚙️ Parameters
|
469
|
+
|
470
|
+
<dl>
|
471
|
+
<dd>
|
472
|
+
|
473
|
+
<dl>
|
474
|
+
<dd>
|
475
|
+
|
476
|
+
**sessionId:** `string` — The session id for the window.
|
477
|
+
|
478
|
+
</dd>
|
479
|
+
</dl>
|
480
|
+
|
481
|
+
<dl>
|
482
|
+
<dd>
|
483
|
+
|
484
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
485
|
+
|
486
|
+
</dd>
|
487
|
+
</dl>
|
488
|
+
|
489
|
+
<dl>
|
490
|
+
<dd>
|
491
|
+
|
492
|
+
**request:** `Airtop.AsyncScreenshotRequest`
|
493
|
+
|
494
|
+
</dd>
|
495
|
+
</dl>
|
496
|
+
|
497
|
+
<dl>
|
498
|
+
<dd>
|
499
|
+
|
500
|
+
**requestOptions:** `Windows.RequestOptions`
|
501
|
+
|
502
|
+
</dd>
|
503
|
+
</dl>
|
504
|
+
</dd>
|
505
|
+
</dl>
|
506
|
+
|
507
|
+
</dd>
|
508
|
+
</dl>
|
509
|
+
</details>
|
510
|
+
|
511
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
512
|
+
<dl>
|
513
|
+
<dd>
|
514
|
+
|
515
|
+
#### 📝 Description
|
516
|
+
|
517
|
+
<dl>
|
518
|
+
<dd>
|
519
|
+
|
520
|
+
<dl>
|
521
|
+
<dd>
|
522
|
+
|
523
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
524
|
+
|
525
|
+
</dd>
|
526
|
+
</dl>
|
527
|
+
</dd>
|
528
|
+
</dl>
|
529
|
+
|
530
|
+
#### 🔌 Usage
|
531
|
+
|
532
|
+
<dl>
|
533
|
+
<dd>
|
534
|
+
|
535
|
+
<dl>
|
536
|
+
<dd>
|
537
|
+
|
538
|
+
```typescript
|
539
|
+
await client.windows.asyncSummarizeContent(
|
540
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
541
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
542
|
+
);
|
543
|
+
```
|
544
|
+
|
545
|
+
</dd>
|
546
|
+
</dl>
|
547
|
+
</dd>
|
548
|
+
</dl>
|
549
|
+
|
550
|
+
#### ⚙️ Parameters
|
551
|
+
|
552
|
+
<dl>
|
553
|
+
<dd>
|
554
|
+
|
555
|
+
<dl>
|
556
|
+
<dd>
|
557
|
+
|
558
|
+
**sessionId:** `string` — The session id for the window.
|
559
|
+
|
560
|
+
</dd>
|
561
|
+
</dl>
|
562
|
+
|
563
|
+
<dl>
|
564
|
+
<dd>
|
565
|
+
|
566
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
567
|
+
|
568
|
+
</dd>
|
569
|
+
</dl>
|
570
|
+
|
571
|
+
<dl>
|
572
|
+
<dd>
|
573
|
+
|
574
|
+
**request:** `Airtop.AsyncSummarizeContentRequest`
|
575
|
+
|
576
|
+
</dd>
|
577
|
+
</dl>
|
578
|
+
|
579
|
+
<dl>
|
580
|
+
<dd>
|
581
|
+
|
582
|
+
**requestOptions:** `Windows.RequestOptions`
|
583
|
+
|
584
|
+
</dd>
|
585
|
+
</dl>
|
586
|
+
</dd>
|
587
|
+
</dl>
|
588
|
+
|
589
|
+
</dd>
|
590
|
+
</dl>
|
591
|
+
</details>
|
592
|
+
|
593
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
594
|
+
<dl>
|
595
|
+
<dd>
|
596
|
+
|
597
|
+
#### 🔌 Usage
|
598
|
+
|
599
|
+
<dl>
|
600
|
+
<dd>
|
601
|
+
|
602
|
+
<dl>
|
603
|
+
<dd>
|
604
|
+
|
605
|
+
```typescript
|
606
|
+
await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
607
|
+
text: "Example text",
|
608
|
+
});
|
609
|
+
```
|
610
|
+
|
611
|
+
</dd>
|
612
|
+
</dl>
|
613
|
+
</dd>
|
614
|
+
</dl>
|
615
|
+
|
616
|
+
#### ⚙️ Parameters
|
617
|
+
|
618
|
+
<dl>
|
619
|
+
<dd>
|
620
|
+
|
621
|
+
<dl>
|
622
|
+
<dd>
|
623
|
+
|
624
|
+
**sessionId:** `string` — The session id for the window.
|
625
|
+
|
626
|
+
</dd>
|
627
|
+
</dl>
|
628
|
+
|
629
|
+
<dl>
|
630
|
+
<dd>
|
631
|
+
|
632
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
633
|
+
|
634
|
+
</dd>
|
635
|
+
</dl>
|
636
|
+
|
637
|
+
<dl>
|
638
|
+
<dd>
|
639
|
+
|
640
|
+
**request:** `Airtop.AsyncTypeRequest`
|
641
|
+
|
642
|
+
</dd>
|
643
|
+
</dl>
|
644
|
+
|
645
|
+
<dl>
|
646
|
+
<dd>
|
647
|
+
|
648
|
+
**requestOptions:** `Windows.RequestOptions`
|
649
|
+
|
650
|
+
</dd>
|
651
|
+
</dl>
|
652
|
+
</dd>
|
653
|
+
</dl>
|
654
|
+
|
655
|
+
</dd>
|
656
|
+
</dl>
|
657
|
+
</details>
|
658
|
+
|
5
659
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
|
6
660
|
<dl>
|
7
661
|
<dd>
|
@@ -14,7 +668,240 @@
|
|
14
668
|
<dl>
|
15
669
|
<dd>
|
16
670
|
|
17
|
-
Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
|
671
|
+
Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
|
672
|
+
|
673
|
+
</dd>
|
674
|
+
</dl>
|
675
|
+
</dd>
|
676
|
+
</dl>
|
677
|
+
|
678
|
+
#### 🔌 Usage
|
679
|
+
|
680
|
+
<dl>
|
681
|
+
<dd>
|
682
|
+
|
683
|
+
<dl>
|
684
|
+
<dd>
|
685
|
+
|
686
|
+
```typescript
|
687
|
+
await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
688
|
+
```
|
689
|
+
|
690
|
+
</dd>
|
691
|
+
</dl>
|
692
|
+
</dd>
|
693
|
+
</dl>
|
694
|
+
|
695
|
+
#### ⚙️ Parameters
|
696
|
+
|
697
|
+
<dl>
|
698
|
+
<dd>
|
699
|
+
|
700
|
+
<dl>
|
701
|
+
<dd>
|
702
|
+
|
703
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
704
|
+
|
705
|
+
</dd>
|
706
|
+
</dl>
|
707
|
+
|
708
|
+
<dl>
|
709
|
+
<dd>
|
710
|
+
|
711
|
+
**request:** `Airtop.CreateWindowInputV1Body`
|
712
|
+
|
713
|
+
</dd>
|
714
|
+
</dl>
|
715
|
+
|
716
|
+
<dl>
|
717
|
+
<dd>
|
718
|
+
|
719
|
+
**requestOptions:** `Windows.RequestOptions`
|
720
|
+
|
721
|
+
</dd>
|
722
|
+
</dl>
|
723
|
+
</dd>
|
724
|
+
</dl>
|
725
|
+
|
726
|
+
</dd>
|
727
|
+
</dl>
|
728
|
+
</details>
|
729
|
+
|
730
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
|
731
|
+
<dl>
|
732
|
+
<dd>
|
733
|
+
|
734
|
+
#### 📝 Description
|
735
|
+
|
736
|
+
<dl>
|
737
|
+
<dd>
|
738
|
+
|
739
|
+
<dl>
|
740
|
+
<dd>
|
741
|
+
|
742
|
+
Get information about a browser window in a session, including the live view url.
|
743
|
+
|
744
|
+
</dd>
|
745
|
+
</dl>
|
746
|
+
</dd>
|
747
|
+
</dl>
|
748
|
+
|
749
|
+
#### 🔌 Usage
|
750
|
+
|
751
|
+
<dl>
|
752
|
+
<dd>
|
753
|
+
|
754
|
+
<dl>
|
755
|
+
<dd>
|
756
|
+
|
757
|
+
```typescript
|
758
|
+
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
759
|
+
screenResolution: "1280x720",
|
760
|
+
});
|
761
|
+
```
|
762
|
+
|
763
|
+
</dd>
|
764
|
+
</dl>
|
765
|
+
</dd>
|
766
|
+
</dl>
|
767
|
+
|
768
|
+
#### ⚙️ Parameters
|
769
|
+
|
770
|
+
<dl>
|
771
|
+
<dd>
|
772
|
+
|
773
|
+
<dl>
|
774
|
+
<dd>
|
775
|
+
|
776
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
777
|
+
|
778
|
+
</dd>
|
779
|
+
</dl>
|
780
|
+
|
781
|
+
<dl>
|
782
|
+
<dd>
|
783
|
+
|
784
|
+
**windowId:** `string` — 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.
|
785
|
+
|
786
|
+
</dd>
|
787
|
+
</dl>
|
788
|
+
|
789
|
+
<dl>
|
790
|
+
<dd>
|
791
|
+
|
792
|
+
**request:** `Airtop.GetWindowInfoRequest`
|
793
|
+
|
794
|
+
</dd>
|
795
|
+
</dl>
|
796
|
+
|
797
|
+
<dl>
|
798
|
+
<dd>
|
799
|
+
|
800
|
+
**requestOptions:** `Windows.RequestOptions`
|
801
|
+
|
802
|
+
</dd>
|
803
|
+
</dl>
|
804
|
+
</dd>
|
805
|
+
</dl>
|
806
|
+
|
807
|
+
</dd>
|
808
|
+
</dl>
|
809
|
+
</details>
|
810
|
+
|
811
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
|
812
|
+
<dl>
|
813
|
+
<dd>
|
814
|
+
|
815
|
+
#### 📝 Description
|
816
|
+
|
817
|
+
<dl>
|
818
|
+
<dd>
|
819
|
+
|
820
|
+
<dl>
|
821
|
+
<dd>
|
822
|
+
|
823
|
+
Loads a specified url on a given window
|
824
|
+
|
825
|
+
</dd>
|
826
|
+
</dl>
|
827
|
+
</dd>
|
828
|
+
</dl>
|
829
|
+
|
830
|
+
#### 🔌 Usage
|
831
|
+
|
832
|
+
<dl>
|
833
|
+
<dd>
|
834
|
+
|
835
|
+
<dl>
|
836
|
+
<dd>
|
837
|
+
|
838
|
+
```typescript
|
839
|
+
await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
840
|
+
url: "https://www.airtop.ai",
|
841
|
+
});
|
842
|
+
```
|
843
|
+
|
844
|
+
</dd>
|
845
|
+
</dl>
|
846
|
+
</dd>
|
847
|
+
</dl>
|
848
|
+
|
849
|
+
#### ⚙️ Parameters
|
850
|
+
|
851
|
+
<dl>
|
852
|
+
<dd>
|
853
|
+
|
854
|
+
<dl>
|
855
|
+
<dd>
|
856
|
+
|
857
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
858
|
+
|
859
|
+
</dd>
|
860
|
+
</dl>
|
861
|
+
|
862
|
+
<dl>
|
863
|
+
<dd>
|
864
|
+
|
865
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
866
|
+
|
867
|
+
</dd>
|
868
|
+
</dl>
|
869
|
+
|
870
|
+
<dl>
|
871
|
+
<dd>
|
872
|
+
|
873
|
+
**request:** `Airtop.WindowLoadUrlV1Body`
|
874
|
+
|
875
|
+
</dd>
|
876
|
+
</dl>
|
877
|
+
|
878
|
+
<dl>
|
879
|
+
<dd>
|
880
|
+
|
881
|
+
**requestOptions:** `Windows.RequestOptions`
|
882
|
+
|
883
|
+
</dd>
|
884
|
+
</dl>
|
885
|
+
</dd>
|
886
|
+
</dl>
|
887
|
+
|
888
|
+
</dd>
|
889
|
+
</dl>
|
890
|
+
</details>
|
891
|
+
|
892
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
|
893
|
+
<dl>
|
894
|
+
<dd>
|
895
|
+
|
896
|
+
#### 📝 Description
|
897
|
+
|
898
|
+
<dl>
|
899
|
+
<dd>
|
900
|
+
|
901
|
+
<dl>
|
902
|
+
<dd>
|
903
|
+
|
904
|
+
Closes a browser window in a session
|
18
905
|
|
19
906
|
</dd>
|
20
907
|
</dl>
|
@@ -30,7 +917,7 @@ Creates a new browser window in a session. Optionally, you can specify a url to
|
|
30
917
|
<dd>
|
31
918
|
|
32
919
|
```typescript
|
33
|
-
await client.windows.
|
920
|
+
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
34
921
|
```
|
35
922
|
|
36
923
|
</dd>
|
@@ -54,7 +941,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
54
941
|
<dl>
|
55
942
|
<dd>
|
56
943
|
|
57
|
-
**
|
944
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
58
945
|
|
59
946
|
</dd>
|
60
947
|
</dl>
|
@@ -73,7 +960,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
73
960
|
</dl>
|
74
961
|
</details>
|
75
962
|
|
76
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
963
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
77
964
|
<dl>
|
78
965
|
<dd>
|
79
966
|
|
@@ -85,7 +972,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
85
972
|
<dl>
|
86
973
|
<dd>
|
87
974
|
|
88
|
-
|
975
|
+
Execute a click interaction in a specific browser window
|
89
976
|
|
90
977
|
</dd>
|
91
978
|
</dl>
|
@@ -101,8 +988,8 @@ Get information about a browser window in a session, including the live view url
|
|
101
988
|
<dd>
|
102
989
|
|
103
990
|
```typescript
|
104
|
-
await client.windows.
|
105
|
-
|
991
|
+
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
992
|
+
elementDescription: "The login button",
|
106
993
|
});
|
107
994
|
```
|
108
995
|
|
@@ -119,7 +1006,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
119
1006
|
<dl>
|
120
1007
|
<dd>
|
121
1008
|
|
122
|
-
**sessionId:** `string` —
|
1009
|
+
**sessionId:** `string` — The session id for the window.
|
123
1010
|
|
124
1011
|
</dd>
|
125
1012
|
</dl>
|
@@ -127,7 +1014,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
127
1014
|
<dl>
|
128
1015
|
<dd>
|
129
1016
|
|
130
|
-
**windowId:** `string` —
|
1017
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
131
1018
|
|
132
1019
|
</dd>
|
133
1020
|
</dl>
|
@@ -135,7 +1022,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
135
1022
|
<dl>
|
136
1023
|
<dd>
|
137
1024
|
|
138
|
-
**request:** `Airtop.
|
1025
|
+
**request:** `Airtop.SessionClickHandlerRequestBody`
|
139
1026
|
|
140
1027
|
</dd>
|
141
1028
|
</dl>
|
@@ -154,7 +1041,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
154
1041
|
</dl>
|
155
1042
|
</details>
|
156
1043
|
|
157
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1044
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
158
1045
|
<dl>
|
159
1046
|
<dd>
|
160
1047
|
|
@@ -166,7 +1053,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
166
1053
|
<dl>
|
167
1054
|
<dd>
|
168
1055
|
|
169
|
-
|
1056
|
+
Execute a hover interaction in a specific browser window
|
170
1057
|
|
171
1058
|
</dd>
|
172
1059
|
</dl>
|
@@ -182,9 +1069,7 @@ Loads a specified url on a given window
|
|
182
1069
|
<dd>
|
183
1070
|
|
184
1071
|
```typescript
|
185
|
-
await client.windows.
|
186
|
-
url: "https://www.airtop.ai",
|
187
|
-
});
|
1072
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
188
1073
|
```
|
189
1074
|
|
190
1075
|
</dd>
|
@@ -200,7 +1085,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
200
1085
|
<dl>
|
201
1086
|
<dd>
|
202
1087
|
|
203
|
-
**sessionId:** `string` —
|
1088
|
+
**sessionId:** `string` — The session id for the window.
|
204
1089
|
|
205
1090
|
</dd>
|
206
1091
|
</dl>
|
@@ -208,7 +1093,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
208
1093
|
<dl>
|
209
1094
|
<dd>
|
210
1095
|
|
211
|
-
**windowId:** `string` — Airtop window
|
1096
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
212
1097
|
|
213
1098
|
</dd>
|
214
1099
|
</dl>
|
@@ -216,7 +1101,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
216
1101
|
<dl>
|
217
1102
|
<dd>
|
218
1103
|
|
219
|
-
**request:** `Airtop.
|
1104
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
220
1105
|
|
221
1106
|
</dd>
|
222
1107
|
</dl>
|
@@ -235,11 +1120,11 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
235
1120
|
</dl>
|
236
1121
|
</details>
|
237
1122
|
|
238
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1123
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
239
1124
|
<dl>
|
240
1125
|
<dd>
|
241
1126
|
|
242
|
-
####
|
1127
|
+
#### 🔌 Usage
|
243
1128
|
|
244
1129
|
<dl>
|
245
1130
|
<dd>
|
@@ -247,14 +1132,16 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
247
1132
|
<dl>
|
248
1133
|
<dd>
|
249
1134
|
|
250
|
-
|
1135
|
+
```typescript
|
1136
|
+
await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1137
|
+
```
|
251
1138
|
|
252
1139
|
</dd>
|
253
1140
|
</dl>
|
254
1141
|
</dd>
|
255
1142
|
</dl>
|
256
1143
|
|
257
|
-
####
|
1144
|
+
#### ⚙️ Parameters
|
258
1145
|
|
259
1146
|
<dl>
|
260
1147
|
<dd>
|
@@ -262,24 +1149,15 @@ Closes a browser window in a session
|
|
262
1149
|
<dl>
|
263
1150
|
<dd>
|
264
1151
|
|
265
|
-
|
266
|
-
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
267
|
-
```
|
1152
|
+
**sessionId:** `string` — The session id for the window.
|
268
1153
|
|
269
1154
|
</dd>
|
270
1155
|
</dl>
|
271
|
-
</dd>
|
272
|
-
</dl>
|
273
|
-
|
274
|
-
#### ⚙️ Parameters
|
275
|
-
|
276
|
-
<dl>
|
277
|
-
<dd>
|
278
1156
|
|
279
1157
|
<dl>
|
280
1158
|
<dd>
|
281
1159
|
|
282
|
-
**
|
1160
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
283
1161
|
|
284
1162
|
</dd>
|
285
1163
|
</dl>
|
@@ -287,7 +1165,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
287
1165
|
<dl>
|
288
1166
|
<dd>
|
289
1167
|
|
290
|
-
**
|
1168
|
+
**request:** `Airtop.SessionMonitorHandlerRequestBody`
|
291
1169
|
|
292
1170
|
</dd>
|
293
1171
|
</dl>
|
@@ -306,7 +1184,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
306
1184
|
</dl>
|
307
1185
|
</details>
|
308
1186
|
|
309
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1187
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
310
1188
|
<dl>
|
311
1189
|
<dd>
|
312
1190
|
|
@@ -318,7 +1196,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
318
1196
|
<dl>
|
319
1197
|
<dd>
|
320
1198
|
|
321
|
-
|
1199
|
+
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?).
|
322
1200
|
|
323
1201
|
</dd>
|
324
1202
|
</dl>
|
@@ -334,8 +1212,8 @@ Execute a click interaction in a specific browser window
|
|
334
1212
|
<dd>
|
335
1213
|
|
336
1214
|
```typescript
|
337
|
-
await client.windows.
|
338
|
-
|
1215
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1216
|
+
prompt: "What is the main idea of this page?",
|
339
1217
|
});
|
340
1218
|
```
|
341
1219
|
|
@@ -368,7 +1246,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
368
1246
|
<dl>
|
369
1247
|
<dd>
|
370
1248
|
|
371
|
-
**request:** `Airtop.
|
1249
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
372
1250
|
|
373
1251
|
</dd>
|
374
1252
|
</dl>
|
@@ -387,7 +1265,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
387
1265
|
</dl>
|
388
1266
|
</details>
|
389
1267
|
|
390
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1268
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
391
1269
|
<dl>
|
392
1270
|
<dd>
|
393
1271
|
|
@@ -399,7 +1277,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
399
1277
|
<dl>
|
400
1278
|
<dd>
|
401
1279
|
|
402
|
-
|
1280
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
403
1281
|
|
404
1282
|
</dd>
|
405
1283
|
</dl>
|
@@ -415,7 +1293,10 @@ Execute a hover interaction in a specific browser window
|
|
415
1293
|
<dd>
|
416
1294
|
|
417
1295
|
```typescript
|
418
|
-
await client.windows.
|
1296
|
+
await client.windows.paginatedExtraction(
|
1297
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
1298
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
1299
|
+
);
|
419
1300
|
```
|
420
1301
|
|
421
1302
|
</dd>
|
@@ -447,7 +1328,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
447
1328
|
<dl>
|
448
1329
|
<dd>
|
449
1330
|
|
450
|
-
**request:** `Airtop.
|
1331
|
+
**request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
|
451
1332
|
|
452
1333
|
</dd>
|
453
1334
|
</dl>
|
@@ -466,7 +1347,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
466
1347
|
</dl>
|
467
1348
|
</details>
|
468
1349
|
|
469
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1350
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
470
1351
|
<dl>
|
471
1352
|
<dd>
|
472
1353
|
|
@@ -478,7 +1359,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
478
1359
|
<dl>
|
479
1360
|
<dd>
|
480
1361
|
|
481
|
-
|
1362
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
482
1363
|
|
483
1364
|
</dd>
|
484
1365
|
</dl>
|
@@ -494,7 +1375,7 @@ Submit a prompt that queries the content of a specific browser window. You may e
|
|
494
1375
|
<dd>
|
495
1376
|
|
496
1377
|
```typescript
|
497
|
-
await client.windows.
|
1378
|
+
await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
498
1379
|
prompt: "What is the main idea of this page?",
|
499
1380
|
});
|
500
1381
|
```
|
@@ -547,7 +1428,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
547
1428
|
</dl>
|
548
1429
|
</details>
|
549
1430
|
|
550
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1431
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
551
1432
|
<dl>
|
552
1433
|
<dd>
|
553
1434
|
|
@@ -559,7 +1440,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
559
1440
|
<dl>
|
560
1441
|
<dd>
|
561
1442
|
|
562
|
-
|
1443
|
+
Scrape a window and return the content as markdown
|
563
1444
|
|
564
1445
|
</dd>
|
565
1446
|
</dl>
|
@@ -575,10 +1456,7 @@ Submit a prompt that queries the content of a specific browser window and pagina
|
|
575
1456
|
<dd>
|
576
1457
|
|
577
1458
|
```typescript
|
578
|
-
await client.windows.
|
579
|
-
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
580
|
-
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
581
|
-
);
|
1459
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
582
1460
|
```
|
583
1461
|
|
584
1462
|
</dd>
|
@@ -602,7 +1480,7 @@ await client.windows.paginatedExtraction(
|
|
602
1480
|
<dl>
|
603
1481
|
<dd>
|
604
1482
|
|
605
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
1483
|
+
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
606
1484
|
|
607
1485
|
</dd>
|
608
1486
|
</dl>
|
@@ -610,7 +1488,7 @@ await client.windows.paginatedExtraction(
|
|
610
1488
|
<dl>
|
611
1489
|
<dd>
|
612
1490
|
|
613
|
-
**request:** `Airtop.
|
1491
|
+
**request:** `Airtop.ScrapeContentRequest`
|
614
1492
|
|
615
1493
|
</dd>
|
616
1494
|
</dl>
|
@@ -629,7 +1507,7 @@ await client.windows.paginatedExtraction(
|
|
629
1507
|
</dl>
|
630
1508
|
</details>
|
631
1509
|
|
632
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1510
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
633
1511
|
<dl>
|
634
1512
|
<dd>
|
635
1513
|
|
@@ -641,7 +1519,7 @@ await client.windows.paginatedExtraction(
|
|
641
1519
|
<dl>
|
642
1520
|
<dd>
|
643
1521
|
|
644
|
-
|
1522
|
+
Take a screenshot of a browser window
|
645
1523
|
|
646
1524
|
</dd>
|
647
1525
|
</dl>
|
@@ -657,9 +1535,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
657
1535
|
<dd>
|
658
1536
|
|
659
1537
|
```typescript
|
660
|
-
await client.windows.
|
661
|
-
prompt: "What is the main idea of this page?",
|
662
|
-
});
|
1538
|
+
await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
663
1539
|
```
|
664
1540
|
|
665
1541
|
</dd>
|
@@ -691,7 +1567,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
691
1567
|
<dl>
|
692
1568
|
<dd>
|
693
1569
|
|
694
|
-
**request:** `Airtop.
|
1570
|
+
**request:** `Airtop.SessionScreenshotHandlerRequestBody`
|
695
1571
|
|
696
1572
|
</dd>
|
697
1573
|
</dl>
|
@@ -710,7 +1586,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
710
1586
|
</dl>
|
711
1587
|
</details>
|
712
1588
|
|
713
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1589
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
714
1590
|
<dl>
|
715
1591
|
<dd>
|
716
1592
|
|
@@ -722,7 +1598,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
722
1598
|
<dl>
|
723
1599
|
<dd>
|
724
1600
|
|
725
|
-
|
1601
|
+
Execute a scroll interaction in a specific browser window
|
726
1602
|
|
727
1603
|
</dd>
|
728
1604
|
</dl>
|
@@ -738,7 +1614,7 @@ Scrape a window and return the content as markdown
|
|
738
1614
|
<dd>
|
739
1615
|
|
740
1616
|
```typescript
|
741
|
-
await client.windows.
|
1617
|
+
await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
742
1618
|
```
|
743
1619
|
|
744
1620
|
</dd>
|
@@ -762,7 +1638,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
762
1638
|
<dl>
|
763
1639
|
<dd>
|
764
1640
|
|
765
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
1641
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
766
1642
|
|
767
1643
|
</dd>
|
768
1644
|
</dl>
|
@@ -770,7 +1646,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
770
1646
|
<dl>
|
771
1647
|
<dd>
|
772
1648
|
|
773
|
-
**request:** `Airtop.
|
1649
|
+
**request:** `Airtop.SessionScrollHandlerRequestBody`
|
774
1650
|
|
775
1651
|
</dd>
|
776
1652
|
</dl>
|
@@ -789,7 +1665,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
789
1665
|
</dl>
|
790
1666
|
</details>
|
791
1667
|
|
792
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1668
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
793
1669
|
<dl>
|
794
1670
|
<dd>
|
795
1671
|
|
@@ -801,7 +1677,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
801
1677
|
<dl>
|
802
1678
|
<dd>
|
803
1679
|
|
804
|
-
|
1680
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
805
1681
|
|
806
1682
|
</dd>
|
807
1683
|
</dl>
|
@@ -817,7 +1693,7 @@ Take a screenshot of a browser window
|
|
817
1693
|
<dd>
|
818
1694
|
|
819
1695
|
```typescript
|
820
|
-
await client.windows.
|
1696
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
821
1697
|
```
|
822
1698
|
|
823
1699
|
</dd>
|
@@ -841,7 +1717,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
841
1717
|
<dl>
|
842
1718
|
<dd>
|
843
1719
|
|
844
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
1720
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
845
1721
|
|
846
1722
|
</dd>
|
847
1723
|
</dl>
|
@@ -849,7 +1725,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
849
1725
|
<dl>
|
850
1726
|
<dd>
|
851
1727
|
|
852
|
-
**request:** `Airtop.
|
1728
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
853
1729
|
|
854
1730
|
</dd>
|
855
1731
|
</dl>
|
@@ -868,7 +1744,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
868
1744
|
</dl>
|
869
1745
|
</details>
|
870
1746
|
|
871
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1747
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
872
1748
|
<dl>
|
873
1749
|
<dd>
|
874
1750
|
|
@@ -880,7 +1756,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
880
1756
|
<dl>
|
881
1757
|
<dd>
|
882
1758
|
|
883
|
-
|
1759
|
+
Execute a type interaction in a specific browser window
|
884
1760
|
|
885
1761
|
</dd>
|
886
1762
|
</dl>
|
@@ -896,7 +1772,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
896
1772
|
<dd>
|
897
1773
|
|
898
1774
|
```typescript
|
899
|
-
await client.windows.
|
1775
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1776
|
+
text: "Example text",
|
1777
|
+
});
|
900
1778
|
```
|
901
1779
|
|
902
1780
|
</dd>
|
@@ -920,7 +1798,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
920
1798
|
<dl>
|
921
1799
|
<dd>
|
922
1800
|
|
923
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
1801
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
924
1802
|
|
925
1803
|
</dd>
|
926
1804
|
</dl>
|
@@ -928,7 +1806,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
928
1806
|
<dl>
|
929
1807
|
<dd>
|
930
1808
|
|
931
|
-
**request:** `Airtop.
|
1809
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
932
1810
|
|
933
1811
|
</dd>
|
934
1812
|
</dl>
|
@@ -947,7 +1825,9 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
947
1825
|
</dl>
|
948
1826
|
</details>
|
949
1827
|
|
950
|
-
|
1828
|
+
## ExtensionConfigurations
|
1829
|
+
|
1830
|
+
<details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationDelete</a>({ ...params }) -> void</code></summary>
|
951
1831
|
<dl>
|
952
1832
|
<dd>
|
953
1833
|
|
@@ -959,7 +1839,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
959
1839
|
<dl>
|
960
1840
|
<dd>
|
961
1841
|
|
962
|
-
|
1842
|
+
Delete extension configurations matching by name
|
963
1843
|
|
964
1844
|
</dd>
|
965
1845
|
</dl>
|
@@ -975,9 +1855,7 @@ Execute a type interaction in a specific browser window
|
|
975
1855
|
<dd>
|
976
1856
|
|
977
1857
|
```typescript
|
978
|
-
await client.
|
979
|
-
text: "Example text",
|
980
|
-
});
|
1858
|
+
await client.extensionConfigurations.extensionConfigurationDelete();
|
981
1859
|
```
|
982
1860
|
|
983
1861
|
</dd>
|
@@ -993,7 +1871,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
993
1871
|
<dl>
|
994
1872
|
<dd>
|
995
1873
|
|
996
|
-
**
|
1874
|
+
**request:** `Airtop.ExtensionConfigurationDeleteRequest`
|
997
1875
|
|
998
1876
|
</dd>
|
999
1877
|
</dl>
|
@@ -1001,23 +1879,70 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1001
1879
|
<dl>
|
1002
1880
|
<dd>
|
1003
1881
|
|
1004
|
-
**
|
1882
|
+
**requestOptions:** `ExtensionConfigurations.RequestOptions`
|
1883
|
+
|
1884
|
+
</dd>
|
1885
|
+
</dl>
|
1886
|
+
</dd>
|
1887
|
+
</dl>
|
1005
1888
|
|
1006
1889
|
</dd>
|
1007
1890
|
</dl>
|
1891
|
+
</details>
|
1008
1892
|
|
1893
|
+
<details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationGetInfo</a>(name) -> Airtop.ExtensionConfigurationOutput</code></summary>
|
1009
1894
|
<dl>
|
1010
1895
|
<dd>
|
1011
1896
|
|
1012
|
-
|
1897
|
+
#### 📝 Description
|
1898
|
+
|
1899
|
+
<dl>
|
1900
|
+
<dd>
|
1901
|
+
|
1902
|
+
<dl>
|
1903
|
+
<dd>
|
1904
|
+
|
1905
|
+
Get an extension configuration by name
|
1013
1906
|
|
1014
1907
|
</dd>
|
1015
1908
|
</dl>
|
1909
|
+
</dd>
|
1910
|
+
</dl>
|
1911
|
+
|
1912
|
+
#### 🔌 Usage
|
1016
1913
|
|
1017
1914
|
<dl>
|
1018
1915
|
<dd>
|
1019
1916
|
|
1020
|
-
|
1917
|
+
<dl>
|
1918
|
+
<dd>
|
1919
|
+
|
1920
|
+
```typescript
|
1921
|
+
await client.extensionConfigurations.extensionConfigurationGetInfo("my-configuration");
|
1922
|
+
```
|
1923
|
+
|
1924
|
+
</dd>
|
1925
|
+
</dl>
|
1926
|
+
</dd>
|
1927
|
+
</dl>
|
1928
|
+
|
1929
|
+
#### ⚙️ Parameters
|
1930
|
+
|
1931
|
+
<dl>
|
1932
|
+
<dd>
|
1933
|
+
|
1934
|
+
<dl>
|
1935
|
+
<dd>
|
1936
|
+
|
1937
|
+
**name:** `string` — Name of the extension configuration to get
|
1938
|
+
|
1939
|
+
</dd>
|
1940
|
+
</dl>
|
1941
|
+
|
1942
|
+
<dl>
|
1943
|
+
<dd>
|
1944
|
+
|
1945
|
+
**requestOptions:** `ExtensionConfigurations.RequestOptions`
|
1021
1946
|
|
1022
1947
|
</dd>
|
1023
1948
|
</dl>
|
@@ -1093,6 +2018,56 @@ await client.profiles.delete();
|
|
1093
2018
|
</dl>
|
1094
2019
|
</details>
|
1095
2020
|
|
2021
|
+
## Requests
|
2022
|
+
|
2023
|
+
<details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
|
2024
|
+
<dl>
|
2025
|
+
<dd>
|
2026
|
+
|
2027
|
+
#### 🔌 Usage
|
2028
|
+
|
2029
|
+
<dl>
|
2030
|
+
<dd>
|
2031
|
+
|
2032
|
+
<dl>
|
2033
|
+
<dd>
|
2034
|
+
|
2035
|
+
```typescript
|
2036
|
+
await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
2037
|
+
```
|
2038
|
+
|
2039
|
+
</dd>
|
2040
|
+
</dl>
|
2041
|
+
</dd>
|
2042
|
+
</dl>
|
2043
|
+
|
2044
|
+
#### ⚙️ Parameters
|
2045
|
+
|
2046
|
+
<dl>
|
2047
|
+
<dd>
|
2048
|
+
|
2049
|
+
<dl>
|
2050
|
+
<dd>
|
2051
|
+
|
2052
|
+
**requestId:** `string` — The ID of the request to check.
|
2053
|
+
|
2054
|
+
</dd>
|
2055
|
+
</dl>
|
2056
|
+
|
2057
|
+
<dl>
|
2058
|
+
<dd>
|
2059
|
+
|
2060
|
+
**requestOptions:** `Requests.RequestOptions`
|
2061
|
+
|
2062
|
+
</dd>
|
2063
|
+
</dl>
|
2064
|
+
</dd>
|
2065
|
+
</dl>
|
2066
|
+
|
2067
|
+
</dd>
|
2068
|
+
</dl>
|
2069
|
+
</details>
|
2070
|
+
|
1096
2071
|
## Sessions
|
1097
2072
|
|
1098
2073
|
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
|