@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
@@ -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,
@@ -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
  *
@@ -62,6 +62,18 @@ class Sync {
62
62
  /**
63
63
  * List all syncs for the current user.
64
64
  *
65
+ * Args:
66
+ * -----
67
+ * db: The database session
68
+ * skip: The number of syncs to skip
69
+ * limit: The number of syncs to return
70
+ * with_source_connection: Whether to include the source connection in the response
71
+ * user: The current user
72
+ *
73
+ * Returns:
74
+ * --------
75
+ * list[schemas.Sync] | list[schemas.SyncWithSourceConnection]: A list of syncs
76
+ *
65
77
  * @param {AirweaveSDK.ListSyncsSyncGetRequest} request
66
78
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
67
79
  *
@@ -89,7 +101,7 @@ class Sync {
89
101
  method: "GET",
90
102
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
91
103
  ? yield core.Supplier.get(this._options.apiKey)
92
- : 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),
104
+ : 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),
93
105
  contentType: "application/json",
94
106
  queryParameters: _queryParams,
95
107
  requestType: "json",
@@ -139,6 +151,17 @@ class Sync {
139
151
  /**
140
152
  * Create a new sync configuration.
141
153
  *
154
+ * Args:
155
+ * -----
156
+ * db: The database session
157
+ * sync_in: The sync to create
158
+ * user: The current user
159
+ * background_tasks: The background tasks
160
+ *
161
+ * Returns:
162
+ * --------
163
+ * sync (schemas.Sync): The created sync
164
+ *
142
165
  * @param {AirweaveSDK.SyncCreate} request
143
166
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
144
167
  *
@@ -158,7 +181,7 @@ class Sync {
158
181
  method: "POST",
159
182
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
160
183
  ? yield core.Supplier.get(this._options.apiKey)
161
- : 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),
184
+ : 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),
162
185
  contentType: "application/json",
163
186
  requestType: "json",
164
187
  body: serializers.SyncCreate.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -208,6 +231,16 @@ class Sync {
208
231
  /**
209
232
  * Get a specific sync by ID.
210
233
  *
234
+ * Args:
235
+ * -----
236
+ * db: The database session
237
+ * sync_id: The ID of the sync to get
238
+ * user: The current user
239
+ *
240
+ * Returns:
241
+ * --------
242
+ * sync (schemas.Sync): The sync
243
+ *
211
244
  * @param {string} syncId
212
245
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
213
246
  *
@@ -224,7 +257,7 @@ class Sync {
224
257
  method: "GET",
225
258
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
226
259
  ? yield core.Supplier.get(this._options.apiKey)
227
- : 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),
260
+ : 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),
228
261
  contentType: "application/json",
229
262
  requestType: "json",
230
263
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -273,6 +306,17 @@ class Sync {
273
306
  /**
274
307
  * Delete a sync configuration and optionally its associated data.
275
308
  *
309
+ * Args:
310
+ * -----
311
+ * db: The database session
312
+ * sync_id: The ID of the sync to delete
313
+ * delete_data: Whether to delete the data associated with the sync
314
+ * user: The current user
315
+ *
316
+ * Returns:
317
+ * --------
318
+ * sync (schemas.Sync): The deleted sync
319
+ *
276
320
  * @param {string} syncId
277
321
  * @param {AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest} request
278
322
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
@@ -295,7 +339,7 @@ class Sync {
295
339
  method: "DELETE",
296
340
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
297
341
  ? yield core.Supplier.get(this._options.apiKey)
298
- : 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),
342
+ : 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),
299
343
  contentType: "application/json",
300
344
  queryParameters: _queryParams,
301
345
  requestType: "json",
@@ -345,6 +389,17 @@ class Sync {
345
389
  /**
346
390
  * Trigger a sync run.
347
391
  *
392
+ * Args:
393
+ * -----
394
+ * db: The database session
395
+ * sync_id: The ID of the sync to run
396
+ * user: The current user
397
+ * background_tasks: The background tasks
398
+ *
399
+ * Returns:
400
+ * --------
401
+ * sync_job (schemas.SyncJob): The sync job
402
+ *
348
403
  * @param {string} syncId
349
404
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
350
405
  *
@@ -361,7 +416,7 @@ class Sync {
361
416
  method: "POST",
362
417
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
363
418
  ? yield core.Supplier.get(this._options.apiKey)
364
- : 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),
419
+ : 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),
365
420
  contentType: "application/json",
366
421
  requestType: "json",
367
422
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -410,6 +465,16 @@ class Sync {
410
465
  /**
411
466
  * List all jobs for a specific sync.
412
467
  *
468
+ * Args:
469
+ * -----
470
+ * db: The database session
471
+ * sync_id: The ID of the sync to list jobs for
472
+ * user: The current user
473
+ *
474
+ * Returns:
475
+ * --------
476
+ * list[schemas.SyncJob]: A list of sync jobs
477
+ *
413
478
  * @param {string} syncId
414
479
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
415
480
  *
@@ -426,7 +491,7 @@ class Sync {
426
491
  method: "GET",
427
492
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
428
493
  ? yield core.Supplier.get(this._options.apiKey)
429
- : 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),
494
+ : 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),
430
495
  contentType: "application/json",
431
496
  requestType: "json",
432
497
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -475,6 +540,17 @@ class Sync {
475
540
  /**
476
541
  * Get details of a specific sync job.
477
542
  *
543
+ * Args:
544
+ * -----
545
+ * db: The database session
546
+ * sync_id: The ID of the sync to list jobs for
547
+ * job_id: The ID of the job to get
548
+ * user: The current user
549
+ *
550
+ * Returns:
551
+ * --------
552
+ * sync_job (schemas.SyncJob): The sync job
553
+ *
478
554
  * @param {string} jobId
479
555
  * @param {AirweaveSDK.GetSyncJobSyncJobJobIdGetRequest} request
480
556
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
@@ -497,7 +573,7 @@ class Sync {
497
573
  method: "GET",
498
574
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
499
575
  ? yield core.Supplier.get(this._options.apiKey)
500
- : 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),
576
+ : 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),
501
577
  contentType: "application/json",
502
578
  queryParameters: _queryParams,
503
579
  requestType: "json",
@@ -547,6 +623,15 @@ class Sync {
547
623
  /**
548
624
  * Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
549
625
  *
626
+ * Args:
627
+ * -----
628
+ * job_id: The ID of the job to subscribe to
629
+ * user: The current user
630
+ *
631
+ * Returns:
632
+ * --------
633
+ * StreamingResponse: The streaming response
634
+ *
550
635
  * @param {string} jobId
551
636
  * @param {Sync.RequestOptions} requestOptions - Request-specific configuration.
552
637
  *
@@ -563,7 +648,7 @@ class Sync {
563
648
  method: "GET",
564
649
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
565
650
  ? yield core.Supplier.get(this._options.apiKey)
566
- : 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),
651
+ : 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),
567
652
  contentType: "application/json",
568
653
  requestType: "json",
569
654
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -85,7 +85,7 @@ class Users {
85
85
  method: "GET",
86
86
  headers: Object.assign({ "x-api-key": (yield core.Supplier.get(this._options.apiKey)) != null
87
87
  ? yield core.Supplier.get(this._options.apiKey)
88
- : 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),
88
+ : 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),
89
89
  contentType: "application/json",
90
90
  requestType: "json",
91
91
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -29,6 +29,15 @@ export declare class WhiteLabels {
29
29
  /**
30
30
  * List all white labels for the current user's organization.
31
31
  *
32
+ * Args:
33
+ * -----
34
+ * db: The database session
35
+ * current_user: The current user
36
+ *
37
+ * Returns:
38
+ * --------
39
+ * list[schemas.WhiteLabel]: A list of white labels
40
+ *
32
41
  * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
33
42
  *
34
43
  * @throws {@link AirweaveSDK.UnprocessableEntityError}
@@ -40,6 +49,16 @@ export declare class WhiteLabels {
40
49
  /**
41
50
  * Create new white label integration.
42
51
  *
52
+ * Args:
53
+ * -----
54
+ * db: The database session
55
+ * current_user: The current user
56
+ * white_label_in: The white label to create
57
+ *
58
+ * Returns:
59
+ * --------
60
+ * white_label (schemas.WhiteLabel): The created white label
61
+ *
43
62
  * @param {AirweaveSDK.WhiteLabelCreate} request
44
63
  * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
45
64
  *
@@ -58,6 +77,16 @@ export declare class WhiteLabels {
58
77
  /**
59
78
  * Get a specific white label integration.
60
79
  *
80
+ * Args:
81
+ * -----
82
+ * db: The database session
83
+ * white_label_id: The ID of the white label to get
84
+ * current_user: The current user
85
+ *
86
+ * Returns:
87
+ * --------
88
+ * white_label (schemas.WhiteLabel): The white label
89
+ *
61
90
  * @param {string} whiteLabelId
62
91
  * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
63
92
  *
@@ -70,6 +99,17 @@ export declare class WhiteLabels {
70
99
  /**
71
100
  * Update a white label integration.
72
101
  *
102
+ * Args:
103
+ * -----
104
+ * db: The database session
105
+ * current_user: The current user
106
+ * white_label_id: The ID of the white label to update
107
+ * white_label_in: The white label to update
108
+ *
109
+ * Returns:
110
+ * --------
111
+ * white_label (schemas.WhiteLabel): The updated white label
112
+ *
73
113
  * @param {string} whiteLabelId
74
114
  * @param {AirweaveSDK.WhiteLabelUpdate} request
75
115
  * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
@@ -83,6 +123,16 @@ export declare class WhiteLabels {
83
123
  /**
84
124
  * Delete a white label integration.
85
125
  *
126
+ * Args:
127
+ * -----
128
+ * db: The database session
129
+ * current_user: The current user
130
+ * white_label_id: The ID of the white label to delete
131
+ *
132
+ * Returns:
133
+ * --------
134
+ * white_label (schemas.WhiteLabel): The deleted white label
135
+ *
86
136
  * @param {string} whiteLabelId
87
137
  * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
88
138
  *
@@ -95,6 +145,16 @@ export declare class WhiteLabels {
95
145
  /**
96
146
  * Generate the OAuth2 authorization URL by delegating to oauth2_service.
97
147
  *
148
+ * Args:
149
+ * -----
150
+ * db: The database session
151
+ * white_label_id: The ID of the white label to get the auth URL for
152
+ * user: The current user
153
+ *
154
+ * Returns:
155
+ * --------
156
+ * str: The OAuth2 authorization URL
157
+ *
98
158
  * @param {string} whiteLabelId
99
159
  * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
100
160
  *
@@ -107,6 +167,17 @@ export declare class WhiteLabels {
107
167
  /**
108
168
  * Exchange OAuth2 code for tokens and create connection.
109
169
  *
170
+ * Args:
171
+ * -----
172
+ * white_label_id: The ID of the white label to exchange the code for
173
+ * code: The OAuth2 code
174
+ * db: The database session
175
+ * user: The current user
176
+ *
177
+ * Returns:
178
+ * --------
179
+ * connection (schemas.Connection): The created connection
180
+ *
110
181
  * @param {string} whiteLabelId
111
182
  * @param {string} request
112
183
  * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
@@ -120,6 +191,16 @@ export declare class WhiteLabels {
120
191
  /**
121
192
  * List all syncs for a specific white label.
122
193
  *
194
+ * Args:
195
+ * -----
196
+ * white_label_id: The ID of the white label to list syncs for
197
+ * db: The database session
198
+ * current_user: The current user
199
+ *
200
+ * Returns:
201
+ * --------
202
+ * list[schemas.Sync]: A list of syncs
203
+ *
123
204
  * @param {string} whiteLabelId
124
205
  * @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
125
206
  *