@airweave/sdk 0.7.20 → 0.8.77

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

@@ -10,10 +10,6 @@ export declare namespace Sources {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
-        /** Override the X-Framework-Name header */
-        frameworkName?: core.Supplier<string | undefined>;
-        /** Override the X-Framework-Version header */
-        frameworkVersion?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -24,10 +20,6 @@ export declare namespace Sources {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the X-Framework-Name header */
-        frameworkName?: string | undefined;
-        /** Override the X-Framework-Version header */
-        frameworkVersion?: string | undefined;
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
@@ -41,14 +33,22 @@ export declare class Sources {
     protected readonly _options: Sources.Options;
     constructor(_options: Sources.Options);
     /**
-     * List all available data source connectors.
+     * Retrieve all available data source connectors.
      *
-     * <br/><br/>
-     * Returns the complete catalog of source types that Airweave can connect to.
+     * Returns the complete catalog of source types that Airweave can connect to,
+     * including their authentication methods, configuration requirements, and
+     * supported features. Use this endpoint to discover which integrations are
+     * available for your organization.
+     *
+     * Each source includes:
+     * - **Authentication methods**: How to connect (OAuth, API key, etc.)
+     * - **Configuration schemas**: What settings are required or optional
+     * - **Supported auth providers**: Pre-configured OAuth providers available
      *
      * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
      *
      * @example
      *     await client.sources.list()
@@ -56,15 +56,26 @@ export declare class Sources {
     list(requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<AirweaveSDK.Source[]>;
     private __list;
     /**
-     * Get detailed information about a specific data source connector.
+     * Retrieve detailed information about a specific data source connector.
+     *
+     * Returns the complete configuration for a source type, including:
+     *
+     * - **Authentication fields**: Schema for credentials required to connect
+     * - **Configuration fields**: Schema for optional settings and customization
+     * - **Supported auth providers**: Pre-configured OAuth providers available for this source
+     *
+     * Use this endpoint before creating a source connection to understand what
+     * authentication and configuration values are required.
      *
      * @param {string} shortName - Technical identifier of the source type (e.g., 'github', 'stripe', 'slack')
      * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link AirweaveSDK.NotFoundError}
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
      *
      * @example
-     *     await client.sources.get("short_name")
+     *     await client.sources.get("github")
      */
     get(shortName: string, requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<AirweaveSDK.Source>;
     private __get;

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

@@ -59,14 +59,22 @@ class Sources {
         this._options = _options;
     }
     /**
-     * List all available data source connectors.
+     * Retrieve all available data source connectors.
      *
-     * <br/><br/>
-     * Returns the complete catalog of source types that Airweave can connect to.
+     * Returns the complete catalog of source types that Airweave can connect to,
+     * including their authentication methods, configuration requirements, and
+     * supported features. Use this endpoint to discover which integrations are
+     * available for your organization.
+     *
+     * Each source includes:
+     * - **Authentication methods**: How to connect (OAuth, API key, etc.)
+     * - **Configuration schemas**: What settings are required or optional
+     * - **Supported auth providers**: Pre-configured OAuth providers available
      *
      * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
      *
      * @example
      *     await client.sources.list()
@@ -76,10 +84,10 @@ class Sources {
     }
     __list(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g;
-            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);
+            var _a, _b, _c;
+            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({}, (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, "sources"),
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AirweaveSDKEnvironment.Production, "sources"),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -94,6 +102,8 @@ class Sources {
                 switch (_response.error.statusCode) {
                     case 422:
                         throw new AirweaveSDK.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new AirweaveSDK.TooManyRequestsError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.AirweaveSDKError({
                             statusCode: _response.error.statusCode,
@@ -120,25 +130,36 @@ class Sources {
         });
     }
     /**
-     * Get detailed information about a specific data source connector.
+     * Retrieve detailed information about a specific data source connector.
+     *
+     * Returns the complete configuration for a source type, including:
+     *
+     * - **Authentication fields**: Schema for credentials required to connect
+     * - **Configuration fields**: Schema for optional settings and customization
+     * - **Supported auth providers**: Pre-configured OAuth providers available for this source
+     *
+     * Use this endpoint before creating a source connection to understand what
+     * authentication and configuration values are required.
      *
      * @param {string} shortName - Technical identifier of the source type (e.g., 'github', 'stripe', 'slack')
      * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link AirweaveSDK.NotFoundError}
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
      *
      * @example
-     *     await client.sources.get("short_name")
+     *     await client.sources.get("github")
      */
     get(shortName, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__get(shortName, requestOptions));
     }
     __get(shortName, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g;
-            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);
+            var _a, _b, _c;
+            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({}, (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, `sources/${encodeURIComponent(shortName)}`),
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AirweaveSDKEnvironment.Production, `sources/${encodeURIComponent(shortName)}`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -151,8 +172,12 @@ class Sources {
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
+                    case 404:
+                        throw new AirweaveSDK.NotFoundError(_response.error.body, _response.rawResponse);
                     case 422:
                         throw new AirweaveSDK.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new AirweaveSDK.TooManyRequestsError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.AirweaveSDKError({
                             statusCode: _response.error.statusCode,

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

@@ -0,0 +1,231 @@
+/**
+ * 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 Webhooks {
+    interface Options {
+        environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | 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;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+/**
+ * API endpoints for managing webhook subscriptions and messages. Subscribe to events like sync completions to receive real-time notifications at your webhook URL
+ */
+export declare class Webhooks {
+    protected readonly _options: Webhooks.Options;
+    constructor(_options: Webhooks.Options);
+    /**
+     * Retrieve all webhook messages for your organization.
+     *
+     * Webhook messages represent payloads that were sent (or attempted to be sent)
+     * to your subscribed endpoints. Each message contains the event type, payload data,
+     * and delivery status information.
+     *
+     * Use the `event_types` query parameter to filter messages by specific event types,
+     * such as `sync.completed` or `sync.failed`.
+     *
+     * @param {AirweaveSDK.GetMessagesWebhooksMessagesGetRequest} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
+     *
+     * @example
+     *     await client.webhooks.getMessages()
+     */
+    getMessages(request?: AirweaveSDK.GetMessagesWebhooksMessagesGetRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WebhookMessage[]>;
+    private __getMessages;
+    /**
+     * Retrieve a specific webhook message by its ID.
+     *
+     * Returns the full message details including the event type, payload data,
+     * timestamp, and delivery channel information. Use this to inspect the
+     * exact payload that was sent to your webhook endpoints.
+     *
+     * Use `include_attempts=true` to also retrieve delivery attempts for this message,
+     * which include HTTP response codes, response bodies, and timestamps for debugging
+     * delivery failures.
+     *
+     * @param {string} messageId - The unique identifier of the message to retrieve (UUID).
+     * @param {AirweaveSDK.GetMessageWebhooksMessagesMessageIdGetRequest} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.NotFoundError}
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
+     *
+     * @example
+     *     await client.webhooks.getMessage("550e8400-e29b-41d4-a716-446655440000", {
+     *         include_attempts: true
+     *     })
+     */
+    getMessage(messageId: string, request?: AirweaveSDK.GetMessageWebhooksMessagesMessageIdGetRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WebhookMessageWithAttempts>;
+    private __getMessage;
+    /**
+     * List all webhook subscriptions for your organization.
+     *
+     * Returns all configured webhook endpoints, including their URLs, subscribed
+     * event types, and current status (enabled/disabled). Use this to audit
+     * your webhook configuration or find a specific subscription.
+     *
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
+     *
+     * @example
+     *     await client.webhooks.getSubscriptions()
+     */
+    getSubscriptions(requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WebhookSubscription[]>;
+    private __getSubscriptions;
+    /**
+     * Create a new webhook subscription.
+     *
+     * Webhook subscriptions allow you to receive real-time notifications when events
+     * occur in Airweave. When you create a subscription, you specify:
+     *
+     * - **URL**: The HTTPS endpoint where events will be delivered
+     * - **Event Types**: Which events you want to receive (e.g., `sync.completed`, `sync.failed`)
+     * - **Secret** (optional): A custom signing secret for verifying webhook signatures
+     *
+     * After creation, Airweave will send HTTP POST requests to your URL whenever
+     * matching events occur. Each request includes a signature header for verification.
+     *
+     * @param {AirweaveSDK.CreateSubscriptionRequest} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
+     *
+     * @example
+     *     await client.webhooks.createSubscription({
+     *         url: "https://api.mycompany.com/webhooks/airweave",
+     *         event_types: ["sync.completed", "sync.failed"]
+     *     })
+     */
+    createSubscription(request: AirweaveSDK.CreateSubscriptionRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WebhookSubscription>;
+    private __createSubscription;
+    /**
+     * Retrieve a specific webhook subscription with its recent delivery attempts.
+     *
+     * Returns the subscription configuration along with a history of message delivery
+     * attempts. This is useful for debugging delivery issues or verifying that your
+     * endpoint is correctly receiving events.
+     *
+     * Use `include_secret=true` to also retrieve the signing secret for webhook
+     * signature verification. Keep this secret secure.
+     *
+     * @param {string} subscriptionId - The unique identifier of the subscription to retrieve (UUID).
+     * @param {AirweaveSDK.GetSubscriptionWebhooksSubscriptionsSubscriptionIdGetRequest} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.NotFoundError}
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
+     *
+     * @example
+     *     await client.webhooks.getSubscription("550e8400-e29b-41d4-a716-446655440000", {
+     *         include_secret: true
+     *     })
+     */
+    getSubscription(subscriptionId: string, request?: AirweaveSDK.GetSubscriptionWebhooksSubscriptionsSubscriptionIdGetRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WebhookSubscription>;
+    private __getSubscription;
+    /**
+     * Permanently delete a webhook subscription.
+     *
+     * Once deleted, Airweave will stop sending events to this endpoint immediately.
+     * This action cannot be undone. Any pending message deliveries will be cancelled.
+     *
+     * If you want to temporarily stop receiving events, consider disabling the
+     * subscription instead using the PATCH endpoint.
+     *
+     * @param {string} subscriptionId - The unique identifier of the subscription to delete (UUID).
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.NotFoundError}
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
+     *
+     * @example
+     *     await client.webhooks.deleteSubscription("550e8400-e29b-41d4-a716-446655440000")
+     */
+    deleteSubscription(subscriptionId: string, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WebhookSubscription>;
+    private __deleteSubscription;
+    /**
+     * Update an existing webhook subscription.
+     *
+     * Use this endpoint to modify a subscription's configuration. You can:
+     *
+     * - **Change the URL**: Update where events are delivered
+     * - **Update event types**: Modify which events trigger notifications
+     * - **Enable/disable**: Temporarily pause delivery without deleting the subscription
+     * - **Recover messages**: When re-enabling, optionally recover missed messages
+     *
+     * Only include the fields you want to change. Omitted fields will retain their
+     * current values.
+     *
+     * When re-enabling a subscription (`disabled: false`), you can optionally provide
+     * `recover_since` to automatically retry all messages that were generated while
+     * the subscription was disabled.
+     *
+     * @param {string} subscriptionId - The unique identifier of the subscription to update (UUID).
+     * @param {AirweaveSDK.PatchSubscriptionRequest} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.NotFoundError}
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
+     *
+     * @example
+     *     await client.webhooks.patchSubscription("550e8400-e29b-41d4-a716-446655440000")
+     */
+    patchSubscription(subscriptionId: string, request?: AirweaveSDK.PatchSubscriptionRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WebhookSubscription>;
+    private __patchSubscription;
+    /**
+     * Retry failed message deliveries for a webhook subscription.
+     *
+     * Triggers a recovery process that replays all failed messages within the
+     * specified time window. This is useful when:
+     *
+     * - Your endpoint was temporarily down and you want to catch up
+     * - You've fixed a bug in your webhook handler
+     * - You want to reprocess events after re-enabling a disabled subscription
+     *
+     * Messages are retried in chronological order. Successfully delivered messages
+     * are skipped; only failed or pending messages are retried.
+     *
+     * @param {string} subscriptionId - The unique identifier of the subscription to recover messages for (UUID).
+     * @param {AirweaveSDK.RecoverMessagesRequest} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.NotFoundError}
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     * @throws {@link AirweaveSDK.TooManyRequestsError}
+     *
+     * @example
+     *     await client.webhooks.recoverFailedMessages("550e8400-e29b-41d4-a716-446655440000", {
+     *         since: "2024-03-14T00:00:00Z"
+     *     })
+     */
+    recoverFailedMessages(subscriptionId: string, request: AirweaveSDK.RecoverMessagesRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<AirweaveSDK.RecoveryTask>;
+    private __recoverFailedMessages;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}