@airweave/sdk 0.3.45 → 0.3.46
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/sourceConnections/client/requests/SourceConnectionCreate.d.ts +4 -0
- package/dist/cjs/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +4 -0
- package/dist/cjs/api/resources/whiteLabels/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/whiteLabels/client/Client.js +4 -4
- package/dist/cjs/api/types/AuthProvider.d.ts +32 -0
- package/dist/cjs/api/types/AuthProvider.js +5 -0
- package/dist/cjs/api/types/AuthProviderConnection.d.ts +21 -0
- package/dist/cjs/api/types/AuthProviderConnection.js +5 -0
- package/dist/cjs/api/types/AuthProviderConnectionCreate.d.ts +19 -0
- package/dist/cjs/api/types/AuthProviderConnectionCreate.js +5 -0
- package/dist/cjs/api/types/AuthProviderConnectionUpdate.d.ts +15 -0
- package/dist/cjs/api/types/AuthProviderConnectionUpdate.js +5 -0
- package/dist/cjs/api/types/ConfigField.d.ts +1 -0
- package/dist/cjs/api/types/Connection.d.ts +9 -0
- package/dist/cjs/api/types/IntegrationType.d.ts +2 -1
- package/dist/cjs/api/types/IntegrationType.js +1 -0
- package/dist/cjs/api/types/SourceConnection.d.ts +4 -0
- package/dist/cjs/api/types/index.d.ts +4 -0
- package/dist/cjs/api/types/index.js +4 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/sourceConnections/client/requests/SourceConnectionCreate.d.mts +4 -0
- package/dist/esm/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.mts +4 -0
- package/dist/esm/api/resources/whiteLabels/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/whiteLabels/client/Client.mjs +4 -4
- package/dist/esm/api/types/AuthProvider.d.mts +32 -0
- package/dist/esm/api/types/AuthProvider.mjs +4 -0
- package/dist/esm/api/types/AuthProviderConnection.d.mts +21 -0
- package/dist/esm/api/types/AuthProviderConnection.mjs +4 -0
- package/dist/esm/api/types/AuthProviderConnectionCreate.d.mts +19 -0
- package/dist/esm/api/types/AuthProviderConnectionCreate.mjs +4 -0
- package/dist/esm/api/types/AuthProviderConnectionUpdate.d.mts +15 -0
- package/dist/esm/api/types/AuthProviderConnectionUpdate.mjs +4 -0
- package/dist/esm/api/types/ConfigField.d.mts +1 -0
- package/dist/esm/api/types/Connection.d.mts +9 -0
- package/dist/esm/api/types/IntegrationType.d.mts +2 -1
- package/dist/esm/api/types/IntegrationType.mjs +1 -0
- package/dist/esm/api/types/SourceConnection.d.mts +4 -0
- package/dist/esm/api/types/index.d.mts +4 -0
- package/dist/esm/api/types/index.mjs +4 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +2 -2
package/dist/cjs/Client.js
CHANGED
|
@@ -50,8 +50,8 @@ class AirweaveSDKClient {
|
|
|
50
50
|
"X-Organization-ID": _options === null || _options === void 0 ? void 0 : _options.organizationId,
|
|
51
51
|
"X-Fern-Language": "JavaScript",
|
|
52
52
|
"X-Fern-SDK-Name": "@airweave/sdk",
|
|
53
|
-
"X-Fern-SDK-Version": "v0.3.
|
|
54
|
-
"User-Agent": "@airweave/sdk/v0.3.
|
|
53
|
+
"X-Fern-SDK-Version": "v0.3.46",
|
|
54
|
+
"User-Agent": "@airweave/sdk/v0.3.46",
|
|
55
55
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
56
56
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
57
57
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
package/dist/cjs/api/resources/sourceConnections/client/requests/SourceConnectionCreate.d.ts
CHANGED
|
@@ -24,6 +24,10 @@ export interface SourceConnectionCreate {
|
|
|
24
24
|
cron_schedule?: string;
|
|
25
25
|
/** Authentication credentials required to access the data source. The required fields vary by source type. Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
|
|
26
26
|
auth_fields?: AirweaveSDK.ConfigValues;
|
|
27
|
+
/** Unique readable ID of a connected auth provider to use for authentication instead of providing auth_fields directly. When specified, credentials for the source will be obtained and refreshed automatically by Airweave interaction with the auth provider. To see which auth providers are supported and learn more about how to use them, check [this page](https://docs.airweave.ai/docs/auth-providers). */
|
|
28
|
+
auth_provider?: string;
|
|
29
|
+
/** Configuration for the auth provider when using auth_provider field. Required fields vary by auth provider. For Composio, use integration_id and account_id to specify which integration and account from Composio you want to use to connect to the source. */
|
|
30
|
+
auth_provider_config?: AirweaveSDK.ConfigValues;
|
|
27
31
|
/** Whether to start an initial data synchronization immediately after creating the connection. */
|
|
28
32
|
sync_immediately?: boolean;
|
|
29
33
|
}
|
package/dist/cjs/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts
CHANGED
|
@@ -21,6 +21,10 @@ export interface SourceConnectionUpdate {
|
|
|
21
21
|
connection_id?: string;
|
|
22
22
|
/** ID of the white label integration. Used for custom OAuth integrations with your own branding. */
|
|
23
23
|
white_label_id?: string;
|
|
24
|
+
/** Updated auth provider readable ID. Only relevant if the connection uses an auth provider. */
|
|
25
|
+
auth_provider?: string;
|
|
26
|
+
/** Updated configuration for the auth provider. Only relevant if the connection uses an auth provider. */
|
|
27
|
+
auth_provider_config?: Record<string, unknown>;
|
|
24
28
|
}
|
|
25
29
|
export declare namespace SourceConnectionUpdate {
|
|
26
30
|
/**
|
|
@@ -147,10 +147,10 @@ export declare class WhiteLabels {
|
|
|
147
147
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
148
148
|
*
|
|
149
149
|
* @example
|
|
150
|
-
* await client.whiteLabels.
|
|
150
|
+
* await client.whiteLabels.getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions("white_label_id")
|
|
151
151
|
*/
|
|
152
|
-
|
|
153
|
-
private
|
|
152
|
+
getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId: string, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<string>;
|
|
153
|
+
private __getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions;
|
|
154
154
|
/**
|
|
155
155
|
* List all source connections created through a specific white label integration.
|
|
156
156
|
*
|
|
@@ -409,12 +409,12 @@ class WhiteLabels {
|
|
|
409
409
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
410
410
|
*
|
|
411
411
|
* @example
|
|
412
|
-
* await client.whiteLabels.
|
|
412
|
+
* await client.whiteLabels.getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions("white_label_id")
|
|
413
413
|
*/
|
|
414
|
-
|
|
415
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
414
|
+
getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId, requestOptions) {
|
|
415
|
+
return core.HttpResponsePromise.fromPromise(this.__getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId, requestOptions));
|
|
416
416
|
}
|
|
417
|
-
|
|
417
|
+
__getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId, requestOptions) {
|
|
418
418
|
return __awaiter(this, void 0, void 0, function* () {
|
|
419
419
|
var _a, _b, _c;
|
|
420
420
|
const _response = yield core.fetcher({
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Schema for auth provider response.
|
|
7
|
+
*/
|
|
8
|
+
export interface AuthProvider {
|
|
9
|
+
/** Human-readable name of the auth provider (e.g., 'Google OAuth', 'GitHub') */
|
|
10
|
+
name: string;
|
|
11
|
+
/** Technical identifier used internally to reference this auth provider. Must be unique. */
|
|
12
|
+
short_name: string;
|
|
13
|
+
/** Python class name of the auth provider implementation */
|
|
14
|
+
class_name: string;
|
|
15
|
+
/** Python class name that defines the authentication configuration fields */
|
|
16
|
+
auth_config_class: string;
|
|
17
|
+
/** Python class name that defines the auth provider-specific configuration */
|
|
18
|
+
config_class: string;
|
|
19
|
+
/** Type of authentication mechanism used by this provider */
|
|
20
|
+
auth_type: AirweaveSDK.AuthType;
|
|
21
|
+
/** Detailed description explaining what this auth provider offers */
|
|
22
|
+
description?: string;
|
|
23
|
+
/** Organization identifier for custom auth providers. System providers have this set to null. */
|
|
24
|
+
organization_id?: string;
|
|
25
|
+
id: string;
|
|
26
|
+
created_at: string;
|
|
27
|
+
modified_at: string;
|
|
28
|
+
/** Dynamically populated field definitions for authentication configuration. These describe what credentials are required to connect to this auth provider. */
|
|
29
|
+
auth_fields?: AirweaveSDK.Fields;
|
|
30
|
+
/** Dynamically populated field definitions for auth provider-specific configuration. These describe what additional configuration is required when using this auth provider to connect to a source (e.g., integration_id and account_id for Composio). */
|
|
31
|
+
config_fields?: AirweaveSDK.Fields;
|
|
32
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Schema for auth provider connection response.
|
|
6
|
+
*/
|
|
7
|
+
export interface AuthProviderConnection {
|
|
8
|
+
id: string;
|
|
9
|
+
name: string;
|
|
10
|
+
/** URL-safe unique identifier that can be used to reference this connection when setting up source connections. */
|
|
11
|
+
readable_id: string;
|
|
12
|
+
short_name: string;
|
|
13
|
+
/** Description of the connection */
|
|
14
|
+
description?: string;
|
|
15
|
+
/** Email of the user who created this connection */
|
|
16
|
+
created_by_email?: string;
|
|
17
|
+
/** Email of the user who last modified this connection */
|
|
18
|
+
modified_by_email?: string;
|
|
19
|
+
created_at: string;
|
|
20
|
+
modified_at: string;
|
|
21
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Schema for creating an auth provider connection with credentials.
|
|
7
|
+
*/
|
|
8
|
+
export interface AuthProviderConnectionCreate {
|
|
9
|
+
/** Human-readable name for this auth provider connection */
|
|
10
|
+
name: string;
|
|
11
|
+
/** URL-safe unique identifier for the connection. Must contain only lowercase letters, numbers, and hyphens. If not provided, it will be automatically generated from the connection name with a random suffix for uniqueness (e.g., 'composio-connection-ab123'). */
|
|
12
|
+
readable_id?: string;
|
|
13
|
+
/** Optional detailed description of what this auth provider connection provides. */
|
|
14
|
+
description?: string;
|
|
15
|
+
/** Technical identifier of the auth provider */
|
|
16
|
+
short_name: string;
|
|
17
|
+
/** Authentication credentials required to access the auth provider. The required fields vary by auth provider type. */
|
|
18
|
+
auth_fields?: AirweaveSDK.ConfigValues;
|
|
19
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Schema for updating an auth provider connection.
|
|
7
|
+
*/
|
|
8
|
+
export interface AuthProviderConnectionUpdate {
|
|
9
|
+
/** Human-readable name for this auth provider connection */
|
|
10
|
+
name?: string;
|
|
11
|
+
/** Optional detailed description of what this auth provider connection provides. */
|
|
12
|
+
description?: string;
|
|
13
|
+
/** Updated authentication credentials for the auth provider. The required fields vary by auth provider type. If provided, all existing credentials will be replaced. */
|
|
14
|
+
auth_fields?: AirweaveSDK.ConfigValues;
|
|
15
|
+
}
|
|
@@ -6,12 +6,21 @@ import * as AirweaveSDK from "../index.js";
|
|
|
6
6
|
* Schema for connection with config fields.
|
|
7
7
|
*/
|
|
8
8
|
export interface Connection {
|
|
9
|
+
/** Human-readable display name for the connection. */
|
|
9
10
|
name: string;
|
|
11
|
+
/** URL-safe unique identifier used in API endpoints. This becomes non-optional once the connection is created. */
|
|
12
|
+
readable_id: string;
|
|
13
|
+
description?: string;
|
|
10
14
|
integration_type: AirweaveSDK.IntegrationType;
|
|
11
15
|
integration_credential_id?: string;
|
|
12
16
|
status: AirweaveSDK.ConnectionStatus;
|
|
13
17
|
short_name: string;
|
|
18
|
+
/** Unique system identifier for the connection. */
|
|
14
19
|
id: string;
|
|
20
|
+
/** Timestamp when the connection was created (ISO 8601 format). */
|
|
21
|
+
created_at: string;
|
|
22
|
+
/** Timestamp when the connection was last modified (ISO 8601 format). */
|
|
23
|
+
modified_at: string;
|
|
15
24
|
organization_id?: string;
|
|
16
25
|
created_by_email?: string;
|
|
17
26
|
modified_by_email?: string;
|
|
@@ -4,9 +4,10 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Integration type enum.
|
|
6
6
|
*/
|
|
7
|
-
export type IntegrationType = "source" | "destination" | "embedding_model";
|
|
7
|
+
export type IntegrationType = "source" | "destination" | "embedding_model" | "auth_provider";
|
|
8
8
|
export declare const IntegrationType: {
|
|
9
9
|
readonly Source: "source";
|
|
10
10
|
readonly Destination: "destination";
|
|
11
11
|
readonly EmbeddingModel: "embedding_model";
|
|
12
|
+
readonly AuthProvider: "auth_provider";
|
|
12
13
|
};
|
|
@@ -16,6 +16,10 @@ export interface SourceConnection {
|
|
|
16
16
|
short_name: string;
|
|
17
17
|
/** Identifier for custom OAuth integrations. Only present for connections created through white label OAuth flows. */
|
|
18
18
|
white_label_id?: string;
|
|
19
|
+
/** Readable ID of the auth provider used to create this connection. Present only if the connection was created through an auth provider. */
|
|
20
|
+
auth_provider?: string;
|
|
21
|
+
/** Configuration used with the auth provider to create this connection. Present only if the connection was created through an auth provider. */
|
|
22
|
+
auth_provider_config?: Record<string, unknown>;
|
|
19
23
|
/** Unique system identifier for this source connection. This UUID is generated automatically and used for API operations. */
|
|
20
24
|
id: string;
|
|
21
25
|
/** Internal identifier for the sync configuration associated with this source connection. Managed automatically by the system. */
|
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
export * from "./ApiKey.js";
|
|
2
2
|
export * from "./ApiKeyCreate.js";
|
|
3
|
+
export * from "./AuthProvider.js";
|
|
4
|
+
export * from "./AuthProviderConnection.js";
|
|
5
|
+
export * from "./AuthProviderConnectionCreate.js";
|
|
6
|
+
export * from "./AuthProviderConnectionUpdate.js";
|
|
3
7
|
export * from "./AuthType.js";
|
|
4
8
|
export * from "./BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js";
|
|
5
9
|
export * from "./BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.js";
|
|
@@ -16,6 +16,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./ApiKey.js"), exports);
|
|
18
18
|
__exportStar(require("./ApiKeyCreate.js"), exports);
|
|
19
|
+
__exportStar(require("./AuthProvider.js"), exports);
|
|
20
|
+
__exportStar(require("./AuthProviderConnection.js"), exports);
|
|
21
|
+
__exportStar(require("./AuthProviderConnectionCreate.js"), exports);
|
|
22
|
+
__exportStar(require("./AuthProviderConnectionUpdate.js"), exports);
|
|
19
23
|
__exportStar(require("./AuthType.js"), exports);
|
|
20
24
|
__exportStar(require("./BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js"), exports);
|
|
21
25
|
__exportStar(require("./BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "v0.3.
|
|
1
|
+
export declare const SDK_VERSION = "v0.3.46";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -14,8 +14,8 @@ export class AirweaveSDKClient {
|
|
|
14
14
|
"X-Organization-ID": _options === null || _options === void 0 ? void 0 : _options.organizationId,
|
|
15
15
|
"X-Fern-Language": "JavaScript",
|
|
16
16
|
"X-Fern-SDK-Name": "@airweave/sdk",
|
|
17
|
-
"X-Fern-SDK-Version": "v0.3.
|
|
18
|
-
"User-Agent": "@airweave/sdk/v0.3.
|
|
17
|
+
"X-Fern-SDK-Version": "v0.3.46",
|
|
18
|
+
"User-Agent": "@airweave/sdk/v0.3.46",
|
|
19
19
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
20
20
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
21
21
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
package/dist/esm/api/resources/sourceConnections/client/requests/SourceConnectionCreate.d.mts
CHANGED
|
@@ -24,6 +24,10 @@ export interface SourceConnectionCreate {
|
|
|
24
24
|
cron_schedule?: string;
|
|
25
25
|
/** Authentication credentials required to access the data source. The required fields vary by source type. Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
|
|
26
26
|
auth_fields?: AirweaveSDK.ConfigValues;
|
|
27
|
+
/** Unique readable ID of a connected auth provider to use for authentication instead of providing auth_fields directly. When specified, credentials for the source will be obtained and refreshed automatically by Airweave interaction with the auth provider. To see which auth providers are supported and learn more about how to use them, check [this page](https://docs.airweave.ai/docs/auth-providers). */
|
|
28
|
+
auth_provider?: string;
|
|
29
|
+
/** Configuration for the auth provider when using auth_provider field. Required fields vary by auth provider. For Composio, use integration_id and account_id to specify which integration and account from Composio you want to use to connect to the source. */
|
|
30
|
+
auth_provider_config?: AirweaveSDK.ConfigValues;
|
|
27
31
|
/** Whether to start an initial data synchronization immediately after creating the connection. */
|
|
28
32
|
sync_immediately?: boolean;
|
|
29
33
|
}
|
package/dist/esm/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.mts
CHANGED
|
@@ -21,6 +21,10 @@ export interface SourceConnectionUpdate {
|
|
|
21
21
|
connection_id?: string;
|
|
22
22
|
/** ID of the white label integration. Used for custom OAuth integrations with your own branding. */
|
|
23
23
|
white_label_id?: string;
|
|
24
|
+
/** Updated auth provider readable ID. Only relevant if the connection uses an auth provider. */
|
|
25
|
+
auth_provider?: string;
|
|
26
|
+
/** Updated configuration for the auth provider. Only relevant if the connection uses an auth provider. */
|
|
27
|
+
auth_provider_config?: Record<string, unknown>;
|
|
24
28
|
}
|
|
25
29
|
export declare namespace SourceConnectionUpdate {
|
|
26
30
|
/**
|
|
@@ -147,10 +147,10 @@ export declare class WhiteLabels {
|
|
|
147
147
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
148
148
|
*
|
|
149
149
|
* @example
|
|
150
|
-
* await client.whiteLabels.
|
|
150
|
+
* await client.whiteLabels.getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions("white_label_id")
|
|
151
151
|
*/
|
|
152
|
-
|
|
153
|
-
private
|
|
152
|
+
getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId: string, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<string>;
|
|
153
|
+
private __getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions;
|
|
154
154
|
/**
|
|
155
155
|
* List all source connections created through a specific white label integration.
|
|
156
156
|
*
|
|
@@ -373,12 +373,12 @@ export class WhiteLabels {
|
|
|
373
373
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
374
374
|
*
|
|
375
375
|
* @example
|
|
376
|
-
* await client.whiteLabels.
|
|
376
|
+
* await client.whiteLabels.getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions("white_label_id")
|
|
377
377
|
*/
|
|
378
|
-
|
|
379
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
378
|
+
getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId, requestOptions) {
|
|
379
|
+
return core.HttpResponsePromise.fromPromise(this.__getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId, requestOptions));
|
|
380
380
|
}
|
|
381
|
-
|
|
381
|
+
__getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId, requestOptions) {
|
|
382
382
|
return __awaiter(this, void 0, void 0, function* () {
|
|
383
383
|
var _a, _b, _c;
|
|
384
384
|
const _response = yield core.fetcher({
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Schema for auth provider response.
|
|
7
|
+
*/
|
|
8
|
+
export interface AuthProvider {
|
|
9
|
+
/** Human-readable name of the auth provider (e.g., 'Google OAuth', 'GitHub') */
|
|
10
|
+
name: string;
|
|
11
|
+
/** Technical identifier used internally to reference this auth provider. Must be unique. */
|
|
12
|
+
short_name: string;
|
|
13
|
+
/** Python class name of the auth provider implementation */
|
|
14
|
+
class_name: string;
|
|
15
|
+
/** Python class name that defines the authentication configuration fields */
|
|
16
|
+
auth_config_class: string;
|
|
17
|
+
/** Python class name that defines the auth provider-specific configuration */
|
|
18
|
+
config_class: string;
|
|
19
|
+
/** Type of authentication mechanism used by this provider */
|
|
20
|
+
auth_type: AirweaveSDK.AuthType;
|
|
21
|
+
/** Detailed description explaining what this auth provider offers */
|
|
22
|
+
description?: string;
|
|
23
|
+
/** Organization identifier for custom auth providers. System providers have this set to null. */
|
|
24
|
+
organization_id?: string;
|
|
25
|
+
id: string;
|
|
26
|
+
created_at: string;
|
|
27
|
+
modified_at: string;
|
|
28
|
+
/** Dynamically populated field definitions for authentication configuration. These describe what credentials are required to connect to this auth provider. */
|
|
29
|
+
auth_fields?: AirweaveSDK.Fields;
|
|
30
|
+
/** Dynamically populated field definitions for auth provider-specific configuration. These describe what additional configuration is required when using this auth provider to connect to a source (e.g., integration_id and account_id for Composio). */
|
|
31
|
+
config_fields?: AirweaveSDK.Fields;
|
|
32
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Schema for auth provider connection response.
|
|
6
|
+
*/
|
|
7
|
+
export interface AuthProviderConnection {
|
|
8
|
+
id: string;
|
|
9
|
+
name: string;
|
|
10
|
+
/** URL-safe unique identifier that can be used to reference this connection when setting up source connections. */
|
|
11
|
+
readable_id: string;
|
|
12
|
+
short_name: string;
|
|
13
|
+
/** Description of the connection */
|
|
14
|
+
description?: string;
|
|
15
|
+
/** Email of the user who created this connection */
|
|
16
|
+
created_by_email?: string;
|
|
17
|
+
/** Email of the user who last modified this connection */
|
|
18
|
+
modified_by_email?: string;
|
|
19
|
+
created_at: string;
|
|
20
|
+
modified_at: string;
|
|
21
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Schema for creating an auth provider connection with credentials.
|
|
7
|
+
*/
|
|
8
|
+
export interface AuthProviderConnectionCreate {
|
|
9
|
+
/** Human-readable name for this auth provider connection */
|
|
10
|
+
name: string;
|
|
11
|
+
/** URL-safe unique identifier for the connection. Must contain only lowercase letters, numbers, and hyphens. If not provided, it will be automatically generated from the connection name with a random suffix for uniqueness (e.g., 'composio-connection-ab123'). */
|
|
12
|
+
readable_id?: string;
|
|
13
|
+
/** Optional detailed description of what this auth provider connection provides. */
|
|
14
|
+
description?: string;
|
|
15
|
+
/** Technical identifier of the auth provider */
|
|
16
|
+
short_name: string;
|
|
17
|
+
/** Authentication credentials required to access the auth provider. The required fields vary by auth provider type. */
|
|
18
|
+
auth_fields?: AirweaveSDK.ConfigValues;
|
|
19
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Schema for updating an auth provider connection.
|
|
7
|
+
*/
|
|
8
|
+
export interface AuthProviderConnectionUpdate {
|
|
9
|
+
/** Human-readable name for this auth provider connection */
|
|
10
|
+
name?: string;
|
|
11
|
+
/** Optional detailed description of what this auth provider connection provides. */
|
|
12
|
+
description?: string;
|
|
13
|
+
/** Updated authentication credentials for the auth provider. The required fields vary by auth provider type. If provided, all existing credentials will be replaced. */
|
|
14
|
+
auth_fields?: AirweaveSDK.ConfigValues;
|
|
15
|
+
}
|
|
@@ -6,12 +6,21 @@ import * as AirweaveSDK from "../index.mjs";
|
|
|
6
6
|
* Schema for connection with config fields.
|
|
7
7
|
*/
|
|
8
8
|
export interface Connection {
|
|
9
|
+
/** Human-readable display name for the connection. */
|
|
9
10
|
name: string;
|
|
11
|
+
/** URL-safe unique identifier used in API endpoints. This becomes non-optional once the connection is created. */
|
|
12
|
+
readable_id: string;
|
|
13
|
+
description?: string;
|
|
10
14
|
integration_type: AirweaveSDK.IntegrationType;
|
|
11
15
|
integration_credential_id?: string;
|
|
12
16
|
status: AirweaveSDK.ConnectionStatus;
|
|
13
17
|
short_name: string;
|
|
18
|
+
/** Unique system identifier for the connection. */
|
|
14
19
|
id: string;
|
|
20
|
+
/** Timestamp when the connection was created (ISO 8601 format). */
|
|
21
|
+
created_at: string;
|
|
22
|
+
/** Timestamp when the connection was last modified (ISO 8601 format). */
|
|
23
|
+
modified_at: string;
|
|
15
24
|
organization_id?: string;
|
|
16
25
|
created_by_email?: string;
|
|
17
26
|
modified_by_email?: string;
|
|
@@ -4,9 +4,10 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Integration type enum.
|
|
6
6
|
*/
|
|
7
|
-
export type IntegrationType = "source" | "destination" | "embedding_model";
|
|
7
|
+
export type IntegrationType = "source" | "destination" | "embedding_model" | "auth_provider";
|
|
8
8
|
export declare const IntegrationType: {
|
|
9
9
|
readonly Source: "source";
|
|
10
10
|
readonly Destination: "destination";
|
|
11
11
|
readonly EmbeddingModel: "embedding_model";
|
|
12
|
+
readonly AuthProvider: "auth_provider";
|
|
12
13
|
};
|
|
@@ -16,6 +16,10 @@ export interface SourceConnection {
|
|
|
16
16
|
short_name: string;
|
|
17
17
|
/** Identifier for custom OAuth integrations. Only present for connections created through white label OAuth flows. */
|
|
18
18
|
white_label_id?: string;
|
|
19
|
+
/** Readable ID of the auth provider used to create this connection. Present only if the connection was created through an auth provider. */
|
|
20
|
+
auth_provider?: string;
|
|
21
|
+
/** Configuration used with the auth provider to create this connection. Present only if the connection was created through an auth provider. */
|
|
22
|
+
auth_provider_config?: Record<string, unknown>;
|
|
19
23
|
/** Unique system identifier for this source connection. This UUID is generated automatically and used for API operations. */
|
|
20
24
|
id: string;
|
|
21
25
|
/** Internal identifier for the sync configuration associated with this source connection. Managed automatically by the system. */
|
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
export * from "./ApiKey.mjs";
|
|
2
2
|
export * from "./ApiKeyCreate.mjs";
|
|
3
|
+
export * from "./AuthProvider.mjs";
|
|
4
|
+
export * from "./AuthProviderConnection.mjs";
|
|
5
|
+
export * from "./AuthProviderConnectionCreate.mjs";
|
|
6
|
+
export * from "./AuthProviderConnectionUpdate.mjs";
|
|
3
7
|
export * from "./AuthType.mjs";
|
|
4
8
|
export * from "./BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.mjs";
|
|
5
9
|
export * from "./BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.mjs";
|
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
export * from "./ApiKey.mjs";
|
|
2
2
|
export * from "./ApiKeyCreate.mjs";
|
|
3
|
+
export * from "./AuthProvider.mjs";
|
|
4
|
+
export * from "./AuthProviderConnection.mjs";
|
|
5
|
+
export * from "./AuthProviderConnectionCreate.mjs";
|
|
6
|
+
export * from "./AuthProviderConnectionUpdate.mjs";
|
|
3
7
|
export * from "./AuthType.mjs";
|
|
4
8
|
export * from "./BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.mjs";
|
|
5
9
|
export * from "./BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "v0.3.
|
|
1
|
+
export declare const SDK_VERSION = "v0.3.46";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "v0.3.
|
|
1
|
+
export const SDK_VERSION = "v0.3.46";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1720,7 +1720,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
1720
1720
|
</dl>
|
|
1721
1721
|
</details>
|
|
1722
1722
|
|
|
1723
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">
|
|
1723
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions</a>(whiteLabelId) -> string</code></summary>
|
|
1724
1724
|
<dl>
|
|
1725
1725
|
<dd>
|
|
1726
1726
|
|
|
@@ -1753,7 +1753,7 @@ branding instead of Airweave.
|
|
|
1753
1753
|
<dd>
|
|
1754
1754
|
|
|
1755
1755
|
```typescript
|
|
1756
|
-
await client.whiteLabels.
|
|
1756
|
+
await client.whiteLabels.getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions("white_label_id");
|
|
1757
1757
|
```
|
|
1758
1758
|
|
|
1759
1759
|
</dd>
|