@nvisy/sdk 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +62 -1
- package/README.md +43 -21
- package/dist/auth/index.d.ts +7 -36
- package/dist/auth/index.d.ts.map +1 -0
- package/dist/auth/index.js +96 -174
- package/dist/auth/index.js.map +1 -1
- package/dist/client-DAxwkjk3.d.ts +809 -0
- package/dist/client-DAxwkjk3.d.ts.map +1 -0
- package/dist/config-BRQp8Cat.d.ts +83 -0
- package/dist/config-BRQp8Cat.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -9
- package/dist/datatypes/index.js +0 -3
- package/dist/error-DmkKaDjI.js +199 -0
- package/dist/error-DmkKaDjI.js.map +1 -0
- package/dist/index-DfNB2LNT.d.ts +10477 -0
- package/dist/index-DfNB2LNT.d.ts.map +1 -0
- package/dist/index.d.ts +86 -98
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +273 -1472
- package/dist/index.js.map +1 -1
- package/dist/services/index.d.ts +2 -5
- package/dist/services/index.js +2 -1066
- package/dist/services-DXP-jsLt.js +1087 -0
- package/dist/services-DXP-jsLt.js.map +1 -0
- package/package.json +13 -13
- package/dist/auth-CncOz2vx.d.ts +0 -7420
- package/dist/client-DQRisDAK.d.ts +0 -808
- package/dist/config-L7FKq_q5.d.ts +0 -81
- package/dist/datatypes/index.js.map +0 -1
- package/dist/services/index.js.map +0 -1
- package/dist/workspace-BjdbMWsa.d.ts +0 -118
package/dist/index.js
CHANGED
|
@@ -1,1480 +1,281 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { a as VERSION, i as DEFAULTS, n as NvisyApiError, r as NvisyError, t as errorMiddleware } from "./error-DmkKaDjI.js";
|
|
2
|
+
import { a as Policies, c as Members, d as Connections, f as Auth, h as Account, i as Runs, l as Invites, m as Activities, n as Webhooks, o as Pipelines, p as ApiTokens, r as Status, s as Notifications, t as Workspaces, u as Files } from "./services-DXP-jsLt.js";
|
|
3
|
+
import createClient from "openapi-fetch";
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
* Default base URL for the Nvisy API.
|
|
10
|
-
*/
|
|
11
|
-
BASE_URL: "https://api.nvisy.com",
|
|
12
|
-
/**
|
|
13
|
-
* Default user agent string.
|
|
14
|
-
*/
|
|
15
|
-
USER_AGENT: `@nvisy/sdk v.${VERSION}`
|
|
16
|
-
};
|
|
17
|
-
|
|
18
|
-
// src/errors.ts
|
|
19
|
-
var NvisyError = class extends Error {
|
|
20
|
-
/**
|
|
21
|
-
* The error class name.
|
|
22
|
-
*/
|
|
23
|
-
name;
|
|
24
|
-
/**
|
|
25
|
-
* Creates a new NvisyError.
|
|
26
|
-
*
|
|
27
|
-
* @param message - The error message
|
|
28
|
-
*/
|
|
29
|
-
constructor(message) {
|
|
30
|
-
super(message);
|
|
31
|
-
this.name = this.constructor.name;
|
|
32
|
-
if (Error.captureStackTrace) {
|
|
33
|
-
Error.captureStackTrace(this, this.constructor);
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
};
|
|
37
|
-
var NvisyApiError = class extends NvisyError {
|
|
38
|
-
/**
|
|
39
|
-
* The error type identifier (e.g., "ValidationError", "NotFoundError").
|
|
40
|
-
*/
|
|
41
|
-
name;
|
|
42
|
-
/**
|
|
43
|
-
* Human-readable error message safe for display to end users.
|
|
44
|
-
*/
|
|
45
|
-
message;
|
|
46
|
-
/**
|
|
47
|
-
* The resource type that the error relates to (e.g., "account", "project").
|
|
48
|
-
* May be null if the error is not resource-specific.
|
|
49
|
-
*/
|
|
50
|
-
resource;
|
|
51
|
-
/**
|
|
52
|
-
* A helpful suggestion for resolving the error.
|
|
53
|
-
* May be null if no suggestion is available.
|
|
54
|
-
*/
|
|
55
|
-
suggestion;
|
|
56
|
-
/**
|
|
57
|
-
* Field-specific validation errors.
|
|
58
|
-
* Present when the error is due to invalid input data.
|
|
59
|
-
*/
|
|
60
|
-
validation;
|
|
61
|
-
/**
|
|
62
|
-
* HTTP status code of the response (e.g., 400, 404, 500).
|
|
63
|
-
*/
|
|
64
|
-
statusCode;
|
|
65
|
-
/**
|
|
66
|
-
* Creates a new NvisyApiError from an API error response.
|
|
67
|
-
*
|
|
68
|
-
* @param response - The error response from the API
|
|
69
|
-
* @param statusCode - The HTTP status code of the response
|
|
70
|
-
*/
|
|
71
|
-
constructor(response, statusCode) {
|
|
72
|
-
super(response.message);
|
|
73
|
-
this.name = response.name;
|
|
74
|
-
this.message = response.message;
|
|
75
|
-
this.resource = response.resource;
|
|
76
|
-
this.suggestion = response.suggestion;
|
|
77
|
-
this.validation = response.validation;
|
|
78
|
-
this.statusCode = statusCode;
|
|
79
|
-
if (Error.captureStackTrace) {
|
|
80
|
-
Error.captureStackTrace(this, this.constructor);
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
/**
|
|
84
|
-
* Checks if this is a client error (4xx status code).
|
|
85
|
-
*
|
|
86
|
-
* Client errors indicate problems with the request itself, such as
|
|
87
|
-
* invalid input, missing authentication, or accessing non-existent resources.
|
|
88
|
-
*
|
|
89
|
-
* @returns True if the status code is in the 4xx range
|
|
90
|
-
*/
|
|
91
|
-
isClientError() {
|
|
92
|
-
return this.statusCode >= 400 && this.statusCode < 500;
|
|
93
|
-
}
|
|
94
|
-
/**
|
|
95
|
-
* Checks if this is a server error (5xx status code).
|
|
96
|
-
*
|
|
97
|
-
* Server errors indicate problems on the API side. These are typically
|
|
98
|
-
* transient and may succeed if retried.
|
|
99
|
-
*
|
|
100
|
-
* @returns True if the status code is in the 5xx range
|
|
101
|
-
*/
|
|
102
|
-
isServerError() {
|
|
103
|
-
return this.statusCode >= 500;
|
|
104
|
-
}
|
|
105
|
-
/**
|
|
106
|
-
* Determines if this error is safe to retry.
|
|
107
|
-
*
|
|
108
|
-
* An error is considered retryable if it's a server error (5xx),
|
|
109
|
-
* a request timeout (408), or rate limiting (429).
|
|
110
|
-
*
|
|
111
|
-
* @returns True if the request may succeed on retry
|
|
112
|
-
*/
|
|
113
|
-
isRetryable() {
|
|
114
|
-
return this.statusCode >= 500 || // Server errors
|
|
115
|
-
this.statusCode === 408 || // Request timeout
|
|
116
|
-
this.statusCode === 429;
|
|
117
|
-
}
|
|
118
|
-
/**
|
|
119
|
-
* Converts the error to a plain {@link ErrorResponse} object.
|
|
120
|
-
*
|
|
121
|
-
* Useful for serialization or logging.
|
|
122
|
-
*
|
|
123
|
-
* @returns A plain object representation of the error
|
|
124
|
-
*/
|
|
125
|
-
toJSON() {
|
|
126
|
-
return {
|
|
127
|
-
name: this.name,
|
|
128
|
-
message: this.message,
|
|
129
|
-
resource: this.resource,
|
|
130
|
-
suggestion: this.suggestion,
|
|
131
|
-
validation: this.validation
|
|
132
|
-
};
|
|
133
|
-
}
|
|
134
|
-
};
|
|
135
|
-
|
|
136
|
-
// src/middleware/error.ts
|
|
137
|
-
var errorMiddleware = {
|
|
138
|
-
async onResponse({ response }) {
|
|
139
|
-
if (!response.ok) {
|
|
140
|
-
const error = await response.clone().json();
|
|
141
|
-
throw new NvisyApiError(error, response.status);
|
|
142
|
-
}
|
|
143
|
-
return response;
|
|
144
|
-
},
|
|
145
|
-
onError({ error }) {
|
|
146
|
-
if (error instanceof Error) {
|
|
147
|
-
throw new NvisyError(error.message);
|
|
148
|
-
}
|
|
149
|
-
throw new NvisyError("An unknown network error occurred");
|
|
150
|
-
}
|
|
151
|
-
};
|
|
152
|
-
|
|
153
|
-
// src/middleware/logging.ts
|
|
5
|
+
//#region src/middleware/logging.ts
|
|
6
|
+
/**
|
|
7
|
+
* Creates a logging middleware for debugging requests and responses.
|
|
8
|
+
*
|
|
9
|
+
* Logs request method, URL, response status, and timing to console.
|
|
10
|
+
*/
|
|
154
11
|
function createLoggingMiddleware() {
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
console.error(
|
|
185
|
-
`[nvisy] ${request.method} ${url.pathname} ERROR (${duration}ms):`,
|
|
186
|
-
error instanceof Error ? error.message : error
|
|
187
|
-
);
|
|
188
|
-
}
|
|
189
|
-
};
|
|
12
|
+
return {
|
|
13
|
+
async onRequest({ request }) {
|
|
14
|
+
request._startTime = performance.now();
|
|
15
|
+
return request;
|
|
16
|
+
},
|
|
17
|
+
async onResponse({ request, response }) {
|
|
18
|
+
const start = request._startTime ?? performance.now();
|
|
19
|
+
const duration = Math.round(performance.now() - start);
|
|
20
|
+
const url = new URL(request.url);
|
|
21
|
+
console.log(`[nvisy] ${request.method} ${url.pathname} ${response.status} (${duration}ms)`);
|
|
22
|
+
if (!response.ok) {
|
|
23
|
+
const cloned = response.clone();
|
|
24
|
+
try {
|
|
25
|
+
const body = await cloned.json();
|
|
26
|
+
console.error("[nvisy] Response:", JSON.stringify(body, null, 2));
|
|
27
|
+
} catch {
|
|
28
|
+
const text = await cloned.text();
|
|
29
|
+
if (text) console.error("[nvisy] Response:", text);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
return response;
|
|
33
|
+
},
|
|
34
|
+
onError({ request, error }) {
|
|
35
|
+
const start = request._startTime ?? performance.now();
|
|
36
|
+
const duration = Math.round(performance.now() - start);
|
|
37
|
+
const url = new URL(request.url);
|
|
38
|
+
console.error(`[nvisy] ${request.method} ${url.pathname} ERROR (${duration}ms):`, error instanceof Error ? error.message : error);
|
|
39
|
+
}
|
|
40
|
+
};
|
|
190
41
|
}
|
|
191
42
|
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
* @returns Promise that resolves when logout is complete
|
|
427
|
-
* @throws {ApiError} if the request fails
|
|
428
|
-
*/
|
|
429
|
-
async logoutAccount() {
|
|
430
|
-
await this.#api.POST("/auth/logout");
|
|
431
|
-
}
|
|
432
|
-
};
|
|
433
|
-
|
|
434
|
-
// src/services/comments.ts
|
|
435
|
-
var Comments = class {
|
|
436
|
-
#api;
|
|
437
|
-
constructor(api) {
|
|
438
|
-
this.#api = api;
|
|
439
|
-
}
|
|
440
|
-
/**
|
|
441
|
-
* List all comments on a file
|
|
442
|
-
* @param fileId - File ID
|
|
443
|
-
* @param query - Optional pagination parameters (limit, after)
|
|
444
|
-
* @returns Promise that resolves with a paginated list of comments
|
|
445
|
-
* @throws {ApiError} if the request fails
|
|
446
|
-
*/
|
|
447
|
-
async listComments(fileId, query) {
|
|
448
|
-
const { data } = await this.#api.GET("/files/{fileId}/comments", {
|
|
449
|
-
params: { path: { fileId }, query }
|
|
450
|
-
});
|
|
451
|
-
return data;
|
|
452
|
-
}
|
|
453
|
-
/**
|
|
454
|
-
* Create a new comment on a file
|
|
455
|
-
* @param fileId - File ID
|
|
456
|
-
* @param comment - Comment creation request
|
|
457
|
-
* @returns Promise that resolves with the created comment
|
|
458
|
-
* @throws {ApiError} if the request fails
|
|
459
|
-
*/
|
|
460
|
-
async createComment(fileId, comment) {
|
|
461
|
-
const { data } = await this.#api.POST("/files/{fileId}/comments", {
|
|
462
|
-
params: { path: { fileId } },
|
|
463
|
-
body: comment
|
|
464
|
-
});
|
|
465
|
-
return data;
|
|
466
|
-
}
|
|
467
|
-
/**
|
|
468
|
-
* Update a comment
|
|
469
|
-
* @param commentId - Comment ID
|
|
470
|
-
* @param updates - Comment update request
|
|
471
|
-
* @returns Promise that resolves with the updated comment
|
|
472
|
-
* @throws {ApiError} if the request fails
|
|
473
|
-
*/
|
|
474
|
-
async updateComment(commentId, updates) {
|
|
475
|
-
const { data } = await this.#api.PATCH("/comments/{commentId}", {
|
|
476
|
-
params: { path: { commentId } },
|
|
477
|
-
body: updates
|
|
478
|
-
});
|
|
479
|
-
return data;
|
|
480
|
-
}
|
|
481
|
-
/**
|
|
482
|
-
* Delete a comment
|
|
483
|
-
* @param commentId - Comment ID
|
|
484
|
-
* @returns Promise that resolves when the comment is deleted
|
|
485
|
-
* @throws {ApiError} if the request fails
|
|
486
|
-
*/
|
|
487
|
-
async deleteComment(commentId) {
|
|
488
|
-
await this.#api.DELETE("/comments/{commentId}", {
|
|
489
|
-
params: { path: { commentId } }
|
|
490
|
-
});
|
|
491
|
-
}
|
|
492
|
-
};
|
|
493
|
-
|
|
494
|
-
// src/services/documents.ts
|
|
495
|
-
var Documents = class {
|
|
496
|
-
#api;
|
|
497
|
-
constructor(api) {
|
|
498
|
-
this.#api = api;
|
|
499
|
-
}
|
|
500
|
-
/**
|
|
501
|
-
* List documents in a workspace
|
|
502
|
-
* @param workspaceId - Workspace ID
|
|
503
|
-
* @param query - Optional pagination parameters (limit, after)
|
|
504
|
-
* @returns Promise that resolves with a paginated list of documents
|
|
505
|
-
* @throws {ApiError} if the request fails
|
|
506
|
-
*/
|
|
507
|
-
async listDocuments(workspaceId, query) {
|
|
508
|
-
const { data } = await this.#api.GET(
|
|
509
|
-
"/workspaces/{workspaceId}/documents",
|
|
510
|
-
{
|
|
511
|
-
params: { path: { workspaceId }, query }
|
|
512
|
-
}
|
|
513
|
-
);
|
|
514
|
-
return data;
|
|
515
|
-
}
|
|
516
|
-
/**
|
|
517
|
-
* Get document details by ID
|
|
518
|
-
* @param documentId - Document ID
|
|
519
|
-
* @returns Promise that resolves with the document details
|
|
520
|
-
* @throws {ApiError} if the request fails
|
|
521
|
-
*/
|
|
522
|
-
async getDocument(documentId) {
|
|
523
|
-
const { data } = await this.#api.GET("/documents/{documentId}", {
|
|
524
|
-
params: { path: { documentId } }
|
|
525
|
-
});
|
|
526
|
-
return data;
|
|
527
|
-
}
|
|
528
|
-
/**
|
|
529
|
-
* Create a new document
|
|
530
|
-
* @param workspaceId - Workspace ID
|
|
531
|
-
* @param document - Document creation request
|
|
532
|
-
* @returns Promise that resolves with the created document
|
|
533
|
-
* @throws {ApiError} if the request fails
|
|
534
|
-
*/
|
|
535
|
-
async createDocument(workspaceId, document) {
|
|
536
|
-
const { data } = await this.#api.POST(
|
|
537
|
-
"/workspaces/{workspaceId}/documents",
|
|
538
|
-
{
|
|
539
|
-
params: { path: { workspaceId } },
|
|
540
|
-
body: document
|
|
541
|
-
}
|
|
542
|
-
);
|
|
543
|
-
return data;
|
|
544
|
-
}
|
|
545
|
-
/**
|
|
546
|
-
* Update an existing document
|
|
547
|
-
* @param documentId - Document ID
|
|
548
|
-
* @param updates - Document update request
|
|
549
|
-
* @returns Promise that resolves with the updated document
|
|
550
|
-
* @throws {ApiError} if the request fails
|
|
551
|
-
*/
|
|
552
|
-
async updateDocument(documentId, updates) {
|
|
553
|
-
const { data } = await this.#api.PATCH("/documents/{documentId}", {
|
|
554
|
-
params: { path: { documentId } },
|
|
555
|
-
body: updates
|
|
556
|
-
});
|
|
557
|
-
return data;
|
|
558
|
-
}
|
|
559
|
-
/**
|
|
560
|
-
* Delete a document
|
|
561
|
-
* @param documentId - Document ID
|
|
562
|
-
* @returns Promise that resolves when the document is deleted
|
|
563
|
-
* @throws {ApiError} if the request fails
|
|
564
|
-
*/
|
|
565
|
-
async deleteDocument(documentId) {
|
|
566
|
-
await this.#api.DELETE("/documents/{documentId}", {
|
|
567
|
-
params: { path: { documentId } }
|
|
568
|
-
});
|
|
569
|
-
}
|
|
570
|
-
};
|
|
571
|
-
|
|
572
|
-
// src/services/files.ts
|
|
573
|
-
var Files = class {
|
|
574
|
-
#api;
|
|
575
|
-
constructor(api) {
|
|
576
|
-
this.#api = api;
|
|
577
|
-
}
|
|
578
|
-
/**
|
|
579
|
-
* Upload one or more files to a workspace
|
|
580
|
-
* @param workspaceId - Workspace ID
|
|
581
|
-
* @param files - File or array of files to upload
|
|
582
|
-
* @returns Promise that resolves with the uploaded file metadata
|
|
583
|
-
* @throws {ApiError} if the request fails
|
|
584
|
-
*/
|
|
585
|
-
async uploadFiles(workspaceId, files) {
|
|
586
|
-
const formData = new FormData();
|
|
587
|
-
const fileArray = Array.isArray(files) ? files : [files];
|
|
588
|
-
for (const file of fileArray) {
|
|
589
|
-
const name = file instanceof File ? file.name : "file";
|
|
590
|
-
formData.append("files", file, name);
|
|
591
|
-
}
|
|
592
|
-
const { data } = await this.#api.POST("/workspaces/{workspaceId}/files/", {
|
|
593
|
-
params: { path: { workspaceId } },
|
|
594
|
-
// Schema types multipart as unknown[], but openapi-fetch needs FormData.
|
|
595
|
-
body: formData,
|
|
596
|
-
bodySerializer: (formData2) => formData2,
|
|
597
|
-
// Remove Content-Type so browser sets multipart/form-data with boundary.
|
|
598
|
-
headers: { "Content-Type": null }
|
|
599
|
-
});
|
|
600
|
-
return data;
|
|
601
|
-
}
|
|
602
|
-
/**
|
|
603
|
-
* List files in a workspace
|
|
604
|
-
* @param workspaceId - Workspace ID
|
|
605
|
-
* @param query - Optional query parameters (formats, limit, after)
|
|
606
|
-
* @returns Promise that resolves with a paginated list of files
|
|
607
|
-
* @throws {ApiError} if the request fails
|
|
608
|
-
*/
|
|
609
|
-
async listFiles(workspaceId, query) {
|
|
610
|
-
const { data } = await this.#api.GET("/workspaces/{workspaceId}/files/", {
|
|
611
|
-
params: { path: { workspaceId }, query }
|
|
612
|
-
});
|
|
613
|
-
return data;
|
|
614
|
-
}
|
|
615
|
-
/**
|
|
616
|
-
* Get file metadata by ID
|
|
617
|
-
* @param fileId - File ID
|
|
618
|
-
* @returns Promise that resolves with the file metadata
|
|
619
|
-
* @throws {ApiError} if the request fails
|
|
620
|
-
*/
|
|
621
|
-
async getFile(fileId) {
|
|
622
|
-
const { data } = await this.#api.GET("/files/{fileId}", {
|
|
623
|
-
params: { path: { fileId } }
|
|
624
|
-
});
|
|
625
|
-
return data;
|
|
626
|
-
}
|
|
627
|
-
/**
|
|
628
|
-
* Download a file by ID
|
|
629
|
-
* @param fileId - File ID
|
|
630
|
-
* @returns Promise that resolves with the file response
|
|
631
|
-
* @throws {ApiError} if the request fails
|
|
632
|
-
*/
|
|
633
|
-
async downloadFile(fileId) {
|
|
634
|
-
const { response } = await this.#api.GET("/files/{fileId}/content", {
|
|
635
|
-
params: { path: { fileId } },
|
|
636
|
-
parseAs: "stream"
|
|
637
|
-
});
|
|
638
|
-
return response;
|
|
639
|
-
}
|
|
640
|
-
/**
|
|
641
|
-
* Update a file's metadata
|
|
642
|
-
* @param fileId - File ID
|
|
643
|
-
* @param updates - File update request
|
|
644
|
-
* @returns Promise that resolves with the updated file
|
|
645
|
-
* @throws {ApiError} if the request fails
|
|
646
|
-
*/
|
|
647
|
-
async updateFile(fileId, updates) {
|
|
648
|
-
const { data } = await this.#api.PATCH("/files/{fileId}", {
|
|
649
|
-
params: { path: { fileId } },
|
|
650
|
-
body: updates
|
|
651
|
-
});
|
|
652
|
-
return data;
|
|
653
|
-
}
|
|
654
|
-
/**
|
|
655
|
-
* Delete a file
|
|
656
|
-
* @param fileId - File ID
|
|
657
|
-
* @returns Promise that resolves when the file is deleted
|
|
658
|
-
* @throws {ApiError} if the request fails
|
|
659
|
-
*/
|
|
660
|
-
async deleteFile(fileId) {
|
|
661
|
-
await this.#api.DELETE("/files/{fileId}", {
|
|
662
|
-
params: { path: { fileId } }
|
|
663
|
-
});
|
|
664
|
-
}
|
|
665
|
-
/**
|
|
666
|
-
* Download files as an archive
|
|
667
|
-
* @param workspaceId - Workspace ID
|
|
668
|
-
* @param request - Download request with format and optional file IDs
|
|
669
|
-
* @returns Promise that resolves with the archive response
|
|
670
|
-
* @throws {ApiError} if the request fails
|
|
671
|
-
*/
|
|
672
|
-
async downloadFiles(workspaceId, request) {
|
|
673
|
-
const { response } = await this.#api.GET(
|
|
674
|
-
"/workspaces/{workspaceId}/files/batch",
|
|
675
|
-
{
|
|
676
|
-
params: { path: { workspaceId } },
|
|
677
|
-
body: request,
|
|
678
|
-
parseAs: "stream"
|
|
679
|
-
}
|
|
680
|
-
);
|
|
681
|
-
return response;
|
|
682
|
-
}
|
|
683
|
-
/**
|
|
684
|
-
* Delete multiple files
|
|
685
|
-
* @param workspaceId - Workspace ID
|
|
686
|
-
* @param request - Delete request with file IDs
|
|
687
|
-
* @returns Promise that resolves when the files are deleted
|
|
688
|
-
* @throws {ApiError} if the request fails
|
|
689
|
-
*/
|
|
690
|
-
async deleteFiles(workspaceId, request) {
|
|
691
|
-
await this.#api.DELETE("/workspaces/{workspaceId}/files/batch", {
|
|
692
|
-
params: { path: { workspaceId } },
|
|
693
|
-
body: request
|
|
694
|
-
});
|
|
695
|
-
}
|
|
696
|
-
};
|
|
697
|
-
|
|
698
|
-
// src/services/integrations.ts
|
|
699
|
-
var Integrations = class {
|
|
700
|
-
#api;
|
|
701
|
-
constructor(api) {
|
|
702
|
-
this.#api = api;
|
|
703
|
-
}
|
|
704
|
-
/**
|
|
705
|
-
* List integrations for a workspace
|
|
706
|
-
* @param workspaceId - Workspace ID
|
|
707
|
-
* @param query - Optional pagination parameters (limit, after)
|
|
708
|
-
* @returns Promise that resolves with a paginated list of integrations
|
|
709
|
-
* @throws {ApiError} if the request fails
|
|
710
|
-
*/
|
|
711
|
-
async listIntegrations(workspaceId, query) {
|
|
712
|
-
const { data } = await this.#api.GET(
|
|
713
|
-
"/workspaces/{workspaceId}/integrations/",
|
|
714
|
-
{
|
|
715
|
-
params: { path: { workspaceId }, query }
|
|
716
|
-
}
|
|
717
|
-
);
|
|
718
|
-
return data;
|
|
719
|
-
}
|
|
720
|
-
/**
|
|
721
|
-
* Get integration details by ID
|
|
722
|
-
* @param integrationId - Integration ID
|
|
723
|
-
* @returns Promise that resolves with the integration details
|
|
724
|
-
* @throws {ApiError} if the request fails
|
|
725
|
-
*/
|
|
726
|
-
async getIntegration(integrationId) {
|
|
727
|
-
const { data } = await this.#api.GET("/integrations/{integrationId}/", {
|
|
728
|
-
params: { path: { integrationId } }
|
|
729
|
-
});
|
|
730
|
-
return data;
|
|
731
|
-
}
|
|
732
|
-
/**
|
|
733
|
-
* Create a new integration
|
|
734
|
-
* @param workspaceId - Workspace ID
|
|
735
|
-
* @param integration - Integration creation request
|
|
736
|
-
* @returns Promise that resolves with the created integration
|
|
737
|
-
* @throws {ApiError} if the request fails
|
|
738
|
-
*/
|
|
739
|
-
async createIntegration(workspaceId, integration) {
|
|
740
|
-
const { data } = await this.#api.POST(
|
|
741
|
-
"/workspaces/{workspaceId}/integrations/",
|
|
742
|
-
{
|
|
743
|
-
params: { path: { workspaceId } },
|
|
744
|
-
body: integration
|
|
745
|
-
}
|
|
746
|
-
);
|
|
747
|
-
return data;
|
|
748
|
-
}
|
|
749
|
-
/**
|
|
750
|
-
* Update an existing integration
|
|
751
|
-
* @param integrationId - Integration ID
|
|
752
|
-
* @param updates - Integration update request
|
|
753
|
-
* @returns Promise that resolves with the updated integration
|
|
754
|
-
* @throws {ApiError} if the request fails
|
|
755
|
-
*/
|
|
756
|
-
async updateIntegration(integrationId, updates) {
|
|
757
|
-
const { data } = await this.#api.PUT("/integrations/{integrationId}/", {
|
|
758
|
-
params: { path: { integrationId } },
|
|
759
|
-
body: updates
|
|
760
|
-
});
|
|
761
|
-
return data;
|
|
762
|
-
}
|
|
763
|
-
/**
|
|
764
|
-
* Update integration credentials
|
|
765
|
-
* @param integrationId - Integration ID
|
|
766
|
-
* @param credentials - New credentials
|
|
767
|
-
* @returns Promise that resolves with the updated integration
|
|
768
|
-
* @throws {ApiError} if the request fails
|
|
769
|
-
*/
|
|
770
|
-
async updateIntegrationCredentials(integrationId, credentials) {
|
|
771
|
-
const { data } = await this.#api.PATCH(
|
|
772
|
-
"/integrations/{integrationId}/credentials/",
|
|
773
|
-
{
|
|
774
|
-
params: { path: { integrationId } },
|
|
775
|
-
body: credentials
|
|
776
|
-
}
|
|
777
|
-
);
|
|
778
|
-
return data;
|
|
779
|
-
}
|
|
780
|
-
/**
|
|
781
|
-
* Delete an integration
|
|
782
|
-
* @param integrationId - Integration ID
|
|
783
|
-
* @returns Promise that resolves when the integration is deleted
|
|
784
|
-
* @throws {ApiError} if the request fails
|
|
785
|
-
*/
|
|
786
|
-
async deleteIntegration(integrationId) {
|
|
787
|
-
await this.#api.DELETE("/integrations/{integrationId}/", {
|
|
788
|
-
params: { path: { integrationId } }
|
|
789
|
-
});
|
|
790
|
-
}
|
|
791
|
-
};
|
|
792
|
-
|
|
793
|
-
// src/services/invites.ts
|
|
794
|
-
var Invites = class {
|
|
795
|
-
#api;
|
|
796
|
-
constructor(api) {
|
|
797
|
-
this.#api = api;
|
|
798
|
-
}
|
|
799
|
-
/**
|
|
800
|
-
* List all invitations for a workspace
|
|
801
|
-
* @param workspaceId - Workspace ID
|
|
802
|
-
* @param query - Optional query parameters (role, sortBy, order, limit, after)
|
|
803
|
-
* @returns Promise that resolves with a paginated list of invitations
|
|
804
|
-
* @throws {ApiError} if the request fails
|
|
805
|
-
*/
|
|
806
|
-
async listInvites(workspaceId, query) {
|
|
807
|
-
const { data } = await this.#api.GET("/workspaces/{workspaceId}/invites/", {
|
|
808
|
-
params: { path: { workspaceId }, query }
|
|
809
|
-
});
|
|
810
|
-
return data;
|
|
811
|
-
}
|
|
812
|
-
/**
|
|
813
|
-
* Send an invitation to join a workspace
|
|
814
|
-
* @param workspaceId - Workspace ID
|
|
815
|
-
* @param invite - Invitation request
|
|
816
|
-
* @returns Promise that resolves with the created invitation
|
|
817
|
-
* @throws {ApiError} if the request fails
|
|
818
|
-
*/
|
|
819
|
-
async sendInvite(workspaceId, invite) {
|
|
820
|
-
const { data } = await this.#api.POST(
|
|
821
|
-
"/workspaces/{workspaceId}/invites/",
|
|
822
|
-
{
|
|
823
|
-
params: { path: { workspaceId } },
|
|
824
|
-
body: invite
|
|
825
|
-
}
|
|
826
|
-
);
|
|
827
|
-
return data;
|
|
828
|
-
}
|
|
829
|
-
/**
|
|
830
|
-
* Cancel a pending invitation
|
|
831
|
-
* @param inviteId - Invite ID
|
|
832
|
-
* @returns Promise that resolves when the invitation is canceled
|
|
833
|
-
* @throws {ApiError} if the request fails
|
|
834
|
-
*/
|
|
835
|
-
async cancelInvite(inviteId) {
|
|
836
|
-
await this.#api.DELETE("/invites/{inviteId}/", {
|
|
837
|
-
params: { path: { inviteId } }
|
|
838
|
-
});
|
|
839
|
-
}
|
|
840
|
-
/**
|
|
841
|
-
* Reply to an invitation (accept or decline)
|
|
842
|
-
* @param inviteId - Invite ID
|
|
843
|
-
* @param reply - Reply request
|
|
844
|
-
* @returns Promise that resolves with the updated invitation
|
|
845
|
-
* @throws {ApiError} if the request fails
|
|
846
|
-
*/
|
|
847
|
-
async replyToInvite(inviteId, reply) {
|
|
848
|
-
const { data } = await this.#api.POST("/invites/{inviteId}/", {
|
|
849
|
-
params: { path: { inviteId } },
|
|
850
|
-
body: reply
|
|
851
|
-
});
|
|
852
|
-
return data;
|
|
853
|
-
}
|
|
854
|
-
/**
|
|
855
|
-
* Generate a shareable invite code for a workspace
|
|
856
|
-
* @param workspaceId - Workspace ID
|
|
857
|
-
* @param options - Invite code generation options
|
|
858
|
-
* @returns Promise that resolves with the generated invite code
|
|
859
|
-
* @throws {ApiError} if the request fails
|
|
860
|
-
*/
|
|
861
|
-
async generateInviteCode(workspaceId, options) {
|
|
862
|
-
const { data } = await this.#api.POST(
|
|
863
|
-
"/workspaces/{workspaceId}/invites/code/",
|
|
864
|
-
{
|
|
865
|
-
params: { path: { workspaceId } },
|
|
866
|
-
body: options
|
|
867
|
-
}
|
|
868
|
-
);
|
|
869
|
-
return data;
|
|
870
|
-
}
|
|
871
|
-
/**
|
|
872
|
-
* Reply to an invite code (accept or decline)
|
|
873
|
-
* @param inviteCode - The invite code
|
|
874
|
-
* @param reply - Optional reply request (defaults to accept if not provided)
|
|
875
|
-
* @returns Promise that resolves with the member details if accepted, null if declined
|
|
876
|
-
* @throws {ApiError} if the request fails
|
|
877
|
-
*/
|
|
878
|
-
async replyToInviteCode(inviteCode, reply) {
|
|
879
|
-
const { data } = await this.#api.POST("/invites/code/{inviteCode}/", {
|
|
880
|
-
params: { path: { inviteCode } },
|
|
881
|
-
body: reply ?? null
|
|
882
|
-
});
|
|
883
|
-
return data;
|
|
884
|
-
}
|
|
885
|
-
/**
|
|
886
|
-
* Preview an invite code without joining
|
|
887
|
-
* @param inviteCode - The invite code
|
|
888
|
-
* @returns Promise that resolves with the invite preview details
|
|
889
|
-
* @throws {ApiError} if the request fails
|
|
890
|
-
*/
|
|
891
|
-
async previewInvite(inviteCode) {
|
|
892
|
-
const { data } = await this.#api.GET("/invites/code/{inviteCode}/", {
|
|
893
|
-
params: { path: { inviteCode } }
|
|
894
|
-
});
|
|
895
|
-
return data;
|
|
896
|
-
}
|
|
897
|
-
};
|
|
898
|
-
|
|
899
|
-
// src/services/members.ts
|
|
900
|
-
var Members = class {
|
|
901
|
-
#api;
|
|
902
|
-
constructor(api) {
|
|
903
|
-
this.#api = api;
|
|
904
|
-
}
|
|
905
|
-
/**
|
|
906
|
-
* List members of a workspace
|
|
907
|
-
* @param workspaceId - Workspace ID
|
|
908
|
-
* @param query - Optional query parameters (role, has2fa, sortBy, order, limit, after)
|
|
909
|
-
* @returns Promise that resolves with a paginated list of members
|
|
910
|
-
* @throws {ApiError} if the request fails
|
|
911
|
-
*/
|
|
912
|
-
async listMembers(workspaceId, query) {
|
|
913
|
-
const { data } = await this.#api.GET("/workspaces/{workspaceId}/members/", {
|
|
914
|
-
params: { path: { workspaceId }, query }
|
|
915
|
-
});
|
|
916
|
-
return data;
|
|
917
|
-
}
|
|
918
|
-
/**
|
|
919
|
-
* Get member details by account ID
|
|
920
|
-
* @param workspaceId - Workspace ID
|
|
921
|
-
* @param accountId - Account ID
|
|
922
|
-
* @returns Promise that resolves with the member details
|
|
923
|
-
* @throws {ApiError} if the request fails
|
|
924
|
-
*/
|
|
925
|
-
async getMember(workspaceId, accountId) {
|
|
926
|
-
const { data } = await this.#api.GET(
|
|
927
|
-
"/workspaces/{workspaceId}/members/{accountId}/",
|
|
928
|
-
{
|
|
929
|
-
params: {
|
|
930
|
-
path: { workspaceId, accountId }
|
|
931
|
-
}
|
|
932
|
-
}
|
|
933
|
-
);
|
|
934
|
-
return data;
|
|
935
|
-
}
|
|
936
|
-
/**
|
|
937
|
-
* Update a member's role
|
|
938
|
-
* @param workspaceId - Workspace ID
|
|
939
|
-
* @param accountId - Account ID
|
|
940
|
-
* @param updates - New role for the member
|
|
941
|
-
* @returns Promise that resolves with the updated member
|
|
942
|
-
* @throws {ApiError} if the request fails
|
|
943
|
-
*/
|
|
944
|
-
async updateMember(workspaceId, accountId, updates) {
|
|
945
|
-
const { data } = await this.#api.PATCH(
|
|
946
|
-
"/workspaces/{workspaceId}/members/{accountId}/role",
|
|
947
|
-
{
|
|
948
|
-
params: {
|
|
949
|
-
path: { workspaceId, accountId }
|
|
950
|
-
},
|
|
951
|
-
body: updates
|
|
952
|
-
}
|
|
953
|
-
);
|
|
954
|
-
return data;
|
|
955
|
-
}
|
|
956
|
-
/**
|
|
957
|
-
* Remove a member from a workspace
|
|
958
|
-
* @param workspaceId - Workspace ID
|
|
959
|
-
* @param accountId - Account ID
|
|
960
|
-
* @returns Promise that resolves when the member is removed
|
|
961
|
-
* @throws {ApiError} if the request fails
|
|
962
|
-
*/
|
|
963
|
-
async removeMember(workspaceId, accountId) {
|
|
964
|
-
await this.#api.DELETE("/workspaces/{workspaceId}/members/{accountId}/", {
|
|
965
|
-
params: { path: { workspaceId, accountId } }
|
|
966
|
-
});
|
|
967
|
-
}
|
|
968
|
-
/**
|
|
969
|
-
* Leave a workspace
|
|
970
|
-
* @param workspaceId - Workspace ID
|
|
971
|
-
* @returns Promise that resolves when the member has left
|
|
972
|
-
* @throws {ApiError} if the request fails
|
|
973
|
-
*/
|
|
974
|
-
async leaveWorkspace(workspaceId) {
|
|
975
|
-
await this.#api.POST("/workspaces/{workspaceId}/members/leave", {
|
|
976
|
-
params: { path: { workspaceId } }
|
|
977
|
-
});
|
|
978
|
-
}
|
|
979
|
-
};
|
|
980
|
-
|
|
981
|
-
// src/services/notifications.ts
|
|
982
|
-
var Notifications = class {
|
|
983
|
-
#api;
|
|
984
|
-
constructor(api) {
|
|
985
|
-
this.#api = api;
|
|
986
|
-
}
|
|
987
|
-
/**
|
|
988
|
-
* List notifications for the authenticated account
|
|
989
|
-
* @param query - Optional pagination parameters (limit, after)
|
|
990
|
-
* @returns Promise that resolves with a paginated list of notifications
|
|
991
|
-
* @throws {ApiError} if the request fails
|
|
992
|
-
*/
|
|
993
|
-
async listNotifications(query) {
|
|
994
|
-
const { data } = await this.#api.GET("/notifications/", {
|
|
995
|
-
params: { query }
|
|
996
|
-
});
|
|
997
|
-
return data;
|
|
998
|
-
}
|
|
999
|
-
/**
|
|
1000
|
-
* Get the unread notifications count for the authenticated account
|
|
1001
|
-
* @returns Promise that resolves with the unread status
|
|
1002
|
-
* @throws {ApiError} if the request fails
|
|
1003
|
-
*/
|
|
1004
|
-
async getUnreadNotificationsStatus() {
|
|
1005
|
-
const { data } = await this.#api.GET("/notifications/unread");
|
|
1006
|
-
return data;
|
|
1007
|
-
}
|
|
1008
|
-
};
|
|
1009
|
-
|
|
1010
|
-
// src/services/runs.ts
|
|
1011
|
-
var Runs = class {
|
|
1012
|
-
#api;
|
|
1013
|
-
constructor(api) {
|
|
1014
|
-
this.#api = api;
|
|
1015
|
-
}
|
|
1016
|
-
/**
|
|
1017
|
-
* List integration runs for a workspace
|
|
1018
|
-
* @param workspaceId - Workspace ID
|
|
1019
|
-
* @param query - Optional pagination parameters (limit, after)
|
|
1020
|
-
* @returns Promise that resolves with a paginated list of integration runs
|
|
1021
|
-
* @throws {ApiError} if the request fails
|
|
1022
|
-
*/
|
|
1023
|
-
async listRuns(workspaceId, query) {
|
|
1024
|
-
const { data } = await this.#api.GET("/workspaces/{workspaceId}/runs/", {
|
|
1025
|
-
params: { path: { workspaceId }, query }
|
|
1026
|
-
});
|
|
1027
|
-
return data;
|
|
1028
|
-
}
|
|
1029
|
-
/**
|
|
1030
|
-
* Get integration run details by ID
|
|
1031
|
-
* @param runId - Run ID
|
|
1032
|
-
* @returns Promise that resolves with the integration run details
|
|
1033
|
-
* @throws {ApiError} if the request fails
|
|
1034
|
-
*/
|
|
1035
|
-
async getRun(runId) {
|
|
1036
|
-
const { data } = await this.#api.GET("/runs/{runId}", {
|
|
1037
|
-
params: { path: { runId } }
|
|
1038
|
-
});
|
|
1039
|
-
return data;
|
|
1040
|
-
}
|
|
1041
|
-
};
|
|
1042
|
-
|
|
1043
|
-
// src/services/status.ts
|
|
1044
|
-
var Status = class {
|
|
1045
|
-
#api;
|
|
1046
|
-
constructor(api) {
|
|
1047
|
-
this.#api = api;
|
|
1048
|
-
}
|
|
1049
|
-
/**
|
|
1050
|
-
* Check the health status of the API
|
|
1051
|
-
* @param options - Health check options
|
|
1052
|
-
* @returns Promise that resolves with the API health status
|
|
1053
|
-
*/
|
|
1054
|
-
async checkHealth(options) {
|
|
1055
|
-
const { data, error } = await this.#api.GET("/health", {
|
|
1056
|
-
params: { path: { version: "v1" } },
|
|
1057
|
-
body: options ?? {}
|
|
1058
|
-
});
|
|
1059
|
-
return data ?? error;
|
|
1060
|
-
}
|
|
1061
|
-
};
|
|
1062
|
-
|
|
1063
|
-
// src/services/webhooks.ts
|
|
1064
|
-
var Webhooks = class {
|
|
1065
|
-
#api;
|
|
1066
|
-
constructor(api) {
|
|
1067
|
-
this.#api = api;
|
|
1068
|
-
}
|
|
1069
|
-
/**
|
|
1070
|
-
* List all webhooks in a workspace
|
|
1071
|
-
* @param workspaceId - Workspace ID
|
|
1072
|
-
* @param query - Optional pagination parameters (limit, after)
|
|
1073
|
-
* @returns Promise that resolves with a paginated list of webhooks
|
|
1074
|
-
* @throws {ApiError} if the request fails
|
|
1075
|
-
*/
|
|
1076
|
-
async listWebhooks(workspaceId, query) {
|
|
1077
|
-
const { data } = await this.#api.GET(
|
|
1078
|
-
"/workspaces/{workspaceId}/webhooks/",
|
|
1079
|
-
{
|
|
1080
|
-
params: { path: { workspaceId }, query }
|
|
1081
|
-
}
|
|
1082
|
-
);
|
|
1083
|
-
return data;
|
|
1084
|
-
}
|
|
1085
|
-
/**
|
|
1086
|
-
* Get a specific webhook by ID
|
|
1087
|
-
* @param webhookId - Webhook ID
|
|
1088
|
-
* @returns Promise that resolves with the webhook details
|
|
1089
|
-
* @throws {ApiError} if the request fails
|
|
1090
|
-
*/
|
|
1091
|
-
async getWebhook(webhookId) {
|
|
1092
|
-
const { data } = await this.#api.GET("/webhooks/{webhookId}/", {
|
|
1093
|
-
params: { path: { webhookId } }
|
|
1094
|
-
});
|
|
1095
|
-
return data;
|
|
1096
|
-
}
|
|
1097
|
-
/**
|
|
1098
|
-
* Create a new webhook
|
|
1099
|
-
* @param workspaceId - Workspace ID
|
|
1100
|
-
* @param webhook - Webhook creation request
|
|
1101
|
-
* @returns Promise that resolves with the created webhook
|
|
1102
|
-
* @throws {ApiError} if the request fails
|
|
1103
|
-
*/
|
|
1104
|
-
async createWebhook(workspaceId, webhook) {
|
|
1105
|
-
const { data } = await this.#api.POST(
|
|
1106
|
-
"/workspaces/{workspaceId}/webhooks/",
|
|
1107
|
-
{
|
|
1108
|
-
params: { path: { workspaceId } },
|
|
1109
|
-
body: webhook
|
|
1110
|
-
}
|
|
1111
|
-
);
|
|
1112
|
-
return data;
|
|
1113
|
-
}
|
|
1114
|
-
/**
|
|
1115
|
-
* Update an existing webhook
|
|
1116
|
-
* @param webhookId - Webhook ID
|
|
1117
|
-
* @param updates - Webhook update request
|
|
1118
|
-
* @returns Promise that resolves with the updated webhook
|
|
1119
|
-
* @throws {ApiError} if the request fails
|
|
1120
|
-
*/
|
|
1121
|
-
async updateWebhook(webhookId, updates) {
|
|
1122
|
-
const { data } = await this.#api.PUT("/webhooks/{webhookId}/", {
|
|
1123
|
-
params: { path: { webhookId } },
|
|
1124
|
-
body: updates
|
|
1125
|
-
});
|
|
1126
|
-
return data;
|
|
1127
|
-
}
|
|
1128
|
-
/**
|
|
1129
|
-
* Delete a webhook
|
|
1130
|
-
* @param webhookId - Webhook ID
|
|
1131
|
-
* @returns Promise that resolves when the webhook is deleted
|
|
1132
|
-
* @throws {ApiError} if the request fails
|
|
1133
|
-
*/
|
|
1134
|
-
async deleteWebhook(webhookId) {
|
|
1135
|
-
await this.#api.DELETE("/webhooks/{webhookId}/", {
|
|
1136
|
-
params: { path: { webhookId } }
|
|
1137
|
-
});
|
|
1138
|
-
}
|
|
1139
|
-
/**
|
|
1140
|
-
* Test a webhook by sending a test payload
|
|
1141
|
-
* @param webhookId - Webhook ID
|
|
1142
|
-
* @param options - Test webhook options
|
|
1143
|
-
* @returns Promise that resolves with the test result
|
|
1144
|
-
* @throws {ApiError} if the request fails
|
|
1145
|
-
*/
|
|
1146
|
-
async testWebhook(webhookId, options) {
|
|
1147
|
-
const { data } = await this.#api.POST("/webhooks/{webhookId}/test/", {
|
|
1148
|
-
params: { path: { webhookId } },
|
|
1149
|
-
body: options ?? {}
|
|
1150
|
-
});
|
|
1151
|
-
return data;
|
|
1152
|
-
}
|
|
1153
|
-
};
|
|
1154
|
-
|
|
1155
|
-
// src/services/workspaces.ts
|
|
1156
|
-
var Workspaces = class {
|
|
1157
|
-
#api;
|
|
1158
|
-
constructor(api) {
|
|
1159
|
-
this.#api = api;
|
|
1160
|
-
}
|
|
1161
|
-
/**
|
|
1162
|
-
* List all workspaces
|
|
1163
|
-
* @param query - Optional pagination parameters (limit, after)
|
|
1164
|
-
* @returns Promise that resolves with a paginated list of workspaces
|
|
1165
|
-
* @throws {ApiError} if the request fails
|
|
1166
|
-
*/
|
|
1167
|
-
async listWorkspaces(query) {
|
|
1168
|
-
const { data } = await this.#api.GET("/workspaces/", {
|
|
1169
|
-
params: { query }
|
|
1170
|
-
});
|
|
1171
|
-
return data;
|
|
1172
|
-
}
|
|
1173
|
-
/**
|
|
1174
|
-
* Get workspace details by ID
|
|
1175
|
-
* @param workspaceId - Workspace ID
|
|
1176
|
-
* @returns Promise that resolves with the workspace details
|
|
1177
|
-
* @throws {ApiError} if the request fails
|
|
1178
|
-
*/
|
|
1179
|
-
async getWorkspace(workspaceId) {
|
|
1180
|
-
const { data } = await this.#api.GET("/workspaces/{workspaceId}/", {
|
|
1181
|
-
params: { path: { workspaceId } }
|
|
1182
|
-
});
|
|
1183
|
-
return data;
|
|
1184
|
-
}
|
|
1185
|
-
/**
|
|
1186
|
-
* Create a new workspace
|
|
1187
|
-
* @param workspace - Workspace creation request
|
|
1188
|
-
* @returns Promise that resolves with the created workspace
|
|
1189
|
-
* @throws {ApiError} if the request fails
|
|
1190
|
-
*/
|
|
1191
|
-
async createWorkspace(workspace) {
|
|
1192
|
-
const { data } = await this.#api.POST("/workspaces/", {
|
|
1193
|
-
body: workspace
|
|
1194
|
-
});
|
|
1195
|
-
return data;
|
|
1196
|
-
}
|
|
1197
|
-
/**
|
|
1198
|
-
* Update an existing workspace
|
|
1199
|
-
* @param workspaceId - Workspace ID
|
|
1200
|
-
* @param updates - Workspace update request
|
|
1201
|
-
* @returns Promise that resolves with the updated workspace
|
|
1202
|
-
* @throws {ApiError} if the request fails
|
|
1203
|
-
*/
|
|
1204
|
-
async updateWorkspace(workspaceId, updates) {
|
|
1205
|
-
const { data } = await this.#api.PATCH("/workspaces/{workspaceId}/", {
|
|
1206
|
-
params: { path: { workspaceId } },
|
|
1207
|
-
body: updates
|
|
1208
|
-
});
|
|
1209
|
-
return data;
|
|
1210
|
-
}
|
|
1211
|
-
/**
|
|
1212
|
-
* Delete a workspace
|
|
1213
|
-
* @param workspaceId - Workspace ID
|
|
1214
|
-
* @returns Promise that resolves when the workspace is deleted
|
|
1215
|
-
* @throws {ApiError} if the request fails
|
|
1216
|
-
*/
|
|
1217
|
-
async deleteWorkspace(workspaceId) {
|
|
1218
|
-
await this.#api.DELETE("/workspaces/{workspaceId}/", {
|
|
1219
|
-
params: { path: { workspaceId } }
|
|
1220
|
-
});
|
|
1221
|
-
}
|
|
1222
|
-
/**
|
|
1223
|
-
* Get notification settings for the authenticated user in a workspace
|
|
1224
|
-
* @param workspaceId - Workspace ID
|
|
1225
|
-
* @returns Promise that resolves with the notification settings
|
|
1226
|
-
* @throws {ApiError} if the request fails
|
|
1227
|
-
*/
|
|
1228
|
-
async getNotificationSettings(workspaceId) {
|
|
1229
|
-
const { data } = await this.#api.GET(
|
|
1230
|
-
"/workspaces/{workspaceId}/notifications",
|
|
1231
|
-
{
|
|
1232
|
-
params: { path: { workspaceId } }
|
|
1233
|
-
}
|
|
1234
|
-
);
|
|
1235
|
-
return data;
|
|
1236
|
-
}
|
|
1237
|
-
/**
|
|
1238
|
-
* Update notification settings for the authenticated user in a workspace
|
|
1239
|
-
* @param workspaceId - Workspace ID
|
|
1240
|
-
* @param settings - Notification settings update request
|
|
1241
|
-
* @returns Promise that resolves with the updated notification settings
|
|
1242
|
-
* @throws {ApiError} if the request fails
|
|
1243
|
-
*/
|
|
1244
|
-
async updateNotificationSettings(workspaceId, settings) {
|
|
1245
|
-
const { data } = await this.#api.PATCH(
|
|
1246
|
-
"/workspaces/{workspaceId}/notifications",
|
|
1247
|
-
{
|
|
1248
|
-
params: { path: { workspaceId } },
|
|
1249
|
-
body: settings
|
|
1250
|
-
}
|
|
1251
|
-
);
|
|
1252
|
-
return data;
|
|
1253
|
-
}
|
|
1254
|
-
};
|
|
1255
|
-
|
|
1256
|
-
// src/client.ts
|
|
1257
|
-
var Nvisy = class _Nvisy {
|
|
1258
|
-
/**
|
|
1259
|
-
* The resolved client configuration with defaults applied.
|
|
1260
|
-
* @internal
|
|
1261
|
-
*/
|
|
1262
|
-
#config;
|
|
1263
|
-
/**
|
|
1264
|
-
* The underlying openapi-fetch client instance.
|
|
1265
|
-
* @internal
|
|
1266
|
-
*/
|
|
1267
|
-
#api;
|
|
1268
|
-
/**
|
|
1269
|
-
* Creates a new Nvisy client instance.
|
|
1270
|
-
*
|
|
1271
|
-
* @param config - Configuration options with required `apiToken`
|
|
1272
|
-
* @throws {NvisyError} If the API token is invalid
|
|
1273
|
-
*
|
|
1274
|
-
* @example
|
|
1275
|
-
* ```typescript
|
|
1276
|
-
* const nvisy = new Nvisy({
|
|
1277
|
-
* apiToken: "your-api-token",
|
|
1278
|
-
* baseUrl: "https://custom.api.nvisy.com",
|
|
1279
|
-
* });
|
|
1280
|
-
* const account = await nvisy.account.getAccount();
|
|
1281
|
-
* ```
|
|
1282
|
-
*/
|
|
1283
|
-
constructor(config) {
|
|
1284
|
-
const validatedToken = this.#validateApiToken(config.apiToken);
|
|
1285
|
-
this.#config = {
|
|
1286
|
-
apiToken: validatedToken,
|
|
1287
|
-
baseUrl: config.baseUrl ?? DEFAULTS.BASE_URL,
|
|
1288
|
-
headers: config.headers ?? {},
|
|
1289
|
-
userAgent: config.userAgent ?? DEFAULTS.USER_AGENT,
|
|
1290
|
-
withLogging: config.withLogging ?? false
|
|
1291
|
-
};
|
|
1292
|
-
this.#api = this.#createApiClient();
|
|
1293
|
-
}
|
|
1294
|
-
/**
|
|
1295
|
-
* Creates and configures the underlying openapi-fetch client.
|
|
1296
|
-
*
|
|
1297
|
-
* @returns A configured ApiClient instance
|
|
1298
|
-
* @internal
|
|
1299
|
-
*/
|
|
1300
|
-
#createApiClient() {
|
|
1301
|
-
const headers = {
|
|
1302
|
-
"Content-Type": "application/json",
|
|
1303
|
-
"User-Agent": this.#config.userAgent,
|
|
1304
|
-
Authorization: `Bearer ${this.#config.apiToken}`,
|
|
1305
|
-
...this.#config.headers
|
|
1306
|
-
};
|
|
1307
|
-
const api = createClient({
|
|
1308
|
-
baseUrl: this.#config.baseUrl,
|
|
1309
|
-
headers
|
|
1310
|
-
});
|
|
1311
|
-
if (this.#config.withLogging) {
|
|
1312
|
-
api.use(createLoggingMiddleware());
|
|
1313
|
-
}
|
|
1314
|
-
api.use(errorMiddleware);
|
|
1315
|
-
return api;
|
|
1316
|
-
}
|
|
1317
|
-
/**
|
|
1318
|
-
* Validates an API token format.
|
|
1319
|
-
*
|
|
1320
|
-
* @param apiToken - The API token to validate
|
|
1321
|
-
* @returns The trimmed API token if valid
|
|
1322
|
-
* @throws {NvisyError} If the API token is invalid
|
|
1323
|
-
* @internal
|
|
1324
|
-
*/
|
|
1325
|
-
#validateApiToken(apiToken) {
|
|
1326
|
-
if (typeof apiToken !== "string" || apiToken.trim().length === 0) {
|
|
1327
|
-
throw new NvisyError("API token must be a non-empty string");
|
|
1328
|
-
}
|
|
1329
|
-
const trimmedToken = apiToken.trim();
|
|
1330
|
-
if (trimmedToken.length < 10) {
|
|
1331
|
-
throw new NvisyError("API token must be at least 10 characters");
|
|
1332
|
-
}
|
|
1333
|
-
if (!/^[a-zA-Z0-9_.\-]+$/.test(trimmedToken)) {
|
|
1334
|
-
throw new NvisyError("API token contains invalid characters");
|
|
1335
|
-
}
|
|
1336
|
-
return trimmedToken;
|
|
1337
|
-
}
|
|
1338
|
-
/**
|
|
1339
|
-
* Creates a new client with a different API token.
|
|
1340
|
-
*
|
|
1341
|
-
* Returns a new client instance with the new token. The original client
|
|
1342
|
-
* remains unchanged. All other configuration (base URL, headers, etc.)
|
|
1343
|
-
* is preserved in the new client.
|
|
1344
|
-
*
|
|
1345
|
-
* @param apiToken - The new API token
|
|
1346
|
-
* @returns A new Nvisy instance with the new token
|
|
1347
|
-
* @throws {NvisyError} If the API token is invalid
|
|
1348
|
-
*
|
|
1349
|
-
* @example
|
|
1350
|
-
* ```typescript
|
|
1351
|
-
* const nvisy = new Nvisy({ apiToken: "original-token" });
|
|
1352
|
-
* const newNvisy = nvisy.withApiToken("new-token");
|
|
1353
|
-
*
|
|
1354
|
-
* // newNvisy uses the new token
|
|
1355
|
-
* // nvisy still uses the original token
|
|
1356
|
-
* ```
|
|
1357
|
-
*/
|
|
1358
|
-
withApiToken(apiToken) {
|
|
1359
|
-
return new _Nvisy({ ...this.#config, apiToken });
|
|
1360
|
-
}
|
|
1361
|
-
/**
|
|
1362
|
-
* The base URL used for API requests.
|
|
1363
|
-
*
|
|
1364
|
-
* @returns The configured base URL
|
|
1365
|
-
*/
|
|
1366
|
-
get baseUrl() {
|
|
1367
|
-
return this.#config.baseUrl;
|
|
1368
|
-
}
|
|
1369
|
-
/**
|
|
1370
|
-
* The underlying openapi-fetch client for direct API access.
|
|
1371
|
-
*
|
|
1372
|
-
* Use this for advanced scenarios where you need direct access to the
|
|
1373
|
-
* HTTP client, such as calling endpoints not covered by the service classes.
|
|
1374
|
-
*
|
|
1375
|
-
* @returns The configured ApiClient instance
|
|
1376
|
-
*/
|
|
1377
|
-
get api() {
|
|
1378
|
-
return this.#api;
|
|
1379
|
-
}
|
|
1380
|
-
/**
|
|
1381
|
-
* Service for authentication operations (login, signup, logout).
|
|
1382
|
-
*/
|
|
1383
|
-
get auth() {
|
|
1384
|
-
return new Auth(this.#api);
|
|
1385
|
-
}
|
|
1386
|
-
/**
|
|
1387
|
-
* Service for API status and health checks.
|
|
1388
|
-
*/
|
|
1389
|
-
get status() {
|
|
1390
|
-
return new Status(this.#api);
|
|
1391
|
-
}
|
|
1392
|
-
/**
|
|
1393
|
-
* Service for managing the authenticated user's account.
|
|
1394
|
-
*/
|
|
1395
|
-
get account() {
|
|
1396
|
-
return new Account(this.#api);
|
|
1397
|
-
}
|
|
1398
|
-
/**
|
|
1399
|
-
* Service for viewing workspace activities.
|
|
1400
|
-
*/
|
|
1401
|
-
get activities() {
|
|
1402
|
-
return new Activities(this.#api);
|
|
1403
|
-
}
|
|
1404
|
-
/**
|
|
1405
|
-
* Service for managing file annotations.
|
|
1406
|
-
*/
|
|
1407
|
-
get annotations() {
|
|
1408
|
-
return new Annotations(this.#api);
|
|
1409
|
-
}
|
|
1410
|
-
/**
|
|
1411
|
-
* Service for managing API tokens.
|
|
1412
|
-
*/
|
|
1413
|
-
get apiTokens() {
|
|
1414
|
-
return new ApiTokens(this.#api);
|
|
1415
|
-
}
|
|
1416
|
-
/**
|
|
1417
|
-
* Service for managing file comments.
|
|
1418
|
-
*/
|
|
1419
|
-
get comments() {
|
|
1420
|
-
return new Comments(this.#api);
|
|
1421
|
-
}
|
|
1422
|
-
/**
|
|
1423
|
-
* Service for document operations.
|
|
1424
|
-
*/
|
|
1425
|
-
get documents() {
|
|
1426
|
-
return new Documents(this.#api);
|
|
1427
|
-
}
|
|
1428
|
-
/**
|
|
1429
|
-
* Service for file operations (upload, download, delete).
|
|
1430
|
-
*/
|
|
1431
|
-
get files() {
|
|
1432
|
-
return new Files(this.#api);
|
|
1433
|
-
}
|
|
1434
|
-
/**
|
|
1435
|
-
* Service for managing integrations.
|
|
1436
|
-
*/
|
|
1437
|
-
get integrations() {
|
|
1438
|
-
return new Integrations(this.#api);
|
|
1439
|
-
}
|
|
1440
|
-
/**
|
|
1441
|
-
* Service for managing workspace invitations.
|
|
1442
|
-
*/
|
|
1443
|
-
get invites() {
|
|
1444
|
-
return new Invites(this.#api);
|
|
1445
|
-
}
|
|
1446
|
-
/**
|
|
1447
|
-
* Service for managing workspace members.
|
|
1448
|
-
*/
|
|
1449
|
-
get members() {
|
|
1450
|
-
return new Members(this.#api);
|
|
1451
|
-
}
|
|
1452
|
-
/**
|
|
1453
|
-
* Service for managing notifications.
|
|
1454
|
-
*/
|
|
1455
|
-
get notifications() {
|
|
1456
|
-
return new Notifications(this.#api);
|
|
1457
|
-
}
|
|
1458
|
-
/**
|
|
1459
|
-
* Service for managing processing runs.
|
|
1460
|
-
*/
|
|
1461
|
-
get runs() {
|
|
1462
|
-
return new Runs(this.#api);
|
|
1463
|
-
}
|
|
1464
|
-
/**
|
|
1465
|
-
* Service for managing webhooks.
|
|
1466
|
-
*/
|
|
1467
|
-
get webhooks() {
|
|
1468
|
-
return new Webhooks(this.#api);
|
|
1469
|
-
}
|
|
1470
|
-
/**
|
|
1471
|
-
* Service for managing workspaces.
|
|
1472
|
-
*/
|
|
1473
|
-
get workspaces() {
|
|
1474
|
-
return new Workspaces(this.#api);
|
|
1475
|
-
}
|
|
43
|
+
//#endregion
|
|
44
|
+
//#region src/client.ts
|
|
45
|
+
/**
|
|
46
|
+
* @fileoverview Main client for the Nvisy SDK.
|
|
47
|
+
*
|
|
48
|
+
* This module exports the {@link Nvisy} class, which is the primary entry point
|
|
49
|
+
* for interacting with the Nvisy document processing API.
|
|
50
|
+
*
|
|
51
|
+
* @module client
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```typescript
|
|
55
|
+
* const nvisy = new Nvisy({ apiToken: "your-api-token" });
|
|
56
|
+
* const account = await nvisy.account.getAccount();
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
/**
|
|
60
|
+
* Main client class for interacting with the Nvisy document processing API.
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```typescript
|
|
64
|
+
* const nvisy = new Nvisy({ apiToken: "your-api-token" });
|
|
65
|
+
* const account = await nvisy.account.getAccount();
|
|
66
|
+
* const workspaces = await nvisy.workspaces.listWorkspaces();
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
var Nvisy = class Nvisy {
|
|
70
|
+
/**
|
|
71
|
+
* The resolved client configuration with defaults applied.
|
|
72
|
+
* @internal
|
|
73
|
+
*/
|
|
74
|
+
#config;
|
|
75
|
+
/**
|
|
76
|
+
* The underlying openapi-fetch client instance.
|
|
77
|
+
* @internal
|
|
78
|
+
*/
|
|
79
|
+
#api;
|
|
80
|
+
/**
|
|
81
|
+
* Creates a new Nvisy client instance.
|
|
82
|
+
*
|
|
83
|
+
* @param config - Configuration options with required `apiToken`
|
|
84
|
+
* @throws {NvisyError} If the API token is invalid
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* ```typescript
|
|
88
|
+
* const nvisy = new Nvisy({
|
|
89
|
+
* apiToken: "your-api-token",
|
|
90
|
+
* baseUrl: "https://custom.api.nvisy.com",
|
|
91
|
+
* });
|
|
92
|
+
* const account = await nvisy.account.getAccount();
|
|
93
|
+
* ```
|
|
94
|
+
*/
|
|
95
|
+
constructor(config) {
|
|
96
|
+
const validatedToken = this.#validateApiToken(config.apiToken);
|
|
97
|
+
this.#config = {
|
|
98
|
+
apiToken: validatedToken,
|
|
99
|
+
baseUrl: config.baseUrl ?? DEFAULTS.BASE_URL,
|
|
100
|
+
headers: config.headers ?? {},
|
|
101
|
+
userAgent: config.userAgent ?? DEFAULTS.USER_AGENT,
|
|
102
|
+
withLogging: config.withLogging ?? false
|
|
103
|
+
};
|
|
104
|
+
this.#api = this.#createApiClient();
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Creates and configures the underlying openapi-fetch client.
|
|
108
|
+
*
|
|
109
|
+
* @returns A configured ApiClient instance
|
|
110
|
+
* @internal
|
|
111
|
+
*/
|
|
112
|
+
#createApiClient() {
|
|
113
|
+
const headers = {
|
|
114
|
+
"Content-Type": "application/json",
|
|
115
|
+
"User-Agent": this.#config.userAgent,
|
|
116
|
+
Authorization: `Bearer ${this.#config.apiToken}`,
|
|
117
|
+
...this.#config.headers
|
|
118
|
+
};
|
|
119
|
+
const api = createClient({
|
|
120
|
+
baseUrl: this.#config.baseUrl,
|
|
121
|
+
headers
|
|
122
|
+
});
|
|
123
|
+
if (this.#config.withLogging) api.use(createLoggingMiddleware());
|
|
124
|
+
api.use(errorMiddleware);
|
|
125
|
+
return api;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Validates an API token format.
|
|
129
|
+
*
|
|
130
|
+
* @param apiToken - The API token to validate
|
|
131
|
+
* @returns The trimmed API token if valid
|
|
132
|
+
* @throws {NvisyError} If the API token is invalid
|
|
133
|
+
* @internal
|
|
134
|
+
*/
|
|
135
|
+
#validateApiToken(apiToken) {
|
|
136
|
+
if (typeof apiToken !== "string" || apiToken.trim().length === 0) throw new NvisyError("API token must be a non-empty string");
|
|
137
|
+
const trimmedToken = apiToken.trim();
|
|
138
|
+
if (trimmedToken.length < 10) throw new NvisyError("API token must be at least 10 characters");
|
|
139
|
+
if (!/^[a-zA-Z0-9_.-]+$/.test(trimmedToken)) throw new NvisyError("API token contains invalid characters");
|
|
140
|
+
return trimmedToken;
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Creates a new client with a different API token.
|
|
144
|
+
*
|
|
145
|
+
* Returns a new client instance with the new token. The original client
|
|
146
|
+
* remains unchanged. All other configuration (base URL, headers, etc.)
|
|
147
|
+
* is preserved in the new client.
|
|
148
|
+
*
|
|
149
|
+
* @param apiToken - The new API token
|
|
150
|
+
* @returns A new Nvisy instance with the new token
|
|
151
|
+
* @throws {NvisyError} If the API token is invalid
|
|
152
|
+
*
|
|
153
|
+
* @example
|
|
154
|
+
* ```typescript
|
|
155
|
+
* const nvisy = new Nvisy({ apiToken: "original-token" });
|
|
156
|
+
* const newNvisy = nvisy.withApiToken("new-token");
|
|
157
|
+
*
|
|
158
|
+
* // newNvisy uses the new token
|
|
159
|
+
* // nvisy still uses the original token
|
|
160
|
+
* ```
|
|
161
|
+
*/
|
|
162
|
+
withApiToken(apiToken) {
|
|
163
|
+
return new Nvisy({
|
|
164
|
+
...this.#config,
|
|
165
|
+
apiToken
|
|
166
|
+
});
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* The base URL used for API requests.
|
|
170
|
+
*
|
|
171
|
+
* @returns The configured base URL
|
|
172
|
+
*/
|
|
173
|
+
get baseUrl() {
|
|
174
|
+
return this.#config.baseUrl;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* The underlying openapi-fetch client for direct API access.
|
|
178
|
+
*
|
|
179
|
+
* Use this for advanced scenarios where you need direct access to the
|
|
180
|
+
* HTTP client, such as calling endpoints not covered by the service classes.
|
|
181
|
+
*
|
|
182
|
+
* @returns The configured ApiClient instance
|
|
183
|
+
*/
|
|
184
|
+
get api() {
|
|
185
|
+
return this.#api;
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* Service for authentication operations (login, signup, logout).
|
|
189
|
+
*/
|
|
190
|
+
get auth() {
|
|
191
|
+
return new Auth(this.#api);
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* Service for API status and health checks.
|
|
195
|
+
*/
|
|
196
|
+
get status() {
|
|
197
|
+
return new Status(this.#api);
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* Service for managing the authenticated user's account.
|
|
201
|
+
*/
|
|
202
|
+
get account() {
|
|
203
|
+
return new Account(this.#api);
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* Service for viewing workspace activities.
|
|
207
|
+
*/
|
|
208
|
+
get activities() {
|
|
209
|
+
return new Activities(this.#api);
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* Service for managing API tokens.
|
|
213
|
+
*/
|
|
214
|
+
get apiTokens() {
|
|
215
|
+
return new ApiTokens(this.#api);
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Service for managing connections.
|
|
219
|
+
*/
|
|
220
|
+
get connections() {
|
|
221
|
+
return new Connections(this.#api);
|
|
222
|
+
}
|
|
223
|
+
/**
|
|
224
|
+
* Service for file operations (upload, download, delete).
|
|
225
|
+
*/
|
|
226
|
+
get files() {
|
|
227
|
+
return new Files(this.#api);
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
* Service for managing pipelines.
|
|
231
|
+
*/
|
|
232
|
+
get pipelines() {
|
|
233
|
+
return new Pipelines(this.#api);
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* Service for managing policies.
|
|
237
|
+
*/
|
|
238
|
+
get policies() {
|
|
239
|
+
return new Policies(this.#api);
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Service for managing workspace invitations.
|
|
243
|
+
*/
|
|
244
|
+
get invites() {
|
|
245
|
+
return new Invites(this.#api);
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* Service for managing workspace members.
|
|
249
|
+
*/
|
|
250
|
+
get members() {
|
|
251
|
+
return new Members(this.#api);
|
|
252
|
+
}
|
|
253
|
+
/**
|
|
254
|
+
* Service for managing notifications.
|
|
255
|
+
*/
|
|
256
|
+
get notifications() {
|
|
257
|
+
return new Notifications(this.#api);
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Service for managing pipeline runs.
|
|
261
|
+
*/
|
|
262
|
+
get runs() {
|
|
263
|
+
return new Runs(this.#api);
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Service for managing webhooks.
|
|
267
|
+
*/
|
|
268
|
+
get webhooks() {
|
|
269
|
+
return new Webhooks(this.#api);
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
* Service for managing workspaces.
|
|
273
|
+
*/
|
|
274
|
+
get workspaces() {
|
|
275
|
+
return new Workspaces(this.#api);
|
|
276
|
+
}
|
|
1476
277
|
};
|
|
1477
278
|
|
|
279
|
+
//#endregion
|
|
1478
280
|
export { DEFAULTS, Nvisy, NvisyApiError, NvisyError, VERSION };
|
|
1479
|
-
//# sourceMappingURL=index.js.map
|
|
1480
281
|
//# sourceMappingURL=index.js.map
|