@airweave/sdk 0.6.0 → 0.6.3
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.d.ts +0 -3
- package/dist/cjs/Client.js +2 -7
- package/dist/cjs/api/resources/index.d.ts +0 -2
- package/dist/cjs/api/resources/index.js +1 -3
- package/dist/cjs/api/resources/sourceConnections/client/Client.d.ts +31 -82
- package/dist/cjs/api/resources/sourceConnections/client/Client.js +45 -190
- package/dist/cjs/api/resources/sourceConnections/client/requests/GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest.d.ts +10 -0
- package/dist/cjs/api/resources/sourceConnections/client/requests/ListSourceConnectionsGetRequest.d.ts +1 -7
- package/dist/cjs/api/resources/sourceConnections/client/requests/SourceConnectionCreate.d.ts +21 -20
- package/dist/cjs/api/resources/sourceConnections/client/requests/index.d.ts +1 -3
- package/dist/cjs/api/types/ActionCheckRequest.d.ts +10 -0
- package/dist/cjs/api/types/ActionCheckResponse.d.ts +4 -16
- package/dist/cjs/api/types/ActionCheckResponse.js +0 -8
- package/dist/cjs/api/types/AuthProvider.d.ts +0 -2
- package/dist/cjs/api/types/AuthProviderAuthentication.d.ts +12 -0
- package/dist/cjs/api/types/AuthenticationDetails.d.ts +19 -0
- package/dist/cjs/api/types/AuthenticationMethod.d.ts +14 -0
- package/dist/cjs/api/types/AuthenticationMethod.js +13 -0
- package/dist/cjs/api/types/Destination.d.ts +0 -2
- package/dist/cjs/api/types/DestinationWithAuthenticationFields.d.ts +0 -1
- package/dist/cjs/api/types/DirectAuthentication.d.ts +10 -0
- package/dist/cjs/api/types/EmbeddingModel.d.ts +0 -2
- package/dist/cjs/api/types/EmbeddingModelWithAuthenticationFields.d.ts +0 -1
- package/dist/cjs/api/types/EntityCountWithDefinition.d.ts +1 -0
- package/dist/cjs/api/types/EntitySummary.d.ts +12 -0
- package/dist/cjs/api/types/EntityTypeStats.d.ts +10 -0
- package/dist/cjs/api/types/IntegrationCredentialInDb.d.ts +2 -1
- package/dist/cjs/api/types/IntegrationCredentialRawCreate.d.ts +2 -1
- package/dist/cjs/api/types/OAuthBrowserAuthentication.d.ts +14 -0
- package/dist/cjs/api/types/OAuthTokenAuthentication.d.ts +14 -0
- package/dist/cjs/api/types/OAuthType.d.ts +12 -0
- package/dist/cjs/api/types/OAuthType.js +11 -0
- package/dist/cjs/api/types/ScheduleConfig.d.ts +14 -0
- package/dist/cjs/api/types/ScheduleDetails.d.ts +13 -0
- package/dist/cjs/api/types/SingleActionCheckResponse.d.ts +23 -0
- package/dist/cjs/api/types/SingleActionCheckResponse.js +13 -0
- package/dist/cjs/api/types/Source.d.ts +11 -7
- package/dist/cjs/api/types/SourceConnection.d.ts +9 -52
- package/dist/cjs/api/types/SourceConnectionJob.d.ts +9 -34
- package/dist/cjs/api/types/SourceConnectionListItem.d.ts +13 -16
- package/dist/cjs/api/types/SourceConnectionStatus.d.ts +7 -4
- package/dist/cjs/api/types/SourceConnectionStatus.js +5 -2
- package/dist/cjs/api/types/SourceConnectionUpdate.d.ts +16 -0
- package/dist/cjs/api/types/SyncDetails.d.ts +13 -0
- package/dist/cjs/api/types/SyncJobDetails.d.ts +20 -0
- package/dist/cjs/api/types/SyncJobStatus.d.ts +2 -2
- package/dist/cjs/api/types/SyncJobStatus.js +1 -1
- package/dist/cjs/api/types/SyncSummary.d.ts +11 -0
- package/dist/cjs/api/types/SyncSummary.js +5 -0
- package/dist/cjs/api/types/index.d.ts +17 -9
- package/dist/cjs/api/types/index.js +17 -9
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +0 -3
- package/dist/esm/Client.mjs +2 -7
- package/dist/esm/api/resources/index.d.mts +0 -2
- package/dist/esm/api/resources/index.mjs +0 -2
- package/dist/esm/api/resources/sourceConnections/client/Client.d.mts +31 -82
- package/dist/esm/api/resources/sourceConnections/client/Client.mjs +45 -190
- package/dist/esm/api/resources/sourceConnections/client/requests/GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest.d.mts +10 -0
- package/dist/esm/api/resources/sourceConnections/client/requests/ListSourceConnectionsGetRequest.d.mts +1 -7
- package/dist/esm/api/resources/sourceConnections/client/requests/SourceConnectionCreate.d.mts +21 -20
- package/dist/esm/api/resources/sourceConnections/client/requests/index.d.mts +1 -3
- package/dist/esm/api/types/ActionCheckRequest.d.mts +10 -0
- package/dist/esm/api/types/ActionCheckResponse.d.mts +4 -16
- package/dist/esm/api/types/ActionCheckResponse.mjs +1 -7
- package/dist/esm/api/types/AuthProvider.d.mts +0 -2
- package/dist/esm/api/types/AuthProviderAuthentication.d.mts +12 -0
- package/dist/esm/api/types/AuthenticationDetails.d.mts +19 -0
- package/dist/esm/api/types/AuthenticationMethod.d.mts +14 -0
- package/dist/esm/api/types/AuthenticationMethod.mjs +10 -0
- package/dist/esm/api/types/Destination.d.mts +0 -2
- package/dist/esm/api/types/DestinationWithAuthenticationFields.d.mts +0 -1
- package/dist/esm/api/types/DirectAuthentication.d.mts +10 -0
- package/dist/esm/api/types/EmbeddingModel.d.mts +0 -2
- package/dist/esm/api/types/EmbeddingModelWithAuthenticationFields.d.mts +0 -1
- package/dist/esm/api/types/EntityCountWithDefinition.d.mts +1 -0
- package/dist/esm/api/types/EntitySummary.d.mts +12 -0
- package/dist/esm/api/types/EntityTypeStats.d.mts +10 -0
- package/dist/esm/api/types/IntegrationCredentialInDb.d.mts +2 -1
- package/dist/esm/api/types/IntegrationCredentialRawCreate.d.mts +2 -1
- package/dist/esm/api/types/OAuthBrowserAuthentication.d.mts +14 -0
- package/dist/esm/api/types/OAuthTokenAuthentication.d.mts +14 -0
- package/dist/esm/api/types/OAuthType.d.mts +12 -0
- package/dist/esm/api/types/OAuthType.mjs +8 -0
- package/dist/esm/api/types/ScheduleConfig.d.mts +14 -0
- package/dist/esm/api/types/ScheduleDetails.d.mts +13 -0
- package/dist/esm/api/types/SingleActionCheckResponse.d.mts +23 -0
- package/dist/esm/api/types/SingleActionCheckResponse.mjs +10 -0
- package/dist/esm/api/types/Source.d.mts +11 -7
- package/dist/esm/api/types/SourceConnection.d.mts +9 -52
- package/dist/esm/api/types/SourceConnectionJob.d.mts +9 -34
- package/dist/esm/api/types/SourceConnectionListItem.d.mts +13 -16
- package/dist/esm/api/types/SourceConnectionStatus.d.mts +7 -4
- package/dist/esm/api/types/SourceConnectionStatus.mjs +5 -2
- package/dist/esm/api/types/SourceConnectionUpdate.d.mts +16 -0
- package/dist/esm/api/types/SyncDetails.d.mts +13 -0
- package/dist/esm/api/types/SyncJobDetails.d.mts +20 -0
- package/dist/esm/api/types/SyncJobStatus.d.mts +2 -2
- package/dist/esm/api/types/SyncJobStatus.mjs +1 -1
- package/dist/esm/api/types/SyncSummary.d.mts +11 -0
- package/dist/esm/api/types/SyncSummary.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +17 -9
- package/dist/esm/api/types/index.mjs +17 -9
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +30 -763
- package/dist/cjs/api/resources/sourceConnections/client/requests/BodyRunSourceConnectionsSourceConnectionIdRunPost.d.ts +0 -11
- package/dist/cjs/api/resources/sourceConnections/client/requests/GetSourceConnectionsSourceConnectionIdGetRequest.d.ts +0 -13
- package/dist/cjs/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts +0 -34
- package/dist/cjs/api/resources/whiteLabels/client/Client.d.ts +0 -189
- package/dist/cjs/api/resources/whiteLabels/client/Client.js +0 -585
- package/dist/cjs/api/resources/whiteLabels/client/index.d.ts +0 -2
- package/dist/cjs/api/resources/whiteLabels/client/index.js +0 -17
- package/dist/cjs/api/resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.d.ts +0 -16
- package/dist/cjs/api/resources/whiteLabels/client/requests/WhiteLabelCreate.d.ts +0 -28
- package/dist/cjs/api/resources/whiteLabels/client/requests/WhiteLabelUpdate.d.ts +0 -23
- package/dist/cjs/api/resources/whiteLabels/client/requests/index.d.ts +0 -3
- package/dist/cjs/api/resources/whiteLabels/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/whiteLabels/index.d.ts +0 -1
- package/dist/cjs/api/resources/whiteLabels/index.js +0 -17
- package/dist/cjs/api/types/AuthType.d.ts +0 -27
- package/dist/cjs/api/types/AuthType.js +0 -16
- package/dist/cjs/api/types/BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.d.ts +0 -13
- package/dist/cjs/api/types/OAuth2AuthUrl.d.ts +0 -13
- package/dist/cjs/api/types/SourceConnectionContinuousResponse.d.ts +0 -67
- package/dist/cjs/api/types/SourceConnectionCreateContinuous.d.ts +0 -33
- package/dist/cjs/api/types/SourceConnectionCreateWithCredential.d.ts +0 -25
- package/dist/cjs/api/types/SourceConnectionCreateWithWhiteLabel.d.ts +0 -29
- package/dist/cjs/api/types/SourceConnectionMakeContinuous.d.ts +0 -14
- package/dist/cjs/api/types/WhiteLabel.d.ts +0 -32
- package/dist/esm/api/resources/sourceConnections/client/requests/BodyRunSourceConnectionsSourceConnectionIdRunPost.d.mts +0 -11
- package/dist/esm/api/resources/sourceConnections/client/requests/GetSourceConnectionsSourceConnectionIdGetRequest.d.mts +0 -13
- package/dist/esm/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.mts +0 -34
- package/dist/esm/api/resources/whiteLabels/client/Client.d.mts +0 -189
- package/dist/esm/api/resources/whiteLabels/client/Client.mjs +0 -548
- package/dist/esm/api/resources/whiteLabels/client/index.d.mts +0 -2
- package/dist/esm/api/resources/whiteLabels/client/index.mjs +0 -1
- package/dist/esm/api/resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.d.mts +0 -16
- package/dist/esm/api/resources/whiteLabels/client/requests/WhiteLabelCreate.d.mts +0 -28
- package/dist/esm/api/resources/whiteLabels/client/requests/WhiteLabelUpdate.d.mts +0 -23
- package/dist/esm/api/resources/whiteLabels/client/requests/index.d.mts +0 -3
- package/dist/esm/api/resources/whiteLabels/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/whiteLabels/index.d.mts +0 -1
- package/dist/esm/api/resources/whiteLabels/index.mjs +0 -1
- package/dist/esm/api/types/AuthType.d.mts +0 -27
- package/dist/esm/api/types/AuthType.mjs +0 -13
- package/dist/esm/api/types/BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.d.mts +0 -13
- package/dist/esm/api/types/OAuth2AuthUrl.d.mts +0 -13
- package/dist/esm/api/types/SourceConnectionContinuousResponse.d.mts +0 -67
- package/dist/esm/api/types/SourceConnectionCreateContinuous.d.mts +0 -33
- package/dist/esm/api/types/SourceConnectionCreateWithCredential.d.mts +0 -25
- package/dist/esm/api/types/SourceConnectionCreateWithWhiteLabel.d.mts +0 -29
- package/dist/esm/api/types/SourceConnectionMakeContinuous.d.mts +0 -14
- package/dist/esm/api/types/WhiteLabel.d.mts +0 -32
- /package/dist/cjs/api/resources/sourceConnections/client/requests/{BodyRunSourceConnectionsSourceConnectionIdRunPost.js → GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest.js} +0 -0
- /package/dist/cjs/api/{resources/sourceConnections/client/requests/GetSourceConnectionsSourceConnectionIdGetRequest.js → types/ActionCheckRequest.js} +0 -0
- /package/dist/cjs/api/{resources/sourceConnections/client/requests/SourceConnectionUpdate.js → types/AuthProviderAuthentication.js} +0 -0
- /package/dist/cjs/api/{resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.js → types/AuthenticationDetails.js} +0 -0
- /package/dist/cjs/api/{resources/whiteLabels/client/requests/WhiteLabelCreate.js → types/DirectAuthentication.js} +0 -0
- /package/dist/cjs/api/{resources/whiteLabels/client/requests/WhiteLabelUpdate.js → types/EntitySummary.js} +0 -0
- /package/dist/cjs/api/types/{BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.js → EntityTypeStats.js} +0 -0
- /package/dist/cjs/api/types/{OAuth2AuthUrl.js → OAuthBrowserAuthentication.js} +0 -0
- /package/dist/cjs/api/types/{SourceConnectionContinuousResponse.js → OAuthTokenAuthentication.js} +0 -0
- /package/dist/cjs/api/types/{SourceConnectionCreateContinuous.js → ScheduleConfig.js} +0 -0
- /package/dist/cjs/api/types/{SourceConnectionCreateWithCredential.js → ScheduleDetails.js} +0 -0
- /package/dist/cjs/api/types/{SourceConnectionCreateWithWhiteLabel.js → SourceConnectionUpdate.js} +0 -0
- /package/dist/cjs/api/types/{SourceConnectionMakeContinuous.js → SyncDetails.js} +0 -0
- /package/dist/cjs/api/types/{WhiteLabel.js → SyncJobDetails.js} +0 -0
- /package/dist/esm/api/resources/sourceConnections/client/requests/{BodyRunSourceConnectionsSourceConnectionIdRunPost.mjs → GetSourceConnectionJobsSourceConnectionsSourceConnectionIdJobsGetRequest.mjs} +0 -0
- /package/dist/esm/api/{resources/sourceConnections/client/requests/GetSourceConnectionsSourceConnectionIdGetRequest.mjs → types/ActionCheckRequest.mjs} +0 -0
- /package/dist/esm/api/{resources/sourceConnections/client/requests/SourceConnectionUpdate.mjs → types/AuthProviderAuthentication.mjs} +0 -0
- /package/dist/esm/api/{resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.mjs → types/AuthenticationDetails.mjs} +0 -0
- /package/dist/esm/api/{resources/whiteLabels/client/requests/WhiteLabelCreate.mjs → types/DirectAuthentication.mjs} +0 -0
- /package/dist/esm/api/{resources/whiteLabels/client/requests/WhiteLabelUpdate.mjs → types/EntitySummary.mjs} +0 -0
- /package/dist/esm/api/types/{BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.mjs → EntityTypeStats.mjs} +0 -0
- /package/dist/esm/api/types/{OAuth2AuthUrl.mjs → OAuthBrowserAuthentication.mjs} +0 -0
- /package/dist/esm/api/types/{SourceConnectionContinuousResponse.mjs → OAuthTokenAuthentication.mjs} +0 -0
- /package/dist/esm/api/types/{SourceConnectionCreateContinuous.mjs → ScheduleConfig.mjs} +0 -0
- /package/dist/esm/api/types/{SourceConnectionCreateWithCredential.mjs → ScheduleDetails.mjs} +0 -0
- /package/dist/esm/api/types/{SourceConnectionCreateWithWhiteLabel.mjs → SourceConnectionUpdate.mjs} +0 -0
- /package/dist/esm/api/types/{SourceConnectionMakeContinuous.mjs → SyncDetails.mjs} +0 -0
- /package/dist/esm/api/types/{WhiteLabel.mjs → SyncJobDetails.mjs} +0 -0
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {}
|
|
7
|
-
*/
|
|
8
|
-
export interface BodyRunSourceConnectionsSourceConnectionIdRunPost {
|
|
9
|
-
/** This parameter gives you the ability to start a sync job with an access token for an OAuth2.0 source directly instead of using the credentials that Airweave has stored for you. Learn more about direct token injection [here](https://docs.airweave.ai/direct-token-injection). */
|
|
10
|
-
access_token?: string;
|
|
11
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {}
|
|
7
|
-
*/
|
|
8
|
-
export interface GetSourceConnectionsSourceConnectionIdGetRequest {
|
|
9
|
-
/**
|
|
10
|
-
* Whether to reveal authentication credentials.
|
|
11
|
-
*/
|
|
12
|
-
show_auth_fields?: boolean;
|
|
13
|
-
}
|
package/dist/cjs/api/resources/sourceConnections/client/requests/SourceConnectionUpdate.d.ts
DELETED
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as AirweaveSDK from "../../../../index.js";
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {}
|
|
8
|
-
*/
|
|
9
|
-
export interface SourceConnectionUpdate {
|
|
10
|
-
/** Updated name for the source connection. Must be between 4 and 42 characters. */
|
|
11
|
-
name?: string;
|
|
12
|
-
/** Updated description of what this source connection provides. */
|
|
13
|
-
description?: string;
|
|
14
|
-
/** Updated authentication credentials for the data source. Provide new credentials to refresh or update authentication. */
|
|
15
|
-
auth_fields?: SourceConnectionUpdate.AuthFields;
|
|
16
|
-
/** Source-specific configuration parameters required for data extraction. These vary by source type and control how data is retrieved (e.g., database queries, API filters, file paths). Check the documentation of a specific source (for example [Github](https://docs.airweave.ai/docs/connectors/github)) to see what is required. */
|
|
17
|
-
config_fields?: AirweaveSDK.ConfigValues;
|
|
18
|
-
/** Updated cron expression for automatic synchronization schedule. Set to null to disable automatic syncing. */
|
|
19
|
-
cron_schedule?: string;
|
|
20
|
-
/** Internal connection identifier. This is typically managed automatically and should not be modified manually. */
|
|
21
|
-
connection_id?: string;
|
|
22
|
-
/** ID of the white label integration. Used for custom OAuth integrations with your own branding. */
|
|
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>;
|
|
28
|
-
}
|
|
29
|
-
export declare namespace SourceConnectionUpdate {
|
|
30
|
-
/**
|
|
31
|
-
* Updated authentication credentials for the data source. Provide new credentials to refresh or update authentication.
|
|
32
|
-
*/
|
|
33
|
-
type AuthFields = AirweaveSDK.ConfigValues | string;
|
|
34
|
-
}
|
|
@@ -1,189 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
import * as environments from "../../../../environments.js";
|
|
5
|
-
import * as core from "../../../../core/index.js";
|
|
6
|
-
import * as AirweaveSDK from "../../../index.js";
|
|
7
|
-
export declare namespace WhiteLabels {
|
|
8
|
-
interface Options {
|
|
9
|
-
environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
|
|
10
|
-
/** Specify a custom URL to connect the client to. */
|
|
11
|
-
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey: core.Supplier<string>;
|
|
13
|
-
/** Additional headers to include in requests. */
|
|
14
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
15
|
-
}
|
|
16
|
-
interface RequestOptions {
|
|
17
|
-
/** The maximum time to wait for a response in seconds. */
|
|
18
|
-
timeoutInSeconds?: number;
|
|
19
|
-
/** The number of times to retry the request. Defaults to 2. */
|
|
20
|
-
maxRetries?: number;
|
|
21
|
-
/** A hook to abort the request. */
|
|
22
|
-
abortSignal?: AbortSignal;
|
|
23
|
-
/** Additional headers to include in the request. */
|
|
24
|
-
headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
/**
|
|
28
|
-
* API endpoints for managing custom OAuth2 integrations with your own branding and credentials
|
|
29
|
-
*/
|
|
30
|
-
export declare class WhiteLabels {
|
|
31
|
-
protected readonly _options: WhiteLabels.Options;
|
|
32
|
-
constructor(_options: WhiteLabels.Options);
|
|
33
|
-
/**
|
|
34
|
-
* List all white label integrations for your organization.
|
|
35
|
-
*
|
|
36
|
-
* <br/><br/>
|
|
37
|
-
* Returns all custom OAuth integrations configured with your own branding and
|
|
38
|
-
* credentials. These integrations allow you to present OAuth consent screens with
|
|
39
|
-
* your company name instead of Airweave.<br/><br/>**White label integrations only
|
|
40
|
-
* work with OAuth2.0 sources** like Slack, Google Drive, or HubSpot that require
|
|
41
|
-
* OAuth consent flows.
|
|
42
|
-
*
|
|
43
|
-
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
44
|
-
*
|
|
45
|
-
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
46
|
-
*
|
|
47
|
-
* @example
|
|
48
|
-
* await client.whiteLabels.listWhiteLabels()
|
|
49
|
-
*/
|
|
50
|
-
listWhiteLabels(requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WhiteLabel[]>;
|
|
51
|
-
private __listWhiteLabels;
|
|
52
|
-
/**
|
|
53
|
-
* Create a new white label integration.
|
|
54
|
-
*
|
|
55
|
-
* <br/><br/>
|
|
56
|
-
* **This only works for sources that use OAuth2.0 authentication** like Slack,
|
|
57
|
-
* Google Drive, GitHub, or HubSpot.<br/><br/>Sets up a custom OAuth integration
|
|
58
|
-
* using your own OAuth application credentials and branding. Once created,
|
|
59
|
-
* customers will see your company name during OAuth consent flows instead of
|
|
60
|
-
* Airweave. This requires you to have already configured your own OAuth
|
|
61
|
-
* application with the target service provider.
|
|
62
|
-
*
|
|
63
|
-
* @param {AirweaveSDK.WhiteLabelCreate} request
|
|
64
|
-
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
65
|
-
*
|
|
66
|
-
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
67
|
-
*
|
|
68
|
-
* @example
|
|
69
|
-
* await client.whiteLabels.createWhiteLabel({
|
|
70
|
-
* name: "Customer Portal Slack Integration",
|
|
71
|
-
* source_short_name: "slack",
|
|
72
|
-
* redirect_url: "https://yourapp.com/auth/slack/callback",
|
|
73
|
-
* client_id: "1234567890.1234567890123",
|
|
74
|
-
* client_secret: "abcdefghijklmnopqrstuvwxyz123456",
|
|
75
|
-
* allowed_origins: "https://yourapp.com,https://app.yourapp.com"
|
|
76
|
-
* })
|
|
77
|
-
*/
|
|
78
|
-
createWhiteLabel(request: AirweaveSDK.WhiteLabelCreate, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WhiteLabel>;
|
|
79
|
-
private __createWhiteLabel;
|
|
80
|
-
/**
|
|
81
|
-
* Retrieve a specific white label integration by its ID.
|
|
82
|
-
*
|
|
83
|
-
* @param {string} whiteLabelId - The unique identifier of the white label integration
|
|
84
|
-
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
85
|
-
*
|
|
86
|
-
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
87
|
-
*
|
|
88
|
-
* @example
|
|
89
|
-
* await client.whiteLabels.getWhiteLabel("white_label_id")
|
|
90
|
-
*/
|
|
91
|
-
getWhiteLabel(whiteLabelId: string, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WhiteLabel>;
|
|
92
|
-
private __getWhiteLabel;
|
|
93
|
-
/**
|
|
94
|
-
* Update a white label integration's configuration.
|
|
95
|
-
*
|
|
96
|
-
* @param {string} whiteLabelId - The unique identifier of the white label integration to update
|
|
97
|
-
* @param {AirweaveSDK.WhiteLabelUpdate} request
|
|
98
|
-
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
99
|
-
*
|
|
100
|
-
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
101
|
-
*
|
|
102
|
-
* @example
|
|
103
|
-
* await client.whiteLabels.updateWhiteLabel("white_label_id", {
|
|
104
|
-
* name: "Updated Customer Portal Integration",
|
|
105
|
-
* redirect_url: "https://v2.yourapp.com/auth/slack/callback",
|
|
106
|
-
* allowed_origins: "https://v2.yourapp.com,https://api.yourapp.com"
|
|
107
|
-
* })
|
|
108
|
-
*/
|
|
109
|
-
updateWhiteLabel(whiteLabelId: string, request?: AirweaveSDK.WhiteLabelUpdate, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WhiteLabel>;
|
|
110
|
-
private __updateWhiteLabel;
|
|
111
|
-
/**
|
|
112
|
-
* Delete a white label integration.
|
|
113
|
-
*
|
|
114
|
-
* <br/><br/>
|
|
115
|
-
* Permanently removes the white label configuration and OAuth credentials.
|
|
116
|
-
* Existing source connections created through this integration will continue to work,
|
|
117
|
-
* but no new OAuth flows can be initiated until a new white label integration is created.
|
|
118
|
-
*
|
|
119
|
-
* @param {string} whiteLabelId - The unique identifier of the white label integration to delete
|
|
120
|
-
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
121
|
-
*
|
|
122
|
-
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
123
|
-
*
|
|
124
|
-
* @example
|
|
125
|
-
* await client.whiteLabels.deleteWhiteLabel("white_label_id")
|
|
126
|
-
*/
|
|
127
|
-
deleteWhiteLabel(whiteLabelId: string, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<AirweaveSDK.WhiteLabel>;
|
|
128
|
-
private __deleteWhiteLabel;
|
|
129
|
-
/**
|
|
130
|
-
* Generate a branded OAuth2 authorization URL for customer authentication.
|
|
131
|
-
*
|
|
132
|
-
* <br/><br/>
|
|
133
|
-
* Creates the OAuth consent URL that customers should be redirected to for
|
|
134
|
-
* authentication. The OAuth consent screen will display your company name and
|
|
135
|
-
* branding instead of Airweave.
|
|
136
|
-
*
|
|
137
|
-
* @param {string} whiteLabelId - The unique identifier of the white label integration
|
|
138
|
-
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
139
|
-
*
|
|
140
|
-
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
141
|
-
*
|
|
142
|
-
* @example
|
|
143
|
-
* await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id")
|
|
144
|
-
*/
|
|
145
|
-
getWhiteLabelOauth2AuthUrl(whiteLabelId: string, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<string>;
|
|
146
|
-
private __getWhiteLabelOauth2AuthUrl;
|
|
147
|
-
/**
|
|
148
|
-
* List all source connections created through a specific white label integration.
|
|
149
|
-
*
|
|
150
|
-
* <br/><br/>
|
|
151
|
-
* Returns source connections that were established using this white label's OAuth flow.
|
|
152
|
-
*
|
|
153
|
-
* @param {string} whiteLabelId - The unique identifier of the white label integration
|
|
154
|
-
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
155
|
-
*
|
|
156
|
-
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
157
|
-
*
|
|
158
|
-
* @example
|
|
159
|
-
* await client.whiteLabels.listWhiteLabelSourceConnections("white_label_id")
|
|
160
|
-
*/
|
|
161
|
-
listWhiteLabelSourceConnections(whiteLabelId: string, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnectionListItem[]>;
|
|
162
|
-
private __listWhiteLabelSourceConnections;
|
|
163
|
-
/**
|
|
164
|
-
* Complete the OAuth flow and create a source connection.
|
|
165
|
-
*
|
|
166
|
-
* <br/><br/>
|
|
167
|
-
* **This is the core endpoint that converts OAuth authorization codes into working
|
|
168
|
-
* source connections.**<br/><br/>The OAuth credentials are obtained automatically
|
|
169
|
-
* from the authorization code - you do not need to provide auth_fields. The white
|
|
170
|
-
* label integration is automatically linked to the created source connection for
|
|
171
|
-
* tracking and branding purposes.
|
|
172
|
-
*
|
|
173
|
-
* @param {string} whiteLabelId - The unique identifier of the white label integration
|
|
174
|
-
* @param {AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions} request
|
|
175
|
-
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
176
|
-
*
|
|
177
|
-
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
178
|
-
*
|
|
179
|
-
* @example
|
|
180
|
-
* await client.whiteLabels.exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions("white_label_id", {
|
|
181
|
-
* code: "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7"
|
|
182
|
-
* })
|
|
183
|
-
*/
|
|
184
|
-
exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions(whiteLabelId: string, request: AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
|
|
185
|
-
private __exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions;
|
|
186
|
-
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
187
|
-
"x-api-key": string;
|
|
188
|
-
}>;
|
|
189
|
-
}
|