@airweave/sdk 0.5.14 → 0.6.3

package/dist/esm/api/types/AuthType.d.mts

@@ -1,27 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Enumeration of supported authentication types.
- *
- * Attributes:
- * ----------
- *     oauth2: OAuth2 authentication.
- *     oauth2_with_refresh: OAuth2 authentication with refresh token.
- *     oauth2_with_refresh_rotating: OAuth2 authentication with rotating refresh token.
- *     api_key: API key authentication.
- *     native_functionality: Native functionality.
- *     url_and_api_key: URL and API key authentication.
- *     none: No authentication.
- */
-export type AuthType = "oauth2" | "oauth2_with_refresh" | "oauth2_with_refresh_rotating" | "api_key" | "native_functionality" | "config_class" | "trello_auth" | "none";
-export declare const AuthType: {
-    readonly Oauth2: "oauth2";
-    readonly Oauth2WithRefresh: "oauth2_with_refresh";
-    readonly Oauth2WithRefreshRotating: "oauth2_with_refresh_rotating";
-    readonly ApiKey: "api_key";
-    readonly NativeFunctionality: "native_functionality";
-    readonly ConfigClass: "config_class";
-    readonly TrelloAuth: "trello_auth";
-    readonly None: "none";
-};

package/dist/esm/api/types/AuthType.mjs

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export const AuthType = {
-    Oauth2: "oauth2",
-    Oauth2WithRefresh: "oauth2_with_refresh",
-    Oauth2WithRefreshRotating: "oauth2_with_refresh_rotating",
-    ApiKey: "api_key",
-    NativeFunctionality: "native_functionality",
-    ConfigClass: "config_class",
-    TrelloAuth: "trello_auth",
-    None: "none",
-};

package/dist/esm/api/types/BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.d.mts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost {
-    /** Custom name for the stored credential */
-    credential_name?: string;
-    /** Description to help identify this credential */
-    credential_description?: string;
-    /** OAuth client ID (required for bring-your-own-credentials) */
-    client_id?: string;
-    /** OAuth client secret (required for bring-your-own-credentials) */
-    client_secret?: string;
-}

package/dist/esm/api/types/OAuth2AuthUrl.d.mts

@@ -1,13 +0,0 @@
-/**
- * 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/esm/api/types/SourceConnectionContinuousResponse.d.mts

@@ -1,67 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as AirweaveSDK from "../index.mjs";
-/**
- * Response schema for continuous source connection creation.
- */
-export interface SourceConnectionContinuousResponse {
-    /** 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;
-    /** Readable ID of the auth provider used to create this connection. Present only if the connection was created through an auth provider. */
-    auth_provider?: string;
-    /** Configuration used with the auth provider to create this connection. Present only if the connection was created through an auth provider. */
-    auth_provider_config?: Record<string, unknown>;
-    /** 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?: SourceConnectionContinuousResponse.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;
-    /** Information about the created minute-level schedule including schedule ID, cron expression, and current status. */
-    minute_level_schedule?: Record<string, unknown>;
-}
-export declare namespace SourceConnectionContinuousResponse {
-    /**
-     * Authentication credentials for the data source. Returns '********' by default for security.
-     */
-    type AuthFields = AirweaveSDK.ConfigValues | string;
-}

package/dist/esm/api/types/SourceConnectionCreateContinuous.d.mts

@@ -1,33 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as AirweaveSDK from "../index.mjs";
-/**
- * Schema for creating a continuously syncing source connection (BETA).
- *
- * This endpoint creates a source connection that stays continuously in sync with your
- * data source. Your data will be automatically synchronized every minute, ensuring it's
- * always up-to-date without any manual intervention or sync management.
- */
-export interface SourceConnectionCreateContinuous {
-    /** 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;
-    /** Whether to create a daily forced full sync with entity cleanup. Defaults to true for resilience; set to false to rely solely on incremental changes. */
-    enable_daily_cleanup?: boolean;
-    /** Authentication credentials required to access the data source. The required fields vary by source type. Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
-    auth_fields?: AirweaveSDK.ConfigValues;
-    /** Unique readable ID of a connected auth provider to use for authentication instead of providing auth_fields directly. */
-    auth_provider?: string;
-    /** Configuration for the auth provider when using auth_provider field. */
-    auth_provider_config?: AirweaveSDK.ConfigValues;
-    /** Specify which field in the entity should be used as the cursor for incremental syncs. This field must contain a timestamp or incrementing value that indicates when records were last modified. Required for sources without predefined entities (e.g., databases). If not specified, the source's default cursor field will be used if available. */
-    cursor_field?: string;
-}

package/dist/esm/api/types/SourceConnectionCreateWithCredential.d.mts

@@ -1,25 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as AirweaveSDK from "../index.mjs";
-/**
- * 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/esm/api/types/SourceConnectionCreateWithWhiteLabel.d.mts

@@ -1,29 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as AirweaveSDK from "../index.mjs";
-/**
- * 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/esm/api/types/SourceConnectionMakeContinuous.d.mts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Schema for converting an existing source connection to continuous (BETA).
- */
-export interface SourceConnectionMakeContinuous {
-    /** Specify which field in the entity should be used as the cursor for incremental syncs. If omitted, the source's default cursor field will be used if available. Required for sources without a default (e.g., PostgreSQL). */
-    cursor_field?: string;
-    /** Whether to create a daily forced full sync with entity cleanup. This helps remove orphaned entities that incremental syncs cannot detect. */
-    enable_daily_cleanup?: boolean;
-    /** Whether to immediately trigger a sync job after enabling continuous mode. If no cursor data exists yet, this initial run will perform a full sync. */
-    run_initial_sync?: boolean;
-}

package/dist/esm/api/types/WhiteLabel.d.mts

@@ -1,32 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Complete white label integration representation returned by the API.
- */
-export interface WhiteLabel {
-    /** Human-readable name for the white label integration. This helps you identify the integration in the UI and should clearly describe its purpose (e.g., 'Customer Portal Slack Integration', 'Enterprise Google Drive Access'). */
-    name: string;
-    /** Technical identifier of the source type that this integration supports (e.g., 'slack', 'google_drive', 'github'). This determines which service provider the OAuth integration connects to. */
-    source_short_name: string;
-    /** OAuth2 callback URL where users are redirected after completing authentication. This must be a valid HTTPS URL that your application can handle to receive the authorization code. */
-    redirect_url: string;
-    /** OAuth2 client identifier provided by the service provider. This identifies your application during the OAuth consent flow and must match the client ID configured in the service provider's developer console. */
-    client_id: string;
-    /** OAuth2 client secret from your registered application. This is used to securely authenticate your application when exchanging authorization codes for access tokens. Keep this value secure and never expose it in client-side code. */
-    client_secret: string;
-    /** Comma-separated list of allowed domains for OAuth flows and CORS. This prevents unauthorized websites from using your OAuth credentials and should include all domains where your application is hosted. */
-    allowed_origins: string;
-    /** Unique system identifier for the white label integration. This UUID is generated automatically and used for API operations and OAuth flow tracking. */
-    id: string;
-    /** Identifier of the organization that owns this white label integration. White label integrations are isolated per organization for security and multi-tenancy. */
-    organization_id: string;
-    /** Timestamp when the white label integration was created (ISO 8601 format). */
-    created_at: string;
-    /** Timestamp when the white label integration was last modified (ISO 8601 format). */
-    modified_at: string;
-    /** Email address of the user who created this white label integration. */
-    created_by_email?: string;
-    /** Email address of the user who last modified this white label integration. */
-    modified_by_email?: string;
-}