@airweave/sdk 0.4.16 → 0.4.18
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/README.md +8 -8
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/collections/client/Client.d.ts +23 -23
- package/dist/cjs/api/resources/collections/client/Client.js +30 -30
- package/dist/cjs/api/resources/collections/client/requests/{ListCollectionsCollectionsGetRequest.d.ts → ListCollectionsGetRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/collections/client/requests/{SearchCollectionCollectionsReadableIdSearchGetRequest.d.ts → SearchCollectionsReadableIdSearchGetRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/collections/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/sourceConnections/client/Client.d.ts +30 -30
- package/dist/cjs/api/resources/sourceConnections/client/Client.js +39 -39
- package/dist/{esm/api/resources/sourceConnections/client/requests/BodyRunSourceConnectionSourceConnectionsSourceConnectionIdRunPost.d.mts → cjs/api/resources/sourceConnections/client/requests/BodyRunSourceConnectionsSourceConnectionIdRunPost.d.ts} +1 -1
- package/dist/cjs/api/resources/sourceConnections/client/requests/{GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.d.ts → GetSourceConnectionsSourceConnectionIdGetRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/sourceConnections/client/requests/{ListSourceConnectionsSourceConnectionsGetRequest.d.ts → ListSourceConnectionsGetRequest.d.ts} +1 -1
- package/dist/cjs/api/resources/sourceConnections/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/sources/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/sources/client/Client.js +8 -8
- 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/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 +23 -23
- package/dist/esm/api/resources/collections/client/Client.mjs +30 -30
- package/dist/esm/api/resources/collections/client/requests/{ListCollectionsCollectionsGetRequest.d.mts → ListCollectionsGetRequest.d.mts} +1 -1
- package/dist/esm/api/resources/collections/client/requests/{SearchCollectionCollectionsReadableIdSearchGetRequest.d.mts → SearchCollectionsReadableIdSearchGetRequest.d.mts} +1 -1
- package/dist/esm/api/resources/collections/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/sourceConnections/client/Client.d.mts +30 -30
- package/dist/esm/api/resources/sourceConnections/client/Client.mjs +39 -39
- package/dist/{cjs/api/resources/sourceConnections/client/requests/BodyRunSourceConnectionSourceConnectionsSourceConnectionIdRunPost.d.ts → esm/api/resources/sourceConnections/client/requests/BodyRunSourceConnectionsSourceConnectionIdRunPost.d.mts} +1 -1
- package/dist/esm/api/resources/sourceConnections/client/requests/{GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.d.mts → GetSourceConnectionsSourceConnectionIdGetRequest.d.mts} +1 -1
- package/dist/esm/api/resources/sourceConnections/client/requests/{ListSourceConnectionsSourceConnectionsGetRequest.d.mts → ListSourceConnectionsGetRequest.d.mts} +1 -1
- package/dist/esm/api/resources/sourceConnections/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/sources/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/sources/client/Client.mjs +8 -8
- 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/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +46 -46
- /package/dist/cjs/api/resources/collections/client/requests/{ListCollectionsCollectionsGetRequest.js → ListCollectionsGetRequest.js} +0 -0
- /package/dist/cjs/api/resources/collections/client/requests/{SearchCollectionCollectionsReadableIdSearchGetRequest.js → SearchCollectionsReadableIdSearchGetRequest.js} +0 -0
- /package/dist/cjs/api/resources/sourceConnections/client/requests/{BodyRunSourceConnectionSourceConnectionsSourceConnectionIdRunPost.js → BodyRunSourceConnectionsSourceConnectionIdRunPost.js} +0 -0
- /package/dist/cjs/api/resources/sourceConnections/client/requests/{GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.js → GetSourceConnectionsSourceConnectionIdGetRequest.js} +0 -0
- /package/dist/cjs/api/resources/sourceConnections/client/requests/{ListSourceConnectionsSourceConnectionsGetRequest.js → ListSourceConnectionsGetRequest.js} +0 -0
- /package/dist/cjs/api/resources/whiteLabels/client/requests/{BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.js → BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.js} +0 -0
- /package/dist/esm/api/resources/collections/client/requests/{ListCollectionsCollectionsGetRequest.mjs → ListCollectionsGetRequest.mjs} +0 -0
- /package/dist/esm/api/resources/collections/client/requests/{SearchCollectionCollectionsReadableIdSearchGetRequest.mjs → SearchCollectionsReadableIdSearchGetRequest.mjs} +0 -0
- /package/dist/esm/api/resources/sourceConnections/client/requests/{BodyRunSourceConnectionSourceConnectionsSourceConnectionIdRunPost.mjs → BodyRunSourceConnectionsSourceConnectionIdRunPost.mjs} +0 -0
- /package/dist/esm/api/resources/sourceConnections/client/requests/{GetSourceConnectionSourceConnectionsSourceConnectionIdGetRequest.mjs → GetSourceConnectionsSourceConnectionIdGetRequest.mjs} +0 -0
- /package/dist/esm/api/resources/sourceConnections/client/requests/{ListSourceConnectionsSourceConnectionsGetRequest.mjs → ListSourceConnectionsGetRequest.mjs} +0 -0
- /package/dist/esm/api/resources/whiteLabels/client/requests/{BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.mjs → BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.mjs} +0 -0
|
@@ -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";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "v0.4.
|
|
1
|
+
export declare const SDK_VERSION = "v0.4.18";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "v0.4.
|
|
1
|
+
export const SDK_VERSION = "v0.4.18";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## sources
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">
|
|
5
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">read</a>(shortName) -> AirweaveSDK.Source</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -30,7 +30,7 @@ Get detailed information about a specific data source connector.
|
|
|
30
30
|
<dd>
|
|
31
31
|
|
|
32
32
|
```typescript
|
|
33
|
-
await client.sources.
|
|
33
|
+
await client.sources.read("short_name");
|
|
34
34
|
```
|
|
35
35
|
|
|
36
36
|
</dd>
|
|
@@ -65,7 +65,7 @@ await client.sources.readSource("short_name");
|
|
|
65
65
|
</dl>
|
|
66
66
|
</details>
|
|
67
67
|
|
|
68
|
-
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">
|
|
68
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">list</a>() -> AirweaveSDK.Source[]</code></summary>
|
|
69
69
|
<dl>
|
|
70
70
|
<dd>
|
|
71
71
|
|
|
@@ -96,7 +96,7 @@ Returns the complete catalog of source types that Airweave can connect to.
|
|
|
96
96
|
<dd>
|
|
97
97
|
|
|
98
98
|
```typescript
|
|
99
|
-
await client.sources.
|
|
99
|
+
await client.sources.list();
|
|
100
100
|
```
|
|
101
101
|
|
|
102
102
|
</dd>
|
|
@@ -125,7 +125,7 @@ await client.sources.readSources();
|
|
|
125
125
|
|
|
126
126
|
## collections
|
|
127
127
|
|
|
128
|
-
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">
|
|
128
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">list</a>({ ...params }) -> AirweaveSDK.Collection[]</code></summary>
|
|
129
129
|
<dl>
|
|
130
130
|
<dd>
|
|
131
131
|
|
|
@@ -153,7 +153,7 @@ List all collections that belong to your organization.
|
|
|
153
153
|
<dd>
|
|
154
154
|
|
|
155
155
|
```typescript
|
|
156
|
-
await client.collections.
|
|
156
|
+
await client.collections.list();
|
|
157
157
|
```
|
|
158
158
|
|
|
159
159
|
</dd>
|
|
@@ -169,7 +169,7 @@ await client.collections.listCollections();
|
|
|
169
169
|
<dl>
|
|
170
170
|
<dd>
|
|
171
171
|
|
|
172
|
-
**request:** `AirweaveSDK.
|
|
172
|
+
**request:** `AirweaveSDK.ListCollectionsGetRequest`
|
|
173
173
|
|
|
174
174
|
</dd>
|
|
175
175
|
</dl>
|
|
@@ -188,7 +188,7 @@ await client.collections.listCollections();
|
|
|
188
188
|
</dl>
|
|
189
189
|
</details>
|
|
190
190
|
|
|
191
|
-
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">
|
|
191
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">create</a>({ ...params }) -> AirweaveSDK.Collection</code></summary>
|
|
192
192
|
<dl>
|
|
193
193
|
<dd>
|
|
194
194
|
|
|
@@ -219,7 +219,7 @@ until you explicitly add source connections to it.
|
|
|
219
219
|
<dd>
|
|
220
220
|
|
|
221
221
|
```typescript
|
|
222
|
-
await client.collections.
|
|
222
|
+
await client.collections.create({
|
|
223
223
|
name: "Finance Data",
|
|
224
224
|
readable_id: "finance-data-reports",
|
|
225
225
|
});
|
|
@@ -257,7 +257,7 @@ await client.collections.createCollection({
|
|
|
257
257
|
</dl>
|
|
258
258
|
</details>
|
|
259
259
|
|
|
260
|
-
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">
|
|
260
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">get</a>(readableId) -> AirweaveSDK.Collection</code></summary>
|
|
261
261
|
<dl>
|
|
262
262
|
<dd>
|
|
263
263
|
|
|
@@ -285,7 +285,7 @@ Retrieve a specific collection by its readable ID.
|
|
|
285
285
|
<dd>
|
|
286
286
|
|
|
287
287
|
```typescript
|
|
288
|
-
await client.collections.
|
|
288
|
+
await client.collections.get("readable_id");
|
|
289
289
|
```
|
|
290
290
|
|
|
291
291
|
</dd>
|
|
@@ -320,7 +320,7 @@ await client.collections.getCollection("readable_id");
|
|
|
320
320
|
</dl>
|
|
321
321
|
</details>
|
|
322
322
|
|
|
323
|
-
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">
|
|
323
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">update</a>(readableId, { ...params }) -> AirweaveSDK.Collection</code></summary>
|
|
324
324
|
<dl>
|
|
325
325
|
<dd>
|
|
326
326
|
|
|
@@ -352,7 +352,7 @@ API endpoints and preserve any existing integrations or bookmarks.
|
|
|
352
352
|
<dd>
|
|
353
353
|
|
|
354
354
|
```typescript
|
|
355
|
-
await client.collections.
|
|
355
|
+
await client.collections.update("readable_id", {
|
|
356
356
|
name: "Updated Finance Data",
|
|
357
357
|
});
|
|
358
358
|
```
|
|
@@ -397,7 +397,7 @@ await client.collections.updateCollection("readable_id", {
|
|
|
397
397
|
</dl>
|
|
398
398
|
</details>
|
|
399
399
|
|
|
400
|
-
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">
|
|
400
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">delete</a>(readableId) -> AirweaveSDK.Collection</code></summary>
|
|
401
401
|
<dl>
|
|
402
402
|
<dd>
|
|
403
403
|
|
|
@@ -429,7 +429,7 @@ will also be deleted as part of the cleanup process. This action cannot be undon
|
|
|
429
429
|
<dd>
|
|
430
430
|
|
|
431
431
|
```typescript
|
|
432
|
-
await client.collections.
|
|
432
|
+
await client.collections.delete("readable_id");
|
|
433
433
|
```
|
|
434
434
|
|
|
435
435
|
</dd>
|
|
@@ -464,7 +464,7 @@ await client.collections.deleteCollection("readable_id");
|
|
|
464
464
|
</dl>
|
|
465
465
|
</details>
|
|
466
466
|
|
|
467
|
-
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">
|
|
467
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">search</a>(readableId, { ...params }) -> AirweaveSDK.SearchResponse</code></summary>
|
|
468
468
|
<dl>
|
|
469
469
|
<dd>
|
|
470
470
|
|
|
@@ -495,7 +495,7 @@ and options, use the POST /search endpoint.
|
|
|
495
495
|
<dd>
|
|
496
496
|
|
|
497
497
|
```typescript
|
|
498
|
-
await client.collections.
|
|
498
|
+
await client.collections.search("readable_id", {
|
|
499
499
|
query: "customer payment issues",
|
|
500
500
|
});
|
|
501
501
|
```
|
|
@@ -521,7 +521,7 @@ await client.collections.searchCollection("readable_id", {
|
|
|
521
521
|
<dl>
|
|
522
522
|
<dd>
|
|
523
523
|
|
|
524
|
-
**request:** `AirweaveSDK.
|
|
524
|
+
**request:** `AirweaveSDK.SearchCollectionsReadableIdSearchGetRequest`
|
|
525
525
|
|
|
526
526
|
</dd>
|
|
527
527
|
</dl>
|
|
@@ -540,7 +540,7 @@ await client.collections.searchCollection("readable_id", {
|
|
|
540
540
|
</dl>
|
|
541
541
|
</details>
|
|
542
542
|
|
|
543
|
-
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">
|
|
543
|
+
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">searchAdvanced</a>(readableId, { ...params }) -> AirweaveSDK.SearchResponse</code></summary>
|
|
544
544
|
<dl>
|
|
545
545
|
<dd>
|
|
546
546
|
|
|
@@ -589,7 +589,7 @@ To disable features, explicitly set:
|
|
|
589
589
|
<dd>
|
|
590
590
|
|
|
591
591
|
```typescript
|
|
592
|
-
await client.collections.
|
|
592
|
+
await client.collections.searchAdvanced("readable_id", {
|
|
593
593
|
query: "customer payment issues",
|
|
594
594
|
filter: {
|
|
595
595
|
must: {
|
|
@@ -712,7 +712,7 @@ await client.collections.refreshAllSourceConnections("readable_id");
|
|
|
712
712
|
|
|
713
713
|
## source-connections
|
|
714
714
|
|
|
715
|
-
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">
|
|
715
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">list</a>({ ...params }) -> AirweaveSDK.SourceConnectionListItem[]</code></summary>
|
|
716
716
|
<dl>
|
|
717
717
|
<dd>
|
|
718
718
|
|
|
@@ -745,7 +745,7 @@ or managing connections within a particular collection.
|
|
|
745
745
|
<dd>
|
|
746
746
|
|
|
747
747
|
```typescript
|
|
748
|
-
await client.sourceConnections.
|
|
748
|
+
await client.sourceConnections.list();
|
|
749
749
|
```
|
|
750
750
|
|
|
751
751
|
</dd>
|
|
@@ -761,7 +761,7 @@ await client.sourceConnections.listSourceConnections();
|
|
|
761
761
|
<dl>
|
|
762
762
|
<dd>
|
|
763
763
|
|
|
764
|
-
**request:** `AirweaveSDK.
|
|
764
|
+
**request:** `AirweaveSDK.ListSourceConnectionsGetRequest`
|
|
765
765
|
|
|
766
766
|
</dd>
|
|
767
767
|
</dl>
|
|
@@ -780,7 +780,7 @@ await client.sourceConnections.listSourceConnections();
|
|
|
780
780
|
</dl>
|
|
781
781
|
</details>
|
|
782
782
|
|
|
783
|
-
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">
|
|
783
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">create</a>({ ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
784
784
|
<dl>
|
|
785
785
|
<dd>
|
|
786
786
|
|
|
@@ -821,7 +821,7 @@ of authentication is used.
|
|
|
821
821
|
<dd>
|
|
822
822
|
|
|
823
823
|
```typescript
|
|
824
|
-
await client.sourceConnections.
|
|
824
|
+
await client.sourceConnections.create({
|
|
825
825
|
name: "Production Stripe Account",
|
|
826
826
|
short_name: "stripe",
|
|
827
827
|
});
|
|
@@ -859,7 +859,7 @@ await client.sourceConnections.createSourceConnection({
|
|
|
859
859
|
</dl>
|
|
860
860
|
</details>
|
|
861
861
|
|
|
862
|
-
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">
|
|
862
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">get</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
863
863
|
<dl>
|
|
864
864
|
<dd>
|
|
865
865
|
|
|
@@ -887,7 +887,7 @@ Retrieve a specific source connection by its ID.
|
|
|
887
887
|
<dd>
|
|
888
888
|
|
|
889
889
|
```typescript
|
|
890
|
-
await client.sourceConnections.
|
|
890
|
+
await client.sourceConnections.get("source_connection_id");
|
|
891
891
|
```
|
|
892
892
|
|
|
893
893
|
</dd>
|
|
@@ -911,7 +911,7 @@ await client.sourceConnections.getSourceConnection("source_connection_id");
|
|
|
911
911
|
<dl>
|
|
912
912
|
<dd>
|
|
913
913
|
|
|
914
|
-
**request:** `AirweaveSDK.
|
|
914
|
+
**request:** `AirweaveSDK.GetSourceConnectionsSourceConnectionIdGetRequest`
|
|
915
915
|
|
|
916
916
|
</dd>
|
|
917
917
|
</dl>
|
|
@@ -930,7 +930,7 @@ await client.sourceConnections.getSourceConnection("source_connection_id");
|
|
|
930
930
|
</dl>
|
|
931
931
|
</details>
|
|
932
932
|
|
|
933
|
-
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">
|
|
933
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">update</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
934
934
|
<dl>
|
|
935
935
|
<dd>
|
|
936
936
|
|
|
@@ -961,7 +961,7 @@ authentication credentials, configuration fields, sync schedule, or source-speci
|
|
|
961
961
|
<dd>
|
|
962
962
|
|
|
963
963
|
```typescript
|
|
964
|
-
await client.sourceConnections.
|
|
964
|
+
await client.sourceConnections.update("source_connection_id");
|
|
965
965
|
```
|
|
966
966
|
|
|
967
967
|
</dd>
|
|
@@ -1004,7 +1004,7 @@ await client.sourceConnections.updateSourceConnection("source_connection_id");
|
|
|
1004
1004
|
</dl>
|
|
1005
1005
|
</details>
|
|
1006
1006
|
|
|
1007
|
-
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">
|
|
1007
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">delete</a>(sourceConnectionId) -> AirweaveSDK.SourceConnection</code></summary>
|
|
1008
1008
|
<dl>
|
|
1009
1009
|
<dd>
|
|
1010
1010
|
|
|
@@ -1036,7 +1036,7 @@ Use delete_data=true to also remove all associated data from destination systems
|
|
|
1036
1036
|
<dd>
|
|
1037
1037
|
|
|
1038
1038
|
```typescript
|
|
1039
|
-
await client.sourceConnections.
|
|
1039
|
+
await client.sourceConnections.delete("source_connection_id");
|
|
1040
1040
|
```
|
|
1041
1041
|
|
|
1042
1042
|
</dd>
|
|
@@ -1071,7 +1071,7 @@ await client.sourceConnections.deleteSourceConnection("source_connection_id");
|
|
|
1071
1071
|
</dl>
|
|
1072
1072
|
</details>
|
|
1073
1073
|
|
|
1074
|
-
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">
|
|
1074
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">run</a>(sourceConnectionId, { ...params }) -> AirweaveSDK.SourceConnectionJob</code></summary>
|
|
1075
1075
|
<dl>
|
|
1076
1076
|
<dd>
|
|
1077
1077
|
|
|
@@ -1103,7 +1103,7 @@ The job runs asynchronously and endpoint returns immediately with tracking infor
|
|
|
1103
1103
|
<dd>
|
|
1104
1104
|
|
|
1105
1105
|
```typescript
|
|
1106
|
-
await client.sourceConnections.
|
|
1106
|
+
await client.sourceConnections.run("source_connection_id");
|
|
1107
1107
|
```
|
|
1108
1108
|
|
|
1109
1109
|
</dd>
|
|
@@ -1127,7 +1127,7 @@ await client.sourceConnections.runSourceConnection("source_connection_id");
|
|
|
1127
1127
|
<dl>
|
|
1128
1128
|
<dd>
|
|
1129
1129
|
|
|
1130
|
-
**request:** `AirweaveSDK.
|
|
1130
|
+
**request:** `AirweaveSDK.BodyRunSourceConnectionsSourceConnectionIdRunPost`
|
|
1131
1131
|
|
|
1132
1132
|
</dd>
|
|
1133
1133
|
</dl>
|
|
@@ -1146,7 +1146,7 @@ await client.sourceConnections.runSourceConnection("source_connection_id");
|
|
|
1146
1146
|
</dl>
|
|
1147
1147
|
</details>
|
|
1148
1148
|
|
|
1149
|
-
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">
|
|
1149
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">listJobs</a>(sourceConnectionId) -> AirweaveSDK.SourceConnectionJob[]</code></summary>
|
|
1150
1150
|
<dl>
|
|
1151
1151
|
<dd>
|
|
1152
1152
|
|
|
@@ -1177,7 +1177,7 @@ failed attempts, and currently running operations.
|
|
|
1177
1177
|
<dd>
|
|
1178
1178
|
|
|
1179
1179
|
```typescript
|
|
1180
|
-
await client.sourceConnections.
|
|
1180
|
+
await client.sourceConnections.listJobs("source_connection_id");
|
|
1181
1181
|
```
|
|
1182
1182
|
|
|
1183
1183
|
</dd>
|
|
@@ -1212,7 +1212,7 @@ await client.sourceConnections.listSourceConnectionJobs("source_connection_id");
|
|
|
1212
1212
|
</dl>
|
|
1213
1213
|
</details>
|
|
1214
1214
|
|
|
1215
|
-
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">
|
|
1215
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">getJob</a>(sourceConnectionId, jobId) -> AirweaveSDK.SourceConnectionJob</code></summary>
|
|
1216
1216
|
<dl>
|
|
1217
1217
|
<dd>
|
|
1218
1218
|
|
|
@@ -1240,7 +1240,7 @@ Get detailed information about a specific sync job.
|
|
|
1240
1240
|
<dd>
|
|
1241
1241
|
|
|
1242
1242
|
```typescript
|
|
1243
|
-
await client.sourceConnections.
|
|
1243
|
+
await client.sourceConnections.getJob("source_connection_id", "job_id");
|
|
1244
1244
|
```
|
|
1245
1245
|
|
|
1246
1246
|
</dd>
|
|
@@ -1283,7 +1283,7 @@ await client.sourceConnections.getSourceConnectionJob("source_connection_id", "j
|
|
|
1283
1283
|
</dl>
|
|
1284
1284
|
</details>
|
|
1285
1285
|
|
|
1286
|
-
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">
|
|
1286
|
+
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">cancelJob</a>(sourceConnectionId, jobId) -> AirweaveSDK.SourceConnectionJob</code></summary>
|
|
1287
1287
|
<dl>
|
|
1288
1288
|
<dd>
|
|
1289
1289
|
|
|
@@ -1315,7 +1315,7 @@ Only jobs in 'created', 'pending', or 'in_progress' states can be cancelled.
|
|
|
1315
1315
|
<dd>
|
|
1316
1316
|
|
|
1317
1317
|
```typescript
|
|
1318
|
-
await client.sourceConnections.
|
|
1318
|
+
await client.sourceConnections.cancelJob("source_connection_id", "job_id");
|
|
1319
1319
|
```
|
|
1320
1320
|
|
|
1321
1321
|
</dd>
|
|
@@ -1706,7 +1706,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
1706
1706
|
</dl>
|
|
1707
1707
|
</details>
|
|
1708
1708
|
|
|
1709
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">
|
|
1709
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabelOauth2AuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
1710
1710
|
<dl>
|
|
1711
1711
|
<dd>
|
|
1712
1712
|
|
|
@@ -1739,7 +1739,7 @@ branding instead of Airweave.
|
|
|
1739
1739
|
<dd>
|
|
1740
1740
|
|
|
1741
1741
|
```typescript
|
|
1742
|
-
await client.whiteLabels.
|
|
1742
|
+
await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
1743
1743
|
```
|
|
1744
1744
|
|
|
1745
1745
|
</dd>
|
|
@@ -1840,7 +1840,7 @@ await client.whiteLabels.listWhiteLabelSourceConnections("white_label_id");
|
|
|
1840
1840
|
</dl>
|
|
1841
1841
|
</details>
|
|
1842
1842
|
|
|
1843
|
-
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">
|
|
1843
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">exchangeWhiteLabelOauth2Code</a>(whiteLabelId, { ...params }) -> AirweaveSDK.SourceConnection</code></summary>
|
|
1844
1844
|
<dl>
|
|
1845
1845
|
<dd>
|
|
1846
1846
|
|
|
@@ -1875,7 +1875,7 @@ tracking and branding purposes.
|
|
|
1875
1875
|
<dd>
|
|
1876
1876
|
|
|
1877
1877
|
```typescript
|
|
1878
|
-
await client.whiteLabels.
|
|
1878
|
+
await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", {
|
|
1879
1879
|
code: "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7",
|
|
1880
1880
|
});
|
|
1881
1881
|
```
|
|
@@ -1901,7 +1901,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOaut
|
|
|
1901
1901
|
<dl>
|
|
1902
1902
|
<dd>
|
|
1903
1903
|
|
|
1904
|
-
**request:** `AirweaveSDK.
|
|
1904
|
+
**request:** `AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost`
|
|
1905
1905
|
|
|
1906
1906
|
</dd>
|
|
1907
1907
|
</dl>
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|