@airweave/sdk 0.0.1 → 0.0.81

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

@@ -0,0 +1,320 @@
+/**
+ * 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 Connections {
+    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 Connections {
+    protected readonly _options: Connections.Options;
+    constructor(_options?: Connections.Options);
+    /**
+     * Get a specific connection.
+     *
+     * Args:
+     * -----
+     *     connection_id: The ID of the connection to get.
+     *     db: The database session.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     schemas.Connection: The connection.
+     *
+     * @param {string} connectionId
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.getConnection("connection_id")
+     */
+    getConnection(connectionId: string, requestOptions?: Connections.RequestOptions): Promise<AirweaveSDK.Connection>;
+    /**
+     * Get all active connections for the current user across all integration types.
+     *
+     * Args:
+     * -----
+     *     db: The database session.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     list[schemas.Connection]: The list of connections.
+     *
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.listAllConnectedIntegrations()
+     */
+    listAllConnectedIntegrations(requestOptions?: Connections.RequestOptions): Promise<AirweaveSDK.Connection[]>;
+    /**
+     * Get all integrations of specified type connected to the current user.
+     *
+     * Args:
+     * -----
+     *     integration_type (IntegrationType): The type of integration to get connections for.
+     *     db (AsyncSession): The database session.
+     *     user (schemas.User): The current user.
+     *
+     * Returns:
+     * -------
+     *     list[schemas.Connection]: The list of connections.
+     *
+     * @param {AirweaveSDK.IntegrationType} integrationType
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.listConnectedIntegrations("source")
+     */
+    listConnectedIntegrations(integrationType: AirweaveSDK.IntegrationType, requestOptions?: Connections.RequestOptions): Promise<AirweaveSDK.Connection[]>;
+    /**
+     * Connect to a source, destination, or embedding model.
+     *
+     * Expects a POST body with:
+     * ```json
+     * {
+     *     "name": "required connection name",
+     *     ... other config fields specific to the integration type ...
+     * }
+     * ```
+     *
+     * Args:
+     * -----
+     *     db: The database session.
+     *     integration_type: The type of integration to connect to.
+     *     short_name: The short name of the integration to connect to.
+     *     name: The name of the connection.
+     *     config_fields: The config fields for the integration.
+     *     user: The current user.
+     *
+     * Returns:
+     * -------
+     *     schemas.Connection: The connection.
+     *
+     * @param {AirweaveSDK.IntegrationType} integrationType
+     * @param {string} shortName
+     * @param {AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost} request
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.connectIntegration("source", "short_name", {
+     *         configFields: {
+     *             "key": "value"
+     *         }
+     *     })
+     */
+    connectIntegration(integrationType: AirweaveSDK.IntegrationType, shortName: string, request: AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost, requestOptions?: Connections.RequestOptions): Promise<AirweaveSDK.Connection>;
+    /**
+     * Get the credentials for a connection.
+     *
+     * Args:
+     * -----
+     *     connection_id (UUID): The ID of the connection to get credentials for
+     *     db (AsyncSession): The database session
+     *     user (schemas.User): The current user
+     *
+     * Returns:
+     * -------
+     *     decrypted_credentials (dict): The credentials for the connection
+     *
+     * @param {string} connectionId
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.getConnectionCredentials("connection_id")
+     */
+    getConnectionCredentials(connectionId: string, requestOptions?: Connections.RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * Delete a connection.
+     *
+     * Deletes the connection and integration credential.
+     *
+     * Args:
+     * -----
+     *     db (AsyncSession): The database session
+     *     connection_id (UUID): The ID of the connection to delete
+     *     user (schemas.User): The current user
+     *
+     * Returns:
+     * --------
+     *     connection (schemas.Connection): The deleted connection
+     *
+     * @param {string} connectionId
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.deleteConnection("connection_id")
+     */
+    deleteConnection(connectionId: string, requestOptions?: Connections.RequestOptions): Promise<AirweaveSDK.Connection>;
+    /**
+     * Disconnect from a source connection.
+     *
+     * Args:
+     * -----
+     *     db (AsyncSession): The database session
+     *     connection_id (UUID): The ID of the connection to disconnect
+     *     user (schemas.User): The current user
+     *
+     * Returns:
+     * --------
+     *     connection_schema (schemas.Connection): The disconnected connection
+     *
+     * @param {string} connectionId
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.disconnectSourceConnection("connection_id")
+     */
+    disconnectSourceConnection(connectionId: string, requestOptions?: Connections.RequestOptions): Promise<AirweaveSDK.Connection>;
+    /**
+     * Disconnect from a destination connection.
+     *
+     * Args:
+     * -----
+     *     db (AsyncSession): The database session
+     *     connection_id (UUID): The ID of the connection to disconnect
+     *     user (schemas.User): The current user
+     *
+     * Returns:
+     * --------
+     *     connection_schema (schemas.Connection): The disconnected connection
+     *
+     * @param {string} connectionId
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.disconnectDestinationConnection("connection_id")
+     */
+    disconnectDestinationConnection(connectionId: string, requestOptions?: Connections.RequestOptions): Promise<AirweaveSDK.Connection>;
+    /**
+     * Get the OAuth2 authorization URL for a source.
+     *
+     * Args:
+     * -----
+     *     db: The database session
+     *     short_name: The short name of the source
+     *     user: The current user
+     *
+     * @param {AirweaveSDK.GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest} request
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.getOauth2AuthUrl({
+     *         shortName: "short_name"
+     *     })
+     */
+    getOauth2AuthUrl(request: AirweaveSDK.GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest, requestOptions?: Connections.RequestOptions): Promise<string>;
+    /**
+     * Send the OAuth2 authorization code for a source.
+     *
+     * This will:
+     * 1. Get the OAuth2 settings for the source
+     * 2. Exchange the authorization code for a token
+     * 3. Create an integration credential with the token
+     *
+     * Args:
+     * -----
+     *     db: The database session
+     *     short_name: The short name of the source
+     *     code: The authorization code
+     *     user: The current user
+     *
+     * Returns:
+     * --------
+     *     connection (schemas.Connection): The created connection
+     *
+     * @param {AirweaveSDK.BodySendOauth2CodeConnectionsOauth2SourceCodePost} request
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.sendOauth2Code({
+     *         shortName: "short_name",
+     *         code: "code"
+     *     })
+     */
+    sendOauth2Code(request: AirweaveSDK.BodySendOauth2CodeConnectionsOauth2SourceCodePost, requestOptions?: Connections.RequestOptions): Promise<AirweaveSDK.Connection>;
+    /**
+     * Exchange the OAuth2 authorization code for a white label integration.
+     *
+     * Args:
+     * -----
+     *     db: The database session
+     *     white_label_id: The ID of the white label integration
+     *     code: The authorization code
+     *     user: The current user
+     *     background_tasks: The background tasks
+     *
+     * Returns:
+     * --------
+     *     connection (schemas.Connection): The created connection
+     *
+     * @param {string} whiteLabelId
+     * @param {string} request
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string")
+     */
+    sendOauth2WhiteLabelCode(whiteLabelId: string, request: string, requestOptions?: Connections.RequestOptions): Promise<AirweaveSDK.Connection>;
+    /**
+     * Get the OAuth2 authorization URL for a white label integration.
+     *
+     * Args:
+     * -----
+     *     db: The database session
+     *     white_label_id: The ID of the white label integration
+     *     user: The current user
+     *
+     * Returns:
+     * --------
+     *     str: The OAuth2 authorization URL
+     *
+     * @param {string} whiteLabelId
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AirweaveSDK.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id")
+     */
+    getOauth2WhiteLabelAuthUrl(whiteLabelId: string, requestOptions?: Connections.RequestOptions): Promise<string>;
+}