@airtop/sdk 0.1.6 → 0.1.7

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 (160) hide show
  1. package/Client.d.ts +3 -3
  2. package/Client.js +9 -9
  3. package/README.md +6 -6
  4. package/api/resources/index.d.ts +3 -3
  5. package/api/resources/index.js +4 -4
  6. package/api/resources/profiles/client/Client.js +4 -4
  7. package/api/resources/sessions/client/Client.js +10 -10
  8. package/api/resources/windows/client/Client.d.ts +3 -3
  9. package/api/resources/windows/client/Client.js +25 -25
  10. package/api/resources/windows/client/requests/CreateWindowInputV1Body.d.ts +1 -1
  11. package/api/resources/windows/client/requests/WindowLoadUrlV1Body.d.ts +1 -1
  12. package/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +3 -2
  13. package/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -0
  14. package/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +3 -2
  15. package/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -0
  16. package/api/types/ClickConfig.d.ts +5 -1
  17. package/api/types/Issue.d.ts +2 -0
  18. package/{dist/api/types/EmptyResponseJson.d.ts → api/types/OperationOutcome.d.ts} +1 -1
  19. package/api/types/{EmptyResponse.d.ts → OperationOutcomeResponse.d.ts} +3 -3
  20. package/api/types/PageQueryConfig.d.ts +3 -0
  21. package/api/types/SummaryConfig.d.ts +2 -0
  22. package/api/types/VisualAnalysisConfig.d.ts +12 -0
  23. package/api/types/VisualAnalysisConfigPartitionDirection.d.ts +12 -0
  24. package/api/types/VisualAnalysisConfigPartitionDirection.js +11 -0
  25. package/api/types/VisualAnalysisConfigScope.d.ts +11 -0
  26. package/api/types/VisualAnalysisConfigScope.js +10 -0
  27. package/api/types/index.d.ts +5 -4
  28. package/api/types/index.js +5 -4
  29. package/dist/Client.d.ts +3 -3
  30. package/dist/Client.js +9 -9
  31. package/dist/api/resources/index.d.ts +3 -3
  32. package/dist/api/resources/index.js +4 -4
  33. package/dist/api/resources/profiles/client/Client.js +4 -4
  34. package/dist/api/resources/sessions/client/Client.js +10 -10
  35. package/dist/api/resources/windows/client/Client.d.ts +3 -3
  36. package/dist/api/resources/windows/client/Client.js +25 -25
  37. package/dist/api/resources/windows/client/requests/CreateWindowInputV1Body.d.ts +1 -1
  38. package/dist/api/resources/windows/client/requests/WindowLoadUrlV1Body.d.ts +1 -1
  39. package/dist/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +3 -2
  40. package/dist/api/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -0
  41. package/dist/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +3 -2
  42. package/dist/api/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -0
  43. package/dist/api/types/ClickConfig.d.ts +5 -1
  44. package/dist/api/types/Issue.d.ts +2 -0
  45. package/{api/types/EmptyResponseJson.d.ts → dist/api/types/OperationOutcome.d.ts} +1 -1
  46. package/dist/api/types/{EmptyResponse.d.ts → OperationOutcomeResponse.d.ts} +3 -3
  47. package/dist/api/types/PageQueryConfig.d.ts +3 -0
  48. package/dist/api/types/SummaryConfig.d.ts +2 -0
  49. package/dist/api/types/VisualAnalysisConfig.d.ts +12 -0
  50. package/dist/api/types/VisualAnalysisConfigPartitionDirection.d.ts +12 -0
  51. package/dist/api/types/VisualAnalysisConfigPartitionDirection.js +11 -0
  52. package/dist/api/types/VisualAnalysisConfigScope.d.ts +11 -0
  53. package/dist/api/types/VisualAnalysisConfigScope.js +10 -0
  54. package/dist/api/types/index.d.ts +5 -4
  55. package/dist/api/types/index.js +5 -4
  56. package/dist/index.d.ts +1 -0
  57. package/dist/index.js +4 -0
  58. package/dist/serialization/resources/index.d.ts +3 -3
  59. package/dist/serialization/resources/index.js +4 -4
  60. package/dist/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +1 -1
  61. package/dist/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -1
  62. package/dist/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +1 -1
  63. package/dist/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -1
  64. package/dist/serialization/types/ClickConfig.d.ts +5 -2
  65. package/dist/serialization/types/ClickConfig.js +4 -1
  66. package/dist/serialization/types/Issue.d.ts +1 -0
  67. package/dist/serialization/types/Issue.js +1 -0
  68. package/{serialization/types/EmptyResponseJson.d.ts → dist/serialization/types/OperationOutcome.d.ts} +2 -2
  69. package/{serialization/types/EmptyResponseJson.js → dist/serialization/types/OperationOutcome.js} +2 -2
  70. package/dist/serialization/types/OperationOutcomeResponse.d.ts +18 -0
  71. package/dist/serialization/types/{EmptyResponse.js → OperationOutcomeResponse.js} +6 -6
  72. package/dist/serialization/types/PageQueryConfig.d.ts +2 -0
  73. package/dist/serialization/types/PageQueryConfig.js +2 -0
  74. package/dist/serialization/types/SummaryConfig.d.ts +2 -0
  75. package/dist/serialization/types/SummaryConfig.js +2 -0
  76. package/dist/serialization/types/VisualAnalysisConfig.d.ts +16 -0
  77. package/dist/serialization/types/{EnvelopeStatusDefaultMeta.js → VisualAnalysisConfig.js} +7 -5
  78. package/dist/serialization/types/VisualAnalysisConfigPartitionDirection.d.ts +10 -0
  79. package/dist/serialization/types/VisualAnalysisConfigPartitionDirection.js +31 -0
  80. package/dist/serialization/types/VisualAnalysisConfigScope.d.ts +10 -0
  81. package/dist/serialization/types/{EnvelopeStatusDefaultMetaStatus.js → VisualAnalysisConfigScope.js} +2 -2
  82. package/dist/serialization/types/index.d.ts +5 -4
  83. package/dist/serialization/types/index.js +5 -4
  84. package/dist/utils/batch-operate/SessionQueue.d.ts +46 -0
  85. package/dist/utils/batch-operate/SessionQueue.js +223 -0
  86. package/dist/utils/batch-operate/WindowQueue.d.ts +25 -0
  87. package/dist/utils/batch-operate/WindowQueue.js +201 -0
  88. package/dist/utils/batch-operate/batch-util.d.ts +3 -0
  89. package/dist/utils/batch-operate/batch-util.js +51 -0
  90. package/dist/utils/batch-operate/helpers.d.ts +2 -0
  91. package/dist/utils/batch-operate/helpers.js +19 -0
  92. package/dist/utils/batch-operate/types.d.ts +29 -0
  93. package/dist/utils/batch-operate/types.js +2 -0
  94. package/dist/utils/index.d.ts +2 -0
  95. package/dist/utils/index.js +18 -0
  96. package/dist/wrapper/AirtopClient.d.ts +3 -0
  97. package/dist/wrapper/AirtopClient.js +16 -0
  98. package/index.d.ts +1 -0
  99. package/index.js +4 -0
  100. package/package.json +3 -2
  101. package/reference.md +243 -243
  102. package/serialization/resources/index.d.ts +3 -3
  103. package/serialization/resources/index.js +4 -4
  104. package/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.d.ts +1 -1
  105. package/serialization/resources/windows/types/CreateWindowInputV1BodyWaitUntil.js +1 -1
  106. package/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.d.ts +1 -1
  107. package/serialization/resources/windows/types/WindowLoadUrlV1BodyWaitUntil.js +1 -1
  108. package/serialization/types/ClickConfig.d.ts +5 -2
  109. package/serialization/types/ClickConfig.js +4 -1
  110. package/serialization/types/Issue.d.ts +1 -0
  111. package/serialization/types/Issue.js +1 -0
  112. package/{dist/serialization/types/EmptyResponseJson.d.ts → serialization/types/OperationOutcome.d.ts} +2 -2
  113. package/{dist/serialization/types/EmptyResponseJson.js → serialization/types/OperationOutcome.js} +2 -2
  114. package/serialization/types/OperationOutcomeResponse.d.ts +18 -0
  115. package/serialization/types/{EmptyResponse.js → OperationOutcomeResponse.js} +6 -6
  116. package/serialization/types/PageQueryConfig.d.ts +2 -0
  117. package/serialization/types/PageQueryConfig.js +2 -0
  118. package/serialization/types/SummaryConfig.d.ts +2 -0
  119. package/serialization/types/SummaryConfig.js +2 -0
  120. package/serialization/types/VisualAnalysisConfig.d.ts +16 -0
  121. package/serialization/types/VisualAnalysisConfig.js +37 -0
  122. package/serialization/types/VisualAnalysisConfigPartitionDirection.d.ts +10 -0
  123. package/serialization/types/VisualAnalysisConfigPartitionDirection.js +31 -0
  124. package/serialization/types/VisualAnalysisConfigScope.d.ts +10 -0
  125. package/serialization/types/{EnvelopeStatusDefaultMetaStatus.js → VisualAnalysisConfigScope.js} +2 -2
  126. package/serialization/types/index.d.ts +5 -4
  127. package/serialization/types/index.js +5 -4
  128. package/utils/batch-operate/SessionQueue.d.ts +46 -0
  129. package/utils/batch-operate/SessionQueue.js +223 -0
  130. package/utils/batch-operate/WindowQueue.d.ts +25 -0
  131. package/utils/batch-operate/WindowQueue.js +201 -0
  132. package/utils/batch-operate/batch-util.d.ts +3 -0
  133. package/utils/batch-operate/batch-util.js +51 -0
  134. package/utils/batch-operate/helpers.d.ts +2 -0
  135. package/utils/batch-operate/helpers.js +19 -0
  136. package/utils/batch-operate/types.d.ts +29 -0
  137. package/utils/batch-operate/types.js +2 -0
  138. package/utils/index.d.ts +2 -0
  139. package/utils/index.js +18 -0
  140. package/wrapper/AirtopClient.d.ts +3 -0
  141. package/wrapper/AirtopClient.js +16 -0
  142. package/api/types/EnvelopeStatusDefaultMeta.d.ts +0 -8
  143. package/api/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -9
  144. package/api/types/EnvelopeStatusDefaultMetaStatus.js +0 -11
  145. package/dist/api/types/EnvelopeStatusDefaultMeta.d.ts +0 -8
  146. package/dist/api/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -9
  147. package/dist/api/types/EnvelopeStatusDefaultMetaStatus.js +0 -11
  148. package/dist/serialization/types/EmptyResponse.d.ts +0 -18
  149. package/dist/serialization/types/EnvelopeStatusDefaultMeta.d.ts +0 -14
  150. package/dist/serialization/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -10
  151. package/serialization/types/EmptyResponse.d.ts +0 -18
  152. package/serialization/types/EnvelopeStatusDefaultMeta.d.ts +0 -14
  153. package/serialization/types/EnvelopeStatusDefaultMeta.js +0 -35
  154. package/serialization/types/EnvelopeStatusDefaultMetaStatus.d.ts +0 -10
  155. /package/api/types/{EmptyResponse.js → OperationOutcome.js} +0 -0
  156. /package/api/types/{EmptyResponseJson.js → OperationOutcomeResponse.js} +0 -0
  157. /package/api/types/{EnvelopeStatusDefaultMeta.js → VisualAnalysisConfig.js} +0 -0
  158. /package/dist/api/types/{EmptyResponse.js → OperationOutcome.js} +0 -0
  159. /package/dist/api/types/{EmptyResponseJson.js → OperationOutcomeResponse.js} +0 -0
  160. /package/dist/api/types/{EnvelopeStatusDefaultMeta.js → VisualAnalysisConfig.js} +0 -0
package/Client.d.ts CHANGED
@@ -3,9 +3,9 @@
3
3
  */
4
4
  import * as environments from "./environments";
5
5
  import * as core from "./core";
6
+ import { Windows } from "./api/resources/windows/client/Client";
6
7
  import { Profiles } from "./api/resources/profiles/client/Client";
7
8
  import { Sessions } from "./api/resources/sessions/client/Client";
8
- import { Windows } from "./api/resources/windows/client/Client";
9
9
  export declare namespace AirtopClient {
10
10
  interface Options {
11
11
  environment?: core.Supplier<environments.AirtopEnvironment | string>;
@@ -24,10 +24,10 @@ export declare namespace AirtopClient {
24
24
  export declare class AirtopClient {
25
25
  protected readonly _options: AirtopClient.Options;
26
26
  constructor(_options: AirtopClient.Options);
27
+ protected _windows: Windows | undefined;
28
+ get windows(): Windows;
27
29
  protected _profiles: Profiles | undefined;
28
30
  get profiles(): Profiles;
29
31
  protected _sessions: Sessions | undefined;
30
32
  get sessions(): Sessions;
31
- protected _windows: Windows | undefined;
32
- get windows(): Windows;
33
33
  }
package/Client.js CHANGED
@@ -4,24 +4,24 @@
4
4
  */
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.AirtopClient = void 0;
7
- const Client_1 = require("./api/resources/profiles/client/Client");
8
- const Client_2 = require("./api/resources/sessions/client/Client");
9
- const Client_3 = require("./api/resources/windows/client/Client");
7
+ const Client_1 = require("./api/resources/windows/client/Client");
8
+ const Client_2 = require("./api/resources/profiles/client/Client");
9
+ const Client_3 = require("./api/resources/sessions/client/Client");
10
10
  class AirtopClient {
11
11
  constructor(_options) {
12
12
  this._options = _options;
13
13
  }
14
- get profiles() {
14
+ get windows() {
15
15
  var _a;
16
- return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new Client_1.Profiles(this._options)));
16
+ return ((_a = this._windows) !== null && _a !== void 0 ? _a : (this._windows = new Client_1.Windows(this._options)));
17
17
  }
18
- get sessions() {
18
+ get profiles() {
19
19
  var _a;
20
- return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_2.Sessions(this._options)));
20
+ return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new Client_2.Profiles(this._options)));
21
21
  }
22
- get windows() {
22
+ get sessions() {
23
23
  var _a;
24
- return ((_a = this._windows) !== null && _a !== void 0 ? _a : (this._windows = new Client_3.Windows(this._options)));
24
+ return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_3.Sessions(this._options)));
25
25
  }
26
26
  }
27
27
  exports.AirtopClient = AirtopClient;
package/README.md CHANGED
@@ -19,7 +19,7 @@ Instantiate and use the client with the following:
19
19
  import { AirtopClient } from "@airtop/sdk";
20
20
 
21
21
  const client = new AirtopClient({ apiKey: "YOUR_API_KEY" });
22
- await client.sessions.create();
22
+ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
23
23
  ```
24
24
 
25
25
  ## Request And Response Types
@@ -30,7 +30,7 @@ following namespace:
30
30
  ```typescript
31
31
  import { Airtop } from "@airtop/sdk";
32
32
 
33
- const request: Airtop.ProfilesGetRequest = {
33
+ const request: Airtop.CreateWindowInputV1Body = {
34
34
  ...
35
35
  };
36
36
  ```
@@ -44,7 +44,7 @@ will be thrown.
44
44
  import { AirtopError } from "@airtop/sdk";
45
45
 
46
46
  try {
47
- await client.sessions.create(...);
47
+ await client.windows.create(...);
48
48
  } catch (err) {
49
49
  if (err instanceof AirtopError) {
50
50
  console.log(err.statusCode);
@@ -71,7 +71,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
71
71
  Use the `maxRetries` request option to configure this behavior.
72
72
 
73
73
  ```typescript
74
- const response = await client.sessions.create(..., {
74
+ const response = await client.windows.create(..., {
75
75
  maxRetries: 0 // override maxRetries at the request level
76
76
  });
77
77
  ```
@@ -81,7 +81,7 @@ const response = await client.sessions.create(..., {
81
81
  The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
82
82
 
83
83
  ```typescript
84
- const response = await client.sessions.create(..., {
84
+ const response = await client.windows.create(..., {
85
85
  timeoutInSeconds: 30 // override timeout to 30s
86
86
  });
87
87
  ```
@@ -92,7 +92,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
92
92
 
93
93
  ```typescript
94
94
  const controller = new AbortController();
95
- const response = await client.sessions.create(..., {
95
+ const response = await client.windows.create(..., {
96
96
  abortSignal: controller.signal
97
97
  });
98
98
  controller.abort(); // aborts the request
@@ -1,8 +1,8 @@
1
- export * as sessions from "./sessions";
2
- export * from "./sessions/types";
3
1
  export * as windows from "./windows";
4
2
  export * from "./windows/types";
3
+ export * as sessions from "./sessions";
4
+ export * from "./sessions/types";
5
5
  export * as profiles from "./profiles";
6
+ export * from "./windows/client/requests";
6
7
  export * from "./profiles/client/requests";
7
8
  export * from "./sessions/client/requests";
8
- export * from "./windows/client/requests";
@@ -26,12 +26,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
26
26
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.profiles = exports.windows = exports.sessions = void 0;
30
- exports.sessions = __importStar(require("./sessions"));
31
- __exportStar(require("./sessions/types"), exports);
29
+ exports.profiles = exports.sessions = exports.windows = void 0;
32
30
  exports.windows = __importStar(require("./windows"));
33
31
  __exportStar(require("./windows/types"), exports);
32
+ exports.sessions = __importStar(require("./sessions"));
33
+ __exportStar(require("./sessions/types"), exports);
34
34
  exports.profiles = __importStar(require("./profiles"));
35
+ __exportStar(require("./windows/client/requests"), exports);
35
36
  __exportStar(require("./profiles/client/requests"), exports);
36
37
  __exportStar(require("./sessions/client/requests"), exports);
37
- __exportStar(require("./windows/client/requests"), exports);
@@ -77,8 +77,8 @@ class Profiles {
77
77
  Authorization: yield this._getAuthorizationHeader(),
78
78
  "X-Fern-Language": "JavaScript",
79
79
  "X-Fern-SDK-Name": "@airtop/sdk",
80
- "X-Fern-SDK-Version": "0.1.6",
81
- "User-Agent": "@airtop/sdk/0.1.6",
80
+ "X-Fern-SDK-Version": "0.1.7",
81
+ "User-Agent": "@airtop/sdk/0.1.7",
82
82
  "X-Fern-Runtime": core.RUNTIME.type,
83
83
  "X-Fern-Runtime-Version": core.RUNTIME.version,
84
84
  },
@@ -148,8 +148,8 @@ class Profiles {
148
148
  Authorization: yield this._getAuthorizationHeader(),
149
149
  "X-Fern-Language": "JavaScript",
150
150
  "X-Fern-SDK-Name": "@airtop/sdk",
151
- "X-Fern-SDK-Version": "0.1.6",
152
- "User-Agent": "@airtop/sdk/0.1.6",
151
+ "X-Fern-SDK-Version": "0.1.7",
152
+ "User-Agent": "@airtop/sdk/0.1.7",
153
153
  "X-Fern-Runtime": core.RUNTIME.type,
154
154
  "X-Fern-Runtime-Version": core.RUNTIME.version,
155
155
  },
@@ -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.6",
98
- "User-Agent": "@airtop/sdk/0.1.6",
97
+ "X-Fern-SDK-Version": "0.1.7",
98
+ "User-Agent": "@airtop/sdk/0.1.7",
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.6",
184
- "User-Agent": "@airtop/sdk/0.1.6",
183
+ "X-Fern-SDK-Version": "0.1.7",
184
+ "User-Agent": "@airtop/sdk/0.1.7",
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.6",
249
- "User-Agent": "@airtop/sdk/0.1.6",
248
+ "X-Fern-SDK-Version": "0.1.7",
249
+ "User-Agent": "@airtop/sdk/0.1.7",
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.6",
336
- "User-Agent": "@airtop/sdk/0.1.6",
335
+ "X-Fern-SDK-Version": "0.1.7",
336
+ "User-Agent": "@airtop/sdk/0.1.7",
337
337
  "X-Fern-Runtime": core.RUNTIME.type,
338
338
  "X-Fern-Runtime-Version": core.RUNTIME.version,
339
339
  },
@@ -380,8 +380,8 @@ class Sessions {
380
380
  Authorization: yield this._getAuthorizationHeader(),
381
381
  "X-Fern-Language": "JavaScript",
382
382
  "X-Fern-SDK-Name": "@airtop/sdk",
383
- "X-Fern-SDK-Version": "0.1.6",
384
- "User-Agent": "@airtop/sdk/0.1.6",
383
+ "X-Fern-SDK-Version": "0.1.7",
384
+ "User-Agent": "@airtop/sdk/0.1.7",
385
385
  "X-Fern-Runtime": core.RUNTIME.type,
386
386
  "X-Fern-Runtime-Version": core.RUNTIME.version,
387
387
  },
@@ -54,7 +54,7 @@ export declare class Windows {
54
54
  * url: "https://www.airtop.ai"
55
55
  * })
56
56
  */
57
- loadUrl(sessionId: string, windowId: string, request: Airtop.WindowLoadUrlV1Body, requestOptions?: Windows.RequestOptions): Promise<Airtop.EmptyResponse>;
57
+ loadUrl(sessionId: string, windowId: string, request: Airtop.WindowLoadUrlV1Body, requestOptions?: Windows.RequestOptions): Promise<Airtop.OperationOutcomeResponse>;
58
58
  /**
59
59
  * @param {string} sessionId - ID of the session that owns the window.
60
60
  * @param {string} windowId - Airtop window ID of the browser window.
@@ -88,7 +88,7 @@ export declare class Windows {
88
88
  hover(sessionId: string, windowId: string, request?: Airtop.SessionHoverHandlerRequestBody, requestOptions?: Windows.RequestOptions): Promise<Airtop.AiPromptResponse>;
89
89
  /**
90
90
  * @param {string} sessionId - The session id for the window.
91
- * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
91
+ * @param {string} windowId - The Airtop window id of the browser window.
92
92
  * @param {Airtop.SessionPageQueryHandlerRequestBody} request
93
93
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
94
94
  *
@@ -102,7 +102,7 @@ export declare class Windows {
102
102
  * This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
103
103
  *
104
104
  * @param {string} sessionId - The session id for the window.
105
- * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
105
+ * @param {string} windowId - The Airtop window id of the browser window.
106
106
  * @param {Airtop.SessionPageQueryHandlerRequestBody} request
107
107
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
108
108
  *
@@ -66,8 +66,8 @@ class Windows {
66
66
  Authorization: yield this._getAuthorizationHeader(),
67
67
  "X-Fern-Language": "JavaScript",
68
68
  "X-Fern-SDK-Name": "@airtop/sdk",
69
- "X-Fern-SDK-Version": "0.1.6",
70
- "User-Agent": "@airtop/sdk/0.1.6",
69
+ "X-Fern-SDK-Version": "0.1.7",
70
+ "User-Agent": "@airtop/sdk/0.1.7",
71
71
  "X-Fern-Runtime": core.RUNTIME.type,
72
72
  "X-Fern-Runtime-Version": core.RUNTIME.version,
73
73
  },
@@ -140,8 +140,8 @@ class Windows {
140
140
  Authorization: yield this._getAuthorizationHeader(),
141
141
  "X-Fern-Language": "JavaScript",
142
142
  "X-Fern-SDK-Name": "@airtop/sdk",
143
- "X-Fern-SDK-Version": "0.1.6",
144
- "User-Agent": "@airtop/sdk/0.1.6",
143
+ "X-Fern-SDK-Version": "0.1.7",
144
+ "User-Agent": "@airtop/sdk/0.1.7",
145
145
  "X-Fern-Runtime": core.RUNTIME.type,
146
146
  "X-Fern-Runtime-Version": core.RUNTIME.version,
147
147
  },
@@ -203,8 +203,8 @@ class Windows {
203
203
  Authorization: yield this._getAuthorizationHeader(),
204
204
  "X-Fern-Language": "JavaScript",
205
205
  "X-Fern-SDK-Name": "@airtop/sdk",
206
- "X-Fern-SDK-Version": "0.1.6",
207
- "User-Agent": "@airtop/sdk/0.1.6",
206
+ "X-Fern-SDK-Version": "0.1.7",
207
+ "User-Agent": "@airtop/sdk/0.1.7",
208
208
  "X-Fern-Runtime": core.RUNTIME.type,
209
209
  "X-Fern-Runtime-Version": core.RUNTIME.version,
210
210
  },
@@ -216,7 +216,7 @@ class Windows {
216
216
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
217
217
  });
218
218
  if (_response.ok) {
219
- return serializers.EmptyResponse.parseOrThrow(_response.body, {
219
+ return serializers.OperationOutcomeResponse.parseOrThrow(_response.body, {
220
220
  unrecognizedObjectKeys: "passthrough",
221
221
  allowUnrecognizedUnionMembers: true,
222
222
  allowUnrecognizedEnumValues: true,
@@ -263,8 +263,8 @@ class Windows {
263
263
  Authorization: yield this._getAuthorizationHeader(),
264
264
  "X-Fern-Language": "JavaScript",
265
265
  "X-Fern-SDK-Name": "@airtop/sdk",
266
- "X-Fern-SDK-Version": "0.1.6",
267
- "User-Agent": "@airtop/sdk/0.1.6",
266
+ "X-Fern-SDK-Version": "0.1.7",
267
+ "User-Agent": "@airtop/sdk/0.1.7",
268
268
  "X-Fern-Runtime": core.RUNTIME.type,
269
269
  "X-Fern-Runtime-Version": core.RUNTIME.version,
270
270
  },
@@ -325,8 +325,8 @@ class Windows {
325
325
  Authorization: yield this._getAuthorizationHeader(),
326
326
  "X-Fern-Language": "JavaScript",
327
327
  "X-Fern-SDK-Name": "@airtop/sdk",
328
- "X-Fern-SDK-Version": "0.1.6",
329
- "User-Agent": "@airtop/sdk/0.1.6",
328
+ "X-Fern-SDK-Version": "0.1.7",
329
+ "User-Agent": "@airtop/sdk/0.1.7",
330
330
  "X-Fern-Runtime": core.RUNTIME.type,
331
331
  "X-Fern-Runtime-Version": core.RUNTIME.version,
332
332
  },
@@ -386,8 +386,8 @@ class Windows {
386
386
  Authorization: yield this._getAuthorizationHeader(),
387
387
  "X-Fern-Language": "JavaScript",
388
388
  "X-Fern-SDK-Name": "@airtop/sdk",
389
- "X-Fern-SDK-Version": "0.1.6",
390
- "User-Agent": "@airtop/sdk/0.1.6",
389
+ "X-Fern-SDK-Version": "0.1.7",
390
+ "User-Agent": "@airtop/sdk/0.1.7",
391
391
  "X-Fern-Runtime": core.RUNTIME.type,
392
392
  "X-Fern-Runtime-Version": core.RUNTIME.version,
393
393
  },
@@ -430,7 +430,7 @@ class Windows {
430
430
  }
431
431
  /**
432
432
  * @param {string} sessionId - The session id for the window.
433
- * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
433
+ * @param {string} windowId - The Airtop window id of the browser window.
434
434
  * @param {Airtop.SessionPageQueryHandlerRequestBody} request
435
435
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
436
436
  *
@@ -449,8 +449,8 @@ class Windows {
449
449
  Authorization: yield this._getAuthorizationHeader(),
450
450
  "X-Fern-Language": "JavaScript",
451
451
  "X-Fern-SDK-Name": "@airtop/sdk",
452
- "X-Fern-SDK-Version": "0.1.6",
453
- "User-Agent": "@airtop/sdk/0.1.6",
452
+ "X-Fern-SDK-Version": "0.1.7",
453
+ "User-Agent": "@airtop/sdk/0.1.7",
454
454
  "X-Fern-Runtime": core.RUNTIME.type,
455
455
  "X-Fern-Runtime-Version": core.RUNTIME.version,
456
456
  },
@@ -497,7 +497,7 @@ class Windows {
497
497
  * This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
498
498
  *
499
499
  * @param {string} sessionId - The session id for the window.
500
- * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
500
+ * @param {string} windowId - The Airtop window id of the browser window.
501
501
  * @param {Airtop.SessionPageQueryHandlerRequestBody} request
502
502
  * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
503
503
  *
@@ -516,8 +516,8 @@ class Windows {
516
516
  Authorization: yield this._getAuthorizationHeader(),
517
517
  "X-Fern-Language": "JavaScript",
518
518
  "X-Fern-SDK-Name": "@airtop/sdk",
519
- "X-Fern-SDK-Version": "0.1.6",
520
- "User-Agent": "@airtop/sdk/0.1.6",
519
+ "X-Fern-SDK-Version": "0.1.7",
520
+ "User-Agent": "@airtop/sdk/0.1.7",
521
521
  "X-Fern-Runtime": core.RUNTIME.type,
522
522
  "X-Fern-Runtime-Version": core.RUNTIME.version,
523
523
  },
@@ -579,8 +579,8 @@ class Windows {
579
579
  Authorization: yield this._getAuthorizationHeader(),
580
580
  "X-Fern-Language": "JavaScript",
581
581
  "X-Fern-SDK-Name": "@airtop/sdk",
582
- "X-Fern-SDK-Version": "0.1.6",
583
- "User-Agent": "@airtop/sdk/0.1.6",
582
+ "X-Fern-SDK-Version": "0.1.7",
583
+ "User-Agent": "@airtop/sdk/0.1.7",
584
584
  "X-Fern-Runtime": core.RUNTIME.type,
585
585
  "X-Fern-Runtime-Version": core.RUNTIME.version,
586
586
  },
@@ -642,8 +642,8 @@ class Windows {
642
642
  Authorization: yield this._getAuthorizationHeader(),
643
643
  "X-Fern-Language": "JavaScript",
644
644
  "X-Fern-SDK-Name": "@airtop/sdk",
645
- "X-Fern-SDK-Version": "0.1.6",
646
- "User-Agent": "@airtop/sdk/0.1.6",
645
+ "X-Fern-SDK-Version": "0.1.7",
646
+ "User-Agent": "@airtop/sdk/0.1.7",
647
647
  "X-Fern-Runtime": core.RUNTIME.type,
648
648
  "X-Fern-Runtime-Version": core.RUNTIME.version,
649
649
  },
@@ -707,8 +707,8 @@ class Windows {
707
707
  Authorization: yield this._getAuthorizationHeader(),
708
708
  "X-Fern-Language": "JavaScript",
709
709
  "X-Fern-SDK-Name": "@airtop/sdk",
710
- "X-Fern-SDK-Version": "0.1.6",
711
- "User-Agent": "@airtop/sdk/0.1.6",
710
+ "X-Fern-SDK-Version": "0.1.7",
711
+ "User-Agent": "@airtop/sdk/0.1.7",
712
712
  "X-Fern-Runtime": core.RUNTIME.type,
713
713
  "X-Fern-Runtime-Version": core.RUNTIME.version,
714
714
  },
@@ -11,7 +11,7 @@ export interface CreateWindowInputV1Body {
11
11
  screenResolution?: string;
12
12
  /** Initial url to navigate to */
13
13
  url?: string;
14
- /** Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, and 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. */
14
+ /** Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. 'noWait' will not wait for any loading event and will return immediately. */
15
15
  waitUntil?: Airtop.CreateWindowInputV1BodyWaitUntil;
16
16
  /** Maximum time in seconds to wait for the specified loading event to occur before timing out. */
17
17
  waitUntilTimeoutSeconds?: number;
@@ -11,7 +11,7 @@ import * as Airtop from "../../../../index";
11
11
  export interface WindowLoadUrlV1Body {
12
12
  /** Url to navigate to */
13
13
  url: string;
14
- /** Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, and 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. */
14
+ /** Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. 'noWait' will not wait for any loading event and will return immediately. */
15
15
  waitUntil?: Airtop.WindowLoadUrlV1BodyWaitUntil;
16
16
  /** Maximum time in seconds to wait for the specified loading event to occur before timing out. */
17
17
  waitUntilTimeoutSeconds?: number;
@@ -2,11 +2,12 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  /**
5
- * Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, and 'complete' will wait until the page and all it's iframes have loaded it's dom and assets.
5
+ * Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. 'noWait' will not wait for any loading event and will return immediately.
6
6
  */
7
- export declare type CreateWindowInputV1BodyWaitUntil = "load" | "domContentLoaded" | "complete";
7
+ export declare type CreateWindowInputV1BodyWaitUntil = "load" | "domContentLoaded" | "complete" | "noWait";
8
8
  export declare const CreateWindowInputV1BodyWaitUntil: {
9
9
  readonly Load: "load";
10
10
  readonly DomContentLoaded: "domContentLoaded";
11
11
  readonly Complete: "complete";
12
+ readonly NoWait: "noWait";
12
13
  };
@@ -8,4 +8,5 @@ exports.CreateWindowInputV1BodyWaitUntil = {
8
8
  Load: "load",
9
9
  DomContentLoaded: "domContentLoaded",
10
10
  Complete: "complete",
11
+ NoWait: "noWait",
11
12
  };
@@ -2,11 +2,12 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  /**
5
- * Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, and 'complete' will wait until the page and all it's iframes have loaded it's dom and assets.
5
+ * Wait until the specified loading event occurs. Defaults to 'load', which waits until the page dom and it's assets have loaded. 'domContentLoaded' will wait until the dom has loaded, 'complete' will wait until the page and all it's iframes have loaded it's dom and assets. 'noWait' will not wait for any loading event and will return immediately.
6
6
  */
7
- export declare type WindowLoadUrlV1BodyWaitUntil = "load" | "domContentLoaded" | "complete";
7
+ export declare type WindowLoadUrlV1BodyWaitUntil = "load" | "domContentLoaded" | "complete" | "noWait";
8
8
  export declare const WindowLoadUrlV1BodyWaitUntil: {
9
9
  readonly Load: "load";
10
10
  readonly DomContentLoaded: "domContentLoaded";
11
11
  readonly Complete: "complete";
12
+ readonly NoWait: "noWait";
12
13
  };
@@ -8,4 +8,5 @@ exports.WindowLoadUrlV1BodyWaitUntil = {
8
8
  Load: "load",
9
9
  DomContentLoaded: "domContentLoaded",
10
10
  Complete: "complete",
11
+ NoWait: "noWait",
11
12
  };
@@ -1,4 +1,8 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export declare type ClickConfig = Record<string, unknown>;
4
+ import * as Airtop from "../index";
5
+ export interface ClickConfig {
6
+ /** Optional configuration for visual analysis when locating specified content. */
7
+ visualAnalysis?: Airtop.VisualAnalysisConfig;
8
+ }
@@ -8,4 +8,6 @@ export interface Issue {
8
8
  details?: Record<string, unknown>;
9
9
  /** Message describing the issue. */
10
10
  message: string;
11
+ /** Underlying reason for the issue. */
12
+ reason?: string;
11
13
  }
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export interface EmptyResponseJson {
4
+ export interface OperationOutcome {
5
5
  /** Indicates if the operations was successful */
6
6
  success: boolean;
7
7
  }
@@ -2,9 +2,9 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as Airtop from "../index";
5
- export interface EmptyResponse {
6
- data: Airtop.EmptyResponseJson;
5
+ export interface OperationOutcomeResponse {
6
+ data: Airtop.OperationOutcome;
7
7
  errors?: Airtop.Issue[];
8
- meta: Airtop.EnvelopeStatusDefaultMeta;
8
+ meta: Airtop.EnvelopeDefaultMeta;
9
9
  warnings?: Airtop.Issue[];
10
10
  }
@@ -1,7 +1,10 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ import * as Airtop from "../index";
4
5
  export interface PageQueryConfig {
6
+ /** Experimental configuration options. These may be subject to change and are not guaranteed to be stable across versions. */
7
+ experimental?: Airtop.PageQueryExperimentalConfig;
5
8
  /** JSON schema defining the structure of the output. If not provided, the format of the output might vary. */
6
9
  outputSchema?: string;
7
10
  }
@@ -1,7 +1,9 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ import * as Airtop from "../index";
4
5
  export interface SummaryConfig {
6
+ experimental?: Airtop.SummaryExperimentalConfig;
5
7
  /** JSON schema defining the structure of the output. If not provided, the format of the output might vary. */
6
8
  outputSchema?: string;
7
9
  }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Airtop from "../index";
5
+ export interface VisualAnalysisConfig {
6
+ /** The percentage of overlap between screenshot chunks. Defaults to 30 (percent). */
7
+ overlapPercentage?: number;
8
+ /** The direction to partition the screenshot into chunks: 'vertical', 'horizontal', or 'bidirectional'. Defaults to 'vertical', which is recommended for most web pages. For optimal results when partitioning in a single direction, ensure the perpendicular dimension does not exceed 1920 pixels. */
9
+ partitionDirection?: Airtop.VisualAnalysisConfigPartitionDirection;
10
+ /** Whether to analyze the current viewport or the whole page. Can be 'viewport' or 'page'. Defaults to 'page', which provides the simplest out-of-the-box experience for most web pages. Use 'viewport' for full control over the analyzed content. */
11
+ scope?: Airtop.VisualAnalysisConfigScope;
12
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * The direction to partition the screenshot into chunks: 'vertical', 'horizontal', or 'bidirectional'. Defaults to 'vertical', which is recommended for most web pages. For optimal results when partitioning in a single direction, ensure the perpendicular dimension does not exceed 1920 pixels.
6
+ */
7
+ export declare type VisualAnalysisConfigPartitionDirection = "vertical" | "horizontal" | "bidirectional";
8
+ export declare const VisualAnalysisConfigPartitionDirection: {
9
+ readonly Vertical: "vertical";
10
+ readonly Horizontal: "horizontal";
11
+ readonly Bidirectional: "bidirectional";
12
+ };
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.VisualAnalysisConfigPartitionDirection = void 0;
7
+ exports.VisualAnalysisConfigPartitionDirection = {
8
+ Vertical: "vertical",
9
+ Horizontal: "horizontal",
10
+ Bidirectional: "bidirectional",
11
+ };
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * Whether to analyze the current viewport or the whole page. Can be 'viewport' or 'page'. Defaults to 'page', which provides the simplest out-of-the-box experience for most web pages. Use 'viewport' for full control over the analyzed content.
6
+ */
7
+ export declare type VisualAnalysisConfigScope = "viewport" | "page";
8
+ export declare const VisualAnalysisConfigScope: {
9
+ readonly Viewport: "viewport";
10
+ readonly Page: "page";
11
+ };
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.VisualAnalysisConfigScope = void 0;
7
+ exports.VisualAnalysisConfigScope = {
8
+ Viewport: "viewport",
9
+ Page: "page",
10
+ };
@@ -2,11 +2,7 @@ export * from "./AiPromptResponse";
2
2
  export * from "./AiResponseEnvelope";
3
3
  export * from "./ClickConfig";
4
4
  export * from "./ClientProvidedResponseMetadata";
5
- export * from "./EmptyResponse";
6
- export * from "./EmptyResponseJson";
7
5
  export * from "./EnvelopeDefaultMeta";
8
- export * from "./EnvelopeStatusDefaultMetaStatus";
9
- export * from "./EnvelopeStatusDefaultMeta";
10
6
  export * from "./ErrorDetail";
11
7
  export * from "./ErrorMessage";
12
8
  export * from "./ErrorModel";
@@ -17,6 +13,8 @@ export * from "./ExternalSessionAiResponseMetadataUsage";
17
13
  export * from "./ExternalSessionConfig";
18
14
  export * from "./ExternalSessionWithConnectionInfo";
19
15
  export * from "./Issue";
16
+ export * from "./OperationOutcome";
17
+ export * from "./OperationOutcomeResponse";
20
18
  export * from "./PageQueryConfig";
21
19
  export * from "./PageQueryExperimentalConfig";
22
20
  export * from "./Pagination";
@@ -38,6 +36,9 @@ export * from "./StatusMessageStatus";
38
36
  export * from "./StatusMessage";
39
37
  export * from "./SummaryConfig";
40
38
  export * from "./SummaryExperimentalConfig";
39
+ export * from "./VisualAnalysisConfigPartitionDirection";
40
+ export * from "./VisualAnalysisConfigScope";
41
+ export * from "./VisualAnalysisConfig";
41
42
  export * from "./Window";
42
43
  export * from "./WindowId";
43
44
  export * from "./WindowIdResponse";