@airweave/sdk 0.8.85 → 0.8.87

package/dist/cjs/Client.js

@@ -48,8 +48,8 @@ class AirweaveSDKClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@airweave/sdk",
-                "X-Fern-SDK-Version": "v0.8.85",
-                "User-Agent": "@airweave/sdk/v0.8.85",
+                "X-Fern-SDK-Version": "v0.8.87",
+                "User-Agent": "@airweave/sdk/v0.8.87",
                 "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/sourceConnections/client/Client.d.ts

@@ -106,12 +106,21 @@ export declare class SourceConnections {
     /**
      * Permanently delete a source connection and all its synced data.
      *
-     * This operation:
-     * - Removes all entities synced from this source from the vector database
-     * - Cancels any scheduled or running sync jobs
-     * - Deletes the connection configuration and credentials
+     * **What happens when you delete:**
      *
-     * **Warning**: This action cannot be undone. All synced data will be permanently deleted.
+     * 1. Any running sync is cancelled and the API waits (up to 15 s) for the
+     *    worker to stop writing.
+     * 2. The source connection, sync configuration, job history, and entity
+     *    metadata are cascade-deleted from the database.
+     * 3. A background cleanup workflow is scheduled to remove data from the
+     *    vector database (Vespa) and raw data storage (ARF). This may take
+     *    several minutes for large datasets but does **not** block the response.
+     *
+     * The API returns immediately after step 2. Vector database cleanup happens
+     * asynchronously -- the data becomes unsearchable as soon as the database
+     * records are deleted.
+     *
+     * **Warning**: This action cannot be undone.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection to delete (UUID)
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
@@ -182,12 +191,14 @@ export declare class SourceConnections {
      * includes status, timing information, and entity counts.
      *
      * Job statuses:
-     * - **PENDING**: Job is queued and waiting to start
+     * - **PENDING**: Job is queued, waiting for the worker to pick it up
      * - **RUNNING**: Sync is actively pulling and processing data
      * - **COMPLETED**: Sync finished successfully
-     * - **FAILED**: Sync encountered an error
-     * - **CANCELLED**: Sync was manually cancelled
-     * - **CANCELLING**: Cancellation has been requested
+     * - **FAILED**: Sync encountered an unrecoverable error
+     * - **CANCELLING**: Cancellation has been requested. The worker is
+     *   gracefully stopping the pipeline and cleaning up destination data.
+     * - **CANCELLED**: Sync was cancelled. The worker has fully stopped
+     *   and destination data cleanup has been scheduled.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection (UUID)
      * @param {AirweaveSDK.GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest} request
@@ -207,11 +218,19 @@ export declare class SourceConnections {
     /**
      * Request cancellation of a running sync job.
      *
-     * The job will be marked as CANCELLING and the sync workflow will stop at the
-     * next checkpoint. Already-processed entities are retained.
+     * **State lifecycle**: `PENDING` / `RUNNING` → `CANCELLING` → `CANCELLED`
+     *
+     * 1. The API immediately marks the job as **CANCELLING** in the database.
+     * 2. A cancellation signal is sent to the Temporal workflow.
+     * 3. The worker receives the signal, gracefully stops the sync pipeline
+     *    (cancels worker pool, source stream), and marks the job as **CANCELLED**.
+     *
+     * Already-processed entities are retained in the vector database.
+     * If the worker is unresponsive, a background cleanup job will force the
+     * transition to CANCELLED after 3 minutes.
      *
-     * **Note**: Cancellation is asynchronous. The job status will change to CANCELLED
-     * once the workflow has fully stopped.
+     * **Note**: Only jobs in `PENDING` or `RUNNING` state can be cancelled.
+     * Attempting to cancel a `COMPLETED`, `FAILED`, or `CANCELLED` job returns 400.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection (UUID)
      * @param {string} jobId - Unique identifier of the sync job to cancel (UUID)

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

@@ -295,12 +295,21 @@ class SourceConnections {
     /**
      * Permanently delete a source connection and all its synced data.
      *
-     * This operation:
-     * - Removes all entities synced from this source from the vector database
-     * - Cancels any scheduled or running sync jobs
-     * - Deletes the connection configuration and credentials
+     * **What happens when you delete:**
      *
-     * **Warning**: This action cannot be undone. All synced data will be permanently deleted.
+     * 1. Any running sync is cancelled and the API waits (up to 15 s) for the
+     *    worker to stop writing.
+     * 2. The source connection, sync configuration, job history, and entity
+     *    metadata are cascade-deleted from the database.
+     * 3. A background cleanup workflow is scheduled to remove data from the
+     *    vector database (Vespa) and raw data storage (ARF). This may take
+     *    several minutes for large datasets but does **not** block the response.
+     *
+     * The API returns immediately after step 2. Vector database cleanup happens
+     * asynchronously -- the data becomes unsearchable as soon as the database
+     * records are deleted.
+     *
+     * **Warning**: This action cannot be undone.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection to delete (UUID)
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
@@ -531,12 +540,14 @@ class SourceConnections {
      * includes status, timing information, and entity counts.
      *
      * Job statuses:
-     * - **PENDING**: Job is queued and waiting to start
+     * - **PENDING**: Job is queued, waiting for the worker to pick it up
      * - **RUNNING**: Sync is actively pulling and processing data
      * - **COMPLETED**: Sync finished successfully
-     * - **FAILED**: Sync encountered an error
-     * - **CANCELLED**: Sync was manually cancelled
-     * - **CANCELLING**: Cancellation has been requested
+     * - **FAILED**: Sync encountered an unrecoverable error
+     * - **CANCELLING**: Cancellation has been requested. The worker is
+     *   gracefully stopping the pipeline and cleaning up destination data.
+     * - **CANCELLED**: Sync was cancelled. The worker has fully stopped
+     *   and destination data cleanup has been scheduled.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection (UUID)
      * @param {AirweaveSDK.GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest} request
@@ -611,11 +622,19 @@ class SourceConnections {
     /**
      * Request cancellation of a running sync job.
      *
-     * The job will be marked as CANCELLING and the sync workflow will stop at the
-     * next checkpoint. Already-processed entities are retained.
+     * **State lifecycle**: `PENDING` / `RUNNING` → `CANCELLING` → `CANCELLED`
+     *
+     * 1. The API immediately marks the job as **CANCELLING** in the database.
+     * 2. A cancellation signal is sent to the Temporal workflow.
+     * 3. The worker receives the signal, gracefully stops the sync pipeline
+     *    (cancels worker pool, source stream), and marks the job as **CANCELLED**.
+     *
+     * Already-processed entities are retained in the vector database.
+     * If the worker is unresponsive, a background cleanup job will force the
+     * transition to CANCELLED after 3 minutes.
      *
-     * **Note**: Cancellation is asynchronous. The job status will change to CANCELLED
-     * once the workflow has fully stopped.
+     * **Note**: Only jobs in `PENDING` or `RUNNING` state can be cancelled.
+     * Attempting to cancel a `COMPLETED`, `FAILED`, or `CANCELLED` job returns 400.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection (UUID)
      * @param {string} jobId - Unique identifier of the sync job to cancel (UUID)

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "v0.8.85";
+export declare const SDK_VERSION = "v0.8.87";

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.8.85";
+exports.SDK_VERSION = "v0.8.87";

package/dist/esm/Client.mjs

@@ -12,8 +12,8 @@ export class AirweaveSDKClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@airweave/sdk",
-                "X-Fern-SDK-Version": "v0.8.85",
-                "User-Agent": "@airweave/sdk/v0.8.85",
+                "X-Fern-SDK-Version": "v0.8.87",
+                "User-Agent": "@airweave/sdk/v0.8.87",
                 "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/sourceConnections/client/Client.d.mts

@@ -106,12 +106,21 @@ export declare class SourceConnections {
     /**
      * Permanently delete a source connection and all its synced data.
      *
-     * This operation:
-     * - Removes all entities synced from this source from the vector database
-     * - Cancels any scheduled or running sync jobs
-     * - Deletes the connection configuration and credentials
+     * **What happens when you delete:**
      *
-     * **Warning**: This action cannot be undone. All synced data will be permanently deleted.
+     * 1. Any running sync is cancelled and the API waits (up to 15 s) for the
+     *    worker to stop writing.
+     * 2. The source connection, sync configuration, job history, and entity
+     *    metadata are cascade-deleted from the database.
+     * 3. A background cleanup workflow is scheduled to remove data from the
+     *    vector database (Vespa) and raw data storage (ARF). This may take
+     *    several minutes for large datasets but does **not** block the response.
+     *
+     * The API returns immediately after step 2. Vector database cleanup happens
+     * asynchronously -- the data becomes unsearchable as soon as the database
+     * records are deleted.
+     *
+     * **Warning**: This action cannot be undone.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection to delete (UUID)
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
@@ -182,12 +191,14 @@ export declare class SourceConnections {
      * includes status, timing information, and entity counts.
      *
      * Job statuses:
-     * - **PENDING**: Job is queued and waiting to start
+     * - **PENDING**: Job is queued, waiting for the worker to pick it up
      * - **RUNNING**: Sync is actively pulling and processing data
      * - **COMPLETED**: Sync finished successfully
-     * - **FAILED**: Sync encountered an error
-     * - **CANCELLED**: Sync was manually cancelled
-     * - **CANCELLING**: Cancellation has been requested
+     * - **FAILED**: Sync encountered an unrecoverable error
+     * - **CANCELLING**: Cancellation has been requested. The worker is
+     *   gracefully stopping the pipeline and cleaning up destination data.
+     * - **CANCELLED**: Sync was cancelled. The worker has fully stopped
+     *   and destination data cleanup has been scheduled.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection (UUID)
      * @param {AirweaveSDK.GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest} request
@@ -207,11 +218,19 @@ export declare class SourceConnections {
     /**
      * Request cancellation of a running sync job.
      *
-     * The job will be marked as CANCELLING and the sync workflow will stop at the
-     * next checkpoint. Already-processed entities are retained.
+     * **State lifecycle**: `PENDING` / `RUNNING` → `CANCELLING` → `CANCELLED`
+     *
+     * 1. The API immediately marks the job as **CANCELLING** in the database.
+     * 2. A cancellation signal is sent to the Temporal workflow.
+     * 3. The worker receives the signal, gracefully stops the sync pipeline
+     *    (cancels worker pool, source stream), and marks the job as **CANCELLED**.
+     *
+     * Already-processed entities are retained in the vector database.
+     * If the worker is unresponsive, a background cleanup job will force the
+     * transition to CANCELLED after 3 minutes.
      *
-     * **Note**: Cancellation is asynchronous. The job status will change to CANCELLED
-     * once the workflow has fully stopped.
+     * **Note**: Only jobs in `PENDING` or `RUNNING` state can be cancelled.
+     * Attempting to cancel a `COMPLETED`, `FAILED`, or `CANCELLED` job returns 400.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection (UUID)
      * @param {string} jobId - Unique identifier of the sync job to cancel (UUID)

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

@@ -259,12 +259,21 @@ export class SourceConnections {
     /**
      * Permanently delete a source connection and all its synced data.
      *
-     * This operation:
-     * - Removes all entities synced from this source from the vector database
-     * - Cancels any scheduled or running sync jobs
-     * - Deletes the connection configuration and credentials
+     * **What happens when you delete:**
      *
-     * **Warning**: This action cannot be undone. All synced data will be permanently deleted.
+     * 1. Any running sync is cancelled and the API waits (up to 15 s) for the
+     *    worker to stop writing.
+     * 2. The source connection, sync configuration, job history, and entity
+     *    metadata are cascade-deleted from the database.
+     * 3. A background cleanup workflow is scheduled to remove data from the
+     *    vector database (Vespa) and raw data storage (ARF). This may take
+     *    several minutes for large datasets but does **not** block the response.
+     *
+     * The API returns immediately after step 2. Vector database cleanup happens
+     * asynchronously -- the data becomes unsearchable as soon as the database
+     * records are deleted.
+     *
+     * **Warning**: This action cannot be undone.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection to delete (UUID)
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
@@ -495,12 +504,14 @@ export class SourceConnections {
      * includes status, timing information, and entity counts.
      *
      * Job statuses:
-     * - **PENDING**: Job is queued and waiting to start
+     * - **PENDING**: Job is queued, waiting for the worker to pick it up
      * - **RUNNING**: Sync is actively pulling and processing data
      * - **COMPLETED**: Sync finished successfully
-     * - **FAILED**: Sync encountered an error
-     * - **CANCELLED**: Sync was manually cancelled
-     * - **CANCELLING**: Cancellation has been requested
+     * - **FAILED**: Sync encountered an unrecoverable error
+     * - **CANCELLING**: Cancellation has been requested. The worker is
+     *   gracefully stopping the pipeline and cleaning up destination data.
+     * - **CANCELLED**: Sync was cancelled. The worker has fully stopped
+     *   and destination data cleanup has been scheduled.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection (UUID)
      * @param {AirweaveSDK.GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest} request
@@ -575,11 +586,19 @@ export class SourceConnections {
     /**
      * Request cancellation of a running sync job.
      *
-     * The job will be marked as CANCELLING and the sync workflow will stop at the
-     * next checkpoint. Already-processed entities are retained.
+     * **State lifecycle**: `PENDING` / `RUNNING` → `CANCELLING` → `CANCELLED`
+     *
+     * 1. The API immediately marks the job as **CANCELLING** in the database.
+     * 2. A cancellation signal is sent to the Temporal workflow.
+     * 3. The worker receives the signal, gracefully stops the sync pipeline
+     *    (cancels worker pool, source stream), and marks the job as **CANCELLED**.
+     *
+     * Already-processed entities are retained in the vector database.
+     * If the worker is unresponsive, a background cleanup job will force the
+     * transition to CANCELLED after 3 minutes.
      *
-     * **Note**: Cancellation is asynchronous. The job status will change to CANCELLED
-     * once the workflow has fully stopped.
+     * **Note**: Only jobs in `PENDING` or `RUNNING` state can be cancelled.
+     * Attempting to cancel a `COMPLETED`, `FAILED`, or `CANCELLED` job returns 400.
      *
      * @param {string} sourceConnectionId - Unique identifier of the source connection (UUID)
      * @param {string} jobId - Unique identifier of the sync job to cancel (UUID)

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "v0.8.85";
+export declare const SDK_VERSION = "v0.8.87";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "v0.8.85";
+export const SDK_VERSION = "v0.8.87";

package/package.json

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

package/reference.md

@@ -985,13 +985,21 @@ await client.sourceConnections.get("550e8400-e29b-41d4-a716-446655440000");
 
 Permanently delete a source connection and all its synced data.
 
-This operation:
+**What happens when you delete:**
+
+1. Any running sync is cancelled and the API waits (up to 15 s) for the
+   worker to stop writing.
+2. The source connection, sync configuration, job history, and entity
+   metadata are cascade-deleted from the database.
+3. A background cleanup workflow is scheduled to remove data from the
+   vector database (Vespa) and raw data storage (ARF). This may take
+   several minutes for large datasets but does **not** block the response.
 
-- Removes all entities synced from this source from the vector database
-- Cancels any scheduled or running sync jobs
-- Deletes the connection configuration and credentials
+The API returns immediately after step 2. Vector database cleanup happens
+asynchronously -- the data becomes unsearchable as soon as the database
+records are deleted.
 
-**Warning**: This action cannot be undone. All synced data will be permanently deleted.
+**Warning**: This action cannot be undone.
 
 </dd>
 </dl>
@@ -1221,12 +1229,14 @@ includes status, timing information, and entity counts.
 
 Job statuses:
 
-- **PENDING**: Job is queued and waiting to start
+- **PENDING**: Job is queued, waiting for the worker to pick it up
 - **RUNNING**: Sync is actively pulling and processing data
 - **COMPLETED**: Sync finished successfully
-- **FAILED**: Sync encountered an error
-- **CANCELLED**: Sync was manually cancelled
-- **CANCELLING**: Cancellation has been requested
+- **FAILED**: Sync encountered an unrecoverable error
+- **CANCELLING**: Cancellation has been requested. The worker is
+  gracefully stopping the pipeline and cleaning up destination data.
+- **CANCELLED**: Sync was cancelled. The worker has fully stopped
+and destination data cleanup has been scheduled.
   </dd>
   </dl>
   </dd>
@@ -1300,11 +1310,19 @@ await client.sourceConnections.getSourceConnectionJobs("550e8400-e29b-41d4-a716-
 
 Request cancellation of a running sync job.
 
-The job will be marked as CANCELLING and the sync workflow will stop at the
-next checkpoint. Already-processed entities are retained.
+**State lifecycle**: `PENDING` / `RUNNING` → `CANCELLING` → `CANCELLED`
+
+1. The API immediately marks the job as **CANCELLING** in the database.
+2. A cancellation signal is sent to the Temporal workflow.
+3. The worker receives the signal, gracefully stops the sync pipeline
+   (cancels worker pool, source stream), and marks the job as **CANCELLED**.
+
+Already-processed entities are retained in the vector database.
+If the worker is unresponsive, a background cleanup job will force the
+transition to CANCELLED after 3 minutes.
 
-**Note**: Cancellation is asynchronous. The job status will change to CANCELLED
-once the workflow has fully stopped.
+**Note**: Only jobs in `PENDING` or `RUNNING` state can be cancelled.
+Attempting to cancel a `COMPLETED`, `FAILED`, or `CANCELLED` job returns 400.
 
 </dd>
 </dl>