@knowledge-stack/ksapi 1.40.1 → 1.42.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/.openapi-generator/FILES +8 -0
- package/README.md +18 -9
- package/dist/apis/ApiKeysApi.d.ts +187 -0
- package/dist/apis/ApiKeysApi.js +193 -0
- package/dist/apis/AuthApi.d.ts +6 -0
- package/dist/apis/AuthApi.js +6 -0
- package/dist/apis/ChunkLineagesApi.d.ts +9 -0
- package/dist/apis/ChunkLineagesApi.js +9 -0
- package/dist/apis/ChunksApi.d.ts +24 -0
- package/dist/apis/ChunksApi.js +24 -0
- package/dist/apis/DocumentVersionsApi.d.ts +21 -0
- package/dist/apis/DocumentVersionsApi.js +21 -0
- package/dist/apis/DocumentsApi.d.ts +21 -0
- package/dist/apis/DocumentsApi.js +21 -0
- package/dist/apis/FoldersApi.d.ts +21 -0
- package/dist/apis/FoldersApi.js +21 -0
- package/dist/apis/InvitesApi.d.ts +12 -0
- package/dist/apis/InvitesApi.js +12 -0
- package/dist/apis/PathPartsApi.d.ts +18 -0
- package/dist/apis/PathPartsApi.js +18 -0
- package/dist/apis/SectionsApi.d.ts +12 -0
- package/dist/apis/SectionsApi.js +12 -0
- package/dist/apis/TagsApi.d.ts +15 -0
- package/dist/apis/TagsApi.js +15 -0
- package/dist/apis/TenantsApi.d.ts +24 -0
- package/dist/apis/TenantsApi.js +24 -0
- package/dist/apis/ThreadMessagesApi.d.ts +9 -0
- package/dist/apis/ThreadMessagesApi.js +9 -0
- package/dist/apis/ThreadsApi.d.ts +21 -0
- package/dist/apis/ThreadsApi.js +21 -0
- package/dist/apis/UserPermissionsApi.d.ts +12 -0
- package/dist/apis/UserPermissionsApi.js +12 -0
- package/dist/apis/UsersApi.d.ts +6 -0
- package/dist/apis/UsersApi.js +6 -0
- package/dist/apis/WorkflowsApi.d.ts +9 -0
- package/dist/apis/WorkflowsApi.js +9 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ApiKeysApi.d.ts +187 -0
- package/dist/esm/apis/ApiKeysApi.js +189 -0
- package/dist/esm/apis/AuthApi.d.ts +6 -0
- package/dist/esm/apis/AuthApi.js +6 -0
- package/dist/esm/apis/ChunkLineagesApi.d.ts +9 -0
- package/dist/esm/apis/ChunkLineagesApi.js +9 -0
- package/dist/esm/apis/ChunksApi.d.ts +24 -0
- package/dist/esm/apis/ChunksApi.js +24 -0
- package/dist/esm/apis/DocumentVersionsApi.d.ts +21 -0
- package/dist/esm/apis/DocumentVersionsApi.js +21 -0
- package/dist/esm/apis/DocumentsApi.d.ts +21 -0
- package/dist/esm/apis/DocumentsApi.js +21 -0
- package/dist/esm/apis/FoldersApi.d.ts +21 -0
- package/dist/esm/apis/FoldersApi.js +21 -0
- package/dist/esm/apis/InvitesApi.d.ts +12 -0
- package/dist/esm/apis/InvitesApi.js +12 -0
- package/dist/esm/apis/PathPartsApi.d.ts +18 -0
- package/dist/esm/apis/PathPartsApi.js +18 -0
- package/dist/esm/apis/SectionsApi.d.ts +12 -0
- package/dist/esm/apis/SectionsApi.js +12 -0
- package/dist/esm/apis/TagsApi.d.ts +15 -0
- package/dist/esm/apis/TagsApi.js +15 -0
- package/dist/esm/apis/TenantsApi.d.ts +24 -0
- package/dist/esm/apis/TenantsApi.js +24 -0
- package/dist/esm/apis/ThreadMessagesApi.d.ts +9 -0
- package/dist/esm/apis/ThreadMessagesApi.js +9 -0
- package/dist/esm/apis/ThreadsApi.d.ts +21 -0
- package/dist/esm/apis/ThreadsApi.js +21 -0
- package/dist/esm/apis/UserPermissionsApi.d.ts +12 -0
- package/dist/esm/apis/UserPermissionsApi.js +12 -0
- package/dist/esm/apis/UsersApi.d.ts +6 -0
- package/dist/esm/apis/UsersApi.js +6 -0
- package/dist/esm/apis/WorkflowsApi.d.ts +9 -0
- package/dist/esm/apis/WorkflowsApi.js +9 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/ApiKeyResponse.d.ts +65 -0
- package/dist/esm/models/ApiKeyResponse.js +56 -0
- package/dist/esm/models/CreateApiKeyRequest.d.ts +47 -0
- package/dist/esm/models/CreateApiKeyRequest.js +49 -0
- package/dist/esm/models/CreateApiKeyResponse.d.ts +71 -0
- package/dist/esm/models/CreateApiKeyResponse.js +60 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/ApiKeyResponse.d.ts +65 -0
- package/dist/models/ApiKeyResponse.js +64 -0
- package/dist/models/CreateApiKeyRequest.d.ts +47 -0
- package/dist/models/CreateApiKeyRequest.js +57 -0
- package/dist/models/CreateApiKeyResponse.d.ts +71 -0
- package/dist/models/CreateApiKeyResponse.js +68 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/ApiKeyResponse.md +41 -0
- package/docs/ApiKeysApi.md +293 -0
- package/docs/AuthApi.md +8 -2
- package/docs/ChunkLineagesApi.md +12 -3
- package/docs/ChunksApi.md +32 -8
- package/docs/CreateApiKeyRequest.md +35 -0
- package/docs/CreateApiKeyResponse.md +43 -0
- package/docs/DocumentVersionsApi.md +28 -7
- package/docs/DocumentsApi.md +28 -7
- package/docs/FoldersApi.md +28 -7
- package/docs/InvitesApi.md +16 -4
- package/docs/PathPartsApi.md +24 -6
- package/docs/SectionsApi.md +16 -4
- package/docs/TagsApi.md +20 -5
- package/docs/TenantsApi.md +32 -8
- package/docs/ThreadMessagesApi.md +12 -3
- package/docs/ThreadsApi.md +28 -7
- package/docs/UserPermissionsApi.md +16 -4
- package/docs/UsersApi.md +8 -2
- package/docs/WorkflowsApi.md +12 -3
- package/package.json +1 -1
- package/src/apis/ApiKeysApi.ts +350 -0
- package/src/apis/AuthApi.ts +14 -0
- package/src/apis/ChunkLineagesApi.ts +21 -0
- package/src/apis/ChunksApi.ts +56 -0
- package/src/apis/DocumentVersionsApi.ts +49 -0
- package/src/apis/DocumentsApi.ts +49 -0
- package/src/apis/FoldersApi.ts +49 -0
- package/src/apis/InvitesApi.ts +28 -0
- package/src/apis/PathPartsApi.ts +42 -0
- package/src/apis/SectionsApi.ts +28 -0
- package/src/apis/TagsApi.ts +35 -0
- package/src/apis/TenantsApi.ts +56 -0
- package/src/apis/ThreadMessagesApi.ts +21 -0
- package/src/apis/ThreadsApi.ts +49 -0
- package/src/apis/UserPermissionsApi.ts +28 -0
- package/src/apis/UsersApi.ts +14 -0
- package/src/apis/WorkflowsApi.ts +21 -0
- package/src/apis/index.ts +1 -0
- package/src/models/ApiKeyResponse.ts +110 -0
- package/src/models/CreateApiKeyRequest.ts +87 -0
- package/src/models/CreateApiKeyResponse.ts +119 -0
- package/src/models/index.ts +3 -0
package/docs/ThreadsApi.md
CHANGED
|
@@ -16,7 +16,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
16
16
|
|
|
17
17
|
## createThread
|
|
18
18
|
|
|
19
|
-
> ThreadResponse createThread(createThreadRequest, ksUat)
|
|
19
|
+
> ThreadResponse createThread(createThreadRequest, authorization, ksUat)
|
|
20
20
|
|
|
21
21
|
Create Thread Handler
|
|
22
22
|
|
|
@@ -39,6 +39,8 @@ async function example() {
|
|
|
39
39
|
// CreateThreadRequest
|
|
40
40
|
createThreadRequest: ...,
|
|
41
41
|
// string (optional)
|
|
42
|
+
authorization: authorization_example,
|
|
43
|
+
// string (optional)
|
|
42
44
|
ksUat: ksUat_example,
|
|
43
45
|
} satisfies CreateThreadOperationRequest;
|
|
44
46
|
|
|
@@ -60,6 +62,7 @@ example().catch(console.error);
|
|
|
60
62
|
| Name | Type | Description | Notes |
|
|
61
63
|
|------------- | ------------- | ------------- | -------------|
|
|
62
64
|
| **createThreadRequest** | [CreateThreadRequest](CreateThreadRequest.md) | | |
|
|
65
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
63
66
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
64
67
|
|
|
65
68
|
### Return type
|
|
@@ -87,7 +90,7 @@ No authorization required
|
|
|
87
90
|
|
|
88
91
|
## deleteThread
|
|
89
92
|
|
|
90
|
-
> deleteThread(threadId, ksUat)
|
|
93
|
+
> deleteThread(threadId, authorization, ksUat)
|
|
91
94
|
|
|
92
95
|
Delete Thread Handler
|
|
93
96
|
|
|
@@ -110,6 +113,8 @@ async function example() {
|
|
|
110
113
|
// string
|
|
111
114
|
threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
112
115
|
// string (optional)
|
|
116
|
+
authorization: authorization_example,
|
|
117
|
+
// string (optional)
|
|
113
118
|
ksUat: ksUat_example,
|
|
114
119
|
} satisfies DeleteThreadRequest;
|
|
115
120
|
|
|
@@ -131,6 +136,7 @@ example().catch(console.error);
|
|
|
131
136
|
| Name | Type | Description | Notes |
|
|
132
137
|
|------------- | ------------- | ------------- | -------------|
|
|
133
138
|
| **threadId** | `string` | | [Defaults to `undefined`] |
|
|
139
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
134
140
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
135
141
|
|
|
136
142
|
### Return type
|
|
@@ -158,7 +164,7 @@ No authorization required
|
|
|
158
164
|
|
|
159
165
|
## getThread
|
|
160
166
|
|
|
161
|
-
> ThreadResponse getThread(threadId, ksUat)
|
|
167
|
+
> ThreadResponse getThread(threadId, authorization, ksUat)
|
|
162
168
|
|
|
163
169
|
Get Thread Handler
|
|
164
170
|
|
|
@@ -181,6 +187,8 @@ async function example() {
|
|
|
181
187
|
// string
|
|
182
188
|
threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
183
189
|
// string (optional)
|
|
190
|
+
authorization: authorization_example,
|
|
191
|
+
// string (optional)
|
|
184
192
|
ksUat: ksUat_example,
|
|
185
193
|
} satisfies GetThreadRequest;
|
|
186
194
|
|
|
@@ -202,6 +210,7 @@ example().catch(console.error);
|
|
|
202
210
|
| Name | Type | Description | Notes |
|
|
203
211
|
|------------- | ------------- | ------------- | -------------|
|
|
204
212
|
| **threadId** | `string` | | [Defaults to `undefined`] |
|
|
213
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
205
214
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
206
215
|
|
|
207
216
|
### Return type
|
|
@@ -229,7 +238,7 @@ No authorization required
|
|
|
229
238
|
|
|
230
239
|
## listThreads
|
|
231
240
|
|
|
232
|
-
> PaginatedResponseThreadResponse listThreads(parentPathPartId, limit, offset, ksUat)
|
|
241
|
+
> PaginatedResponseThreadResponse listThreads(parentPathPartId, limit, offset, authorization, ksUat)
|
|
233
242
|
|
|
234
243
|
List Threads Handler
|
|
235
244
|
|
|
@@ -256,6 +265,8 @@ async function example() {
|
|
|
256
265
|
// number | Number of items to skip (optional)
|
|
257
266
|
offset: 56,
|
|
258
267
|
// string (optional)
|
|
268
|
+
authorization: authorization_example,
|
|
269
|
+
// string (optional)
|
|
259
270
|
ksUat: ksUat_example,
|
|
260
271
|
} satisfies ListThreadsRequest;
|
|
261
272
|
|
|
@@ -279,6 +290,7 @@ example().catch(console.error);
|
|
|
279
290
|
| **parentPathPartId** | `string` | Parent PathPart ID. Omit to list user\'s conversation threads. | [Optional] [Defaults to `undefined`] |
|
|
280
291
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
281
292
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
293
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
282
294
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
283
295
|
|
|
284
296
|
### Return type
|
|
@@ -306,7 +318,7 @@ No authorization required
|
|
|
306
318
|
|
|
307
319
|
## sendUserMessage
|
|
308
320
|
|
|
309
|
-
> UserMessageResponse sendUserMessage(threadId, userMessageRequest, ksUat)
|
|
321
|
+
> UserMessageResponse sendUserMessage(threadId, userMessageRequest, authorization, ksUat)
|
|
310
322
|
|
|
311
323
|
Send User Message Handler
|
|
312
324
|
|
|
@@ -331,6 +343,8 @@ async function example() {
|
|
|
331
343
|
// UserMessageRequest
|
|
332
344
|
userMessageRequest: ...,
|
|
333
345
|
// string (optional)
|
|
346
|
+
authorization: authorization_example,
|
|
347
|
+
// string (optional)
|
|
334
348
|
ksUat: ksUat_example,
|
|
335
349
|
} satisfies SendUserMessageRequest;
|
|
336
350
|
|
|
@@ -353,6 +367,7 @@ example().catch(console.error);
|
|
|
353
367
|
|------------- | ------------- | ------------- | -------------|
|
|
354
368
|
| **threadId** | `string` | | [Defaults to `undefined`] |
|
|
355
369
|
| **userMessageRequest** | [UserMessageRequest](UserMessageRequest.md) | | |
|
|
370
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
356
371
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
357
372
|
|
|
358
373
|
### Return type
|
|
@@ -380,7 +395,7 @@ No authorization required
|
|
|
380
395
|
|
|
381
396
|
## streamThread
|
|
382
397
|
|
|
383
|
-
> streamThread(threadId, lastMessageId, lastEntryId, ksUat)
|
|
398
|
+
> streamThread(threadId, lastMessageId, lastEntryId, authorization, ksUat)
|
|
384
399
|
|
|
385
400
|
Stream Thread Handler
|
|
386
401
|
|
|
@@ -407,6 +422,8 @@ async function example() {
|
|
|
407
422
|
// string (optional)
|
|
408
423
|
lastEntryId: lastEntryId_example,
|
|
409
424
|
// string (optional)
|
|
425
|
+
authorization: authorization_example,
|
|
426
|
+
// string (optional)
|
|
410
427
|
ksUat: ksUat_example,
|
|
411
428
|
} satisfies StreamThreadRequest;
|
|
412
429
|
|
|
@@ -430,6 +447,7 @@ example().catch(console.error);
|
|
|
430
447
|
| **threadId** | `string` | | [Defaults to `undefined`] |
|
|
431
448
|
| **lastMessageId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
432
449
|
| **lastEntryId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
450
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
433
451
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
434
452
|
|
|
435
453
|
### Return type
|
|
@@ -457,7 +475,7 @@ No authorization required
|
|
|
457
475
|
|
|
458
476
|
## updateThread
|
|
459
477
|
|
|
460
|
-
> ThreadResponse updateThread(threadId, updateThreadRequest, ksUat)
|
|
478
|
+
> ThreadResponse updateThread(threadId, updateThreadRequest, authorization, ksUat)
|
|
461
479
|
|
|
462
480
|
Update Thread Handler
|
|
463
481
|
|
|
@@ -482,6 +500,8 @@ async function example() {
|
|
|
482
500
|
// UpdateThreadRequest
|
|
483
501
|
updateThreadRequest: ...,
|
|
484
502
|
// string (optional)
|
|
503
|
+
authorization: authorization_example,
|
|
504
|
+
// string (optional)
|
|
485
505
|
ksUat: ksUat_example,
|
|
486
506
|
} satisfies UpdateThreadOperationRequest;
|
|
487
507
|
|
|
@@ -504,6 +524,7 @@ example().catch(console.error);
|
|
|
504
524
|
|------------- | ------------- | ------------- | -------------|
|
|
505
525
|
| **threadId** | `string` | | [Defaults to `undefined`] |
|
|
506
526
|
| **updateThreadRequest** | [UpdateThreadRequest](UpdateThreadRequest.md) | | |
|
|
527
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
507
528
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
508
529
|
|
|
509
530
|
### Return type
|
|
@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
13
13
|
|
|
14
14
|
## createUserPermission
|
|
15
15
|
|
|
16
|
-
> PermissionResponse createUserPermission(createPermissionRequest, ksUat)
|
|
16
|
+
> PermissionResponse createUserPermission(createPermissionRequest, authorization, ksUat)
|
|
17
17
|
|
|
18
18
|
Create User Permission Handler
|
|
19
19
|
|
|
@@ -36,6 +36,8 @@ async function example() {
|
|
|
36
36
|
// CreatePermissionRequest
|
|
37
37
|
createPermissionRequest: ...,
|
|
38
38
|
// string (optional)
|
|
39
|
+
authorization: authorization_example,
|
|
40
|
+
// string (optional)
|
|
39
41
|
ksUat: ksUat_example,
|
|
40
42
|
} satisfies CreateUserPermissionRequest;
|
|
41
43
|
|
|
@@ -57,6 +59,7 @@ example().catch(console.error);
|
|
|
57
59
|
| Name | Type | Description | Notes |
|
|
58
60
|
|------------- | ------------- | ------------- | -------------|
|
|
59
61
|
| **createPermissionRequest** | [CreatePermissionRequest](CreatePermissionRequest.md) | | |
|
|
62
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
60
63
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
61
64
|
|
|
62
65
|
### Return type
|
|
@@ -84,7 +87,7 @@ No authorization required
|
|
|
84
87
|
|
|
85
88
|
## deleteUserPermission
|
|
86
89
|
|
|
87
|
-
> deleteUserPermission(permissionId, tenantId, ksUat)
|
|
90
|
+
> deleteUserPermission(permissionId, tenantId, authorization, ksUat)
|
|
88
91
|
|
|
89
92
|
Delete User Permission Handler
|
|
90
93
|
|
|
@@ -109,6 +112,8 @@ async function example() {
|
|
|
109
112
|
// string | Tenant ID the permission belongs to
|
|
110
113
|
tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
111
114
|
// string (optional)
|
|
115
|
+
authorization: authorization_example,
|
|
116
|
+
// string (optional)
|
|
112
117
|
ksUat: ksUat_example,
|
|
113
118
|
} satisfies DeleteUserPermissionRequest;
|
|
114
119
|
|
|
@@ -131,6 +136,7 @@ example().catch(console.error);
|
|
|
131
136
|
|------------- | ------------- | ------------- | -------------|
|
|
132
137
|
| **permissionId** | `string` | | [Defaults to `undefined`] |
|
|
133
138
|
| **tenantId** | `string` | Tenant ID the permission belongs to | [Defaults to `undefined`] |
|
|
139
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
134
140
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
135
141
|
|
|
136
142
|
### Return type
|
|
@@ -158,7 +164,7 @@ No authorization required
|
|
|
158
164
|
|
|
159
165
|
## listUserPermissions
|
|
160
166
|
|
|
161
|
-
> PaginatedResponsePermissionResponse listUserPermissions(tenantId, userId, limit, offset, ksUat)
|
|
167
|
+
> PaginatedResponsePermissionResponse listUserPermissions(tenantId, userId, limit, offset, authorization, ksUat)
|
|
162
168
|
|
|
163
169
|
List User Permissions Handler
|
|
164
170
|
|
|
@@ -187,6 +193,8 @@ async function example() {
|
|
|
187
193
|
// number | Number of items to skip (optional)
|
|
188
194
|
offset: 56,
|
|
189
195
|
// string (optional)
|
|
196
|
+
authorization: authorization_example,
|
|
197
|
+
// string (optional)
|
|
190
198
|
ksUat: ksUat_example,
|
|
191
199
|
} satisfies ListUserPermissionsRequest;
|
|
192
200
|
|
|
@@ -211,6 +219,7 @@ example().catch(console.error);
|
|
|
211
219
|
| **userId** | `string` | User ID to list permissions for | [Defaults to `undefined`] |
|
|
212
220
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
213
221
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
222
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
214
223
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
215
224
|
|
|
216
225
|
### Return type
|
|
@@ -238,7 +247,7 @@ No authorization required
|
|
|
238
247
|
|
|
239
248
|
## updateUserPermission
|
|
240
249
|
|
|
241
|
-
> PermissionResponse updateUserPermission(permissionId, tenantId, updatePermissionRequest, ksUat)
|
|
250
|
+
> PermissionResponse updateUserPermission(permissionId, tenantId, updatePermissionRequest, authorization, ksUat)
|
|
242
251
|
|
|
243
252
|
Update User Permission Handler
|
|
244
253
|
|
|
@@ -265,6 +274,8 @@ async function example() {
|
|
|
265
274
|
// UpdatePermissionRequest
|
|
266
275
|
updatePermissionRequest: ...,
|
|
267
276
|
// string (optional)
|
|
277
|
+
authorization: authorization_example,
|
|
278
|
+
// string (optional)
|
|
268
279
|
ksUat: ksUat_example,
|
|
269
280
|
} satisfies UpdateUserPermissionRequest;
|
|
270
281
|
|
|
@@ -288,6 +299,7 @@ example().catch(console.error);
|
|
|
288
299
|
| **permissionId** | `string` | | [Defaults to `undefined`] |
|
|
289
300
|
| **tenantId** | `string` | Tenant ID the permission belongs to | [Defaults to `undefined`] |
|
|
290
301
|
| **updatePermissionRequest** | [UpdatePermissionRequest](UpdatePermissionRequest.md) | | |
|
|
302
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
291
303
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
292
304
|
|
|
293
305
|
### Return type
|
package/docs/UsersApi.md
CHANGED
|
@@ -11,7 +11,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
11
11
|
|
|
12
12
|
## getMe
|
|
13
13
|
|
|
14
|
-
> UserResponse getMe(ksUat)
|
|
14
|
+
> UserResponse getMe(authorization, ksUat)
|
|
15
15
|
|
|
16
16
|
Get Me Handler
|
|
17
17
|
|
|
@@ -31,6 +31,8 @@ async function example() {
|
|
|
31
31
|
const api = new UsersApi();
|
|
32
32
|
|
|
33
33
|
const body = {
|
|
34
|
+
// string (optional)
|
|
35
|
+
authorization: authorization_example,
|
|
34
36
|
// string (optional)
|
|
35
37
|
ksUat: ksUat_example,
|
|
36
38
|
} satisfies GetMeRequest;
|
|
@@ -52,6 +54,7 @@ example().catch(console.error);
|
|
|
52
54
|
|
|
53
55
|
| Name | Type | Description | Notes |
|
|
54
56
|
|------------- | ------------- | ------------- | -------------|
|
|
57
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
55
58
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
56
59
|
|
|
57
60
|
### Return type
|
|
@@ -79,7 +82,7 @@ No authorization required
|
|
|
79
82
|
|
|
80
83
|
## updateMe
|
|
81
84
|
|
|
82
|
-
> UserResponse updateMe(updateUserRequest, ksUat)
|
|
85
|
+
> UserResponse updateMe(updateUserRequest, authorization, ksUat)
|
|
83
86
|
|
|
84
87
|
Update Me Handler
|
|
85
88
|
|
|
@@ -102,6 +105,8 @@ async function example() {
|
|
|
102
105
|
// UpdateUserRequest
|
|
103
106
|
updateUserRequest: ...,
|
|
104
107
|
// string (optional)
|
|
108
|
+
authorization: authorization_example,
|
|
109
|
+
// string (optional)
|
|
105
110
|
ksUat: ksUat_example,
|
|
106
111
|
} satisfies UpdateMeRequest;
|
|
107
112
|
|
|
@@ -123,6 +128,7 @@ example().catch(console.error);
|
|
|
123
128
|
| Name | Type | Description | Notes |
|
|
124
129
|
|------------- | ------------- | ------------- | -------------|
|
|
125
130
|
| **updateUserRequest** | [UpdateUserRequest](UpdateUserRequest.md) | | |
|
|
131
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
126
132
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
127
133
|
|
|
128
134
|
### Return type
|
package/docs/WorkflowsApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
12
12
|
|
|
13
13
|
## getWorkflow
|
|
14
14
|
|
|
15
|
-
> WorkflowDetailResponse getWorkflow(workflowId, ksUat)
|
|
15
|
+
> WorkflowDetailResponse getWorkflow(workflowId, authorization, ksUat)
|
|
16
16
|
|
|
17
17
|
Get Workflow Handler
|
|
18
18
|
|
|
@@ -35,6 +35,8 @@ async function example() {
|
|
|
35
35
|
// string
|
|
36
36
|
workflowId: workflowId_example,
|
|
37
37
|
// string (optional)
|
|
38
|
+
authorization: authorization_example,
|
|
39
|
+
// string (optional)
|
|
38
40
|
ksUat: ksUat_example,
|
|
39
41
|
} satisfies GetWorkflowRequest;
|
|
40
42
|
|
|
@@ -56,6 +58,7 @@ example().catch(console.error);
|
|
|
56
58
|
| Name | Type | Description | Notes |
|
|
57
59
|
|------------- | ------------- | ------------- | -------------|
|
|
58
60
|
| **workflowId** | `string` | | [Defaults to `undefined`] |
|
|
61
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
59
62
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
60
63
|
|
|
61
64
|
### Return type
|
|
@@ -83,7 +86,7 @@ No authorization required
|
|
|
83
86
|
|
|
84
87
|
## listWorkflows
|
|
85
88
|
|
|
86
|
-
> PaginatedResponseWorkflowSummaryResponse listWorkflows(limit, offset, ksUat)
|
|
89
|
+
> PaginatedResponseWorkflowSummaryResponse listWorkflows(limit, offset, authorization, ksUat)
|
|
87
90
|
|
|
88
91
|
List Workflows Handler
|
|
89
92
|
|
|
@@ -108,6 +111,8 @@ async function example() {
|
|
|
108
111
|
// number | Number of items to skip (optional)
|
|
109
112
|
offset: 56,
|
|
110
113
|
// string (optional)
|
|
114
|
+
authorization: authorization_example,
|
|
115
|
+
// string (optional)
|
|
111
116
|
ksUat: ksUat_example,
|
|
112
117
|
} satisfies ListWorkflowsRequest;
|
|
113
118
|
|
|
@@ -130,6 +135,7 @@ example().catch(console.error);
|
|
|
130
135
|
|------------- | ------------- | ------------- | -------------|
|
|
131
136
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
132
137
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
138
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
133
139
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
134
140
|
|
|
135
141
|
### Return type
|
|
@@ -157,7 +163,7 @@ No authorization required
|
|
|
157
163
|
|
|
158
164
|
## workflowAction
|
|
159
165
|
|
|
160
|
-
> WorkflowActionResponse workflowAction(workflowId, action, ksUat)
|
|
166
|
+
> WorkflowActionResponse workflowAction(workflowId, action, authorization, ksUat)
|
|
161
167
|
|
|
162
168
|
Workflow Action Handler
|
|
163
169
|
|
|
@@ -182,6 +188,8 @@ async function example() {
|
|
|
182
188
|
// WorkflowAction | Action to perform
|
|
183
189
|
action: ...,
|
|
184
190
|
// string (optional)
|
|
191
|
+
authorization: authorization_example,
|
|
192
|
+
// string (optional)
|
|
185
193
|
ksUat: ksUat_example,
|
|
186
194
|
} satisfies WorkflowActionRequest;
|
|
187
195
|
|
|
@@ -204,6 +212,7 @@ example().catch(console.error);
|
|
|
204
212
|
|------------- | ------------- | ------------- | -------------|
|
|
205
213
|
| **workflowId** | `string` | | [Defaults to `undefined`] |
|
|
206
214
|
| **action** | `WorkflowAction` | Action to perform | [Defaults to `undefined`] [Enum: rerun, cancel] |
|
|
215
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
207
216
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
208
217
|
|
|
209
218
|
### Return type
|