@airtop/sdk 0.1.30 → 0.1.31-beta1
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 +9 -0
- package/Client.js +19 -4
- package/README.md +8 -6
- package/api/errors/ForbiddenError.d.ts +8 -0
- package/api/errors/ForbiddenError.js +41 -0
- package/api/errors/UnauthorizedError.d.ts +8 -0
- package/api/errors/UnauthorizedError.js +41 -0
- package/api/errors/index.d.ts +2 -0
- package/api/errors/index.js +2 -0
- package/api/resources/automations/client/Client.d.ts +87 -0
- package/api/resources/automations/client/Client.js +451 -0
- package/api/resources/automations/client/index.d.ts +1 -0
- package/api/resources/automations/client/index.js +17 -0
- package/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +19 -0
- package/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +5 -0
- package/api/resources/automations/client/requests/index.d.ts +1 -0
- package/api/resources/automations/client/requests/index.js +2 -0
- package/api/resources/automations/index.d.ts +1 -0
- package/api/resources/automations/index.js +17 -0
- package/api/resources/extensionConfigurations/client/Client.d.ts +40 -0
- package/api/resources/extensionConfigurations/client/Client.js +149 -0
- package/api/resources/extensionConfigurations/client/index.d.ts +1 -0
- package/api/resources/extensionConfigurations/client/index.js +2 -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 +4 -0
- package/api/resources/index.js +5 -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.d.ts +9 -0
- package/api/resources/sessions/client/Client.js +65 -12
- package/api/resources/sessions/types/SessionsListRequestStatus.d.ts +4 -1
- package/api/resources/sessions/types/SessionsListRequestStatus.js +3 -0
- 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/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/AutomationOutput.d.ts +10 -0
- package/api/types/AutomationOutput.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/DeleteAutomationOutputWrapperBody.d.ts +4 -0
- package/api/types/DeleteAutomationOutputWrapperBody.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/ListAutomationsOutput.d.ts +7 -0
- package/api/types/ListAutomationsOutput.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/Pagination.d.ts +8 -0
- package/api/types/RequestStatusResponse.d.ts +8 -0
- package/api/types/RequestStatusResponse.js +5 -0
- package/api/types/SessionConfigV1.d.ts +2 -0
- package/api/types/index.d.ts +13 -0
- package/api/types/index.js +13 -0
- package/dist/Client.d.ts +9 -0
- package/dist/Client.js +19 -4
- package/dist/api/errors/ForbiddenError.d.ts +8 -0
- package/dist/api/errors/ForbiddenError.js +41 -0
- package/dist/api/errors/UnauthorizedError.d.ts +8 -0
- package/dist/api/errors/UnauthorizedError.js +41 -0
- package/dist/api/errors/index.d.ts +2 -0
- package/dist/api/errors/index.js +2 -0
- package/dist/api/resources/automations/client/Client.d.ts +87 -0
- package/dist/api/resources/automations/client/Client.js +451 -0
- package/dist/api/resources/automations/client/index.d.ts +1 -0
- package/dist/api/resources/automations/client/index.js +17 -0
- package/dist/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +19 -0
- package/dist/api/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +5 -0
- package/dist/api/resources/automations/client/requests/index.d.ts +1 -0
- package/dist/api/resources/automations/client/requests/index.js +2 -0
- package/dist/api/resources/automations/index.d.ts +1 -0
- package/dist/api/resources/automations/index.js +17 -0
- package/dist/api/resources/extensionConfigurations/client/Client.d.ts +40 -0
- package/dist/api/resources/extensionConfigurations/client/Client.js +149 -0
- package/dist/api/resources/extensionConfigurations/client/index.d.ts +1 -0
- package/dist/api/resources/extensionConfigurations/client/index.js +2 -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 +4 -0
- package/dist/api/resources/index.js +5 -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.d.ts +9 -0
- package/dist/api/resources/sessions/client/Client.js +65 -12
- package/dist/api/resources/sessions/types/SessionsListRequestStatus.d.ts +4 -1
- package/dist/api/resources/sessions/types/SessionsListRequestStatus.js +3 -0
- 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/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/AutomationOutput.d.ts +10 -0
- package/dist/api/types/AutomationOutput.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/DeleteAutomationOutputWrapperBody.d.ts +4 -0
- package/dist/api/types/DeleteAutomationOutputWrapperBody.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/ListAutomationsOutput.d.ts +7 -0
- package/dist/api/types/ListAutomationsOutput.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/Pagination.d.ts +8 -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 +2 -0
- package/dist/api/types/index.d.ts +13 -0
- package/dist/api/types/index.js +13 -0
- package/dist/serialization/resources/automations/client/index.d.ts +1 -0
- package/dist/serialization/resources/automations/client/index.js +17 -0
- package/dist/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +14 -0
- package/dist/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +35 -0
- package/dist/serialization/resources/automations/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/automations/client/requests/index.js +5 -0
- package/dist/serialization/resources/automations/index.d.ts +1 -0
- package/dist/serialization/resources/automations/index.js +17 -0
- package/dist/serialization/resources/index.d.ts +2 -0
- package/dist/serialization/resources/index.js +3 -1
- package/dist/serialization/resources/sessions/types/SessionsListRequestStatus.d.ts +1 -1
- package/dist/serialization/resources/sessions/types/SessionsListRequestStatus.js +1 -1
- 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/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/AutomationOutput.d.ts +16 -0
- package/dist/serialization/types/AutomationOutput.js +37 -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/DeleteAutomationOutputWrapperBody.d.ts +10 -0
- package/dist/serialization/types/DeleteAutomationOutputWrapperBody.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/ListAutomationsOutput.d.ts +13 -0
- package/dist/serialization/types/ListAutomationsOutput.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 +1 -0
- package/dist/serialization/types/SessionConfigV1.js +1 -0
- package/dist/serialization/types/index.d.ts +13 -0
- package/dist/serialization/types/index.js +13 -0
- package/dist/wrapper/AirtopClient.d.ts +4 -0
- package/dist/wrapper/AirtopClient.js +8 -0
- package/dist/wrapper/AirtopRequests.d.ts +18 -0
- package/dist/wrapper/AirtopRequests.js +48 -0
- package/dist/wrapper/AirtopWindows.d.ts +11 -1
- package/dist/wrapper/AirtopWindows.js +17 -0
- package/package.json +3 -2
- package/reference.md +1418 -163
- package/serialization/resources/automations/client/index.d.ts +1 -0
- package/serialization/resources/automations/client/index.js +17 -0
- package/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.d.ts +14 -0
- package/serialization/resources/automations/client/requests/UpdateAutomationDescriptionInputBody.js +35 -0
- package/serialization/resources/automations/client/requests/index.d.ts +1 -0
- package/serialization/resources/automations/client/requests/index.js +5 -0
- package/serialization/resources/automations/index.d.ts +1 -0
- package/serialization/resources/automations/index.js +17 -0
- package/serialization/resources/index.d.ts +2 -0
- package/serialization/resources/index.js +3 -1
- package/serialization/resources/sessions/types/SessionsListRequestStatus.d.ts +1 -1
- package/serialization/resources/sessions/types/SessionsListRequestStatus.js +1 -1
- 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/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/AutomationOutput.d.ts +16 -0
- package/serialization/types/AutomationOutput.js +37 -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/DeleteAutomationOutputWrapperBody.d.ts +10 -0
- package/serialization/types/DeleteAutomationOutputWrapperBody.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/ListAutomationsOutput.d.ts +13 -0
- package/serialization/types/ListAutomationsOutput.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 +1 -0
- package/serialization/types/SessionConfigV1.js +1 -0
- package/serialization/types/index.d.ts +13 -0
- package/serialization/types/index.js +13 -0
- package/wrapper/AirtopClient.d.ts +4 -0
- package/wrapper/AirtopClient.js +8 -0
- package/wrapper/AirtopRequests.d.ts +18 -0
- package/wrapper/AirtopRequests.js +48 -0
- package/wrapper/AirtopWindows.d.ts +11 -1
- package/wrapper/AirtopWindows.js +17 -0
package/reference.md
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
## Windows
|
4
4
|
|
5
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
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
6
|
<dl>
|
7
7
|
<dd>
|
8
8
|
|
@@ -14,7 +14,7 @@
|
|
14
14
|
<dl>
|
15
15
|
<dd>
|
16
16
|
|
17
|
-
|
17
|
+
Execute a click interaction in a specific browser window asynchronously
|
18
18
|
|
19
19
|
</dd>
|
20
20
|
</dl>
|
@@ -30,7 +30,9 @@ Creates a new browser window in a session. Optionally, you can specify a url to
|
|
30
30
|
<dd>
|
31
31
|
|
32
32
|
```typescript
|
33
|
-
await client.windows.
|
33
|
+
await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
34
|
+
elementDescription: "The login button",
|
35
|
+
});
|
34
36
|
```
|
35
37
|
|
36
38
|
</dd>
|
@@ -46,7 +48,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
46
48
|
<dl>
|
47
49
|
<dd>
|
48
50
|
|
49
|
-
**sessionId:** `string` —
|
51
|
+
**sessionId:** `string` — The session id for the window.
|
50
52
|
|
51
53
|
</dd>
|
52
54
|
</dl>
|
@@ -54,7 +56,15 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
54
56
|
<dl>
|
55
57
|
<dd>
|
56
58
|
|
57
|
-
**
|
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`
|
58
68
|
|
59
69
|
</dd>
|
60
70
|
</dl>
|
@@ -73,7 +83,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
73
83
|
</dl>
|
74
84
|
</details>
|
75
85
|
|
76
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
86
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncCreateAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
77
87
|
<dl>
|
78
88
|
<dd>
|
79
89
|
|
@@ -85,7 +95,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
85
95
|
<dl>
|
86
96
|
<dd>
|
87
97
|
|
88
|
-
|
98
|
+
Create an automation of a browser window asynchronously
|
89
99
|
|
90
100
|
</dd>
|
91
101
|
</dl>
|
@@ -101,9 +111,10 @@ Get information about a browser window in a session, including the live view url
|
|
101
111
|
<dd>
|
102
112
|
|
103
113
|
```typescript
|
104
|
-
await client.windows.
|
105
|
-
|
106
|
-
|
114
|
+
await client.windows.asyncCreateAutomation(
|
115
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
116
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
117
|
+
);
|
107
118
|
```
|
108
119
|
|
109
120
|
</dd>
|
@@ -119,7 +130,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
119
130
|
<dl>
|
120
131
|
<dd>
|
121
132
|
|
122
|
-
**sessionId:** `string` —
|
133
|
+
**sessionId:** `string` — The session id for the window.
|
123
134
|
|
124
135
|
</dd>
|
125
136
|
</dl>
|
@@ -127,7 +138,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
127
138
|
<dl>
|
128
139
|
<dd>
|
129
140
|
|
130
|
-
**windowId:** `string` —
|
141
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
131
142
|
|
132
143
|
</dd>
|
133
144
|
</dl>
|
@@ -135,7 +146,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
135
146
|
<dl>
|
136
147
|
<dd>
|
137
148
|
|
138
|
-
**request:** `Airtop.
|
149
|
+
**request:** `Airtop.AsyncCreateAutomationRequest`
|
139
150
|
|
140
151
|
</dd>
|
141
152
|
</dl>
|
@@ -154,7 +165,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
154
165
|
</dl>
|
155
166
|
</details>
|
156
167
|
|
157
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
168
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
158
169
|
<dl>
|
159
170
|
<dd>
|
160
171
|
|
@@ -166,7 +177,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
166
177
|
<dl>
|
167
178
|
<dd>
|
168
179
|
|
169
|
-
|
180
|
+
Execute an automation of a browser window asynchronously
|
170
181
|
|
171
182
|
</dd>
|
172
183
|
</dl>
|
@@ -182,9 +193,13 @@ Loads a specified url on a given window
|
|
182
193
|
<dd>
|
183
194
|
|
184
195
|
```typescript
|
185
|
-
await client.windows.
|
186
|
-
|
187
|
-
|
196
|
+
await client.windows.asyncExecuteAutomation(
|
197
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
198
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
199
|
+
{
|
200
|
+
automationId: "automationId",
|
201
|
+
}
|
202
|
+
);
|
188
203
|
```
|
189
204
|
|
190
205
|
</dd>
|
@@ -200,7 +215,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
200
215
|
<dl>
|
201
216
|
<dd>
|
202
217
|
|
203
|
-
**sessionId:** `string` —
|
218
|
+
**sessionId:** `string` — The session id for the window.
|
204
219
|
|
205
220
|
</dd>
|
206
221
|
</dl>
|
@@ -208,7 +223,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
208
223
|
<dl>
|
209
224
|
<dd>
|
210
225
|
|
211
|
-
**windowId:** `string` — Airtop window
|
226
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
212
227
|
|
213
228
|
</dd>
|
214
229
|
</dl>
|
@@ -216,7 +231,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
216
231
|
<dl>
|
217
232
|
<dd>
|
218
233
|
|
219
|
-
**request:** `Airtop.
|
234
|
+
**request:** `Airtop.AsyncExecuteAutomationRequest`
|
220
235
|
|
221
236
|
</dd>
|
222
237
|
</dl>
|
@@ -235,11 +250,11 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
235
250
|
</dl>
|
236
251
|
</details>
|
237
252
|
|
238
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
253
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
239
254
|
<dl>
|
240
255
|
<dd>
|
241
256
|
|
242
|
-
####
|
257
|
+
#### 🔌 Usage
|
243
258
|
|
244
259
|
<dl>
|
245
260
|
<dd>
|
@@ -247,14 +262,18 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
247
262
|
<dl>
|
248
263
|
<dd>
|
249
264
|
|
250
|
-
|
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
|
+
```
|
251
270
|
|
252
271
|
</dd>
|
253
272
|
</dl>
|
254
273
|
</dd>
|
255
274
|
</dl>
|
256
275
|
|
257
|
-
####
|
276
|
+
#### ⚙️ Parameters
|
258
277
|
|
259
278
|
<dl>
|
260
279
|
<dd>
|
@@ -262,24 +281,15 @@ Closes a browser window in a session
|
|
262
281
|
<dl>
|
263
282
|
<dd>
|
264
283
|
|
265
|
-
|
266
|
-
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
267
|
-
```
|
284
|
+
**sessionId:** `string` — The session id for the window.
|
268
285
|
|
269
286
|
</dd>
|
270
287
|
</dl>
|
271
|
-
</dd>
|
272
|
-
</dl>
|
273
|
-
|
274
|
-
#### ⚙️ Parameters
|
275
|
-
|
276
|
-
<dl>
|
277
|
-
<dd>
|
278
288
|
|
279
289
|
<dl>
|
280
290
|
<dd>
|
281
291
|
|
282
|
-
**
|
292
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
283
293
|
|
284
294
|
</dd>
|
285
295
|
</dl>
|
@@ -287,7 +297,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
287
297
|
<dl>
|
288
298
|
<dd>
|
289
299
|
|
290
|
-
**
|
300
|
+
**request:** `Airtop.AsyncHoverRequest`
|
291
301
|
|
292
302
|
</dd>
|
293
303
|
</dl>
|
@@ -306,25 +316,10 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
306
316
|
</dl>
|
307
317
|
</details>
|
308
318
|
|
309
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
310
|
-
<dl>
|
311
|
-
<dd>
|
312
|
-
|
313
|
-
#### 📝 Description
|
314
|
-
|
315
|
-
<dl>
|
316
|
-
<dd>
|
317
|
-
|
319
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
318
320
|
<dl>
|
319
321
|
<dd>
|
320
322
|
|
321
|
-
Execute a click interaction in a specific browser window
|
322
|
-
|
323
|
-
</dd>
|
324
|
-
</dl>
|
325
|
-
</dd>
|
326
|
-
</dl>
|
327
|
-
|
328
323
|
#### 🔌 Usage
|
329
324
|
|
330
325
|
<dl>
|
@@ -334,9 +329,7 @@ Execute a click interaction in a specific browser window
|
|
334
329
|
<dd>
|
335
330
|
|
336
331
|
```typescript
|
337
|
-
await client.windows.
|
338
|
-
elementDescription: "The login button",
|
339
|
-
});
|
332
|
+
await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
340
333
|
```
|
341
334
|
|
342
335
|
</dd>
|
@@ -368,7 +361,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
368
361
|
<dl>
|
369
362
|
<dd>
|
370
363
|
|
371
|
-
**request:** `Airtop.
|
364
|
+
**request:** `Airtop.AsyncMonitorRequest`
|
372
365
|
|
373
366
|
</dd>
|
374
367
|
</dl>
|
@@ -387,25 +380,10 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
387
380
|
</dl>
|
388
381
|
</details>
|
389
382
|
|
390
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
391
|
-
<dl>
|
392
|
-
<dd>
|
393
|
-
|
394
|
-
#### 📝 Description
|
395
|
-
|
396
|
-
<dl>
|
397
|
-
<dd>
|
398
|
-
|
383
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
399
384
|
<dl>
|
400
385
|
<dd>
|
401
386
|
|
402
|
-
Execute a hover interaction in a specific browser window
|
403
|
-
|
404
|
-
</dd>
|
405
|
-
</dl>
|
406
|
-
</dd>
|
407
|
-
</dl>
|
408
|
-
|
409
387
|
#### 🔌 Usage
|
410
388
|
|
411
389
|
<dl>
|
@@ -415,8 +393,8 @@ Execute a hover interaction in a specific browser window
|
|
415
393
|
<dd>
|
416
394
|
|
417
395
|
```typescript
|
418
|
-
await client.windows.
|
419
|
-
|
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?",
|
420
398
|
});
|
421
399
|
```
|
422
400
|
|
@@ -449,7 +427,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
449
427
|
<dl>
|
450
428
|
<dd>
|
451
429
|
|
452
|
-
**request:** `Airtop.
|
430
|
+
**request:** `Airtop.AsyncPageQueryRequest`
|
453
431
|
|
454
432
|
</dd>
|
455
433
|
</dl>
|
@@ -468,25 +446,10 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
468
446
|
</dl>
|
469
447
|
</details>
|
470
448
|
|
471
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
472
|
-
<dl>
|
473
|
-
<dd>
|
474
|
-
|
475
|
-
#### 📝 Description
|
476
|
-
|
477
|
-
<dl>
|
478
|
-
<dd>
|
479
|
-
|
449
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
480
450
|
<dl>
|
481
451
|
<dd>
|
482
452
|
|
483
|
-
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?).
|
484
|
-
|
485
|
-
</dd>
|
486
|
-
</dl>
|
487
|
-
</dd>
|
488
|
-
</dl>
|
489
|
-
|
490
453
|
#### 🔌 Usage
|
491
454
|
|
492
455
|
<dl>
|
@@ -496,9 +459,13 @@ Submit a prompt that queries the content of a specific browser window. You may e
|
|
496
459
|
<dd>
|
497
460
|
|
498
461
|
```typescript
|
499
|
-
await client.windows.
|
500
|
-
|
501
|
-
|
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
|
+
);
|
502
469
|
```
|
503
470
|
|
504
471
|
</dd>
|
@@ -530,7 +497,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
530
497
|
<dl>
|
531
498
|
<dd>
|
532
499
|
|
533
|
-
**request:** `Airtop.
|
500
|
+
**request:** `Airtop.AsyncPaginatedExtractionRequest`
|
534
501
|
|
535
502
|
</dd>
|
536
503
|
</dl>
|
@@ -549,7 +516,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
549
516
|
</dl>
|
550
517
|
</details>
|
551
518
|
|
552
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
519
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
553
520
|
<dl>
|
554
521
|
<dd>
|
555
522
|
|
@@ -561,7 +528,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
561
528
|
<dl>
|
562
529
|
<dd>
|
563
530
|
|
564
|
-
|
531
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
565
532
|
|
566
533
|
</dd>
|
567
534
|
</dl>
|
@@ -577,11 +544,11 @@ Submit a prompt that queries the content of a specific browser window and pagina
|
|
577
544
|
<dd>
|
578
545
|
|
579
546
|
```typescript
|
580
|
-
await client.windows.
|
547
|
+
await client.windows.asyncPromptContent(
|
581
548
|
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
582
549
|
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
583
550
|
{
|
584
|
-
prompt: "
|
551
|
+
prompt: "What is the main idea of this page?",
|
585
552
|
}
|
586
553
|
);
|
587
554
|
```
|
@@ -615,7 +582,7 @@ await client.windows.paginatedExtraction(
|
|
615
582
|
<dl>
|
616
583
|
<dd>
|
617
584
|
|
618
|
-
**request:** `Airtop.
|
585
|
+
**request:** `Airtop.AsyncPromptContentRequest`
|
619
586
|
|
620
587
|
</dd>
|
621
588
|
</dl>
|
@@ -634,7 +601,7 @@ await client.windows.paginatedExtraction(
|
|
634
601
|
</dl>
|
635
602
|
</details>
|
636
603
|
|
637
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
604
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
638
605
|
<dl>
|
639
606
|
<dd>
|
640
607
|
|
@@ -646,7 +613,7 @@ await client.windows.paginatedExtraction(
|
|
646
613
|
<dl>
|
647
614
|
<dd>
|
648
615
|
|
649
|
-
|
616
|
+
Take a screenshot of the current viewport of a browser window asynchronously
|
650
617
|
|
651
618
|
</dd>
|
652
619
|
</dl>
|
@@ -662,9 +629,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
662
629
|
<dd>
|
663
630
|
|
664
631
|
```typescript
|
665
|
-
await client.windows.
|
666
|
-
prompt: "What is the main idea of this page?",
|
667
|
-
});
|
632
|
+
await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
668
633
|
```
|
669
634
|
|
670
635
|
</dd>
|
@@ -696,7 +661,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
696
661
|
<dl>
|
697
662
|
<dd>
|
698
663
|
|
699
|
-
**request:** `Airtop.
|
664
|
+
**request:** `Airtop.AsyncScreenshotRequest`
|
700
665
|
|
701
666
|
</dd>
|
702
667
|
</dl>
|
@@ -715,7 +680,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
715
680
|
</dl>
|
716
681
|
</details>
|
717
682
|
|
718
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
683
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
719
684
|
<dl>
|
720
685
|
<dd>
|
721
686
|
|
@@ -727,7 +692,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
727
692
|
<dl>
|
728
693
|
<dd>
|
729
694
|
|
730
|
-
|
695
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
731
696
|
|
732
697
|
</dd>
|
733
698
|
</dl>
|
@@ -743,7 +708,10 @@ Scrape a window and return the content as markdown
|
|
743
708
|
<dd>
|
744
709
|
|
745
710
|
```typescript
|
746
|
-
await client.windows.
|
711
|
+
await client.windows.asyncSummarizeContent(
|
712
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
713
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430"
|
714
|
+
);
|
747
715
|
```
|
748
716
|
|
749
717
|
</dd>
|
@@ -767,7 +735,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
767
735
|
<dl>
|
768
736
|
<dd>
|
769
737
|
|
770
|
-
**windowId:** `string` — The Airtop window id of the browser window to
|
738
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
771
739
|
|
772
740
|
</dd>
|
773
741
|
</dl>
|
@@ -775,7 +743,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
775
743
|
<dl>
|
776
744
|
<dd>
|
777
745
|
|
778
|
-
**request:** `Airtop.
|
746
|
+
**request:** `Airtop.AsyncSummarizeContentRequest`
|
779
747
|
|
780
748
|
</dd>
|
781
749
|
</dl>
|
@@ -794,25 +762,10 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
794
762
|
</dl>
|
795
763
|
</details>
|
796
764
|
|
797
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
798
|
-
<dl>
|
799
|
-
<dd>
|
800
|
-
|
801
|
-
#### 📝 Description
|
802
|
-
|
765
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
803
766
|
<dl>
|
804
767
|
<dd>
|
805
768
|
|
806
|
-
<dl>
|
807
|
-
<dd>
|
808
|
-
|
809
|
-
Take a screenshot of a browser window
|
810
|
-
|
811
|
-
</dd>
|
812
|
-
</dl>
|
813
|
-
</dd>
|
814
|
-
</dl>
|
815
|
-
|
816
769
|
#### 🔌 Usage
|
817
770
|
|
818
771
|
<dl>
|
@@ -822,7 +775,9 @@ Take a screenshot of a browser window
|
|
822
775
|
<dd>
|
823
776
|
|
824
777
|
```typescript
|
825
|
-
await client.windows.
|
778
|
+
await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
779
|
+
text: "Example text",
|
780
|
+
});
|
826
781
|
```
|
827
782
|
|
828
783
|
</dd>
|
@@ -854,7 +809,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
854
809
|
<dl>
|
855
810
|
<dd>
|
856
811
|
|
857
|
-
**request:** `Airtop.
|
812
|
+
**request:** `Airtop.AsyncTypeRequest`
|
858
813
|
|
859
814
|
</dd>
|
860
815
|
</dl>
|
@@ -873,7 +828,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
873
828
|
</dl>
|
874
829
|
</details>
|
875
830
|
|
876
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
831
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
|
877
832
|
<dl>
|
878
833
|
<dd>
|
879
834
|
|
@@ -885,7 +840,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
885
840
|
<dl>
|
886
841
|
<dd>
|
887
842
|
|
888
|
-
|
843
|
+
Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
|
889
844
|
|
890
845
|
</dd>
|
891
846
|
</dl>
|
@@ -901,7 +856,7 @@ Execute a scroll interaction in a specific browser window
|
|
901
856
|
<dd>
|
902
857
|
|
903
858
|
```typescript
|
904
|
-
await client.windows.
|
859
|
+
await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
905
860
|
```
|
906
861
|
|
907
862
|
</dd>
|
@@ -917,15 +872,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
917
872
|
<dl>
|
918
873
|
<dd>
|
919
874
|
|
920
|
-
**sessionId:** `string` —
|
921
|
-
|
922
|
-
</dd>
|
923
|
-
</dl>
|
924
|
-
|
925
|
-
<dl>
|
926
|
-
<dd>
|
927
|
-
|
928
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
875
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
929
876
|
|
930
877
|
</dd>
|
931
878
|
</dl>
|
@@ -933,7 +880,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
933
880
|
<dl>
|
934
881
|
<dd>
|
935
882
|
|
936
|
-
**request:** `Airtop.
|
883
|
+
**request:** `Airtop.CreateWindowInputV1Body`
|
937
884
|
|
938
885
|
</dd>
|
939
886
|
</dl>
|
@@ -952,7 +899,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
952
899
|
</dl>
|
953
900
|
</details>
|
954
901
|
|
955
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
902
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
|
956
903
|
<dl>
|
957
904
|
<dd>
|
958
905
|
|
@@ -964,7 +911,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
964
911
|
<dl>
|
965
912
|
<dd>
|
966
913
|
|
967
|
-
|
914
|
+
Get information about a browser window in a session, including the live view url.
|
968
915
|
|
969
916
|
</dd>
|
970
917
|
</dl>
|
@@ -980,7 +927,9 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
980
927
|
<dd>
|
981
928
|
|
982
929
|
```typescript
|
983
|
-
await client.windows.
|
930
|
+
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
931
|
+
screenResolution: "1280x720",
|
932
|
+
});
|
984
933
|
```
|
985
934
|
|
986
935
|
</dd>
|
@@ -996,7 +945,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
996
945
|
<dl>
|
997
946
|
<dd>
|
998
947
|
|
999
|
-
**sessionId:** `string` —
|
948
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1000
949
|
|
1001
950
|
</dd>
|
1002
951
|
</dl>
|
@@ -1004,7 +953,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1004
953
|
<dl>
|
1005
954
|
<dd>
|
1006
955
|
|
1007
|
-
**windowId:** `string` —
|
956
|
+
**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.
|
1008
957
|
|
1009
958
|
</dd>
|
1010
959
|
</dl>
|
@@ -1012,7 +961,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1012
961
|
<dl>
|
1013
962
|
<dd>
|
1014
963
|
|
1015
|
-
**request:** `Airtop.
|
964
|
+
**request:** `Airtop.GetWindowInfoRequest`
|
1016
965
|
|
1017
966
|
</dd>
|
1018
967
|
</dl>
|
@@ -1031,7 +980,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1031
980
|
</dl>
|
1032
981
|
</details>
|
1033
982
|
|
1034
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
983
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
|
1035
984
|
<dl>
|
1036
985
|
<dd>
|
1037
986
|
|
@@ -1043,7 +992,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1043
992
|
<dl>
|
1044
993
|
<dd>
|
1045
994
|
|
1046
|
-
|
995
|
+
Loads a specified url on a given window
|
1047
996
|
|
1048
997
|
</dd>
|
1049
998
|
</dl>
|
@@ -1059,8 +1008,8 @@ Execute a type interaction in a specific browser window
|
|
1059
1008
|
<dd>
|
1060
1009
|
|
1061
1010
|
```typescript
|
1062
|
-
await client.windows.
|
1063
|
-
|
1011
|
+
await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1012
|
+
url: "https://www.airtop.ai",
|
1064
1013
|
});
|
1065
1014
|
```
|
1066
1015
|
|
@@ -1077,7 +1026,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1077
1026
|
<dl>
|
1078
1027
|
<dd>
|
1079
1028
|
|
1080
|
-
**sessionId:** `string` —
|
1029
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1081
1030
|
|
1082
1031
|
</dd>
|
1083
1032
|
</dl>
|
@@ -1085,7 +1034,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1085
1034
|
<dl>
|
1086
1035
|
<dd>
|
1087
1036
|
|
1088
|
-
**windowId:** `string` —
|
1037
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1089
1038
|
|
1090
1039
|
</dd>
|
1091
1040
|
</dl>
|
@@ -1093,7 +1042,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1093
1042
|
<dl>
|
1094
1043
|
<dd>
|
1095
1044
|
|
1096
|
-
**request:** `Airtop.
|
1045
|
+
**request:** `Airtop.WindowLoadUrlV1Body`
|
1097
1046
|
|
1098
1047
|
</dd>
|
1099
1048
|
</dl>
|
@@ -1112,9 +1061,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1112
1061
|
</dl>
|
1113
1062
|
</details>
|
1114
1063
|
|
1115
|
-
|
1116
|
-
|
1117
|
-
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
1064
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
|
1118
1065
|
<dl>
|
1119
1066
|
<dd>
|
1120
1067
|
|
@@ -1126,7 +1073,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1126
1073
|
<dl>
|
1127
1074
|
<dd>
|
1128
1075
|
|
1129
|
-
|
1076
|
+
Closes a browser window in a session
|
1130
1077
|
|
1131
1078
|
</dd>
|
1132
1079
|
</dl>
|
@@ -1142,7 +1089,7 @@ Delete profiles matching by id
|
|
1142
1089
|
<dd>
|
1143
1090
|
|
1144
1091
|
```typescript
|
1145
|
-
await client.
|
1092
|
+
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
1146
1093
|
```
|
1147
1094
|
|
1148
1095
|
</dd>
|
@@ -1158,7 +1105,7 @@ await client.profiles.delete();
|
|
1158
1105
|
<dl>
|
1159
1106
|
<dd>
|
1160
1107
|
|
1161
|
-
**
|
1108
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1162
1109
|
|
1163
1110
|
</dd>
|
1164
1111
|
</dl>
|
@@ -1166,7 +1113,1315 @@ await client.profiles.delete();
|
|
1166
1113
|
<dl>
|
1167
1114
|
<dd>
|
1168
1115
|
|
1169
|
-
**
|
1116
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1117
|
+
|
1118
|
+
</dd>
|
1119
|
+
</dl>
|
1120
|
+
|
1121
|
+
<dl>
|
1122
|
+
<dd>
|
1123
|
+
|
1124
|
+
**requestOptions:** `Windows.RequestOptions`
|
1125
|
+
|
1126
|
+
</dd>
|
1127
|
+
</dl>
|
1128
|
+
</dd>
|
1129
|
+
</dl>
|
1130
|
+
|
1131
|
+
</dd>
|
1132
|
+
</dl>
|
1133
|
+
</details>
|
1134
|
+
|
1135
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1136
|
+
<dl>
|
1137
|
+
<dd>
|
1138
|
+
|
1139
|
+
#### 📝 Description
|
1140
|
+
|
1141
|
+
<dl>
|
1142
|
+
<dd>
|
1143
|
+
|
1144
|
+
<dl>
|
1145
|
+
<dd>
|
1146
|
+
|
1147
|
+
Execute a click interaction in a specific browser window
|
1148
|
+
|
1149
|
+
</dd>
|
1150
|
+
</dl>
|
1151
|
+
</dd>
|
1152
|
+
</dl>
|
1153
|
+
|
1154
|
+
#### 🔌 Usage
|
1155
|
+
|
1156
|
+
<dl>
|
1157
|
+
<dd>
|
1158
|
+
|
1159
|
+
<dl>
|
1160
|
+
<dd>
|
1161
|
+
|
1162
|
+
```typescript
|
1163
|
+
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1164
|
+
elementDescription: "The login button",
|
1165
|
+
});
|
1166
|
+
```
|
1167
|
+
|
1168
|
+
</dd>
|
1169
|
+
</dl>
|
1170
|
+
</dd>
|
1171
|
+
</dl>
|
1172
|
+
|
1173
|
+
#### ⚙️ Parameters
|
1174
|
+
|
1175
|
+
<dl>
|
1176
|
+
<dd>
|
1177
|
+
|
1178
|
+
<dl>
|
1179
|
+
<dd>
|
1180
|
+
|
1181
|
+
**sessionId:** `string` — The session id for the window.
|
1182
|
+
|
1183
|
+
</dd>
|
1184
|
+
</dl>
|
1185
|
+
|
1186
|
+
<dl>
|
1187
|
+
<dd>
|
1188
|
+
|
1189
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1190
|
+
|
1191
|
+
</dd>
|
1192
|
+
</dl>
|
1193
|
+
|
1194
|
+
<dl>
|
1195
|
+
<dd>
|
1196
|
+
|
1197
|
+
**request:** `Airtop.SessionClickHandlerRequestBody`
|
1198
|
+
|
1199
|
+
</dd>
|
1200
|
+
</dl>
|
1201
|
+
|
1202
|
+
<dl>
|
1203
|
+
<dd>
|
1204
|
+
|
1205
|
+
**requestOptions:** `Windows.RequestOptions`
|
1206
|
+
|
1207
|
+
</dd>
|
1208
|
+
</dl>
|
1209
|
+
</dd>
|
1210
|
+
</dl>
|
1211
|
+
|
1212
|
+
</dd>
|
1213
|
+
</dl>
|
1214
|
+
</details>
|
1215
|
+
|
1216
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1217
|
+
<dl>
|
1218
|
+
<dd>
|
1219
|
+
|
1220
|
+
#### 📝 Description
|
1221
|
+
|
1222
|
+
<dl>
|
1223
|
+
<dd>
|
1224
|
+
|
1225
|
+
<dl>
|
1226
|
+
<dd>
|
1227
|
+
|
1228
|
+
Execute a hover interaction in a specific browser window
|
1229
|
+
|
1230
|
+
</dd>
|
1231
|
+
</dl>
|
1232
|
+
</dd>
|
1233
|
+
</dl>
|
1234
|
+
|
1235
|
+
#### 🔌 Usage
|
1236
|
+
|
1237
|
+
<dl>
|
1238
|
+
<dd>
|
1239
|
+
|
1240
|
+
<dl>
|
1241
|
+
<dd>
|
1242
|
+
|
1243
|
+
```typescript
|
1244
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1245
|
+
elementDescription: "The search box input in the top right corner",
|
1246
|
+
});
|
1247
|
+
```
|
1248
|
+
|
1249
|
+
</dd>
|
1250
|
+
</dl>
|
1251
|
+
</dd>
|
1252
|
+
</dl>
|
1253
|
+
|
1254
|
+
#### ⚙️ Parameters
|
1255
|
+
|
1256
|
+
<dl>
|
1257
|
+
<dd>
|
1258
|
+
|
1259
|
+
<dl>
|
1260
|
+
<dd>
|
1261
|
+
|
1262
|
+
**sessionId:** `string` — The session id for the window.
|
1263
|
+
|
1264
|
+
</dd>
|
1265
|
+
</dl>
|
1266
|
+
|
1267
|
+
<dl>
|
1268
|
+
<dd>
|
1269
|
+
|
1270
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1271
|
+
|
1272
|
+
</dd>
|
1273
|
+
</dl>
|
1274
|
+
|
1275
|
+
<dl>
|
1276
|
+
<dd>
|
1277
|
+
|
1278
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
1279
|
+
|
1280
|
+
</dd>
|
1281
|
+
</dl>
|
1282
|
+
|
1283
|
+
<dl>
|
1284
|
+
<dd>
|
1285
|
+
|
1286
|
+
**requestOptions:** `Windows.RequestOptions`
|
1287
|
+
|
1288
|
+
</dd>
|
1289
|
+
</dl>
|
1290
|
+
</dd>
|
1291
|
+
</dl>
|
1292
|
+
|
1293
|
+
</dd>
|
1294
|
+
</dl>
|
1295
|
+
</details>
|
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
|
+
|
1361
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1362
|
+
<dl>
|
1363
|
+
<dd>
|
1364
|
+
|
1365
|
+
#### 📝 Description
|
1366
|
+
|
1367
|
+
<dl>
|
1368
|
+
<dd>
|
1369
|
+
|
1370
|
+
<dl>
|
1371
|
+
<dd>
|
1372
|
+
|
1373
|
+
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?).
|
1374
|
+
|
1375
|
+
</dd>
|
1376
|
+
</dl>
|
1377
|
+
</dd>
|
1378
|
+
</dl>
|
1379
|
+
|
1380
|
+
#### 🔌 Usage
|
1381
|
+
|
1382
|
+
<dl>
|
1383
|
+
<dd>
|
1384
|
+
|
1385
|
+
<dl>
|
1386
|
+
<dd>
|
1387
|
+
|
1388
|
+
```typescript
|
1389
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1390
|
+
prompt: "What is the main idea of this page?",
|
1391
|
+
});
|
1392
|
+
```
|
1393
|
+
|
1394
|
+
</dd>
|
1395
|
+
</dl>
|
1396
|
+
</dd>
|
1397
|
+
</dl>
|
1398
|
+
|
1399
|
+
#### ⚙️ Parameters
|
1400
|
+
|
1401
|
+
<dl>
|
1402
|
+
<dd>
|
1403
|
+
|
1404
|
+
<dl>
|
1405
|
+
<dd>
|
1406
|
+
|
1407
|
+
**sessionId:** `string` — The session id for the window.
|
1408
|
+
|
1409
|
+
</dd>
|
1410
|
+
</dl>
|
1411
|
+
|
1412
|
+
<dl>
|
1413
|
+
<dd>
|
1414
|
+
|
1415
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1416
|
+
|
1417
|
+
</dd>
|
1418
|
+
</dl>
|
1419
|
+
|
1420
|
+
<dl>
|
1421
|
+
<dd>
|
1422
|
+
|
1423
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
1424
|
+
|
1425
|
+
</dd>
|
1426
|
+
</dl>
|
1427
|
+
|
1428
|
+
<dl>
|
1429
|
+
<dd>
|
1430
|
+
|
1431
|
+
**requestOptions:** `Windows.RequestOptions`
|
1432
|
+
|
1433
|
+
</dd>
|
1434
|
+
</dl>
|
1435
|
+
</dd>
|
1436
|
+
</dl>
|
1437
|
+
|
1438
|
+
</dd>
|
1439
|
+
</dl>
|
1440
|
+
</details>
|
1441
|
+
|
1442
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1443
|
+
<dl>
|
1444
|
+
<dd>
|
1445
|
+
|
1446
|
+
#### 📝 Description
|
1447
|
+
|
1448
|
+
<dl>
|
1449
|
+
<dd>
|
1450
|
+
|
1451
|
+
<dl>
|
1452
|
+
<dd>
|
1453
|
+
|
1454
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
1455
|
+
|
1456
|
+
</dd>
|
1457
|
+
</dl>
|
1458
|
+
</dd>
|
1459
|
+
</dl>
|
1460
|
+
|
1461
|
+
#### 🔌 Usage
|
1462
|
+
|
1463
|
+
<dl>
|
1464
|
+
<dd>
|
1465
|
+
|
1466
|
+
<dl>
|
1467
|
+
<dd>
|
1468
|
+
|
1469
|
+
```typescript
|
1470
|
+
await client.windows.paginatedExtraction(
|
1471
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
1472
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
1473
|
+
{
|
1474
|
+
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.",
|
1475
|
+
}
|
1476
|
+
);
|
1477
|
+
```
|
1478
|
+
|
1479
|
+
</dd>
|
1480
|
+
</dl>
|
1481
|
+
</dd>
|
1482
|
+
</dl>
|
1483
|
+
|
1484
|
+
#### ⚙️ Parameters
|
1485
|
+
|
1486
|
+
<dl>
|
1487
|
+
<dd>
|
1488
|
+
|
1489
|
+
<dl>
|
1490
|
+
<dd>
|
1491
|
+
|
1492
|
+
**sessionId:** `string` — The session id for the window.
|
1493
|
+
|
1494
|
+
</dd>
|
1495
|
+
</dl>
|
1496
|
+
|
1497
|
+
<dl>
|
1498
|
+
<dd>
|
1499
|
+
|
1500
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1501
|
+
|
1502
|
+
</dd>
|
1503
|
+
</dl>
|
1504
|
+
|
1505
|
+
<dl>
|
1506
|
+
<dd>
|
1507
|
+
|
1508
|
+
**request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
|
1509
|
+
|
1510
|
+
</dd>
|
1511
|
+
</dl>
|
1512
|
+
|
1513
|
+
<dl>
|
1514
|
+
<dd>
|
1515
|
+
|
1516
|
+
**requestOptions:** `Windows.RequestOptions`
|
1517
|
+
|
1518
|
+
</dd>
|
1519
|
+
</dl>
|
1520
|
+
</dd>
|
1521
|
+
</dl>
|
1522
|
+
|
1523
|
+
</dd>
|
1524
|
+
</dl>
|
1525
|
+
</details>
|
1526
|
+
|
1527
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1528
|
+
<dl>
|
1529
|
+
<dd>
|
1530
|
+
|
1531
|
+
#### 📝 Description
|
1532
|
+
|
1533
|
+
<dl>
|
1534
|
+
<dd>
|
1535
|
+
|
1536
|
+
<dl>
|
1537
|
+
<dd>
|
1538
|
+
|
1539
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
1540
|
+
|
1541
|
+
</dd>
|
1542
|
+
</dl>
|
1543
|
+
</dd>
|
1544
|
+
</dl>
|
1545
|
+
|
1546
|
+
#### 🔌 Usage
|
1547
|
+
|
1548
|
+
<dl>
|
1549
|
+
<dd>
|
1550
|
+
|
1551
|
+
<dl>
|
1552
|
+
<dd>
|
1553
|
+
|
1554
|
+
```typescript
|
1555
|
+
await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1556
|
+
prompt: "What is the main idea of this page?",
|
1557
|
+
});
|
1558
|
+
```
|
1559
|
+
|
1560
|
+
</dd>
|
1561
|
+
</dl>
|
1562
|
+
</dd>
|
1563
|
+
</dl>
|
1564
|
+
|
1565
|
+
#### ⚙️ Parameters
|
1566
|
+
|
1567
|
+
<dl>
|
1568
|
+
<dd>
|
1569
|
+
|
1570
|
+
<dl>
|
1571
|
+
<dd>
|
1572
|
+
|
1573
|
+
**sessionId:** `string` — The session id for the window.
|
1574
|
+
|
1575
|
+
</dd>
|
1576
|
+
</dl>
|
1577
|
+
|
1578
|
+
<dl>
|
1579
|
+
<dd>
|
1580
|
+
|
1581
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1582
|
+
|
1583
|
+
</dd>
|
1584
|
+
</dl>
|
1585
|
+
|
1586
|
+
<dl>
|
1587
|
+
<dd>
|
1588
|
+
|
1589
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
1590
|
+
|
1591
|
+
</dd>
|
1592
|
+
</dl>
|
1593
|
+
|
1594
|
+
<dl>
|
1595
|
+
<dd>
|
1596
|
+
|
1597
|
+
**requestOptions:** `Windows.RequestOptions`
|
1598
|
+
|
1599
|
+
</dd>
|
1600
|
+
</dl>
|
1601
|
+
</dd>
|
1602
|
+
</dl>
|
1603
|
+
|
1604
|
+
</dd>
|
1605
|
+
</dl>
|
1606
|
+
</details>
|
1607
|
+
|
1608
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
1609
|
+
<dl>
|
1610
|
+
<dd>
|
1611
|
+
|
1612
|
+
#### 📝 Description
|
1613
|
+
|
1614
|
+
<dl>
|
1615
|
+
<dd>
|
1616
|
+
|
1617
|
+
<dl>
|
1618
|
+
<dd>
|
1619
|
+
|
1620
|
+
Scrape a window and return the content as markdown
|
1621
|
+
|
1622
|
+
</dd>
|
1623
|
+
</dl>
|
1624
|
+
</dd>
|
1625
|
+
</dl>
|
1626
|
+
|
1627
|
+
#### 🔌 Usage
|
1628
|
+
|
1629
|
+
<dl>
|
1630
|
+
<dd>
|
1631
|
+
|
1632
|
+
<dl>
|
1633
|
+
<dd>
|
1634
|
+
|
1635
|
+
```typescript
|
1636
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1637
|
+
```
|
1638
|
+
|
1639
|
+
</dd>
|
1640
|
+
</dl>
|
1641
|
+
</dd>
|
1642
|
+
</dl>
|
1643
|
+
|
1644
|
+
#### ⚙️ Parameters
|
1645
|
+
|
1646
|
+
<dl>
|
1647
|
+
<dd>
|
1648
|
+
|
1649
|
+
<dl>
|
1650
|
+
<dd>
|
1651
|
+
|
1652
|
+
**sessionId:** `string` — The session id for the window.
|
1653
|
+
|
1654
|
+
</dd>
|
1655
|
+
</dl>
|
1656
|
+
|
1657
|
+
<dl>
|
1658
|
+
<dd>
|
1659
|
+
|
1660
|
+
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
1661
|
+
|
1662
|
+
</dd>
|
1663
|
+
</dl>
|
1664
|
+
|
1665
|
+
<dl>
|
1666
|
+
<dd>
|
1667
|
+
|
1668
|
+
**request:** `Airtop.ScrapeContentRequest`
|
1669
|
+
|
1670
|
+
</dd>
|
1671
|
+
</dl>
|
1672
|
+
|
1673
|
+
<dl>
|
1674
|
+
<dd>
|
1675
|
+
|
1676
|
+
**requestOptions:** `Windows.RequestOptions`
|
1677
|
+
|
1678
|
+
</dd>
|
1679
|
+
</dl>
|
1680
|
+
</dd>
|
1681
|
+
</dl>
|
1682
|
+
|
1683
|
+
</dd>
|
1684
|
+
</dl>
|
1685
|
+
</details>
|
1686
|
+
|
1687
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1688
|
+
<dl>
|
1689
|
+
<dd>
|
1690
|
+
|
1691
|
+
#### 📝 Description
|
1692
|
+
|
1693
|
+
<dl>
|
1694
|
+
<dd>
|
1695
|
+
|
1696
|
+
<dl>
|
1697
|
+
<dd>
|
1698
|
+
|
1699
|
+
Take a screenshot of a browser window
|
1700
|
+
|
1701
|
+
</dd>
|
1702
|
+
</dl>
|
1703
|
+
</dd>
|
1704
|
+
</dl>
|
1705
|
+
|
1706
|
+
#### 🔌 Usage
|
1707
|
+
|
1708
|
+
<dl>
|
1709
|
+
<dd>
|
1710
|
+
|
1711
|
+
<dl>
|
1712
|
+
<dd>
|
1713
|
+
|
1714
|
+
```typescript
|
1715
|
+
await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1716
|
+
```
|
1717
|
+
|
1718
|
+
</dd>
|
1719
|
+
</dl>
|
1720
|
+
</dd>
|
1721
|
+
</dl>
|
1722
|
+
|
1723
|
+
#### ⚙️ Parameters
|
1724
|
+
|
1725
|
+
<dl>
|
1726
|
+
<dd>
|
1727
|
+
|
1728
|
+
<dl>
|
1729
|
+
<dd>
|
1730
|
+
|
1731
|
+
**sessionId:** `string` — The session id for the window.
|
1732
|
+
|
1733
|
+
</dd>
|
1734
|
+
</dl>
|
1735
|
+
|
1736
|
+
<dl>
|
1737
|
+
<dd>
|
1738
|
+
|
1739
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1740
|
+
|
1741
|
+
</dd>
|
1742
|
+
</dl>
|
1743
|
+
|
1744
|
+
<dl>
|
1745
|
+
<dd>
|
1746
|
+
|
1747
|
+
**request:** `Airtop.SessionScreenshotHandlerRequestBody`
|
1748
|
+
|
1749
|
+
</dd>
|
1750
|
+
</dl>
|
1751
|
+
|
1752
|
+
<dl>
|
1753
|
+
<dd>
|
1754
|
+
|
1755
|
+
**requestOptions:** `Windows.RequestOptions`
|
1756
|
+
|
1757
|
+
</dd>
|
1758
|
+
</dl>
|
1759
|
+
</dd>
|
1760
|
+
</dl>
|
1761
|
+
|
1762
|
+
</dd>
|
1763
|
+
</dl>
|
1764
|
+
</details>
|
1765
|
+
|
1766
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1767
|
+
<dl>
|
1768
|
+
<dd>
|
1769
|
+
|
1770
|
+
#### 📝 Description
|
1771
|
+
|
1772
|
+
<dl>
|
1773
|
+
<dd>
|
1774
|
+
|
1775
|
+
<dl>
|
1776
|
+
<dd>
|
1777
|
+
|
1778
|
+
Execute a scroll interaction in a specific browser window
|
1779
|
+
|
1780
|
+
</dd>
|
1781
|
+
</dl>
|
1782
|
+
</dd>
|
1783
|
+
</dl>
|
1784
|
+
|
1785
|
+
#### 🔌 Usage
|
1786
|
+
|
1787
|
+
<dl>
|
1788
|
+
<dd>
|
1789
|
+
|
1790
|
+
<dl>
|
1791
|
+
<dd>
|
1792
|
+
|
1793
|
+
```typescript
|
1794
|
+
await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1795
|
+
```
|
1796
|
+
|
1797
|
+
</dd>
|
1798
|
+
</dl>
|
1799
|
+
</dd>
|
1800
|
+
</dl>
|
1801
|
+
|
1802
|
+
#### ⚙️ Parameters
|
1803
|
+
|
1804
|
+
<dl>
|
1805
|
+
<dd>
|
1806
|
+
|
1807
|
+
<dl>
|
1808
|
+
<dd>
|
1809
|
+
|
1810
|
+
**sessionId:** `string` — The session id for the window.
|
1811
|
+
|
1812
|
+
</dd>
|
1813
|
+
</dl>
|
1814
|
+
|
1815
|
+
<dl>
|
1816
|
+
<dd>
|
1817
|
+
|
1818
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1819
|
+
|
1820
|
+
</dd>
|
1821
|
+
</dl>
|
1822
|
+
|
1823
|
+
<dl>
|
1824
|
+
<dd>
|
1825
|
+
|
1826
|
+
**request:** `Airtop.SessionScrollHandlerRequestBody`
|
1827
|
+
|
1828
|
+
</dd>
|
1829
|
+
</dl>
|
1830
|
+
|
1831
|
+
<dl>
|
1832
|
+
<dd>
|
1833
|
+
|
1834
|
+
**requestOptions:** `Windows.RequestOptions`
|
1835
|
+
|
1836
|
+
</dd>
|
1837
|
+
</dl>
|
1838
|
+
</dd>
|
1839
|
+
</dl>
|
1840
|
+
|
1841
|
+
</dd>
|
1842
|
+
</dl>
|
1843
|
+
</details>
|
1844
|
+
|
1845
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1846
|
+
<dl>
|
1847
|
+
<dd>
|
1848
|
+
|
1849
|
+
#### 📝 Description
|
1850
|
+
|
1851
|
+
<dl>
|
1852
|
+
<dd>
|
1853
|
+
|
1854
|
+
<dl>
|
1855
|
+
<dd>
|
1856
|
+
|
1857
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
1858
|
+
|
1859
|
+
</dd>
|
1860
|
+
</dl>
|
1861
|
+
</dd>
|
1862
|
+
</dl>
|
1863
|
+
|
1864
|
+
#### 🔌 Usage
|
1865
|
+
|
1866
|
+
<dl>
|
1867
|
+
<dd>
|
1868
|
+
|
1869
|
+
<dl>
|
1870
|
+
<dd>
|
1871
|
+
|
1872
|
+
```typescript
|
1873
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1874
|
+
```
|
1875
|
+
|
1876
|
+
</dd>
|
1877
|
+
</dl>
|
1878
|
+
</dd>
|
1879
|
+
</dl>
|
1880
|
+
|
1881
|
+
#### ⚙️ Parameters
|
1882
|
+
|
1883
|
+
<dl>
|
1884
|
+
<dd>
|
1885
|
+
|
1886
|
+
<dl>
|
1887
|
+
<dd>
|
1888
|
+
|
1889
|
+
**sessionId:** `string` — The session id for the window.
|
1890
|
+
|
1891
|
+
</dd>
|
1892
|
+
</dl>
|
1893
|
+
|
1894
|
+
<dl>
|
1895
|
+
<dd>
|
1896
|
+
|
1897
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
1898
|
+
|
1899
|
+
</dd>
|
1900
|
+
</dl>
|
1901
|
+
|
1902
|
+
<dl>
|
1903
|
+
<dd>
|
1904
|
+
|
1905
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
1906
|
+
|
1907
|
+
</dd>
|
1908
|
+
</dl>
|
1909
|
+
|
1910
|
+
<dl>
|
1911
|
+
<dd>
|
1912
|
+
|
1913
|
+
**requestOptions:** `Windows.RequestOptions`
|
1914
|
+
|
1915
|
+
</dd>
|
1916
|
+
</dl>
|
1917
|
+
</dd>
|
1918
|
+
</dl>
|
1919
|
+
|
1920
|
+
</dd>
|
1921
|
+
</dl>
|
1922
|
+
</details>
|
1923
|
+
|
1924
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1925
|
+
<dl>
|
1926
|
+
<dd>
|
1927
|
+
|
1928
|
+
#### 📝 Description
|
1929
|
+
|
1930
|
+
<dl>
|
1931
|
+
<dd>
|
1932
|
+
|
1933
|
+
<dl>
|
1934
|
+
<dd>
|
1935
|
+
|
1936
|
+
Execute a type interaction in a specific browser window
|
1937
|
+
|
1938
|
+
</dd>
|
1939
|
+
</dl>
|
1940
|
+
</dd>
|
1941
|
+
</dl>
|
1942
|
+
|
1943
|
+
#### 🔌 Usage
|
1944
|
+
|
1945
|
+
<dl>
|
1946
|
+
<dd>
|
1947
|
+
|
1948
|
+
<dl>
|
1949
|
+
<dd>
|
1950
|
+
|
1951
|
+
```typescript
|
1952
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1953
|
+
text: "Example text",
|
1954
|
+
});
|
1955
|
+
```
|
1956
|
+
|
1957
|
+
</dd>
|
1958
|
+
</dl>
|
1959
|
+
</dd>
|
1960
|
+
</dl>
|
1961
|
+
|
1962
|
+
#### ⚙️ Parameters
|
1963
|
+
|
1964
|
+
<dl>
|
1965
|
+
<dd>
|
1966
|
+
|
1967
|
+
<dl>
|
1968
|
+
<dd>
|
1969
|
+
|
1970
|
+
**sessionId:** `string` — The session id for the window.
|
1971
|
+
|
1972
|
+
</dd>
|
1973
|
+
</dl>
|
1974
|
+
|
1975
|
+
<dl>
|
1976
|
+
<dd>
|
1977
|
+
|
1978
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1979
|
+
|
1980
|
+
</dd>
|
1981
|
+
</dl>
|
1982
|
+
|
1983
|
+
<dl>
|
1984
|
+
<dd>
|
1985
|
+
|
1986
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
1987
|
+
|
1988
|
+
</dd>
|
1989
|
+
</dl>
|
1990
|
+
|
1991
|
+
<dl>
|
1992
|
+
<dd>
|
1993
|
+
|
1994
|
+
**requestOptions:** `Windows.RequestOptions`
|
1995
|
+
|
1996
|
+
</dd>
|
1997
|
+
</dl>
|
1998
|
+
</dd>
|
1999
|
+
</dl>
|
2000
|
+
|
2001
|
+
</dd>
|
2002
|
+
</dl>
|
2003
|
+
</details>
|
2004
|
+
|
2005
|
+
## Automations
|
2006
|
+
|
2007
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">listAutomations</a>() -> Airtop.ListAutomationsOutput</code></summary>
|
2008
|
+
<dl>
|
2009
|
+
<dd>
|
2010
|
+
|
2011
|
+
#### 📝 Description
|
2012
|
+
|
2013
|
+
<dl>
|
2014
|
+
<dd>
|
2015
|
+
|
2016
|
+
<dl>
|
2017
|
+
<dd>
|
2018
|
+
|
2019
|
+
List all automations for a given organization
|
2020
|
+
|
2021
|
+
</dd>
|
2022
|
+
</dl>
|
2023
|
+
</dd>
|
2024
|
+
</dl>
|
2025
|
+
|
2026
|
+
#### 🔌 Usage
|
2027
|
+
|
2028
|
+
<dl>
|
2029
|
+
<dd>
|
2030
|
+
|
2031
|
+
<dl>
|
2032
|
+
<dd>
|
2033
|
+
|
2034
|
+
```typescript
|
2035
|
+
await client.automations.listAutomations();
|
2036
|
+
```
|
2037
|
+
|
2038
|
+
</dd>
|
2039
|
+
</dl>
|
2040
|
+
</dd>
|
2041
|
+
</dl>
|
2042
|
+
|
2043
|
+
#### ⚙️ Parameters
|
2044
|
+
|
2045
|
+
<dl>
|
2046
|
+
<dd>
|
2047
|
+
|
2048
|
+
<dl>
|
2049
|
+
<dd>
|
2050
|
+
|
2051
|
+
**requestOptions:** `Automations.RequestOptions`
|
2052
|
+
|
2053
|
+
</dd>
|
2054
|
+
</dl>
|
2055
|
+
</dd>
|
2056
|
+
</dl>
|
2057
|
+
|
2058
|
+
</dd>
|
2059
|
+
</dl>
|
2060
|
+
</details>
|
2061
|
+
|
2062
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">updateAutomationDescription</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
|
2063
|
+
<dl>
|
2064
|
+
<dd>
|
2065
|
+
|
2066
|
+
#### 📝 Description
|
2067
|
+
|
2068
|
+
<dl>
|
2069
|
+
<dd>
|
2070
|
+
|
2071
|
+
<dl>
|
2072
|
+
<dd>
|
2073
|
+
|
2074
|
+
Update the description of a specific automation
|
2075
|
+
|
2076
|
+
</dd>
|
2077
|
+
</dl>
|
2078
|
+
</dd>
|
2079
|
+
</dl>
|
2080
|
+
|
2081
|
+
#### 🔌 Usage
|
2082
|
+
|
2083
|
+
<dl>
|
2084
|
+
<dd>
|
2085
|
+
|
2086
|
+
<dl>
|
2087
|
+
<dd>
|
2088
|
+
|
2089
|
+
```typescript
|
2090
|
+
await client.automations.updateAutomationDescription({
|
2091
|
+
description: "description",
|
2092
|
+
id: "id",
|
2093
|
+
orgId: "orgId",
|
2094
|
+
});
|
2095
|
+
```
|
2096
|
+
|
2097
|
+
</dd>
|
2098
|
+
</dl>
|
2099
|
+
</dd>
|
2100
|
+
</dl>
|
2101
|
+
|
2102
|
+
#### ⚙️ Parameters
|
2103
|
+
|
2104
|
+
<dl>
|
2105
|
+
<dd>
|
2106
|
+
|
2107
|
+
<dl>
|
2108
|
+
<dd>
|
2109
|
+
|
2110
|
+
**request:** `Airtop.UpdateAutomationDescriptionInputBody`
|
2111
|
+
|
2112
|
+
</dd>
|
2113
|
+
</dl>
|
2114
|
+
|
2115
|
+
<dl>
|
2116
|
+
<dd>
|
2117
|
+
|
2118
|
+
**requestOptions:** `Automations.RequestOptions`
|
2119
|
+
|
2120
|
+
</dd>
|
2121
|
+
</dl>
|
2122
|
+
</dd>
|
2123
|
+
</dl>
|
2124
|
+
|
2125
|
+
</dd>
|
2126
|
+
</dl>
|
2127
|
+
</details>
|
2128
|
+
|
2129
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">getAutomation</a>(automationId) -> Airtop.AutomationOutput</code></summary>
|
2130
|
+
<dl>
|
2131
|
+
<dd>
|
2132
|
+
|
2133
|
+
#### 📝 Description
|
2134
|
+
|
2135
|
+
<dl>
|
2136
|
+
<dd>
|
2137
|
+
|
2138
|
+
<dl>
|
2139
|
+
<dd>
|
2140
|
+
|
2141
|
+
Get a specific automation by ID
|
2142
|
+
|
2143
|
+
</dd>
|
2144
|
+
</dl>
|
2145
|
+
</dd>
|
2146
|
+
</dl>
|
2147
|
+
|
2148
|
+
#### 🔌 Usage
|
2149
|
+
|
2150
|
+
<dl>
|
2151
|
+
<dd>
|
2152
|
+
|
2153
|
+
<dl>
|
2154
|
+
<dd>
|
2155
|
+
|
2156
|
+
```typescript
|
2157
|
+
await client.automations.getAutomation("automationId");
|
2158
|
+
```
|
2159
|
+
|
2160
|
+
</dd>
|
2161
|
+
</dl>
|
2162
|
+
</dd>
|
2163
|
+
</dl>
|
2164
|
+
|
2165
|
+
#### ⚙️ Parameters
|
2166
|
+
|
2167
|
+
<dl>
|
2168
|
+
<dd>
|
2169
|
+
|
2170
|
+
<dl>
|
2171
|
+
<dd>
|
2172
|
+
|
2173
|
+
**automationId:** `string` — ID of the automation to retrieve
|
2174
|
+
|
2175
|
+
</dd>
|
2176
|
+
</dl>
|
2177
|
+
|
2178
|
+
<dl>
|
2179
|
+
<dd>
|
2180
|
+
|
2181
|
+
**requestOptions:** `Automations.RequestOptions`
|
2182
|
+
|
2183
|
+
</dd>
|
2184
|
+
</dl>
|
2185
|
+
</dd>
|
2186
|
+
</dl>
|
2187
|
+
|
2188
|
+
</dd>
|
2189
|
+
</dl>
|
2190
|
+
</details>
|
2191
|
+
|
2192
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">deleteAutomation</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
|
2193
|
+
<dl>
|
2194
|
+
<dd>
|
2195
|
+
|
2196
|
+
#### 📝 Description
|
2197
|
+
|
2198
|
+
<dl>
|
2199
|
+
<dd>
|
2200
|
+
|
2201
|
+
<dl>
|
2202
|
+
<dd>
|
2203
|
+
|
2204
|
+
Delete a specific automation
|
2205
|
+
|
2206
|
+
</dd>
|
2207
|
+
</dl>
|
2208
|
+
</dd>
|
2209
|
+
</dl>
|
2210
|
+
|
2211
|
+
#### 🔌 Usage
|
2212
|
+
|
2213
|
+
<dl>
|
2214
|
+
<dd>
|
2215
|
+
|
2216
|
+
<dl>
|
2217
|
+
<dd>
|
2218
|
+
|
2219
|
+
```typescript
|
2220
|
+
await client.automations.deleteAutomation("automationId");
|
2221
|
+
```
|
2222
|
+
|
2223
|
+
</dd>
|
2224
|
+
</dl>
|
2225
|
+
</dd>
|
2226
|
+
</dl>
|
2227
|
+
|
2228
|
+
#### ⚙️ Parameters
|
2229
|
+
|
2230
|
+
<dl>
|
2231
|
+
<dd>
|
2232
|
+
|
2233
|
+
<dl>
|
2234
|
+
<dd>
|
2235
|
+
|
2236
|
+
**automationId:** `string` — ID of the automation to delete
|
2237
|
+
|
2238
|
+
</dd>
|
2239
|
+
</dl>
|
2240
|
+
|
2241
|
+
<dl>
|
2242
|
+
<dd>
|
2243
|
+
|
2244
|
+
**requestOptions:** `Automations.RequestOptions`
|
2245
|
+
|
2246
|
+
</dd>
|
2247
|
+
</dl>
|
2248
|
+
</dd>
|
2249
|
+
</dl>
|
2250
|
+
|
2251
|
+
</dd>
|
2252
|
+
</dl>
|
2253
|
+
</details>
|
2254
|
+
|
2255
|
+
## ExtensionConfigurations
|
2256
|
+
|
2257
|
+
<details><summary><code>client.extensionConfigurations.<a href="/src/api/resources/extensionConfigurations/client/Client.ts">extensionConfigurationGetInfo</a>(name) -> Airtop.ExtensionConfigurationOutput</code></summary>
|
2258
|
+
<dl>
|
2259
|
+
<dd>
|
2260
|
+
|
2261
|
+
#### 📝 Description
|
2262
|
+
|
2263
|
+
<dl>
|
2264
|
+
<dd>
|
2265
|
+
|
2266
|
+
<dl>
|
2267
|
+
<dd>
|
2268
|
+
|
2269
|
+
Get an extension configuration by name
|
2270
|
+
|
2271
|
+
</dd>
|
2272
|
+
</dl>
|
2273
|
+
</dd>
|
2274
|
+
</dl>
|
2275
|
+
|
2276
|
+
#### 🔌 Usage
|
2277
|
+
|
2278
|
+
<dl>
|
2279
|
+
<dd>
|
2280
|
+
|
2281
|
+
<dl>
|
2282
|
+
<dd>
|
2283
|
+
|
2284
|
+
```typescript
|
2285
|
+
await client.extensionConfigurations.extensionConfigurationGetInfo("my-configuration");
|
2286
|
+
```
|
2287
|
+
|
2288
|
+
</dd>
|
2289
|
+
</dl>
|
2290
|
+
</dd>
|
2291
|
+
</dl>
|
2292
|
+
|
2293
|
+
#### ⚙️ Parameters
|
2294
|
+
|
2295
|
+
<dl>
|
2296
|
+
<dd>
|
2297
|
+
|
2298
|
+
<dl>
|
2299
|
+
<dd>
|
2300
|
+
|
2301
|
+
**name:** `string` — Name of the extension configuration to get
|
2302
|
+
|
2303
|
+
</dd>
|
2304
|
+
</dl>
|
2305
|
+
|
2306
|
+
<dl>
|
2307
|
+
<dd>
|
2308
|
+
|
2309
|
+
**requestOptions:** `ExtensionConfigurations.RequestOptions`
|
2310
|
+
|
2311
|
+
</dd>
|
2312
|
+
</dl>
|
2313
|
+
</dd>
|
2314
|
+
</dl>
|
2315
|
+
|
2316
|
+
</dd>
|
2317
|
+
</dl>
|
2318
|
+
</details>
|
2319
|
+
|
2320
|
+
## Profiles
|
2321
|
+
|
2322
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
2323
|
+
<dl>
|
2324
|
+
<dd>
|
2325
|
+
|
2326
|
+
#### 📝 Description
|
2327
|
+
|
2328
|
+
<dl>
|
2329
|
+
<dd>
|
2330
|
+
|
2331
|
+
<dl>
|
2332
|
+
<dd>
|
2333
|
+
|
2334
|
+
Delete profiles matching by id
|
2335
|
+
|
2336
|
+
</dd>
|
2337
|
+
</dl>
|
2338
|
+
</dd>
|
2339
|
+
</dl>
|
2340
|
+
|
2341
|
+
#### 🔌 Usage
|
2342
|
+
|
2343
|
+
<dl>
|
2344
|
+
<dd>
|
2345
|
+
|
2346
|
+
<dl>
|
2347
|
+
<dd>
|
2348
|
+
|
2349
|
+
```typescript
|
2350
|
+
await client.profiles.delete();
|
2351
|
+
```
|
2352
|
+
|
2353
|
+
</dd>
|
2354
|
+
</dl>
|
2355
|
+
</dd>
|
2356
|
+
</dl>
|
2357
|
+
|
2358
|
+
#### ⚙️ Parameters
|
2359
|
+
|
2360
|
+
<dl>
|
2361
|
+
<dd>
|
2362
|
+
|
2363
|
+
<dl>
|
2364
|
+
<dd>
|
2365
|
+
|
2366
|
+
**request:** `Airtop.ProfilesDeleteRequest`
|
2367
|
+
|
2368
|
+
</dd>
|
2369
|
+
</dl>
|
2370
|
+
|
2371
|
+
<dl>
|
2372
|
+
<dd>
|
2373
|
+
|
2374
|
+
**requestOptions:** `Profiles.RequestOptions`
|
2375
|
+
|
2376
|
+
</dd>
|
2377
|
+
</dl>
|
2378
|
+
</dd>
|
2379
|
+
</dl>
|
2380
|
+
|
2381
|
+
</dd>
|
2382
|
+
</dl>
|
2383
|
+
</details>
|
2384
|
+
|
2385
|
+
## Requests
|
2386
|
+
|
2387
|
+
<details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
|
2388
|
+
<dl>
|
2389
|
+
<dd>
|
2390
|
+
|
2391
|
+
#### 🔌 Usage
|
2392
|
+
|
2393
|
+
<dl>
|
2394
|
+
<dd>
|
2395
|
+
|
2396
|
+
<dl>
|
2397
|
+
<dd>
|
2398
|
+
|
2399
|
+
```typescript
|
2400
|
+
await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
2401
|
+
```
|
2402
|
+
|
2403
|
+
</dd>
|
2404
|
+
</dl>
|
2405
|
+
</dd>
|
2406
|
+
</dl>
|
2407
|
+
|
2408
|
+
#### ⚙️ Parameters
|
2409
|
+
|
2410
|
+
<dl>
|
2411
|
+
<dd>
|
2412
|
+
|
2413
|
+
<dl>
|
2414
|
+
<dd>
|
2415
|
+
|
2416
|
+
**requestId:** `string` — The ID of the request to check.
|
2417
|
+
|
2418
|
+
</dd>
|
2419
|
+
</dl>
|
2420
|
+
|
2421
|
+
<dl>
|
2422
|
+
<dd>
|
2423
|
+
|
2424
|
+
**requestOptions:** `Requests.RequestOptions`
|
1170
2425
|
|
1171
2426
|
</dd>
|
1172
2427
|
</dl>
|