@airweave/sdk 0.2.26 → 0.2.27

package/dist/api/resources/sourceConnections/client/Client.d.ts

@@ -0,0 +1,191 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as AirweaveSDK from "../../../index";
+export declare namespace SourceConnections {
+    interface Options {
+        environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
+        token: core.Supplier<core.BearerToken>;
+        /** Override the x-api-key header */
+        apiKey?: core.Supplier<string | 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;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class SourceConnections {
+    protected readonly _options: SourceConnections.Options;
+    constructor(_options: SourceConnections.Options);
+    /**
+     * List all source connections for the current user.
+     *
+     * Args:
+     *     db: The database session
+     *     collection: The collection to filter by
+     *     skip: The number of connections to skip
+     *     limit: The number of connections to return
+     *     user: The current user
+     *
+     * Returns:
+     *     A list of source connection list items with essential information
+     *
+     * @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): Promise<AirweaveSDK.SourceConnectionListItem[]>;
+    /**
+     * Create a new source connection.
+     *
+     * This endpoint creates:
+     * 1. An integration credential with the provided auth fields
+     * 2. A collection if not provided
+     * 3. The source connection
+     * 4. A sync configuration and DAG
+     * 5. A sync job if immediate execution is requested
+     *
+     * Args:
+     *     db: The database session
+     *     source_connection_in: The source connection to create
+     *     user: The current user
+     *     background_tasks: Background tasks for async operations
+     *
+     * Returns:
+     *     The created source connection
+     *
+     * @param {AirweaveSDK.SourceConnectionCreate} request
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.createSourceConnection({
+     *         name: "name",
+     *         shortName: "short_name"
+     *     })
+     */
+    createSourceConnection(request: AirweaveSDK.SourceConnectionCreate, requestOptions?: SourceConnections.RequestOptions): Promise<AirweaveSDK.SourceConnection>;
+    /**
+     * Get a specific source connection by ID.
+     *
+     * Args:
+     *     db: The database session
+     *     source_connection_id: The ID of the source connection
+     *     show_auth_fields: Whether to show the auth fields, default is False
+     *     user: The current user
+     *
+     * Returns:
+     *     The source connection
+     *
+     * @param {string} sourceConnectionId
+     * @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): Promise<AirweaveSDK.SourceConnection>;
+    /**
+     * Update a source connection.
+     *
+     * Args:
+     *     db: The database session
+     *     source_connection_id: The ID of the source connection to update
+     *     source_connection_in: The updated source connection data
+     *     user: The current user
+     *
+     * Returns:
+     *     The updated source connection
+     *
+     * @param {string} sourceConnectionId
+     * @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): Promise<AirweaveSDK.SourceConnection>;
+    /**
+     * Delete a source connection and all related components.
+     *
+     * Args:
+     *     db: The database session
+     *     source_connection_id: The ID of the source connection to delete
+     *     delete_data: Whether to delete the associated data in destinations
+     *     user: The current user
+     *
+     * Returns:
+     *     The deleted source connection
+     *
+     * @param {string} sourceConnectionId
+     * @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): Promise<AirweaveSDK.SourceConnection>;
+    /**
+     * Trigger a sync run for a source connection.
+     *
+     * Args:
+     *     db: The database session
+     *     source_connection_id: The ID of the source connection to run
+     *     user: The current user
+     *     background_tasks: Background tasks for async operations
+     *
+     * Returns:
+     *     The created sync job
+     *
+     * @param {string} sourceConnectionId
+     * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.sourceConnections.runSourceConnection("source_connection_id")
+     */
+    runSourceConnection(sourceConnectionId: string, requestOptions?: SourceConnections.RequestOptions): Promise<AirweaveSDK.SourceConnectionJob>;
+    /**
+     * List all sync jobs for a source connection.
+     *
+     * Args:
+     *     db: The database session
+     *     source_connection_id: The ID of the source connection
+     *     user: The current user
+     *
+     * Returns:
+     *     A list of sync jobs
+     *
+     * @param {string} sourceConnectionId
+     * @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): Promise<AirweaveSDK.SourceConnectionJob[]>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}