@airweave/sdk 0.3.54 → 0.4.0
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/collections/client/Client.d.ts +1 -3
- package/dist/cjs/api/resources/collections/client/Client.js +1 -3
- package/dist/cjs/api/resources/sourceConnections/client/Client.d.ts +3 -12
- package/dist/cjs/api/resources/sourceConnections/client/Client.js +3 -12
- package/dist/cjs/api/resources/whiteLabels/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/whiteLabels/client/Client.js +9 -9
- package/dist/cjs/api/resources/whiteLabels/client/requests/{BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.d.ts → BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.d.ts} +1 -1
- package/dist/cjs/api/resources/whiteLabels/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/types/ActionCheckResponse.d.ts +23 -0
- package/dist/cjs/api/types/ActionCheckResponse.js +13 -0
- package/dist/cjs/api/types/BillingPeriodUsage.d.ts +27 -0
- package/dist/cjs/api/types/BillingPeriodUsage.js +5 -0
- package/dist/cjs/api/types/CancelSubscriptionRequest.d.ts +11 -0
- package/dist/cjs/api/types/CancelSubscriptionRequest.js +5 -0
- package/dist/cjs/api/types/CheckoutSessionRequest.d.ts +14 -0
- package/dist/cjs/api/types/CheckoutSessionRequest.js +5 -0
- package/dist/cjs/api/types/CheckoutSessionResponse.d.ts +10 -0
- package/dist/cjs/api/types/CheckoutSessionResponse.js +5 -0
- package/dist/cjs/api/types/CustomerPortalRequest.d.ts +10 -0
- package/dist/cjs/api/types/CustomerPortalRequest.js +5 -0
- package/dist/cjs/api/types/CustomerPortalResponse.d.ts +10 -0
- package/dist/cjs/api/types/CustomerPortalResponse.js +5 -0
- package/dist/cjs/api/types/MessageResponse.d.ts +10 -0
- package/dist/cjs/api/types/MessageResponse.js +5 -0
- package/dist/cjs/api/types/Organization.d.ts +1 -0
- package/dist/cjs/api/types/OrganizationCreate.d.ts +2 -0
- package/dist/cjs/api/types/OrganizationWithRole.d.ts +1 -0
- package/dist/cjs/api/types/SubscriptionInfo.d.ts +40 -0
- package/dist/cjs/api/types/SubscriptionInfo.js +5 -0
- package/dist/cjs/api/types/UpdatePlanRequest.d.ts +10 -0
- package/dist/cjs/api/types/UpdatePlanRequest.js +5 -0
- package/dist/cjs/api/types/UsageDashboard.d.ts +23 -0
- package/dist/cjs/api/types/UsageDashboard.js +5 -0
- package/dist/cjs/api/types/UsageSnapshot.d.ts +32 -0
- package/dist/cjs/api/types/UsageSnapshot.js +5 -0
- package/dist/cjs/api/types/UsageTrend.d.ts +14 -0
- package/dist/cjs/api/types/UsageTrend.js +5 -0
- package/dist/cjs/api/types/index.d.ts +13 -0
- package/dist/cjs/api/types/index.js +13 -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/collections/client/Client.d.mts +1 -3
- package/dist/esm/api/resources/collections/client/Client.mjs +1 -3
- package/dist/esm/api/resources/sourceConnections/client/Client.d.mts +3 -12
- package/dist/esm/api/resources/sourceConnections/client/Client.mjs +3 -12
- package/dist/esm/api/resources/whiteLabels/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/whiteLabels/client/Client.mjs +9 -9
- package/dist/esm/api/resources/whiteLabels/client/requests/{BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.d.mts → BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.d.mts} +1 -1
- package/dist/esm/api/resources/whiteLabels/client/requests/index.d.mts +1 -1
- package/dist/esm/api/types/ActionCheckResponse.d.mts +23 -0
- package/dist/esm/api/types/ActionCheckResponse.mjs +10 -0
- package/dist/esm/api/types/BillingPeriodUsage.d.mts +27 -0
- package/dist/esm/api/types/BillingPeriodUsage.mjs +4 -0
- package/dist/esm/api/types/CancelSubscriptionRequest.d.mts +11 -0
- package/dist/esm/api/types/CancelSubscriptionRequest.mjs +4 -0
- package/dist/esm/api/types/CheckoutSessionRequest.d.mts +14 -0
- package/dist/esm/api/types/CheckoutSessionRequest.mjs +4 -0
- package/dist/esm/api/types/CheckoutSessionResponse.d.mts +10 -0
- package/dist/esm/api/types/CheckoutSessionResponse.mjs +4 -0
- package/dist/esm/api/types/CustomerPortalRequest.d.mts +10 -0
- package/dist/esm/api/types/CustomerPortalRequest.mjs +4 -0
- package/dist/esm/api/types/CustomerPortalResponse.d.mts +10 -0
- package/dist/esm/api/types/CustomerPortalResponse.mjs +4 -0
- package/dist/esm/api/types/MessageResponse.d.mts +10 -0
- package/dist/esm/api/types/MessageResponse.mjs +4 -0
- package/dist/esm/api/types/Organization.d.mts +1 -0
- package/dist/esm/api/types/OrganizationCreate.d.mts +2 -0
- package/dist/esm/api/types/OrganizationWithRole.d.mts +1 -0
- package/dist/esm/api/types/SubscriptionInfo.d.mts +40 -0
- package/dist/esm/api/types/SubscriptionInfo.mjs +4 -0
- package/dist/esm/api/types/UpdatePlanRequest.d.mts +10 -0
- package/dist/esm/api/types/UpdatePlanRequest.mjs +4 -0
- package/dist/esm/api/types/UsageDashboard.d.mts +23 -0
- package/dist/esm/api/types/UsageDashboard.mjs +4 -0
- package/dist/esm/api/types/UsageSnapshot.d.mts +32 -0
- package/dist/esm/api/types/UsageSnapshot.mjs +4 -0
- package/dist/esm/api/types/UsageTrend.d.mts +14 -0
- package/dist/esm/api/types/UsageTrend.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +13 -0
- package/dist/esm/api/types/index.mjs +13 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +9 -20
- /package/dist/cjs/api/resources/whiteLabels/client/requests/{BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.js → BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.js} +0 -0
- /package/dist/esm/api/resources/whiteLabels/client/requests/{BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.mjs → BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.mjs} +0 -0
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Usage trend information.
|
|
6
|
+
*/
|
|
7
|
+
export interface UsageTrend {
|
|
8
|
+
/** Metric name (syncs, entities, etc) */
|
|
9
|
+
metric: string;
|
|
10
|
+
/** Trend direction: up, down, or stable */
|
|
11
|
+
direction: string;
|
|
12
|
+
/** Percentage change from previous period */
|
|
13
|
+
percentage_change: number;
|
|
14
|
+
}
|
|
@@ -1,18 +1,25 @@
|
|
|
1
1
|
export * from "./ApiKey.js";
|
|
2
2
|
export * from "./ApiKeyCreate.js";
|
|
3
|
+
export * from "./ActionCheckResponse.js";
|
|
3
4
|
export * from "./AuthProvider.js";
|
|
4
5
|
export * from "./AuthProviderConnection.js";
|
|
5
6
|
export * from "./AuthProviderConnectionCreate.js";
|
|
6
7
|
export * from "./AuthProviderConnectionUpdate.js";
|
|
7
8
|
export * from "./AuthType.js";
|
|
9
|
+
export * from "./BillingPeriodUsage.js";
|
|
8
10
|
export * from "./BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js";
|
|
9
11
|
export * from "./BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.js";
|
|
12
|
+
export * from "./CancelSubscriptionRequest.js";
|
|
13
|
+
export * from "./CheckoutSessionRequest.js";
|
|
14
|
+
export * from "./CheckoutSessionResponse.js";
|
|
10
15
|
export * from "./Collection.js";
|
|
11
16
|
export * from "./CollectionStatus.js";
|
|
12
17
|
export * from "./ConfigField.js";
|
|
13
18
|
export * from "./ConfigValues.js";
|
|
14
19
|
export * from "./Connection.js";
|
|
15
20
|
export * from "./ConnectionStatus.js";
|
|
21
|
+
export * from "./CustomerPortalRequest.js";
|
|
22
|
+
export * from "./CustomerPortalResponse.js";
|
|
16
23
|
export * from "./DagEdge.js";
|
|
17
24
|
export * from "./DagEdgeCreate.js";
|
|
18
25
|
export * from "./DagNode.js";
|
|
@@ -51,6 +58,7 @@ export * from "./MatchExcept.js";
|
|
|
51
58
|
export * from "./MatchText.js";
|
|
52
59
|
export * from "./MatchValue.js";
|
|
53
60
|
export * from "./MemberResponse.js";
|
|
61
|
+
export * from "./MessageResponse.js";
|
|
54
62
|
export * from "./MinShould.js";
|
|
55
63
|
export * from "./Nested.js";
|
|
56
64
|
export * from "./NestedCondition.js";
|
|
@@ -71,6 +79,7 @@ export * from "./SourceConnectionCreateWithWhiteLabel.js";
|
|
|
71
79
|
export * from "./SourceConnectionJob.js";
|
|
72
80
|
export * from "./SourceConnectionListItem.js";
|
|
73
81
|
export * from "./SourceConnectionStatus.js";
|
|
82
|
+
export * from "./SubscriptionInfo.js";
|
|
74
83
|
export * from "./Sync.js";
|
|
75
84
|
export * from "./SyncCreate.js";
|
|
76
85
|
export * from "./SyncDag.js";
|
|
@@ -84,6 +93,10 @@ export * from "./SyncWithSourceConnection.js";
|
|
|
84
93
|
export * from "./Transformer.js";
|
|
85
94
|
export * from "./TransformerCreate.js";
|
|
86
95
|
export * from "./TransformerUpdate.js";
|
|
96
|
+
export * from "./UpdatePlanRequest.js";
|
|
97
|
+
export * from "./UsageDashboard.js";
|
|
98
|
+
export * from "./UsageSnapshot.js";
|
|
99
|
+
export * from "./UsageTrend.js";
|
|
87
100
|
export * from "./User.js";
|
|
88
101
|
export * from "./UserCreate.js";
|
|
89
102
|
export * from "./UserOrganization.js";
|
|
@@ -16,19 +16,26 @@ 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("./ActionCheckResponse.js"), exports);
|
|
19
20
|
__exportStar(require("./AuthProvider.js"), exports);
|
|
20
21
|
__exportStar(require("./AuthProviderConnection.js"), exports);
|
|
21
22
|
__exportStar(require("./AuthProviderConnectionCreate.js"), exports);
|
|
22
23
|
__exportStar(require("./AuthProviderConnectionUpdate.js"), exports);
|
|
23
24
|
__exportStar(require("./AuthType.js"), exports);
|
|
25
|
+
__exportStar(require("./BillingPeriodUsage.js"), exports);
|
|
24
26
|
__exportStar(require("./BodyConnectSlackWithTokenConnectionsDirectTokenSlackPost.js"), exports);
|
|
25
27
|
__exportStar(require("./BodyCreateCredentialsFromAuthorizationCodeSourceConnectionsSourceShortNameCodeToTokenCredentialsPost.js"), exports);
|
|
28
|
+
__exportStar(require("./CancelSubscriptionRequest.js"), exports);
|
|
29
|
+
__exportStar(require("./CheckoutSessionRequest.js"), exports);
|
|
30
|
+
__exportStar(require("./CheckoutSessionResponse.js"), exports);
|
|
26
31
|
__exportStar(require("./Collection.js"), exports);
|
|
27
32
|
__exportStar(require("./CollectionStatus.js"), exports);
|
|
28
33
|
__exportStar(require("./ConfigField.js"), exports);
|
|
29
34
|
__exportStar(require("./ConfigValues.js"), exports);
|
|
30
35
|
__exportStar(require("./Connection.js"), exports);
|
|
31
36
|
__exportStar(require("./ConnectionStatus.js"), exports);
|
|
37
|
+
__exportStar(require("./CustomerPortalRequest.js"), exports);
|
|
38
|
+
__exportStar(require("./CustomerPortalResponse.js"), exports);
|
|
32
39
|
__exportStar(require("./DagEdge.js"), exports);
|
|
33
40
|
__exportStar(require("./DagEdgeCreate.js"), exports);
|
|
34
41
|
__exportStar(require("./DagNode.js"), exports);
|
|
@@ -67,6 +74,7 @@ __exportStar(require("./MatchExcept.js"), exports);
|
|
|
67
74
|
__exportStar(require("./MatchText.js"), exports);
|
|
68
75
|
__exportStar(require("./MatchValue.js"), exports);
|
|
69
76
|
__exportStar(require("./MemberResponse.js"), exports);
|
|
77
|
+
__exportStar(require("./MessageResponse.js"), exports);
|
|
70
78
|
__exportStar(require("./MinShould.js"), exports);
|
|
71
79
|
__exportStar(require("./Nested.js"), exports);
|
|
72
80
|
__exportStar(require("./NestedCondition.js"), exports);
|
|
@@ -87,6 +95,7 @@ __exportStar(require("./SourceConnectionCreateWithWhiteLabel.js"), exports);
|
|
|
87
95
|
__exportStar(require("./SourceConnectionJob.js"), exports);
|
|
88
96
|
__exportStar(require("./SourceConnectionListItem.js"), exports);
|
|
89
97
|
__exportStar(require("./SourceConnectionStatus.js"), exports);
|
|
98
|
+
__exportStar(require("./SubscriptionInfo.js"), exports);
|
|
90
99
|
__exportStar(require("./Sync.js"), exports);
|
|
91
100
|
__exportStar(require("./SyncCreate.js"), exports);
|
|
92
101
|
__exportStar(require("./SyncDag.js"), exports);
|
|
@@ -100,6 +109,10 @@ __exportStar(require("./SyncWithSourceConnection.js"), exports);
|
|
|
100
109
|
__exportStar(require("./Transformer.js"), exports);
|
|
101
110
|
__exportStar(require("./TransformerCreate.js"), exports);
|
|
102
111
|
__exportStar(require("./TransformerUpdate.js"), exports);
|
|
112
|
+
__exportStar(require("./UpdatePlanRequest.js"), exports);
|
|
113
|
+
__exportStar(require("./UsageDashboard.js"), exports);
|
|
114
|
+
__exportStar(require("./UsageSnapshot.js"), exports);
|
|
115
|
+
__exportStar(require("./UsageTrend.js"), exports);
|
|
103
116
|
__exportStar(require("./User.js"), exports);
|
|
104
117
|
__exportStar(require("./UserCreate.js"), exports);
|
|
105
118
|
__exportStar(require("./UserOrganization.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "v0.
|
|
1
|
+
export declare const SDK_VERSION = "v0.4.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -12,8 +12,8 @@ export class AirweaveSDKClient {
|
|
|
12
12
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
13
13
|
"X-Fern-Language": "JavaScript",
|
|
14
14
|
"X-Fern-SDK-Name": "@airweave/sdk",
|
|
15
|
-
"X-Fern-SDK-Version": "v0.
|
|
16
|
-
"User-Agent": "@airweave/sdk/v0.
|
|
15
|
+
"X-Fern-SDK-Version": "v0.4.0",
|
|
16
|
+
"User-Agent": "@airweave/sdk/v0.4.0",
|
|
17
17
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
18
18
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
19
19
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -46,7 +46,6 @@ export declare class Collections {
|
|
|
46
46
|
/**
|
|
47
47
|
* Create a new collection.
|
|
48
48
|
*
|
|
49
|
-
* <br/><br/>
|
|
50
49
|
* The newly created collection is initially empty and does not contain any data
|
|
51
50
|
* until you explicitly add source connections to it.
|
|
52
51
|
*
|
|
@@ -79,7 +78,6 @@ export declare class Collections {
|
|
|
79
78
|
/**
|
|
80
79
|
* Update a collection's properties.
|
|
81
80
|
*
|
|
82
|
-
* <br/><br/>
|
|
83
81
|
* Modifies the display name of an existing collection.
|
|
84
82
|
* Note that the readable ID cannot be changed after creation to maintain stable
|
|
85
83
|
* API endpoints and preserve any existing integrations or bookmarks.
|
|
@@ -166,7 +164,7 @@ export declare class Collections {
|
|
|
166
164
|
/**
|
|
167
165
|
* Trigger data synchronization for all source connections in the collection.
|
|
168
166
|
*
|
|
169
|
-
*
|
|
167
|
+
* The sync jobs run asynchronously in the background, so this endpoint
|
|
170
168
|
* returns immediately with job details that you can use to track progress. You can
|
|
171
169
|
* monitor the status of individual data synchronization using the source connection
|
|
172
170
|
* endpoints.
|
|
@@ -91,7 +91,6 @@ export class Collections {
|
|
|
91
91
|
/**
|
|
92
92
|
* Create a new collection.
|
|
93
93
|
*
|
|
94
|
-
* <br/><br/>
|
|
95
94
|
* The newly created collection is initially empty and does not contain any data
|
|
96
95
|
* until you explicitly add source connections to it.
|
|
97
96
|
*
|
|
@@ -215,7 +214,6 @@ export class Collections {
|
|
|
215
214
|
/**
|
|
216
215
|
* Update a collection's properties.
|
|
217
216
|
*
|
|
218
|
-
* <br/><br/>
|
|
219
217
|
* Modifies the display name of an existing collection.
|
|
220
218
|
* Note that the readable ID cannot be changed after creation to maintain stable
|
|
221
219
|
* API endpoints and preserve any existing integrations or bookmarks.
|
|
@@ -503,7 +501,7 @@ export class Collections {
|
|
|
503
501
|
/**
|
|
504
502
|
* Trigger data synchronization for all source connections in the collection.
|
|
505
503
|
*
|
|
506
|
-
*
|
|
504
|
+
* The sync jobs run asynchronously in the background, so this endpoint
|
|
507
505
|
* returns immediately with job details that you can use to track progress. You can
|
|
508
506
|
* monitor the status of individual data synchronization using the source connection
|
|
509
507
|
* endpoints.
|
|
@@ -33,7 +33,6 @@ export declare class SourceConnections {
|
|
|
33
33
|
/**
|
|
34
34
|
* List source connections across your organization.
|
|
35
35
|
*
|
|
36
|
-
* <br/><br/>
|
|
37
36
|
* By default, returns ALL source connections from every collection in your
|
|
38
37
|
* organization. Use the 'collection' parameter to filter results to a specific
|
|
39
38
|
* collection. This is useful for getting an overview of all your data sources
|
|
@@ -52,8 +51,6 @@ export declare class SourceConnections {
|
|
|
52
51
|
/**
|
|
53
52
|
* Create a new source connection to sync data into your collection.
|
|
54
53
|
*
|
|
55
|
-
* <br/><br/>
|
|
56
|
-
*
|
|
57
54
|
* **This endpoint only works for sources that do not use OAuth2.0.**
|
|
58
55
|
* Sources that do use OAuth2.0 like Google Drive, Slack, or HubSpot must be
|
|
59
56
|
* connected through the UI where you can complete the OAuth consent flow.<br/><br/>
|
|
@@ -96,8 +93,6 @@ export declare class SourceConnections {
|
|
|
96
93
|
/**
|
|
97
94
|
* Update a source connection's properties.
|
|
98
95
|
*
|
|
99
|
-
* <br/><br/>
|
|
100
|
-
*
|
|
101
96
|
* Modify the configuration of an existing source connection including its name,
|
|
102
97
|
* authentication credentials, configuration fields, sync schedule, or source-specific settings.
|
|
103
98
|
*
|
|
@@ -115,10 +110,9 @@ export declare class SourceConnections {
|
|
|
115
110
|
/**
|
|
116
111
|
* Delete a source connection and all associated data.
|
|
117
112
|
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
* from the destination systems. This action cannot be undone.
|
|
113
|
+
* Permanently removes the source connection configuration and credentials.
|
|
114
|
+
* By default, previously synced data remains in your destination systems for continuity.
|
|
115
|
+
* Use delete_data=true to also remove all associated data from destination systems.
|
|
122
116
|
*
|
|
123
117
|
* @param {string} sourceConnectionId - The unique identifier of the source connection to delete
|
|
124
118
|
* @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -133,7 +127,6 @@ export declare class SourceConnections {
|
|
|
133
127
|
/**
|
|
134
128
|
* Manually trigger a data sync for this source connection.
|
|
135
129
|
*
|
|
136
|
-
* <br/><br/>
|
|
137
130
|
* Starts an immediate synchronization job that extracts fresh data from your source,
|
|
138
131
|
* transforms it according to your configuration, and updates the destination systems.
|
|
139
132
|
* The job runs asynchronously and endpoint returns immediately with tracking information.
|
|
@@ -152,7 +145,6 @@ export declare class SourceConnections {
|
|
|
152
145
|
/**
|
|
153
146
|
* List all sync jobs for a source connection.
|
|
154
147
|
*
|
|
155
|
-
* <br/><br/>
|
|
156
148
|
* Returns the complete history of data synchronization jobs including successful syncs,
|
|
157
149
|
* failed attempts, and currently running operations.
|
|
158
150
|
*
|
|
@@ -183,7 +175,6 @@ export declare class SourceConnections {
|
|
|
183
175
|
/**
|
|
184
176
|
* Cancel a running sync job.
|
|
185
177
|
*
|
|
186
|
-
* <br/><br/>
|
|
187
178
|
* Sends a cancellation signal to stop an in-progress data synchronization.
|
|
188
179
|
* The job will complete its current operation and then terminate gracefully.
|
|
189
180
|
* Only jobs in 'created', 'pending', or 'in_progress' states can be cancelled.
|
|
@@ -25,7 +25,6 @@ export class SourceConnections {
|
|
|
25
25
|
/**
|
|
26
26
|
* List source connections across your organization.
|
|
27
27
|
*
|
|
28
|
-
* <br/><br/>
|
|
29
28
|
* By default, returns ALL source connections from every collection in your
|
|
30
29
|
* organization. Use the 'collection' parameter to filter results to a specific
|
|
31
30
|
* collection. This is useful for getting an overview of all your data sources
|
|
@@ -103,8 +102,6 @@ export class SourceConnections {
|
|
|
103
102
|
/**
|
|
104
103
|
* Create a new source connection to sync data into your collection.
|
|
105
104
|
*
|
|
106
|
-
* <br/><br/>
|
|
107
|
-
*
|
|
108
105
|
* **This endpoint only works for sources that do not use OAuth2.0.**
|
|
109
106
|
* Sources that do use OAuth2.0 like Google Drive, Slack, or HubSpot must be
|
|
110
107
|
* connected through the UI where you can complete the OAuth consent flow.<br/><br/>
|
|
@@ -244,8 +241,6 @@ export class SourceConnections {
|
|
|
244
241
|
/**
|
|
245
242
|
* Update a source connection's properties.
|
|
246
243
|
*
|
|
247
|
-
* <br/><br/>
|
|
248
|
-
*
|
|
249
244
|
* Modify the configuration of an existing source connection including its name,
|
|
250
245
|
* authentication credentials, configuration fields, sync schedule, or source-specific settings.
|
|
251
246
|
*
|
|
@@ -310,10 +305,9 @@ export class SourceConnections {
|
|
|
310
305
|
/**
|
|
311
306
|
* Delete a source connection and all associated data.
|
|
312
307
|
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
* from the destination systems. This action cannot be undone.
|
|
308
|
+
* Permanently removes the source connection configuration and credentials.
|
|
309
|
+
* By default, previously synced data remains in your destination systems for continuity.
|
|
310
|
+
* Use delete_data=true to also remove all associated data from destination systems.
|
|
317
311
|
*
|
|
318
312
|
* @param {string} sourceConnectionId - The unique identifier of the source connection to delete
|
|
319
313
|
* @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -372,7 +366,6 @@ export class SourceConnections {
|
|
|
372
366
|
/**
|
|
373
367
|
* Manually trigger a data sync for this source connection.
|
|
374
368
|
*
|
|
375
|
-
* <br/><br/>
|
|
376
369
|
* Starts an immediate synchronization job that extracts fresh data from your source,
|
|
377
370
|
* transforms it according to your configuration, and updates the destination systems.
|
|
378
371
|
* The job runs asynchronously and endpoint returns immediately with tracking information.
|
|
@@ -438,7 +431,6 @@ export class SourceConnections {
|
|
|
438
431
|
/**
|
|
439
432
|
* List all sync jobs for a source connection.
|
|
440
433
|
*
|
|
441
|
-
* <br/><br/>
|
|
442
434
|
* Returns the complete history of data synchronization jobs including successful syncs,
|
|
443
435
|
* failed attempts, and currently running operations.
|
|
444
436
|
*
|
|
@@ -557,7 +549,6 @@ export class SourceConnections {
|
|
|
557
549
|
/**
|
|
558
550
|
* Cancel a running sync job.
|
|
559
551
|
*
|
|
560
|
-
* <br/><br/>
|
|
561
552
|
* Sends a cancellation signal to stop an in-progress data synchronization.
|
|
562
553
|
* The job will complete its current operation and then terminate gracefully.
|
|
563
554
|
* Only jobs in 'created', 'pending', or 'in_progress' states can be cancelled.
|
|
@@ -140,10 +140,10 @@ export declare class WhiteLabels {
|
|
|
140
140
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
141
141
|
*
|
|
142
142
|
* @example
|
|
143
|
-
* await client.whiteLabels.
|
|
143
|
+
* await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id")
|
|
144
144
|
*/
|
|
145
|
-
|
|
146
|
-
private
|
|
145
|
+
getWhiteLabelOauth2AuthUrl(whiteLabelId: string, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<string>;
|
|
146
|
+
private __getWhiteLabelOauth2AuthUrl;
|
|
147
147
|
/**
|
|
148
148
|
* List all source connections created through a specific white label integration.
|
|
149
149
|
*
|
|
@@ -171,18 +171,18 @@ export declare class WhiteLabels {
|
|
|
171
171
|
* tracking and branding purposes.
|
|
172
172
|
*
|
|
173
173
|
* @param {string} whiteLabelId - The unique identifier of the white label integration
|
|
174
|
-
* @param {AirweaveSDK.
|
|
174
|
+
* @param {AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost} request
|
|
175
175
|
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
176
176
|
*
|
|
177
177
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
178
178
|
*
|
|
179
179
|
* @example
|
|
180
|
-
* await client.whiteLabels.
|
|
180
|
+
* await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", {
|
|
181
181
|
* code: "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7"
|
|
182
182
|
* })
|
|
183
183
|
*/
|
|
184
|
-
|
|
185
|
-
private
|
|
184
|
+
exchangeWhiteLabelOauth2Code(whiteLabelId: string, request: AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
|
|
185
|
+
private __exchangeWhiteLabelOauth2Code;
|
|
186
186
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
187
187
|
"x-api-key": string;
|
|
188
188
|
}>;
|
|
@@ -358,12 +358,12 @@ export class WhiteLabels {
|
|
|
358
358
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
359
359
|
*
|
|
360
360
|
* @example
|
|
361
|
-
* await client.whiteLabels.
|
|
361
|
+
* await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id")
|
|
362
362
|
*/
|
|
363
|
-
|
|
364
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
363
|
+
getWhiteLabelOauth2AuthUrl(whiteLabelId, requestOptions) {
|
|
364
|
+
return core.HttpResponsePromise.fromPromise(this.__getWhiteLabelOauth2AuthUrl(whiteLabelId, requestOptions));
|
|
365
365
|
}
|
|
366
|
-
|
|
366
|
+
__getWhiteLabelOauth2AuthUrl(whiteLabelId, requestOptions) {
|
|
367
367
|
return __awaiter(this, void 0, void 0, function* () {
|
|
368
368
|
var _a, _b, _c;
|
|
369
369
|
const _response = yield core.fetcher({
|
|
@@ -480,20 +480,20 @@ export class WhiteLabels {
|
|
|
480
480
|
* tracking and branding purposes.
|
|
481
481
|
*
|
|
482
482
|
* @param {string} whiteLabelId - The unique identifier of the white label integration
|
|
483
|
-
* @param {AirweaveSDK.
|
|
483
|
+
* @param {AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost} request
|
|
484
484
|
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
485
485
|
*
|
|
486
486
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
487
487
|
*
|
|
488
488
|
* @example
|
|
489
|
-
* await client.whiteLabels.
|
|
489
|
+
* await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", {
|
|
490
490
|
* code: "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7"
|
|
491
491
|
* })
|
|
492
492
|
*/
|
|
493
|
-
|
|
494
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
493
|
+
exchangeWhiteLabelOauth2Code(whiteLabelId, request, requestOptions) {
|
|
494
|
+
return core.HttpResponsePromise.fromPromise(this.__exchangeWhiteLabelOauth2Code(whiteLabelId, request, requestOptions));
|
|
495
495
|
}
|
|
496
|
-
|
|
496
|
+
__exchangeWhiteLabelOauth2Code(whiteLabelId, request, requestOptions) {
|
|
497
497
|
return __awaiter(this, void 0, void 0, function* () {
|
|
498
498
|
var _a, _b, _c;
|
|
499
499
|
const _response = yield core.fetcher({
|
|
@@ -8,7 +8,7 @@ import * as AirweaveSDK from "../../../../index.mjs";
|
|
|
8
8
|
* code: "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7"
|
|
9
9
|
* }
|
|
10
10
|
*/
|
|
11
|
-
export interface
|
|
11
|
+
export interface BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost {
|
|
12
12
|
/** The OAuth2 authorization code received from the OAuth callback after customer authentication */
|
|
13
13
|
code: string;
|
|
14
14
|
/** Optional configuration for the source connection. If not provided, a source connection will be created automatically with default settings. The white label integration is automatically linked to the source connection. */
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export { type WhiteLabelCreate } from "./WhiteLabelCreate.mjs";
|
|
2
2
|
export { type WhiteLabelUpdate } from "./WhiteLabelUpdate.mjs";
|
|
3
|
-
export { type
|
|
3
|
+
export { type BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost } from "./BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.mjs";
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Response schema for action permission checks.
|
|
6
|
+
*/
|
|
7
|
+
export interface ActionCheckResponse {
|
|
8
|
+
/** Whether the action is allowed for the organization */
|
|
9
|
+
allowed: boolean;
|
|
10
|
+
/** The action type that was checked */
|
|
11
|
+
action: string;
|
|
12
|
+
/** Reason why the action is not allowed (if applicable) */
|
|
13
|
+
reason?: ActionCheckResponse.Reason;
|
|
14
|
+
/** Additional details about why the action is not allowed */
|
|
15
|
+
details?: Record<string, unknown>;
|
|
16
|
+
}
|
|
17
|
+
export declare namespace ActionCheckResponse {
|
|
18
|
+
type Reason = "payment_required" | "usage_limit_exceeded";
|
|
19
|
+
const Reason: {
|
|
20
|
+
readonly PaymentRequired: "payment_required";
|
|
21
|
+
readonly UsageLimitExceeded: "usage_limit_exceeded";
|
|
22
|
+
};
|
|
23
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export var ActionCheckResponse;
|
|
5
|
+
(function (ActionCheckResponse) {
|
|
6
|
+
ActionCheckResponse.Reason = {
|
|
7
|
+
PaymentRequired: "payment_required",
|
|
8
|
+
UsageLimitExceeded: "usage_limit_exceeded",
|
|
9
|
+
};
|
|
10
|
+
})(ActionCheckResponse || (ActionCheckResponse = {}));
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Complete usage data for a billing period.
|
|
7
|
+
*/
|
|
8
|
+
export interface BillingPeriodUsage {
|
|
9
|
+
/** Billing period ID */
|
|
10
|
+
period_id: string;
|
|
11
|
+
/** Period start date */
|
|
12
|
+
period_start: string;
|
|
13
|
+
/** Period end date */
|
|
14
|
+
period_end: string;
|
|
15
|
+
/** Period status (active, trial, ended, etc) */
|
|
16
|
+
status: string;
|
|
17
|
+
/** Subscription plan for this period */
|
|
18
|
+
plan: string;
|
|
19
|
+
/** Current usage snapshot */
|
|
20
|
+
usage: AirweaveSDK.UsageSnapshot;
|
|
21
|
+
/** Daily snapshots for trend visualization */
|
|
22
|
+
daily_usage?: AirweaveSDK.UsageSnapshot[];
|
|
23
|
+
/** Days left in period */
|
|
24
|
+
days_remaining?: number;
|
|
25
|
+
/** Whether this is the current period */
|
|
26
|
+
is_current?: boolean;
|
|
27
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Request to cancel subscription.
|
|
6
|
+
*
|
|
7
|
+
* Subscription will be canceled at the end of the current billing period.
|
|
8
|
+
* For immediate cancellation, delete the organization instead.
|
|
9
|
+
*/
|
|
10
|
+
export interface CancelSubscriptionRequest {
|
|
11
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Request to create a checkout session.
|
|
6
|
+
*/
|
|
7
|
+
export interface CheckoutSessionRequest {
|
|
8
|
+
/** Plan to subscribe to (developer, startup) */
|
|
9
|
+
plan: string;
|
|
10
|
+
/** URL to redirect on successful payment */
|
|
11
|
+
success_url: string;
|
|
12
|
+
/** URL to redirect on cancellation */
|
|
13
|
+
cancel_url: string;
|
|
14
|
+
}
|