@airweave/sdk 0.6.0 → 0.6.26

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

@@ -11,7 +11,7 @@ export declare namespace SourceConnections {
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -20,8 +20,10 @@ export declare namespace SourceConnections {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 /**
@@ -31,12 +33,7 @@ export declare class SourceConnections {
     protected readonly _options: SourceConnections.Options;
     constructor(_options: SourceConnections.Options);
     /**
-     * List source connections across your organization.
-     *
-     * 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.
+     * List source connections with minimal fields for performance.
      *
      * @param {AirweaveSDK.ListSourceConnectionsGetRequest} request
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
@@ -44,25 +41,29 @@ export declare class SourceConnections {
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
      *
      * @example
-     *     await client.sourceConnections.list()
+     *     await client.sourceConnections.list({
+     *         collection: "collection",
+     *         skip: 1,
+     *         limit: 1
+     *     })
      */
     list(request?: AirweaveSDK.ListSourceConnectionsGetRequest, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionListItem[]>;
     private __list;
     /**
-     * Create a new source connection to sync data into your collection.
+     * Create a new source connection.
      *
-     * **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
-     * or using Auth Providers (see [Auth Providers](/docs/auth-providers)).<br/><br/>
+     * The authentication configuration determines the flow:
+     * - DirectAuthentication: Immediate creation with provided credentials
+     * - OAuthBrowserAuthentication: Returns shell with authentication URL
+     * - OAuthTokenAuthentication: Immediate creation with provided token
+     * - AuthProviderAuthentication: Using external auth provider
      *
-     * 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/>
+     * BYOC (Bring Your Own Client) is detected when client_id and client_secret
+     * are provided in OAuthBrowserAuthentication.
      *
-     * 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.
+     * sync_immediately defaults:
+     * - True for: direct, oauth_token, auth_provider
+     * - False for: oauth_browser, oauth_byoc (these sync after authentication)
      *
      * @param {AirweaveSDK.SourceConnectionCreate} request
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
@@ -71,17 +72,16 @@ export declare class SourceConnections {
      *
      * @example
      *     await client.sourceConnections.create({
-     *         name: "Production Stripe Account",
-     *         short_name: "stripe"
+     *         short_name: "short_name",
+     *         readable_collection_id: "readable_collection_id"
      *     })
      */
     create(request: AirweaveSDK.SourceConnectionCreate, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
     private __create;
     /**
-     * Retrieve a specific source connection by its ID.
+     * Get a source connection with optional depth expansion.
      *
-     * @param {string} sourceConnectionId - The unique identifier of the source connection
-     * @param {AirweaveSDK.GetSourceConnectionsSourceConnectionIdGetRequest} request
+     * @param {string} sourceConnectionId
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
@@ -89,33 +89,12 @@ export declare class SourceConnections {
      * @example
      *     await client.sourceConnections.get("source_connection_id")
      */
-    get(sourceConnectionId: string, request?: AirweaveSDK.GetSourceConnectionsSourceConnectionIdGetRequest, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
+    get(sourceConnectionId: string, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
     private __get;
     /**
-     * Update a source connection's properties.
+     * Delete a source connection and all related data.
      *
-     * 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.update("source_connection_id")
-     */
-    update(sourceConnectionId: string, request?: AirweaveSDK.SourceConnectionUpdate, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
-    private __update;
-    /**
-     * Delete a source connection and all associated data.
-     *
-     * 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 {string} sourceConnectionId
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
@@ -126,62 +105,65 @@ export declare class SourceConnections {
     delete(sourceConnectionId: string, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
     private __delete;
     /**
-     * Manually trigger a data sync for this source connection.
+     * Update a source connection.
      *
-     * 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.
+     * Updateable fields:
+     * - name, description
+     * - config_fields
+     * - cron_schedule
+     * - auth_fields (direct auth only)
      *
-     * @param {string} sourceConnectionId - The unique identifier of the source connection to sync
-     * @param {AirweaveSDK.BodyRunSourceConnectionsSourceConnectionIdRunPost} request
+     * @param {string} sourceConnectionId
+     * @param {AirweaveSDK.SourceConnectionUpdate} request
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
      *
      * @example
-     *     await client.sourceConnections.run("source_connection_id")
+     *     await client.sourceConnections.update("source_connection_id")
      */
-    run(sourceConnectionId: string, request?: AirweaveSDK.BodyRunSourceConnectionsSourceConnectionIdRunPost, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob>;
-    private __run;
+    update(sourceConnectionId: string, request?: AirweaveSDK.SourceConnectionUpdate, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
+    private __update;
     /**
-     * List all sync jobs for a source connection.
+     * Trigger a sync run for a source connection.
      *
-     * Returns the complete history of data synchronization jobs including successful syncs,
-     * failed attempts, and currently running operations.
+     * Runs are always executed through Temporal workflow engine.
      *
-     * @param {string} sourceConnectionId - The unique identifier of the source connection
+     * @param {string} sourceConnectionId
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
      *
      * @example
-     *     await client.sourceConnections.listJobs("source_connection_id")
+     *     await client.sourceConnections.run("source_connection_id")
      */
-    listJobs(sourceConnectionId: string, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob[]>;
-    private __listJobs;
+    run(sourceConnectionId: string, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob>;
+    private __run;
     /**
-     * Get detailed information about a specific sync job.
+     * Get sync jobs for a source connection.
      *
-     * @param {string} sourceConnectionId - The unique identifier of the source connection
-     * @param {string} jobId - The unique identifier of the sync job
+     * @param {string} sourceConnectionId
+     * @param {AirweaveSDK.GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest} request
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
      *
      * @example
-     *     await client.sourceConnections.getJob("source_connection_id", "job_id")
+     *     await client.sourceConnections.getSourceConnectionJobs("source_connection_id", {
+     *         limit: 1
+     *     })
      */
-    getJob(sourceConnectionId: string, jobId: string, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob>;
-    private __getJob;
+    getSourceConnectionJobs(sourceConnectionId: string, request?: AirweaveSDK.GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob[]>;
+    private __getSourceConnectionJobs;
     /**
-     * Cancel a running sync job.
+     * Cancel a running sync job for a source connection.
      *
-     * 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.
+     * This endpoint requests cancellation and marks the job as CANCELLING.
+     * The workflow updates the final status to CANCELLED when it processes
+     * the cancellation request.
      *
-     * @param {string} sourceConnectionId - The unique identifier of the source connection
-     * @param {string} jobId - The unique identifier of the sync job to cancel
+     * @param {string} sourceConnectionId
+     * @param {string} jobId
      * @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
@@ -191,7 +173,5 @@ export declare class SourceConnections {
      */
     cancelJob(sourceConnectionId: string, jobId: string, requestOptions?: SourceConnections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionJob>;
     private __cancelJob;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-api-key": string;
-    }>;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }