@airweave/sdk 0.7.1 → 0.7.2

package/README.md

@@ -1,235 +0,0 @@
-# Airweave TypeScript Library
-
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fairweave-ai%2Ftypescript-sdk)
-[![npm shield](https://img.shields.io/npm/v/@airweave/sdk)](https://www.npmjs.com/package/@airweave/sdk)
-
-The Airweave TypeScript library provides convenient access to the Airweave APIs from TypeScript.
-
-## Table of Contents
-
-- [Table of Contents](#table-of-contents)
-- [Installation](#installation)
-- [Reference](#reference)
-- [Usage](#usage)
-- [Framework Tracking](#framework-tracking)
-- [Request and Response Types](#request-and-response-types)
-- [Exception Handling](#exception-handling)
-- [Advanced](#advanced)
-    - [Additional Headers](#additional-headers)
-    - [Additional Query String Parameters](#additional-query-string-parameters)
-    - [Retries](#retries)
-    - [Timeouts](#timeouts)
-    - [Aborting Requests](#aborting-requests)
-    - [Access Raw Response Data](#access-raw-response-data)
-    - [Runtime Compatibility](#runtime-compatibility)
-- [Contributing](#contributing)
-
-## Table of Contents
-
-- [Installation](#installation)
-- [Reference](#reference)
-- [Usage](#usage)
-- [Framework Tracking](#framework-tracking)
-- [Request and Response Types](#request-and-response-types)
-- [Exception Handling](#exception-handling)
-- [Advanced](#advanced)
-    - [Additional Headers](#additional-headers)
-    - [Additional Query String Parameters](#additional-query-string-parameters)
-    - [Retries](#retries)
-    - [Timeouts](#timeouts)
-    - [Aborting Requests](#aborting-requests)
-    - [Access Raw Response Data](#access-raw-response-data)
-    - [Runtime Compatibility](#runtime-compatibility)
-- [Contributing](#contributing)
-
-## Installation
-
-```sh
-npm i -s @airweave/sdk
-```
-
-## Reference
-
-A full reference for this library is available [here](https://github.com/airweave-ai/typescript-sdk/blob/HEAD/./reference.md).
-
-## Usage
-
-Instantiate and use the client with the following:
-
-```typescript
-import { AirweaveSDKClient } from "@airweave/sdk";
-
-const client = new AirweaveSDKClient({
-    apiKey: "YOUR_API_KEY",
-    frameworkName: "YOUR_FRAMEWORK_NAME",
-    frameworkVersion: "YOUR_FRAMEWORK_VERSION",
-});
-await client.collections.create({
-    name: "Finance Data",
-    readable_id: "finance-data-reports",
-});
-```
-
-## Framework Tracking
-
-If you're using Airweave with an agent framework like CrewAI, LangChain, or LlamaIndex, you can track which framework is making requests. This helps Airweave provide better analytics and support for your specific framework.
-
-```typescript
-import { AirweaveSDKClient } from "@airweave/sdk";
-
-const client = new AirweaveSDKClient({
-    apiKey: "YOUR_API_KEY",
-    frameworkName: "langchain",
-    frameworkVersion: "0.2.0",
-});
-```
-
-The framework information is automatically sent with every request as headers (`X-Framework-Name` and `X-Framework-Version`), enabling better insights and troubleshooting.
-
-## Request and Response Types
-
-The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
-following namespace:
-
-```typescript
-import { AirweaveSDK } from "@airweave/sdk";
-
-const request: AirweaveSDK.ListCollectionsGetRequest = {
-    ...
-};
-```
-
-## 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 { AirweaveSDKError } from "@airweave/sdk";
-
-try {
-    await client.collections.create(...);
-} catch (err) {
-    if (err instanceof AirweaveSDKError) {
-        console.log(err.statusCode);
-        console.log(err.message);
-        console.log(err.body);
-        console.log(err.rawResponse);
-    }
-}
-```
-
-## Advanced
-
-### Additional Headers
-
-If you would like to send additional headers as part of the request, use the `headers` request option.
-
-```typescript
-const response = await client.collections.create(..., {
-    headers: {
-        'X-Custom-Header': 'custom value'
-    }
-});
-```
-
-### Additional Query String Parameters
-
-If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
-
-```typescript
-const response = await client.collections.create(..., {
-    queryParams: {
-        'customQueryParamKey': 'custom query param value'
-    }
-});
-```
-
-### Retries
-
-The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-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 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)
-- [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.collections.create(..., {
-    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.collections.create(..., {
-    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.collections.create(..., {
-    abortSignal: controller.signal
-});
-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.create(...).withRawResponse();
-
-console.log(data);
-console.log(rawResponse.headers['X-My-Header']);
-```
-
-### Runtime Compatibility
-
-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 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
-import { AirweaveSDKClient } from "@airweave/sdk";
-
-const client = new AirweaveSDKClient({
-    ...
-    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/dist/cjs/Client.js

@@ -49,8 +49,8 @@ class AirweaveSDKClient {
                 "X-Framework-Version": _options === null || _options === void 0 ? void 0 : _options.frameworkVersion,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@airweave/sdk",
-                "X-Fern-SDK-Version": "v0.7.1",
-                "User-Agent": "@airweave/sdk/v0.7.1",
+                "X-Fern-SDK-Version": "v0.7.2",
+                "User-Agent": "@airweave/sdk/v0.7.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -41,7 +41,9 @@ export declare class Collections {
     protected readonly _options: Collections.Options;
     constructor(_options: Collections.Options);
     /**
-     * List all collections that belong to your organization.
+     * List all collections that belong to your organization with optional search filtering.
+     *
+     * Collections are always sorted by creation date (newest first).
      *
      * @param {AirweaveSDK.ListCollectionsGetRequest} request
      * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,7 +53,8 @@ export declare class Collections {
      * @example
      *     await client.collections.list({
      *         skip: 1,
-     *         limit: 1
+     *         limit: 1,
+     *         search: "search"
      *     })
      */
     list(request?: AirweaveSDK.ListCollectionsGetRequest, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.Collection[]>;

package/dist/cjs/api/resources/collections/client/Client.js

@@ -59,7 +59,9 @@ class Collections {
         this._options = _options;
     }
     /**
-     * List all collections that belong to your organization.
+     * List all collections that belong to your organization with optional search filtering.
+     *
+     * Collections are always sorted by creation date (newest first).
      *
      * @param {AirweaveSDK.ListCollectionsGetRequest} request
      * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
@@ -69,7 +71,8 @@ class Collections {
      * @example
      *     await client.collections.list({
      *         skip: 1,
-     *         limit: 1
+     *         limit: 1,
+     *         search: "search"
      *     })
      */
     list(request = {}, requestOptions) {
@@ -78,7 +81,7 @@ class Collections {
     __list() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g;
-            const { skip, limit } = request;
+            const { skip, limit, search } = request;
             const _queryParams = {};
             if (skip != null) {
                 _queryParams["skip"] = skip.toString();
@@ -86,6 +89,9 @@ class Collections {
             if (limit != null) {
                 _queryParams["limit"] = limit.toString();
             }
+            if (search != null) {
+                _queryParams["search"] = search;
+            }
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({ "X-Framework-Name": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.frameworkName) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.frameworkName, "X-Framework-Version": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.frameworkVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.frameworkVersion }, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_g = (_f = (yield core.Supplier.get(this._options.baseUrl))) !== null && _f !== void 0 ? _f : (yield core.Supplier.get(this._options.environment))) !== null && _g !== void 0 ? _g : environments.AirweaveSDKEnvironment.Production, "collections"),

package/dist/cjs/api/resources/collections/client/requests/ListCollectionsGetRequest.d.ts

@@ -5,7 +5,8 @@
  * @example
  *     {
  *         skip: 1,
- *         limit: 1
+ *         limit: 1,
+ *         search: "search"
  *     }
  */
 export interface ListCollectionsGetRequest {
@@ -13,4 +14,6 @@ export interface ListCollectionsGetRequest {
     skip?: number;
     /** Maximum number of collections to return (1-1000) */
     limit?: number;
+    /** Search term to filter by name or readable_id */
+    search?: string;
 }

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "v0.7.1";
+export declare const SDK_VERSION = "v0.7.2";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "v0.7.1";
+exports.SDK_VERSION = "v0.7.2";

package/dist/esm/Client.mjs

@@ -13,8 +13,8 @@ export class AirweaveSDKClient {
                 "X-Framework-Version": _options === null || _options === void 0 ? void 0 : _options.frameworkVersion,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@airweave/sdk",
-                "X-Fern-SDK-Version": "v0.7.1",
-                "User-Agent": "@airweave/sdk/v0.7.1",
+                "X-Fern-SDK-Version": "v0.7.2",
+                "User-Agent": "@airweave/sdk/v0.7.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/collections/client/Client.d.mts

@@ -41,7 +41,9 @@ export declare class Collections {
     protected readonly _options: Collections.Options;
     constructor(_options: Collections.Options);
     /**
-     * List all collections that belong to your organization.
+     * List all collections that belong to your organization with optional search filtering.
+     *
+     * Collections are always sorted by creation date (newest first).
      *
      * @param {AirweaveSDK.ListCollectionsGetRequest} request
      * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,7 +53,8 @@ export declare class Collections {
      * @example
      *     await client.collections.list({
      *         skip: 1,
-     *         limit: 1
+     *         limit: 1,
+     *         search: "search"
      *     })
      */
     list(request?: AirweaveSDK.ListCollectionsGetRequest, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.Collection[]>;

package/dist/esm/api/resources/collections/client/Client.mjs

@@ -23,7 +23,9 @@ export class Collections {
         this._options = _options;
     }
     /**
-     * List all collections that belong to your organization.
+     * List all collections that belong to your organization with optional search filtering.
+     *
+     * Collections are always sorted by creation date (newest first).
      *
      * @param {AirweaveSDK.ListCollectionsGetRequest} request
      * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
@@ -33,7 +35,8 @@ export class Collections {
      * @example
      *     await client.collections.list({
      *         skip: 1,
-     *         limit: 1
+     *         limit: 1,
+     *         search: "search"
      *     })
      */
     list(request = {}, requestOptions) {
@@ -42,7 +45,7 @@ export class Collections {
     __list() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g;
-            const { skip, limit } = request;
+            const { skip, limit, search } = request;
             const _queryParams = {};
             if (skip != null) {
                 _queryParams["skip"] = skip.toString();
@@ -50,6 +53,9 @@ export class Collections {
             if (limit != null) {
                 _queryParams["limit"] = limit.toString();
             }
+            if (search != null) {
+                _queryParams["search"] = search;
+            }
             let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({ "X-Framework-Name": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.frameworkName) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.frameworkName, "X-Framework-Version": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.frameworkVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.frameworkVersion }, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_g = (_f = (yield core.Supplier.get(this._options.baseUrl))) !== null && _f !== void 0 ? _f : (yield core.Supplier.get(this._options.environment))) !== null && _g !== void 0 ? _g : environments.AirweaveSDKEnvironment.Production, "collections"),

package/dist/esm/api/resources/collections/client/requests/ListCollectionsGetRequest.d.mts

@@ -5,7 +5,8 @@
  * @example
  *     {
  *         skip: 1,
- *         limit: 1
+ *         limit: 1,
+ *         search: "search"
  *     }
  */
 export interface ListCollectionsGetRequest {
@@ -13,4 +14,6 @@ export interface ListCollectionsGetRequest {
     skip?: number;
     /** Maximum number of collections to return (1-1000) */
     limit?: number;
+    /** Search term to filter by name or readable_id */
+    search?: string;
 }

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "v0.7.1";
+export declare const SDK_VERSION = "v0.7.2";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "v0.7.1";
+export const SDK_VERSION = "v0.7.2";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@airweave/sdk",
-    "version": "v0.7.1",
+    "version": "v0.7.2",
     "private": false,
     "repository": "github:airweave-ai/typescript-sdk",
     "type": "commonjs",

package/reference.md

@@ -137,7 +137,9 @@ await client.sources.get("short_name");
 <dl>
 <dd>
 
-List all collections that belong to your organization.
+List all collections that belong to your organization with optional search filtering.
+
+Collections are always sorted by creation date (newest first).
 
 </dd>
 </dl>
@@ -156,6 +158,7 @@ List all collections that belong to your organization.
 await client.collections.list({
     skip: 1,
     limit: 1,
+    search: "search",
 });
 ```