@airtop/sdk 0.1.13 → 0.1.15-beta0

package/Client.d.ts

@@ -5,6 +5,7 @@ import * as environments from "./environments";
 import * as core from "./core";
 import { Windows } from "./api/resources/windows/client/Client";
 import { Profiles } from "./api/resources/profiles/client/Client";
+import { Requests } from "./api/resources/requests/client/Client";
 import { Sessions } from "./api/resources/sessions/client/Client";
 export declare namespace AirtopClient {
     interface Options {
@@ -28,6 +29,8 @@ export declare class AirtopClient {
     get windows(): Windows;
     protected _profiles: Profiles | undefined;
     get profiles(): Profiles;
+    protected _requests: Requests | undefined;
+    get requests(): Requests;
     protected _sessions: Sessions | undefined;
     get sessions(): Sessions;
 }

package/Client.js

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

package/README.md

@@ -19,7 +19,9 @@ Instantiate and use the client with the following:
 import { AirtopClient } from "@airtop/sdk";
 
 const client = new AirtopClient({ apiKey: "YOUR_API_KEY" });
-await client.windows.create("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
+await client.windows.asyncClick("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+    elementDescription: "The login button",
+});
 ```
 
 ## Request And Response Types
@@ -30,7 +32,7 @@ following namespace:
 ```typescript
 import { Airtop } from "@airtop/sdk";
 
-const request: Airtop.CreateWindowInputV1Body = {
+const request: Airtop.AsyncClickRequest = {
     ...
 };
 ```
@@ -44,7 +46,7 @@ will be thrown.
 import { AirtopError } from "@airtop/sdk";
 
 try {
-    await client.windows.create(...);
+    await client.windows.asyncClick(...);
 } catch (err) {
     if (err instanceof AirtopError) {
         console.log(err.statusCode);
@@ -71,7 +73,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.windows.create(..., {
+const response = await client.windows.asyncClick(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -81,7 +83,7 @@ const response = await client.windows.create(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.windows.create(..., {
+const response = await client.windows.asyncClick(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -92,7 +94,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.windows.create(..., {
+const response = await client.windows.asyncClick(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request

package/api/resources/index.d.ts

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

package/api/resources/index.js

@@ -26,12 +26,13 @@ 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 = exports.windows = void 0;
+exports.requests = exports.profiles = exports.sessions = exports.windows = void 0;
 exports.windows = __importStar(require("./windows"));
 __exportStar(require("./windows/types"), exports);
 exports.sessions = __importStar(require("./sessions"));
 __exportStar(require("./sessions/types"), exports);
 exports.profiles = __importStar(require("./profiles"));
+exports.requests = __importStar(require("./requests"));
 __exportStar(require("./windows/client/requests"), exports);
 __exportStar(require("./profiles/client/requests"), exports);
 __exportStar(require("./sessions/client/requests"), exports);

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

@@ -22,16 +22,6 @@ export declare namespace Profiles {
 export declare class Profiles {
     protected readonly _options: Profiles.Options;
     constructor(_options: Profiles.Options);
-    /**
-     * Get profiles matching by id
-     *
-     * @param {Airtop.ProfilesGetRequest} request
-     * @param {Profiles.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.profiles.get()
-     */
-    get(request?: Airtop.ProfilesGetRequest, requestOptions?: Profiles.RequestOptions): Promise<Airtop.ProfilesResponse>;
     /**
      * Delete profiles matching by id
      *

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

@@ -42,91 +42,11 @@ exports.Profiles = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
 class Profiles {
     constructor(_options) {
         this._options = _options;
     }
-    /**
-     * Get profiles matching by id
-     *
-     * @param {Airtop.ProfilesGetRequest} request
-     * @param {Profiles.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.profiles.get()
-     */
-    get(request = {}, requestOptions) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
-            const { profileIds, profileNames } = request;
-            const _queryParams = {};
-            if (profileIds != null) {
-                if (Array.isArray(profileIds)) {
-                    _queryParams["profileIds"] = profileIds.map((item) => item);
-                }
-                else {
-                    _queryParams["profileIds"] = profileIds;
-                }
-            }
-            if (profileNames != null) {
-                if (Array.isArray(profileNames)) {
-                    _queryParams["profileNames"] = profileNames.map((item) => item);
-                }
-                else {
-                    _queryParams["profileNames"] = profileNames;
-                }
-            }
-            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                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: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.13",
-                    "User-Agent": "@airtop/sdk/0.1.13",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
-                contentType: "application/json",
-                queryParameters: _queryParams,
-                requestType: "json",
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return serializers.ProfilesResponse.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    skipValidation: true,
-                    breadcrumbsPrefix: ["response"],
-                });
-            }
-            if (_response.error.reason === "status-code") {
-                throw new errors.AirtopError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                });
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.AirtopError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                    });
-                case "timeout":
-                    throw new errors.AirtopTimeoutError();
-                case "unknown":
-                    throw new errors.AirtopError({
-                        message: _response.error.errorMessage,
-                    });
-            }
-        });
-    }
     /**
      * Delete profiles matching by id
      *
@@ -164,8 +84,8 @@ class Profiles {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.13",
-                    "User-Agent": "@airtop/sdk/0.1.13",
+                    "X-Fern-SDK-Version": "0.1.16",
+                    "User-Agent": "@airtop/sdk/0.1.16",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/profiles/client/requests/index.d.ts

@@ -1,2 +1 @@
-export { type ProfilesGetRequest } from "./ProfilesGetRequest";
 export { type ProfilesDeleteRequest } from "./ProfilesDeleteRequest";

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

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Airtop from "../../../index";
+export declare namespace Requests {
+    interface Options {
+        environment?: core.Supplier<environments.AirtopEnvironment | string>;
+        apiKey: core.Supplier<core.BearerToken>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class Requests {
+    protected readonly _options: Requests.Options;
+    constructor(_options: Requests.Options);
+    /**
+     * @param {string} requestId - The ID of the request to check.
+     * @param {Requests.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000")
+     */
+    getRequestStatus(requestId: string, requestOptions?: Requests.RequestOptions): Promise<Airtop.RequestStatusResponse>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}

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

@@ -0,0 +1,115 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Requests = void 0;
+const environments = __importStar(require("../../../../environments"));
+const core = __importStar(require("../../../../core"));
+const url_join_1 = __importDefault(require("url-join"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const errors = __importStar(require("../../../../errors/index"));
+class Requests {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * @param {string} requestId - The ID of the request to check.
+     * @param {Requests.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.requests.getRequestStatus("123e4567-e89b-12d3-a456-426614174000")
+     */
+    getRequestStatus(requestId, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirtopEnvironment.Default, `requests/${encodeURIComponent(requestId)}/status`),
+                method: "GET",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@airtop/sdk",
+                    "X-Fern-SDK-Version": "0.1.16",
+                    "User-Agent": "@airtop/sdk/0.1.16",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                requestType: "json",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return serializers.RequestStatusResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.AirtopError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.AirtopError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.AirtopTimeoutError();
+                case "unknown":
+                    throw new errors.AirtopError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    _getAuthorizationHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return `Bearer ${yield core.Supplier.get(this._options.apiKey)}`;
+        });
+    }
+}
+exports.Requests = Requests;

package/api/resources/requests/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/api/resources/requests/client/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/requests/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/api/resources/requests/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./client"), exports);

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

@@ -94,8 +94,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.13",
-                    "User-Agent": "@airtop/sdk/0.1.13",
+                    "X-Fern-SDK-Version": "0.1.16",
+                    "User-Agent": "@airtop/sdk/0.1.16",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -180,8 +180,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.13",
-                    "User-Agent": "@airtop/sdk/0.1.13",
+                    "X-Fern-SDK-Version": "0.1.16",
+                    "User-Agent": "@airtop/sdk/0.1.16",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -245,8 +245,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.13",
-                    "User-Agent": "@airtop/sdk/0.1.13",
+                    "X-Fern-SDK-Version": "0.1.16",
+                    "User-Agent": "@airtop/sdk/0.1.16",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -332,8 +332,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.13",
-                    "User-Agent": "@airtop/sdk/0.1.13",
+                    "X-Fern-SDK-Version": "0.1.16",
+                    "User-Agent": "@airtop/sdk/0.1.16",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -388,8 +388,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.13",
-                    "User-Agent": "@airtop/sdk/0.1.13",
+                    "X-Fern-SDK-Version": "0.1.16",
+                    "User-Agent": "@airtop/sdk/0.1.16",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -486,8 +486,8 @@ class Sessions {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@airtop/sdk",
-                    "X-Fern-SDK-Version": "0.1.13",
-                    "User-Agent": "@airtop/sdk/0.1.13",
+                    "X-Fern-SDK-Version": "0.1.16",
+                    "User-Agent": "@airtop/sdk/0.1.16",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },