@airtop/sdk 0.1.26-beta0 → 0.1.27-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.
Files changed (82) hide show
  1. package/api/resources/extensionConfigurations/client/Client.js +4 -4
  2. package/api/resources/profiles/client/Client.js +2 -2
  3. package/api/resources/requests/client/Client.js +2 -2
  4. package/api/resources/sessions/client/Client.js +14 -14
  5. package/api/resources/windows/client/Client.d.ts +42 -8
  6. package/api/resources/windows/client/Client.js +192 -56
  7. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +23 -0
  8. package/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +5 -0
  9. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +27 -0
  10. package/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +5 -0
  11. package/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +4 -2
  12. package/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +4 -2
  13. package/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +4 -2
  14. package/api/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.d.ts +4 -2
  15. package/api/resources/windows/client/requests/SessionScrollHandlerRequestBody.d.ts +3 -3
  16. package/api/resources/windows/client/requests/index.d.ts +2 -0
  17. package/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
  18. package/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
  19. package/api/types/index.d.ts +1 -0
  20. package/api/types/index.js +1 -0
  21. package/dist/api/resources/extensionConfigurations/client/Client.js +4 -4
  22. package/dist/api/resources/profiles/client/Client.js +2 -2
  23. package/dist/api/resources/requests/client/Client.js +2 -2
  24. package/dist/api/resources/sessions/client/Client.js +14 -14
  25. package/dist/api/resources/windows/client/Client.d.ts +42 -8
  26. package/dist/api/resources/windows/client/Client.js +192 -56
  27. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +23 -0
  28. package/dist/api/resources/windows/client/requests/AsyncCreateAutomationRequest.js +5 -0
  29. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +27 -0
  30. package/dist/api/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +5 -0
  31. package/dist/api/resources/windows/client/requests/AsyncHoverRequest.d.ts +4 -2
  32. package/dist/api/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +4 -2
  33. package/dist/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +4 -2
  34. package/dist/api/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.d.ts +4 -2
  35. package/dist/api/resources/windows/client/requests/SessionScrollHandlerRequestBody.d.ts +3 -3
  36. package/dist/api/resources/windows/client/requests/index.d.ts +2 -0
  37. package/dist/api/types/CreateAutomationRequestBodyConfiguration.d.ts +4 -0
  38. package/dist/api/types/CreateAutomationRequestBodyConfiguration.js +5 -0
  39. package/dist/api/types/index.d.ts +1 -0
  40. package/dist/api/types/index.js +1 -0
  41. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
  42. package/dist/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +39 -0
  43. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
  44. package/dist/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +39 -0
  45. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +1 -1
  46. package/dist/serialization/resources/windows/client/requests/AsyncHoverRequest.js +1 -1
  47. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +1 -1
  48. package/dist/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +1 -1
  49. package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +1 -1
  50. package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +1 -1
  51. package/dist/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.d.ts +1 -1
  52. package/dist/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.js +1 -1
  53. package/dist/serialization/resources/windows/client/requests/index.d.ts +2 -0
  54. package/dist/serialization/resources/windows/client/requests/index.js +5 -1
  55. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
  56. package/dist/serialization/types/CreateAutomationRequestBodyConfiguration.js +31 -0
  57. package/dist/serialization/types/index.d.ts +1 -0
  58. package/dist/serialization/types/index.js +1 -0
  59. package/dist/wrapper/AirtopWindows.d.ts +15 -3
  60. package/dist/wrapper/AirtopWindows.js +21 -2
  61. package/package.json +1 -1
  62. package/reference.md +181 -4
  63. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.d.ts +18 -0
  64. package/serialization/resources/windows/client/requests/AsyncCreateAutomationRequest.js +39 -0
  65. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.d.ts +18 -0
  66. package/serialization/resources/windows/client/requests/AsyncExecuteAutomationRequest.js +39 -0
  67. package/serialization/resources/windows/client/requests/AsyncHoverRequest.d.ts +1 -1
  68. package/serialization/resources/windows/client/requests/AsyncHoverRequest.js +1 -1
  69. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.d.ts +1 -1
  70. package/serialization/resources/windows/client/requests/AsyncPaginatedExtractionRequest.js +1 -1
  71. package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +1 -1
  72. package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +1 -1
  73. package/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.d.ts +1 -1
  74. package/serialization/resources/windows/client/requests/SessionPaginatedExtractionHandlerRequestBody.js +1 -1
  75. package/serialization/resources/windows/client/requests/index.d.ts +2 -0
  76. package/serialization/resources/windows/client/requests/index.js +5 -1
  77. package/serialization/types/CreateAutomationRequestBodyConfiguration.d.ts +10 -0
  78. package/serialization/types/CreateAutomationRequestBodyConfiguration.js +31 -0
  79. package/serialization/types/index.d.ts +1 -0
  80. package/serialization/types/index.js +1 -0
  81. package/wrapper/AirtopWindows.d.ts +15 -3
  82. package/wrapper/AirtopWindows.js +21 -2
package/api/resources/extensionConfigurations/client/Client.js CHANGED
@@ -78,8 +78,8 @@ class ExtensionConfigurations {
78
78
  Authorization: yield this._getAuthorizationHeader(),
79
79
  "X-Fern-Language": "JavaScript",
80
80
  "X-Fern-SDK-Name": "@airtop/sdk",
81
- "X-Fern-SDK-Version": "0.1.26-beta0",
82
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
81
+ "X-Fern-SDK-Version": "0.1.27-beta0",
82
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
83
83
  "X-Fern-Runtime": core.RUNTIME.type,
84
84
  "X-Fern-Runtime-Version": core.RUNTIME.version,
85
85
  },
@@ -137,8 +137,8 @@ class ExtensionConfigurations {
137
137
  Authorization: yield this._getAuthorizationHeader(),
138
138
  "X-Fern-Language": "JavaScript",
139
139
  "X-Fern-SDK-Name": "@airtop/sdk",
140
- "X-Fern-SDK-Version": "0.1.26-beta0",
141
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
140
+ "X-Fern-SDK-Version": "0.1.27-beta0",
141
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
142
142
  "X-Fern-Runtime": core.RUNTIME.type,
143
143
  "X-Fern-Runtime-Version": core.RUNTIME.version,
144
144
  },
package/api/resources/profiles/client/Client.js CHANGED
@@ -84,8 +84,8 @@ class Profiles {
84
84
  Authorization: yield this._getAuthorizationHeader(),
85
85
  "X-Fern-Language": "JavaScript",
86
86
  "X-Fern-SDK-Name": "@airtop/sdk",
87
- "X-Fern-SDK-Version": "0.1.26-beta0",
88
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
87
+ "X-Fern-SDK-Version": "0.1.27-beta0",
88
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
89
89
  "X-Fern-Runtime": core.RUNTIME.type,
90
90
  "X-Fern-Runtime-Version": core.RUNTIME.version,
91
91
  },
package/api/resources/requests/client/Client.js CHANGED
@@ -65,8 +65,8 @@ class Requests {
65
65
  Authorization: yield this._getAuthorizationHeader(),
66
66
  "X-Fern-Language": "JavaScript",
67
67
  "X-Fern-SDK-Name": "@airtop/sdk",
68
- "X-Fern-SDK-Version": "0.1.26-beta0",
69
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
68
+ "X-Fern-SDK-Version": "0.1.27-beta0",
69
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
70
70
  "X-Fern-Runtime": core.RUNTIME.type,
71
71
  "X-Fern-Runtime-Version": core.RUNTIME.version,
72
72
  },
package/api/resources/sessions/client/Client.js CHANGED
@@ -94,8 +94,8 @@ class Sessions {
94
94
  Authorization: yield this._getAuthorizationHeader(),
95
95
  "X-Fern-Language": "JavaScript",
96
96
  "X-Fern-SDK-Name": "@airtop/sdk",
97
- "X-Fern-SDK-Version": "0.1.26-beta0",
98
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
97
+ "X-Fern-SDK-Version": "0.1.27-beta0",
98
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
99
99
  "X-Fern-Runtime": core.RUNTIME.type,
100
100
  "X-Fern-Runtime-Version": core.RUNTIME.version,
101
101
  },
@@ -180,8 +180,8 @@ class Sessions {
180
180
  Authorization: yield this._getAuthorizationHeader(),
181
181
  "X-Fern-Language": "JavaScript",
182
182
  "X-Fern-SDK-Name": "@airtop/sdk",
183
- "X-Fern-SDK-Version": "0.1.26-beta0",
184
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
183
+ "X-Fern-SDK-Version": "0.1.27-beta0",
184
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
185
185
  "X-Fern-Runtime": core.RUNTIME.type,
186
186
  "X-Fern-Runtime-Version": core.RUNTIME.version,
187
187
  },
@@ -245,8 +245,8 @@ class Sessions {
245
245
  Authorization: yield this._getAuthorizationHeader(),
246
246
  "X-Fern-Language": "JavaScript",
247
247
  "X-Fern-SDK-Name": "@airtop/sdk",
248
- "X-Fern-SDK-Version": "0.1.26-beta0",
249
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
248
+ "X-Fern-SDK-Version": "0.1.27-beta0",
249
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
250
250
  "X-Fern-Runtime": core.RUNTIME.type,
251
251
  "X-Fern-Runtime-Version": core.RUNTIME.version,
252
252
  },
@@ -332,8 +332,8 @@ class Sessions {
332
332
  Authorization: yield this._getAuthorizationHeader(),
333
333
  "X-Fern-Language": "JavaScript",
334
334
  "X-Fern-SDK-Name": "@airtop/sdk",
335
- "X-Fern-SDK-Version": "0.1.26-beta0",
336
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
335
+ "X-Fern-SDK-Version": "0.1.27-beta0",
336
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
337
337
  "X-Fern-Runtime": core.RUNTIME.type,
338
338
  "X-Fern-Runtime-Version": core.RUNTIME.version,
339
339
  },
@@ -388,8 +388,8 @@ class Sessions {
388
388
  Authorization: yield this._getAuthorizationHeader(),
389
389
  "X-Fern-Language": "JavaScript",
390
390
  "X-Fern-SDK-Name": "@airtop/sdk",
391
- "X-Fern-SDK-Version": "0.1.26-beta0",
392
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
391
+ "X-Fern-SDK-Version": "0.1.27-beta0",
392
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
393
393
  "X-Fern-Runtime": core.RUNTIME.type,
394
394
  "X-Fern-Runtime-Version": core.RUNTIME.version,
395
395
  },
@@ -486,8 +486,8 @@ class Sessions {
486
486
  Authorization: yield this._getAuthorizationHeader(),
487
487
  "X-Fern-Language": "JavaScript",
488
488
  "X-Fern-SDK-Name": "@airtop/sdk",
489
- "X-Fern-SDK-Version": "0.1.26-beta0",
490
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
489
+ "X-Fern-SDK-Version": "0.1.27-beta0",
490
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
491
491
  "X-Fern-Runtime": core.RUNTIME.type,
492
492
  "X-Fern-Runtime-Version": core.RUNTIME.version,
493
493
  },
@@ -539,8 +539,8 @@ class Sessions {
539
539
  Authorization: yield this._getAuthorizationHeader(),
540
540
  "X-Fern-Language": "JavaScript",
541
541
  "X-Fern-SDK-Name": "@airtop/sdk",
542
- "X-Fern-SDK-Version": "0.1.26-beta0",
543
- "User-Agent": "@airtop/sdk/0.1.26-beta0",
542
+ "X-Fern-SDK-Version": "0.1.27-beta0",
543
+ "User-Agent": "@airtop/sdk/0.1.27-beta0",
544
544
  "X-Fern-Runtime": core.RUNTIME.type,
545
545
  "X-Fern-Runtime-Version": core.RUNTIME.version,
546
546
  },
package/api/resources/windows/client/Client.d.ts CHANGED
@@ -36,6 +36,32 @@ export declare class Windows {
36
36
  * })
37
37
  */
38
38
  asyncClick(sessionId: string, windowId: string, request: Airtop.AsyncClickRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
39
+ /**
40
+ * Create an automation of a browser window asynchronously
41
+ *
42
+ * @param {string} sessionId - The session id for the window.
43
+ * @param {string} windowId - The Airtop window id of the browser window.
44
+ * @param {Airtop.AsyncCreateAutomationRequest} request
45
+ * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
46
+ *
47
+ * @example
48
+ * await client.windows.asyncCreateAutomation("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
49
+ */
50
+ asyncCreateAutomation(sessionId: string, windowId: string, request?: Airtop.AsyncCreateAutomationRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
51
+ /**
52
+ * Execute an automation of a browser window asynchronously
53
+ *
54
+ * @param {string} sessionId - The session id for the window.
55
+ * @param {string} windowId - The Airtop window id of the browser window.
56
+ * @param {Airtop.AsyncExecuteAutomationRequest} request
57
+ * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
58
+ *
59
+ * @example
60
+ * await client.windows.asyncExecuteAutomation("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
61
+ * automationId: "automationId"
62
+ * })
63
+ */
64
+ asyncExecuteAutomation(sessionId: string, windowId: string, request: Airtop.AsyncExecuteAutomationRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
39
65
  /**
40
66
  * @param {string} sessionId - The session id for the window.
41
67
  * @param {string} windowId - The Airtop window id of the browser window.
@@ -43,9 +69,11 @@ export declare class Windows {
43
69
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
44
70
  *
45
71
  * @example
46
- * await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
72
+ * await client.windows.asyncHover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
73
+ * elementDescription: "The search box input in the top right corner"
74
+ * })
47
75
  */
48
- asyncHover(sessionId: string, windowId: string, request?: Airtop.AsyncHoverRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
76
+ asyncHover(sessionId: string, windowId: string, request: Airtop.AsyncHoverRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
49
77
  /**
50
78
  * @param {string} sessionId - The session id for the window.
51
79
  * @param {string} windowId - The Airtop window id of the browser window.
@@ -75,9 +103,11 @@ export declare class Windows {
75
103
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
76
104
  *
77
105
  * @example
78
- * await client.windows.asyncPaginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
106
+ * await client.windows.asyncPaginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
107
+ * 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."
108
+ * })
79
109
  */
80
- asyncPaginatedExtraction(sessionId: string, windowId: string, request?: Airtop.AsyncPaginatedExtractionRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
110
+ asyncPaginatedExtraction(sessionId: string, windowId: string, request: Airtop.AsyncPaginatedExtractionRequest, requestOptions?: Windows.RequestOptions): Promise<Airtop.AsyncSessionAiResponseEnvelope>;
81
111
  /**
82
112
  * This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
83
113
  *
@@ -201,9 +231,11 @@ export declare class Windows {
201
231
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
202
232
  *
203
233
  * @example
204
- * await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
234
+ * await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
235
+ * elementDescription: "The search box input in the top right corner"
236
+ * })
205
237
  */
206
- hover(sessionId: string, windowId: string, request?: Airtop.SessionHoverHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
238
+ hover(sessionId: string, windowId: string, request: Airtop.SessionHoverHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
207
239
  /**
208
240
  * @param {string} sessionId - The session id for the window.
209
241
  * @param {string} windowId - The Airtop window id of the browser window.
@@ -237,9 +269,11 @@ export declare class Windows {
237
269
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
238
270
  *
239
271
  * @example
240
- * await client.windows.paginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
272
+ * await client.windows.paginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
273
+ * 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."
274
+ * })
241
275
  */
242
- paginatedExtraction(sessionId: string, windowId: string, request?: Airtop.SessionPaginatedExtractionHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
276
+ paginatedExtraction(sessionId: string, windowId: string, request: Airtop.SessionPaginatedExtractionHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
243
277
  /**
244
278
  * This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
245
279
  *