@airweave/sdk 0.1.19 → 0.1.21

package/api/resources/whiteLabels/client/Client.js

@@ -62,6 +62,15 @@ class WhiteLabels {
     /**
      * List all white labels for the current user's organization.
      *
+     * Args:
+     * -----
+     *     db: The database session
+     *     current_user: The current user
+     *
+     * Returns:
+     * --------
+     *     list[schemas.WhiteLabel]: A list of white labels
+     *
      * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link AirweaveSDK.UnprocessableEntityError}
@@ -77,7 +86,7 @@ class WhiteLabels {
                 method: "GET",
                 headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
                         ? yield core.Supplier.get(this._options.apiKey)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -126,6 +135,16 @@ class WhiteLabels {
     /**
      * Create new white label integration.
      *
+     * Args:
+     * -----
+     *     db: The database session
+     *     current_user: The current user
+     *     white_label_in: The white label to create
+     *
+     * Returns:
+     * --------
+     *     white_label (schemas.WhiteLabel): The created white label
+     *
      * @param {AirweaveSDK.WhiteLabelCreate} request
      * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -148,7 +167,7 @@ class WhiteLabels {
                 method: "POST",
                 headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
                         ? yield core.Supplier.get(this._options.apiKey)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.WhiteLabelCreate.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -198,6 +217,16 @@ class WhiteLabels {
     /**
      * Get a specific white label integration.
      *
+     * Args:
+     * -----
+     *     db: The database session
+     *     white_label_id: The ID of the white label to get
+     *     current_user: The current user
+     *
+     * Returns:
+     * --------
+     *     white_label (schemas.WhiteLabel): The white label
+     *
      * @param {string} whiteLabelId
      * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -214,7 +243,7 @@ class WhiteLabels {
                 method: "GET",
                 headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
                         ? yield core.Supplier.get(this._options.apiKey)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -263,6 +292,17 @@ class WhiteLabels {
     /**
      * Update a white label integration.
      *
+     * Args:
+     * -----
+     *     db: The database session
+     *     current_user: The current user
+     *     white_label_id: The ID of the white label to update
+     *     white_label_in: The white label to update
+     *
+     * Returns:
+     * --------
+     *     white_label (schemas.WhiteLabel): The updated white label
+     *
      * @param {string} whiteLabelId
      * @param {AirweaveSDK.WhiteLabelUpdate} request
      * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
@@ -280,7 +320,7 @@ class WhiteLabels {
                 method: "PUT",
                 headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
                         ? yield core.Supplier.get(this._options.apiKey)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.WhiteLabelUpdate.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -330,6 +370,16 @@ class WhiteLabels {
     /**
      * Delete a white label integration.
      *
+     * Args:
+     * -----
+     *     db: The database session
+     *     current_user: The current user
+     *     white_label_id: The ID of the white label to delete
+     *
+     * Returns:
+     * --------
+     *     white_label (schemas.WhiteLabel): The deleted white label
+     *
      * @param {string} whiteLabelId
      * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -346,7 +396,7 @@ class WhiteLabels {
                 method: "DELETE",
                 headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
                         ? yield core.Supplier.get(this._options.apiKey)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -395,6 +445,16 @@ class WhiteLabels {
     /**
      * Generate the OAuth2 authorization URL by delegating to oauth2_service.
      *
+     * Args:
+     * -----
+     *     db: The database session
+     *     white_label_id: The ID of the white label to get the auth URL for
+     *     user: The current user
+     *
+     * Returns:
+     * --------
+     *     str: The OAuth2 authorization URL
+     *
      * @param {string} whiteLabelId
      * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -411,7 +471,7 @@ class WhiteLabels {
                 method: "GET",
                 headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
                         ? yield core.Supplier.get(this._options.apiKey)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -460,6 +520,17 @@ class WhiteLabels {
     /**
      * Exchange OAuth2 code for tokens and create connection.
      *
+     * Args:
+     * -----
+     *     white_label_id: The ID of the white label to exchange the code for
+     *     code: The OAuth2 code
+     *     db: The database session
+     *     user: The current user
+     *
+     * Returns:
+     * --------
+     *     connection (schemas.Connection): The created connection
+     *
      * @param {string} whiteLabelId
      * @param {string} request
      * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
@@ -477,7 +548,7 @@ class WhiteLabels {
                 method: "POST",
                 headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
                         ? yield core.Supplier.get(this._options.apiKey)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.whiteLabels.exchangeWhiteLabelOauth2Code.Request.jsonOrThrow(request, {
@@ -529,6 +600,16 @@ class WhiteLabels {
     /**
      * List all syncs for a specific white label.
      *
+     * Args:
+     * -----
+     *     white_label_id: The ID of the white label to list syncs for
+     *     db: The database session
+     *     current_user: The current user
+     *
+     * Returns:
+     * --------
+     *     list[schemas.Sync]: A list of syncs
+     *
      * @param {string} whiteLabelId
      * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -545,7 +626,7 @@ class WhiteLabels {
                 method: "GET",
                 headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
                         ? yield core.Supplier.get(this._options.apiKey)
-                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                        : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

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

@@ -29,6 +29,16 @@ export declare class Connections {
     /**
      * 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.
      *
@@ -41,6 +51,15 @@ export declare class Connections {
     /**
      * 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}
@@ -53,11 +72,13 @@ export declare class Connections {
      * 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
@@ -80,6 +101,19 @@ export declare class Connections {
      * }
      * ```
      *
+     * 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
@@ -99,12 +133,14 @@ export declare class Connections {
      * 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:
-     *     dict: The credentials for the connection
+     * -------
+     *     decrypted_credentials (dict): The credentials for the connection
      *
      * @param {string} connectionId
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -121,13 +157,14 @@ export declare class Connections {
      * Deletes the connection and integration credential.
      *
      * Args:
+     * -----
      *     db (AsyncSession): The database session
      *     connection_id (UUID): The ID of the connection to delete
-     *     delete_syncs_and_data (bool): Whether to delete the associated syncs and data
      *     user (schemas.User): The current user
      *
      * Returns:
-     *     schemas.Connection: The deleted connection
+     * --------
+     *     connection (schemas.Connection): The deleted connection
      *
      * @param {string} connectionId
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -142,11 +179,14 @@ export declare class Connections {
      * 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:
-     *     schemas.Connection: The disconnected connection
+     * --------
+     *     connection_schema (schemas.Connection): The disconnected connection
      *
      * @param {string} connectionId
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -161,12 +201,14 @@ export declare class Connections {
      * 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:
-     *     schemas.Connection: The disconnected connection
+     * --------
+     *     connection_schema (schemas.Connection): The disconnected connection
      *
      * @param {string} connectionId
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -180,6 +222,12 @@ export declare class Connections {
     /**
      * 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.
      *
@@ -199,6 +247,17 @@ export declare class Connections {
      * 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.
      *
@@ -214,6 +273,18 @@ export declare class Connections {
     /**
      * 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.
@@ -227,6 +298,16 @@ export declare class Connections {
     /**
      * 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.
      *