@airweave/sdk 0.1.28 → 0.1.35

package/api/resources/sync/client/Client.d.ts

@@ -1,275 +0,0 @@
-/**
- * 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 Sync {
-    interface Options {
-        environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
-        /** 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 Sync {
-    protected readonly _options: Sync.Options;
-    constructor(_options?: Sync.Options);
-    /**
-     * List all syncs for the current user.
-     *
-     * Args:
-     * -----
-     *     db: The database session
-     *     skip: The number of syncs to skip
-     *     limit: The number of syncs to return
-     *     with_source_connection: Whether to include the source connection in the response
-     *     user: The current user
-     *
-     * Returns:
-     * --------
-     *     list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
-     *
-     * @param {AirweaveSDK.ListSyncsSyncGetRequest} request
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.listSyncs()
-     */
-    listSyncs(request?: AirweaveSDK.ListSyncsSyncGetRequest, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.ListSyncsSyncGetResponse>;
-    /**
-     * Create a new sync configuration.
-     *
-     * Args:
-     * -----
-     *     db: The database session
-     *     sync_in: The sync to create
-     *     user: The current user
-     *     background_tasks: The background tasks
-     *
-     * Returns:
-     * --------
-     *     sync (schemas.Sync): The created sync
-     *
-     * @param {AirweaveSDK.SyncCreate} request
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.createSync({
-     *         name: "name",
-     *         sourceConnectionId: "source_connection_id",
-     *         destinationConnectionIds: ["destination_connection_ids"]
-     *     })
-     */
-    createSync(request: AirweaveSDK.SyncCreate, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.Sync>;
-    /**
-     * List all sync jobs across all syncs.
-     *
-     * Args:
-     * -----
-     *     db: The database session
-     *     skip: The number of jobs to skip
-     *     limit: The number of jobs to return
-     *     user: The current user
-     *
-     * Returns:
-     * --------
-     *     list[schemas.SyncJob]: A list of all sync jobs
-     *
-     * @param {AirweaveSDK.ListAllJobsSyncJobsGetRequest} request
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.listAllJobs()
-     */
-    listAllJobs(request?: AirweaveSDK.ListAllJobsSyncJobsGetRequest, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.SyncJob[]>;
-    /**
-     * Get a specific sync by ID.
-     *
-     * Args:
-     * -----
-     *     db: The database session
-     *     sync_id: The ID of the sync to get
-     *     user: The current user
-     *
-     * Returns:
-     * --------
-     *     sync (schemas.Sync): The sync
-     *
-     * @param {string} syncId
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.getSync("sync_id")
-     */
-    getSync(syncId: string, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.Sync>;
-    /**
-     * Delete a sync configuration and optionally its associated data.
-     *
-     * Args:
-     * -----
-     *     db: The database session
-     *     sync_id: The ID of the sync to delete
-     *     delete_data: Whether to delete the data associated with the sync
-     *     user: The current user
-     *
-     * Returns:
-     * --------
-     *     sync (schemas.Sync): The deleted sync
-     *
-     * @param {string} syncId
-     * @param {AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest} request
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.deleteSync("sync_id")
-     */
-    deleteSync(syncId: string, request?: AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.Sync>;
-    /**
-     * Update a sync configuration.
-     *
-     * Args:
-     * -----
-     *     db: The database session
-     *     sync_id: The ID of the sync to update
-     *     sync_update: The sync update data
-     *     user: The current user
-     *
-     * Returns:
-     * --------
-     *     sync (schemas.Sync): The updated sync
-     *
-     * @param {string} syncId
-     * @param {AirweaveSDK.SyncUpdate} request
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.updateSync("sync_id")
-     */
-    updateSync(syncId: string, request?: AirweaveSDK.SyncUpdate, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.Sync>;
-    /**
-     * Trigger a sync run.
-     *
-     * Args:
-     * -----
-     *     db: The database session
-     *     sync_id: The ID of the sync to run
-     *     user: The current user
-     *     background_tasks: The background tasks
-     *
-     * Returns:
-     * --------
-     *     sync_job (schemas.SyncJob): The sync job
-     *
-     * @param {string} syncId
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.runSync("sync_id")
-     */
-    runSync(syncId: string, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.SyncJob>;
-    /**
-     * List all jobs for a specific sync.
-     *
-     * Args:
-     * -----
-     *     db: The database session
-     *     sync_id: The ID of the sync to list jobs for
-     *     user: The current user
-     *
-     * Returns:
-     * --------
-     *     list[schemas.SyncJob]: A list of sync jobs
-     *
-     * @param {string} syncId
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.listSyncJobs("sync_id")
-     */
-    listSyncJobs(syncId: string, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.SyncJob[]>;
-    /**
-     * Get details of a specific sync job.
-     *
-     * Args:
-     * -----
-     *     db: The database session
-     *     sync_id: The ID of the sync to list jobs for
-     *     job_id: The ID of the job to get
-     *     user: The current user
-     *
-     * Returns:
-     * --------
-     *     sync_job (schemas.SyncJob): The sync job
-     *
-     * @param {string} syncId
-     * @param {string} jobId
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.getSyncJob("sync_id", "job_id")
-     */
-    getSyncJob(syncId: string, jobId: string, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.SyncJob>;
-    /**
-     * Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
-     *
-     * Args:
-     * -----
-     *     job_id: The ID of the job to subscribe to
-     *     user: The current user
-     *
-     * Returns:
-     * --------
-     *     StreamingResponse: The streaming response
-     *
-     * @param {string} jobId
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.subscribeSyncJob("job_id")
-     */
-    subscribeSyncJob(jobId: string, requestOptions?: Sync.RequestOptions): Promise<unknown>;
-    /**
-     * Get the DAG for a specific sync.
-     *
-     * @param {string} syncId
-     * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link AirweaveSDK.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.sync.getSyncDag("sync_id")
-     */
-    getSyncDag(syncId: string, requestOptions?: Sync.RequestOptions): Promise<AirweaveSDK.SyncDag>;
-}