@airtop/sdk 0.1.36 → 0.1.37-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 +3 -0
- package/Client.js +11 -6
- package/README.md +9 -10
- package/api/resources/automations/client/Client.js +4 -4
- 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 +20 -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 +3 -0
- package/api/resources/index.js +4 -1
- package/api/resources/profiles/client/Client.js +1 -1
- package/api/resources/requests/client/Client.js +1 -1
- package/api/resources/sessions/client/Client.js +6 -6
- package/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -1
- package/api/resources/sessions/types/SessionsEventsResponseFileEvent.d.ts +11 -0
- package/api/resources/sessions/types/SessionsEventsResponseFileEvent.js +5 -0
- package/api/resources/sessions/types/index.d.ts +1 -0
- package/api/resources/sessions/types/index.js +1 -0
- package/api/resources/windows/client/Client.d.ts +126 -0
- package/api/resources/windows/client/Client.js +577 -21
- 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/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/OperatorPromptV1Body.d.ts +25 -0
- package/api/resources/windows/client/requests/OperatorPromptV1Body.js +5 -0
- package/api/resources/windows/client/requests/index.d.ts +10 -0
- package/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +9 -0
- package/api/types/AsyncOperatorPromptResponseEnvelope.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/CreateFileV1Status.d.ts +13 -0
- package/api/types/CreateFileV1Status.js +12 -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 +35 -0
- package/api/types/ExternalFile.js +5 -0
- package/api/types/FileEventMessage.d.ts +14 -0
- package/api/types/FileEventMessage.js +5 -0
- package/api/types/FileEventMessageStatus.d.ts +13 -0
- package/api/types/FileEventMessageStatus.js +12 -0
- 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 +26 -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/GetFileV1Status.d.ts +13 -0
- package/api/types/GetFileV1Status.js +12 -0
- package/api/types/index.d.ts +14 -0
- package/api/types/index.js +14 -0
- package/dist/Client.d.ts +3 -0
- package/dist/Client.js +11 -6
- package/dist/api/resources/automations/client/Client.js +4 -4
- 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 +20 -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 +3 -0
- package/dist/api/resources/index.js +4 -1
- package/dist/api/resources/profiles/client/Client.js +1 -1
- package/dist/api/resources/requests/client/Client.js +1 -1
- package/dist/api/resources/sessions/client/Client.js +6 -6
- package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -1
- package/dist/api/resources/sessions/types/SessionsEventsResponseFileEvent.d.ts +11 -0
- package/dist/api/resources/sessions/types/SessionsEventsResponseFileEvent.js +5 -0
- package/dist/api/resources/sessions/types/index.d.ts +1 -0
- package/dist/api/resources/sessions/types/index.js +1 -0
- package/dist/api/resources/windows/client/Client.d.ts +126 -0
- package/dist/api/resources/windows/client/Client.js +577 -21
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/AsyncClickRequest.js +5 -0
- package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +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/OperatorPromptV1Body.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/OperatorPromptV1Body.js +5 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +10 -0
- package/dist/api/types/AsyncOperatorPromptResponseEnvelope.d.ts +9 -0
- package/dist/api/types/AsyncOperatorPromptResponseEnvelope.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/CreateFileV1Status.d.ts +13 -0
- package/dist/api/types/CreateFileV1Status.js +12 -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 +35 -0
- package/dist/api/types/ExternalFile.js +5 -0
- package/dist/api/types/FileEventMessage.d.ts +14 -0
- package/dist/api/types/FileEventMessage.js +5 -0
- package/dist/api/types/FileEventMessageStatus.d.ts +13 -0
- package/dist/api/types/FileEventMessageStatus.js +12 -0
- 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 +26 -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/GetFileV1Status.d.ts +13 -0
- package/dist/api/types/GetFileV1Status.js +12 -0
- package/dist/api/types/index.d.ts +14 -0
- package/dist/api/types/index.js +14 -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 +16 -0
- package/dist/serialization/resources/files/client/requests/CreateFileRestInputV1.js +47 -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 +3 -0
- package/dist/serialization/resources/index.js +4 -1
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -1
- package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -0
- package/dist/serialization/resources/sessions/types/SessionsEventsResponseFileEvent.d.ts +15 -0
- package/dist/serialization/resources/sessions/types/SessionsEventsResponseFileEvent.js +46 -0
- package/dist/serialization/resources/sessions/types/index.d.ts +1 -0
- package/dist/serialization/resources/sessions/types/index.js +1 -0
- 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/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/OperatorPromptV1Body.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +48 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +10 -0
- package/dist/serialization/resources/windows/client/requests/index.js +21 -1
- package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +15 -0
- package/dist/serialization/types/AsyncOperatorPromptResponseEnvelope.js +46 -0
- package/dist/serialization/types/CreateFileV1.d.ts +22 -0
- package/dist/serialization/types/CreateFileV1.js +53 -0
- package/dist/serialization/types/CreateFileV1FileType.d.ts +10 -0
- package/dist/serialization/types/CreateFileV1FileType.js +41 -0
- package/dist/serialization/types/CreateFileV1Status.d.ts +10 -0
- package/dist/serialization/types/CreateFileV1Status.js +41 -0
- package/dist/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +18 -0
- package/dist/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +49 -0
- package/dist/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +18 -0
- package/dist/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +49 -0
- package/dist/serialization/types/ExternalFile.d.ts +26 -0
- package/dist/serialization/types/ExternalFile.js +57 -0
- package/dist/serialization/types/FileEventMessage.d.ts +16 -0
- package/dist/serialization/types/FileEventMessage.js +47 -0
- package/dist/serialization/types/FileEventMessageStatus.d.ts +10 -0
- package/dist/serialization/types/FileEventMessageStatus.js +41 -0
- 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 +23 -0
- package/dist/serialization/types/GetFileV1.js +54 -0
- package/dist/serialization/types/GetFileV1FileType.d.ts +10 -0
- package/dist/serialization/types/GetFileV1FileType.js +41 -0
- package/dist/serialization/types/GetFileV1Status.d.ts +10 -0
- package/dist/serialization/types/GetFileV1Status.js +41 -0
- package/dist/serialization/types/index.d.ts +14 -0
- package/dist/serialization/types/index.js +14 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/AirtopClient.d.ts +3 -0
- package/dist/wrapper/AirtopClient.js +5 -0
- package/dist/wrapper/AirtopFiles.d.ts +50 -0
- package/dist/wrapper/AirtopFiles.js +180 -0
- package/dist/wrapper/AirtopSessions.d.ts +39 -0
- package/dist/wrapper/AirtopSessions.js +219 -17
- package/package.json +1 -1
- package/reference.md +1122 -166
- 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 +16 -0
- package/serialization/resources/files/client/requests/CreateFileRestInputV1.js +47 -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 +3 -0
- package/serialization/resources/index.js +4 -1
- package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -1
- package/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -0
- package/serialization/resources/sessions/types/SessionsEventsResponseFileEvent.d.ts +15 -0
- package/serialization/resources/sessions/types/SessionsEventsResponseFileEvent.js +46 -0
- package/serialization/resources/sessions/types/index.d.ts +1 -0
- package/serialization/resources/sessions/types/index.js +1 -0
- 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/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/OperatorPromptV1Body.d.ts +17 -0
- package/serialization/resources/windows/client/requests/OperatorPromptV1Body.js +48 -0
- package/serialization/resources/windows/client/requests/index.d.ts +10 -0
- package/serialization/resources/windows/client/requests/index.js +21 -1
- package/serialization/types/AsyncOperatorPromptResponseEnvelope.d.ts +15 -0
- package/serialization/types/AsyncOperatorPromptResponseEnvelope.js +46 -0
- package/serialization/types/CreateFileV1.d.ts +22 -0
- package/serialization/types/CreateFileV1.js +53 -0
- package/serialization/types/CreateFileV1FileType.d.ts +10 -0
- package/serialization/types/CreateFileV1FileType.js +41 -0
- package/serialization/types/CreateFileV1Status.d.ts +10 -0
- package/serialization/types/CreateFileV1Status.js +41 -0
- package/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.d.ts +18 -0
- package/serialization/types/EnvelopeCreateFileV1EnvelopeDefaultMeta.js +49 -0
- package/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.d.ts +18 -0
- package/serialization/types/EnvelopeGetFileV1EnvelopeDefaultMeta.js +49 -0
- package/serialization/types/ExternalFile.d.ts +26 -0
- package/serialization/types/ExternalFile.js +57 -0
- package/serialization/types/FileEventMessage.d.ts +16 -0
- package/serialization/types/FileEventMessage.js +47 -0
- package/serialization/types/FileEventMessageStatus.d.ts +10 -0
- package/serialization/types/FileEventMessageStatus.js +41 -0
- 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 +23 -0
- package/serialization/types/GetFileV1.js +54 -0
- package/serialization/types/GetFileV1FileType.d.ts +10 -0
- package/serialization/types/GetFileV1FileType.js +41 -0
- package/serialization/types/GetFileV1Status.d.ts +10 -0
- package/serialization/types/GetFileV1Status.js +41 -0
- package/serialization/types/index.d.ts +14 -0
- package/serialization/types/index.js +14 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/AirtopClient.d.ts +3 -0
- package/wrapper/AirtopClient.js +5 -0
- package/wrapper/AirtopFiles.d.ts +50 -0
- package/wrapper/AirtopFiles.js +180 -0
- package/wrapper/AirtopSessions.d.ts +39 -0
- package/wrapper/AirtopSessions.js +219 -17
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,10 +30,9 @@ Create an automation of a browser window asynchronously
|
|
30
30
|
<dd>
|
31
31
|
|
32
32
|
```typescript
|
33
|
-
await client.windows.
|
34
|
-
"
|
35
|
-
|
36
|
-
);
|
33
|
+
await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
34
|
+
elementDescription: "The login button",
|
35
|
+
});
|
37
36
|
```
|
38
37
|
|
39
38
|
</dd>
|
@@ -65,7 +64,7 @@ await client.windows.asyncCreateAutomation(
|
|
65
64
|
<dl>
|
66
65
|
<dd>
|
67
66
|
|
68
|
-
**request:** `Airtop.
|
67
|
+
**request:** `Airtop.AsyncClickRequest`
|
69
68
|
|
70
69
|
</dd>
|
71
70
|
</dl>
|
@@ -84,7 +83,7 @@ await client.windows.asyncCreateAutomation(
|
|
84
83
|
</dl>
|
85
84
|
</details>
|
86
85
|
|
87
|
-
<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>
|
88
87
|
<dl>
|
89
88
|
<dd>
|
90
89
|
|
@@ -96,7 +95,7 @@ await client.windows.asyncCreateAutomation(
|
|
96
95
|
<dl>
|
97
96
|
<dd>
|
98
97
|
|
99
|
-
Create a
|
98
|
+
Create an automation of a browser window asynchronously
|
100
99
|
|
101
100
|
</dd>
|
102
101
|
</dl>
|
@@ -112,7 +111,7 @@ Create a form filler automation asynchronously
|
|
112
111
|
<dd>
|
113
112
|
|
114
113
|
```typescript
|
115
|
-
await client.windows.
|
114
|
+
await client.windows.asyncCreateAutomation(
|
116
115
|
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
117
116
|
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
118
117
|
);
|
@@ -147,7 +146,7 @@ await client.windows.asyncCreateFormFiller(
|
|
147
146
|
<dl>
|
148
147
|
<dd>
|
149
148
|
|
150
|
-
**request:** `Airtop.
|
149
|
+
**request:** `Airtop.AsyncCreateAutomationRequest`
|
151
150
|
|
152
151
|
</dd>
|
153
152
|
</dl>
|
@@ -166,7 +165,7 @@ await client.windows.asyncCreateFormFiller(
|
|
166
165
|
</dl>
|
167
166
|
</details>
|
168
167
|
|
169
|
-
<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>
|
170
169
|
<dl>
|
171
170
|
<dd>
|
172
171
|
|
@@ -178,7 +177,7 @@ await client.windows.asyncCreateFormFiller(
|
|
178
177
|
<dl>
|
179
178
|
<dd>
|
180
179
|
|
181
|
-
|
180
|
+
Create a form filler automation asynchronously
|
182
181
|
|
183
182
|
</dd>
|
184
183
|
</dl>
|
@@ -194,12 +193,9 @@ Execute an automation of a browser window asynchronously
|
|
194
193
|
<dd>
|
195
194
|
|
196
195
|
```typescript
|
197
|
-
await client.windows.
|
196
|
+
await client.windows.asyncCreateFormFiller(
|
198
197
|
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
199
198
|
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
200
|
-
{
|
201
|
-
automationId: "automationId",
|
202
|
-
},
|
203
199
|
);
|
204
200
|
```
|
205
201
|
|
@@ -232,7 +228,7 @@ await client.windows.asyncExecuteAutomation(
|
|
232
228
|
<dl>
|
233
229
|
<dd>
|
234
230
|
|
235
|
-
**request:** `Airtop.
|
231
|
+
**request:** `Airtop.AsyncCreateFormFillerRequest`
|
236
232
|
|
237
233
|
</dd>
|
238
234
|
</dl>
|
@@ -251,7 +247,7 @@ await client.windows.asyncExecuteAutomation(
|
|
251
247
|
</dl>
|
252
248
|
</details>
|
253
249
|
|
254
|
-
<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>
|
255
251
|
<dl>
|
256
252
|
<dd>
|
257
253
|
|
@@ -263,7 +259,7 @@ await client.windows.asyncExecuteAutomation(
|
|
263
259
|
<dl>
|
264
260
|
<dd>
|
265
261
|
|
266
|
-
|
262
|
+
Execute an automation of a browser window asynchronously
|
267
263
|
|
268
264
|
</dd>
|
269
265
|
</dl>
|
@@ -279,9 +275,13 @@ Fill a form of a browser window asynchronously using a form-filler automation
|
|
279
275
|
<dd>
|
280
276
|
|
281
277
|
```typescript
|
282
|
-
await client.windows.
|
283
|
-
|
284
|
-
|
278
|
+
await client.windows.asyncExecuteAutomation(
|
279
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
280
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
281
|
+
{
|
282
|
+
automationId: "automationId",
|
283
|
+
},
|
284
|
+
);
|
285
285
|
```
|
286
286
|
|
287
287
|
</dd>
|
@@ -313,7 +313,7 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
313
313
|
<dl>
|
314
314
|
<dd>
|
315
315
|
|
316
|
-
**request:** `Airtop.
|
316
|
+
**request:** `Airtop.AsyncExecuteAutomationRequest`
|
317
317
|
|
318
318
|
</dd>
|
319
319
|
</dl>
|
@@ -332,7 +332,7 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
332
332
|
</dl>
|
333
333
|
</details>
|
334
334
|
|
335
|
-
<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>
|
336
336
|
<dl>
|
337
337
|
<dd>
|
338
338
|
|
@@ -344,7 +344,7 @@ await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
344
344
|
<dl>
|
345
345
|
<dd>
|
346
346
|
|
347
|
-
|
347
|
+
Fill a form of a browser window asynchronously using a form-filler automation
|
348
348
|
|
349
349
|
</dd>
|
350
350
|
</dl>
|
@@ -360,7 +360,9 @@ Creates a new browser window in a session. Optionally, you can specify a url to
|
|
360
360
|
<dd>
|
361
361
|
|
362
362
|
```typescript
|
363
|
-
await client.windows.
|
363
|
+
await client.windows.asyncFillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
364
|
+
automationId: "automationId",
|
365
|
+
});
|
364
366
|
```
|
365
367
|
|
366
368
|
</dd>
|
@@ -376,7 +378,7 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
376
378
|
<dl>
|
377
379
|
<dd>
|
378
380
|
|
379
|
-
**sessionId:** `string` —
|
381
|
+
**sessionId:** `string` — The session id for the window.
|
380
382
|
|
381
383
|
</dd>
|
382
384
|
</dl>
|
@@ -384,7 +386,15 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
384
386
|
<dl>
|
385
387
|
<dd>
|
386
388
|
|
387
|
-
**
|
389
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
390
|
+
|
391
|
+
</dd>
|
392
|
+
</dl>
|
393
|
+
|
394
|
+
<dl>
|
395
|
+
<dd>
|
396
|
+
|
397
|
+
**request:** `Airtop.AsyncFillFormRequest`
|
388
398
|
|
389
399
|
</dd>
|
390
400
|
</dl>
|
@@ -403,25 +413,10 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
|
403
413
|
</dl>
|
404
414
|
</details>
|
405
415
|
|
406
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
407
|
-
<dl>
|
408
|
-
<dd>
|
409
|
-
|
410
|
-
#### 📝 Description
|
411
|
-
|
412
|
-
<dl>
|
413
|
-
<dd>
|
414
|
-
|
416
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncHover</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
415
417
|
<dl>
|
416
418
|
<dd>
|
417
419
|
|
418
|
-
Get information about a browser window in a session, including the live view url.
|
419
|
-
|
420
|
-
</dd>
|
421
|
-
</dl>
|
422
|
-
</dd>
|
423
|
-
</dl>
|
424
|
-
|
425
420
|
#### 🔌 Usage
|
426
421
|
|
427
422
|
<dl>
|
@@ -431,8 +426,8 @@ Get information about a browser window in a session, including the live view url
|
|
431
426
|
<dd>
|
432
427
|
|
433
428
|
```typescript
|
434
|
-
await client.windows.
|
435
|
-
|
429
|
+
await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
430
|
+
elementDescription: "The search box input in the top right corner",
|
436
431
|
});
|
437
432
|
```
|
438
433
|
|
@@ -449,7 +444,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
449
444
|
<dl>
|
450
445
|
<dd>
|
451
446
|
|
452
|
-
**sessionId:** `string` —
|
447
|
+
**sessionId:** `string` — The session id for the window.
|
453
448
|
|
454
449
|
</dd>
|
455
450
|
</dl>
|
@@ -457,7 +452,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
457
452
|
<dl>
|
458
453
|
<dd>
|
459
454
|
|
460
|
-
**windowId:** `string` —
|
455
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
461
456
|
|
462
457
|
</dd>
|
463
458
|
</dl>
|
@@ -465,7 +460,7 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
465
460
|
<dl>
|
466
461
|
<dd>
|
467
462
|
|
468
|
-
**request:** `Airtop.
|
463
|
+
**request:** `Airtop.AsyncHoverRequest`
|
469
464
|
|
470
465
|
</dd>
|
471
466
|
</dl>
|
@@ -484,25 +479,10 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
|
|
484
479
|
</dl>
|
485
480
|
</details>
|
486
481
|
|
487
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
488
|
-
<dl>
|
489
|
-
<dd>
|
490
|
-
|
491
|
-
#### 📝 Description
|
492
|
-
|
493
|
-
<dl>
|
494
|
-
<dd>
|
495
|
-
|
482
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncMonitor</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
496
483
|
<dl>
|
497
484
|
<dd>
|
498
485
|
|
499
|
-
Loads a specified url on a given window
|
500
|
-
|
501
|
-
</dd>
|
502
|
-
</dl>
|
503
|
-
</dd>
|
504
|
-
</dl>
|
505
|
-
|
506
486
|
#### 🔌 Usage
|
507
487
|
|
508
488
|
<dl>
|
@@ -512,8 +492,8 @@ Loads a specified url on a given window
|
|
512
492
|
<dd>
|
513
493
|
|
514
494
|
```typescript
|
515
|
-
await client.windows.
|
516
|
-
|
495
|
+
await client.windows.asyncMonitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
496
|
+
condition: "Determine if the user appears to be signed in to the website",
|
517
497
|
});
|
518
498
|
```
|
519
499
|
|
@@ -530,7 +510,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
530
510
|
<dl>
|
531
511
|
<dd>
|
532
512
|
|
533
|
-
**sessionId:** `string` —
|
513
|
+
**sessionId:** `string` — The session id for the window.
|
534
514
|
|
535
515
|
</dd>
|
536
516
|
</dl>
|
@@ -538,7 +518,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
538
518
|
<dl>
|
539
519
|
<dd>
|
540
520
|
|
541
|
-
**windowId:** `string` — Airtop window
|
521
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
542
522
|
|
543
523
|
</dd>
|
544
524
|
</dl>
|
@@ -546,7 +526,7 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
546
526
|
<dl>
|
547
527
|
<dd>
|
548
528
|
|
549
|
-
**request:** `Airtop.
|
529
|
+
**request:** `Airtop.AsyncMonitorRequest`
|
550
530
|
|
551
531
|
</dd>
|
552
532
|
</dl>
|
@@ -565,11 +545,11 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
565
545
|
</dl>
|
566
546
|
</details>
|
567
547
|
|
568
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
548
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
569
549
|
<dl>
|
570
550
|
<dd>
|
571
551
|
|
572
|
-
####
|
552
|
+
#### 🔌 Usage
|
573
553
|
|
574
554
|
<dl>
|
575
555
|
<dd>
|
@@ -577,14 +557,18 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
|
|
577
557
|
<dl>
|
578
558
|
<dd>
|
579
559
|
|
580
|
-
|
560
|
+
```typescript
|
561
|
+
await client.windows.asyncPageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
562
|
+
prompt: "What is the main idea of this page?",
|
563
|
+
});
|
564
|
+
```
|
581
565
|
|
582
566
|
</dd>
|
583
567
|
</dl>
|
584
568
|
</dd>
|
585
569
|
</dl>
|
586
570
|
|
587
|
-
####
|
571
|
+
#### ⚙️ Parameters
|
588
572
|
|
589
573
|
<dl>
|
590
574
|
<dd>
|
@@ -592,24 +576,15 @@ Closes a browser window in a session
|
|
592
576
|
<dl>
|
593
577
|
<dd>
|
594
578
|
|
595
|
-
|
596
|
-
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
597
|
-
```
|
579
|
+
**sessionId:** `string` — The session id for the window.
|
598
580
|
|
599
|
-
</dd>
|
600
|
-
</dl>
|
601
581
|
</dd>
|
602
582
|
</dl>
|
603
583
|
|
604
|
-
#### ⚙️ Parameters
|
605
|
-
|
606
|
-
<dl>
|
607
|
-
<dd>
|
608
|
-
|
609
584
|
<dl>
|
610
585
|
<dd>
|
611
586
|
|
612
|
-
**
|
587
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
613
588
|
|
614
589
|
</dd>
|
615
590
|
</dl>
|
@@ -617,7 +592,7 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
617
592
|
<dl>
|
618
593
|
<dd>
|
619
594
|
|
620
|
-
**
|
595
|
+
**request:** `Airtop.AsyncPageQueryRequest`
|
621
596
|
|
622
597
|
</dd>
|
623
598
|
</dl>
|
@@ -636,25 +611,10 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
636
611
|
</dl>
|
637
612
|
</details>
|
638
613
|
|
639
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
640
|
-
<dl>
|
641
|
-
<dd>
|
642
|
-
|
643
|
-
#### 📝 Description
|
644
|
-
|
645
|
-
<dl>
|
646
|
-
<dd>
|
647
|
-
|
614
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncPaginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
648
615
|
<dl>
|
649
616
|
<dd>
|
650
617
|
|
651
|
-
Execute a click interaction in a specific browser window
|
652
|
-
|
653
|
-
</dd>
|
654
|
-
</dl>
|
655
|
-
</dd>
|
656
|
-
</dl>
|
657
|
-
|
658
618
|
#### 🔌 Usage
|
659
619
|
|
660
620
|
<dl>
|
@@ -664,9 +624,13 @@ Execute a click interaction in a specific browser window
|
|
664
624
|
<dd>
|
665
625
|
|
666
626
|
```typescript
|
667
|
-
await client.windows.
|
668
|
-
|
669
|
-
|
627
|
+
await client.windows.asyncPaginatedExtraction(
|
628
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
629
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
630
|
+
{
|
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.",
|
632
|
+
},
|
633
|
+
);
|
670
634
|
```
|
671
635
|
|
672
636
|
</dd>
|
@@ -698,7 +662,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
698
662
|
<dl>
|
699
663
|
<dd>
|
700
664
|
|
701
|
-
**request:** `Airtop.
|
665
|
+
**request:** `Airtop.AsyncPaginatedExtractionRequest`
|
702
666
|
|
703
667
|
</dd>
|
704
668
|
</dl>
|
@@ -717,7 +681,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
717
681
|
</dl>
|
718
682
|
</details>
|
719
683
|
|
720
|
-
<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>
|
721
685
|
<dl>
|
722
686
|
<dd>
|
723
687
|
|
@@ -729,7 +693,7 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
729
693
|
<dl>
|
730
694
|
<dd>
|
731
695
|
|
732
|
-
|
696
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
733
697
|
|
734
698
|
</dd>
|
735
699
|
</dl>
|
@@ -745,7 +709,13 @@ Create a form-filler automation synchronously for the form loaded in the browser
|
|
745
709
|
<dd>
|
746
710
|
|
747
711
|
```typescript
|
748
|
-
await client.windows.
|
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
|
+
);
|
749
719
|
```
|
750
720
|
|
751
721
|
</dd>
|
@@ -777,7 +747,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
777
747
|
<dl>
|
778
748
|
<dd>
|
779
749
|
|
780
|
-
**request:** `Airtop.
|
750
|
+
**request:** `Airtop.AsyncPromptContentRequest`
|
781
751
|
|
782
752
|
</dd>
|
783
753
|
</dl>
|
@@ -796,7 +766,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
796
766
|
</dl>
|
797
767
|
</details>
|
798
768
|
|
799
|
-
<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>
|
800
770
|
<dl>
|
801
771
|
<dd>
|
802
772
|
|
@@ -808,7 +778,7 @@ await client.windows.createFormFiller("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
808
778
|
<dl>
|
809
779
|
<dd>
|
810
780
|
|
811
|
-
|
781
|
+
Take a screenshot of the current viewport of a browser window asynchronously
|
812
782
|
|
813
783
|
</dd>
|
814
784
|
</dl>
|
@@ -824,9 +794,7 @@ Fill a form of a browser window synchronously using a form-filler automation
|
|
824
794
|
<dd>
|
825
795
|
|
826
796
|
```typescript
|
827
|
-
await client.windows.
|
828
|
-
automationId: "automationId",
|
829
|
-
});
|
797
|
+
await client.windows.asyncScreenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
830
798
|
```
|
831
799
|
|
832
800
|
</dd>
|
@@ -858,7 +826,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
858
826
|
<dl>
|
859
827
|
<dd>
|
860
828
|
|
861
|
-
**request:** `Airtop.
|
829
|
+
**request:** `Airtop.AsyncScreenshotRequest`
|
862
830
|
|
863
831
|
</dd>
|
864
832
|
</dl>
|
@@ -877,7 +845,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
877
845
|
</dl>
|
878
846
|
</details>
|
879
847
|
|
880
|
-
<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>
|
881
849
|
<dl>
|
882
850
|
<dd>
|
883
851
|
|
@@ -889,7 +857,7 @@ await client.windows.fillForm("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-
|
|
889
857
|
<dl>
|
890
858
|
<dd>
|
891
859
|
|
892
|
-
|
860
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
893
861
|
|
894
862
|
</dd>
|
895
863
|
</dl>
|
@@ -905,9 +873,10 @@ Execute a hover interaction in a specific browser window
|
|
905
873
|
<dd>
|
906
874
|
|
907
875
|
```typescript
|
908
|
-
await client.windows.
|
909
|
-
|
910
|
-
|
876
|
+
await client.windows.asyncSummarizeContent(
|
877
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
878
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
879
|
+
);
|
911
880
|
```
|
912
881
|
|
913
882
|
</dd>
|
@@ -931,7 +900,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
931
900
|
<dl>
|
932
901
|
<dd>
|
933
902
|
|
934
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
903
|
+
**windowId:** `string` — The Airtop window id of the browser window to summarize.
|
935
904
|
|
936
905
|
</dd>
|
937
906
|
</dl>
|
@@ -939,7 +908,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
939
908
|
<dl>
|
940
909
|
<dd>
|
941
910
|
|
942
|
-
**request:** `Airtop.
|
911
|
+
**request:** `Airtop.AsyncSummarizeContentRequest`
|
943
912
|
|
944
913
|
</dd>
|
945
914
|
</dl>
|
@@ -958,7 +927,7 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
958
927
|
</dl>
|
959
928
|
</details>
|
960
929
|
|
961
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
930
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">asyncType</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncSessionAiResponseEnvelope</code></summary>
|
962
931
|
<dl>
|
963
932
|
<dd>
|
964
933
|
|
@@ -971,8 +940,8 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
|
|
971
940
|
<dd>
|
972
941
|
|
973
942
|
```typescript
|
974
|
-
await client.windows.
|
975
|
-
|
943
|
+
await client.windows.asyncType("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
944
|
+
text: "Example text",
|
976
945
|
});
|
977
946
|
```
|
978
947
|
|
@@ -1005,7 +974,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1005
974
|
<dl>
|
1006
975
|
<dd>
|
1007
976
|
|
1008
|
-
**request:** `Airtop.
|
977
|
+
**request:** `Airtop.AsyncTypeRequest`
|
1009
978
|
|
1010
979
|
</dd>
|
1011
980
|
</dl>
|
@@ -1024,7 +993,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1024
993
|
</dl>
|
1025
994
|
</details>
|
1026
995
|
|
1027
|
-
<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>
|
1028
997
|
<dl>
|
1029
998
|
<dd>
|
1030
999
|
|
@@ -1036,7 +1005,7 @@ await client.windows.monitor("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-9
|
|
1036
1005
|
<dl>
|
1037
1006
|
<dd>
|
1038
1007
|
|
1039
|
-
|
1008
|
+
Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
|
1040
1009
|
|
1041
1010
|
</dd>
|
1042
1011
|
</dl>
|
@@ -1052,9 +1021,7 @@ Submit a prompt that queries the content of a specific browser window. You may e
|
|
1052
1021
|
<dd>
|
1053
1022
|
|
1054
1023
|
```typescript
|
1055
|
-
await client.windows.
|
1056
|
-
prompt: "What is the main idea of this page?",
|
1057
|
-
});
|
1024
|
+
await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
1058
1025
|
```
|
1059
1026
|
|
1060
1027
|
</dd>
|
@@ -1070,15 +1037,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1070
1037
|
<dl>
|
1071
1038
|
<dd>
|
1072
1039
|
|
1073
|
-
**sessionId:** `string` —
|
1074
|
-
|
1075
|
-
</dd>
|
1076
|
-
</dl>
|
1077
|
-
|
1078
|
-
<dl>
|
1079
|
-
<dd>
|
1080
|
-
|
1081
|
-
**windowId:** `string` — The Airtop window id of the browser window.
|
1040
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1082
1041
|
|
1083
1042
|
</dd>
|
1084
1043
|
</dl>
|
@@ -1086,7 +1045,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1086
1045
|
<dl>
|
1087
1046
|
<dd>
|
1088
1047
|
|
1089
|
-
**request:** `Airtop.
|
1048
|
+
**request:** `Airtop.CreateWindowInputV1Body`
|
1090
1049
|
|
1091
1050
|
</dd>
|
1092
1051
|
</dl>
|
@@ -1105,7 +1064,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1105
1064
|
</dl>
|
1106
1065
|
</details>
|
1107
1066
|
|
1108
|
-
<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>
|
1109
1068
|
<dl>
|
1110
1069
|
<dd>
|
1111
1070
|
|
@@ -1117,7 +1076,7 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
|
|
1117
1076
|
<dl>
|
1118
1077
|
<dd>
|
1119
1078
|
|
1120
|
-
|
1079
|
+
Get information about a browser window in a session, including the live view url.
|
1121
1080
|
|
1122
1081
|
</dd>
|
1123
1082
|
</dl>
|
@@ -1133,13 +1092,9 @@ Submit a prompt that queries the content of a specific browser window and pagina
|
|
1133
1092
|
<dd>
|
1134
1093
|
|
1135
1094
|
```typescript
|
1136
|
-
await client.windows.
|
1137
|
-
"
|
1138
|
-
|
1139
|
-
{
|
1140
|
-
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.",
|
1141
|
-
},
|
1142
|
-
);
|
1095
|
+
await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1096
|
+
screenResolution: "1280x720",
|
1097
|
+
});
|
1143
1098
|
```
|
1144
1099
|
|
1145
1100
|
</dd>
|
@@ -1155,7 +1110,7 @@ await client.windows.paginatedExtraction(
|
|
1155
1110
|
<dl>
|
1156
1111
|
<dd>
|
1157
1112
|
|
1158
|
-
**sessionId:** `string` —
|
1113
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1159
1114
|
|
1160
1115
|
</dd>
|
1161
1116
|
</dl>
|
@@ -1163,7 +1118,7 @@ await client.windows.paginatedExtraction(
|
|
1163
1118
|
<dl>
|
1164
1119
|
<dd>
|
1165
1120
|
|
1166
|
-
**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.
|
1167
1122
|
|
1168
1123
|
</dd>
|
1169
1124
|
</dl>
|
@@ -1171,7 +1126,7 @@ await client.windows.paginatedExtraction(
|
|
1171
1126
|
<dl>
|
1172
1127
|
<dd>
|
1173
1128
|
|
1174
|
-
**request:** `Airtop.
|
1129
|
+
**request:** `Airtop.GetWindowInfoRequest`
|
1175
1130
|
|
1176
1131
|
</dd>
|
1177
1132
|
</dl>
|
@@ -1190,7 +1145,7 @@ await client.windows.paginatedExtraction(
|
|
1190
1145
|
</dl>
|
1191
1146
|
</details>
|
1192
1147
|
|
1193
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1148
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">loadUrl</a>(sessionId, windowId, { ...params }) -> Airtop.OperationOutcomeResponse</code></summary>
|
1194
1149
|
<dl>
|
1195
1150
|
<dd>
|
1196
1151
|
|
@@ -1202,7 +1157,7 @@ await client.windows.paginatedExtraction(
|
|
1202
1157
|
<dl>
|
1203
1158
|
<dd>
|
1204
1159
|
|
1205
|
-
|
1160
|
+
Loads a specified url on a given window
|
1206
1161
|
|
1207
1162
|
</dd>
|
1208
1163
|
</dl>
|
@@ -1218,8 +1173,8 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
|
1218
1173
|
<dd>
|
1219
1174
|
|
1220
1175
|
```typescript
|
1221
|
-
await client.windows.
|
1222
|
-
|
1176
|
+
await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1177
|
+
url: "https://www.airtop.ai",
|
1223
1178
|
});
|
1224
1179
|
```
|
1225
1180
|
|
@@ -1236,7 +1191,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1236
1191
|
<dl>
|
1237
1192
|
<dd>
|
1238
1193
|
|
1239
|
-
**sessionId:** `string` —
|
1194
|
+
**sessionId:** `string` — ID of the session that owns the window.
|
1240
1195
|
|
1241
1196
|
</dd>
|
1242
1197
|
</dl>
|
@@ -1244,7 +1199,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1244
1199
|
<dl>
|
1245
1200
|
<dd>
|
1246
1201
|
|
1247
|
-
**windowId:** `string` —
|
1202
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1248
1203
|
|
1249
1204
|
</dd>
|
1250
1205
|
</dl>
|
@@ -1252,7 +1207,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1252
1207
|
<dl>
|
1253
1208
|
<dd>
|
1254
1209
|
|
1255
|
-
**request:** `Airtop.
|
1210
|
+
**request:** `Airtop.WindowLoadUrlV1Body`
|
1256
1211
|
|
1257
1212
|
</dd>
|
1258
1213
|
</dl>
|
@@ -1271,7 +1226,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1271
1226
|
</dl>
|
1272
1227
|
</details>
|
1273
1228
|
|
1274
|
-
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">
|
1229
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">close</a>(sessionId, windowId) -> Airtop.WindowIdResponse</code></summary>
|
1275
1230
|
<dl>
|
1276
1231
|
<dd>
|
1277
1232
|
|
@@ -1283,7 +1238,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1283
1238
|
<dl>
|
1284
1239
|
<dd>
|
1285
1240
|
|
1286
|
-
|
1241
|
+
Closes a browser window in a session
|
1287
1242
|
|
1288
1243
|
</dd>
|
1289
1244
|
</dl>
|
@@ -1299,7 +1254,7 @@ Scrape a window and return the content as markdown
|
|
1299
1254
|
<dd>
|
1300
1255
|
|
1301
1256
|
```typescript
|
1302
|
-
await client.windows.
|
1257
|
+
await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430");
|
1303
1258
|
```
|
1304
1259
|
|
1305
1260
|
</dd>
|
@@ -1315,7 +1270,794 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
1315
1270
|
<dl>
|
1316
1271
|
<dd>
|
1317
1272
|
|
1318
|
-
**sessionId:** `string` —
|
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">operatorPrompt</a>(sessionId, windowId, { ...params }) -> Airtop.AsyncOperatorPromptResponseEnvelope</code></summary>
|
1689
|
+
<dl>
|
1690
|
+
<dd>
|
1691
|
+
|
1692
|
+
#### 📝 Description
|
1693
|
+
|
1694
|
+
<dl>
|
1695
|
+
<dd>
|
1696
|
+
|
1697
|
+
<dl>
|
1698
|
+
<dd>
|
1699
|
+
|
1700
|
+
Prompt OpenAI Operator
|
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.operatorPrompt("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430", {
|
1717
|
+
prompt: "What is the latest news about OpenAI?",
|
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` — ID of the session that owns the window.
|
1735
|
+
|
1736
|
+
</dd>
|
1737
|
+
</dl>
|
1738
|
+
|
1739
|
+
<dl>
|
1740
|
+
<dd>
|
1741
|
+
|
1742
|
+
**windowId:** `string` — Airtop window ID of the browser window.
|
1743
|
+
|
1744
|
+
</dd>
|
1745
|
+
</dl>
|
1746
|
+
|
1747
|
+
<dl>
|
1748
|
+
<dd>
|
1749
|
+
|
1750
|
+
**request:** `Airtop.OperatorPromptV1Body`
|
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">pageQuery</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. 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?).
|
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.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1798
|
+
prompt: "What is the main idea of this page?",
|
1799
|
+
});
|
1800
|
+
```
|
1801
|
+
|
1802
|
+
</dd>
|
1803
|
+
</dl>
|
1804
|
+
</dd>
|
1805
|
+
</dl>
|
1806
|
+
|
1807
|
+
#### ⚙️ Parameters
|
1808
|
+
|
1809
|
+
<dl>
|
1810
|
+
<dd>
|
1811
|
+
|
1812
|
+
<dl>
|
1813
|
+
<dd>
|
1814
|
+
|
1815
|
+
**sessionId:** `string` — The session id for the window.
|
1816
|
+
|
1817
|
+
</dd>
|
1818
|
+
</dl>
|
1819
|
+
|
1820
|
+
<dl>
|
1821
|
+
<dd>
|
1822
|
+
|
1823
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1824
|
+
|
1825
|
+
</dd>
|
1826
|
+
</dl>
|
1827
|
+
|
1828
|
+
<dl>
|
1829
|
+
<dd>
|
1830
|
+
|
1831
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
1832
|
+
|
1833
|
+
</dd>
|
1834
|
+
</dl>
|
1835
|
+
|
1836
|
+
<dl>
|
1837
|
+
<dd>
|
1838
|
+
|
1839
|
+
**requestOptions:** `Windows.RequestOptions`
|
1840
|
+
|
1841
|
+
</dd>
|
1842
|
+
</dl>
|
1843
|
+
</dd>
|
1844
|
+
</dl>
|
1845
|
+
|
1846
|
+
</dd>
|
1847
|
+
</dl>
|
1848
|
+
</details>
|
1849
|
+
|
1850
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">paginatedExtraction</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1851
|
+
<dl>
|
1852
|
+
<dd>
|
1853
|
+
|
1854
|
+
#### 📝 Description
|
1855
|
+
|
1856
|
+
<dl>
|
1857
|
+
<dd>
|
1858
|
+
|
1859
|
+
<dl>
|
1860
|
+
<dd>
|
1861
|
+
|
1862
|
+
Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
|
1863
|
+
|
1864
|
+
</dd>
|
1865
|
+
</dl>
|
1866
|
+
</dd>
|
1867
|
+
</dl>
|
1868
|
+
|
1869
|
+
#### 🔌 Usage
|
1870
|
+
|
1871
|
+
<dl>
|
1872
|
+
<dd>
|
1873
|
+
|
1874
|
+
<dl>
|
1875
|
+
<dd>
|
1876
|
+
|
1877
|
+
```typescript
|
1878
|
+
await client.windows.paginatedExtraction(
|
1879
|
+
"6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
|
1880
|
+
"0334da2a-91b0-42c5-6156-76a5eba87430",
|
1881
|
+
{
|
1882
|
+
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.",
|
1883
|
+
},
|
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.SessionPaginatedExtractionHandlerRequestBody`
|
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">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1936
|
+
<dl>
|
1937
|
+
<dd>
|
1938
|
+
|
1939
|
+
#### 📝 Description
|
1940
|
+
|
1941
|
+
<dl>
|
1942
|
+
<dd>
|
1943
|
+
|
1944
|
+
<dl>
|
1945
|
+
<dd>
|
1946
|
+
|
1947
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
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.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1964
|
+
prompt: "What is the main idea of this page?",
|
1965
|
+
});
|
1966
|
+
```
|
1967
|
+
|
1968
|
+
</dd>
|
1969
|
+
</dl>
|
1970
|
+
</dd>
|
1971
|
+
</dl>
|
1972
|
+
|
1973
|
+
#### ⚙️ Parameters
|
1974
|
+
|
1975
|
+
<dl>
|
1976
|
+
<dd>
|
1977
|
+
|
1978
|
+
<dl>
|
1979
|
+
<dd>
|
1980
|
+
|
1981
|
+
**sessionId:** `string` — The session id for the window.
|
1982
|
+
|
1983
|
+
</dd>
|
1984
|
+
</dl>
|
1985
|
+
|
1986
|
+
<dl>
|
1987
|
+
<dd>
|
1988
|
+
|
1989
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1990
|
+
|
1991
|
+
</dd>
|
1992
|
+
</dl>
|
1993
|
+
|
1994
|
+
<dl>
|
1995
|
+
<dd>
|
1996
|
+
|
1997
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
1998
|
+
|
1999
|
+
</dd>
|
2000
|
+
</dl>
|
2001
|
+
|
2002
|
+
<dl>
|
2003
|
+
<dd>
|
2004
|
+
|
2005
|
+
**requestOptions:** `Windows.RequestOptions`
|
2006
|
+
|
2007
|
+
</dd>
|
2008
|
+
</dl>
|
2009
|
+
</dd>
|
2010
|
+
</dl>
|
2011
|
+
|
2012
|
+
</dd>
|
2013
|
+
</dl>
|
2014
|
+
</details>
|
2015
|
+
|
2016
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">scrapeContent</a>(sessionId, windowId, { ...params }) -> Airtop.ScrapeResponse</code></summary>
|
2017
|
+
<dl>
|
2018
|
+
<dd>
|
2019
|
+
|
2020
|
+
#### 📝 Description
|
2021
|
+
|
2022
|
+
<dl>
|
2023
|
+
<dd>
|
2024
|
+
|
2025
|
+
<dl>
|
2026
|
+
<dd>
|
2027
|
+
|
2028
|
+
Scrape a window and return the content as markdown
|
2029
|
+
|
2030
|
+
</dd>
|
2031
|
+
</dl>
|
2032
|
+
</dd>
|
2033
|
+
</dl>
|
2034
|
+
|
2035
|
+
#### 🔌 Usage
|
2036
|
+
|
2037
|
+
<dl>
|
2038
|
+
<dd>
|
2039
|
+
|
2040
|
+
<dl>
|
2041
|
+
<dd>
|
2042
|
+
|
2043
|
+
```typescript
|
2044
|
+
await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
2045
|
+
```
|
2046
|
+
|
2047
|
+
</dd>
|
2048
|
+
</dl>
|
2049
|
+
</dd>
|
2050
|
+
</dl>
|
2051
|
+
|
2052
|
+
#### ⚙️ Parameters
|
2053
|
+
|
2054
|
+
<dl>
|
2055
|
+
<dd>
|
2056
|
+
|
2057
|
+
<dl>
|
2058
|
+
<dd>
|
2059
|
+
|
2060
|
+
**sessionId:** `string` — The session id for the window.
|
1319
2061
|
|
1320
2062
|
</dd>
|
1321
2063
|
</dl>
|
@@ -1918,6 +2660,220 @@ await client.automations.delete("automationId");
|
|
1918
2660
|
</dl>
|
1919
2661
|
</details>
|
1920
2662
|
|
2663
|
+
## Files
|
2664
|
+
|
2665
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">list</a>({ ...params }) -> Airtop.FilesResponse</code></summary>
|
2666
|
+
<dl>
|
2667
|
+
<dd>
|
2668
|
+
|
2669
|
+
#### 📝 Description
|
2670
|
+
|
2671
|
+
<dl>
|
2672
|
+
<dd>
|
2673
|
+
|
2674
|
+
<dl>
|
2675
|
+
<dd>
|
2676
|
+
|
2677
|
+
Get a list of files filtered by session ID
|
2678
|
+
|
2679
|
+
</dd>
|
2680
|
+
</dl>
|
2681
|
+
</dd>
|
2682
|
+
</dl>
|
2683
|
+
|
2684
|
+
#### 🔌 Usage
|
2685
|
+
|
2686
|
+
<dl>
|
2687
|
+
<dd>
|
2688
|
+
|
2689
|
+
<dl>
|
2690
|
+
<dd>
|
2691
|
+
|
2692
|
+
```typescript
|
2693
|
+
await client.files.list({
|
2694
|
+
offset: 1,
|
2695
|
+
limit: 10,
|
2696
|
+
});
|
2697
|
+
```
|
2698
|
+
|
2699
|
+
</dd>
|
2700
|
+
</dl>
|
2701
|
+
</dd>
|
2702
|
+
</dl>
|
2703
|
+
|
2704
|
+
#### ⚙️ Parameters
|
2705
|
+
|
2706
|
+
<dl>
|
2707
|
+
<dd>
|
2708
|
+
|
2709
|
+
<dl>
|
2710
|
+
<dd>
|
2711
|
+
|
2712
|
+
**request:** `Airtop.FilesListRequest`
|
2713
|
+
|
2714
|
+
</dd>
|
2715
|
+
</dl>
|
2716
|
+
|
2717
|
+
<dl>
|
2718
|
+
<dd>
|
2719
|
+
|
2720
|
+
**requestOptions:** `Files.RequestOptions`
|
2721
|
+
|
2722
|
+
</dd>
|
2723
|
+
</dl>
|
2724
|
+
</dd>
|
2725
|
+
</dl>
|
2726
|
+
|
2727
|
+
</dd>
|
2728
|
+
</dl>
|
2729
|
+
</details>
|
2730
|
+
|
2731
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">create</a>({ ...params }) -> Airtop.EnvelopeCreateFileV1EnvelopeDefaultMeta</code></summary>
|
2732
|
+
<dl>
|
2733
|
+
<dd>
|
2734
|
+
|
2735
|
+
#### 🔌 Usage
|
2736
|
+
|
2737
|
+
<dl>
|
2738
|
+
<dd>
|
2739
|
+
|
2740
|
+
<dl>
|
2741
|
+
<dd>
|
2742
|
+
|
2743
|
+
```typescript
|
2744
|
+
await client.files.create({
|
2745
|
+
fileName: "fileName",
|
2746
|
+
});
|
2747
|
+
```
|
2748
|
+
|
2749
|
+
</dd>
|
2750
|
+
</dl>
|
2751
|
+
</dd>
|
2752
|
+
</dl>
|
2753
|
+
|
2754
|
+
#### ⚙️ Parameters
|
2755
|
+
|
2756
|
+
<dl>
|
2757
|
+
<dd>
|
2758
|
+
|
2759
|
+
<dl>
|
2760
|
+
<dd>
|
2761
|
+
|
2762
|
+
**request:** `Airtop.CreateFileRestInputV1`
|
2763
|
+
|
2764
|
+
</dd>
|
2765
|
+
</dl>
|
2766
|
+
|
2767
|
+
<dl>
|
2768
|
+
<dd>
|
2769
|
+
|
2770
|
+
**requestOptions:** `Files.RequestOptions`
|
2771
|
+
|
2772
|
+
</dd>
|
2773
|
+
</dl>
|
2774
|
+
</dd>
|
2775
|
+
</dl>
|
2776
|
+
|
2777
|
+
</dd>
|
2778
|
+
</dl>
|
2779
|
+
</details>
|
2780
|
+
|
2781
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">get</a>(id) -> Airtop.EnvelopeGetFileV1EnvelopeDefaultMeta</code></summary>
|
2782
|
+
<dl>
|
2783
|
+
<dd>
|
2784
|
+
|
2785
|
+
#### 🔌 Usage
|
2786
|
+
|
2787
|
+
<dl>
|
2788
|
+
<dd>
|
2789
|
+
|
2790
|
+
<dl>
|
2791
|
+
<dd>
|
2792
|
+
|
2793
|
+
```typescript
|
2794
|
+
await client.files.get("id");
|
2795
|
+
```
|
2796
|
+
|
2797
|
+
</dd>
|
2798
|
+
</dl>
|
2799
|
+
</dd>
|
2800
|
+
</dl>
|
2801
|
+
|
2802
|
+
#### ⚙️ Parameters
|
2803
|
+
|
2804
|
+
<dl>
|
2805
|
+
<dd>
|
2806
|
+
|
2807
|
+
<dl>
|
2808
|
+
<dd>
|
2809
|
+
|
2810
|
+
**id:** `string` — ID of the file
|
2811
|
+
|
2812
|
+
</dd>
|
2813
|
+
</dl>
|
2814
|
+
|
2815
|
+
<dl>
|
2816
|
+
<dd>
|
2817
|
+
|
2818
|
+
**requestOptions:** `Files.RequestOptions`
|
2819
|
+
|
2820
|
+
</dd>
|
2821
|
+
</dl>
|
2822
|
+
</dd>
|
2823
|
+
</dl>
|
2824
|
+
|
2825
|
+
</dd>
|
2826
|
+
</dl>
|
2827
|
+
</details>
|
2828
|
+
|
2829
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">delete</a>(id) -> void</code></summary>
|
2830
|
+
<dl>
|
2831
|
+
<dd>
|
2832
|
+
|
2833
|
+
#### 🔌 Usage
|
2834
|
+
|
2835
|
+
<dl>
|
2836
|
+
<dd>
|
2837
|
+
|
2838
|
+
<dl>
|
2839
|
+
<dd>
|
2840
|
+
|
2841
|
+
```typescript
|
2842
|
+
await client.files.delete("id");
|
2843
|
+
```
|
2844
|
+
|
2845
|
+
</dd>
|
2846
|
+
</dl>
|
2847
|
+
</dd>
|
2848
|
+
</dl>
|
2849
|
+
|
2850
|
+
#### ⚙️ Parameters
|
2851
|
+
|
2852
|
+
<dl>
|
2853
|
+
<dd>
|
2854
|
+
|
2855
|
+
<dl>
|
2856
|
+
<dd>
|
2857
|
+
|
2858
|
+
**id:** `string` — ID of the file
|
2859
|
+
|
2860
|
+
</dd>
|
2861
|
+
</dl>
|
2862
|
+
|
2863
|
+
<dl>
|
2864
|
+
<dd>
|
2865
|
+
|
2866
|
+
**requestOptions:** `Files.RequestOptions`
|
2867
|
+
|
2868
|
+
</dd>
|
2869
|
+
</dl>
|
2870
|
+
</dd>
|
2871
|
+
</dl>
|
2872
|
+
|
2873
|
+
</dd>
|
2874
|
+
</dl>
|
2875
|
+
</details>
|
2876
|
+
|
1921
2877
|
## Profiles
|
1922
2878
|
|
1923
2879
|
<details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
|