@airweave/sdk 0.2.26 → 0.2.52

package/Client.d.ts

@@ -3,13 +3,9 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import { ApiKeys } from "./api/resources/apiKeys/client/Client";
 import { Sources } from "./api/resources/sources/client/Client";
-import { EmbeddingModels } from "./api/resources/embeddingModels/client/Client";
-import { Connections } from "./api/resources/connections/client/Client";
-import { Sync } from "./api/resources/sync/client/Client";
-import { Search } from "./api/resources/search/client/Client";
-import { WhiteLabels } from "./api/resources/whiteLabels/client/Client";
+import { Collections } from "./api/resources/collections/client/Client";
+import { SourceConnections } from "./api/resources/sourceConnections/client/Client";
 export declare namespace AirweaveSDKClient {
     interface Options {
         environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
@@ -31,19 +27,11 @@ export declare namespace AirweaveSDKClient {
 }
 export declare class AirweaveSDKClient {
     protected readonly _options: AirweaveSDKClient.Options;
-    protected _apiKeys: ApiKeys | undefined;
     protected _sources: Sources | undefined;
-    protected _embeddingModels: EmbeddingModels | undefined;
-    protected _connections: Connections | undefined;
-    protected _sync: Sync | undefined;
-    protected _search: Search | undefined;
-    protected _whiteLabels: WhiteLabels | undefined;
+    protected _collections: Collections | undefined;
+    protected _sourceConnections: SourceConnections | undefined;
     constructor(_options?: AirweaveSDKClient.Options);
-    get apiKeys(): ApiKeys;
     get sources(): Sources;
-    get embeddingModels(): EmbeddingModels;
-    get connections(): Connections;
-    get sync(): Sync;
-    get search(): Search;
-    get whiteLabels(): WhiteLabels;
+    get collections(): Collections;
+    get sourceConnections(): SourceConnections;
 }

package/Client.js

@@ -4,44 +4,24 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AirweaveSDKClient = void 0;
-const Client_1 = require("./api/resources/apiKeys/client/Client");
-const Client_2 = require("./api/resources/sources/client/Client");
-const Client_3 = require("./api/resources/embeddingModels/client/Client");
-const Client_4 = require("./api/resources/connections/client/Client");
-const Client_5 = require("./api/resources/sync/client/Client");
-const Client_6 = require("./api/resources/search/client/Client");
-const Client_7 = require("./api/resources/whiteLabels/client/Client");
+const Client_1 = require("./api/resources/sources/client/Client");
+const Client_2 = require("./api/resources/collections/client/Client");
+const Client_3 = require("./api/resources/sourceConnections/client/Client");
 class AirweaveSDKClient {
     constructor(_options = {}) {
         this._options = _options;
     }
-    get apiKeys() {
-        var _a;
-        return ((_a = this._apiKeys) !== null && _a !== void 0 ? _a : (this._apiKeys = new Client_1.ApiKeys(this._options)));
-    }
     get sources() {
         var _a;
-        return ((_a = this._sources) !== null && _a !== void 0 ? _a : (this._sources = new Client_2.Sources(this._options)));
-    }
-    get embeddingModels() {
-        var _a;
-        return ((_a = this._embeddingModels) !== null && _a !== void 0 ? _a : (this._embeddingModels = new Client_3.EmbeddingModels(this._options)));
-    }
-    get connections() {
-        var _a;
-        return ((_a = this._connections) !== null && _a !== void 0 ? _a : (this._connections = new Client_4.Connections(this._options)));
-    }
-    get sync() {
-        var _a;
-        return ((_a = this._sync) !== null && _a !== void 0 ? _a : (this._sync = new Client_5.Sync(this._options)));
+        return ((_a = this._sources) !== null && _a !== void 0 ? _a : (this._sources = new Client_1.Sources(this._options)));
     }
-    get search() {
+    get collections() {
         var _a;
-        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_6.Search(this._options)));
+        return ((_a = this._collections) !== null && _a !== void 0 ? _a : (this._collections = new Client_2.Collections(this._options)));
     }
-    get whiteLabels() {
+    get sourceConnections() {
         var _a;
-        return ((_a = this._whiteLabels) !== null && _a !== void 0 ? _a : (this._whiteLabels = new Client_7.WhiteLabels(this._options)));
+        return ((_a = this._sourceConnections) !== null && _a !== void 0 ? _a : (this._sourceConnections = new Client_3.SourceConnections(this._options)));
     }
 }
 exports.AirweaveSDKClient = AirweaveSDKClient;

package/README.md

@@ -23,7 +23,9 @@ Instantiate and use the client with the following:
 import { AirweaveSDKClient } from "@airweave/sdk";
 
 const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY" });
-await client.apiKeys.createApiKey();
+await client.collections.createCollection({
+    name: "name",
+});
 ```
 
 ## Request And Response Types
@@ -34,7 +36,7 @@ following namespace:
 ```typescript
 import { AirweaveSDK } from "@airweave/sdk";
 
-const request: AirweaveSDK.ReadApiKeysApiKeysGetRequest = {
+const request: AirweaveSDK.ListCollectionsCollectionsGetRequest = {
     ...
 };
 ```
@@ -48,7 +50,7 @@ will be thrown.
 import { AirweaveSDKError } from "@airweave/sdk";
 
 try {
-    await client.apiKeys.createApiKey(...);
+    await client.collections.createCollection(...);
 } catch (err) {
     if (err instanceof AirweaveSDKError) {
         console.log(err.statusCode);
@@ -65,7 +67,7 @@ try {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.apiKeys.createApiKey(..., {
+const response = await client.collections.createCollection(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -87,7 +89,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.apiKeys.createApiKey(..., {
+const response = await client.collections.createCollection(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -97,7 +99,7 @@ const response = await client.apiKeys.createApiKey(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.apiKeys.createApiKey(..., {
+const response = await client.collections.createCollection(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -108,7 +110,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.apiKeys.createApiKey(..., {
+const response = await client.collections.createCollection(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request

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

@@ -0,0 +1,135 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as AirweaveSDK from "../../../index";
+export declare namespace Collections {
+    interface Options {
+        environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
+        /** Override the x-api-key header */
+        apiKey?: core.Supplier<string | 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;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Collections {
+    protected readonly _options: Collections.Options;
+    constructor(_options?: Collections.Options);
+    /**
+     * List all collections for the current user's 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): Promise<AirweaveSDK.Collection[]>;
+    /**
+     * Create a new collection.
+     *
+     * @param {AirweaveSDK.CollectionCreate} request
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.createCollection({
+     *         name: "name"
+     *     })
+     */
+    createCollection(request: AirweaveSDK.CollectionCreate, requestOptions?: Collections.RequestOptions): Promise<AirweaveSDK.Collection>;
+    /**
+     * Get a specific collection by its readable ID.
+     *
+     * @param {string} readableId
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.getCollection("readable_id")
+     */
+    getCollection(readableId: string, requestOptions?: Collections.RequestOptions): Promise<AirweaveSDK.Collection>;
+    /**
+     * Delete a collection by its readable ID.
+     *
+     * Args:
+     *     readable_id: The readable ID of the collection to delete
+     *     delete_data: Whether to delete the data in destinations
+     *     db: The database session
+     *     current_user: The current user
+     *
+     * Returns:
+     *     The deleted collection
+     *
+     * @param {string} readableId
+     * @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): Promise<AirweaveSDK.Collection>;
+    /**
+     * Search within a collection identified by readable ID.
+     *
+     * Args:
+     *     readable_id: The readable ID of the collection to search
+     *     query: The search query
+     *     response_type: Type of response (raw results or AI completion)
+     *     db: The database session
+     *     current_user: The current user
+     *
+     * Returns:
+     *     dict: Search results or AI completion response
+     *
+     * @param {string} readableId
+     * @param {AirweaveSDK.SearchCollectionCollectionsReadableIdSearchGetRequest} request
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.searchCollection("readable_id", {
+     *         query: "query"
+     *     })
+     */
+    searchCollection(readableId: string, request: AirweaveSDK.SearchCollectionCollectionsReadableIdSearchGetRequest, requestOptions?: Collections.RequestOptions): Promise<AirweaveSDK.SearchResponse>;
+    /**
+     * Start sync jobs for all source connections in the collection.
+     *
+     * Args:
+     *     readable_id: The readable ID of the collection
+     *     db: The database session
+     *     current_user: The current user
+     *     background_tasks: Background tasks for async operations
+     *
+     * Returns:
+     *     A list of created sync jobs
+     *
+     * @param {string} readableId
+     * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.collections.refreshAllSourceConnections("readable_id")
+     */
+    refreshAllSourceConnections(readableId: string, requestOptions?: Collections.RequestOptions): Promise<AirweaveSDK.SourceConnectionJob[]>;
+}