@airtop/sdk 0.0.4

package/Client.d.ts

@@ -0,0 +1,33 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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";
+export declare namespace AirtopClient {
+    interface Options {
+        environment?: core.Supplier<environments.AirtopEnvironment | string>;
+        /** Override the x-airtop-token header */
+        airtopToken?: core.Supplier<string | undefined>;
+        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;
+        /** Override the x-airtop-token header */
+        airtopToken?: string | undefined;
+    }
+}
+export declare class AirtopClient {
+    protected readonly _options: AirtopClient.Options;
+    constructor(_options?: AirtopClient.Options);
+    protected _profiles: Profiles | undefined;
+    get profiles(): Profiles;
+    protected _sessions: Sessions | undefined;
+    get sessions(): Sessions;
+}

package/Client.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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");
+class AirtopClient {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    get profiles() {
+        var _a;
+        return ((_a = this._profiles) !== null && _a !== void 0 ? _a : (this._profiles = new Client_1.Profiles(this._options)));
+    }
+    get sessions() {
+        var _a;
+        return ((_a = this._sessions) !== null && _a !== void 0 ? _a : (this._sessions = new Client_2.Sessions(this._options)));
+    }
+}
+exports.AirtopClient = AirtopClient;

package/README.md

@@ -0,0 +1,135 @@
+# Airtop TypeScript Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+[![npm shield](https://img.shields.io/npm/v/@airtop/sdk)](https://www.npmjs.com/package/@airtop/sdk)
+
+The Airtop TypeScript library provides convenient access to the Airtop API from TypeScript.
+
+## Installation
+
+```sh
+npm i -s @airtop/sdk
+```
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```typescript
+import { AirtopClient } from "@airtop/sdk";
+
+const client = new AirtopClient({ airtopToken: "YOUR_AIRTOP_TOKEN" });
+await client.sessions.post();
+```
+
+## Request And Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { Airtop } from "@airtop/sdk";
+
+const request: Airtop.ProfilesGetRequest = {
+    ...
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { AirtopError } from "@airtop/sdk";
+
+try {
+    await client.sessions.post(...);
+} catch (err) {
+    if (err instanceof AirtopError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+    }
+}
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+-   [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+-   [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+-   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.sessions.post(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.sessions.post(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+### Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await client.sessions.post(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Runtime Compatibility
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
+runtimes:
+
+-   Node.js 18+
+-   Vercel
+-   Cloudflare Workers
+-   Deno v1.25+
+-   Bun 1.0+
+-   React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { AirtopClient } from "@airtop/sdk";
+
+const client = new AirtopClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/api/errors/InternalServerError.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 InternalServerError extends errors.AirtopError {
+    constructor(body: Airtop.ErrorModel);
+}

package/api/errors/InternalServerError.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.InternalServerError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class InternalServerError extends errors.AirtopError {
+    constructor(body) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+        });
+        Object.setPrototypeOf(this, InternalServerError.prototype);
+    }
+}
+exports.InternalServerError = InternalServerError;

package/api/errors/NotFoundError.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 NotFoundError extends errors.AirtopError {
+    constructor(body: Airtop.ErrorModel);
+}

package/api/errors/NotFoundError.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.NotFoundError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class NotFoundError extends errors.AirtopError {
+    constructor(body) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}
+exports.NotFoundError = NotFoundError;

package/api/errors/UnprocessableEntityError.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 UnprocessableEntityError extends errors.AirtopError {
+    constructor(body: Airtop.ErrorModel);
+}

package/api/errors/UnprocessableEntityError.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.UnprocessableEntityError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class UnprocessableEntityError extends errors.AirtopError {
+    constructor(body) {
+        super({
+            message: "UnprocessableEntityError",
+            statusCode: 422,
+            body: body,
+        });
+        Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
+    }
+}
+exports.UnprocessableEntityError = UnprocessableEntityError;

package/api/errors/index.d.ts

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

package/api/errors/index.js

@@ -0,0 +1,19 @@
+"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("./NotFoundError"), exports);
+__exportStar(require("./UnprocessableEntityError"), exports);
+__exportStar(require("./InternalServerError"), exports);

package/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./resources";
+export * from "./types";
+export * from "./errors";

package/api/index.js

@@ -0,0 +1,19 @@
+"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("./resources"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./errors"), exports);

package/api/resources/index.d.ts

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

package/api/resources/index.js

@@ -0,0 +1,34 @@
+"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 __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 __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.sessions = __importStar(require("./sessions"));
+__exportStar(require("./sessions/types"), exports);
+exports.profiles = __importStar(require("./profiles"));
+__exportStar(require("./profiles/client/requests"), exports);
+__exportStar(require("./sessions/client/requests"), exports);

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

@@ -0,0 +1,66 @@
+/**
+ * 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 Profiles {
+    interface Options {
+        environment?: core.Supplier<environments.AirtopEnvironment | string>;
+        /** Override the x-airtop-token header */
+        airtopToken?: core.Supplier<string | undefined>;
+        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;
+        /** Override the x-airtop-token header */
+        airtopToken?: string | undefined;
+    }
+}
+export declare class Profiles {
+    protected readonly _options: Profiles.Options;
+    constructor(_options?: Profiles.Options);
+    /**
+     * Get profiles, searching by name or tags
+     *
+     * @param {Airtop.ProfilesGetRequest} request
+     * @param {Profiles.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.profiles.get({
+     *         name: "^Acme.*"
+     *     })
+     */
+    get(request?: Airtop.ProfilesGetRequest, requestOptions?: Profiles.RequestOptions): Promise<Airtop.ProfilesOutputV1Body>;
+    /**
+     * Delete profiles matching query
+     *
+     * @param {Airtop.ProfilesDeleteRequest} request
+     * @param {Profiles.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.profiles.delete({
+     *         name: "^Acme.*"
+     *     })
+     */
+    delete(request?: Airtop.ProfilesDeleteRequest, requestOptions?: Profiles.RequestOptions): Promise<void>;
+    /**
+     * Get a profile by ID
+     *
+     * @param {string} id - name of the profile to get
+     * @param {Profiles.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Airtop.NotFoundError}
+     * @throws {@link Airtop.UnprocessableEntityError}
+     * @throws {@link Airtop.InternalServerError}
+     *
+     * @example
+     *     await client.profiles.getById("4a61a55c-391b-4f73-957e-ffbd29ac7cba")
+     */
+    getById(id: string, requestOptions?: Profiles.RequestOptions): Promise<Airtop.ProfileOutputV1Body>;
+}