@airtop/sdk 0.0.7-b → 0.0.7-c

package/Client.d.ts

@@ -5,11 +5,11 @@ import * as environments from "./environments";
 import * as core from "./core";
 import { Profiles } from "./api/resources/profiles/client/Client";
 import { Sessions } from "./api/resources/sessions/client/Client";
+import { Windows } from "./api/resources/windows/client/Client";
 export declare namespace AirtopClient {
     interface Options {
         environment?: core.Supplier<environments.AirtopEnvironment | string>;
-        /** Override the x-airtop-token header */
-        airtopToken?: core.Supplier<string | undefined>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -19,8 +19,6 @@ export declare namespace AirtopClient {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the x-airtop-token header */
-        airtopToken?: string | undefined;
     }
 }
 export declare class AirtopClient {
@@ -30,4 +28,6 @@ export declare class AirtopClient {
     get profiles(): Profiles;
     protected _sessions: Sessions | undefined;
     get sessions(): Sessions;
+    protected _windows: Windows | undefined;
+    get windows(): Windows;
 }

package/Client.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AirtopClient = void 0;
 const Client_1 = require("./api/resources/profiles/client/Client");
 const Client_2 = require("./api/resources/sessions/client/Client");
+const Client_3 = require("./api/resources/windows/client/Client");
 class AirtopClient {
     constructor(_options = {}) {
         this._options = _options;
@@ -18,5 +19,9 @@ class AirtopClient {
         var _a;
         return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_2.Sessions(this._options)));
     }
+    get windows() {
+        var _a;
+        return ((_a = this._windows) !== null && _a !== void 0 ? _a : (this._windows = new Client_3.Windows(this._options)));
+    }
 }
 exports.AirtopClient = AirtopClient;

package/README.md

@@ -18,7 +18,7 @@ Instantiate and use the client with the following:
 ```typescript
 import { AirtopClient } from "@airtop/sdk";
 
-const client = new AirtopClient({ airtopToken: "YOUR_AIRTOP_TOKEN" });
+const client = new AirtopClient({ apiKey: "YOUR_API_KEY" });
 await client.sessions.post();
 ```
 

package/api/errors/InternalServerError.d.ts

@@ -4,5 +4,5 @@
 import * as errors from "../../errors/index";
 import * as Airtop from "../index";
 export declare class InternalServerError extends errors.AirtopError {
-    constructor(body: Airtop.ErrorModel);
+    constructor(body: Airtop.ErrorEnvelope);
 }

package/api/errors/NotFoundError.d.ts

@@ -4,5 +4,5 @@
 import * as errors from "../../errors/index";
 import * as Airtop from "../index";
 export declare class NotFoundError extends errors.AirtopError {
-    constructor(body: Airtop.ErrorModel);
+    constructor(body: Airtop.ErrorEnvelope);
 }

package/api/errors/UnprocessableEntityError.d.ts

@@ -4,5 +4,5 @@
 import * as errors from "../../errors/index";
 import * as Airtop from "../index";
 export declare class UnprocessableEntityError extends errors.AirtopError {
-    constructor(body: Airtop.ErrorModel);
+    constructor(body: Airtop.ErrorEnvelope);
 }

package/api/resources/index.d.ts

@@ -1,5 +1,7 @@
 export * as sessions from "./sessions";
 export * from "./sessions/types";
 export * as profiles from "./profiles";
+export * as windows from "./windows";
 export * from "./profiles/client/requests";
 export * from "./sessions/client/requests";
+export * from "./windows/client/requests";

package/api/resources/index.js

@@ -26,9 +26,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.profiles = exports.sessions = void 0;
+exports.windows = exports.profiles = exports.sessions = void 0;
 exports.sessions = __importStar(require("./sessions"));
 __exportStar(require("./sessions/types"), exports);
 exports.profiles = __importStar(require("./profiles"));
+exports.windows = __importStar(require("./windows"));
 __exportStar(require("./profiles/client/requests"), exports);
 __exportStar(require("./sessions/client/requests"), exports);
+__exportStar(require("./windows/client/requests"), exports);

package/api/resources/profiles/client/Client.d.ts

@@ -7,8 +7,7 @@ import * as Airtop from "../../../index";
 export declare namespace Profiles {
     interface Options {
         environment?: core.Supplier<environments.AirtopEnvironment | string>;
-        /** Override the x-airtop-token header */
-        airtopToken?: core.Supplier<string | undefined>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -18,8 +17,6 @@ export declare namespace Profiles {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the x-airtop-token header */
-        airtopToken?: string | undefined;
     }
 }
 export declare class Profiles {
@@ -36,7 +33,7 @@ export declare class Profiles {
      *         name: "^Acme.*"
      *     })
      */
-    get(request?: Airtop.ProfilesGetRequest, requestOptions?: Profiles.RequestOptions): Promise<Airtop.ProfilesOutputV1Body>;
+    get(request?: Airtop.ProfilesGetRequest, requestOptions?: Profiles.RequestOptions): Promise<Airtop.ListProfileV1EnvelopeDefaultMetaWrapper>;
     /**
      * Delete profiles matching query
      *
@@ -62,5 +59,6 @@ export declare class Profiles {
      * @example
      *     await client.profiles.getById("4a61a55c-391b-4f73-957e-ffbd29ac7cba")
      */
-    getById(id: string, requestOptions?: Profiles.RequestOptions): Promise<Airtop.ProfileOutputV1Body>;
+    getById(id: string, requestOptions?: Profiles.RequestOptions): Promise<Airtop.ProfileV1EnvelopeDefaultMetaWrapper>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/api/resources/profiles/client/Client.js

@@ -80,13 +80,11 @@ class Profiles {
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, "profiles"),
                 method: "GET",
                 headers: {
-                    "x-airtop-token": (yield core.Supplier.get(this._options.airtopToken)) != null
-                        ? yield core.Supplier.get(this._options.airtopToken)
-                        : undefined,
+                    Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.7-b",
-                    "User-Agent": "@airtop/sdk/0.0.7-b",
+                    "X-Fern-SDK-Version": "0.0.7-c",
+                    "User-Agent": "@airtop/sdk/0.0.7-c",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -98,7 +96,7 @@ class Profiles {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return serializers.ProfilesOutputV1Body.parseOrThrow(_response.body, {
+                return serializers.ListProfileV1EnvelopeDefaultMetaWrapper.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -158,13 +156,11 @@ class Profiles {
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, "profiles"),
                 method: "DELETE",
                 headers: {
-                    "x-airtop-token": (yield core.Supplier.get(this._options.airtopToken)) != null
-                        ? yield core.Supplier.get(this._options.airtopToken)
-                        : undefined,
+                    Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.7-b",
-                    "User-Agent": "@airtop/sdk/0.0.7-b",
+                    "X-Fern-SDK-Version": "0.0.7-c",
+                    "User-Agent": "@airtop/sdk/0.0.7-c",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -219,13 +215,11 @@ class Profiles {
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, `profiles/${encodeURIComponent(id)}`),
                 method: "GET",
                 headers: {
-                    "x-airtop-token": (yield core.Supplier.get(this._options.airtopToken)) != null
-                        ? yield core.Supplier.get(this._options.airtopToken)
-                        : undefined,
+                    Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.0.7-b",
-                    "User-Agent": "@airtop/sdk/0.0.7-b",
+                    "X-Fern-SDK-Version": "0.0.7-c",
+                    "User-Agent": "@airtop/sdk/0.0.7-c",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -236,7 +230,7 @@ class Profiles {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return serializers.ProfileOutputV1Body.parseOrThrow(_response.body, {
+                return serializers.ProfileV1EnvelopeDefaultMetaWrapper.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -247,7 +241,7 @@ class Profiles {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 404:
-                        throw new Airtop.NotFoundError(serializers.ErrorModel.parseOrThrow(_response.error.body, {
+                        throw new Airtop.NotFoundError(serializers.ErrorEnvelope.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -255,7 +249,7 @@ class Profiles {
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 422:
-                        throw new Airtop.UnprocessableEntityError(serializers.ErrorModel.parseOrThrow(_response.error.body, {
+                        throw new Airtop.UnprocessableEntityError(serializers.ErrorEnvelope.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -263,7 +257,7 @@ class Profiles {
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new Airtop.InternalServerError(serializers.ErrorModel.parseOrThrow(_response.error.body, {
+                        throw new Airtop.InternalServerError(serializers.ErrorEnvelope.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -292,5 +286,14 @@ class Profiles {
             }
         });
     }
+    _getAuthorizationHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bearer = yield core.Supplier.get(this._options.apiKey);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
+        });
+    }
 }
 exports.Profiles = Profiles;

package/api/resources/sessions/client/Client.d.ts

@@ -7,8 +7,7 @@ import * as Airtop from "../../../index";
 export declare namespace Sessions {
     interface Options {
         environment?: core.Supplier<environments.AirtopEnvironment | string>;
-        /** Override the x-airtop-token header */
-        airtopToken?: core.Supplier<string | undefined>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -18,8 +17,6 @@ export declare namespace Sessions {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the x-airtop-token header */
-        airtopToken?: string | undefined;
     }
 }
 export declare class Sessions {
@@ -38,7 +35,7 @@ export declare class Sessions {
      * @example
      *     await client.sessions.list()
      */
-    list(request?: Airtop.SessionsListRequest, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionsOutputV1Body>;
+    list(request?: Airtop.SessionsListRequest, requestOptions?: Sessions.RequestOptions): Promise<Airtop.ListSessionWithConnectionInfoEnvelopeDefaultMetaWrapper>;
     /**
      * @param {Airtop.SessionRestInputV1} request
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
@@ -46,7 +43,7 @@ export declare class Sessions {
      * @example
      *     await client.sessions.post()
      */
-    post(request?: Airtop.SessionRestInputV1, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionOutputV1Body>;
+    post(request?: Airtop.SessionRestInputV1, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionWithConnectionInfoEnvelopeDefaultMetaWrapper>;
     /**
      * Get a session by ID
      *
@@ -58,72 +55,22 @@ export declare class Sessions {
      * @throws {@link Airtop.InternalServerError}
      *
      * @example
-     *     await client.sessions.get("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
+     *     await client.sessions.getinfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
      */
-    get(id: string, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionOutputV1Body>;
+    getinfo(id: string, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionWithConnectionInfoEnvelopeDefaultMetaWrapper>;
     /**
-     * Ends a session by ID
+     * Ends a session by ID. If a given session id does not exist within the organization, it is ignored.
      *
      * @param {string} id - UUID of the session to delete
      * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.sessions.delete("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
+     *     await client.sessions.terminate("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b")
      */
-    delete(id: string, requestOptions?: Sessions.RequestOptions): Promise<void>;
+    terminate(id: string, requestOptions?: Sessions.RequestOptions): Promise<void>;
     /**
      * Get a session event stream for a given session ID
      */
     events(id: string, requestOptions?: Sessions.RequestOptions): Promise<core.Stream<Airtop.SessionsEventsResponse>>;
-    /**
-     * @param {string} id - UUID of the session to create a url for
-     * @param {string} windowId - id of the browser window, either the browserId (uuid) or targetId (simple string)
-     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.sessions.window("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b0-42c5-6156-76a5eba87430")
-     */
-    window(id: string, windowId: string, requestOptions?: Sessions.RequestOptions): Promise<Airtop.LiveViewUrlOutputV1Body>;
-    /**
-     * @param {string} sessionId - The session id to scrape
-     * @param {string} windowId - The window id to scrape
-     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.sessions.cleanScrapeSession("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
-     */
-    cleanScrapeSession(sessionId: string, windowId: string, requestOptions?: Sessions.RequestOptions): Promise<Airtop.CleanScrapeResponse>;
-    /**
-     * @param {string} sessionId - The session id to submit a prompt about
-     * @param {string} windowId - The window id to submit a prompt about
-     * @param {Airtop.SessionPromptContentRequest} request
-     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.sessions.sessionPromptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-     *         prompt: "What is the main idea of this page?"
-     *     })
-     */
-    sessionPromptContent(sessionId: string, windowId: string, request: Airtop.SessionPromptContentRequest, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionAiResponse>;
-    /**
-     * @param {string} sessionId - The session id to perform a paginated extraction on
-     * @param {string} windowId - The window id to perform a paginated extraction on
-     * @param {Airtop.SessionPromptPaginatedExtractionRequest} request
-     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.sessions.sessionPromptPaginatedExtraction("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
-     *         prompt: "For each page on return all the items listed including a subfield"
-     *     })
-     */
-    sessionPromptPaginatedExtraction(sessionId: string, windowId: string, request: Airtop.SessionPromptPaginatedExtractionRequest, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionAiResponse>;
-    /**
-     * @param {string} sessionId - The session id to summarize
-     * @param {string} windowId - The window id to summarize
-     * @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.sessions.summary("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
-     */
-    summary(sessionId: string, windowId: string, requestOptions?: Sessions.RequestOptions): Promise<Airtop.SessionAiResponse>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }