@airtop/sdk 0.1.31 → 0.1.33-beta0

package/Client.d.ts

@@ -4,6 +4,8 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import { Windows } from "./api/resources/windows/client/Client";
+import { Automations } from "./api/resources/automations/client/Client";
+import { ExtensionConfigurations } from "./api/resources/extensionConfigurations/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";
@@ -27,6 +29,10 @@ export declare class AirtopClient {
     constructor(_options: AirtopClient.Options);
     protected _windows: Windows | undefined;
     get windows(): Windows;
+    protected _automations: Automations | undefined;
+    get automations(): Automations;
+    protected _extensionConfigurations: ExtensionConfigurations | undefined;
+    get extensionConfigurations(): ExtensionConfigurations;
     protected _profiles: Profiles | undefined;
     get profiles(): Profiles;
     protected _requests: Requests | undefined;

package/Client.js

@@ -5,9 +5,11 @@
 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/requests/client/Client");
-const Client_4 = require("./api/resources/sessions/client/Client");
+const Client_2 = require("./api/resources/automations/client/Client");
+const Client_3 = require("./api/resources/extensionConfigurations/client/Client");
+const Client_4 = require("./api/resources/profiles/client/Client");
+const Client_5 = require("./api/resources/requests/client/Client");
+const Client_6 = require("./api/resources/sessions/client/Client");
 class AirtopClient {
     constructor(_options) {
         this._options = _options;
@@ -16,17 +18,25 @@ class AirtopClient {
         var _a;
         return ((_a = this._windows) !== null && _a !== void 0 ? _a : (this._windows = new Client_1.Windows(this._options)));
     }
+    get automations() {
+        var _a;
+        return ((_a = this._automations) !== null && _a !== void 0 ? _a : (this._automations = new Client_2.Automations(this._options)));
+    }
+    get extensionConfigurations() {
+        var _a;
+        return ((_a = this._extensionConfigurations) !== null && _a !== void 0 ? _a : (this._extensionConfigurations = new Client_3.ExtensionConfigurations(this._options)));
+    }
     get profiles() {
         var _a;
-        return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new Client_2.Profiles(this._options)));
+        return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new Client_4.Profiles(this._options)));
     }
     get requests() {
         var _a;
-        return ((_a = this._requests) !== null && _a !== void 0 ? _a : (this._requests = new Client_3.Requests(this._options)));
+        return ((_a = this._requests) !== null && _a !== void 0 ? _a : (this._requests = new Client_5.Requests(this._options)));
     }
     get sessions() {
         var _a;
-        return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_4.Sessions(this._options)));
+        return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_6.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/errors/ForbiddenError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index";
+import * as Airtop from "../index";
+export declare class ForbiddenError extends errors.AirtopError {
+    constructor(body: Airtop.ErrorModel);
+}

package/api/errors/ForbiddenError.js

@@ -0,0 +1,41 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForbiddenError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class ForbiddenError extends errors.AirtopError {
+    constructor(body) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+        });
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+    }
+}
+exports.ForbiddenError = ForbiddenError;

package/api/errors/UnauthorizedError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index";
+import * as Airtop from "../index";
+export declare class UnauthorizedError extends errors.AirtopError {
+    constructor(body: Airtop.ErrorModel);
+}

package/api/errors/UnauthorizedError.js

@@ -0,0 +1,41 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnauthorizedError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class UnauthorizedError extends errors.AirtopError {
+    constructor(body) {
+        super({
+            message: "UnauthorizedError",
+            statusCode: 401,
+            body: body,
+        });
+        Object.setPrototypeOf(this, UnauthorizedError.prototype);
+    }
+}
+exports.UnauthorizedError = UnauthorizedError;

package/api/errors/index.d.ts

@@ -1,3 +1,5 @@
+export * from "./UnauthorizedError";
+export * from "./ForbiddenError";
 export * from "./NotFoundError";
 export * from "./UnprocessableEntityError";
 export * from "./InternalServerError";

package/api/errors/index.js

@@ -14,6 +14,8 @@ 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("./UnauthorizedError"), exports);
+__exportStar(require("./ForbiddenError"), exports);
 __exportStar(require("./NotFoundError"), exports);
 __exportStar(require("./UnprocessableEntityError"), exports);
 __exportStar(require("./InternalServerError"), exports);

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

@@ -0,0 +1,87 @@
+/**
+ * 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 Automations {
+    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 Automations {
+    protected readonly _options: Automations.Options;
+    constructor(_options: Automations.Options);
+    /**
+     * List all automations for a given organization
+     *
+     * @param {Automations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.automations.listAutomations()
+     */
+    listAutomations(requestOptions?: Automations.RequestOptions): Promise<Airtop.ListAutomationsOutput>;
+    /**
+     * Update the description of a specific automation
+     *
+     * @param {Airtop.UpdateAutomationDescriptionInputBody} request
+     * @param {Automations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Airtop.UnauthorizedError}
+     * @throws {@link Airtop.ForbiddenError}
+     * @throws {@link Airtop.NotFoundError}
+     * @throws {@link Airtop.UnprocessableEntityError}
+     * @throws {@link Airtop.InternalServerError}
+     *
+     * @example
+     *     await client.automations.updateAutomationDescription({
+     *         description: "description",
+     *         id: "id",
+     *         orgId: "orgId"
+     *     })
+     */
+    updateAutomationDescription(request: Airtop.UpdateAutomationDescriptionInputBody, requestOptions?: Automations.RequestOptions): Promise<Airtop.AutomationOutput>;
+    /**
+     * Get a specific automation by ID
+     *
+     * @param {string} automationId - ID of the automation to retrieve
+     * @param {Automations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Airtop.UnauthorizedError}
+     * @throws {@link Airtop.ForbiddenError}
+     * @throws {@link Airtop.NotFoundError}
+     * @throws {@link Airtop.UnprocessableEntityError}
+     * @throws {@link Airtop.InternalServerError}
+     *
+     * @example
+     *     await client.automations.getAutomation("automationId")
+     */
+    getAutomation(automationId: string, requestOptions?: Automations.RequestOptions): Promise<Airtop.AutomationOutput>;
+    /**
+     * Delete a specific automation
+     *
+     * @param {string} automationId - ID of the automation to delete
+     * @param {Automations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Airtop.UnauthorizedError}
+     * @throws {@link Airtop.ForbiddenError}
+     * @throws {@link Airtop.NotFoundError}
+     * @throws {@link Airtop.UnprocessableEntityError}
+     * @throws {@link Airtop.InternalServerError}
+     *
+     * @example
+     *     await client.automations.deleteAutomation("automationId")
+     */
+    deleteAutomation(automationId: string, requestOptions?: Automations.RequestOptions): Promise<Airtop.DeleteAutomationOutputWrapperBody>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}