@airweave/sdk 0.2.22 → 0.2.23

package/README.md

@@ -23,15 +23,7 @@ Instantiate and use the client with the following:
 import { AirweaveSDKClient } from "@airweave/sdk";
 
 const client = new AirweaveSDKClient({ apiKey: "YOUR_API_KEY" });
-await client.connections.connectIntegration("source", "short_name", {
-    creds: "creds",
-    name: undefined,
-    configFields: {
-        config_fields: {
-            key: "value",
-        },
-    },
-});
+await client.apiKeys.createApiKey();
 ```
 
 ## Request And Response Types
@@ -42,7 +34,7 @@ following namespace:
 ```typescript
 import { AirweaveSDK } from "@airweave/sdk";
 
-const request: AirweaveSDK.ReadApiKeyApiKeysIdGetRequest = {
+const request: AirweaveSDK.ReadApiKeysApiKeysGetRequest = {
     ...
 };
 ```
@@ -56,7 +48,7 @@ will be thrown.
 import { AirweaveSDKError } from "@airweave/sdk";
 
 try {
-    await client.connections.connectIntegration(...);
+    await client.apiKeys.createApiKey(...);
 } catch (err) {
     if (err instanceof AirweaveSDKError) {
         console.log(err.statusCode);
@@ -73,7 +65,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.connections.connectIntegration(..., {
+const response = await client.apiKeys.createApiKey(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -95,7 +87,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.connections.connectIntegration(..., {
+const response = await client.apiKeys.createApiKey(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -105,7 +97,7 @@ const response = await client.connections.connectIntegration(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.connections.connectIntegration(..., {
+const response = await client.apiKeys.createApiKey(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -116,7 +108,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.connections.connectIntegration(..., {
+const response = await client.apiKeys.createApiKey(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request

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

@@ -26,6 +26,82 @@ export declare namespace ApiKeys {
 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()
+     */
+    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()
+     */
+    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"
+     *     })
+     */
+    deleteApiKey(request: AirweaveSDK.DeleteApiKeyApiKeysDeleteRequest, requestOptions?: ApiKeys.RequestOptions): Promise<AirweaveSDK.ApiKey>;
     /**
      * Retrieve an API key by ID.
      *
@@ -44,15 +120,12 @@ export declare class ApiKeys {
      *     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"
-     *     })
+     *     await client.apiKeys.readApiKey("id")
      */
-    readApiKey(id: string, request: AirweaveSDK.ReadApiKeyApiKeysIdGetRequest, requestOptions?: ApiKeys.RequestOptions): Promise<AirweaveSDK.ApiKey>;
+    readApiKey(id: string, requestOptions?: ApiKeys.RequestOptions): Promise<AirweaveSDK.ApiKey>;
 }

package/api/resources/apiKeys/client/Client.js

@@ -59,6 +59,255 @@ class ApiKeys {
     constructor(_options = {}) {
         this._options = _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()
+     */
+    readApiKeys() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a;
+            const { skip, limit } = request;
+            const _queryParams = {};
+            if (skip != null) {
+                _queryParams["skip"] = skip.toString();
+            }
+            if (limit != null) {
+                _queryParams["limit"] = limit.toString();
+            }
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.AirweaveSDKEnvironment.Production, "api_keys/"),
+                method: "GET",
+                headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
+                        ? yield core.Supplier.get(this._options.apiKey)
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.2.23", "User-Agent": "@airweave/sdk/0.2.23", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                queryParameters: _queryParams,
+                requestType: "json",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return serializers.apiKeys.readApiKeys.Response.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new AirweaveSDK.UnprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    default:
+                        throw new errors.AirweaveSDKError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.AirweaveSDKError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling GET /api_keys/.");
+                case "unknown":
+                    throw new errors.AirweaveSDKError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * 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()
+     */
+    createApiKey() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a;
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.AirweaveSDKEnvironment.Production, "api_keys/"),
+                method: "POST",
+                headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
+                        ? yield core.Supplier.get(this._options.apiKey)
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.2.23", "User-Agent": "@airweave/sdk/0.2.23", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                body: serializers.ApiKeyCreate.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return serializers.ApiKeyWithPlainKey.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new AirweaveSDK.UnprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    default:
+                        throw new errors.AirweaveSDKError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.AirweaveSDKError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling POST /api_keys/.");
+                case "unknown":
+                    throw new errors.AirweaveSDKError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * 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"
+     *     })
+     */
+    deleteApiKey(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const { id } = request;
+            const _queryParams = {};
+            _queryParams["id"] = id;
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.AirweaveSDKEnvironment.Production, "api_keys/"),
+                method: "DELETE",
+                headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
+                        ? yield core.Supplier.get(this._options.apiKey)
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.2.23", "User-Agent": "@airweave/sdk/0.2.23", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                queryParameters: _queryParams,
+                requestType: "json",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return serializers.ApiKey.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new AirweaveSDK.UnprocessableEntityError(serializers.HttpValidationError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    default:
+                        throw new errors.AirweaveSDKError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.AirweaveSDKError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling DELETE /api_keys/.");
+                case "unknown":
+                    throw new errors.AirweaveSDKError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
     /**
      * Retrieve an API key by ID.
      *
@@ -77,30 +326,23 @@ class ApiKeys {
      *     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"
-     *     })
+     *     await client.apiKeys.readApiKey("id")
      */
-    readApiKey(id, request, requestOptions) {
+    readApiKey(id, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            const { creds } = request;
-            const _queryParams = {};
-            _queryParams["creds"] = creds;
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.AirweaveSDKEnvironment.Production, `api-keys/${encodeURIComponent(id)}`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.AirweaveSDKEnvironment.Production, `api_keys/${encodeURIComponent(id)}`),
                 method: "GET",
                 headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
                         ? yield core.Supplier.get(this._options.apiKey)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "v0.2.22", "User-Agent": "@airweave/sdk/v0.2.22", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.2.23", "User-Agent": "@airweave/sdk/0.2.23", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
-                queryParameters: _queryParams,
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -137,7 +379,7 @@ class ApiKeys {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling GET /api-keys/{id}.");
+                    throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling GET /api_keys/{id}.");
                 case "unknown":
                     throw new errors.AirweaveSDKError({
                         message: _response.error.errorMessage,

package/{dist/api/types → api/resources/apiKeys/client/requests}/ApiKeyCreate.d.ts

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * Schema for creating an APIKey object.
+ * @example
+ *     {}
  */
 export interface ApiKeyCreate {
-    /** Expiration date for the API key, defaults to 180 days from now */
     expirationDate?: Date;
 }

package/api/resources/{sync/client/requests/GetSyncSyncSyncIdGetRequest.d.ts → apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts}

@@ -4,9 +4,9 @@
 /**
  * @example
  *     {
- *         creds: "creds"
+ *         id: "id"
  *     }
  */
-export interface GetSyncSyncSyncIdGetRequest {
-    creds: string;
+export interface DeleteApiKeyApiKeysDeleteRequest {
+    id: string;
 }

package/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ReadApiKeysApiKeysGetRequest {
+    skip?: number;
+    limit?: number;
+}

package/api/resources/apiKeys/client/requests/index.d.ts

@@ -1 +1,3 @@
-export { type ReadApiKeyApiKeysIdGetRequest } from "./ReadApiKeyApiKeysIdGetRequest";
+export { type ReadApiKeysApiKeysGetRequest } from "./ReadApiKeysApiKeysGetRequest";
+export { type ApiKeyCreate } from "./ApiKeyCreate";
+export { type DeleteApiKeyApiKeysDeleteRequest } from "./DeleteApiKeyApiKeysDeleteRequest";