@airweave/sdk 0.2.53 → 0.3.42

package/dist/esm/api/resources/sourceConnections/client/Client.d.mts

@@ -0,0 +1,211 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as AirweaveSDK from "../../../index.mjs";
+export declare namespace SourceConnections {
+    interface Options {
+        environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        /** Override the X-API-Key header */
+        apiKey?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-ID header */
+        organizationId?: core.Supplier<string | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the X-API-Key header */
+        apiKey?: string | undefined;
+        /** Override the X-Organization-ID header */
+        organizationId?: string | undefined;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+/**
+ * API endpoints for managing live connections to data sources. Source connections are the actual configured instances that Airweave uses to sync data from your apps and databases, transforming it into searchable, structured information within collections
+ */
+export declare class SourceConnections {
+    protected readonly _options: SourceConnections.Options;
+    constructor(_options?: SourceConnections.Options);
+    /**
+     * List source connections across your organization.
+     *
+     * <br/><br/>
+     * By default, returns ALL source connections from every collection in your
+     * organization. Use the 'collection' parameter to filter results to a specific
+     * collection. This is useful for getting an overview of all your data sources
+     * or managing connections within a particular collection.
+     *
+     * @param {AirweaveSDK.ListSourceConnectionsSourceConnectionsGetRequest} request
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.listSourceConnections()
+     */
+    listSourceConnections(request?: AirweaveSDK.ListSourceConnectionsSourceConnectionsGetRequest, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionListItem[]>;
+    private __listSourceConnections;
+    /**
+     * Create a new source connection to sync data into your collection.
+     *
+     * <br/><br/>
+     *
+     * **This endpoint only works for sources that do not use OAuth2.0.**
+     * Sources that do use OAuth2.0 like Google Drive, Slack, or HubSpot must be
+     * connected through the UI where you can complete the OAuth consent flow.<br/><br/>
+     *
+     * Credentials for a source have to be provided using the `auth_fields` field.
+     * Currently, it is not automatically checked if the provided credentials are valid.
+     * If they are not valid, the data synchronization will fail.<br/><br/>
+     *
+     * Check the documentation of a specific source (for example
+     * [Github](https://docs.airweave.ai/docs/connectors/github)) to see what kind
+     * of authentication is used.
+     *
+     * @param {AirweaveSDK.SourceConnectionCreate} request
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.createSourceConnection({
+     *         name: "Production Stripe Account",
+     *         short_name: "stripe"
+     *     })
+     */
+    createSourceConnection(request: AirweaveSDK.SourceConnectionCreate, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
+    private __createSourceConnection;
+    /**
+     * Retrieve a specific source connection by its ID.
+     *
+     * @param {string} sourceConnectionId - The unique identifier of the source connection
+     * @param {AirweaveSDK.GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest} request
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.getSourceConnection("source_connection_id")
+     */
+    getSourceConnection(sourceConnectionId: string, request?: AirweaveSDK.GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
+    private __getSourceConnection;
+    /**
+     * Update a source connection's properties.
+     *
+     * <br/><br/>
+     *
+     * Modify the configuration of an existing source connection including its name,
+     * authentication credentials, configuration fields, sync schedule, or source-specific settings.
+     *
+     * @param {string} sourceConnectionId - The unique identifier of the source connection to update
+     * @param {AirweaveSDK.SourceConnectionUpdate} request
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.updateSourceConnection("source_connection_id")
+     */
+    updateSourceConnection(sourceConnectionId: string, request?: AirweaveSDK.SourceConnectionUpdate, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
+    private __updateSourceConnection;
+    /**
+     * Delete a source connection.
+     *
+     * <br/><br/>
+     *
+     * Permanently removes the source connection configuration and credentials.
+     * By default, previously synced data remains in your destination systems for continuity.
+     * Use delete_data=true to also remove all associated data from destination systems.
+     *
+     * @param {string} sourceConnectionId - The unique identifier of the source connection to delete
+     * @param {AirweaveSDK.DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest} request
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.deleteSourceConnection("source_connection_id")
+     */
+    deleteSourceConnection(sourceConnectionId: string, request?: AirweaveSDK.DeleteSourceConnectionSourceConnectionsSourceConnectionIdDeleteRequest, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
+    private __deleteSourceConnection;
+    /**
+     * Manually trigger a data sync for this source connection.
+     *
+     * <br/><br/>
+     * Starts an immediate synchronization job that extracts fresh data from your source,
+     * transforms it according to your configuration, and updates the destination systems.
+     * The job runs asynchronously and endpoint returns immediately with tracking information.
+     *
+     * @param {string} sourceConnectionId - The unique identifier of the source connection to sync
+     * @param {AirweaveSDK.BodyRunSourceConnectionSourceConnectionsSourceConnectionIdRunPost} request
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.runSourceConnection("source_connection_id")
+     */
+    runSourceConnection(sourceConnectionId: string, request?: AirweaveSDK.BodyRunSourceConnectionSourceConnectionsSourceConnectionIdRunPost, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob>;
+    private __runSourceConnection;
+    /**
+     * List all sync jobs for a source connection.
+     *
+     * <br/><br/>
+     * Returns the complete history of data synchronization jobs including successful syncs,
+     * failed attempts, and currently running operations.
+     *
+     * @param {string} sourceConnectionId - The unique identifier of the source connection
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.listSourceConnectionJobs("source_connection_id")
+     */
+    listSourceConnectionJobs(sourceConnectionId: string, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob[]>;
+    private __listSourceConnectionJobs;
+    /**
+     * Get detailed information about a specific sync job.
+     *
+     * @param {string} sourceConnectionId - The unique identifier of the source connection
+     * @param {string} jobId - The unique identifier of the sync job
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.getSourceConnectionJob("source_connection_id", "job_id")
+     */
+    getSourceConnectionJob(sourceConnectionId: string, jobId: string, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob>;
+    private __getSourceConnectionJob;
+    /**
+     * Cancel a running sync job.
+     *
+     * <br/><br/>
+     * Sends a cancellation signal to stop an in-progress data synchronization.
+     * The job will complete its current operation and then terminate gracefully.
+     * Only jobs in 'created', 'pending', or 'in_progress' states can be cancelled.
+     *
+     * @param {string} sourceConnectionId - The unique identifier of the source connection
+     * @param {string} jobId - The unique identifier of the sync job to cancel
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.cancelSourceConnectionJob("source_connection_id", "job_id")
+     */
+    cancelSourceConnectionJob(sourceConnectionId: string, jobId: string, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob>;
+    private __cancelSourceConnectionJob;
+}