@airweave/sdk 0.1.19 → 0.1.21

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.
Files changed (32) hide show
  1. package/api/resources/connections/client/Client.d.ts +86 -5
  2. package/api/resources/connections/client/Client.js +98 -17
  3. package/api/resources/destinations/client/Client.d.ts +19 -0
  4. package/api/resources/destinations/client/Client.js +21 -2
  5. package/api/resources/embeddingModels/client/Client.js +2 -2
  6. package/api/resources/search/client/Client.js +2 -2
  7. package/api/resources/sources/client/Client.d.ts +6 -1
  8. package/api/resources/sources/client/Client.js +8 -3
  9. package/api/resources/sync/client/Client.d.ts +85 -0
  10. package/api/resources/sync/client/Client.js +93 -8
  11. package/api/resources/users/client/Client.js +1 -1
  12. package/api/resources/whiteLabels/client/Client.d.ts +81 -0
  13. package/api/resources/whiteLabels/client/Client.js +89 -8
  14. package/dist/api/resources/connections/client/Client.d.ts +86 -5
  15. package/dist/api/resources/connections/client/Client.js +98 -17
  16. package/dist/api/resources/destinations/client/Client.d.ts +19 -0
  17. package/dist/api/resources/destinations/client/Client.js +21 -2
  18. package/dist/api/resources/embeddingModels/client/Client.js +2 -2
  19. package/dist/api/resources/search/client/Client.js +2 -2
  20. package/dist/api/resources/sources/client/Client.d.ts +6 -1
  21. package/dist/api/resources/sources/client/Client.js +8 -3
  22. package/dist/api/resources/sync/client/Client.d.ts +85 -0
  23. package/dist/api/resources/sync/client/Client.js +93 -8
  24. package/dist/api/resources/users/client/Client.js +1 -1
  25. package/dist/api/resources/whiteLabels/client/Client.d.ts +81 -0
  26. package/dist/api/resources/whiteLabels/client/Client.js +89 -8
  27. package/dist/version.d.ts +1 -1
  28. package/dist/version.js +1 -1
  29. package/package.json +1 -1
  30. package/reference.md +307 -35
  31. package/version.d.ts +1 -1
  32. package/version.js +1 -1
package/dist/api/resources/connections/client/Client.js CHANGED
@@ -62,6 +62,16 @@ class Connections {
62
62
  /**
63
63
  * Get a specific connection.
64
64
  *
65
+ * Args:
66
+ * -----
67
+ * connection_id: The ID of the connection to get.
68
+ * db: The database session.
69
+ * user: The current user.
70
+ *
71
+ * Returns:
72
+ * -------
73
+ * schemas.Connection: The connection.
74
+ *
65
75
  * @param {string} connectionId
66
76
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
67
77
  *
@@ -78,7 +88,7 @@ class Connections {
78
88
  method: "GET",
79
89
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
80
90
  ? yield core.Supplier.get(this._options.apiKey)
81
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
91
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
82
92
  contentType: "application/json",
83
93
  requestType: "json",
84
94
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -127,6 +137,15 @@ class Connections {
127
137
  /**
128
138
  * Get all active connections for the current user across all integration types.
129
139
  *
140
+ * Args:
141
+ * -----
142
+ * db: The database session.
143
+ * user: The current user.
144
+ *
145
+ * Returns:
146
+ * -------
147
+ * list[schemas.Connection]: The list of connections.
148
+ *
130
149
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
131
150
  *
132
151
  * @throws {@link AirweaveSDK.UnprocessableEntityError}
@@ -142,7 +161,7 @@ class Connections {
142
161
  method: "GET",
143
162
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
144
163
  ? yield core.Supplier.get(this._options.apiKey)
145
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
164
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
146
165
  contentType: "application/json",
147
166
  requestType: "json",
148
167
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -192,11 +211,13 @@ class Connections {
192
211
  * Get all integrations of specified type connected to the current user.
193
212
  *
194
213
  * Args:
214
+ * -----
195
215
  * integration_type (IntegrationType): The type of integration to get connections for.
196
216
  * db (AsyncSession): The database session.
197
217
  * user (schemas.User): The current user.
198
218
  *
199
219
  * Returns:
220
+ * -------
200
221
  * list[schemas.Connection]: The list of connections.
201
222
  *
202
223
  * @param {AirweaveSDK.IntegrationType} integrationType
@@ -215,7 +236,7 @@ class Connections {
215
236
  method: "GET",
216
237
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
217
238
  ? yield core.Supplier.get(this._options.apiKey)
218
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
239
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
219
240
  contentType: "application/json",
220
241
  requestType: "json",
221
242
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -272,6 +293,19 @@ class Connections {
272
293
  * }
273
294
  * ```
274
295
  *
296
+ * Args:
297
+ * -----
298
+ * db: The database session.
299
+ * integration_type: The type of integration to connect to.
300
+ * short_name: The short name of the integration to connect to.
301
+ * name: The name of the connection.
302
+ * config_fields: The config fields for the integration.
303
+ * user: The current user.
304
+ *
305
+ * Returns:
306
+ * -------
307
+ * schemas.Connection: The connection.
308
+ *
275
309
  * @param {AirweaveSDK.IntegrationType} integrationType
276
310
  * @param {string} shortName
277
311
  * @param {AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost} request
@@ -294,7 +328,7 @@ class Connections {
294
328
  method: "POST",
295
329
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
296
330
  ? yield core.Supplier.get(this._options.apiKey)
297
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
331
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
298
332
  contentType: "application/json",
299
333
  requestType: "json",
300
334
  body: serializers.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -345,12 +379,14 @@ class Connections {
345
379
  * Get the credentials for a connection.
346
380
  *
347
381
  * Args:
382
+ * -----
348
383
  * connection_id (UUID): The ID of the connection to get credentials for
349
384
  * db (AsyncSession): The database session
350
385
  * user (schemas.User): The current user
351
386
  *
352
387
  * Returns:
353
- * dict: The credentials for the connection
388
+ * -------
389
+ * decrypted_credentials (dict): The credentials for the connection
354
390
  *
355
391
  * @param {string} connectionId
356
392
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -368,7 +404,7 @@ class Connections {
368
404
  method: "GET",
369
405
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
370
406
  ? yield core.Supplier.get(this._options.apiKey)
371
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
407
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
372
408
  contentType: "application/json",
373
409
  requestType: "json",
374
410
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -420,13 +456,14 @@ class Connections {
420
456
  * Deletes the connection and integration credential.
421
457
  *
422
458
  * Args:
459
+ * -----
423
460
  * db (AsyncSession): The database session
424
461
  * connection_id (UUID): The ID of the connection to delete
425
- * delete_syncs_and_data (bool): Whether to delete the associated syncs and data
426
462
  * user (schemas.User): The current user
427
463
  *
428
464
  * Returns:
429
- * schemas.Connection: The deleted connection
465
+ * --------
466
+ * connection (schemas.Connection): The deleted connection
430
467
  *
431
468
  * @param {string} connectionId
432
469
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -444,7 +481,7 @@ class Connections {
444
481
  method: "DELETE",
445
482
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
446
483
  ? yield core.Supplier.get(this._options.apiKey)
447
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
484
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
448
485
  contentType: "application/json",
449
486
  requestType: "json",
450
487
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -494,11 +531,14 @@ class Connections {
494
531
  * Disconnect from a source connection.
495
532
  *
496
533
  * Args:
534
+ * -----
497
535
  * db (AsyncSession): The database session
498
536
  * connection_id (UUID): The ID of the connection to disconnect
499
537
  * user (schemas.User): The current user
538
+ *
500
539
  * Returns:
501
- * schemas.Connection: The disconnected connection
540
+ * --------
541
+ * connection_schema (schemas.Connection): The disconnected connection
502
542
  *
503
543
  * @param {string} connectionId
504
544
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -516,7 +556,7 @@ class Connections {
516
556
  method: "PUT",
517
557
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
518
558
  ? yield core.Supplier.get(this._options.apiKey)
519
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
559
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
520
560
  contentType: "application/json",
521
561
  requestType: "json",
522
562
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -566,12 +606,14 @@ class Connections {
566
606
  * Disconnect from a destination connection.
567
607
  *
568
608
  * Args:
609
+ * -----
569
610
  * db (AsyncSession): The database session
570
611
  * connection_id (UUID): The ID of the connection to disconnect
571
612
  * user (schemas.User): The current user
572
613
  *
573
614
  * Returns:
574
- * schemas.Connection: The disconnected connection
615
+ * --------
616
+ * connection_schema (schemas.Connection): The disconnected connection
575
617
  *
576
618
  * @param {string} connectionId
577
619
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -589,7 +631,7 @@ class Connections {
589
631
  method: "PUT",
590
632
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
591
633
  ? yield core.Supplier.get(this._options.apiKey)
592
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
634
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
593
635
  contentType: "application/json",
594
636
  requestType: "json",
595
637
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -638,6 +680,12 @@ class Connections {
638
680
  /**
639
681
  * Get the OAuth2 authorization URL for a source.
640
682
  *
683
+ * Args:
684
+ * -----
685
+ * db: The database session
686
+ * short_name: The short name of the source
687
+ * user: The current user
688
+ *
641
689
  * @param {AirweaveSDK.GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest} request
642
690
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
643
691
  *
@@ -659,7 +707,7 @@ class Connections {
659
707
  method: "GET",
660
708
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
661
709
  ? yield core.Supplier.get(this._options.apiKey)
662
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
710
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
663
711
  contentType: "application/json",
664
712
  queryParameters: _queryParams,
665
713
  requestType: "json",
@@ -714,6 +762,17 @@ class Connections {
714
762
  * 2. Exchange the authorization code for a token
715
763
  * 3. Create an integration credential with the token
716
764
  *
765
+ * Args:
766
+ * -----
767
+ * db: The database session
768
+ * short_name: The short name of the source
769
+ * code: The authorization code
770
+ * user: The current user
771
+ *
772
+ * Returns:
773
+ * --------
774
+ * connection (schemas.Connection): The created connection
775
+ *
717
776
  * @param {AirweaveSDK.BodySendOauth2CodeConnectionsOauth2SourceCodePost} request
718
777
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
719
778
  *
@@ -733,7 +792,7 @@ class Connections {
733
792
  method: "POST",
734
793
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
735
794
  ? yield core.Supplier.get(this._options.apiKey)
736
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
795
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
737
796
  contentType: "application/json",
738
797
  requestType: "json",
739
798
  body: serializers.BodySendOauth2CodeConnectionsOauth2SourceCodePost.jsonOrThrow(request, {
@@ -785,6 +844,18 @@ class Connections {
785
844
  /**
786
845
  * Exchange the OAuth2 authorization code for a white label integration.
787
846
  *
847
+ * Args:
848
+ * -----
849
+ * db: The database session
850
+ * white_label_id: The ID of the white label integration
851
+ * code: The authorization code
852
+ * user: The current user
853
+ * background_tasks: The background tasks
854
+ *
855
+ * Returns:
856
+ * --------
857
+ * connection (schemas.Connection): The created connection
858
+ *
788
859
  * @param {string} whiteLabelId
789
860
  * @param {string} request
790
861
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -802,7 +873,7 @@ class Connections {
802
873
  method: "POST",
803
874
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
804
875
  ? yield core.Supplier.get(this._options.apiKey)
805
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
876
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
806
877
  contentType: "application/json",
807
878
  requestType: "json",
808
879
  body: serializers.connections.sendOauth2WhiteLabelCode.Request.jsonOrThrow(request, {
@@ -854,6 +925,16 @@ class Connections {
854
925
  /**
855
926
  * Get the OAuth2 authorization URL for a white label integration.
856
927
  *
928
+ * Args:
929
+ * -----
930
+ * db: The database session
931
+ * white_label_id: The ID of the white label integration
932
+ * user: The current user
933
+ *
934
+ * Returns:
935
+ * --------
936
+ * str: The OAuth2 authorization URL
937
+ *
857
938
  * @param {string} whiteLabelId
858
939
  * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
859
940
  *
@@ -870,7 +951,7 @@ class Connections {
870
951
  method: "GET",
871
952
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
872
953
  ? yield core.Supplier.get(this._options.apiKey)
873
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
954
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
874
955
  contentType: "application/json",
875
956
  requestType: "json",
876
957
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
package/dist/api/resources/destinations/client/Client.d.ts CHANGED
@@ -29,6 +29,15 @@ export declare class Destinations {
29
29
  /**
30
30
  * Get all available destinations.
31
31
  *
32
+ * Args:
33
+ * -----
34
+ * db: The database session
35
+ * user: The current user
36
+ *
37
+ * Returns:
38
+ * --------
39
+ * List[schemas.Destination]: A list of destinations
40
+ *
32
41
  * @param {Destinations.RequestOptions} requestOptions - Request-specific configuration.
33
42
  *
34
43
  * @throws {@link AirweaveSDK.UnprocessableEntityError}
@@ -40,6 +49,16 @@ export declare class Destinations {
40
49
  /**
41
50
  * Get destination by short name.
42
51
  *
52
+ * Args:
53
+ * -----
54
+ * db: The database session
55
+ * short_name: The short name of the destination
56
+ * user: The current user
57
+ *
58
+ * Returns:
59
+ * --------
60
+ * destination (schemas.Destination): The destination
61
+ *
43
62
  * @param {string} shortName
44
63
  * @param {Destinations.RequestOptions} requestOptions - Request-specific configuration.
45
64
  *
package/dist/api/resources/destinations/client/Client.js CHANGED
@@ -62,6 +62,15 @@ class Destinations {
62
62
  /**
63
63
  * Get all available destinations.
64
64
  *
65
+ * Args:
66
+ * -----
67
+ * db: The database session
68
+ * user: The current user
69
+ *
70
+ * Returns:
71
+ * --------
72
+ * List[schemas.Destination]: A list of destinations
73
+ *
65
74
  * @param {Destinations.RequestOptions} requestOptions - Request-specific configuration.
66
75
  *
67
76
  * @throws {@link AirweaveSDK.UnprocessableEntityError}
@@ -77,7 +86,7 @@ class Destinations {
77
86
  method: "GET",
78
87
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
79
88
  ? yield core.Supplier.get(this._options.apiKey)
80
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
89
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
81
90
  contentType: "application/json",
82
91
  requestType: "json",
83
92
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -126,6 +135,16 @@ class Destinations {
126
135
  /**
127
136
  * Get destination by short name.
128
137
  *
138
+ * Args:
139
+ * -----
140
+ * db: The database session
141
+ * short_name: The short name of the destination
142
+ * user: The current user
143
+ *
144
+ * Returns:
145
+ * --------
146
+ * destination (schemas.Destination): The destination
147
+ *
129
148
  * @param {string} shortName
130
149
  * @param {Destinations.RequestOptions} requestOptions - Request-specific configuration.
131
150
  *
@@ -142,7 +161,7 @@ class Destinations {
142
161
  method: "GET",
143
162
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
144
163
  ? yield core.Supplier.get(this._options.apiKey)
145
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
164
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
146
165
  contentType: "application/json",
147
166
  requestType: "json",
148
167
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
package/dist/api/resources/embeddingModels/client/Client.js CHANGED
@@ -88,7 +88,7 @@ class EmbeddingModels {
88
88
  method: "GET",
89
89
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
90
90
  ? yield core.Supplier.get(this._options.apiKey)
91
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
91
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
92
92
  contentType: "application/json",
93
93
  requestType: "json",
94
94
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -161,7 +161,7 @@ class EmbeddingModels {
161
161
  method: "GET",
162
162
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
163
163
  ? yield core.Supplier.get(this._options.apiKey)
164
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
164
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
165
165
  contentType: "application/json",
166
166
  requestType: "json",
167
167
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
package/dist/api/resources/search/client/Client.js CHANGED
@@ -100,7 +100,7 @@ class Search {
100
100
  method: "GET",
101
101
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
102
102
  ? yield core.Supplier.get(this._options.apiKey)
103
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
103
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
104
104
  contentType: "application/json",
105
105
  queryParameters: _queryParams,
106
106
  requestType: "json",
@@ -194,7 +194,7 @@ class Search {
194
194
  method: "GET",
195
195
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
196
196
  ? yield core.Supplier.get(this._options.apiKey)
197
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
197
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
198
198
  contentType: "application/json",
199
199
  queryParameters: _queryParams,
200
200
  requestType: "json",
package/dist/api/resources/sources/client/Client.d.ts CHANGED
@@ -51,8 +51,13 @@ export declare class Sources {
51
51
  /**
52
52
  * Get all sources for the current user.
53
53
  *
54
+ * Args:
55
+ * -----
56
+ * db: The database session
57
+ * user: The current user
58
+ *
54
59
  * Returns:
55
- * -------
60
+ * --------
56
61
  * list[schemas.Source]: The list of sources.
57
62
  *
58
63
  * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
package/dist/api/resources/sources/client/Client.js CHANGED
@@ -88,7 +88,7 @@ class Sources {
88
88
  method: "GET",
89
89
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
90
90
  ? yield core.Supplier.get(this._options.apiKey)
91
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
91
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
92
92
  contentType: "application/json",
93
93
  requestType: "json",
94
94
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -137,8 +137,13 @@ class Sources {
137
137
  /**
138
138
  * Get all sources for the current user.
139
139
  *
140
+ * Args:
141
+ * -----
142
+ * db: The database session
143
+ * user: The current user
144
+ *
140
145
  * Returns:
141
- * -------
146
+ * --------
142
147
  * list[schemas.Source]: The list of sources.
143
148
  *
144
149
  * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
@@ -156,7 +161,7 @@ class Sources {
156
161
  method: "GET",
157
162
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
158
163
  ? yield core.Supplier.get(this._options.apiKey)
159
- : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.19", "User-Agent": "@airweave/sdk/0.1.19", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
164
+ : undefined, "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@airweave/sdk", "X-Fern-SDK-Version": "0.1.21", "User-Agent": "@airweave/sdk/0.1.21", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
160
165
  contentType: "application/json",
161
166
  requestType: "json",
162
167
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
package/dist/api/resources/sync/client/Client.d.ts CHANGED
@@ -29,6 +29,18 @@ export declare class Sync {
29
29
  /**
30
30
  * List all syncs for the current user.
31
31
  *
32
+ * Args:
33
+ * -----
34
+ * db: The database session
35
+ * skip: The number of syncs to skip
36
+ * limit: The number of syncs to return
37
+ * with_source_connection: Whether to include the source connection in the response
38
+ * user: The current user
39
+ *
40
+ * Returns:
41
+ * --------
42
+ * list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
43
+ *
32
44
  * @param {AirweaveSDK.ListSyncsSyncGetRequest} request
33
45
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
34
46
  *
@@ -41,6 +53,17 @@ export declare class Sync {
41
53
  /**
42
54
  * Create a new sync configuration.
43
55
  *
56
+ * Args:
57
+ * -----
58
+ * db: The database session
59
+ * sync_in: The sync to create
60
+ * user: The current user
61
+ * background_tasks: The background tasks
62
+ *
63
+ * Returns:
64
+ * --------
65
+ * sync (schemas.Sync): The created sync
66
+ *
44
67
  * @param {AirweaveSDK.SyncCreate} request
45
68
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
46
69
  *
@@ -56,6 +79,16 @@ export declare class Sync {
56
79
  /**
57
80
  * Get a specific sync by ID.
58
81
  *
82
+ * Args:
83
+ * -----
84
+ * db: The database session
85
+ * sync_id: The ID of the sync to get
86
+ * user: The current user
87
+ *
88
+ * Returns:
89
+ * --------
90
+ * sync (schemas.Sync): The sync
91
+ *
59
92
  * @param {string} syncId
60
93
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
61
94
  *
@@ -68,6 +101,17 @@ export declare class Sync {
68
101
  /**
69
102
  * Delete a sync configuration and optionally its associated data.
70
103
  *
104
+ * Args:
105
+ * -----
106
+ * db: The database session
107
+ * sync_id: The ID of the sync to delete
108
+ * delete_data: Whether to delete the data associated with the sync
109
+ * user: The current user
110
+ *
111
+ * Returns:
112
+ * --------
113
+ * sync (schemas.Sync): The deleted sync
114
+ *
71
115
  * @param {string} syncId
72
116
  * @param {AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest} request
73
117
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
@@ -81,6 +125,17 @@ export declare class Sync {
81
125
  /**
82
126
  * Trigger a sync run.
83
127
  *
128
+ * Args:
129
+ * -----
130
+ * db: The database session
131
+ * sync_id: The ID of the sync to run
132
+ * user: The current user
133
+ * background_tasks: The background tasks
134
+ *
135
+ * Returns:
136
+ * --------
137
+ * sync_job (schemas.SyncJob): The sync job
138
+ *
84
139
  * @param {string} syncId
85
140
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
86
141
  *
@@ -93,6 +148,16 @@ export declare class Sync {
93
148
  /**
94
149
  * List all jobs for a specific sync.
95
150
  *
151
+ * Args:
152
+ * -----
153
+ * db: The database session
154
+ * sync_id: The ID of the sync to list jobs for
155
+ * user: The current user
156
+ *
157
+ * Returns:
158
+ * --------
159
+ * list[schemas.SyncJob]: A list of sync jobs
160
+ *
96
161
  * @param {string} syncId
97
162
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
98
163
  *
@@ -105,6 +170,17 @@ export declare class Sync {
105
170
  /**
106
171
  * Get details of a specific sync job.
107
172
  *
173
+ * Args:
174
+ * -----
175
+ * db: The database session
176
+ * sync_id: The ID of the sync to list jobs for
177
+ * job_id: The ID of the job to get
178
+ * user: The current user
179
+ *
180
+ * Returns:
181
+ * --------
182
+ * sync_job (schemas.SyncJob): The sync job
183
+ *
108
184
  * @param {string} jobId
109
185
  * @param {AirweaveSDK.GetSyncJobSyncJobJobIdGetRequest} request
110
186
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
@@ -120,6 +196,15 @@ export declare class Sync {
120
196
  /**
121
197
  * Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
122
198
  *
199
+ * Args:
200
+ * -----
201
+ * job_id: The ID of the job to subscribe to
202
+ * user: The current user
203
+ *
204
+ * Returns:
205
+ * --------
206
+ * StreamingResponse: The streaming response
207
+ *
123
208
  * @param {string} jobId
124
209
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
125
210
  *