@airtop/sdk 0.1.34 → 0.1.36-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 +14 -4
- package/Client.js +16 -6
- package/README.md +35 -17
- package/api/errors/ForbiddenError.d.ts +8 -0
- package/api/errors/ForbiddenError.js +51 -0
- package/api/errors/InternalServerError.js +17 -7
- package/api/errors/NotFoundError.js +17 -7
- package/api/errors/UnauthorizedError.d.ts +8 -0
- package/api/errors/UnauthorizedError.js +51 -0
- package/api/errors/UnprocessableEntityError.js +17 -7
- package/api/errors/index.d.ts +2 -0
- package/api/errors/index.js +2 -0
- package/api/resources/automations/client/Client.d.ts +91 -0
- package/api/resources/automations/client/Client.js +429 -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/files/client/Client.d.ts +69 -0
- package/api/resources/files/client/Client.js +286 -0
- package/api/resources/files/client/index.d.ts +1 -0
- package/api/resources/files/client/index.js +17 -0
- package/api/resources/files/client/requests/CreateFileRestInputV1.d.ts +22 -0
- package/api/resources/files/client/requests/CreateFileRestInputV1.js +5 -0
- package/api/resources/files/client/requests/FilesListRequest.d.ts +24 -0
- package/api/resources/files/client/requests/FilesListRequest.js +5 -0
- package/api/resources/files/client/requests/index.d.ts +2 -0
- package/api/resources/files/client/requests/index.js +2 -0
- package/api/resources/files/index.d.ts +2 -0
- package/api/resources/files/index.js +18 -0
- package/api/resources/files/types/CreateFileRestInputV1FileType.d.ts +13 -0
- package/api/resources/files/types/CreateFileRestInputV1FileType.js +12 -0
- package/api/resources/files/types/index.d.ts +1 -0
- package/api/resources/files/types/index.js +17 -0
- package/api/resources/index.d.ts +5 -0
- package/api/resources/index.js +23 -8
- package/api/resources/profiles/client/Client.d.ts +4 -0
- package/api/resources/profiles/client/Client.js +23 -21
- package/api/resources/requests/client/Client.d.ts +4 -0
- package/api/resources/requests/client/Client.js +21 -19
- package/api/resources/sessions/client/Client.d.ts +5 -1
- package/api/resources/sessions/client/Client.js +52 -88
- package/api/resources/sessions/client/requests/SessionsEventsRequest.d.ts +7 -0
- package/api/resources/sessions/types/SessionsEventsResponse.d.ts +7 -7
- package/api/resources/sessions/types/SessionsListRequestStatus.d.ts +1 -1
- package/api/resources/sessions/types/index.d.ts +2 -2
- package/api/resources/sessions/types/index.js +2 -2
- package/api/resources/windows/client/Client.d.ts +194 -0
- package/api/resources/windows/client/Client.js +924 -199
- 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/AsyncCreateFormFillerRequest.d.ts +23 -0
- package/api/resources/windows/client/requests/AsyncCreateFormFillerRequest.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/AsyncFillFormRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/AsyncFillFormRequest.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/CreateFormFillerRequest.d.ts +23 -0
- package/api/resources/windows/client/requests/CreateFormFillerRequest.js +5 -0
- package/api/resources/windows/client/requests/FillFormRequest.d.ts +27 -0
- package/api/resources/windows/client/requests/FillFormRequest.js +5 -0
- package/api/resources/windows/client/requests/index.d.ts +15 -0
- package/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +1 -1
- package/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +1 -1
- 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/BrowserWaitNavigationConfigWaitUntil.d.ts +1 -1
- package/api/types/ClickConfigClickType.d.ts +1 -1
- package/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
- package/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
- package/api/types/CreateFileV1.d.ts +24 -0
- package/api/types/CreateFileV1.js +5 -0
- package/api/types/CreateFileV1FileType.d.ts +13 -0
- package/api/types/CreateFileV1FileType.js +12 -0
- package/api/types/DeleteAutomationOutputWrapperBody.d.ts +4 -0
- package/api/types/DeleteAutomationOutputWrapperBody.js +5 -0
- package/api/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +10 -0
- package/api/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +5 -0
- package/api/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +10 -0
- package/api/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +5 -0
- package/api/types/ExternalFile.d.ts +33 -0
- package/api/types/ExternalFile.js +5 -0
- package/api/types/ExternalSessionAiResponseMetadataStatus.d.ts +1 -1
- package/api/types/FilesResponse.d.ts +10 -0
- package/api/types/FilesResponse.js +5 -0
- package/api/types/FilesWithPagination.d.ts +10 -0
- package/api/types/FilesWithPagination.js +5 -0
- package/api/types/GetFileV1.d.ts +24 -0
- package/api/types/GetFileV1.js +5 -0
- package/api/types/GetFileV1FileType.d.ts +13 -0
- package/api/types/GetFileV1FileType.js +12 -0
- package/api/types/ListAutomationsOutput.d.ts +7 -0
- package/api/types/ListAutomationsOutput.js +5 -0
- package/api/types/MonitorConfigIncludeVisualAnalysis.d.ts +1 -1
- package/api/types/Proxy.d.ts +1 -1
- package/api/types/SessionConfigV1Proxy.d.ts +1 -1
- package/api/types/StatusMessageStatus.d.ts +1 -1
- package/api/types/VisualAnalysisConfigPartitionDirection.d.ts +1 -1
- package/api/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +1 -1
- package/api/types/VisualAnalysisConfigScope.d.ts +1 -1
- package/api/types/index.d.ts +15 -0
- package/api/types/index.js +15 -0
- package/biome.json +3 -0
- package/core/auth/BearerToken.d.ts +1 -1
- package/core/fetcher/APIResponse.d.ts +1 -1
- package/core/fetcher/Fetcher.d.ts +3 -3
- package/core/fetcher/Fetcher.js +6 -5
- package/core/fetcher/Supplier.d.ts +1 -1
- package/core/fetcher/createRequestUrl.d.ts +1 -1
- package/core/fetcher/createRequestUrl.js +1 -2
- package/core/fetcher/getFetchFn.js +18 -9
- package/core/fetcher/getHeader.js +1 -2
- package/core/fetcher/getRequestBody.js +5 -5
- package/core/fetcher/getResponseBody.js +4 -2
- package/core/fetcher/makeRequest.d.ts +1 -1
- package/core/fetcher/requestWithRetries.js +17 -9
- package/core/fetcher/signals.d.ts +0 -1
- package/core/fetcher/signals.js +2 -3
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +1 -2
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +4 -2
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +1 -2
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +6 -4
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +2 -2
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +4 -2
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +1 -1
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +19 -10
- package/core/index.js +17 -7
- package/core/json.d.ts +15 -0
- package/core/json.js +24 -0
- package/core/runtime/runtime.d.ts +1 -1
- package/core/runtime/runtime.js +51 -41
- package/core/schemas/Schema.d.ts +8 -5
- package/core/schemas/Schema.js +3 -0
- package/core/schemas/builders/bigint/bigint.d.ts +2 -0
- package/core/schemas/builders/bigint/bigint.js +53 -0
- package/core/schemas/builders/bigint/index.d.ts +1 -0
- package/core/schemas/builders/bigint/index.js +5 -0
- package/core/schemas/builders/date/date.js +1 -2
- package/core/schemas/builders/enum/enum.js +1 -2
- package/core/schemas/builders/index.d.ts +1 -0
- package/core/schemas/builders/index.js +1 -0
- package/core/schemas/builders/lazy/lazy.d.ts +1 -1
- package/core/schemas/builders/lazy/lazy.js +3 -4
- package/core/schemas/builders/lazy/lazyObject.js +1 -2
- package/core/schemas/builders/list/list.js +1 -2
- package/core/schemas/builders/literals/booleanLiteral.js +1 -2
- package/core/schemas/builders/literals/stringLiteral.js +1 -2
- package/core/schemas/builders/object/object.d.ts +1 -1
- package/core/schemas/builders/object/object.js +31 -3
- package/core/schemas/builders/object/objectWithoutOptionalProperties.d.ts +3 -3
- package/core/schemas/builders/object/objectWithoutOptionalProperties.js +1 -2
- package/core/schemas/builders/object/property.js +2 -3
- package/core/schemas/builders/object/types.d.ts +16 -11
- package/core/schemas/builders/object-like/getObjectLikeUtils.js +2 -3
- package/core/schemas/builders/object-like/types.d.ts +1 -1
- package/core/schemas/builders/record/record.js +2 -4
- package/core/schemas/builders/record/types.d.ts +2 -2
- package/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +4 -0
- package/core/schemas/builders/schema-utils/getSchemaUtils.js +67 -4
- package/core/schemas/builders/schema-utils/stringifyValidationErrors.js +1 -2
- package/core/schemas/builders/set/set.js +1 -2
- package/core/schemas/builders/undiscriminated-union/types.d.ts +4 -4
- package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +1 -2
- package/core/schemas/builders/union/discriminant.js +1 -2
- package/core/schemas/builders/union/types.d.ts +6 -6
- package/core/schemas/builders/union/union.d.ts +1 -1
- package/core/schemas/builders/union/union.js +1 -2
- package/core/schemas/utils/MaybePromise.d.ts +1 -1
- package/core/schemas/utils/addQuestionMarksToNullableProperties.d.ts +4 -4
- package/core/schemas/utils/createIdentitySchemaCreator.js +1 -2
- package/core/schemas/utils/entries.d.ts +1 -1
- package/core/schemas/utils/entries.js +1 -2
- package/core/schemas/utils/filterObject.d.ts +1 -1
- package/core/schemas/utils/filterObject.js +1 -2
- package/core/schemas/utils/getErrorMessageForIncorrectType.js +5 -2
- package/core/schemas/utils/isPlainObject.js +1 -2
- package/core/schemas/utils/keys.d.ts +1 -1
- package/core/schemas/utils/keys.js +1 -2
- package/core/schemas/utils/maybeSkipValidation.js +1 -2
- package/core/schemas/utils/partition.js +1 -2
- package/core/streaming-fetcher/Stream.d.ts +0 -1
- package/core/streaming-fetcher/Stream.js +20 -21
- package/dist/Client.d.ts +14 -4
- package/dist/Client.js +16 -6
- package/dist/api/errors/ForbiddenError.d.ts +8 -0
- package/dist/api/errors/ForbiddenError.js +51 -0
- package/dist/api/errors/InternalServerError.js +17 -7
- package/dist/api/errors/NotFoundError.js +17 -7
- package/dist/api/errors/UnauthorizedError.d.ts +8 -0
- package/dist/api/errors/UnauthorizedError.js +51 -0
- package/dist/api/errors/UnprocessableEntityError.js +17 -7
- 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 +91 -0
- package/dist/api/resources/automations/client/Client.js +429 -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/files/client/Client.d.ts +69 -0
- package/dist/api/resources/files/client/Client.js +286 -0
- package/dist/api/resources/files/client/index.d.ts +1 -0
- package/dist/api/resources/files/client/index.js +17 -0
- package/dist/api/resources/files/client/requests/CreateFileRestInputV1.d.ts +22 -0
- package/dist/api/resources/files/client/requests/CreateFileRestInputV1.js +5 -0
- package/dist/api/resources/files/client/requests/FilesListRequest.d.ts +24 -0
- package/dist/api/resources/files/client/requests/FilesListRequest.js +5 -0
- package/dist/api/resources/files/client/requests/index.d.ts +2 -0
- package/dist/api/resources/files/client/requests/index.js +2 -0
- package/dist/api/resources/files/index.d.ts +2 -0
- package/dist/api/resources/files/index.js +18 -0
- package/dist/api/resources/files/types/CreateFileRestInputV1FileType.d.ts +13 -0
- package/dist/api/resources/files/types/CreateFileRestInputV1FileType.js +12 -0
- package/dist/api/resources/files/types/index.d.ts +1 -0
- package/dist/api/resources/files/types/index.js +17 -0
- package/dist/api/resources/index.d.ts +5 -0
- package/dist/api/resources/index.js +23 -8
- package/dist/api/resources/profiles/client/Client.d.ts +4 -0
- package/dist/api/resources/profiles/client/Client.js +23 -21
- package/dist/api/resources/requests/client/Client.d.ts +4 -0
- package/dist/api/resources/requests/client/Client.js +21 -19
- package/dist/api/resources/sessions/client/Client.d.ts +5 -1
- package/dist/api/resources/sessions/client/Client.js +52 -88
- package/dist/api/resources/sessions/client/requests/SessionsEventsRequest.d.ts +7 -0
- package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +7 -7
- package/dist/api/resources/sessions/types/SessionsListRequestStatus.d.ts +1 -1
- package/dist/api/resources/sessions/types/index.d.ts +2 -2
- package/dist/api/resources/sessions/types/index.js +2 -2
- package/dist/api/resources/windows/client/Client.d.ts +194 -0
- package/dist/api/resources/windows/client/Client.js +924 -199
- 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/AsyncCreateFormFillerRequest.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/AsyncCreateFormFillerRequest.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/AsyncFillFormRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/AsyncFillFormRequest.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/CreateFormFillerRequest.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/CreateFormFillerRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/FillFormRequest.d.ts +27 -0
- package/dist/api/resources/windows/client/requests/FillFormRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +15 -0
- package/dist/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +1 -1
- package/dist/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +1 -1
- 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/BrowserWaitNavigationConfigWaitUntil.d.ts +1 -1
- package/dist/api/types/ClickConfigClickType.d.ts +1 -1
- package/dist/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
- package/dist/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
- package/dist/api/types/CreateFileV1.d.ts +24 -0
- package/dist/api/types/CreateFileV1.js +5 -0
- package/dist/api/types/CreateFileV1FileType.d.ts +13 -0
- package/dist/api/types/CreateFileV1FileType.js +12 -0
- package/dist/api/types/DeleteAutomationOutputWrapperBody.d.ts +4 -0
- package/dist/api/types/DeleteAutomationOutputWrapperBody.js +5 -0
- package/dist/api/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +10 -0
- package/dist/api/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +5 -0
- package/dist/api/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +10 -0
- package/dist/api/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +5 -0
- package/dist/api/types/ExternalFile.d.ts +33 -0
- package/dist/api/types/ExternalFile.js +5 -0
- package/dist/api/types/ExternalSessionAiResponseMetadataStatus.d.ts +1 -1
- package/dist/api/types/FilesResponse.d.ts +10 -0
- package/dist/api/types/FilesResponse.js +5 -0
- package/dist/api/types/FilesWithPagination.d.ts +10 -0
- package/dist/api/types/FilesWithPagination.js +5 -0
- package/dist/api/types/GetFileV1.d.ts +24 -0
- package/dist/api/types/GetFileV1.js +5 -0
- package/dist/api/types/GetFileV1FileType.d.ts +13 -0
- package/dist/api/types/GetFileV1FileType.js +12 -0
- package/dist/api/types/ListAutomationsOutput.d.ts +7 -0
- package/dist/api/types/ListAutomationsOutput.js +5 -0
- package/dist/api/types/MonitorConfigIncludeVisualAnalysis.d.ts +1 -1
- package/dist/api/types/Proxy.d.ts +1 -1
- package/dist/api/types/SessionConfigV1Proxy.d.ts +1 -1
- package/dist/api/types/StatusMessageStatus.d.ts +1 -1
- package/dist/api/types/VisualAnalysisConfigPartitionDirection.d.ts +1 -1
- package/dist/api/types/VisualAnalysisConfigResultSelectionStrategy.d.ts +1 -1
- package/dist/api/types/VisualAnalysisConfigScope.d.ts +1 -1
- package/dist/api/types/index.d.ts +15 -0
- package/dist/api/types/index.js +15 -0
- package/dist/core/auth/BearerToken.d.ts +1 -1
- package/dist/core/fetcher/APIResponse.d.ts +1 -1
- package/dist/core/fetcher/Fetcher.d.ts +3 -3
- package/dist/core/fetcher/Fetcher.js +6 -5
- package/dist/core/fetcher/Supplier.d.ts +1 -1
- package/dist/core/fetcher/createRequestUrl.d.ts +1 -1
- package/dist/core/fetcher/createRequestUrl.js +1 -2
- package/dist/core/fetcher/getFetchFn.js +18 -9
- package/dist/core/fetcher/getHeader.js +1 -2
- package/dist/core/fetcher/getRequestBody.js +5 -5
- package/dist/core/fetcher/getResponseBody.js +4 -2
- package/dist/core/fetcher/makeRequest.d.ts +1 -1
- package/dist/core/fetcher/requestWithRetries.js +17 -9
- package/dist/core/fetcher/signals.d.ts +0 -1
- package/dist/core/fetcher/signals.js +2 -3
- package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +1 -2
- package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +4 -2
- package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +1 -2
- package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +6 -4
- package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +2 -2
- package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +4 -2
- package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +1 -1
- package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +19 -10
- package/dist/core/index.js +17 -7
- package/dist/core/json.d.ts +15 -0
- package/dist/core/json.js +24 -0
- package/dist/core/runtime/runtime.d.ts +1 -1
- package/dist/core/runtime/runtime.js +51 -41
- package/dist/core/schemas/Schema.d.ts +8 -5
- package/dist/core/schemas/Schema.js +3 -0
- package/dist/core/schemas/builders/bigint/bigint.d.ts +2 -0
- package/dist/core/schemas/builders/bigint/bigint.js +53 -0
- package/dist/core/schemas/builders/bigint/index.d.ts +1 -0
- package/dist/core/schemas/builders/bigint/index.js +5 -0
- package/dist/core/schemas/builders/date/date.js +1 -2
- package/dist/core/schemas/builders/enum/enum.js +1 -2
- package/dist/core/schemas/builders/index.d.ts +1 -0
- package/dist/core/schemas/builders/index.js +1 -0
- package/dist/core/schemas/builders/lazy/lazy.d.ts +1 -1
- package/dist/core/schemas/builders/lazy/lazy.js +3 -4
- package/dist/core/schemas/builders/lazy/lazyObject.js +1 -2
- package/dist/core/schemas/builders/list/list.js +1 -2
- package/dist/core/schemas/builders/literals/booleanLiteral.js +1 -2
- package/dist/core/schemas/builders/literals/stringLiteral.js +1 -2
- package/dist/core/schemas/builders/object/object.d.ts +1 -1
- package/dist/core/schemas/builders/object/object.js +31 -3
- package/dist/core/schemas/builders/object/objectWithoutOptionalProperties.d.ts +3 -3
- package/dist/core/schemas/builders/object/objectWithoutOptionalProperties.js +1 -2
- package/dist/core/schemas/builders/object/property.js +2 -3
- package/dist/core/schemas/builders/object/types.d.ts +16 -11
- package/dist/core/schemas/builders/object-like/getObjectLikeUtils.js +2 -3
- package/dist/core/schemas/builders/object-like/types.d.ts +1 -1
- package/dist/core/schemas/builders/record/record.js +2 -4
- package/dist/core/schemas/builders/record/types.d.ts +2 -2
- package/dist/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +4 -0
- package/dist/core/schemas/builders/schema-utils/getSchemaUtils.js +67 -4
- package/dist/core/schemas/builders/schema-utils/stringifyValidationErrors.js +1 -2
- package/dist/core/schemas/builders/set/set.js +1 -2
- package/dist/core/schemas/builders/undiscriminated-union/types.d.ts +4 -4
- package/dist/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +1 -2
- package/dist/core/schemas/builders/union/discriminant.js +1 -2
- package/dist/core/schemas/builders/union/types.d.ts +6 -6
- package/dist/core/schemas/builders/union/union.d.ts +1 -1
- package/dist/core/schemas/builders/union/union.js +1 -2
- package/dist/core/schemas/utils/MaybePromise.d.ts +1 -1
- package/dist/core/schemas/utils/addQuestionMarksToNullableProperties.d.ts +4 -4
- package/dist/core/schemas/utils/createIdentitySchemaCreator.js +1 -2
- package/dist/core/schemas/utils/entries.d.ts +1 -1
- package/dist/core/schemas/utils/entries.js +1 -2
- package/dist/core/schemas/utils/filterObject.d.ts +1 -1
- package/dist/core/schemas/utils/filterObject.js +1 -2
- package/dist/core/schemas/utils/getErrorMessageForIncorrectType.js +5 -2
- package/dist/core/schemas/utils/isPlainObject.js +1 -2
- package/dist/core/schemas/utils/keys.d.ts +1 -1
- package/dist/core/schemas/utils/keys.js +1 -2
- package/dist/core/schemas/utils/maybeSkipValidation.js +1 -2
- package/dist/core/schemas/utils/partition.js +1 -2
- package/dist/core/streaming-fetcher/Stream.d.ts +0 -1
- package/dist/core/streaming-fetcher/Stream.js +20 -21
- package/dist/environments.d.ts +1 -1
- package/dist/errors/AirtopError.js +2 -1
- package/dist/errors/AirtopTimeoutError.d.ts +1 -1
- package/dist/errors/AirtopTimeoutError.js +2 -2
- package/dist/index.js +17 -7
- package/dist/live-view/types.d.ts +1 -1
- package/dist/live-view/types.js +1 -1
- 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 +45 -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/files/client/index.d.ts +1 -0
- package/dist/serialization/resources/files/client/index.js +17 -0
- package/dist/serialization/resources/files/client/requests/CreateFileRestInputV1.d.ts +17 -0
- package/dist/serialization/resources/files/client/requests/CreateFileRestInputV1.js +48 -0
- package/dist/serialization/resources/files/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/files/client/requests/index.js +5 -0
- package/dist/serialization/resources/files/index.d.ts +2 -0
- package/dist/serialization/resources/files/index.js +18 -0
- package/dist/serialization/resources/files/types/CreateFileRestInputV1FileType.d.ts +10 -0
- package/dist/serialization/resources/files/types/CreateFileRestInputV1FileType.js +41 -0
- package/dist/serialization/resources/files/types/index.d.ts +1 -0
- package/dist/serialization/resources/files/types/index.js +17 -0
- package/dist/serialization/resources/index.d.ts +5 -0
- package/dist/serialization/resources/index.js +23 -8
- package/dist/serialization/resources/sessions/client/requests/SessionRestInputV1.js +17 -7
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +9 -9
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +21 -11
- package/dist/serialization/resources/sessions/types/SessionsEventsResponseError.js +17 -7
- package/dist/serialization/resources/sessions/types/SessionsEventsResponseSessionEvent.js +17 -7
- package/dist/serialization/resources/sessions/types/SessionsEventsResponseStatus.js +17 -7
- package/dist/serialization/resources/sessions/types/SessionsEventsResponseWindowEvent.js +17 -7
- package/dist/serialization/resources/sessions/types/SessionsListRequestStatus.js +17 -7
- package/dist/serialization/resources/sessions/types/index.d.ts +2 -2
- package/dist/serialization/resources/sessions/types/index.js +2 -2
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncClickRequest.js +51 -0
- package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/AsyncCreateFormFillerRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncCreateFormFillerRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/AsyncFillFormRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncFillFormRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +51 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/dist/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +51 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +50 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/dist/serialization/resources/windows/client/requests/AsyncTypeRequest.js +55 -0
- package/dist/serialization/resources/windows/client/requests/CreateFormFillerRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/CreateFormFillerRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/CreateWindowInputV1Body.js +17 -7
- package/dist/serialization/resources/windows/client/requests/FillFormRequest.d.ts +18 -0
- package/dist/serialization/resources/windows/client/requests/FillFormRequest.js +49 -0
- package/dist/serialization/resources/windows/client/requests/ScrapeContentRequest.js +17 -7
- package/dist/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.js +17 -7
- package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +17 -7
- package/dist/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +17 -7
- package/dist/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.js +17 -7
- package/dist/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +17 -7
- package/dist/serialization/resources/windows/client/requests/SessionScrollHandlerRequestBody.js +17 -7
- package/dist/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.js +17 -7
- package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +17 -7
- package/dist/serialization/resources/windows/client/requests/WindowLoadUrlV1Body.js +17 -7
- package/dist/serialization/resources/windows/client/requests/index.d.ts +15 -0
- package/dist/serialization/resources/windows/client/requests/index.js +31 -1
- package/dist/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +17 -7
- package/dist/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +17 -7
- package/dist/serialization/types/AiPromptResponse.js +17 -7
- package/dist/serialization/types/AiResponseEnvelope.js +17 -7
- package/dist/serialization/types/AirtopProxyConfiguration.js +17 -7
- package/dist/serialization/types/AsyncConfig.d.ts +12 -0
- package/dist/serialization/types/AsyncConfig.js +43 -0
- package/dist/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
- package/dist/serialization/types/AsyncSessionAiResponseEnvelope.js +46 -0
- package/dist/serialization/types/AutomationOutput.d.ts +16 -0
- package/dist/serialization/types/AutomationOutput.js +47 -0
- package/dist/serialization/types/BrowserWaitNavigationConfig.js +17 -7
- package/dist/serialization/types/BrowserWaitNavigationConfigWaitUntil.js +17 -7
- package/dist/serialization/types/ClickConfig.js +17 -7
- package/dist/serialization/types/ClickConfigClickType.js +17 -7
- package/dist/serialization/types/ClientProvidedResponseMetadata.js +17 -7
- package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
- package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.js +41 -0
- package/dist/serialization/types/CreateFileV1.d.ts +21 -0
- package/dist/serialization/types/CreateFileV1.js +52 -0
- package/dist/serialization/types/CreateFileV1FileType.d.ts +10 -0
- package/dist/serialization/types/CreateFileV1FileType.js +41 -0
- package/dist/serialization/types/DeleteAutomationOutputWrapperBody.d.ts +10 -0
- package/dist/serialization/types/DeleteAutomationOutputWrapperBody.js +41 -0
- package/dist/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +18 -0
- package/dist/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +49 -0
- package/dist/serialization/types/EnvelopeDefaultMeta.js +17 -7
- package/dist/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +18 -0
- package/dist/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +49 -0
- package/dist/serialization/types/ErrorBody.js +17 -7
- package/dist/serialization/types/ErrorDetail.js +17 -7
- package/dist/serialization/types/ErrorMessage.js +17 -7
- package/dist/serialization/types/ErrorModel.js +17 -7
- package/dist/serialization/types/ExternalFile.d.ts +25 -0
- package/dist/serialization/types/ExternalFile.js +56 -0
- package/dist/serialization/types/ExternalSessionAiResponseMetadata.js +17 -7
- package/dist/serialization/types/ExternalSessionAiResponseMetadataStatus.js +17 -7
- package/dist/serialization/types/ExternalSessionAiResponseMetadataUsage.js +17 -7
- package/dist/serialization/types/ExternalSessionConfig.js +17 -7
- package/dist/serialization/types/ExternalSessionWithConnectionInfo.js +17 -7
- package/dist/serialization/types/FilesResponse.d.ts +18 -0
- package/dist/serialization/types/FilesResponse.js +49 -0
- package/dist/serialization/types/FilesWithPagination.d.ts +15 -0
- package/dist/serialization/types/FilesWithPagination.js +46 -0
- package/dist/serialization/types/GetFileV1.d.ts +21 -0
- package/dist/serialization/types/GetFileV1.js +52 -0
- package/dist/serialization/types/GetFileV1FileType.d.ts +10 -0
- package/dist/serialization/types/GetFileV1FileType.js +41 -0
- package/dist/serialization/types/IntervalMonitorConfig.js +17 -7
- package/dist/serialization/types/Issue.js +17 -7
- package/dist/serialization/types/ListAutomationsOutput.d.ts +13 -0
- package/dist/serialization/types/ListAutomationsOutput.js +44 -0
- package/dist/serialization/types/MicroInteractionConfig.js +17 -7
- package/dist/serialization/types/MicroInteractionConfigWithExperimental.js +17 -7
- package/dist/serialization/types/MicroInteractionExperimentalConfig.js +17 -7
- package/dist/serialization/types/MonitorConfig.js +17 -7
- package/dist/serialization/types/MonitorConfigIncludeVisualAnalysis.js +17 -7
- package/dist/serialization/types/OperationOutcome.js +17 -7
- package/dist/serialization/types/OperationOutcomeResponse.js +17 -7
- package/dist/serialization/types/PageQueryConfig.js +17 -7
- package/dist/serialization/types/PageQueryExperimentalConfig.js +17 -7
- package/dist/serialization/types/PaginatedExtractionConfig.js +17 -7
- package/dist/serialization/types/PaginatedExtractionExperimentalConfig.js +17 -7
- package/dist/serialization/types/Pagination.js +17 -7
- package/dist/serialization/types/Proxy.js +17 -7
- package/dist/serialization/types/ProxyConfigurationKind.js +17 -7
- package/dist/serialization/types/ProxyCredentials.js +17 -7
- package/dist/serialization/types/RequestStatusResponse.js +17 -7
- package/dist/serialization/types/ScrapeConfig.js +17 -7
- package/dist/serialization/types/ScrapeResponse.js +17 -7
- package/dist/serialization/types/ScrapeResponseContent.js +17 -7
- package/dist/serialization/types/ScrapeResponseEnvelope.js +17 -7
- package/dist/serialization/types/ScrapeResponseOutput.js +17 -7
- package/dist/serialization/types/ScreenshotConfig.js +17 -7
- package/dist/serialization/types/ScreenshotMetadata.js +17 -7
- package/dist/serialization/types/ScreenshotRequestConfig.js +17 -7
- package/dist/serialization/types/ScrollByConfig.js +17 -7
- package/dist/serialization/types/ScrollToEdgeConfig.js +17 -7
- package/dist/serialization/types/SessionConfigV1.js +17 -7
- package/dist/serialization/types/SessionConfigV1Proxy.js +17 -7
- package/dist/serialization/types/SessionEventMessage.js +17 -7
- package/dist/serialization/types/SessionPageQueryHandlerRequestBody.js +17 -7
- package/dist/serialization/types/SessionResponse.js +17 -7
- package/dist/serialization/types/SessionsResponse.js +17 -7
- package/dist/serialization/types/SessionsWithPagination.js +17 -7
- package/dist/serialization/types/StatusMessage.js +17 -7
- package/dist/serialization/types/StatusMessageStatus.js +17 -7
- package/dist/serialization/types/SummaryConfig.js +17 -7
- package/dist/serialization/types/SummaryExperimentalConfig.js +17 -7
- package/dist/serialization/types/VisualAnalysisConfig.js +17 -7
- package/dist/serialization/types/VisualAnalysisConfigPartitionDirection.js +17 -7
- package/dist/serialization/types/VisualAnalysisConfigResultSelectionStrategy.js +17 -7
- package/dist/serialization/types/VisualAnalysisConfigScope.js +17 -7
- package/dist/serialization/types/Window.js +17 -7
- package/dist/serialization/types/WindowEventMessage.js +17 -7
- package/dist/serialization/types/WindowId.js +17 -7
- package/dist/serialization/types/WindowIdResponse.js +17 -7
- package/dist/serialization/types/WindowResponse.js +17 -7
- package/dist/serialization/types/index.d.ts +15 -0
- package/dist/serialization/types/index.js +15 -0
- package/dist/utils/batch-operate/SessionQueue.js +2 -2
- package/dist/utils/batch-operate/WindowQueue.js +2 -2
- package/dist/utils/batch-operate/batch-util.d.ts +1 -1
- package/dist/utils/batch-operate/types.d.ts +5 -5
- package/dist/utils/process-screenshots.d.ts +1 -2
- package/dist/utils/process-screenshots.js +1 -2
- package/dist/version.d.ts +1 -0
- package/dist/version.js +4 -0
- package/dist/wrapper/AirtopClient.d.ts +6 -2
- package/dist/wrapper/AirtopClient.js +27 -8
- package/dist/wrapper/AirtopFiles.d.ts +38 -0
- package/dist/wrapper/AirtopFiles.js +151 -0
- package/dist/wrapper/AirtopRequests.js +2 -2
- package/dist/wrapper/AirtopSessions.js +7 -5
- package/dist/wrapper/AirtopWindows.js +22 -12
- package/environments.d.ts +1 -1
- package/errors/AirtopError.js +2 -1
- package/errors/AirtopTimeoutError.d.ts +1 -1
- package/errors/AirtopTimeoutError.js +2 -2
- package/index.js +17 -7
- package/{jest.config.js → jest.config.mjs} +4 -1
- package/live-view/types.d.ts +1 -1
- package/live-view/types.js +1 -1
- package/package.json +16 -13
- package/reference.md +1881 -189
- package/scripts/rename-to-esm-files.js +115 -0
- 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 +45 -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/files/client/index.d.ts +1 -0
- package/serialization/resources/files/client/index.js +17 -0
- package/serialization/resources/files/client/requests/CreateFileRestInputV1.d.ts +17 -0
- package/serialization/resources/files/client/requests/CreateFileRestInputV1.js +48 -0
- package/serialization/resources/files/client/requests/index.d.ts +1 -0
- package/serialization/resources/files/client/requests/index.js +5 -0
- package/serialization/resources/files/index.d.ts +2 -0
- package/serialization/resources/files/index.js +18 -0
- package/serialization/resources/files/types/CreateFileRestInputV1FileType.d.ts +10 -0
- package/serialization/resources/files/types/CreateFileRestInputV1FileType.js +41 -0
- package/serialization/resources/files/types/index.d.ts +1 -0
- package/serialization/resources/files/types/index.js +17 -0
- package/serialization/resources/index.d.ts +5 -0
- package/serialization/resources/index.js +23 -8
- package/serialization/resources/sessions/client/requests/SessionRestInputV1.js +17 -7
- package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +9 -9
- package/serialization/resources/sessions/types/SessionsEventsResponse.js +21 -11
- package/serialization/resources/sessions/types/SessionsEventsResponseError.js +17 -7
- package/serialization/resources/sessions/types/SessionsEventsResponseSessionEvent.js +17 -7
- package/serialization/resources/sessions/types/SessionsEventsResponseStatus.js +17 -7
- package/serialization/resources/sessions/types/SessionsEventsResponseWindowEvent.js +17 -7
- package/serialization/resources/sessions/types/SessionsListRequestStatus.js +17 -7
- package/serialization/resources/sessions/types/index.d.ts +2 -2
- package/serialization/resources/sessions/types/index.js +2 -2
- package/serialization/resources/windows/client/requests/AsyncClickRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncClickRequest.js +51 -0
- package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +49 -0
- package/serialization/resources/windows/client/requests/AsyncCreateFormFillerRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncCreateFormFillerRequest.js +49 -0
- package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +49 -0
- package/serialization/resources/windows/client/requests/AsyncFillFormRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncFillFormRequest.js +49 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncMonitorRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPageQueryRequest.js +51 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.d.ts +20 -0
- package/serialization/resources/windows/client/requests/AsyncPromptContentRequest.js +51 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/AsyncScreenshotRequest.js +49 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.d.ts +19 -0
- package/serialization/resources/windows/client/requests/AsyncSummarizeContentRequest.js +50 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.d.ts +24 -0
- package/serialization/resources/windows/client/requests/AsyncTypeRequest.js +55 -0
- package/serialization/resources/windows/client/requests/CreateFormFillerRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/CreateFormFillerRequest.js +49 -0
- package/serialization/resources/windows/client/requests/CreateWindowInputV1Body.js +17 -7
- package/serialization/resources/windows/client/requests/FillFormRequest.d.ts +18 -0
- package/serialization/resources/windows/client/requests/FillFormRequest.js +49 -0
- package/serialization/resources/windows/client/requests/ScrapeContentRequest.js +17 -7
- package/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.js +17 -7
- package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +17 -7
- package/serialization/resources/windows/client/requests/SessionMonitorHandlerRequestBody.js +17 -7
- package/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.js +17 -7
- package/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +17 -7
- package/serialization/resources/windows/client/requests/SessionScrollHandlerRequestBody.js +17 -7
- package/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.js +17 -7
- package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +17 -7
- package/serialization/resources/windows/client/requests/WindowLoadUrlV1Body.js +17 -7
- package/serialization/resources/windows/client/requests/index.d.ts +15 -0
- package/serialization/resources/windows/client/requests/index.js +31 -1
- package/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +17 -7
- package/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +17 -7
- package/serialization/types/AiPromptResponse.js +17 -7
- package/serialization/types/AiResponseEnvelope.js +17 -7
- package/serialization/types/AirtopProxyConfiguration.js +17 -7
- package/serialization/types/AsyncConfig.d.ts +12 -0
- package/serialization/types/AsyncConfig.js +43 -0
- package/serialization/types/AsyncSessionAiResponseEnvelope.d.ts +15 -0
- package/serialization/types/AsyncSessionAiResponseEnvelope.js +46 -0
- package/serialization/types/AutomationOutput.d.ts +16 -0
- package/serialization/types/AutomationOutput.js +47 -0
- package/serialization/types/BrowserWaitNavigationConfig.js +17 -7
- package/serialization/types/BrowserWaitNavigationConfigWaitUntil.js +17 -7
- package/serialization/types/ClickConfig.js +17 -7
- package/serialization/types/ClickConfigClickType.js +17 -7
- package/serialization/types/ClientProvidedResponseMetadata.js +17 -7
- package/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
- package/serialization/types/CreateAutomationRequestBodyConfiguration.js +41 -0
- package/serialization/types/CreateFileV1.d.ts +21 -0
- package/serialization/types/CreateFileV1.js +52 -0
- package/serialization/types/CreateFileV1FileType.d.ts +10 -0
- package/serialization/types/CreateFileV1FileType.js +41 -0
- package/serialization/types/DeleteAutomationOutputWrapperBody.d.ts +10 -0
- package/serialization/types/DeleteAutomationOutputWrapperBody.js +41 -0
- package/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +18 -0
- package/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +49 -0
- package/serialization/types/EnvelopeDefaultMeta.js +17 -7
- package/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +18 -0
- package/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +49 -0
- package/serialization/types/ErrorBody.js +17 -7
- package/serialization/types/ErrorDetail.js +17 -7
- package/serialization/types/ErrorMessage.js +17 -7
- package/serialization/types/ErrorModel.js +17 -7
- package/serialization/types/ExternalFile.d.ts +25 -0
- package/serialization/types/ExternalFile.js +56 -0
- package/serialization/types/ExternalSessionAiResponseMetadata.js +17 -7
- package/serialization/types/ExternalSessionAiResponseMetadataStatus.js +17 -7
- package/serialization/types/ExternalSessionAiResponseMetadataUsage.js +17 -7
- package/serialization/types/ExternalSessionConfig.js +17 -7
- package/serialization/types/ExternalSessionWithConnectionInfo.js +17 -7
- package/serialization/types/FilesResponse.d.ts +18 -0
- package/serialization/types/FilesResponse.js +49 -0
- package/serialization/types/FilesWithPagination.d.ts +15 -0
- package/serialization/types/FilesWithPagination.js +46 -0
- package/serialization/types/GetFileV1.d.ts +21 -0
- package/serialization/types/GetFileV1.js +52 -0
- package/serialization/types/GetFileV1FileType.d.ts +10 -0
- package/serialization/types/GetFileV1FileType.js +41 -0
- package/serialization/types/IntervalMonitorConfig.js +17 -7
- package/serialization/types/Issue.js +17 -7
- package/serialization/types/ListAutomationsOutput.d.ts +13 -0
- package/serialization/types/ListAutomationsOutput.js +44 -0
- package/serialization/types/MicroInteractionConfig.js +17 -7
- package/serialization/types/MicroInteractionConfigWithExperimental.js +17 -7
- package/serialization/types/MicroInteractionExperimentalConfig.js +17 -7
- package/serialization/types/MonitorConfig.js +17 -7
- package/serialization/types/MonitorConfigIncludeVisualAnalysis.js +17 -7
- package/serialization/types/OperationOutcome.js +17 -7
- package/serialization/types/OperationOutcomeResponse.js +17 -7
- package/serialization/types/PageQueryConfig.js +17 -7
- package/serialization/types/PageQueryExperimentalConfig.js +17 -7
- package/serialization/types/PaginatedExtractionConfig.js +17 -7
- package/serialization/types/PaginatedExtractionExperimentalConfig.js +17 -7
- package/serialization/types/Pagination.js +17 -7
- package/serialization/types/Proxy.js +17 -7
- package/serialization/types/ProxyConfigurationKind.js +17 -7
- package/serialization/types/ProxyCredentials.js +17 -7
- package/serialization/types/RequestStatusResponse.js +17 -7
- package/serialization/types/ScrapeConfig.js +17 -7
- package/serialization/types/ScrapeResponse.js +17 -7
- package/serialization/types/ScrapeResponseContent.js +17 -7
- package/serialization/types/ScrapeResponseEnvelope.js +17 -7
- package/serialization/types/ScrapeResponseOutput.js +17 -7
- package/serialization/types/ScreenshotConfig.js +17 -7
- package/serialization/types/ScreenshotMetadata.js +17 -7
- package/serialization/types/ScreenshotRequestConfig.js +17 -7
- package/serialization/types/ScrollByConfig.js +17 -7
- package/serialization/types/ScrollToEdgeConfig.js +17 -7
- package/serialization/types/SessionConfigV1.js +17 -7
- package/serialization/types/SessionConfigV1Proxy.js +17 -7
- package/serialization/types/SessionEventMessage.js +17 -7
- package/serialization/types/SessionPageQueryHandlerRequestBody.js +17 -7
- package/serialization/types/SessionResponse.js +17 -7
- package/serialization/types/SessionsResponse.js +17 -7
- package/serialization/types/SessionsWithPagination.js +17 -7
- package/serialization/types/StatusMessage.js +17 -7
- package/serialization/types/StatusMessageStatus.js +17 -7
- package/serialization/types/SummaryConfig.js +17 -7
- package/serialization/types/SummaryExperimentalConfig.js +17 -7
- package/serialization/types/VisualAnalysisConfig.js +17 -7
- package/serialization/types/VisualAnalysisConfigPartitionDirection.js +17 -7
- package/serialization/types/VisualAnalysisConfigResultSelectionStrategy.js +17 -7
- package/serialization/types/VisualAnalysisConfigScope.js +17 -7
- package/serialization/types/Window.js +17 -7
- package/serialization/types/WindowEventMessage.js +17 -7
- package/serialization/types/WindowId.js +17 -7
- package/serialization/types/WindowIdResponse.js +17 -7
- package/serialization/types/WindowResponse.js +17 -7
- package/serialization/types/index.d.ts +15 -0
- package/serialization/types/index.js +15 -0
- package/utils/batch-operate/SessionQueue.js +2 -2
- package/utils/batch-operate/WindowQueue.js +2 -2
- package/utils/batch-operate/batch-util.d.ts +1 -1
- package/utils/batch-operate/types.d.ts +5 -5
- package/utils/process-screenshots.d.ts +1 -2
- package/utils/process-screenshots.js +1 -2
- package/version.d.ts +1 -0
- package/version.js +4 -0
- package/wrapper/AirtopClient.d.ts +6 -2
- package/wrapper/AirtopClient.js +27 -8
- package/wrapper/AirtopFiles.d.ts +38 -0
- package/wrapper/AirtopFiles.js +151 -0
- package/wrapper/AirtopRequests.js +2 -2
- package/wrapper/AirtopSessions.js +7 -5
- package/wrapper/AirtopWindows.js +22 -12
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">asyncCreateFormFiller</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
|
+
Create a form filler automation asynchronously
|
170
181
|
|
171
182
|
</dd>
|
172
183
|
</dl>
|
@@ -182,9 +193,10 @@ 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.asyncCreateFormFiller(
|
197
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
198
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
199
|
+
);
|
188
200
|
```
|
189
201
|
|
190
202
|
</dd>
|
@@ -200,7 +212,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
200
212
|
<dl>
|
201
213
|
<dd>
|
202
214
|
|
203
|
-
**sessionId:** `string` —
|
215
|
+
**sessionId:** `string` — The session id for the window.
|
204
216
|
|
205
217
|
</dd>
|
206
218
|
</dl>
|
@@ -208,7 +220,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
208
220
|
<dl>
|
209
221
|
<dd>
|
210
222
|
|
211
|
-
**windowId:** `string` — Airtop window
|
223
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
212
224
|
|
213
225
|
</dd>
|
214
226
|
</dl>
|
@@ -216,7 +228,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
216
228
|
<dl>
|
217
229
|
<dd>
|
218
230
|
|
219
|
-
**request:** `Airtop.
|
231
|
+
**request:** `Airtop.AsyncCreateFormFillerRequest`
|
220
232
|
|
221
233
|
</dd>
|
222
234
|
</dl>
|
@@ -235,7 +247,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
235
247
|
</dl>
|
236
248
|
</details>
|
237
249
|
|
238
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
250
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncExecuteAutomation</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
239
251
|
<dl>
|
240
252
|
<dd>
|
241
253
|
|
@@ -247,7 +259,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
247
259
|
<dl>
|
248
260
|
<dd>
|
249
261
|
|
250
|
-
|
262
|
+
Execute an automation of a browser window asynchronously
|
251
263
|
|
252
264
|
</dd>
|
253
265
|
</dl>
|
@@ -263,7 +275,13 @@ Closes a browser window in a session
|
|
263
275
|
<dd>
|
264
276
|
|
265
277
|
```typescript
|
266
|
-
await client.windows.
|
278
|
+
await client.windows.asyncExecuteAutomation(
|
279
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
280
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
281
|
+
{
|
282
|
+
automationId: "automationId",
|
283
|
+
},
|
284
|
+
);
|
267
285
|
```
|
268
286
|
|
269
287
|
</dd>
|
@@ -279,7 +297,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
279
297
|
<dl>
|
280
298
|
<dd>
|
281
299
|
|
282
|
-
**sessionId:** `string` —
|
300
|
+
**sessionId:** `string` — The session id for the window.
|
283
301
|
|
284
302
|
</dd>
|
285
303
|
</dl>
|
@@ -287,7 +305,15 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
287
305
|
<dl>
|
288
306
|
<dd>
|
289
307
|
|
290
|
-
**windowId:** `string` — Airtop window
|
308
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
309
|
+
|
310
|
+
</dd>
|
311
|
+
</dl>
|
312
|
+
|
313
|
+
<dl>
|
314
|
+
<dd>
|
315
|
+
|
316
|
+
**request:** `Airtop.AsyncExecuteAutomationRequest`
|
291
317
|
|
292
318
|
</dd>
|
293
319
|
</dl>
|
@@ -306,7 +332,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
306
332
|
</dl>
|
307
333
|
</details>
|
308
334
|
|
309
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
335
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncFillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
310
336
|
<dl>
|
311
337
|
<dd>
|
312
338
|
|
@@ -318,7 +344,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
318
344
|
<dl>
|
319
345
|
<dd>
|
320
346
|
|
321
|
-
|
347
|
+
Fill a form of a browser window asynchronously using a form-filler automation
|
322
348
|
|
323
349
|
</dd>
|
324
350
|
</dl>
|
@@ -334,8 +360,8 @@ Execute a click interaction in a specific browser window
|
|
334
360
|
<dd>
|
335
361
|
|
336
362
|
```typescript
|
337
|
-
await client.windows.
|
338
|
-
|
363
|
+
await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
364
|
+
automationId: "automationId",
|
339
365
|
});
|
340
366
|
```
|
341
367
|
|
@@ -368,7 +394,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
368
394
|
<dl>
|
369
395
|
<dd>
|
370
396
|
|
371
|
-
**request:** `Airtop.
|
397
|
+
**request:** `Airtop.AsyncFillFormRequest`
|
372
398
|
|
373
399
|
</dd>
|
374
400
|
</dl>
|
@@ -387,25 +413,10 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
387
413
|
</dl>
|
388
414
|
</details>
|
389
415
|
|
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
|
-
|
416
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
399
417
|
<dl>
|
400
418
|
<dd>
|
401
419
|
|
402
|
-
Execute a hover interaction in a specific browser window
|
403
|
-
|
404
|
-
</dd>
|
405
|
-
</dl>
|
406
|
-
</dd>
|
407
|
-
</dl>
|
408
|
-
|
409
420
|
#### 🔌 Usage
|
410
421
|
|
411
422
|
<dl>
|
@@ -415,7 +426,7 @@ Execute a hover interaction in a specific browser window
|
|
415
426
|
<dd>
|
416
427
|
|
417
428
|
```typescript
|
418
|
-
await client.windows.
|
429
|
+
await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
419
430
|
elementDescription: "The search box input in the top right corner",
|
420
431
|
});
|
421
432
|
```
|
@@ -449,7 +460,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
449
460
|
<dl>
|
450
461
|
<dd>
|
451
462
|
|
452
|
-
**request:** `Airtop.
|
463
|
+
**request:** `Airtop.AsyncHoverRequest`
|
453
464
|
|
454
465
|
</dd>
|
455
466
|
</dl>
|
@@ -468,7 +479,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
468
479
|
</dl>
|
469
480
|
</details>
|
470
481
|
|
471
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
482
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
472
483
|
<dl>
|
473
484
|
<dd>
|
474
485
|
|
@@ -481,7 +492,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
481
492
|
<dd>
|
482
493
|
|
483
494
|
```typescript
|
484
|
-
await client.windows.
|
495
|
+
await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
485
496
|
condition: "Determine if the user appears to be signed in to the website",
|
486
497
|
});
|
487
498
|
```
|
@@ -515,7 +526,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
515
526
|
<dl>
|
516
527
|
<dd>
|
517
528
|
|
518
|
-
**request:** `Airtop.
|
529
|
+
**request:** `Airtop.AsyncMonitorRequest`
|
519
530
|
|
520
531
|
</dd>
|
521
532
|
</dl>
|
@@ -534,25 +545,10 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
534
545
|
</dl>
|
535
546
|
</details>
|
536
547
|
|
537
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
538
|
-
<dl>
|
539
|
-
<dd>
|
540
|
-
|
541
|
-
#### 📝 Description
|
542
|
-
|
548
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
543
549
|
<dl>
|
544
550
|
<dd>
|
545
551
|
|
546
|
-
<dl>
|
547
|
-
<dd>
|
548
|
-
|
549
|
-
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?).
|
550
|
-
|
551
|
-
</dd>
|
552
|
-
</dl>
|
553
|
-
</dd>
|
554
|
-
</dl>
|
555
|
-
|
556
552
|
#### 🔌 Usage
|
557
553
|
|
558
554
|
<dl>
|
@@ -562,7 +558,7 @@ Submit a prompt that queries the content of a specific browser window. You may e
|
|
562
558
|
<dd>
|
563
559
|
|
564
560
|
```typescript
|
565
|
-
await client.windows.
|
561
|
+
await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
566
562
|
prompt: "What is the main idea of this page?",
|
567
563
|
});
|
568
564
|
```
|
@@ -596,7 +592,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
596
592
|
<dl>
|
597
593
|
<dd>
|
598
594
|
|
599
|
-
**request:** `Airtop.
|
595
|
+
**request:** `Airtop.AsyncPageQueryRequest`
|
600
596
|
|
601
597
|
</dd>
|
602
598
|
</dl>
|
@@ -615,25 +611,10 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
615
611
|
</dl>
|
616
612
|
</details>
|
617
613
|
|
618
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
619
|
-
<dl>
|
620
|
-
<dd>
|
621
|
-
|
622
|
-
#### 📝 Description
|
623
|
-
|
624
|
-
<dl>
|
625
|
-
<dd>
|
626
|
-
|
614
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
627
615
|
<dl>
|
628
616
|
<dd>
|
629
617
|
|
630
|
-
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
631
|
-
|
632
|
-
</dd>
|
633
|
-
</dl>
|
634
|
-
</dd>
|
635
|
-
</dl>
|
636
|
-
|
637
618
|
#### 🔌 Usage
|
638
619
|
|
639
620
|
<dl>
|
@@ -643,12 +624,12 @@ Submit a prompt that queries the content of a specific browser window and pagina
|
|
643
624
|
<dd>
|
644
625
|
|
645
626
|
```typescript
|
646
|
-
await client.windows.
|
627
|
+
await client.windows.asyncPaginatedExtraction(
|
647
628
|
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
648
629
|
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
649
630
|
{
|
650
631
|
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.",
|
651
|
-
}
|
632
|
+
},
|
652
633
|
);
|
653
634
|
```
|
654
635
|
|
@@ -681,7 +662,7 @@ await client.windows.paginatedExtraction(
|
|
681
662
|
<dl>
|
682
663
|
<dd>
|
683
664
|
|
684
|
-
**request:** `Airtop.
|
665
|
+
**request:** `Airtop.AsyncPaginatedExtractionRequest`
|
685
666
|
|
686
667
|
</dd>
|
687
668
|
</dl>
|
@@ -700,7 +681,7 @@ await client.windows.paginatedExtraction(
|
|
700
681
|
</dl>
|
701
682
|
</details>
|
702
683
|
|
703
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
684
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPromptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
704
685
|
<dl>
|
705
686
|
<dd>
|
706
687
|
|
@@ -728,9 +709,13 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
728
709
|
<dd>
|
729
710
|
|
730
711
|
```typescript
|
731
|
-
await client.windows.
|
732
|
-
|
733
|
-
|
712
|
+
await client.windows.asyncPromptContent(
|
713
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
714
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
715
|
+
{
|
716
|
+
prompt: "What is the main idea of this page?",
|
717
|
+
},
|
718
|
+
);
|
734
719
|
```
|
735
720
|
|
736
721
|
</dd>
|
@@ -762,7 +747,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
762
747
|
<dl>
|
763
748
|
<dd>
|
764
749
|
|
765
|
-
**request:** `Airtop.
|
750
|
+
**request:** `Airtop.AsyncPromptContentRequest`
|
766
751
|
|
767
752
|
</dd>
|
768
753
|
</dl>
|
@@ -781,7 +766,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
781
766
|
</dl>
|
782
767
|
</details>
|
783
768
|
|
784
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
769
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncScreenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
785
770
|
<dl>
|
786
771
|
<dd>
|
787
772
|
|
@@ -793,7 +778,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
793
778
|
<dl>
|
794
779
|
<dd>
|
795
780
|
|
796
|
-
|
781
|
+
Take a screenshot of the current viewport of a browser window asynchronously
|
797
782
|
|
798
783
|
</dd>
|
799
784
|
</dl>
|
@@ -809,7 +794,7 @@ Scrape a window and return the content as markdown
|
|
809
794
|
<dd>
|
810
795
|
|
811
796
|
```typescript
|
812
|
-
await client.windows.
|
797
|
+
await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
813
798
|
```
|
814
799
|
|
815
800
|
</dd>
|
@@ -833,7 +818,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
833
818
|
<dl>
|
834
819
|
<dd>
|
835
820
|
|
836
|
-
**windowId:** `string` — The Airtop window id of the browser window
|
821
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
837
822
|
|
838
823
|
</dd>
|
839
824
|
</dl>
|
@@ -841,7 +826,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
841
826
|
<dl>
|
842
827
|
<dd>
|
843
828
|
|
844
|
-
**request:** `Airtop.
|
829
|
+
**request:** `Airtop.AsyncScreenshotRequest`
|
845
830
|
|
846
831
|
</dd>
|
847
832
|
</dl>
|
@@ -860,7 +845,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
860
845
|
</dl>
|
861
846
|
</details>
|
862
847
|
|
863
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
848
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncSummarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
864
849
|
<dl>
|
865
850
|
<dd>
|
866
851
|
|
@@ -872,7 +857,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
872
857
|
<dl>
|
873
858
|
<dd>
|
874
859
|
|
875
|
-
|
860
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
876
861
|
|
877
862
|
</dd>
|
878
863
|
</dl>
|
@@ -888,7 +873,10 @@ Take a screenshot of a browser window
|
|
888
873
|
<dd>
|
889
874
|
|
890
875
|
```typescript
|
891
|
-
await client.windows.
|
876
|
+
await client.windows.asyncSummarizeContent(
|
877
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
878
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
879
|
+
);
|
892
880
|
```
|
893
881
|
|
894
882
|
</dd>
|
@@ -912,7 +900,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
912
900
|
<dl>
|
913
901
|
<dd>
|
914
902
|
|
915
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
903
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
916
904
|
|
917
905
|
</dd>
|
918
906
|
</dl>
|
@@ -920,7 +908,7 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
920
908
|
<dl>
|
921
909
|
<dd>
|
922
910
|
|
923
|
-
**request:** `Airtop.
|
911
|
+
**request:** `Airtop.AsyncSummarizeContentRequest`
|
924
912
|
|
925
913
|
</dd>
|
926
914
|
</dl>
|
@@ -939,25 +927,10 @@ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2
|
|
939
927
|
</dl>
|
940
928
|
</details>
|
941
929
|
|
942
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
943
|
-
<dl>
|
944
|
-
<dd>
|
945
|
-
|
946
|
-
#### 📝 Description
|
947
|
-
|
948
|
-
<dl>
|
949
|
-
<dd>
|
950
|
-
|
930
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
951
931
|
<dl>
|
952
932
|
<dd>
|
953
933
|
|
954
|
-
Execute a scroll interaction in a specific browser window
|
955
|
-
|
956
|
-
</dd>
|
957
|
-
</dl>
|
958
|
-
</dd>
|
959
|
-
</dl>
|
960
|
-
|
961
934
|
#### 🔌 Usage
|
962
935
|
|
963
936
|
<dl>
|
@@ -967,7 +940,9 @@ Execute a scroll interaction in a specific browser window
|
|
967
940
|
<dd>
|
968
941
|
|
969
942
|
```typescript
|
970
|
-
await client.windows.
|
943
|
+
await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
944
|
+
text: "Example text",
|
945
|
+
});
|
971
946
|
```
|
972
947
|
|
973
948
|
</dd>
|
@@ -999,7 +974,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
999
974
|
<dl>
|
1000
975
|
<dd>
|
1001
976
|
|
1002
|
-
**request:** `Airtop.
|
977
|
+
**request:** `Airtop.AsyncTypeRequest`
|
1003
978
|
|
1004
979
|
</dd>
|
1005
980
|
</dl>
|
@@ -1018,7 +993,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1018
993
|
</dl>
|
1019
994
|
</details>
|
1020
995
|
|
1021
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
996
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">create</a>(sessionId, { ...params }) -> Airtop.WindowIdResponse</code></summary>
|
1022
997
|
<dl>
|
1023
998
|
<dd>
|
1024
999
|
|
@@ -1030,7 +1005,7 @@ await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91
|
|
1030
1005
|
<dl>
|
1031
1006
|
<dd>
|
1032
1007
|
|
1033
|
-
|
1008
|
+
Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
|
1034
1009
|
|
1035
1010
|
</dd>
|
1036
1011
|
</dl>
|
@@ -1046,7 +1021,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
|
|
1046
1021
|
<dd>
|
1047
1022
|
|
1048
1023
|
```typescript
|
1049
|
-
await client.windows.
|
1024
|
+
await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
1050
1025
|
```
|
1051
1026
|
|
1052
1027
|
</dd>
|
@@ -1062,15 +1037,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1062
1037
|
<dl>
|
1063
1038
|
<dd>
|
1064
1039
|
|
1065
|
-
**sessionId:** `string` —
|
1066
|
-
|
1067
|
-
</dd>
|
1068
|
-
</dl>
|
1069
|
-
|
1070
|
-
<dl>
|
1071
|
-
<dd>
|
1072
|
-
|
1073
|
-
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
1040
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1074
1041
|
|
1075
1042
|
</dd>
|
1076
1043
|
</dl>
|
@@ -1078,7 +1045,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1078
1045
|
<dl>
|
1079
1046
|
<dd>
|
1080
1047
|
|
1081
|
-
**request:** `Airtop.
|
1048
|
+
**request:** `Airtop.CreateWindowInputV1Body`
|
1082
1049
|
|
1083
1050
|
</dd>
|
1084
1051
|
</dl>
|
@@ -1097,7 +1064,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1097
1064
|
</dl>
|
1098
1065
|
</details>
|
1099
1066
|
|
1100
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1067
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">getWindowInfo</a>(sessionId, windowId, { ...params }) -> Airtop.WindowResponse</code></summary>
|
1101
1068
|
<dl>
|
1102
1069
|
<dd>
|
1103
1070
|
|
@@ -1109,7 +1076,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
1109
1076
|
<dl>
|
1110
1077
|
<dd>
|
1111
1078
|
|
1112
|
-
|
1079
|
+
Get information about a browser window in a session, including the live view url.
|
1113
1080
|
|
1114
1081
|
</dd>
|
1115
1082
|
</dl>
|
@@ -1125,8 +1092,8 @@ Execute a type interaction in a specific browser window
|
|
1125
1092
|
<dd>
|
1126
1093
|
|
1127
1094
|
```typescript
|
1128
|
-
await client.windows.
|
1129
|
-
|
1095
|
+
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1096
|
+
screenResolution: "1280x720",
|
1130
1097
|
});
|
1131
1098
|
```
|
1132
1099
|
|
@@ -1143,7 +1110,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1143
1110
|
<dl>
|
1144
1111
|
<dd>
|
1145
1112
|
|
1146
|
-
**sessionId:** `string` —
|
1113
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1147
1114
|
|
1148
1115
|
</dd>
|
1149
1116
|
</dl>
|
@@ -1151,7 +1118,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1151
1118
|
<dl>
|
1152
1119
|
<dd>
|
1153
1120
|
|
1154
|
-
**windowId:** `string` —
|
1121
|
+
**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.
|
1155
1122
|
|
1156
1123
|
</dd>
|
1157
1124
|
</dl>
|
@@ -1159,7 +1126,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1159
1126
|
<dl>
|
1160
1127
|
<dd>
|
1161
1128
|
|
1162
|
-
**request:** `Airtop.
|
1129
|
+
**request:** `Airtop.GetWindowInfoRequest`
|
1163
1130
|
|
1164
1131
|
</dd>
|
1165
1132
|
</dl>
|
@@ -1178,9 +1145,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1178
1145
|
</dl>
|
1179
1146
|
</details>
|
1180
1147
|
|
1181
|
-
|
1182
|
-
|
1183
|
-
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
1148
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
|
1184
1149
|
<dl>
|
1185
1150
|
<dd>
|
1186
1151
|
|
@@ -1192,7 +1157,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
|
|
1192
1157
|
<dl>
|
1193
1158
|
<dd>
|
1194
1159
|
|
1195
|
-
|
1160
|
+
Loads a specified url on a given window
|
1196
1161
|
|
1197
1162
|
</dd>
|
1198
1163
|
</dl>
|
@@ -1208,7 +1173,9 @@ Delete profiles matching by id
|
|
1208
1173
|
<dd>
|
1209
1174
|
|
1210
1175
|
```typescript
|
1211
|
-
await client.
|
1176
|
+
await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1177
|
+
url: "https://www.airtop.ai",
|
1178
|
+
});
|
1212
1179
|
```
|
1213
1180
|
|
1214
1181
|
</dd>
|
@@ -1224,57 +1191,23 @@ await client.profiles.delete();
|
|
1224
1191
|
<dl>
|
1225
1192
|
<dd>
|
1226
1193
|
|
1227
|
-
**
|
1228
|
-
|
1229
|
-
</dd>
|
1230
|
-
</dl>
|
1231
|
-
|
1232
|
-
<dl>
|
1233
|
-
<dd>
|
1234
|
-
|
1235
|
-
**requestOptions:** `Profiles.RequestOptions`
|
1236
|
-
|
1237
|
-
</dd>
|
1238
|
-
</dl>
|
1239
|
-
</dd>
|
1240
|
-
</dl>
|
1194
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1241
1195
|
|
1242
1196
|
</dd>
|
1243
1197
|
</dl>
|
1244
|
-
</details>
|
1245
|
-
|
1246
|
-
## Requests
|
1247
|
-
|
1248
|
-
<details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
|
1249
|
-
<dl>
|
1250
|
-
<dd>
|
1251
|
-
|
1252
|
-
#### 🔌 Usage
|
1253
|
-
|
1254
|
-
<dl>
|
1255
|
-
<dd>
|
1256
1198
|
|
1257
1199
|
<dl>
|
1258
1200
|
<dd>
|
1259
1201
|
|
1260
|
-
|
1261
|
-
await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
1262
|
-
```
|
1202
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1263
1203
|
|
1264
1204
|
</dd>
|
1265
1205
|
</dl>
|
1266
|
-
</dd>
|
1267
|
-
</dl>
|
1268
|
-
|
1269
|
-
#### ⚙️ Parameters
|
1270
1206
|
|
1271
1207
|
<dl>
|
1272
1208
|
<dd>
|
1273
1209
|
|
1274
|
-
|
1275
|
-
<dd>
|
1276
|
-
|
1277
|
-
**requestId:** `string` — The ID of the request to check.
|
1210
|
+
**request:** `Airtop.WindowLoadUrlV1Body`
|
1278
1211
|
|
1279
1212
|
</dd>
|
1280
1213
|
</dl>
|
@@ -1282,7 +1215,7 @@ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
|
1282
1215
|
<dl>
|
1283
1216
|
<dd>
|
1284
1217
|
|
1285
|
-
**requestOptions:** `
|
1218
|
+
**requestOptions:** `Windows.RequestOptions`
|
1286
1219
|
|
1287
1220
|
</dd>
|
1288
1221
|
</dl>
|
@@ -1293,9 +1226,7 @@ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
|
1293
1226
|
</dl>
|
1294
1227
|
</details>
|
1295
1228
|
|
1296
|
-
|
1297
|
-
|
1298
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
|
1229
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
|
1299
1230
|
<dl>
|
1300
1231
|
<dd>
|
1301
1232
|
|
@@ -1307,7 +1238,1691 @@ await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
|
1307
1238
|
<dl>
|
1308
1239
|
<dd>
|
1309
1240
|
|
1310
|
-
|
1241
|
+
Closes a browser window in a session
|
1242
|
+
|
1243
|
+
</dd>
|
1244
|
+
</dl>
|
1245
|
+
</dd>
|
1246
|
+
</dl>
|
1247
|
+
|
1248
|
+
#### 🔌 Usage
|
1249
|
+
|
1250
|
+
<dl>
|
1251
|
+
<dd>
|
1252
|
+
|
1253
|
+
<dl>
|
1254
|
+
<dd>
|
1255
|
+
|
1256
|
+
```typescript
|
1257
|
+
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
1258
|
+
```
|
1259
|
+
|
1260
|
+
</dd>
|
1261
|
+
</dl>
|
1262
|
+
</dd>
|
1263
|
+
</dl>
|
1264
|
+
|
1265
|
+
#### ⚙️ Parameters
|
1266
|
+
|
1267
|
+
<dl>
|
1268
|
+
<dd>
|
1269
|
+
|
1270
|
+
<dl>
|
1271
|
+
<dd>
|
1272
|
+
|
1273
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1274
|
+
|
1275
|
+
</dd>
|
1276
|
+
</dl>
|
1277
|
+
|
1278
|
+
<dl>
|
1279
|
+
<dd>
|
1280
|
+
|
1281
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1282
|
+
|
1283
|
+
</dd>
|
1284
|
+
</dl>
|
1285
|
+
|
1286
|
+
<dl>
|
1287
|
+
<dd>
|
1288
|
+
|
1289
|
+
**requestOptions:** `Windows.RequestOptions`
|
1290
|
+
|
1291
|
+
</dd>
|
1292
|
+
</dl>
|
1293
|
+
</dd>
|
1294
|
+
</dl>
|
1295
|
+
|
1296
|
+
</dd>
|
1297
|
+
</dl>
|
1298
|
+
</details>
|
1299
|
+
|
1300
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1301
|
+
<dl>
|
1302
|
+
<dd>
|
1303
|
+
|
1304
|
+
#### 📝 Description
|
1305
|
+
|
1306
|
+
<dl>
|
1307
|
+
<dd>
|
1308
|
+
|
1309
|
+
<dl>
|
1310
|
+
<dd>
|
1311
|
+
|
1312
|
+
Execute a click interaction in a specific browser window
|
1313
|
+
|
1314
|
+
</dd>
|
1315
|
+
</dl>
|
1316
|
+
</dd>
|
1317
|
+
</dl>
|
1318
|
+
|
1319
|
+
#### 🔌 Usage
|
1320
|
+
|
1321
|
+
<dl>
|
1322
|
+
<dd>
|
1323
|
+
|
1324
|
+
<dl>
|
1325
|
+
<dd>
|
1326
|
+
|
1327
|
+
```typescript
|
1328
|
+
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1329
|
+
elementDescription: "The login button",
|
1330
|
+
});
|
1331
|
+
```
|
1332
|
+
|
1333
|
+
</dd>
|
1334
|
+
</dl>
|
1335
|
+
</dd>
|
1336
|
+
</dl>
|
1337
|
+
|
1338
|
+
#### ⚙️ Parameters
|
1339
|
+
|
1340
|
+
<dl>
|
1341
|
+
<dd>
|
1342
|
+
|
1343
|
+
<dl>
|
1344
|
+
<dd>
|
1345
|
+
|
1346
|
+
**sessionId:** `string` — The session id for the window.
|
1347
|
+
|
1348
|
+
</dd>
|
1349
|
+
</dl>
|
1350
|
+
|
1351
|
+
<dl>
|
1352
|
+
<dd>
|
1353
|
+
|
1354
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1355
|
+
|
1356
|
+
</dd>
|
1357
|
+
</dl>
|
1358
|
+
|
1359
|
+
<dl>
|
1360
|
+
<dd>
|
1361
|
+
|
1362
|
+
**request:** `Airtop.SessionClickHandlerRequestBody`
|
1363
|
+
|
1364
|
+
</dd>
|
1365
|
+
</dl>
|
1366
|
+
|
1367
|
+
<dl>
|
1368
|
+
<dd>
|
1369
|
+
|
1370
|
+
**requestOptions:** `Windows.RequestOptions`
|
1371
|
+
|
1372
|
+
</dd>
|
1373
|
+
</dl>
|
1374
|
+
</dd>
|
1375
|
+
</dl>
|
1376
|
+
|
1377
|
+
</dd>
|
1378
|
+
</dl>
|
1379
|
+
</details>
|
1380
|
+
|
1381
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">createFormFiller</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1382
|
+
<dl>
|
1383
|
+
<dd>
|
1384
|
+
|
1385
|
+
#### 📝 Description
|
1386
|
+
|
1387
|
+
<dl>
|
1388
|
+
<dd>
|
1389
|
+
|
1390
|
+
<dl>
|
1391
|
+
<dd>
|
1392
|
+
|
1393
|
+
Create a form-filler automation synchronously for the form loaded in the browser window
|
1394
|
+
|
1395
|
+
</dd>
|
1396
|
+
</dl>
|
1397
|
+
</dd>
|
1398
|
+
</dl>
|
1399
|
+
|
1400
|
+
#### 🔌 Usage
|
1401
|
+
|
1402
|
+
<dl>
|
1403
|
+
<dd>
|
1404
|
+
|
1405
|
+
<dl>
|
1406
|
+
<dd>
|
1407
|
+
|
1408
|
+
```typescript
|
1409
|
+
await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1410
|
+
```
|
1411
|
+
|
1412
|
+
</dd>
|
1413
|
+
</dl>
|
1414
|
+
</dd>
|
1415
|
+
</dl>
|
1416
|
+
|
1417
|
+
#### ⚙️ Parameters
|
1418
|
+
|
1419
|
+
<dl>
|
1420
|
+
<dd>
|
1421
|
+
|
1422
|
+
<dl>
|
1423
|
+
<dd>
|
1424
|
+
|
1425
|
+
**sessionId:** `string` — The session id for the window.
|
1426
|
+
|
1427
|
+
</dd>
|
1428
|
+
</dl>
|
1429
|
+
|
1430
|
+
<dl>
|
1431
|
+
<dd>
|
1432
|
+
|
1433
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1434
|
+
|
1435
|
+
</dd>
|
1436
|
+
</dl>
|
1437
|
+
|
1438
|
+
<dl>
|
1439
|
+
<dd>
|
1440
|
+
|
1441
|
+
**request:** `Airtop.CreateFormFillerRequest`
|
1442
|
+
|
1443
|
+
</dd>
|
1444
|
+
</dl>
|
1445
|
+
|
1446
|
+
<dl>
|
1447
|
+
<dd>
|
1448
|
+
|
1449
|
+
**requestOptions:** `Windows.RequestOptions`
|
1450
|
+
|
1451
|
+
</dd>
|
1452
|
+
</dl>
|
1453
|
+
</dd>
|
1454
|
+
</dl>
|
1455
|
+
|
1456
|
+
</dd>
|
1457
|
+
</dl>
|
1458
|
+
</details>
|
1459
|
+
|
1460
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">fillForm</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1461
|
+
<dl>
|
1462
|
+
<dd>
|
1463
|
+
|
1464
|
+
#### 📝 Description
|
1465
|
+
|
1466
|
+
<dl>
|
1467
|
+
<dd>
|
1468
|
+
|
1469
|
+
<dl>
|
1470
|
+
<dd>
|
1471
|
+
|
1472
|
+
Fill a form of a browser window synchronously using a form-filler automation
|
1473
|
+
|
1474
|
+
</dd>
|
1475
|
+
</dl>
|
1476
|
+
</dd>
|
1477
|
+
</dl>
|
1478
|
+
|
1479
|
+
#### 🔌 Usage
|
1480
|
+
|
1481
|
+
<dl>
|
1482
|
+
<dd>
|
1483
|
+
|
1484
|
+
<dl>
|
1485
|
+
<dd>
|
1486
|
+
|
1487
|
+
```typescript
|
1488
|
+
await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1489
|
+
automationId: "automationId",
|
1490
|
+
});
|
1491
|
+
```
|
1492
|
+
|
1493
|
+
</dd>
|
1494
|
+
</dl>
|
1495
|
+
</dd>
|
1496
|
+
</dl>
|
1497
|
+
|
1498
|
+
#### ⚙️ Parameters
|
1499
|
+
|
1500
|
+
<dl>
|
1501
|
+
<dd>
|
1502
|
+
|
1503
|
+
<dl>
|
1504
|
+
<dd>
|
1505
|
+
|
1506
|
+
**sessionId:** `string` — The session id for the window.
|
1507
|
+
|
1508
|
+
</dd>
|
1509
|
+
</dl>
|
1510
|
+
|
1511
|
+
<dl>
|
1512
|
+
<dd>
|
1513
|
+
|
1514
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1515
|
+
|
1516
|
+
</dd>
|
1517
|
+
</dl>
|
1518
|
+
|
1519
|
+
<dl>
|
1520
|
+
<dd>
|
1521
|
+
|
1522
|
+
**request:** `Airtop.FillFormRequest`
|
1523
|
+
|
1524
|
+
</dd>
|
1525
|
+
</dl>
|
1526
|
+
|
1527
|
+
<dl>
|
1528
|
+
<dd>
|
1529
|
+
|
1530
|
+
**requestOptions:** `Windows.RequestOptions`
|
1531
|
+
|
1532
|
+
</dd>
|
1533
|
+
</dl>
|
1534
|
+
</dd>
|
1535
|
+
</dl>
|
1536
|
+
|
1537
|
+
</dd>
|
1538
|
+
</dl>
|
1539
|
+
</details>
|
1540
|
+
|
1541
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1542
|
+
<dl>
|
1543
|
+
<dd>
|
1544
|
+
|
1545
|
+
#### 📝 Description
|
1546
|
+
|
1547
|
+
<dl>
|
1548
|
+
<dd>
|
1549
|
+
|
1550
|
+
<dl>
|
1551
|
+
<dd>
|
1552
|
+
|
1553
|
+
Execute a hover interaction in a specific browser window
|
1554
|
+
|
1555
|
+
</dd>
|
1556
|
+
</dl>
|
1557
|
+
</dd>
|
1558
|
+
</dl>
|
1559
|
+
|
1560
|
+
#### 🔌 Usage
|
1561
|
+
|
1562
|
+
<dl>
|
1563
|
+
<dd>
|
1564
|
+
|
1565
|
+
<dl>
|
1566
|
+
<dd>
|
1567
|
+
|
1568
|
+
```typescript
|
1569
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1570
|
+
elementDescription: "The search box input in the top right corner",
|
1571
|
+
});
|
1572
|
+
```
|
1573
|
+
|
1574
|
+
</dd>
|
1575
|
+
</dl>
|
1576
|
+
</dd>
|
1577
|
+
</dl>
|
1578
|
+
|
1579
|
+
#### ⚙️ Parameters
|
1580
|
+
|
1581
|
+
<dl>
|
1582
|
+
<dd>
|
1583
|
+
|
1584
|
+
<dl>
|
1585
|
+
<dd>
|
1586
|
+
|
1587
|
+
**sessionId:** `string` — The session id for the window.
|
1588
|
+
|
1589
|
+
</dd>
|
1590
|
+
</dl>
|
1591
|
+
|
1592
|
+
<dl>
|
1593
|
+
<dd>
|
1594
|
+
|
1595
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1596
|
+
|
1597
|
+
</dd>
|
1598
|
+
</dl>
|
1599
|
+
|
1600
|
+
<dl>
|
1601
|
+
<dd>
|
1602
|
+
|
1603
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
1604
|
+
|
1605
|
+
</dd>
|
1606
|
+
</dl>
|
1607
|
+
|
1608
|
+
<dl>
|
1609
|
+
<dd>
|
1610
|
+
|
1611
|
+
**requestOptions:** `Windows.RequestOptions`
|
1612
|
+
|
1613
|
+
</dd>
|
1614
|
+
</dl>
|
1615
|
+
</dd>
|
1616
|
+
</dl>
|
1617
|
+
|
1618
|
+
</dd>
|
1619
|
+
</dl>
|
1620
|
+
</details>
|
1621
|
+
|
1622
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">monitor</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1623
|
+
<dl>
|
1624
|
+
<dd>
|
1625
|
+
|
1626
|
+
#### 🔌 Usage
|
1627
|
+
|
1628
|
+
<dl>
|
1629
|
+
<dd>
|
1630
|
+
|
1631
|
+
<dl>
|
1632
|
+
<dd>
|
1633
|
+
|
1634
|
+
```typescript
|
1635
|
+
await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1636
|
+
condition: "Determine if the user appears to be signed in to the website",
|
1637
|
+
});
|
1638
|
+
```
|
1639
|
+
|
1640
|
+
</dd>
|
1641
|
+
</dl>
|
1642
|
+
</dd>
|
1643
|
+
</dl>
|
1644
|
+
|
1645
|
+
#### ⚙️ Parameters
|
1646
|
+
|
1647
|
+
<dl>
|
1648
|
+
<dd>
|
1649
|
+
|
1650
|
+
<dl>
|
1651
|
+
<dd>
|
1652
|
+
|
1653
|
+
**sessionId:** `string` — The session id for the window.
|
1654
|
+
|
1655
|
+
</dd>
|
1656
|
+
</dl>
|
1657
|
+
|
1658
|
+
<dl>
|
1659
|
+
<dd>
|
1660
|
+
|
1661
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1662
|
+
|
1663
|
+
</dd>
|
1664
|
+
</dl>
|
1665
|
+
|
1666
|
+
<dl>
|
1667
|
+
<dd>
|
1668
|
+
|
1669
|
+
**request:** `Airtop.SessionMonitorHandlerRequestBody`
|
1670
|
+
|
1671
|
+
</dd>
|
1672
|
+
</dl>
|
1673
|
+
|
1674
|
+
<dl>
|
1675
|
+
<dd>
|
1676
|
+
|
1677
|
+
**requestOptions:** `Windows.RequestOptions`
|
1678
|
+
|
1679
|
+
</dd>
|
1680
|
+
</dl>
|
1681
|
+
</dd>
|
1682
|
+
</dl>
|
1683
|
+
|
1684
|
+
</dd>
|
1685
|
+
</dl>
|
1686
|
+
</details>
|
1687
|
+
|
1688
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1689
|
+
<dl>
|
1690
|
+
<dd>
|
1691
|
+
|
1692
|
+
#### 📝 Description
|
1693
|
+
|
1694
|
+
<dl>
|
1695
|
+
<dd>
|
1696
|
+
|
1697
|
+
<dl>
|
1698
|
+
<dd>
|
1699
|
+
|
1700
|
+
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?).
|
1701
|
+
|
1702
|
+
</dd>
|
1703
|
+
</dl>
|
1704
|
+
</dd>
|
1705
|
+
</dl>
|
1706
|
+
|
1707
|
+
#### 🔌 Usage
|
1708
|
+
|
1709
|
+
<dl>
|
1710
|
+
<dd>
|
1711
|
+
|
1712
|
+
<dl>
|
1713
|
+
<dd>
|
1714
|
+
|
1715
|
+
```typescript
|
1716
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1717
|
+
prompt: "What is the main idea of this page?",
|
1718
|
+
});
|
1719
|
+
```
|
1720
|
+
|
1721
|
+
</dd>
|
1722
|
+
</dl>
|
1723
|
+
</dd>
|
1724
|
+
</dl>
|
1725
|
+
|
1726
|
+
#### ⚙️ Parameters
|
1727
|
+
|
1728
|
+
<dl>
|
1729
|
+
<dd>
|
1730
|
+
|
1731
|
+
<dl>
|
1732
|
+
<dd>
|
1733
|
+
|
1734
|
+
**sessionId:** `string` — The session id for the window.
|
1735
|
+
|
1736
|
+
</dd>
|
1737
|
+
</dl>
|
1738
|
+
|
1739
|
+
<dl>
|
1740
|
+
<dd>
|
1741
|
+
|
1742
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1743
|
+
|
1744
|
+
</dd>
|
1745
|
+
</dl>
|
1746
|
+
|
1747
|
+
<dl>
|
1748
|
+
<dd>
|
1749
|
+
|
1750
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
1751
|
+
|
1752
|
+
</dd>
|
1753
|
+
</dl>
|
1754
|
+
|
1755
|
+
<dl>
|
1756
|
+
<dd>
|
1757
|
+
|
1758
|
+
**requestOptions:** `Windows.RequestOptions`
|
1759
|
+
|
1760
|
+
</dd>
|
1761
|
+
</dl>
|
1762
|
+
</dd>
|
1763
|
+
</dl>
|
1764
|
+
|
1765
|
+
</dd>
|
1766
|
+
</dl>
|
1767
|
+
</details>
|
1768
|
+
|
1769
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1770
|
+
<dl>
|
1771
|
+
<dd>
|
1772
|
+
|
1773
|
+
#### 📝 Description
|
1774
|
+
|
1775
|
+
<dl>
|
1776
|
+
<dd>
|
1777
|
+
|
1778
|
+
<dl>
|
1779
|
+
<dd>
|
1780
|
+
|
1781
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
1782
|
+
|
1783
|
+
</dd>
|
1784
|
+
</dl>
|
1785
|
+
</dd>
|
1786
|
+
</dl>
|
1787
|
+
|
1788
|
+
#### 🔌 Usage
|
1789
|
+
|
1790
|
+
<dl>
|
1791
|
+
<dd>
|
1792
|
+
|
1793
|
+
<dl>
|
1794
|
+
<dd>
|
1795
|
+
|
1796
|
+
```typescript
|
1797
|
+
await client.windows.paginatedExtraction(
|
1798
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
1799
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
1800
|
+
{
|
1801
|
+
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.",
|
1802
|
+
},
|
1803
|
+
);
|
1804
|
+
```
|
1805
|
+
|
1806
|
+
</dd>
|
1807
|
+
</dl>
|
1808
|
+
</dd>
|
1809
|
+
</dl>
|
1810
|
+
|
1811
|
+
#### ⚙️ Parameters
|
1812
|
+
|
1813
|
+
<dl>
|
1814
|
+
<dd>
|
1815
|
+
|
1816
|
+
<dl>
|
1817
|
+
<dd>
|
1818
|
+
|
1819
|
+
**sessionId:** `string` — The session id for the window.
|
1820
|
+
|
1821
|
+
</dd>
|
1822
|
+
</dl>
|
1823
|
+
|
1824
|
+
<dl>
|
1825
|
+
<dd>
|
1826
|
+
|
1827
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1828
|
+
|
1829
|
+
</dd>
|
1830
|
+
</dl>
|
1831
|
+
|
1832
|
+
<dl>
|
1833
|
+
<dd>
|
1834
|
+
|
1835
|
+
**request:** `Airtop.SessionPaginatedExtractionHandlerRequestBody`
|
1836
|
+
|
1837
|
+
</dd>
|
1838
|
+
</dl>
|
1839
|
+
|
1840
|
+
<dl>
|
1841
|
+
<dd>
|
1842
|
+
|
1843
|
+
**requestOptions:** `Windows.RequestOptions`
|
1844
|
+
|
1845
|
+
</dd>
|
1846
|
+
</dl>
|
1847
|
+
</dd>
|
1848
|
+
</dl>
|
1849
|
+
|
1850
|
+
</dd>
|
1851
|
+
</dl>
|
1852
|
+
</details>
|
1853
|
+
|
1854
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1855
|
+
<dl>
|
1856
|
+
<dd>
|
1857
|
+
|
1858
|
+
#### 📝 Description
|
1859
|
+
|
1860
|
+
<dl>
|
1861
|
+
<dd>
|
1862
|
+
|
1863
|
+
<dl>
|
1864
|
+
<dd>
|
1865
|
+
|
1866
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
1867
|
+
|
1868
|
+
</dd>
|
1869
|
+
</dl>
|
1870
|
+
</dd>
|
1871
|
+
</dl>
|
1872
|
+
|
1873
|
+
#### 🔌 Usage
|
1874
|
+
|
1875
|
+
<dl>
|
1876
|
+
<dd>
|
1877
|
+
|
1878
|
+
<dl>
|
1879
|
+
<dd>
|
1880
|
+
|
1881
|
+
```typescript
|
1882
|
+
await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1883
|
+
prompt: "What is the main idea of this page?",
|
1884
|
+
});
|
1885
|
+
```
|
1886
|
+
|
1887
|
+
</dd>
|
1888
|
+
</dl>
|
1889
|
+
</dd>
|
1890
|
+
</dl>
|
1891
|
+
|
1892
|
+
#### ⚙️ Parameters
|
1893
|
+
|
1894
|
+
<dl>
|
1895
|
+
<dd>
|
1896
|
+
|
1897
|
+
<dl>
|
1898
|
+
<dd>
|
1899
|
+
|
1900
|
+
**sessionId:** `string` — The session id for the window.
|
1901
|
+
|
1902
|
+
</dd>
|
1903
|
+
</dl>
|
1904
|
+
|
1905
|
+
<dl>
|
1906
|
+
<dd>
|
1907
|
+
|
1908
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1909
|
+
|
1910
|
+
</dd>
|
1911
|
+
</dl>
|
1912
|
+
|
1913
|
+
<dl>
|
1914
|
+
<dd>
|
1915
|
+
|
1916
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
1917
|
+
|
1918
|
+
</dd>
|
1919
|
+
</dl>
|
1920
|
+
|
1921
|
+
<dl>
|
1922
|
+
<dd>
|
1923
|
+
|
1924
|
+
**requestOptions:** `Windows.RequestOptions`
|
1925
|
+
|
1926
|
+
</dd>
|
1927
|
+
</dl>
|
1928
|
+
</dd>
|
1929
|
+
</dl>
|
1930
|
+
|
1931
|
+
</dd>
|
1932
|
+
</dl>
|
1933
|
+
</details>
|
1934
|
+
|
1935
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
1936
|
+
<dl>
|
1937
|
+
<dd>
|
1938
|
+
|
1939
|
+
#### 📝 Description
|
1940
|
+
|
1941
|
+
<dl>
|
1942
|
+
<dd>
|
1943
|
+
|
1944
|
+
<dl>
|
1945
|
+
<dd>
|
1946
|
+
|
1947
|
+
Scrape a window and return the content as markdown
|
1948
|
+
|
1949
|
+
</dd>
|
1950
|
+
</dl>
|
1951
|
+
</dd>
|
1952
|
+
</dl>
|
1953
|
+
|
1954
|
+
#### 🔌 Usage
|
1955
|
+
|
1956
|
+
<dl>
|
1957
|
+
<dd>
|
1958
|
+
|
1959
|
+
<dl>
|
1960
|
+
<dd>
|
1961
|
+
|
1962
|
+
```typescript
|
1963
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
1964
|
+
```
|
1965
|
+
|
1966
|
+
</dd>
|
1967
|
+
</dl>
|
1968
|
+
</dd>
|
1969
|
+
</dl>
|
1970
|
+
|
1971
|
+
#### ⚙️ Parameters
|
1972
|
+
|
1973
|
+
<dl>
|
1974
|
+
<dd>
|
1975
|
+
|
1976
|
+
<dl>
|
1977
|
+
<dd>
|
1978
|
+
|
1979
|
+
**sessionId:** `string` — The session id for the window.
|
1980
|
+
|
1981
|
+
</dd>
|
1982
|
+
</dl>
|
1983
|
+
|
1984
|
+
<dl>
|
1985
|
+
<dd>
|
1986
|
+
|
1987
|
+
**windowId:** `string` — The Airtop window id of the browser window to scrape.
|
1988
|
+
|
1989
|
+
</dd>
|
1990
|
+
</dl>
|
1991
|
+
|
1992
|
+
<dl>
|
1993
|
+
<dd>
|
1994
|
+
|
1995
|
+
**request:** `Airtop.ScrapeContentRequest`
|
1996
|
+
|
1997
|
+
</dd>
|
1998
|
+
</dl>
|
1999
|
+
|
2000
|
+
<dl>
|
2001
|
+
<dd>
|
2002
|
+
|
2003
|
+
**requestOptions:** `Windows.RequestOptions`
|
2004
|
+
|
2005
|
+
</dd>
|
2006
|
+
</dl>
|
2007
|
+
</dd>
|
2008
|
+
</dl>
|
2009
|
+
|
2010
|
+
</dd>
|
2011
|
+
</dl>
|
2012
|
+
</details>
|
2013
|
+
|
2014
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2015
|
+
<dl>
|
2016
|
+
<dd>
|
2017
|
+
|
2018
|
+
#### 📝 Description
|
2019
|
+
|
2020
|
+
<dl>
|
2021
|
+
<dd>
|
2022
|
+
|
2023
|
+
<dl>
|
2024
|
+
<dd>
|
2025
|
+
|
2026
|
+
Take a screenshot of a browser window
|
2027
|
+
|
2028
|
+
</dd>
|
2029
|
+
</dl>
|
2030
|
+
</dd>
|
2031
|
+
</dl>
|
2032
|
+
|
2033
|
+
#### 🔌 Usage
|
2034
|
+
|
2035
|
+
<dl>
|
2036
|
+
<dd>
|
2037
|
+
|
2038
|
+
<dl>
|
2039
|
+
<dd>
|
2040
|
+
|
2041
|
+
```typescript
|
2042
|
+
await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2043
|
+
```
|
2044
|
+
|
2045
|
+
</dd>
|
2046
|
+
</dl>
|
2047
|
+
</dd>
|
2048
|
+
</dl>
|
2049
|
+
|
2050
|
+
#### ⚙️ Parameters
|
2051
|
+
|
2052
|
+
<dl>
|
2053
|
+
<dd>
|
2054
|
+
|
2055
|
+
<dl>
|
2056
|
+
<dd>
|
2057
|
+
|
2058
|
+
**sessionId:** `string` — The session id for the window.
|
2059
|
+
|
2060
|
+
</dd>
|
2061
|
+
</dl>
|
2062
|
+
|
2063
|
+
<dl>
|
2064
|
+
<dd>
|
2065
|
+
|
2066
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
2067
|
+
|
2068
|
+
</dd>
|
2069
|
+
</dl>
|
2070
|
+
|
2071
|
+
<dl>
|
2072
|
+
<dd>
|
2073
|
+
|
2074
|
+
**request:** `Airtop.SessionScreenshotHandlerRequestBody`
|
2075
|
+
|
2076
|
+
</dd>
|
2077
|
+
</dl>
|
2078
|
+
|
2079
|
+
<dl>
|
2080
|
+
<dd>
|
2081
|
+
|
2082
|
+
**requestOptions:** `Windows.RequestOptions`
|
2083
|
+
|
2084
|
+
</dd>
|
2085
|
+
</dl>
|
2086
|
+
</dd>
|
2087
|
+
</dl>
|
2088
|
+
|
2089
|
+
</dd>
|
2090
|
+
</dl>
|
2091
|
+
</details>
|
2092
|
+
|
2093
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scroll</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2094
|
+
<dl>
|
2095
|
+
<dd>
|
2096
|
+
|
2097
|
+
#### 📝 Description
|
2098
|
+
|
2099
|
+
<dl>
|
2100
|
+
<dd>
|
2101
|
+
|
2102
|
+
<dl>
|
2103
|
+
<dd>
|
2104
|
+
|
2105
|
+
Execute a scroll interaction in a specific browser window
|
2106
|
+
|
2107
|
+
</dd>
|
2108
|
+
</dl>
|
2109
|
+
</dd>
|
2110
|
+
</dl>
|
2111
|
+
|
2112
|
+
#### 🔌 Usage
|
2113
|
+
|
2114
|
+
<dl>
|
2115
|
+
<dd>
|
2116
|
+
|
2117
|
+
<dl>
|
2118
|
+
<dd>
|
2119
|
+
|
2120
|
+
```typescript
|
2121
|
+
await client.windows.scroll("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2122
|
+
```
|
2123
|
+
|
2124
|
+
</dd>
|
2125
|
+
</dl>
|
2126
|
+
</dd>
|
2127
|
+
</dl>
|
2128
|
+
|
2129
|
+
#### ⚙️ Parameters
|
2130
|
+
|
2131
|
+
<dl>
|
2132
|
+
<dd>
|
2133
|
+
|
2134
|
+
<dl>
|
2135
|
+
<dd>
|
2136
|
+
|
2137
|
+
**sessionId:** `string` — The session id for the window.
|
2138
|
+
|
2139
|
+
</dd>
|
2140
|
+
</dl>
|
2141
|
+
|
2142
|
+
<dl>
|
2143
|
+
<dd>
|
2144
|
+
|
2145
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
2146
|
+
|
2147
|
+
</dd>
|
2148
|
+
</dl>
|
2149
|
+
|
2150
|
+
<dl>
|
2151
|
+
<dd>
|
2152
|
+
|
2153
|
+
**request:** `Airtop.SessionScrollHandlerRequestBody`
|
2154
|
+
|
2155
|
+
</dd>
|
2156
|
+
</dl>
|
2157
|
+
|
2158
|
+
<dl>
|
2159
|
+
<dd>
|
2160
|
+
|
2161
|
+
**requestOptions:** `Windows.RequestOptions`
|
2162
|
+
|
2163
|
+
</dd>
|
2164
|
+
</dl>
|
2165
|
+
</dd>
|
2166
|
+
</dl>
|
2167
|
+
|
2168
|
+
</dd>
|
2169
|
+
</dl>
|
2170
|
+
</details>
|
2171
|
+
|
2172
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2173
|
+
<dl>
|
2174
|
+
<dd>
|
2175
|
+
|
2176
|
+
#### 📝 Description
|
2177
|
+
|
2178
|
+
<dl>
|
2179
|
+
<dd>
|
2180
|
+
|
2181
|
+
<dl>
|
2182
|
+
<dd>
|
2183
|
+
|
2184
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
2185
|
+
|
2186
|
+
</dd>
|
2187
|
+
</dl>
|
2188
|
+
</dd>
|
2189
|
+
</dl>
|
2190
|
+
|
2191
|
+
#### 🔌 Usage
|
2192
|
+
|
2193
|
+
<dl>
|
2194
|
+
<dd>
|
2195
|
+
|
2196
|
+
<dl>
|
2197
|
+
<dd>
|
2198
|
+
|
2199
|
+
```typescript
|
2200
|
+
await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2201
|
+
```
|
2202
|
+
|
2203
|
+
</dd>
|
2204
|
+
</dl>
|
2205
|
+
</dd>
|
2206
|
+
</dl>
|
2207
|
+
|
2208
|
+
#### ⚙️ Parameters
|
2209
|
+
|
2210
|
+
<dl>
|
2211
|
+
<dd>
|
2212
|
+
|
2213
|
+
<dl>
|
2214
|
+
<dd>
|
2215
|
+
|
2216
|
+
**sessionId:** `string` — The session id for the window.
|
2217
|
+
|
2218
|
+
</dd>
|
2219
|
+
</dl>
|
2220
|
+
|
2221
|
+
<dl>
|
2222
|
+
<dd>
|
2223
|
+
|
2224
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
2225
|
+
|
2226
|
+
</dd>
|
2227
|
+
</dl>
|
2228
|
+
|
2229
|
+
<dl>
|
2230
|
+
<dd>
|
2231
|
+
|
2232
|
+
**request:** `Airtop.SessionSummaryHandlerRequestBody`
|
2233
|
+
|
2234
|
+
</dd>
|
2235
|
+
</dl>
|
2236
|
+
|
2237
|
+
<dl>
|
2238
|
+
<dd>
|
2239
|
+
|
2240
|
+
**requestOptions:** `Windows.RequestOptions`
|
2241
|
+
|
2242
|
+
</dd>
|
2243
|
+
</dl>
|
2244
|
+
</dd>
|
2245
|
+
</dl>
|
2246
|
+
|
2247
|
+
</dd>
|
2248
|
+
</dl>
|
2249
|
+
</details>
|
2250
|
+
|
2251
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
2252
|
+
<dl>
|
2253
|
+
<dd>
|
2254
|
+
|
2255
|
+
#### 📝 Description
|
2256
|
+
|
2257
|
+
<dl>
|
2258
|
+
<dd>
|
2259
|
+
|
2260
|
+
<dl>
|
2261
|
+
<dd>
|
2262
|
+
|
2263
|
+
Execute a type interaction in a specific browser window
|
2264
|
+
|
2265
|
+
</dd>
|
2266
|
+
</dl>
|
2267
|
+
</dd>
|
2268
|
+
</dl>
|
2269
|
+
|
2270
|
+
#### 🔌 Usage
|
2271
|
+
|
2272
|
+
<dl>
|
2273
|
+
<dd>
|
2274
|
+
|
2275
|
+
<dl>
|
2276
|
+
<dd>
|
2277
|
+
|
2278
|
+
```typescript
|
2279
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
2280
|
+
text: "Example text",
|
2281
|
+
});
|
2282
|
+
```
|
2283
|
+
|
2284
|
+
</dd>
|
2285
|
+
</dl>
|
2286
|
+
</dd>
|
2287
|
+
</dl>
|
2288
|
+
|
2289
|
+
#### ⚙️ Parameters
|
2290
|
+
|
2291
|
+
<dl>
|
2292
|
+
<dd>
|
2293
|
+
|
2294
|
+
<dl>
|
2295
|
+
<dd>
|
2296
|
+
|
2297
|
+
**sessionId:** `string` — The session id for the window.
|
2298
|
+
|
2299
|
+
</dd>
|
2300
|
+
</dl>
|
2301
|
+
|
2302
|
+
<dl>
|
2303
|
+
<dd>
|
2304
|
+
|
2305
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
2306
|
+
|
2307
|
+
</dd>
|
2308
|
+
</dl>
|
2309
|
+
|
2310
|
+
<dl>
|
2311
|
+
<dd>
|
2312
|
+
|
2313
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
2314
|
+
|
2315
|
+
</dd>
|
2316
|
+
</dl>
|
2317
|
+
|
2318
|
+
<dl>
|
2319
|
+
<dd>
|
2320
|
+
|
2321
|
+
**requestOptions:** `Windows.RequestOptions`
|
2322
|
+
|
2323
|
+
</dd>
|
2324
|
+
</dl>
|
2325
|
+
</dd>
|
2326
|
+
</dl>
|
2327
|
+
|
2328
|
+
</dd>
|
2329
|
+
</dl>
|
2330
|
+
</details>
|
2331
|
+
|
2332
|
+
## Automations
|
2333
|
+
|
2334
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">list</a>() -> Airtop.ListAutomationsOutput</code></summary>
|
2335
|
+
<dl>
|
2336
|
+
<dd>
|
2337
|
+
|
2338
|
+
#### 📝 Description
|
2339
|
+
|
2340
|
+
<dl>
|
2341
|
+
<dd>
|
2342
|
+
|
2343
|
+
<dl>
|
2344
|
+
<dd>
|
2345
|
+
|
2346
|
+
List all automations for a given organization
|
2347
|
+
|
2348
|
+
</dd>
|
2349
|
+
</dl>
|
2350
|
+
</dd>
|
2351
|
+
</dl>
|
2352
|
+
|
2353
|
+
#### 🔌 Usage
|
2354
|
+
|
2355
|
+
<dl>
|
2356
|
+
<dd>
|
2357
|
+
|
2358
|
+
<dl>
|
2359
|
+
<dd>
|
2360
|
+
|
2361
|
+
```typescript
|
2362
|
+
await client.automations.list();
|
2363
|
+
```
|
2364
|
+
|
2365
|
+
</dd>
|
2366
|
+
</dl>
|
2367
|
+
</dd>
|
2368
|
+
</dl>
|
2369
|
+
|
2370
|
+
#### ⚙️ Parameters
|
2371
|
+
|
2372
|
+
<dl>
|
2373
|
+
<dd>
|
2374
|
+
|
2375
|
+
<dl>
|
2376
|
+
<dd>
|
2377
|
+
|
2378
|
+
**requestOptions:** `Automations.RequestOptions`
|
2379
|
+
|
2380
|
+
</dd>
|
2381
|
+
</dl>
|
2382
|
+
</dd>
|
2383
|
+
</dl>
|
2384
|
+
|
2385
|
+
</dd>
|
2386
|
+
</dl>
|
2387
|
+
</details>
|
2388
|
+
|
2389
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">update</a>({ ...params }) -> Airtop.AutomationOutput</code></summary>
|
2390
|
+
<dl>
|
2391
|
+
<dd>
|
2392
|
+
|
2393
|
+
#### 📝 Description
|
2394
|
+
|
2395
|
+
<dl>
|
2396
|
+
<dd>
|
2397
|
+
|
2398
|
+
<dl>
|
2399
|
+
<dd>
|
2400
|
+
|
2401
|
+
Update the description of a specific automation
|
2402
|
+
|
2403
|
+
</dd>
|
2404
|
+
</dl>
|
2405
|
+
</dd>
|
2406
|
+
</dl>
|
2407
|
+
|
2408
|
+
#### 🔌 Usage
|
2409
|
+
|
2410
|
+
<dl>
|
2411
|
+
<dd>
|
2412
|
+
|
2413
|
+
<dl>
|
2414
|
+
<dd>
|
2415
|
+
|
2416
|
+
```typescript
|
2417
|
+
await client.automations.update({
|
2418
|
+
description: "description",
|
2419
|
+
id: "id",
|
2420
|
+
orgId: "orgId",
|
2421
|
+
});
|
2422
|
+
```
|
2423
|
+
|
2424
|
+
</dd>
|
2425
|
+
</dl>
|
2426
|
+
</dd>
|
2427
|
+
</dl>
|
2428
|
+
|
2429
|
+
#### ⚙️ Parameters
|
2430
|
+
|
2431
|
+
<dl>
|
2432
|
+
<dd>
|
2433
|
+
|
2434
|
+
<dl>
|
2435
|
+
<dd>
|
2436
|
+
|
2437
|
+
**request:** `Airtop.UpdateAutomationDescriptionInputBody`
|
2438
|
+
|
2439
|
+
</dd>
|
2440
|
+
</dl>
|
2441
|
+
|
2442
|
+
<dl>
|
2443
|
+
<dd>
|
2444
|
+
|
2445
|
+
**requestOptions:** `Automations.RequestOptions`
|
2446
|
+
|
2447
|
+
</dd>
|
2448
|
+
</dl>
|
2449
|
+
</dd>
|
2450
|
+
</dl>
|
2451
|
+
|
2452
|
+
</dd>
|
2453
|
+
</dl>
|
2454
|
+
</details>
|
2455
|
+
|
2456
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">get</a>(automationId) -> Airtop.AutomationOutput</code></summary>
|
2457
|
+
<dl>
|
2458
|
+
<dd>
|
2459
|
+
|
2460
|
+
#### 📝 Description
|
2461
|
+
|
2462
|
+
<dl>
|
2463
|
+
<dd>
|
2464
|
+
|
2465
|
+
<dl>
|
2466
|
+
<dd>
|
2467
|
+
|
2468
|
+
Get a specific automation by ID
|
2469
|
+
|
2470
|
+
</dd>
|
2471
|
+
</dl>
|
2472
|
+
</dd>
|
2473
|
+
</dl>
|
2474
|
+
|
2475
|
+
#### 🔌 Usage
|
2476
|
+
|
2477
|
+
<dl>
|
2478
|
+
<dd>
|
2479
|
+
|
2480
|
+
<dl>
|
2481
|
+
<dd>
|
2482
|
+
|
2483
|
+
```typescript
|
2484
|
+
await client.automations.get("automationId");
|
2485
|
+
```
|
2486
|
+
|
2487
|
+
</dd>
|
2488
|
+
</dl>
|
2489
|
+
</dd>
|
2490
|
+
</dl>
|
2491
|
+
|
2492
|
+
#### ⚙️ Parameters
|
2493
|
+
|
2494
|
+
<dl>
|
2495
|
+
<dd>
|
2496
|
+
|
2497
|
+
<dl>
|
2498
|
+
<dd>
|
2499
|
+
|
2500
|
+
**automationId:** `string` — ID of the automation to retrieve
|
2501
|
+
|
2502
|
+
</dd>
|
2503
|
+
</dl>
|
2504
|
+
|
2505
|
+
<dl>
|
2506
|
+
<dd>
|
2507
|
+
|
2508
|
+
**requestOptions:** `Automations.RequestOptions`
|
2509
|
+
|
2510
|
+
</dd>
|
2511
|
+
</dl>
|
2512
|
+
</dd>
|
2513
|
+
</dl>
|
2514
|
+
|
2515
|
+
</dd>
|
2516
|
+
</dl>
|
2517
|
+
</details>
|
2518
|
+
|
2519
|
+
<details><summary><code>client.automations.<a href="/src/api/resources/automations/client/Client.ts">delete</a>(automationId) -> Airtop.DeleteAutomationOutputWrapperBody</code></summary>
|
2520
|
+
<dl>
|
2521
|
+
<dd>
|
2522
|
+
|
2523
|
+
#### 📝 Description
|
2524
|
+
|
2525
|
+
<dl>
|
2526
|
+
<dd>
|
2527
|
+
|
2528
|
+
<dl>
|
2529
|
+
<dd>
|
2530
|
+
|
2531
|
+
Delete a specific automation
|
2532
|
+
|
2533
|
+
</dd>
|
2534
|
+
</dl>
|
2535
|
+
</dd>
|
2536
|
+
</dl>
|
2537
|
+
|
2538
|
+
#### 🔌 Usage
|
2539
|
+
|
2540
|
+
<dl>
|
2541
|
+
<dd>
|
2542
|
+
|
2543
|
+
<dl>
|
2544
|
+
<dd>
|
2545
|
+
|
2546
|
+
```typescript
|
2547
|
+
await client.automations.delete("automationId");
|
2548
|
+
```
|
2549
|
+
|
2550
|
+
</dd>
|
2551
|
+
</dl>
|
2552
|
+
</dd>
|
2553
|
+
</dl>
|
2554
|
+
|
2555
|
+
#### ⚙️ Parameters
|
2556
|
+
|
2557
|
+
<dl>
|
2558
|
+
<dd>
|
2559
|
+
|
2560
|
+
<dl>
|
2561
|
+
<dd>
|
2562
|
+
|
2563
|
+
**automationId:** `string` — ID of the automation to delete
|
2564
|
+
|
2565
|
+
</dd>
|
2566
|
+
</dl>
|
2567
|
+
|
2568
|
+
<dl>
|
2569
|
+
<dd>
|
2570
|
+
|
2571
|
+
**requestOptions:** `Automations.RequestOptions`
|
2572
|
+
|
2573
|
+
</dd>
|
2574
|
+
</dl>
|
2575
|
+
</dd>
|
2576
|
+
</dl>
|
2577
|
+
|
2578
|
+
</dd>
|
2579
|
+
</dl>
|
2580
|
+
</details>
|
2581
|
+
|
2582
|
+
## Files
|
2583
|
+
|
2584
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">list</a>({ ...params }) -> Airtop.FilesResponse</code></summary>
|
2585
|
+
<dl>
|
2586
|
+
<dd>
|
2587
|
+
|
2588
|
+
#### 📝 Description
|
2589
|
+
|
2590
|
+
<dl>
|
2591
|
+
<dd>
|
2592
|
+
|
2593
|
+
<dl>
|
2594
|
+
<dd>
|
2595
|
+
|
2596
|
+
Get a list of files filtered by session ID
|
2597
|
+
|
2598
|
+
</dd>
|
2599
|
+
</dl>
|
2600
|
+
</dd>
|
2601
|
+
</dl>
|
2602
|
+
|
2603
|
+
#### 🔌 Usage
|
2604
|
+
|
2605
|
+
<dl>
|
2606
|
+
<dd>
|
2607
|
+
|
2608
|
+
<dl>
|
2609
|
+
<dd>
|
2610
|
+
|
2611
|
+
```typescript
|
2612
|
+
await client.files.list({
|
2613
|
+
offset: 1,
|
2614
|
+
limit: 10,
|
2615
|
+
});
|
2616
|
+
```
|
2617
|
+
|
2618
|
+
</dd>
|
2619
|
+
</dl>
|
2620
|
+
</dd>
|
2621
|
+
</dl>
|
2622
|
+
|
2623
|
+
#### ⚙️ Parameters
|
2624
|
+
|
2625
|
+
<dl>
|
2626
|
+
<dd>
|
2627
|
+
|
2628
|
+
<dl>
|
2629
|
+
<dd>
|
2630
|
+
|
2631
|
+
**request:** `Airtop.FilesListRequest`
|
2632
|
+
|
2633
|
+
</dd>
|
2634
|
+
</dl>
|
2635
|
+
|
2636
|
+
<dl>
|
2637
|
+
<dd>
|
2638
|
+
|
2639
|
+
**requestOptions:** `Files.RequestOptions`
|
2640
|
+
|
2641
|
+
</dd>
|
2642
|
+
</dl>
|
2643
|
+
</dd>
|
2644
|
+
</dl>
|
2645
|
+
|
2646
|
+
</dd>
|
2647
|
+
</dl>
|
2648
|
+
</details>
|
2649
|
+
|
2650
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">create</a>({ ...params }) -> Airtop.EnvelopeCreateFileV1EnvelopeDefaultMeta</code></summary>
|
2651
|
+
<dl>
|
2652
|
+
<dd>
|
2653
|
+
|
2654
|
+
#### 🔌 Usage
|
2655
|
+
|
2656
|
+
<dl>
|
2657
|
+
<dd>
|
2658
|
+
|
2659
|
+
<dl>
|
2660
|
+
<dd>
|
2661
|
+
|
2662
|
+
```typescript
|
2663
|
+
await client.files.create({
|
2664
|
+
fileName: "fileName",
|
2665
|
+
});
|
2666
|
+
```
|
2667
|
+
|
2668
|
+
</dd>
|
2669
|
+
</dl>
|
2670
|
+
</dd>
|
2671
|
+
</dl>
|
2672
|
+
|
2673
|
+
#### ⚙️ Parameters
|
2674
|
+
|
2675
|
+
<dl>
|
2676
|
+
<dd>
|
2677
|
+
|
2678
|
+
<dl>
|
2679
|
+
<dd>
|
2680
|
+
|
2681
|
+
**request:** `Airtop.CreateFileRestInputV1`
|
2682
|
+
|
2683
|
+
</dd>
|
2684
|
+
</dl>
|
2685
|
+
|
2686
|
+
<dl>
|
2687
|
+
<dd>
|
2688
|
+
|
2689
|
+
**requestOptions:** `Files.RequestOptions`
|
2690
|
+
|
2691
|
+
</dd>
|
2692
|
+
</dl>
|
2693
|
+
</dd>
|
2694
|
+
</dl>
|
2695
|
+
|
2696
|
+
</dd>
|
2697
|
+
</dl>
|
2698
|
+
</details>
|
2699
|
+
|
2700
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">get</a>(id) -> Airtop.EnvelopeGetFileV1EnvelopeDefaultMeta</code></summary>
|
2701
|
+
<dl>
|
2702
|
+
<dd>
|
2703
|
+
|
2704
|
+
#### 🔌 Usage
|
2705
|
+
|
2706
|
+
<dl>
|
2707
|
+
<dd>
|
2708
|
+
|
2709
|
+
<dl>
|
2710
|
+
<dd>
|
2711
|
+
|
2712
|
+
```typescript
|
2713
|
+
await client.files.get("id");
|
2714
|
+
```
|
2715
|
+
|
2716
|
+
</dd>
|
2717
|
+
</dl>
|
2718
|
+
</dd>
|
2719
|
+
</dl>
|
2720
|
+
|
2721
|
+
#### ⚙️ Parameters
|
2722
|
+
|
2723
|
+
<dl>
|
2724
|
+
<dd>
|
2725
|
+
|
2726
|
+
<dl>
|
2727
|
+
<dd>
|
2728
|
+
|
2729
|
+
**id:** `string` — ID of the file
|
2730
|
+
|
2731
|
+
</dd>
|
2732
|
+
</dl>
|
2733
|
+
|
2734
|
+
<dl>
|
2735
|
+
<dd>
|
2736
|
+
|
2737
|
+
**requestOptions:** `Files.RequestOptions`
|
2738
|
+
|
2739
|
+
</dd>
|
2740
|
+
</dl>
|
2741
|
+
</dd>
|
2742
|
+
</dl>
|
2743
|
+
|
2744
|
+
</dd>
|
2745
|
+
</dl>
|
2746
|
+
</details>
|
2747
|
+
|
2748
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id) -> void</code></summary>
|
2749
|
+
<dl>
|
2750
|
+
<dd>
|
2751
|
+
|
2752
|
+
#### 🔌 Usage
|
2753
|
+
|
2754
|
+
<dl>
|
2755
|
+
<dd>
|
2756
|
+
|
2757
|
+
<dl>
|
2758
|
+
<dd>
|
2759
|
+
|
2760
|
+
```typescript
|
2761
|
+
await client.files.delete("id");
|
2762
|
+
```
|
2763
|
+
|
2764
|
+
</dd>
|
2765
|
+
</dl>
|
2766
|
+
</dd>
|
2767
|
+
</dl>
|
2768
|
+
|
2769
|
+
#### ⚙️ Parameters
|
2770
|
+
|
2771
|
+
<dl>
|
2772
|
+
<dd>
|
2773
|
+
|
2774
|
+
<dl>
|
2775
|
+
<dd>
|
2776
|
+
|
2777
|
+
**id:** `string` — ID of the file
|
2778
|
+
|
2779
|
+
</dd>
|
2780
|
+
</dl>
|
2781
|
+
|
2782
|
+
<dl>
|
2783
|
+
<dd>
|
2784
|
+
|
2785
|
+
**requestOptions:** `Files.RequestOptions`
|
2786
|
+
|
2787
|
+
</dd>
|
2788
|
+
</dl>
|
2789
|
+
</dd>
|
2790
|
+
</dl>
|
2791
|
+
|
2792
|
+
</dd>
|
2793
|
+
</dl>
|
2794
|
+
</details>
|
2795
|
+
|
2796
|
+
## Profiles
|
2797
|
+
|
2798
|
+
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|
2799
|
+
<dl>
|
2800
|
+
<dd>
|
2801
|
+
|
2802
|
+
#### 📝 Description
|
2803
|
+
|
2804
|
+
<dl>
|
2805
|
+
<dd>
|
2806
|
+
|
2807
|
+
<dl>
|
2808
|
+
<dd>
|
2809
|
+
|
2810
|
+
Delete profiles matching by id
|
2811
|
+
|
2812
|
+
</dd>
|
2813
|
+
</dl>
|
2814
|
+
</dd>
|
2815
|
+
</dl>
|
2816
|
+
|
2817
|
+
#### 🔌 Usage
|
2818
|
+
|
2819
|
+
<dl>
|
2820
|
+
<dd>
|
2821
|
+
|
2822
|
+
<dl>
|
2823
|
+
<dd>
|
2824
|
+
|
2825
|
+
```typescript
|
2826
|
+
await client.profiles.delete();
|
2827
|
+
```
|
2828
|
+
|
2829
|
+
</dd>
|
2830
|
+
</dl>
|
2831
|
+
</dd>
|
2832
|
+
</dl>
|
2833
|
+
|
2834
|
+
#### ⚙️ Parameters
|
2835
|
+
|
2836
|
+
<dl>
|
2837
|
+
<dd>
|
2838
|
+
|
2839
|
+
<dl>
|
2840
|
+
<dd>
|
2841
|
+
|
2842
|
+
**request:** `Airtop.ProfilesDeleteRequest`
|
2843
|
+
|
2844
|
+
</dd>
|
2845
|
+
</dl>
|
2846
|
+
|
2847
|
+
<dl>
|
2848
|
+
<dd>
|
2849
|
+
|
2850
|
+
**requestOptions:** `Profiles.RequestOptions`
|
2851
|
+
|
2852
|
+
</dd>
|
2853
|
+
</dl>
|
2854
|
+
</dd>
|
2855
|
+
</dl>
|
2856
|
+
|
2857
|
+
</dd>
|
2858
|
+
</dl>
|
2859
|
+
</details>
|
2860
|
+
|
2861
|
+
## Requests
|
2862
|
+
|
2863
|
+
<details><summary><code>client.requests.<a href="/src/api/resources/requests/client/Client.ts">getRequestStatus</a>(requestId) -> Airtop.RequestStatusResponse</code></summary>
|
2864
|
+
<dl>
|
2865
|
+
<dd>
|
2866
|
+
|
2867
|
+
#### 🔌 Usage
|
2868
|
+
|
2869
|
+
<dl>
|
2870
|
+
<dd>
|
2871
|
+
|
2872
|
+
<dl>
|
2873
|
+
<dd>
|
2874
|
+
|
2875
|
+
```typescript
|
2876
|
+
await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000");
|
2877
|
+
```
|
2878
|
+
|
2879
|
+
</dd>
|
2880
|
+
</dl>
|
2881
|
+
</dd>
|
2882
|
+
</dl>
|
2883
|
+
|
2884
|
+
#### ⚙️ Parameters
|
2885
|
+
|
2886
|
+
<dl>
|
2887
|
+
<dd>
|
2888
|
+
|
2889
|
+
<dl>
|
2890
|
+
<dd>
|
2891
|
+
|
2892
|
+
**requestId:** `string` — The ID of the request to check.
|
2893
|
+
|
2894
|
+
</dd>
|
2895
|
+
</dl>
|
2896
|
+
|
2897
|
+
<dl>
|
2898
|
+
<dd>
|
2899
|
+
|
2900
|
+
**requestOptions:** `Requests.RequestOptions`
|
2901
|
+
|
2902
|
+
</dd>
|
2903
|
+
</dl>
|
2904
|
+
</dd>
|
2905
|
+
</dl>
|
2906
|
+
|
2907
|
+
</dd>
|
2908
|
+
</dl>
|
2909
|
+
</details>
|
2910
|
+
|
2911
|
+
## Sessions
|
2912
|
+
|
2913
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">list</a>({ ...params }) -> Airtop.SessionsResponse</code></summary>
|
2914
|
+
<dl>
|
2915
|
+
<dd>
|
2916
|
+
|
2917
|
+
#### 📝 Description
|
2918
|
+
|
2919
|
+
<dl>
|
2920
|
+
<dd>
|
2921
|
+
|
2922
|
+
<dl>
|
2923
|
+
<dd>
|
2924
|
+
|
2925
|
+
Get a paginated list of sessions filtered by ID or status
|
1311
2926
|
|
1312
2927
|
</dd>
|
1313
2928
|
</dl>
|
@@ -1535,6 +3150,83 @@ await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
1535
3150
|
</dl>
|
1536
3151
|
</details>
|
1537
3152
|
|
3153
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">events</a>(id, { ...params }) -> core.Stream<Airtop.SessionsEventsResponse></code></summary>
|
3154
|
+
<dl>
|
3155
|
+
<dd>
|
3156
|
+
|
3157
|
+
#### 📝 Description
|
3158
|
+
|
3159
|
+
<dl>
|
3160
|
+
<dd>
|
3161
|
+
|
3162
|
+
<dl>
|
3163
|
+
<dd>
|
3164
|
+
|
3165
|
+
Get a session event stream for a given session ID
|
3166
|
+
|
3167
|
+
</dd>
|
3168
|
+
</dl>
|
3169
|
+
</dd>
|
3170
|
+
</dl>
|
3171
|
+
|
3172
|
+
#### 🔌 Usage
|
3173
|
+
|
3174
|
+
<dl>
|
3175
|
+
<dd>
|
3176
|
+
|
3177
|
+
<dl>
|
3178
|
+
<dd>
|
3179
|
+
|
3180
|
+
```typescript
|
3181
|
+
const response = await client.sessions.events("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", {
|
3182
|
+
lastEventId: 0,
|
3183
|
+
all: true,
|
3184
|
+
});
|
3185
|
+
for await (const item of response) {
|
3186
|
+
console.log(item);
|
3187
|
+
}
|
3188
|
+
```
|
3189
|
+
|
3190
|
+
</dd>
|
3191
|
+
</dl>
|
3192
|
+
</dd>
|
3193
|
+
</dl>
|
3194
|
+
|
3195
|
+
#### ⚙️ Parameters
|
3196
|
+
|
3197
|
+
<dl>
|
3198
|
+
<dd>
|
3199
|
+
|
3200
|
+
<dl>
|
3201
|
+
<dd>
|
3202
|
+
|
3203
|
+
**id:** `string` — ID of the session to get status info for
|
3204
|
+
|
3205
|
+
</dd>
|
3206
|
+
</dl>
|
3207
|
+
|
3208
|
+
<dl>
|
3209
|
+
<dd>
|
3210
|
+
|
3211
|
+
**request:** `Airtop.SessionsEventsRequest`
|
3212
|
+
|
3213
|
+
</dd>
|
3214
|
+
</dl>
|
3215
|
+
|
3216
|
+
<dl>
|
3217
|
+
<dd>
|
3218
|
+
|
3219
|
+
**requestOptions:** `Sessions.RequestOptions`
|
3220
|
+
|
3221
|
+
</dd>
|
3222
|
+
</dl>
|
3223
|
+
</dd>
|
3224
|
+
</dl>
|
3225
|
+
|
3226
|
+
</dd>
|
3227
|
+
</dl>
|
3228
|
+
</details>
|
3229
|
+
|
1538
3230
|
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">saveProfileOnTermination</a>(sessionId, profileName) -> void</code></summary>
|
1539
3231
|
<dl>
|
1540
3232
|
<dd>
|