@airweave/sdk 0.7.20 → 0.8.76

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

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.js";

package/dist/cjs/api/resources/webhooks/client/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./requests/index.js"), exports);

package/dist/cjs/api/resources/webhooks/client/requests/CreateSubscriptionRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         url: "https://api.mycompany.com/webhooks/airweave",
+ *         event_types: ["sync.completed", "sync.failed"]
+ *     }
+ */
+export interface CreateSubscriptionRequest {
+    /** The HTTPS URL where webhook events will be delivered. Must be a publicly accessible endpoint that returns a 2xx status code. */
+    url: string;
+    /** List of event types to subscribe to. Events not in this list will not be delivered to this subscription. Available types: `sync.pending`, `sync.running`, `sync.completed`, `sync.failed`, `sync.cancelled`. */
+    event_types: AirweaveSDK.EventType[];
+    /** Optional custom signing secret for webhook signature verification. If not provided, a secure secret will be auto-generated. Must be at least 24 characters if specified. */
+    secret?: string;
+}

package/dist/cjs/api/resources/webhooks/client/requests/GetMessageWebhooksMessagesMessageIdGetRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         include_attempts: true
+ *     }
+ */
+export interface GetMessageWebhooksMessagesMessageIdGetRequest {
+    /** Include delivery attempts for this message. Each attempt includes the HTTP response code, response body, and timestamp. */
+    include_attempts?: boolean;
+}

package/dist/cjs/api/resources/webhooks/client/requests/GetMessagesWebhooksMessagesGetRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface GetMessagesWebhooksMessagesGetRequest {
+    /** Filter messages by event type(s). Accepts multiple values, e.g., `?event_types=sync.completed&event_types=sync.failed`. */
+    event_types?: string | string[];
+}

package/dist/cjs/api/resources/webhooks/client/requests/GetSubscriptionWebhooksSubscriptionsSubscriptionIdGetRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         include_secret: true
+ *     }
+ */
+export interface GetSubscriptionWebhooksSubscriptionsSubscriptionIdGetRequest {
+    /** Include the signing secret for webhook signature verification. Keep this secret secure and use it to verify the 'svix-signature' header. */
+    include_secret?: boolean;
+}

package/dist/cjs/api/resources/webhooks/client/requests/PatchSubscriptionRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../../../../index.js";
+/**
+ * @example
+ *     {}
+ */
+export interface PatchSubscriptionRequest {
+    /** New URL for webhook delivery. Must be a publicly accessible HTTPS endpoint. */
+    url?: string;
+    /** New list of event types to subscribe to. This replaces the existing list entirely. */
+    event_types?: AirweaveSDK.EventType[];
+    /** Set to `true` to pause delivery to this subscription, or `false` to resume. Disabled subscriptions will not receive events. */
+    disabled?: boolean;
+    /** When re-enabling a subscription (`disabled: false`), optionally recover failed messages from this timestamp. Only applies when enabling. */
+    recover_since?: string;
+}

package/dist/cjs/api/resources/webhooks/client/requests/RecoverMessagesRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         since: "2024-03-14T00:00:00Z"
+ *     }
+ */
+export interface RecoverMessagesRequest {
+    /** Start of the recovery time window (inclusive). All failed messages from this time onward will be retried. */
+    since: string;
+    /** End of the recovery time window (exclusive). If not specified, recovers all failed messages up to now. */
+    until?: string;
+}

package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts

@@ -0,0 +1,6 @@
+export { type GetMessagesWebhooksMessagesGetRequest } from "./GetMessagesWebhooksMessagesGetRequest.js";
+export { type GetMessageWebhooksMessagesMessageIdGetRequest } from "./GetMessageWebhooksMessagesMessageIdGetRequest.js";
+export { type CreateSubscriptionRequest } from "./CreateSubscriptionRequest.js";
+export { type GetSubscriptionWebhooksSubscriptionsSubscriptionIdGetRequest } from "./GetSubscriptionWebhooksSubscriptionsSubscriptionIdGetRequest.js";
+export { type PatchSubscriptionRequest } from "./PatchSubscriptionRequest.js";
+export { type RecoverMessagesRequest } from "./RecoverMessagesRequest.js";

package/dist/cjs/api/resources/webhooks/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/webhooks/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/cjs/api/resources/webhooks/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/types/AdminSearchDestination.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Destination options for admin search.
+ */
+export type AdminSearchDestination = "qdrant" | "vespa";
+export declare const AdminSearchDestination: {
+    readonly Qdrant: "qdrant";
+    readonly Vespa: "vespa";
+};

package/dist/cjs/api/types/AdminSearchDestination.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminSearchDestination = void 0;
+exports.AdminSearchDestination = {
+    Qdrant: "qdrant",
+    Vespa: "vespa",
+};

package/dist/cjs/api/types/{SyncWithSourceConnection.d.ts → AdminSyncInfo.d.ts}

@@ -3,9 +3,9 @@
  */
 import * as AirweaveSDK from "../index.js";
 /**
- * Schema for Sync with source connection.
+ * Extended sync info for admin listing with entity counts and status.
  */
-export interface SyncWithSourceConnection {
+export interface AdminSyncInfo {
     name: string;
     source_connection_id: string;
     destination_connection_ids: string[];
@@ -15,6 +15,7 @@ export interface SyncWithSourceConnection {
     temporal_schedule_id?: string;
     sync_type?: string;
     sync_metadata?: Record<string, unknown>;
+    sync_config?: AirweaveSDK.SyncConfig;
     status: AirweaveSDK.SyncStatus;
     id: string;
     organization_id: string;
@@ -22,5 +23,15 @@ export interface SyncWithSourceConnection {
     modified_at: string;
     created_by_email?: string;
     modified_by_email?: string;
-    source_connection?: AirweaveSDK.Connection;
+    total_entity_count?: number;
+    total_arf_entity_count?: number;
+    total_qdrant_entity_count?: number;
+    total_vespa_entity_count?: number;
+    last_job_status?: string;
+    last_job_at?: string;
+    last_job_error?: string;
+    all_tags?: string[];
+    source_short_name?: string;
+    source_is_authenticated?: boolean;
+    readable_collection_id?: string;
 }

package/dist/cjs/api/types/BehaviorConfig.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Miscellaneous execution behavior flags.
+ */
+export interface BehaviorConfig {
+    /** Force INSERT for all entities */
+    skip_hash_comparison?: boolean;
+    /** Replay from ARF storage instead of calling source */
+    replay_from_arf?: boolean;
+    /** Skip usage guardrails (entity count checks) */
+    skip_guardrails?: boolean;
+}

package/dist/cjs/api/types/BodyResyncWithExecutionConfigAdminResyncSyncIdPost.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+export interface BodyResyncWithExecutionConfigAdminResyncSyncIdPost {
+    /** Optional nested SyncConfig for sync behavior (destinations, handlers, cursor, behavior) */
+    execution_config?: AirweaveSDK.SyncConfig;
+    /** Optional tags for filtering and organizing sync jobs (e.g., ['vespa-backfill-01-22-2026', 'manual']) */
+    tags?: string[];
+}

package/dist/cjs/api/types/Collection.d.ts

@@ -15,10 +15,12 @@ export interface Collection {
     readable_id: string;
     /** Unique system identifier for the collection. This UUID is generated automatically and used for internal references. */
     id: string;
-    /** Vector dimensions used by this collection. Determines which embedding model is used: 3072 (text-embedding-3-large), 1536 (text-embedding-3-small), or 384 (MiniLM-L6-v2). */
+    /** Vector dimensions used by this collection. Determines which embedding model is used: 3072 (text-embedding-3-large), 1536 (text-embedding-3-small), 1024 (mistral-embed), or 384 (MiniLM-L6-v2). */
     vector_size: number;
-    /** Name of the embedding model used for this collection (e.g., 'text-embedding-3-large', 'text-embedding-3-small'). This ensures queries use the same model as the indexed data. */
+    /** Name of the embedding model used for this collection (e.g., 'text-embedding-3-large', 'text-embedding-3-small', 'mistral-embed'). This ensures queries use the same model as the indexed data. */
     embedding_model_name: string;
+    /** Default sync configuration for all syncs in this collection. Overridable at sync and job level. */
+    sync_config?: AirweaveSDK.SyncConfig;
     /** Timestamp when the collection was created (ISO 8601 format). */
     created_at: string;
     /** Timestamp when the collection was last modified (ISO 8601 format). */

package/dist/cjs/api/types/ConfigField.d.ts

@@ -11,4 +11,6 @@ export interface ConfigField {
     type: string;
     required?: boolean;
     items_type?: string;
+    feature_flag?: string;
+    is_secret?: boolean;
 }

package/dist/cjs/api/types/ConflictErrorResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response returned when a resource conflict occurs (HTTP 409).
+ *
+ * This typically occurs when attempting to create a resource that already exists,
+ * or when an operation cannot be completed due to the current state of a resource.
+ */
+export interface ConflictErrorResponse {
+    /** Error message describing the conflict */
+    detail: string;
+}

package/dist/cjs/api/types/CursorConfig.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Controls incremental sync cursor behavior.
+ */
+export interface CursorConfig {
+    /** Don't load cursor (fetch all entities) */
+    skip_load?: boolean;
+    /** Don't persist cursor progress */
+    skip_updates?: boolean;
+}

package/dist/cjs/api/types/DeliveryAttempt.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A delivery attempt for a webhook message.
+ *
+ * Each time Airweave attempts to deliver a message to your webhook endpoint,
+ * a delivery attempt is recorded. Failed attempts are automatically retried
+ * with exponential backoff.
+ */
+export interface DeliveryAttempt {
+    /** Unique identifier for this delivery attempt */
+    id: string;
+    /** The event message that was being delivered */
+    message_id: string;
+    /** The subscription endpoint this was delivered to */
+    endpoint_id: string;
+    /** The response body returned by your webhook endpoint (truncated to 1KB) */
+    response?: string;
+    /** HTTP status code returned by your webhook endpoint. 2xx codes indicate success; other codes trigger retries. */
+    response_status_code: number;
+    /** Delivery status: `success` (2xx response), `pending` (awaiting delivery), or `failed` (non-2xx response or timeout) */
+    status: string;
+    /** When this delivery attempt occurred (ISO 8601 format, UTC) */
+    timestamp: string;
+    /** The URL that was called */
+    url?: string;
+}

package/dist/cjs/api/types/DestinationConfig.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Controls where entities are written.
+ */
+export interface DestinationConfig {
+    /** Skip writing to native Qdrant */
+    skip_qdrant?: boolean;
+    /** Skip writing to native Vespa */
+    skip_vespa?: boolean;
+    /** If set, ONLY write to these destination UUIDs */
+    target_destinations?: string[];
+    /** Skip these destination UUIDs */
+    exclude_destinations?: string[];
+}

package/dist/cjs/api/types/EventType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Webhook event types.
+ */
+export type EventType = "sync.pending" | "sync.running" | "sync.completed" | "sync.failed" | "sync.cancelled";
+export declare const EventType: {
+    readonly SyncPending: "sync.pending";
+    readonly SyncRunning: "sync.running";
+    readonly SyncCompleted: "sync.completed";
+    readonly SyncFailed: "sync.failed";
+    readonly SyncCancelled: "sync.cancelled";
+};

package/dist/cjs/api/types/EventType.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventType = void 0;
+exports.EventType = {
+    SyncPending: "sync.pending",
+    SyncRunning: "sync.running",
+    SyncCompleted: "sync.completed",
+    SyncFailed: "sync.failed",
+    SyncCancelled: "sync.cancelled",
+};

package/dist/cjs/api/types/FeatureFlag.d.ts

@@ -6,9 +6,12 @@
  *
  * Add new flags here to enable feature gating at the organization level.
  */
-export type FeatureFlag = "s3_destination" | "priority_support" | "source_rate_limiting";
+export type FeatureFlag = "s3_destination" | "priority_support" | "source_rate_limiting" | "zephyr_scale" | "sharepoint_2019_v2" | "api_key_admin_sync";
 export declare const FeatureFlag: {
     readonly S3Destination: "s3_destination";
     readonly PrioritySupport: "priority_support";
     readonly SourceRateLimiting: "source_rate_limiting";
+    readonly ZephyrScale: "zephyr_scale";
+    readonly Sharepoint2019V2: "sharepoint_2019_v2";
+    readonly ApiKeyAdminSync: "api_key_admin_sync";
 };

package/dist/cjs/api/types/FeatureFlag.js

@@ -8,4 +8,7 @@ exports.FeatureFlag = {
     S3Destination: "s3_destination",
     PrioritySupport: "priority_support",
     SourceRateLimiting: "source_rate_limiting",
+    ZephyrScale: "zephyr_scale",
+    Sharepoint2019V2: "sharepoint_2019_v2",
+    ApiKeyAdminSync: "api_key_admin_sync",
 };

package/dist/cjs/api/types/HandlerConfig.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Controls which handlers run during sync.
+ */
+export interface HandlerConfig {
+    /** Enable VectorDBHandler */
+    enable_vector_handlers?: boolean;
+    /** Enable RawDataHandler (ARF) */
+    enable_raw_data_handler?: boolean;
+    /** Enable EntityPostgresHandler */
+    enable_postgres_handler?: boolean;
+}

package/dist/cjs/api/types/LegacySearchRequest.d.ts

@@ -8,8 +8,8 @@ import * as AirweaveSDK from "../index.js";
 export interface LegacySearchRequest {
     /** The search query text (max 2048 tokens) */
     query: string;
-    /** Qdrant native filter for metadata-based filtering */
-    filter?: AirweaveSDK.Filter;
+    /** Filter for metadata-based filtering */
+    filter?: Record<string, unknown>;
     /** Number of results to skip */
     offset?: number;
     /** Maximum number of results */

package/dist/cjs/api/types/NotFoundErrorResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response returned when a resource is not found (HTTP 404).
+ */
+export interface NotFoundErrorResponse {
+    /** Error message describing what was not found */
+    detail: string;
+}

package/dist/cjs/api/types/RateLimitErrorResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response returned when rate limit is exceeded (HTTP 429).
+ *
+ * The API enforces rate limits to ensure fair usage. When exceeded,
+ * wait for the duration specified in the Retry-After header before retrying.
+ */
+export interface RateLimitErrorResponse {
+    /** Error message explaining the rate limit */
+    detail: string;
+}

package/dist/cjs/api/types/RecoveryTask.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Information about a message recovery task.
+ *
+ * When you trigger a recovery of failed messages, this object is returned
+ * to track the recovery progress. The status indicates whether the recovery
+ * is still in progress or has completed.
+ */
+export interface RecoveryTask {
+    /** Unique identifier for this recovery task (Svix internal ID) */
+    id: string;
+    /** Recovery task status: 'running' or 'completed' */
+    status: string;
+}

package/dist/cjs/api/types/S3ConfigRequest.d.ts

@@ -2,21 +2,17 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * Request to configure S3 destination.
+ * Request to configure S3 destination with IAM role.
  */
 export interface S3ConfigRequest {
-    /** AWS access key ID */
-    aws_access_key_id: string;
-    /** AWS secret access key */
-    aws_secret_access_key: string;
+    /** IAM Role ARN to assume (e.g., arn:aws:iam::123456789012:role/airweave-writer) */
+    role_arn: string;
+    /** External ID for secure cross-account trust policy */
+    external_id: string;
     /** S3 bucket name */
     bucket_name: string;
     /** Prefix for Airweave data */
     bucket_prefix?: string;
     /** AWS region */
     aws_region?: string;
-    /** Custom S3 endpoint */
-    endpoint_url?: string;
-    /** Use SSL/TLS */
-    use_ssl?: boolean;
 }

package/dist/cjs/api/types/SearchRequest.d.ts

@@ -3,27 +3,30 @@
  */
 import * as AirweaveSDK from "../index.js";
 /**
- * Search request schema.
+ * Search request for querying a collection.
+ *
+ * Provides fine-grained control over the search pipeline including retrieval strategy,
+ * filtering, and AI-powered features like query expansion and answer generation.
  */
 export interface SearchRequest {
-    /** The search query text */
+    /** The search query text (required, max 2048 tokens) */
     query: string;
-    /** The retrieval strategy to use */
+    /** Search strategy: 'hybrid' (default), 'neural' (semantic only), or 'keyword' (BM25 only) */
     retrieval_strategy?: AirweaveSDK.RetrievalStrategy;
-    /** Qdrant native filter for metadata-based filtering */
-    filter?: AirweaveSDK.Filter;
-    /** Number of results to skip */
+    /** Structured filter for metadata-based filtering (Qdrant filter format) */
+    filter?: Record<string, unknown>;
+    /** Number of results to skip for pagination (default: 0) */
     offset?: number;
-    /** Maximum number of results to return */
+    /** Maximum number of results to return (default: 1000) */
     limit?: number;
-    /** Weight recent content higher than older content; 0 = no recency effect, 1 = only recent items matter */
+    /** Weight recent content higher than older content; 0 = no recency effect, 1 = only recent items matter. NOTE: This feature is currently under construction and will be ignored. */
     temporal_relevance?: number;
-    /** Generate a few query variations to improve recall */
+    /** Generate query variations to improve recall (default: true) */
     expand_query?: boolean;
-    /** Extract structured filters from natural-language query */
+    /** Extract structured filters from natural language (e.g., 'from last week' becomes a date filter) */
     interpret_filters?: boolean;
-    /** Reorder the top candidate results for improved relevance. Max number of results that can be reranked is capped to around 1000. */
+    /** LLM-based reranking for improved relevance (default: true) */
     rerank?: boolean;
-    /** Generate a natural-language answer to the query */
+    /** Generate an AI answer based on search results (default: true) */
     generate_answer?: boolean;
 }

package/dist/cjs/api/types/SearchResponse.d.ts

@@ -2,11 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * Comprehensive search response containing results and metadata.
+ * Search response containing results and optional AI-generated completion.
+ *
+ * Each result includes the matched entity's content, metadata, relevance score,
+ * and source information.
  */
 export interface SearchResponse {
-    /** Array of search result objects containing the found documents, records, or data entities. */
+    /** Array of search result objects containing the found documents, records, or data entities. Each result includes entity_id, source_name, md_content, metadata, score, breadcrumbs, and url. */
     results: Record<string, unknown>[];
-    /** This provides natural language answers to your query based on the content found across your connected data sources when generate_answer is true. */
+    /** AI-generated natural language answer to your query based on the search results. Only included when generate_answer is true in the request. */
     completion?: string;
 }

package/dist/cjs/api/types/Source.d.ts

@@ -34,8 +34,12 @@ export interface Source {
     federated_search?: boolean;
     /** Whether this source's entities have timestamps that enable recency-based ranking. Sources without file-level timestamps (e.g., code repositories) cannot use temporal relevance for search result weighting. */
     supports_temporal_relevance?: boolean;
+    /** Whether this source supports document-level access control. Sources with this capability extract ACL information from the source and apply it during search to filter results based on user permissions. */
+    supports_access_control?: boolean;
     /** Rate limiting level for this source: 'org' (organization-wide), 'connection' (per-connection/per-user), or None (no rate limiting). */
     rate_limit_level?: string;
+    /** Feature flag required to access this source. If set, only organizations with this feature enabled can see/use this source. */
+    feature_flag?: string;
     /** Unique system identifier for this source type. Generated automatically when the source is registered. */
     id: string;
     /** Timestamp when this source type was registered in the system (ISO 8601 format). */

package/dist/cjs/api/types/SourceConnection.d.ts

@@ -3,24 +3,40 @@
  */
 import * as AirweaveSDK from "../index.js";
 /**
- * Complete source connection details.
+ * Complete source connection details including auth, config, sync status, and entities.
+ *
+ * This schema provides full information about a source connection, suitable for
+ * detail views and monitoring sync progress.
  */
 export interface SourceConnection {
+    /** Unique identifier of the source connection */
     id: string;
+    /** Display name of the connection */
     name: string;
+    /** Optional description of the connection's purpose */
     description?: string;
+    /** Source type identifier */
     short_name: string;
+    /** Collection this connection belongs to */
     readable_collection_id: string;
+    /** Current operational status of the connection */
     status: AirweaveSDK.SourceConnectionStatus;
+    /** When the connection was created (ISO 8601) */
     created_at: string;
+    /** When the connection was last modified (ISO 8601) */
     modified_at: string;
+    /** Authentication status and details */
     auth: AirweaveSDK.AuthenticationDetails;
+    /** Source-specific configuration values */
     config?: Record<string, unknown>;
+    /** Sync schedule configuration */
     schedule?: AirweaveSDK.ScheduleDetails;
+    /** Sync execution history and statistics */
     sync?: AirweaveSDK.SyncDetails;
-    /** ID of the associated sync */
+    /** ID of the associated sync (internal use) */
     sync_id?: string;
+    /** Summary of synced entities by type */
     entities?: AirweaveSDK.EntitySummary;
-    /** Whether this source uses federated search */
+    /** Whether this source uses federated (real-time) search instead of syncing */
     federated_search?: boolean;
 }