@airweave/sdk 0.2.53 → 0.3.42

package/README.md

@@ -13,7 +13,7 @@ npm i -s @airweave/sdk
 
 ## Reference
 
-A full reference for this library is available [here](./reference.md).
+A full reference for this library is available [here](https://github.com/airweave-ai/typescript-sdk/blob/HEAD/./reference.md).
 
 ## Usage
 
@@ -22,9 +22,10 @@ Instantiate and use the client with the following:
 ```typescript
 import { AirweaveSDKClient } from "@airweave/sdk";
 
-const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY" });
+const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY", organizationId: "YOUR_ORGANIZATION_ID" });
 await client.collections.createCollection({
-    name: "name",
+    name: "Finance Data",
+    readable_id: "finance-data-reports",
 });
 ```
 
@@ -56,6 +57,7 @@ try {
         console.log(err.statusCode);
         console.log(err.message);
         console.log(err.body);
+        console.log(err.rawResponse);
     }
 }
 ```
@@ -77,10 +79,10 @@ const response = await client.collections.createCollection(..., {
 ### 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
+as the request is deemed retryable 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:
+A request is deemed retryable 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)
@@ -116,6 +118,18 @@ const response = await client.collections.createCollection(..., {
 controller.abort(); // aborts the request
 ```
 
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.collections.createCollection(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
 ### Runtime Compatibility
 
 The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
@@ -130,7 +144,7 @@ runtimes:
 
 ### Customizing Fetch Client
 
-The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+The SDK provides a way for you 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

package/dist/cjs/Client.d.ts

@@ -0,0 +1,48 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments.js";
+import * as core from "./core/index.js";
+import { Sources } from "./api/resources/sources/client/Client.js";
+import { Collections } from "./api/resources/collections/client/Client.js";
+import { SourceConnections } from "./api/resources/sourceConnections/client/Client.js";
+import { WhiteLabels } from "./api/resources/whiteLabels/client/Client.js";
+export declare namespace AirweaveSDKClient {
+    interface Options {
+        environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        /** Override the X-API-Key header */
+        apiKey?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-ID header */
+        organizationId?: core.Supplier<string | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    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-API-Key header */
+        apiKey?: string | undefined;
+        /** Override the X-Organization-ID header */
+        organizationId?: string | undefined;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class AirweaveSDKClient {
+    protected readonly _options: AirweaveSDKClient.Options;
+    protected _sources: Sources | undefined;
+    protected _collections: Collections | undefined;
+    protected _sourceConnections: SourceConnections | undefined;
+    protected _whiteLabels: WhiteLabels | undefined;
+    constructor(_options?: AirweaveSDKClient.Options);
+    get sources(): Sources;
+    get collections(): Collections;
+    get sourceConnections(): SourceConnections;
+    get whiteLabels(): WhiteLabels;
+}

package/dist/cjs/Client.js

@@ -0,0 +1,76 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AirweaveSDKClient = void 0;
+const core = __importStar(require("./core/index.js"));
+const headers_js_1 = require("./core/headers.js");
+const Client_js_1 = require("./api/resources/sources/client/Client.js");
+const Client_js_2 = require("./api/resources/collections/client/Client.js");
+const Client_js_3 = require("./api/resources/sourceConnections/client/Client.js");
+const Client_js_4 = require("./api/resources/whiteLabels/client/Client.js");
+class AirweaveSDKClient {
+    constructor(_options = {}) {
+        this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
+                "X-API-Key": _options === null || _options === void 0 ? void 0 : _options.apiKey,
+                "X-Organization-ID": _options === null || _options === void 0 ? void 0 : _options.organizationId,
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-SDK-Name": "@airweave/sdk",
+                "X-Fern-SDK-Version": "v0.3.42",
+                "User-Agent": "@airweave/sdk/v0.3.42",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+    }
+    get sources() {
+        var _a;
+        return ((_a = this._sources) !== null && _a !== void 0 ? _a : (this._sources = new Client_js_1.Sources(this._options)));
+    }
+    get collections() {
+        var _a;
+        return ((_a = this._collections) !== null && _a !== void 0 ? _a : (this._collections = new Client_js_2.Collections(this._options)));
+    }
+    get sourceConnections() {
+        var _a;
+        return ((_a = this._sourceConnections) !== null && _a !== void 0 ? _a : (this._sourceConnections = new Client_js_3.SourceConnections(this._options)));
+    }
+    get whiteLabels() {
+        var _a;
+        return ((_a = this._whiteLabels) !== null && _a !== void 0 ? _a : (this._whiteLabels = new Client_js_4.WhiteLabels(this._options)));
+    }
+}
+exports.AirweaveSDKClient = AirweaveSDKClient;

package/dist/cjs/api/errors/UnprocessableEntityError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.js";
+import * as AirweaveSDK from "../index.js";
+import * as core from "../../core/index.js";
+export declare class UnprocessableEntityError extends errors.AirweaveSDKError {
+    constructor(body: AirweaveSDK.HttpValidationError, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/UnprocessableEntityError.js

@@ -0,0 +1,52 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnprocessableEntityError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class UnprocessableEntityError extends errors.AirweaveSDKError {
+    constructor(body, rawResponse) {
+        super({
+            message: "UnprocessableEntityError",
+            statusCode: 422,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
+    }
+}
+exports.UnprocessableEntityError = UnprocessableEntityError;

package/dist/cjs/api/errors/index.d.ts

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

package/dist/cjs/api/errors/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("./UnprocessableEntityError.js"), exports);

package/dist/cjs/api/index.d.ts

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

package/dist/cjs/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("./types/index.js"), exports);
+__exportStar(require("./errors/index.js"), exports);
+__exportStar(require("./resources/index.js"), exports);

package/dist/cjs/api/resources/collections/client/Client.d.ts

@@ -0,0 +1,161 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as AirweaveSDK from "../../../index.js";
+export declare namespace Collections {
+    interface Options {
+        environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        /** Override the X-API-Key header */
+        apiKey?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-ID header */
+        organizationId?: core.Supplier<string | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    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-API-Key header */
+        apiKey?: string | undefined;
+        /** Override the X-Organization-ID header */
+        organizationId?: string | undefined;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+/**
+ * API endpoints for managing collections - logical groups of data sources that provide unified search capabilities
+ */
+export declare class Collections {
+    protected readonly _options: Collections.Options;
+    constructor(_options?: Collections.Options);
+    /**
+     * List all collections that belong to your organization.
+     *
+     * @param {AirweaveSDK.ListCollectionsCollectionsGetRequest} request
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.listCollections()
+     */
+    listCollections(request?: AirweaveSDK.ListCollectionsCollectionsGetRequest, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.Collection[]>;
+    private __listCollections;
+    /**
+     * Create a new collection.
+     *
+     * <br/><br/>
+     * The newly created collection is initially empty and does not contain any data
+     * until you explicitly add source connections to it.
+     *
+     * @param {AirweaveSDK.CollectionCreate} request
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.createCollection({
+     *         name: "Finance Data",
+     *         readable_id: "finance-data-reports"
+     *     })
+     */
+    createCollection(request: AirweaveSDK.CollectionCreate, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.Collection>;
+    private __createCollection;
+    /**
+     * Retrieve a specific collection by its readable ID.
+     *
+     * @param {string} readableId - The unique readable identifier of the collection (e.g., 'finance-data-ab123')
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.getCollection("readable_id")
+     */
+    getCollection(readableId: string, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.Collection>;
+    private __getCollection;
+    /**
+     * Update a collection's properties.
+     *
+     * <br/><br/>
+     * Modifies the display name of an existing collection.
+     * Note that the readable ID cannot be changed after creation to maintain stable
+     * API endpoints and preserve any existing integrations or bookmarks.
+     *
+     * @param {string} readableId - The unique readable identifier of the collection to update
+     * @param {AirweaveSDK.CollectionUpdate} request
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.updateCollection("readable_id", {
+     *         name: "Updated Finance Data"
+     *     })
+     */
+    updateCollection(readableId: string, request?: AirweaveSDK.CollectionUpdate, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.Collection>;
+    private __updateCollection;
+    /**
+     * Delete a collection and optionally its associated data.
+     *
+     * <br/><br/>
+     * Permanently removes a collection from your organization. By default, this only
+     * deletes the collection metadata while preserving the actual data in the
+     * destination systems.<br/><br/>All source connections within this collection
+     * will also be deleted as part of the cleanup process.
+     *
+     * @param {string} readableId - The unique readable identifier of the collection to delete
+     * @param {AirweaveSDK.DeleteCollectionCollectionsReadableIdDeleteRequest} request
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.deleteCollection("readable_id")
+     */
+    deleteCollection(readableId: string, request?: AirweaveSDK.DeleteCollectionCollectionsReadableIdDeleteRequest, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.Collection>;
+    private __deleteCollection;
+    /**
+     * Search across all data sources within the specified collection.
+     *
+     * @param {string} readableId - The unique readable identifier of the collection to search
+     * @param {AirweaveSDK.SearchCollectionCollectionsReadableIdSearchGetRequest} request
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.searchCollection("readable_id", {
+     *         query: "customer payment issues"
+     *     })
+     */
+    searchCollection(readableId: string, request: AirweaveSDK.SearchCollectionCollectionsReadableIdSearchGetRequest, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SearchResponse>;
+    private __searchCollection;
+    /**
+     * Trigger data synchronization for all source connections in the collection.
+     *
+     * <br/><br/>The sync jobs run asynchronously in the background, so this endpoint
+     * returns immediately with job details that you can use to track progress. You can
+     * monitor the status of individual data synchronization using the source connection
+     * endpoints.
+     *
+     * @param {string} readableId - The unique readable identifier of the collection to refresh
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.refreshAllSourceConnections("readable_id")
+     */
+    refreshAllSourceConnections(readableId: string, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob[]>;
+    private __refreshAllSourceConnections;
+}