@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
package/dist/cjs/Client.js
CHANGED
|
@@ -48,8 +48,8 @@ class AirweaveSDKClient {
|
|
|
48
48
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
49
49
|
"X-Fern-Language": "JavaScript",
|
|
50
50
|
"X-Fern-SDK-Name": "@airweave/sdk",
|
|
51
|
-
"X-Fern-SDK-Version": "v0.
|
|
52
|
-
"User-Agent": "@airweave/sdk/v0.
|
|
51
|
+
"X-Fern-SDK-Version": "v0.4.0",
|
|
52
|
+
"User-Agent": "@airweave/sdk/v0.4.0",
|
|
53
53
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
54
54
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
55
55
|
}, _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.
|
|
@@ -127,7 +127,6 @@ class Collections {
|
|
|
127
127
|
/**
|
|
128
128
|
* Create a new collection.
|
|
129
129
|
*
|
|
130
|
-
* <br/><br/>
|
|
131
130
|
* The newly created collection is initially empty and does not contain any data
|
|
132
131
|
* until you explicitly add source connections to it.
|
|
133
132
|
*
|
|
@@ -251,7 +250,6 @@ class Collections {
|
|
|
251
250
|
/**
|
|
252
251
|
* Update a collection's properties.
|
|
253
252
|
*
|
|
254
|
-
* <br/><br/>
|
|
255
253
|
* Modifies the display name of an existing collection.
|
|
256
254
|
* Note that the readable ID cannot be changed after creation to maintain stable
|
|
257
255
|
* API endpoints and preserve any existing integrations or bookmarks.
|
|
@@ -539,7 +537,7 @@ class Collections {
|
|
|
539
537
|
/**
|
|
540
538
|
* Trigger data synchronization for all source connections in the collection.
|
|
541
539
|
*
|
|
542
|
-
*
|
|
540
|
+
* The sync jobs run asynchronously in the background, so this endpoint
|
|
543
541
|
* returns immediately with job details that you can use to track progress. You can
|
|
544
542
|
* monitor the status of individual data synchronization using the source connection
|
|
545
543
|
* 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.
|
|
@@ -61,7 +61,6 @@ class SourceConnections {
|
|
|
61
61
|
/**
|
|
62
62
|
* List source connections across your organization.
|
|
63
63
|
*
|
|
64
|
-
* <br/><br/>
|
|
65
64
|
* By default, returns ALL source connections from every collection in your
|
|
66
65
|
* organization. Use the 'collection' parameter to filter results to a specific
|
|
67
66
|
* collection. This is useful for getting an overview of all your data sources
|
|
@@ -139,8 +138,6 @@ class SourceConnections {
|
|
|
139
138
|
/**
|
|
140
139
|
* Create a new source connection to sync data into your collection.
|
|
141
140
|
*
|
|
142
|
-
* <br/><br/>
|
|
143
|
-
*
|
|
144
141
|
* **This endpoint only works for sources that do not use OAuth2.0.**
|
|
145
142
|
* Sources that do use OAuth2.0 like Google Drive, Slack, or HubSpot must be
|
|
146
143
|
* connected through the UI where you can complete the OAuth consent flow.<br/><br/>
|
|
@@ -280,8 +277,6 @@ class SourceConnections {
|
|
|
280
277
|
/**
|
|
281
278
|
* Update a source connection's properties.
|
|
282
279
|
*
|
|
283
|
-
* <br/><br/>
|
|
284
|
-
*
|
|
285
280
|
* Modify the configuration of an existing source connection including its name,
|
|
286
281
|
* authentication credentials, configuration fields, sync schedule, or source-specific settings.
|
|
287
282
|
*
|
|
@@ -346,10 +341,9 @@ class SourceConnections {
|
|
|
346
341
|
/**
|
|
347
342
|
* Delete a source connection and all associated data.
|
|
348
343
|
*
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
* from the destination systems. This action cannot be undone.
|
|
344
|
+
* Permanently removes the source connection configuration and credentials.
|
|
345
|
+
* By default, previously synced data remains in your destination systems for continuity.
|
|
346
|
+
* Use delete_data=true to also remove all associated data from destination systems.
|
|
353
347
|
*
|
|
354
348
|
* @param {string} sourceConnectionId - The unique identifier of the source connection to delete
|
|
355
349
|
* @param {SourceConnections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -408,7 +402,6 @@ class SourceConnections {
|
|
|
408
402
|
/**
|
|
409
403
|
* Manually trigger a data sync for this source connection.
|
|
410
404
|
*
|
|
411
|
-
* <br/><br/>
|
|
412
405
|
* Starts an immediate synchronization job that extracts fresh data from your source,
|
|
413
406
|
* transforms it according to your configuration, and updates the destination systems.
|
|
414
407
|
* The job runs asynchronously and endpoint returns immediately with tracking information.
|
|
@@ -474,7 +467,6 @@ class SourceConnections {
|
|
|
474
467
|
/**
|
|
475
468
|
* List all sync jobs for a source connection.
|
|
476
469
|
*
|
|
477
|
-
* <br/><br/>
|
|
478
470
|
* Returns the complete history of data synchronization jobs including successful syncs,
|
|
479
471
|
* failed attempts, and currently running operations.
|
|
480
472
|
*
|
|
@@ -593,7 +585,6 @@ class SourceConnections {
|
|
|
593
585
|
/**
|
|
594
586
|
* Cancel a running sync job.
|
|
595
587
|
*
|
|
596
|
-
* <br/><br/>
|
|
597
588
|
* Sends a cancellation signal to stop an in-progress data synchronization.
|
|
598
589
|
* The job will complete its current operation and then terminate gracefully.
|
|
599
590
|
* 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
|
}>;
|
|
@@ -394,12 +394,12 @@ class WhiteLabels {
|
|
|
394
394
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
395
395
|
*
|
|
396
396
|
* @example
|
|
397
|
-
* await client.whiteLabels.
|
|
397
|
+
* await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id")
|
|
398
398
|
*/
|
|
399
|
-
|
|
400
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
399
|
+
getWhiteLabelOauth2AuthUrl(whiteLabelId, requestOptions) {
|
|
400
|
+
return core.HttpResponsePromise.fromPromise(this.__getWhiteLabelOauth2AuthUrl(whiteLabelId, requestOptions));
|
|
401
401
|
}
|
|
402
|
-
|
|
402
|
+
__getWhiteLabelOauth2AuthUrl(whiteLabelId, requestOptions) {
|
|
403
403
|
return __awaiter(this, void 0, void 0, function* () {
|
|
404
404
|
var _a, _b, _c;
|
|
405
405
|
const _response = yield core.fetcher({
|
|
@@ -516,20 +516,20 @@ class WhiteLabels {
|
|
|
516
516
|
* tracking and branding purposes.
|
|
517
517
|
*
|
|
518
518
|
* @param {string} whiteLabelId - The unique identifier of the white label integration
|
|
519
|
-
* @param {AirweaveSDK.
|
|
519
|
+
* @param {AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost} request
|
|
520
520
|
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
521
521
|
*
|
|
522
522
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
523
523
|
*
|
|
524
524
|
* @example
|
|
525
|
-
* await client.whiteLabels.
|
|
525
|
+
* await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", {
|
|
526
526
|
* code: "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7"
|
|
527
527
|
* })
|
|
528
528
|
*/
|
|
529
|
-
|
|
530
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
529
|
+
exchangeWhiteLabelOauth2Code(whiteLabelId, request, requestOptions) {
|
|
530
|
+
return core.HttpResponsePromise.fromPromise(this.__exchangeWhiteLabelOauth2Code(whiteLabelId, request, requestOptions));
|
|
531
531
|
}
|
|
532
|
-
|
|
532
|
+
__exchangeWhiteLabelOauth2Code(whiteLabelId, request, requestOptions) {
|
|
533
533
|
return __awaiter(this, void 0, void 0, function* () {
|
|
534
534
|
var _a, _b, _c;
|
|
535
535
|
const _response = yield core.fetcher({
|
|
@@ -8,7 +8,7 @@ import * as AirweaveSDK from "../../../../index.js";
|
|
|
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.js";
|
|
2
2
|
export { type WhiteLabelUpdate } from "./WhiteLabelUpdate.js";
|
|
3
|
-
export { type
|
|
3
|
+
export { type BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost } from "./BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.js";
|
|
@@ -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,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.ActionCheckResponse = void 0;
|
|
7
|
+
var ActionCheckResponse;
|
|
8
|
+
(function (ActionCheckResponse) {
|
|
9
|
+
ActionCheckResponse.Reason = {
|
|
10
|
+
PaymentRequired: "payment_required",
|
|
11
|
+
UsageLimitExceeded: "usage_limit_exceeded",
|
|
12
|
+
};
|
|
13
|
+
})(ActionCheckResponse || (exports.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.js";
|
|
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
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Subscription information response.
|
|
6
|
+
*/
|
|
7
|
+
export interface SubscriptionInfo {
|
|
8
|
+
/** Current billing plan */
|
|
9
|
+
plan: string;
|
|
10
|
+
/** Subscription status */
|
|
11
|
+
status: string;
|
|
12
|
+
/** Trial end date */
|
|
13
|
+
trial_ends_at?: string;
|
|
14
|
+
/** Grace period end date */
|
|
15
|
+
grace_period_ends_at?: string;
|
|
16
|
+
/** Current billing period start */
|
|
17
|
+
current_period_start?: string;
|
|
18
|
+
/** Current billing period end */
|
|
19
|
+
current_period_end?: string;
|
|
20
|
+
/** Whether subscription will cancel at period end */
|
|
21
|
+
cancel_at_period_end?: boolean;
|
|
22
|
+
/** Plan limits */
|
|
23
|
+
limits: Record<string, unknown>;
|
|
24
|
+
/** Whether using OSS version */
|
|
25
|
+
is_oss?: boolean;
|
|
26
|
+
/** Whether has active Stripe subscription */
|
|
27
|
+
has_active_subscription?: boolean;
|
|
28
|
+
/** Whether currently in trial period */
|
|
29
|
+
in_trial?: boolean;
|
|
30
|
+
/** Whether currently in grace period */
|
|
31
|
+
in_grace_period?: boolean;
|
|
32
|
+
/** Whether payment method is added */
|
|
33
|
+
payment_method_added?: boolean;
|
|
34
|
+
/** Whether payment method is required now */
|
|
35
|
+
requires_payment_method?: boolean;
|
|
36
|
+
/** Plan that will take effect at period end */
|
|
37
|
+
pending_plan_change?: string;
|
|
38
|
+
/** When the pending plan change takes effect */
|
|
39
|
+
pending_plan_change_at?: string;
|
|
40
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Complete dashboard data.
|
|
7
|
+
*/
|
|
8
|
+
export interface UsageDashboard {
|
|
9
|
+
/** Current billing period usage */
|
|
10
|
+
current_period: AirweaveSDK.BillingPeriodUsage;
|
|
11
|
+
/** Historical billing periods */
|
|
12
|
+
previous_periods?: AirweaveSDK.BillingPeriodUsage[];
|
|
13
|
+
/** Total entities processed all time */
|
|
14
|
+
total_entities_all_time?: number;
|
|
15
|
+
/** Total queries executed all time */
|
|
16
|
+
total_queries_all_time?: number;
|
|
17
|
+
/** Average entities per day (current period) */
|
|
18
|
+
average_daily_entities?: number;
|
|
19
|
+
/** Average queries per day (current period) */
|
|
20
|
+
average_daily_queries?: number;
|
|
21
|
+
/** Usage trends compared to previous period */
|
|
22
|
+
trends?: AirweaveSDK.UsageTrend[];
|
|
23
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Point-in-time usage data with limits.
|
|
6
|
+
*/
|
|
7
|
+
export interface UsageSnapshot {
|
|
8
|
+
/** Number of syncs executed */
|
|
9
|
+
syncs: number;
|
|
10
|
+
/** Total entities processed */
|
|
11
|
+
entities: number;
|
|
12
|
+
/** Search queries executed */
|
|
13
|
+
queries: number;
|
|
14
|
+
/** Collections created */
|
|
15
|
+
collections: number;
|
|
16
|
+
/** Source connections configured */
|
|
17
|
+
source_connections: number;
|
|
18
|
+
/** Maximum syncs allowed */
|
|
19
|
+
max_syncs?: number;
|
|
20
|
+
/** Maximum entities allowed */
|
|
21
|
+
max_entities?: number;
|
|
22
|
+
/** Maximum queries allowed */
|
|
23
|
+
max_queries?: number;
|
|
24
|
+
/** Maximum collections allowed */
|
|
25
|
+
max_collections?: number;
|
|
26
|
+
/** Maximum source connections allowed */
|
|
27
|
+
max_source_connections?: number;
|
|
28
|
+
/** When this snapshot was taken */
|
|
29
|
+
timestamp: string;
|
|
30
|
+
/** Associated billing period */
|
|
31
|
+
billing_period_id: string;
|
|
32
|
+
}
|