@airweave/sdk 0.2.15 → 0.2.16

package/Client.d.ts

@@ -3,6 +3,7 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
+import { ApiKeys } from "./api/resources/apiKeys/client/Client";
 import { Users } from "./api/resources/users/client/Client";
 import { Sources } from "./api/resources/sources/client/Client";
 import { Destinations } from "./api/resources/destinations/client/Client";
@@ -34,6 +35,7 @@ export declare namespace AirweaveSDKClient {
 }
 export declare class AirweaveSDKClient {
     protected readonly _options: AirweaveSDKClient.Options;
+    protected _apiKeys: ApiKeys | undefined;
     protected _users: Users | undefined;
     protected _sources: Sources | undefined;
     protected _destinations: Destinations | undefined;
@@ -45,6 +47,7 @@ export declare class AirweaveSDKClient {
     protected _entities: Entities | undefined;
     protected _transformers: Transformers | undefined;
     constructor(_options?: AirweaveSDKClient.Options);
+    get apiKeys(): ApiKeys;
     get users(): Users;
     get sources(): Sources;
     get destinations(): Destinations;

package/Client.js

@@ -4,59 +4,64 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AirweaveSDKClient = void 0;
-const Client_1 = require("./api/resources/users/client/Client");
-const Client_2 = require("./api/resources/sources/client/Client");
-const Client_3 = require("./api/resources/destinations/client/Client");
-const Client_4 = require("./api/resources/embeddingModels/client/Client");
-const Client_5 = require("./api/resources/connections/client/Client");
-const Client_6 = require("./api/resources/sync/client/Client");
-const Client_7 = require("./api/resources/search/client/Client");
-const Client_8 = require("./api/resources/whiteLabels/client/Client");
-const Client_9 = require("./api/resources/entities/client/Client");
-const Client_10 = require("./api/resources/transformers/client/Client");
+const Client_1 = require("./api/resources/apiKeys/client/Client");
+const Client_2 = require("./api/resources/users/client/Client");
+const Client_3 = require("./api/resources/sources/client/Client");
+const Client_4 = require("./api/resources/destinations/client/Client");
+const Client_5 = require("./api/resources/embeddingModels/client/Client");
+const Client_6 = require("./api/resources/connections/client/Client");
+const Client_7 = require("./api/resources/sync/client/Client");
+const Client_8 = require("./api/resources/search/client/Client");
+const Client_9 = require("./api/resources/whiteLabels/client/Client");
+const Client_10 = require("./api/resources/entities/client/Client");
+const Client_11 = require("./api/resources/transformers/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 users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_1.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_2.Users(this._options)));
     }
     get sources() {
         var _a;
-        return ((_a = this._sources) !== null && _a !== void 0 ? _a : (this._sources = new Client_2.Sources(this._options)));
+        return ((_a = this._sources) !== null && _a !== void 0 ? _a : (this._sources = new Client_3.Sources(this._options)));
     }
     get destinations() {
         var _a;
-        return ((_a = this._destinations) !== null && _a !== void 0 ? _a : (this._destinations = new Client_3.Destinations(this._options)));
+        return ((_a = this._destinations) !== null && _a !== void 0 ? _a : (this._destinations = new Client_4.Destinations(this._options)));
     }
     get embeddingModels() {
         var _a;
-        return ((_a = this._embeddingModels) !== null && _a !== void 0 ? _a : (this._embeddingModels = new Client_4.EmbeddingModels(this._options)));
+        return ((_a = this._embeddingModels) !== null && _a !== void 0 ? _a : (this._embeddingModels = new Client_5.EmbeddingModels(this._options)));
     }
     get connections() {
         var _a;
-        return ((_a = this._connections) !== null && _a !== void 0 ? _a : (this._connections = new Client_5.Connections(this._options)));
+        return ((_a = this._connections) !== null && _a !== void 0 ? _a : (this._connections = new Client_6.Connections(this._options)));
     }
     get sync() {
         var _a;
-        return ((_a = this._sync) !== null && _a !== void 0 ? _a : (this._sync = new Client_6.Sync(this._options)));
+        return ((_a = this._sync) !== null && _a !== void 0 ? _a : (this._sync = new Client_7.Sync(this._options)));
     }
     get search() {
         var _a;
-        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_7.Search(this._options)));
+        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_8.Search(this._options)));
     }
     get whiteLabels() {
         var _a;
-        return ((_a = this._whiteLabels) !== null && _a !== void 0 ? _a : (this._whiteLabels = new Client_8.WhiteLabels(this._options)));
+        return ((_a = this._whiteLabels) !== null && _a !== void 0 ? _a : (this._whiteLabels = new Client_9.WhiteLabels(this._options)));
     }
     get entities() {
         var _a;
-        return ((_a = this._entities) !== null && _a !== void 0 ? _a : (this._entities = new Client_9.Entities(this._options)));
+        return ((_a = this._entities) !== null && _a !== void 0 ? _a : (this._entities = new Client_10.Entities(this._options)));
     }
     get transformers() {
         var _a;
-        return ((_a = this._transformers) !== null && _a !== void 0 ? _a : (this._transformers = new Client_10.Transformers(this._options)));
+        return ((_a = this._transformers) !== null && _a !== void 0 ? _a : (this._transformers = new Client_11.Transformers(this._options)));
     }
 }
 exports.AirweaveSDKClient = AirweaveSDKClient;

package/README.md

@@ -23,11 +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.users.createOrUpdateUser({
+await client.apiKeys.createApiKey({
     creds: "creds",
-    email: "email",
-    fullName: undefined,
-    organizationId: undefined,
+    expirationDate: undefined,
 });
 ```
 
@@ -39,7 +37,7 @@ following namespace:
 ```typescript
 import { AirweaveSDK } from "@airweave/sdk";
 
-const request: AirweaveSDK.ReadUserUsersGetRequest = {
+const request: AirweaveSDK.ReadApiKeysApiKeysGetRequest = {
     ...
 };
 ```
@@ -53,7 +51,7 @@ will be thrown.
 import { AirweaveSDKError } from "@airweave/sdk";
 
 try {
-    await client.users.createOrUpdateUser(...);
+    await client.apiKeys.createApiKey(...);
 } catch (err) {
     if (err instanceof AirweaveSDKError) {
         console.log(err.statusCode);
@@ -70,7 +68,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.users.createOrUpdateUser(..., {
+const response = await client.apiKeys.createApiKey(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -92,7 +90,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.users.createOrUpdateUser(..., {
+const response = await client.apiKeys.createApiKey(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -102,7 +100,7 @@ const response = await client.users.createOrUpdateUser(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.users.createOrUpdateUser(..., {
+const response = await client.apiKeys.createApiKey(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -113,7 +111,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.users.createOrUpdateUser(..., {
+const response = await client.apiKeys.createApiKey(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request

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

@@ -0,0 +1,140 @@
+/**
+ * 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 ApiKeys {
+    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 ApiKeys {
+    protected readonly _options: ApiKeys.Options;
+    constructor(_options?: ApiKeys.Options);
+    /**
+     * Retrieve all API keys for the current user.
+     *
+     * Args:
+     * ----
+     *     db (AsyncSession): The database session.
+     *     skip (int): Number of records to skip for pagination.
+     *     limit (int): Maximum number of records to return.
+     *     user (schemas.User): The current user.
+     *
+     * Returns:
+     * -------
+     *     List[schemas.APIKey]: A list of API keys.
+     *
+     * @param {AirweaveSDK.ReadApiKeysApiKeysGetRequest} request
+     * @param {ApiKeys.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.apiKeys.readApiKeys({
+     *         creds: "creds"
+     *     })
+     */
+    readApiKeys(request: AirweaveSDK.ReadApiKeysApiKeysGetRequest, requestOptions?: ApiKeys.RequestOptions): Promise<AirweaveSDK.ApiKey[]>;
+    /**
+     * Create a new API key for the current user.
+     *
+     * Returns a temporary plain key for the user to store securely.
+     * This is not stored in the database.
+     *
+     * Args:
+     * ----
+     *     db (AsyncSession): The database session.
+     *     api_key_in (schemas.APIKeyCreate): The API key creation data.
+     *     user (schemas.User): The current user.
+     *
+     * Returns:
+     * -------
+     *     schemas.APIKeyWithPlainKey: The created API key object, including the key.
+     *
+     * @param {AirweaveSDK.ApiKeyCreate} request
+     * @param {ApiKeys.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.apiKeys.createApiKey({
+     *         creds: "creds",
+     *         expirationDate: undefined
+     *     })
+     */
+    createApiKey(request: AirweaveSDK.ApiKeyCreate, requestOptions?: ApiKeys.RequestOptions): Promise<AirweaveSDK.ApiKeyWithPlainKey>;
+    /**
+     * Delete an API key.
+     *
+     * Args:
+     * ----
+     *     db (AsyncSession): The database session.
+     *     id (UUID): The ID of the API key.
+     *     user (schemas.User): The current user.
+     *
+     * Returns:
+     * -------
+     *     schemas.APIKey: The revoked API key object.
+     *
+     * Raises:
+     * ------
+     *     HTTPException: If the API key is not found.
+     *
+     * @param {AirweaveSDK.DeleteApiKeyApiKeysDeleteRequest} request
+     * @param {ApiKeys.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.apiKeys.deleteApiKey({
+     *         id: "id",
+     *         creds: "creds"
+     *     })
+     */
+    deleteApiKey(request: AirweaveSDK.DeleteApiKeyApiKeysDeleteRequest, requestOptions?: ApiKeys.RequestOptions): Promise<AirweaveSDK.ApiKey>;
+    /**
+     * Retrieve an API key by ID.
+     *
+     * Args:
+     * ----
+     *     db (AsyncSession): The database session.
+     *     id (UUID): The ID of the API key.
+     *     user (schemas.User): The current user.
+     *
+     * Returns:
+     * -------
+     *     schemas.APIKey: The API key object.
+     *
+     * Raises:
+     * ------
+     *     HTTPException: If the API key is not found.
+     *
+     * @param {string} id
+     * @param {AirweaveSDK.ReadApiKeyApiKeysIdGetRequest} request
+     * @param {ApiKeys.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.apiKeys.readApiKey("id", {
+     *         creds: "creds"
+     *     })
+     */
+    readApiKey(id: string, request: AirweaveSDK.ReadApiKeyApiKeysIdGetRequest, requestOptions?: ApiKeys.RequestOptions): Promise<AirweaveSDK.ApiKey>;
+}