@airweave/sdk 0.1.45 → 0.1.48

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Create class for integration credentials with raw auth fields.
+ *
+ * This schema is used when auth fields need to be validated and encrypted
+ * before creating the credential.
+ */
+export interface IntegrationCredentialRawCreate {
+    name: string;
+    integration_short_name: string;
+    description?: string;
+    integration_type: AirweaveSDK.IntegrationType;
+    auth_type: AirweaveSDK.AuthType;
+    auth_config_class?: string;
+    auth_fields: Record<string, unknown>;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for creating an invitation.
+ */
+export interface InvitationCreate {
+    email: string;
+    role?: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for invitation responses.
+ */
+export interface InvitationResponse {
+    id: string;
+    email: string;
+    role: string;
+    status: string;
+    invited_at?: string;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Select points with empty payload for a specified field
+ */
+export interface IsEmptyCondition {
+    /** Select points with empty payload for a specified field */
+    is_empty: AirweaveSDK.PayloadField;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Select points with null payload for a specified field
+ */
+export interface IsNullCondition {
+    /** Select points with null payload for a specified field */
+    is_null: AirweaveSDK.PayloadField;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Exact match on any of the given values
+ */
+export interface MatchAny {
+    /** Exact match on any of the given values */
+    any: MatchAny.Any;
+}
+export declare namespace MatchAny {
+    /**
+     * Exact match on any of the given values
+     */
+    type Any = string[] | number[];
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Should have at least one value not matching the any given values
+ */
+export interface MatchExcept {
+    /** Should have at least one value not matching the any given values */
+    except: MatchExcept.Except;
+}
+export declare namespace MatchExcept {
+    /**
+     * Should have at least one value not matching the any given values
+     */
+    type Except = string[] | number[];
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Full-text match of the strings.
+ */
+export interface MatchText {
+    /** Full-text match of the strings. */
+    text: string;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Exact match of the given value
+ */
+export interface MatchValue {
+    /** Exact match of the given value */
+    value: MatchValue.Value;
+}
+export declare namespace MatchValue {
+    /**
+     * Exact match of the given value
+     */
+    type Value = boolean | number | string;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Schema for organization member responses.
+ */
+export interface MemberResponse {
+    id: string;
+    email: string;
+    name: string;
+    role: string;
+    status?: string;
+    is_primary?: boolean;
+    auth0_id?: string;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+export interface MinShould {
+    /** */
+    conditions: MinShould.Conditions.Item[];
+    /** */
+    min_count: number;
+}
+export declare namespace MinShould {
+    type Conditions = Conditions.Item[];
+    namespace Conditions {
+        type Item = AirweaveSDK.FieldCondition | AirweaveSDK.IsEmptyCondition | AirweaveSDK.IsNullCondition | AirweaveSDK.HasIdCondition | AirweaveSDK.HasVectorCondition | AirweaveSDK.NestedCondition | AirweaveSDK.Filter;
+    }
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Select points with payload for a specified nested field
+ */
+export interface Nested {
+    /** Select points with payload for a specified nested field */
+    key: string;
+    /** Select points with payload for a specified nested field */
+    filter: AirweaveSDK.Filter;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+export interface NestedCondition {
+    /** */
+    nested: AirweaveSDK.Nested;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * OAuth2 authorization URL schema.
+ *
+ * Attributes:
+ * ----------
+ *     url (str): The authorization URL.
+ */
+export interface OAuth2AuthUrl {
+    url: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Organization schema.
+ */
+export interface Organization {
+    name: string;
+    description?: string;
+    auth0_org_id?: string;
+    id: string;
+    created_at: string;
+    modified_at: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Organization creation schema.
+ */
+export interface OrganizationCreate {
+    /** Organization name */
+    name: string;
+    /** Organization description */
+    description?: string;
+    /** Auth0 organization ID */
+    auth0_org_id?: string;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Organization schema with user's role information.
+ */
+export interface OrganizationWithRole {
+    id: string;
+    name: string;
+    description?: string;
+    created_at: string;
+    modified_at: string;
+    role: string;
+    is_primary: boolean;
+    auth0_org_id?: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Payload field
+ */
+export interface PayloadField {
+    /** Payload field name */
+    key: string;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Query expansion strategies for search.
+ */
+export type QueryExpansionStrategy = "auto" | "llm" | "no_expansion";
+export declare const QueryExpansionStrategy: {
+    readonly Auto: "auto";
+    readonly Llm: "llm";
+    readonly NoExpansion: "no_expansion";
+};

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

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryExpansionStrategy = void 0;
+exports.QueryExpansionStrategy = {
+    Auto: "auto",
+    Llm: "llm",
+    NoExpansion: "no_expansion",
+};

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Range filter request
+ */
+export interface Range {
+    /** point.key < range.lt */
+    lt?: number;
+    /** point.key > range.gt */
+    gt?: number;
+    /** point.key >= range.gte */
+    gte?: number;
+    /** point.key <= range.lte */
+    lte?: number;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response format options for search results.
+ */
+export type ResponseType = "raw" | "completion";
+export declare const ResponseType: {
+    readonly Raw: "raw";
+    readonly Completion: "completion";
+};

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

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Comprehensive search request encapsulating all search parameters.
+ */
+export interface SearchRequest {
+    /** The search query text */
+    query: string;
+    /** Qdrant native filter for metadata-based filtering */
+    filter?: AirweaveSDK.Filter;
+    /** Number of results to skip */
+    offset?: number;
+    /** Maximum number of results to return */
+    limit?: number;
+    /** Minimum similarity score threshold */
+    score_threshold?: number;
+    /** Whether to summarize results */
+    summarize?: boolean;
+    /** Type of response (raw or completion) */
+    response_type?: AirweaveSDK.ResponseType;
+    /** Query expansion strategy */
+    expansion_strategy?: AirweaveSDK.QueryExpansionStrategy;
+    /** Whether to include metadata in results */
+    include_metadata?: boolean;
+    /** Whether to include vectors in response */
+    with_vectors?: boolean;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Comprehensive search response containing results and metadata.
+ */
+export interface SearchResponse {
+    /** Array of search result objects containing the found documents, records, or data entities. */
+    results: Record<string, unknown>[];
+    /** Indicates whether results are raw search matches or AI-generated completions based on the found content. */
+    response_type: AirweaveSDK.ResponseType;
+    /** AI-generated natural language answer when response_type is 'completion'. This provides natural language answers to your query based on the content found across your connected data sources. */
+    completion?: string;
+    /** Status of the search operation indicating the quality and availability of results:<br/>• **success**: Search found relevant results matching your query<br/>• **no_relevant_results**: Search completed but found no sufficiently relevant matches<br/>• **no_results**: Search found no results at all, possibly indicating empty collections or very specific queries */
+    status: AirweaveSDK.SearchStatus;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Status indicators for search operation outcomes.
+ */
+export type SearchStatus = "success" | "no_relevant_results" | "no_results";
+export declare const SearchStatus: {
+    readonly Success: "success";
+    readonly NoRelevantResults: "no_relevant_results";
+    readonly NoResults: "no_results";
+};

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

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Complete source representation with authentication and configuration schemas.
+ */
+export interface Source {
+    /** Human-readable name of the data source connector (e.g., 'GitHub', 'Stripe', 'PostgreSQL'). */
+    name: string;
+    /** Detailed description explaining what data this source can extract and its typical use cases. */
+    description?: string;
+    /** Type of authentication mechanism required by this source (e.g., 'oauth2'). */
+    auth_type?: AirweaveSDK.AuthType;
+    /** Python class name that defines the authentication configuration fields required for this source. */
+    auth_config_class: string;
+    /** Python class name that defines the source-specific configuration options and parameters. */
+    config_class: string;
+    /** Technical identifier used internally to reference this source type. Must be unique across all sources. */
+    short_name: string;
+    /** Python class name of the source implementation that handles data extraction logic. */
+    class_name: string;
+    /** List of entity definition IDs that this source can produce. Defines the data schema and structure that this connector outputs. */
+    output_entity_definition_ids?: string[];
+    /** Organization identifier for custom source connectors. System sources have this set to null. */
+    organization_id?: string;
+    /** Categorization tags to help users discover and filter sources by domain or use case. */
+    labels?: 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). */
+    created_at: string;
+    /** Timestamp when this source type was last updated (ISO 8601 format). */
+    modified_at: string;
+    /** Schema definition for authentication fields required to connect to this source. Describes field types, validation rules, and user interface hints. */
+    auth_fields: AirweaveSDK.Fields;
+    /** Schema definition for configuration fields required to customize this source. Describes field types, validation rules, and user interface hints. */
+    config_fields: AirweaveSDK.Fields;
+}

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

@@ -0,0 +1,61 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Complete source connection representation returned by the API.
+ */
+export interface SourceConnection {
+    /** Human-readable display name for the source connection. This helps you identify the connection in the UI and should clearly describe what data it connects to (e.g., 'Production Stripe Account', 'Customer Support Database'). */
+    name: string;
+    /** Optional additional context about the data this connection provides. Use this to document the purpose, data types, or any special considerations for this connection. */
+    description?: string;
+    /** Source-specific configuration options that control data retrieval behavior. These vary by source type and control how data is retrieved (e.g., database queries, API filters, file paths). Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
+    config_fields?: AirweaveSDK.ConfigValues;
+    /** Technical identifier of the source type (e.g., 'github', 'stripe', 'postgresql', 'slack'). This determines which connector Airweave uses to sync data. */
+    short_name: string;
+    /** Identifier for custom OAuth integrations. Only present for connections created through white label OAuth flows. */
+    white_label_id?: string;
+    /** Unique system identifier for this source connection. This UUID is generated automatically and used for API operations. */
+    id: string;
+    /** Internal identifier for the sync configuration associated with this source connection. Managed automatically by the system. */
+    sync_id?: string;
+    /** Identifier of the organization that owns this source connection. Source connections are isolated per organization. */
+    organization_id: string;
+    /** Timestamp when the source connection was created (ISO 8601 format). */
+    created_at: string;
+    /** Timestamp when the source connection was last modified (ISO 8601 format). */
+    modified_at: string;
+    /** Internal identifier for the underlying connection object that manages authentication and configuration. */
+    connection_id?: string;
+    /** Readable ID of the collection where this source connection syncs its data. This creates the link between your data source and searchable content. */
+    collection: string;
+    /** Email address of the user who created this source connection. */
+    created_by_email?: string;
+    /** Email address of the user who last modified this source connection. */
+    modified_by_email?: string;
+    /** Authentication credentials for the data source. Returns '********' by default for security. */
+    auth_fields?: SourceConnection.AuthFields;
+    /** Current operational status of the source connection:<br/>• **active**: Connection is healthy and ready for data synchronization<br/>• **in_progress**: Currently syncing data from the source<br/>• **failing**: Recent sync attempts have failed and require attention */
+    status?: AirweaveSDK.SourceConnectionStatus;
+    /** Status of the most recent data synchronization job:<br/>• **completed**: Last sync finished successfully<br/>• **failed**: Last sync encountered errors<br/>• **in_progress**: Currently running a sync job<br/>• **pending**: Sync job is queued and waiting to start */
+    latest_sync_job_status?: AirweaveSDK.SyncJobStatus;
+    /** Unique identifier of the most recent sync job. Use this to track sync progress or retrieve detailed job information. */
+    latest_sync_job_id?: string;
+    /** Timestamp when the most recent sync job started (ISO 8601 format). */
+    latest_sync_job_started_at?: string;
+    /** Timestamp when the most recent sync job completed (ISO 8601 format). Null if the job is still running or failed. */
+    latest_sync_job_completed_at?: string;
+    /** Error message from the most recent sync job if it failed. Use this to diagnose and resolve sync issues. */
+    latest_sync_job_error?: string;
+    /** Cron expression defining when automatic data synchronization occurs. Null if automatic syncing is disabled and syncs must be triggered manually. */
+    cron_schedule?: string;
+    /** Timestamp when the next automatic sync is scheduled to run (ISO 8601 format). Null if no automatic schedule is configured. */
+    next_scheduled_run?: string;
+}
+export declare namespace SourceConnection {
+    /**
+     * Authentication credentials for the data source. Returns '********' by default for security.
+     */
+    type AuthFields = AirweaveSDK.ConfigValues | string;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for creating a source connection with pre-existing credentials (internal use).
+ */
+export interface SourceConnectionCreateWithCredential {
+    /** Human-readable name for the source connection. This helps you identify the connection in the UI and should clearly describe what data it connects to. */
+    name: string;
+    /** Optional detailed description of what this source connection provides. Use this to document the purpose, data types, or any special considerations for this connection. */
+    description?: string;
+    /** Source-specific configuration parameters required for data extraction. These vary by source type and control how data is retrieved (e.g., database queries, API filters, file paths). Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
+    config_fields?: AirweaveSDK.ConfigValues;
+    /** Technical identifier of the source type that determines which connector to use for data synchronization. */
+    short_name: string;
+    /** Readable ID of the collection where synced data will be stored. */
+    collection?: string;
+    /** Cron expression for automatic data synchronization schedule. */
+    cron_schedule?: string;
+    /** ID of the existing integration credential to use for authentication. This credential must already exist and be associated with the same source type. */
+    credential_id: string;
+    /** Whether to start an initial data synchronization immediately after creating the connection. */
+    sync_immediately?: boolean;
+}

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

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for creating a source connection through white label OAuth integrations.
+ */
+export interface SourceConnectionCreateWithWhiteLabel {
+    /** Human-readable name for the source connection. This helps you identify the connection in the UI and should clearly describe what data it connects to. */
+    name: string;
+    /** Optional detailed description of what this source connection provides. Use this to document the purpose, data types, or any special considerations for this connection. */
+    description?: string;
+    /** Source-specific configuration parameters required for data extraction. These vary by source type and control how data is retrieved (e.g., database queries, API filters, file paths). Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
+    config_fields?: AirweaveSDK.ConfigValues;
+    /** Technical identifier of the source type that determines which connector to use for data synchronization. */
+    short_name: string;
+    /** Readable ID of the collection where synced data will be stored. If not provided, a new collection will be automatically created. */
+    collection?: string;
+    /** Cron expression for automatic data synchronization schedule. Uses standard cron format: minute hour day month weekday. */
+    cron_schedule?: string;
+    /** Authentication credentials for the data source. For white label OAuth flows, these are typically obtained automatically during the OAuth consent process. */
+    auth_fields?: AirweaveSDK.ConfigValues;
+    /** ID of an existing integration credential to use instead of creating a new one. Useful when credentials have already been established through OAuth flows. */
+    credential_id?: string;
+    /** Whether to start an initial data synchronization immediately after creating the connection. */
+    sync_immediately?: boolean;
+    /** ID of the white label integration configuration. This is automatically set by the white label OAuth endpoint and links the connection to your custom OAuth application. */
+    white_label_id?: string;
+}

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

@@ -0,0 +1,45 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Data synchronization job for a specific source connection.
+ */
+export interface SourceConnectionJob {
+    /** Unique identifier of the source connection for which this data refresh is running. */
+    source_connection_id: string;
+    /** Unique identifier for this specific data refresh operation. */
+    id: string;
+    /** Identifier of the organization that owns this data refresh operation. */
+    organization_id: string;
+    /** Email address of the user who initiated this data refresh (for manually triggered operations). */
+    created_by_email?: string;
+    /** Email address of the user who last modified this data refresh operation. */
+    modified_by_email?: string;
+    /** Timestamp when this data refresh was created and queued (ISO 8601 format). */
+    created_at?: string;
+    /** Timestamp when this data refresh was last modified (ISO 8601 format). */
+    modified_at?: string;
+    /** Current execution status of the data refresh:<br/>• **created**: Operation has been created but not yet queued<br/>• **pending**: Operation is queued and waiting to start<br/>• **in_progress**: Currently running and processing data<br/>• **completed**: Finished successfully with all data processed<br/>• **failed**: Encountered errors and could not complete<br/>• **cancelled**: Manually cancelled before completion */
+    status?: AirweaveSDK.SyncJobStatus;
+    /** Number of new data entities that were added to the collection during this refresh. */
+    entities_inserted?: number;
+    /** Number of existing entities that were modified and updated during this refresh. */
+    entities_updated?: number;
+    /** Number of entities that were removed from the collection because they no longer exist in the source. */
+    entities_deleted?: number;
+    /** Number of entities that were checked but required no changes because they were already up-to-date. */
+    entities_kept?: number;
+    /** Number of entities that were intentionally skipped due to filtering rules or processing decisions. */
+    entities_skipped?: number;
+    /** Detailed breakdown of entities processed by type or category. */
+    entities_encountered?: Record<string, number | undefined>;
+    /** Timestamp when the data refresh began active processing (ISO 8601 format). */
+    started_at?: string;
+    /** Timestamp when the data refresh finished successfully (ISO 8601 format). */
+    completed_at?: string;
+    /** Timestamp when the data refresh failed (ISO 8601 format). */
+    failed_at?: string;
+    /** Detailed error message if the data refresh failed. */
+    error?: string;
+}

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

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Simplified source connection representation for list operations.
+ */
+export interface SourceConnectionListItem {
+    /** Unique identifier for the source connection. */
+    id: string;
+    /** Human-readable name of the source connection. */
+    name: string;
+    /** Brief description of what data this connection provides. */
+    description?: string;
+    /** Technical identifier of the source type (e.g., 'stripe', 'postgresql'). */
+    short_name: string;
+    /** Current operational status: active, in_progress, or failing. */
+    status: AirweaveSDK.SourceConnectionStatus;
+    /** When the source connection was created (ISO 8601 format). */
+    created_at: string;
+    /** When the source connection was last modified (ISO 8601 format). */
+    modified_at: string;
+    /** Internal identifier for the sync configuration. */
+    sync_id: string;
+    /** Readable ID of the collection where this connection syncs data. */
+    collection: string;
+    /** Identifier for custom OAuth integrations, if applicable. */
+    white_label_id?: string;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as AirweaveSDK from "../index.js";
+/**
+ * Schema for Sync.
+ */
+export interface Sync {
+    name: string;
+    source_connection_id: string;
+    embedding_model_connection_id?: string;
+    destination_connection_ids: string[];
+    description?: string;
+    cron_schedule?: string;
+    next_scheduled_run?: string;
+    sync_metadata?: Record<string, unknown>;
+    status: AirweaveSDK.SyncStatus;
+    id: string;
+    organization_id: string;
+    created_at: string;
+    modified_at: string;
+    created_by_email?: string;
+    modified_by_email?: string;
+}