@airtop/sdk 0.1.13 → 0.1.14

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 (110) hide show
  1. package/api/resources/profiles/client/Client.d.ts +0 -10
  2. package/api/resources/profiles/client/Client.js +2 -82
  3. package/api/resources/profiles/client/requests/index.d.ts +0 -1
  4. package/api/resources/sessions/client/Client.js +12 -12
  5. package/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
  6. package/api/resources/sessions/types/index.d.ts +1 -1
  7. package/api/resources/sessions/types/index.js +1 -1
  8. package/api/resources/windows/client/Client.d.ts +32 -0
  9. package/api/resources/windows/client/Client.js +109 -24
  10. package/api/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +21 -0
  11. package/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +4 -0
  12. package/api/resources/windows/client/requests/index.d.ts +1 -0
  13. package/api/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
  14. package/api/types/ScreenshotConfig.d.ts +13 -0
  15. package/api/types/ScreenshotMetadata.d.ts +7 -0
  16. package/api/types/ScreenshotRequestConfig.d.ts +8 -0
  17. package/api/types/VisualAnalysisConfig.d.ts +5 -1
  18. package/api/types/VisualAnalysisConfigScope.d.ts +4 -2
  19. package/api/types/VisualAnalysisConfigScope.js +2 -0
  20. package/api/types/index.d.ts +3 -2
  21. package/api/types/index.js +3 -2
  22. package/dist/api/resources/profiles/client/Client.d.ts +0 -10
  23. package/dist/api/resources/profiles/client/Client.js +2 -82
  24. package/dist/api/resources/profiles/client/requests/index.d.ts +0 -1
  25. package/dist/api/resources/sessions/client/Client.js +12 -12
  26. package/dist/api/resources/sessions/types/SessionsEventsResponse.d.ts +4 -4
  27. package/dist/api/resources/sessions/types/index.d.ts +1 -1
  28. package/dist/api/resources/sessions/types/index.js +1 -1
  29. package/dist/api/resources/windows/client/Client.d.ts +32 -0
  30. package/dist/api/resources/windows/client/Client.js +109 -24
  31. package/dist/api/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +21 -0
  32. package/dist/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +4 -0
  33. package/dist/api/resources/windows/client/requests/index.d.ts +1 -0
  34. package/dist/api/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
  35. package/dist/api/types/ScreenshotConfig.d.ts +13 -0
  36. package/dist/api/types/ScreenshotMetadata.d.ts +7 -0
  37. package/dist/api/types/ScreenshotMetadata.js +5 -0
  38. package/dist/api/types/ScreenshotRequestConfig.d.ts +8 -0
  39. package/dist/api/types/ScreenshotRequestConfig.js +5 -0
  40. package/dist/api/types/VisualAnalysisConfig.d.ts +5 -1
  41. package/dist/api/types/VisualAnalysisConfigScope.d.ts +4 -2
  42. package/dist/api/types/VisualAnalysisConfigScope.js +2 -0
  43. package/dist/api/types/index.d.ts +3 -2
  44. package/dist/api/types/index.js +3 -2
  45. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
  46. package/dist/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
  47. package/dist/serialization/resources/sessions/types/index.d.ts +1 -1
  48. package/dist/serialization/resources/sessions/types/index.js +1 -1
  49. package/dist/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +16 -0
  50. package/dist/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +37 -0
  51. package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +2 -0
  52. package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +2 -0
  53. package/dist/serialization/resources/windows/client/requests/index.d.ts +1 -0
  54. package/dist/serialization/resources/windows/client/requests/index.js +3 -1
  55. package/dist/serialization/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
  56. package/dist/serialization/types/ExternalSessionAiResponseMetadata.js +2 -0
  57. package/dist/serialization/types/ScreenshotConfig.d.ts +15 -0
  58. package/dist/serialization/types/{ProfilesResponse.js → ScreenshotConfig.js} +6 -9
  59. package/dist/serialization/types/ScreenshotMetadata.d.ts +12 -0
  60. package/dist/serialization/types/{ExternalProfileV1.js → ScreenshotMetadata.js} +3 -5
  61. package/dist/serialization/types/ScreenshotRequestConfig.d.ts +13 -0
  62. package/{serialization/types/ExternalProfileV1.js → dist/serialization/types/ScreenshotRequestConfig.js} +4 -5
  63. package/dist/serialization/types/VisualAnalysisConfig.d.ts +2 -0
  64. package/dist/serialization/types/VisualAnalysisConfig.js +2 -0
  65. package/dist/serialization/types/VisualAnalysisConfigScope.d.ts +1 -1
  66. package/dist/serialization/types/VisualAnalysisConfigScope.js +1 -1
  67. package/dist/serialization/types/index.d.ts +3 -2
  68. package/dist/serialization/types/index.js +3 -2
  69. package/package.json +1 -1
  70. package/reference.md +184 -18
  71. package/serialization/resources/sessions/types/SessionsEventsResponse.d.ts +5 -5
  72. package/serialization/resources/sessions/types/SessionsEventsResponse.js +2 -2
  73. package/serialization/resources/sessions/types/index.d.ts +1 -1
  74. package/serialization/resources/sessions/types/index.js +1 -1
  75. package/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.d.ts +16 -0
  76. package/serialization/resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js +37 -0
  77. package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +2 -0
  78. package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +2 -0
  79. package/serialization/resources/windows/client/requests/index.d.ts +1 -0
  80. package/serialization/resources/windows/client/requests/index.js +3 -1
  81. package/serialization/types/ExternalSessionAiResponseMetadata.d.ts +2 -0
  82. package/serialization/types/ExternalSessionAiResponseMetadata.js +2 -0
  83. package/serialization/types/ScreenshotConfig.d.ts +15 -0
  84. package/serialization/types/{ProfilesResponse.js → ScreenshotConfig.js} +6 -9
  85. package/serialization/types/ScreenshotMetadata.d.ts +12 -0
  86. package/serialization/types/ScreenshotMetadata.js +33 -0
  87. package/serialization/types/ScreenshotRequestConfig.d.ts +13 -0
  88. package/serialization/types/ScreenshotRequestConfig.js +34 -0
  89. package/serialization/types/VisualAnalysisConfig.d.ts +2 -0
  90. package/serialization/types/VisualAnalysisConfig.js +2 -0
  91. package/serialization/types/VisualAnalysisConfigScope.d.ts +1 -1
  92. package/serialization/types/VisualAnalysisConfigScope.js +1 -1
  93. package/serialization/types/index.d.ts +3 -2
  94. package/serialization/types/index.js +3 -2
  95. package/api/resources/profiles/client/requests/ProfilesGetRequest.d.ts +0 -17
  96. package/api/types/ExternalProfileV1.d.ts +0 -11
  97. package/api/types/ProfilesResponse.d.ts +0 -10
  98. package/dist/api/resources/profiles/client/requests/ProfilesGetRequest.d.ts +0 -17
  99. package/dist/api/types/ExternalProfileV1.d.ts +0 -11
  100. package/dist/api/types/ProfilesResponse.d.ts +0 -10
  101. package/dist/serialization/types/ExternalProfileV1.d.ts +0 -14
  102. package/dist/serialization/types/ProfilesResponse.d.ts +0 -18
  103. package/serialization/types/ExternalProfileV1.d.ts +0 -14
  104. package/serialization/types/ProfilesResponse.d.ts +0 -18
  105. /package/api/resources/{profiles/client/requests/ProfilesGetRequest.js → windows/client/requests/SessionScreenshotHandlerRequestBody.js} +0 -0
  106. /package/api/types/{ExternalProfileV1.js → ScreenshotConfig.js} +0 -0
  107. /package/api/types/{ProfilesResponse.js → ScreenshotMetadata.js} +0 -0
  108. /package/{dist/api/resources/profiles/client/requests/ProfilesGetRequest.js → api/types/ScreenshotRequestConfig.js} +0 -0
  109. /package/dist/api/{types/ExternalProfileV1.js → resources/windows/client/requests/SessionScreenshotHandlerRequestBody.js} +0 -0
  110. /package/dist/api/types/{ProfilesResponse.js → ScreenshotConfig.js} +0 -0
@@ -4,5 +4,6 @@ export { SessionClickHandlerRequestBody } from "./SessionClickHandlerRequestBody
4
4
  export { SessionHoverHandlerRequestBody } from "./SessionHoverHandlerRequestBody";
5
5
  export { SessionPaginatedExtractionHandlerRequestBody } from "./SessionPaginatedExtractionHandlerRequestBody";
6
6
  export { ScrapeContentRequest } from "./ScrapeContentRequest";
7
+ export { SessionScreenshotHandlerRequestBody } from "./SessionScreenshotHandlerRequestBody";
7
8
  export { SessionSummaryHandlerRequestBody } from "./SessionSummaryHandlerRequestBody";
8
9
  export { SessionTypeHandlerRequestBody } from "./SessionTypeHandlerRequestBody";
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SessionTypeHandlerRequestBody = exports.SessionSummaryHandlerRequestBody = exports.ScrapeContentRequest = exports.SessionPaginatedExtractionHandlerRequestBody = exports.SessionHoverHandlerRequestBody = exports.SessionClickHandlerRequestBody = exports.WindowLoadUrlV1Body = exports.CreateWindowInputV1Body = void 0;
3
+ exports.SessionTypeHandlerRequestBody = exports.SessionSummaryHandlerRequestBody = exports.SessionScreenshotHandlerRequestBody = exports.ScrapeContentRequest = exports.SessionPaginatedExtractionHandlerRequestBody = exports.SessionHoverHandlerRequestBody = exports.SessionClickHandlerRequestBody = exports.WindowLoadUrlV1Body = exports.CreateWindowInputV1Body = void 0;
4
4
  var CreateWindowInputV1Body_1 = require("./CreateWindowInputV1Body");
5
5
  Object.defineProperty(exports, "CreateWindowInputV1Body", { enumerable: true, get: function () { return CreateWindowInputV1Body_1.CreateWindowInputV1Body; } });
6
6
  var WindowLoadUrlV1Body_1 = require("./WindowLoadUrlV1Body");
@@ -13,6 +13,8 @@ var SessionPaginatedExtractionHandlerRequestBody_1 = require("./SessionPaginated
13
13
  Object.defineProperty(exports, "SessionPaginatedExtractionHandlerRequestBody", { enumerable: true, get: function () { return SessionPaginatedExtractionHandlerRequestBody_1.SessionPaginatedExtractionHandlerRequestBody; } });
14
14
  var ScrapeContentRequest_1 = require("./ScrapeContentRequest");
15
15
  Object.defineProperty(exports, "ScrapeContentRequest", { enumerable: true, get: function () { return ScrapeContentRequest_1.ScrapeContentRequest; } });
16
+ var SessionScreenshotHandlerRequestBody_1 = require("./SessionScreenshotHandlerRequestBody");
17
+ Object.defineProperty(exports, "SessionScreenshotHandlerRequestBody", { enumerable: true, get: function () { return SessionScreenshotHandlerRequestBody_1.SessionScreenshotHandlerRequestBody; } });
16
18
  var SessionSummaryHandlerRequestBody_1 = require("./SessionSummaryHandlerRequestBody");
17
19
  Object.defineProperty(exports, "SessionSummaryHandlerRequestBody", { enumerable: true, get: function () { return SessionSummaryHandlerRequestBody_1.SessionSummaryHandlerRequestBody; } });
18
20
  var SessionTypeHandlerRequestBody_1 = require("./SessionTypeHandlerRequestBody");
@@ -5,6 +5,7 @@ import * as serializers from "../index";
5
5
  import * as Airtop from "../../api/index";
6
6
  import * as core from "../../core";
7
7
  import { ClientProvidedResponseMetadata } from "./ClientProvidedResponseMetadata";
8
+ import { ScreenshotMetadata } from "./ScreenshotMetadata";
8
9
  import { ExternalSessionAiResponseMetadataStatus } from "./ExternalSessionAiResponseMetadataStatus";
9
10
  import { ExternalSessionAiResponseMetadataUsage } from "./ExternalSessionAiResponseMetadataUsage";
10
11
  export declare const ExternalSessionAiResponseMetadata: core.serialization.ObjectSchema<serializers.ExternalSessionAiResponseMetadata.Raw, Airtop.ExternalSessionAiResponseMetadata>;
@@ -12,6 +13,7 @@ export declare namespace ExternalSessionAiResponseMetadata {
12
13
  interface Raw {
13
14
  clientProvided?: ClientProvidedResponseMetadata.Raw | null;
14
15
  requestId?: string | null;
16
+ screenshots?: ScreenshotMetadata.Raw[] | null;
15
17
  status: ExternalSessionAiResponseMetadataStatus.Raw;
16
18
  usage: ExternalSessionAiResponseMetadataUsage.Raw;
17
19
  }
@@ -29,11 +29,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
29
29
  exports.ExternalSessionAiResponseMetadata = void 0;
30
30
  const core = __importStar(require("../../core"));
31
31
  const ClientProvidedResponseMetadata_1 = require("./ClientProvidedResponseMetadata");
32
+ const ScreenshotMetadata_1 = require("./ScreenshotMetadata");
32
33
  const ExternalSessionAiResponseMetadataStatus_1 = require("./ExternalSessionAiResponseMetadataStatus");
33
34
  const ExternalSessionAiResponseMetadataUsage_1 = require("./ExternalSessionAiResponseMetadataUsage");
34
35
  exports.ExternalSessionAiResponseMetadata = core.serialization.object({
35
36
  clientProvided: ClientProvidedResponseMetadata_1.ClientProvidedResponseMetadata.optional(),
36
37
  requestId: core.serialization.string().optional(),
38
+ screenshots: core.serialization.list(ScreenshotMetadata_1.ScreenshotMetadata).optional(),
37
39
  status: ExternalSessionAiResponseMetadataStatus_1.ExternalSessionAiResponseMetadataStatus,
38
40
  usage: ExternalSessionAiResponseMetadataUsage_1.ExternalSessionAiResponseMetadataUsage,
39
41
  });
@@ -0,0 +1,15 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../index";
5
+ import * as Airtop from "../../api/index";
6
+ import * as core from "../../core";
7
+ export declare const ScreenshotConfig: core.serialization.ObjectSchema<serializers.ScreenshotConfig.Raw, Airtop.ScreenshotConfig>;
8
+ export declare namespace ScreenshotConfig {
9
+ interface Raw {
10
+ maxHeight?: number | null;
11
+ maxWidth?: number | null;
12
+ quality?: number | null;
13
+ scope?: "viewport" | null;
14
+ }
15
+ }
@@ -26,14 +26,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
26
26
  return result;
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.ProfilesResponse = void 0;
29
+ exports.ScreenshotConfig = void 0;
30
30
  const core = __importStar(require("../../core"));
31
- const ExternalProfileV1_1 = require("./ExternalProfileV1");
32
- const Issue_1 = require("./Issue");
33
- const EnvelopeDefaultMeta_1 = require("./EnvelopeDefaultMeta");
34
- exports.ProfilesResponse = core.serialization.object({
35
- data: core.serialization.list(ExternalProfileV1_1.ExternalProfileV1).optional(),
36
- errors: core.serialization.list(Issue_1.Issue).optional(),
37
- meta: EnvelopeDefaultMeta_1.EnvelopeDefaultMeta,
38
- warnings: core.serialization.list(Issue_1.Issue).optional(),
31
+ exports.ScreenshotConfig = core.serialization.object({
32
+ maxHeight: core.serialization.number().optional(),
33
+ maxWidth: core.serialization.number().optional(),
34
+ quality: core.serialization.number().optional(),
35
+ scope: core.serialization.stringLiteral("viewport").optional(),
39
36
  });
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../index";
5
+ import * as Airtop from "../../api/index";
6
+ import * as core from "../../core";
7
+ export declare const ScreenshotMetadata: core.serialization.ObjectSchema<serializers.ScreenshotMetadata.Raw, Airtop.ScreenshotMetadata>;
8
+ export declare namespace ScreenshotMetadata {
9
+ interface Raw {
10
+ dataUrl?: string | null;
11
+ }
12
+ }
@@ -26,10 +26,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
26
26
  return result;
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.ExternalProfileV1 = void 0;
29
+ exports.ScreenshotMetadata = void 0;
30
30
  const core = __importStar(require("../../core"));
31
- exports.ExternalProfileV1 = core.serialization.object({
32
- profileId: core.serialization.string(),
33
- profileName: core.serialization.string(),
34
- status: core.serialization.string().optional(),
31
+ exports.ScreenshotMetadata = core.serialization.object({
32
+ dataUrl: core.serialization.string().optional(),
35
33
  });
@@ -0,0 +1,13 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../index";
5
+ import * as Airtop from "../../api/index";
6
+ import * as core from "../../core";
7
+ import { ScreenshotConfig } from "./ScreenshotConfig";
8
+ export declare const ScreenshotRequestConfig: core.serialization.ObjectSchema<serializers.ScreenshotRequestConfig.Raw, Airtop.ScreenshotRequestConfig>;
9
+ export declare namespace ScreenshotRequestConfig {
10
+ interface Raw {
11
+ screenshot?: ScreenshotConfig.Raw | null;
12
+ }
13
+ }
@@ -26,10 +26,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
26
26
  return result;
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.ExternalProfileV1 = void 0;
29
+ exports.ScreenshotRequestConfig = void 0;
30
30
  const core = __importStar(require("../../core"));
31
- exports.ExternalProfileV1 = core.serialization.object({
32
- profileId: core.serialization.string(),
33
- profileName: core.serialization.string(),
34
- status: core.serialization.string().optional(),
31
+ const ScreenshotConfig_1 = require("./ScreenshotConfig");
32
+ exports.ScreenshotRequestConfig = core.serialization.object({
33
+ screenshot: ScreenshotConfig_1.ScreenshotConfig.optional(),
35
34
  });
@@ -9,8 +9,10 @@ import { VisualAnalysisConfigScope } from "./VisualAnalysisConfigScope";
9
9
  export declare const VisualAnalysisConfig: core.serialization.ObjectSchema<serializers.VisualAnalysisConfig.Raw, Airtop.VisualAnalysisConfig>;
10
10
  export declare namespace VisualAnalysisConfig {
11
11
  interface Raw {
12
+ maxScanScrolls?: number | null;
12
13
  overlapPercentage?: number | null;
13
14
  partitionDirection?: VisualAnalysisConfigPartitionDirection.Raw | null;
15
+ scanScrollDelay?: number | null;
14
16
  scope?: VisualAnalysisConfigScope.Raw | null;
15
17
  }
16
18
  }
@@ -31,7 +31,9 @@ const core = __importStar(require("../../core"));
31
31
  const VisualAnalysisConfigPartitionDirection_1 = require("./VisualAnalysisConfigPartitionDirection");
32
32
  const VisualAnalysisConfigScope_1 = require("./VisualAnalysisConfigScope");
33
33
  exports.VisualAnalysisConfig = core.serialization.object({
34
+ maxScanScrolls: core.serialization.number().optional(),
34
35
  overlapPercentage: core.serialization.number().optional(),
35
36
  partitionDirection: VisualAnalysisConfigPartitionDirection_1.VisualAnalysisConfigPartitionDirection.optional(),
37
+ scanScrollDelay: core.serialization.number().optional(),
36
38
  scope: VisualAnalysisConfigScope_1.VisualAnalysisConfigScope.optional(),
37
39
  });
@@ -6,5 +6,5 @@ import * as Airtop from "../../api/index";
6
6
  import * as core from "../../core";
7
7
  export declare const VisualAnalysisConfigScope: core.serialization.Schema<serializers.VisualAnalysisConfigScope.Raw, Airtop.VisualAnalysisConfigScope>;
8
8
  export declare namespace VisualAnalysisConfigScope {
9
- type Raw = "viewport" | "page";
9
+ type Raw = "viewport" | "page" | "scan" | "auto";
10
10
  }
@@ -28,4 +28,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
29
  exports.VisualAnalysisConfigScope = void 0;
30
30
  const core = __importStar(require("../../core"));
31
- exports.VisualAnalysisConfigScope = core.serialization.enum_(["viewport", "page"]);
31
+ exports.VisualAnalysisConfigScope = core.serialization.enum_(["viewport", "page", "scan", "auto"]);
@@ -10,7 +10,6 @@ export * from "./ErrorBody";
10
10
  export * from "./ErrorDetail";
11
11
  export * from "./ErrorMessage";
12
12
  export * from "./ErrorModel";
13
- export * from "./ExternalProfileV1";
14
13
  export * from "./ExternalSessionAiResponseMetadataStatus";
15
14
  export * from "./ExternalSessionAiResponseMetadata";
16
15
  export * from "./ExternalSessionAiResponseMetadataUsage";
@@ -24,11 +23,13 @@ export * from "./PageQueryConfig";
24
23
  export * from "./PageQueryExperimentalConfig";
25
24
  export * from "./PaginatedExtractionConfig";
26
25
  export * from "./Pagination";
27
- export * from "./ProfilesResponse";
28
26
  export * from "./ScrapeResponse";
29
27
  export * from "./ScrapeResponseContent";
30
28
  export * from "./ScrapeResponseEnvelope";
31
29
  export * from "./ScrapeResponseOutput";
30
+ export * from "./ScreenshotConfig";
31
+ export * from "./ScreenshotMetadata";
32
+ export * from "./ScreenshotRequestConfig";
32
33
  export * from "./Proxy";
33
34
  export * from "./CustomProxy";
34
35
  export * from "./SessionConfigV1ProxyItem";
@@ -26,7 +26,6 @@ __exportStar(require("./ErrorBody"), exports);
26
26
  __exportStar(require("./ErrorDetail"), exports);
27
27
  __exportStar(require("./ErrorMessage"), exports);
28
28
  __exportStar(require("./ErrorModel"), exports);
29
- __exportStar(require("./ExternalProfileV1"), exports);
30
29
  __exportStar(require("./ExternalSessionAiResponseMetadataStatus"), exports);
31
30
  __exportStar(require("./ExternalSessionAiResponseMetadata"), exports);
32
31
  __exportStar(require("./ExternalSessionAiResponseMetadataUsage"), exports);
@@ -40,11 +39,13 @@ __exportStar(require("./PageQueryConfig"), exports);
40
39
  __exportStar(require("./PageQueryExperimentalConfig"), exports);
41
40
  __exportStar(require("./PaginatedExtractionConfig"), exports);
42
41
  __exportStar(require("./Pagination"), exports);
43
- __exportStar(require("./ProfilesResponse"), exports);
44
42
  __exportStar(require("./ScrapeResponse"), exports);
45
43
  __exportStar(require("./ScrapeResponseContent"), exports);
46
44
  __exportStar(require("./ScrapeResponseEnvelope"), exports);
47
45
  __exportStar(require("./ScrapeResponseOutput"), exports);
46
+ __exportStar(require("./ScreenshotConfig"), exports);
47
+ __exportStar(require("./ScreenshotMetadata"), exports);
48
+ __exportStar(require("./ScreenshotRequestConfig"), exports);
48
49
  __exportStar(require("./Proxy"), exports);
49
50
  __exportStar(require("./CustomProxy"), exports);
50
51
  __exportStar(require("./SessionConfigV1ProxyItem"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@airtop/sdk",
3
- "version": "0.1.13",
3
+ "version": "0.1.14",
4
4
  "private": false,
5
5
  "repository": "https://github.com/airtop-ai/airtop-node-sdk",
6
6
  "main": "./index.js",
package/reference.md CHANGED
@@ -6,6 +6,21 @@
6
6
  <dl>
7
7
  <dd>
8
8
 
9
+ #### 📝 Description
10
+
11
+ <dl>
12
+ <dd>
13
+
14
+ <dl>
15
+ <dd>
16
+
17
+ Creates a new browser window in a session. Optionally, you can specify a url to load on the window upon creation.
18
+
19
+ </dd>
20
+ </dl>
21
+ </dd>
22
+ </dl>
23
+
9
24
  #### 🔌 Usage
10
25
 
11
26
  <dl>
@@ -62,6 +77,21 @@ await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
62
77
  <dl>
63
78
  <dd>
64
79
 
80
+ #### 📝 Description
81
+
82
+ <dl>
83
+ <dd>
84
+
85
+ <dl>
86
+ <dd>
87
+
88
+ Get information about a browser window in a session, including the live view url.
89
+
90
+ </dd>
91
+ </dl>
92
+ </dd>
93
+ </dl>
94
+
65
95
  #### 🔌 Usage
66
96
 
67
97
  <dl>
@@ -128,6 +158,21 @@ await client.windows.getWindowInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334
128
158
  <dl>
129
159
  <dd>
130
160
 
161
+ #### 📝 Description
162
+
163
+ <dl>
164
+ <dd>
165
+
166
+ <dl>
167
+ <dd>
168
+
169
+ Loads a specified url on a given window
170
+
171
+ </dd>
172
+ </dl>
173
+ </dd>
174
+ </dl>
175
+
131
176
  #### 🔌 Usage
132
177
 
133
178
  <dl>
@@ -194,6 +239,21 @@ await client.windows.loadUrl("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-9
194
239
  <dl>
195
240
  <dd>
196
241
 
242
+ #### 📝 Description
243
+
244
+ <dl>
245
+ <dd>
246
+
247
+ <dl>
248
+ <dd>
249
+
250
+ Closes a browser window in a session
251
+
252
+ </dd>
253
+ </dl>
254
+ </dd>
255
+ </dl>
256
+
197
257
  #### 🔌 Usage
198
258
 
199
259
  <dl>
@@ -250,6 +310,21 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
250
310
  <dl>
251
311
  <dd>
252
312
 
313
+ #### 📝 Description
314
+
315
+ <dl>
316
+ <dd>
317
+
318
+ <dl>
319
+ <dd>
320
+
321
+ Execute a click interaction in a specific browser window
322
+
323
+ </dd>
324
+ </dl>
325
+ </dd>
326
+ </dl>
327
+
253
328
  #### 🔌 Usage
254
329
 
255
330
  <dl>
@@ -316,6 +391,21 @@ await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
316
391
  <dl>
317
392
  <dd>
318
393
 
394
+ #### 📝 Description
395
+
396
+ <dl>
397
+ <dd>
398
+
399
+ <dl>
400
+ <dd>
401
+
402
+ Execute a hover interaction in a specific browser window
403
+
404
+ </dd>
405
+ </dl>
406
+ </dd>
407
+ </dl>
408
+
319
409
  #### 🔌 Usage
320
410
 
321
411
  <dl>
@@ -380,6 +470,21 @@ await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b
380
470
  <dl>
381
471
  <dd>
382
472
 
473
+ #### 📝 Description
474
+
475
+ <dl>
476
+ <dd>
477
+
478
+ <dl>
479
+ <dd>
480
+
481
+ 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?).
482
+
483
+ </dd>
484
+ </dl>
485
+ </dd>
486
+ </dl>
487
+
383
488
  #### 🔌 Usage
384
489
 
385
490
  <dl>
@@ -446,6 +551,21 @@ await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a
446
551
  <dl>
447
552
  <dd>
448
553
 
554
+ #### 📝 Description
555
+
556
+ <dl>
557
+ <dd>
558
+
559
+ <dl>
560
+ <dd>
561
+
562
+ Submit a prompt that queries the content of a specific browser window and paginates through pages to return a list of results.
563
+
564
+ </dd>
565
+ </dl>
566
+ </dd>
567
+ </dl>
568
+
449
569
  #### 🔌 Usage
450
570
 
451
571
  <dl>
@@ -594,6 +714,21 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
594
714
  <dl>
595
715
  <dd>
596
716
 
717
+ #### 📝 Description
718
+
719
+ <dl>
720
+ <dd>
721
+
722
+ <dl>
723
+ <dd>
724
+
725
+ Scrape a window and return the content as markdown
726
+
727
+ </dd>
728
+ </dl>
729
+ </dd>
730
+ </dl>
731
+
597
732
  #### 🔌 Usage
598
733
 
599
734
  <dl>
@@ -654,7 +789,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
654
789
  </dl>
655
790
  </details>
656
791
 
657
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
792
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">screenshot</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
658
793
  <dl>
659
794
  <dd>
660
795
 
@@ -666,7 +801,7 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
666
801
  <dl>
667
802
  <dd>
668
803
 
669
- This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
804
+ Take a screenshot of a browser window
670
805
 
671
806
  </dd>
672
807
  </dl>
@@ -682,7 +817,7 @@ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a s
682
817
  <dd>
683
818
 
684
819
  ```typescript
685
- await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
820
+ await client.windows.screenshot("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
686
821
  ```
687
822
 
688
823
  </dd>
@@ -706,7 +841,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
706
841
  <dl>
707
842
  <dd>
708
843
 
709
- **windowId:** `string` — The Airtop window id of the browser window to summarize.
844
+ **windowId:** `string` — The Airtop window id of the browser window.
710
845
 
711
846
  </dd>
712
847
  </dl>
@@ -714,7 +849,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
714
849
  <dl>
715
850
  <dd>
716
851
 
717
- **request:** `Airtop.SessionSummaryHandlerRequestBody`
852
+ **request:** `Airtop.SessionScreenshotHandlerRequestBody`
718
853
 
719
854
  </dd>
720
855
  </dl>
@@ -733,10 +868,25 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
733
868
  </dl>
734
869
  </details>
735
870
 
736
- <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
871
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">summarizeContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
872
+ <dl>
873
+ <dd>
874
+
875
+ #### 📝 Description
876
+
877
+ <dl>
878
+ <dd>
879
+
737
880
  <dl>
738
881
  <dd>
739
882
 
883
+ This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
884
+
885
+ </dd>
886
+ </dl>
887
+ </dd>
888
+ </dl>
889
+
740
890
  #### 🔌 Usage
741
891
 
742
892
  <dl>
@@ -746,9 +896,7 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
746
896
  <dd>
747
897
 
748
898
  ```typescript
749
- await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
750
- text: "Example text",
751
- });
899
+ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
752
900
  ```
753
901
 
754
902
  </dd>
@@ -772,7 +920,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
772
920
  <dl>
773
921
  <dd>
774
922
 
775
- **windowId:** `string` — The Airtop window id of the browser window.
923
+ **windowId:** `string` — The Airtop window id of the browser window to summarize.
776
924
 
777
925
  </dd>
778
926
  </dl>
@@ -780,7 +928,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
780
928
  <dl>
781
929
  <dd>
782
930
 
783
- **request:** `Airtop.SessionTypeHandlerRequestBody`
931
+ **request:** `Airtop.SessionSummaryHandlerRequestBody`
784
932
 
785
933
  </dd>
786
934
  </dl>
@@ -799,9 +947,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
799
947
  </dl>
800
948
  </details>
801
949
 
802
- ## Profiles
803
-
804
- <details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">get</a>({ ...params }) -> Airtop.ProfilesResponse</code></summary>
950
+ <details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
805
951
  <dl>
806
952
  <dd>
807
953
 
@@ -813,7 +959,7 @@ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0
813
959
  <dl>
814
960
  <dd>
815
961
 
816
- Get profiles matching by id
962
+ Execute a type interaction in a specific browser window
817
963
 
818
964
  </dd>
819
965
  </dl>
@@ -829,7 +975,9 @@ Get profiles matching by id
829
975
  <dd>
830
976
 
831
977
  ```typescript
832
- await client.profiles.get();
978
+ await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
979
+ text: "Example text",
980
+ });
833
981
  ```
834
982
 
835
983
  </dd>
@@ -845,7 +993,7 @@ await client.profiles.get();
845
993
  <dl>
846
994
  <dd>
847
995
 
848
- **request:** `Airtop.ProfilesGetRequest`
996
+ **sessionId:** `string` — The session id for the window.
849
997
 
850
998
  </dd>
851
999
  </dl>
@@ -853,7 +1001,23 @@ await client.profiles.get();
853
1001
  <dl>
854
1002
  <dd>
855
1003
 
856
- **requestOptions:** `Profiles.RequestOptions`
1004
+ **windowId:** `string` — The Airtop window id of the browser window.
1005
+
1006
+ </dd>
1007
+ </dl>
1008
+
1009
+ <dl>
1010
+ <dd>
1011
+
1012
+ **request:** `Airtop.SessionTypeHandlerRequestBody`
1013
+
1014
+ </dd>
1015
+ </dl>
1016
+
1017
+ <dl>
1018
+ <dd>
1019
+
1020
+ **requestOptions:** `Windows.RequestOptions`
857
1021
 
858
1022
  </dd>
859
1023
  </dl>
@@ -864,6 +1028,8 @@ await client.profiles.get();
864
1028
  </dl>
865
1029
  </details>
866
1030
 
1031
+ ## Profiles
1032
+
867
1033
  <details><summary><code>client.profiles.<a href="/src/api/resources/profiles/client/Client.ts">delete</a>({ ...params }) -> void</code></summary>
868
1034
  <dl>
869
1035
  <dd>
@@ -4,13 +4,16 @@
4
4
  import * as serializers from "../../../index";
5
5
  import * as Airtop from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
+ import { SessionsEventsResponseSessionEvent } from "./SessionsEventsResponseSessionEvent";
7
8
  import { SessionsEventsResponseStatus } from "./SessionsEventsResponseStatus";
8
9
  import { SessionsEventsResponseError } from "./SessionsEventsResponseError";
9
10
  import { SessionsEventsResponseWindowEvent } from "./SessionsEventsResponseWindowEvent";
10
- import { SessionsEventsResponseSessionEvent } from "./SessionsEventsResponseSessionEvent";
11
11
  export declare const SessionsEventsResponse: core.serialization.Schema<serializers.SessionsEventsResponse.Raw, Airtop.SessionsEventsResponse>;
12
12
  export declare namespace SessionsEventsResponse {
13
- type Raw = SessionsEventsResponse.Status | SessionsEventsResponse.Error | SessionsEventsResponse.WindowEvent | SessionsEventsResponse.SessionEvent;
13
+ type Raw = SessionsEventsResponse.SessionEvent | SessionsEventsResponse.Status | SessionsEventsResponse.Error | SessionsEventsResponse.WindowEvent;
14
+ interface SessionEvent extends SessionsEventsResponseSessionEvent.Raw {
15
+ event: "sessionEvent";
16
+ }
14
17
  interface Status extends SessionsEventsResponseStatus.Raw {
15
18
  event: "status";
16
19
  }
@@ -20,7 +23,4 @@ export declare namespace SessionsEventsResponse {
20
23
  interface WindowEvent extends SessionsEventsResponseWindowEvent.Raw {
21
24
  event: "windowEvent";
22
25
  }
23
- interface SessionEvent extends SessionsEventsResponseSessionEvent.Raw {
24
- event: "sessionEvent";
25
- }
26
26
  }
@@ -28,16 +28,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
29
  exports.SessionsEventsResponse = void 0;
30
30
  const core = __importStar(require("../../../../core"));
31
+ const SessionsEventsResponseSessionEvent_1 = require("./SessionsEventsResponseSessionEvent");
31
32
  const SessionsEventsResponseStatus_1 = require("./SessionsEventsResponseStatus");
32
33
  const SessionsEventsResponseError_1 = require("./SessionsEventsResponseError");
33
34
  const SessionsEventsResponseWindowEvent_1 = require("./SessionsEventsResponseWindowEvent");
34
- const SessionsEventsResponseSessionEvent_1 = require("./SessionsEventsResponseSessionEvent");
35
35
  exports.SessionsEventsResponse = core.serialization
36
36
  .union("event", {
37
+ sessionEvent: SessionsEventsResponseSessionEvent_1.SessionsEventsResponseSessionEvent,
37
38
  status: SessionsEventsResponseStatus_1.SessionsEventsResponseStatus,
38
39
  error: SessionsEventsResponseError_1.SessionsEventsResponseError,
39
40
  windowEvent: SessionsEventsResponseWindowEvent_1.SessionsEventsResponseWindowEvent,
40
- sessionEvent: SessionsEventsResponseSessionEvent_1.SessionsEventsResponseSessionEvent,
41
41
  })
42
42
  .transform({
43
43
  transform: (value) => value,