@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.
Files changed (133) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +18 -9
  3. package/dist/apis/ApiKeysApi.d.ts +187 -0
  4. package/dist/apis/ApiKeysApi.js +193 -0
  5. package/dist/apis/AuthApi.d.ts +6 -0
  6. package/dist/apis/AuthApi.js +6 -0
  7. package/dist/apis/ChunkLineagesApi.d.ts +9 -0
  8. package/dist/apis/ChunkLineagesApi.js +9 -0
  9. package/dist/apis/ChunksApi.d.ts +24 -0
  10. package/dist/apis/ChunksApi.js +24 -0
  11. package/dist/apis/DocumentVersionsApi.d.ts +21 -0
  12. package/dist/apis/DocumentVersionsApi.js +21 -0
  13. package/dist/apis/DocumentsApi.d.ts +21 -0
  14. package/dist/apis/DocumentsApi.js +21 -0
  15. package/dist/apis/FoldersApi.d.ts +21 -0
  16. package/dist/apis/FoldersApi.js +21 -0
  17. package/dist/apis/InvitesApi.d.ts +12 -0
  18. package/dist/apis/InvitesApi.js +12 -0
  19. package/dist/apis/PathPartsApi.d.ts +18 -0
  20. package/dist/apis/PathPartsApi.js +18 -0
  21. package/dist/apis/SectionsApi.d.ts +12 -0
  22. package/dist/apis/SectionsApi.js +12 -0
  23. package/dist/apis/TagsApi.d.ts +15 -0
  24. package/dist/apis/TagsApi.js +15 -0
  25. package/dist/apis/TenantsApi.d.ts +24 -0
  26. package/dist/apis/TenantsApi.js +24 -0
  27. package/dist/apis/ThreadMessagesApi.d.ts +9 -0
  28. package/dist/apis/ThreadMessagesApi.js +9 -0
  29. package/dist/apis/ThreadsApi.d.ts +21 -0
  30. package/dist/apis/ThreadsApi.js +21 -0
  31. package/dist/apis/UserPermissionsApi.d.ts +12 -0
  32. package/dist/apis/UserPermissionsApi.js +12 -0
  33. package/dist/apis/UsersApi.d.ts +6 -0
  34. package/dist/apis/UsersApi.js +6 -0
  35. package/dist/apis/WorkflowsApi.d.ts +9 -0
  36. package/dist/apis/WorkflowsApi.js +9 -0
  37. package/dist/apis/index.d.ts +1 -0
  38. package/dist/apis/index.js +1 -0
  39. package/dist/esm/apis/ApiKeysApi.d.ts +187 -0
  40. package/dist/esm/apis/ApiKeysApi.js +189 -0
  41. package/dist/esm/apis/AuthApi.d.ts +6 -0
  42. package/dist/esm/apis/AuthApi.js +6 -0
  43. package/dist/esm/apis/ChunkLineagesApi.d.ts +9 -0
  44. package/dist/esm/apis/ChunkLineagesApi.js +9 -0
  45. package/dist/esm/apis/ChunksApi.d.ts +24 -0
  46. package/dist/esm/apis/ChunksApi.js +24 -0
  47. package/dist/esm/apis/DocumentVersionsApi.d.ts +21 -0
  48. package/dist/esm/apis/DocumentVersionsApi.js +21 -0
  49. package/dist/esm/apis/DocumentsApi.d.ts +21 -0
  50. package/dist/esm/apis/DocumentsApi.js +21 -0
  51. package/dist/esm/apis/FoldersApi.d.ts +21 -0
  52. package/dist/esm/apis/FoldersApi.js +21 -0
  53. package/dist/esm/apis/InvitesApi.d.ts +12 -0
  54. package/dist/esm/apis/InvitesApi.js +12 -0
  55. package/dist/esm/apis/PathPartsApi.d.ts +18 -0
  56. package/dist/esm/apis/PathPartsApi.js +18 -0
  57. package/dist/esm/apis/SectionsApi.d.ts +12 -0
  58. package/dist/esm/apis/SectionsApi.js +12 -0
  59. package/dist/esm/apis/TagsApi.d.ts +15 -0
  60. package/dist/esm/apis/TagsApi.js +15 -0
  61. package/dist/esm/apis/TenantsApi.d.ts +24 -0
  62. package/dist/esm/apis/TenantsApi.js +24 -0
  63. package/dist/esm/apis/ThreadMessagesApi.d.ts +9 -0
  64. package/dist/esm/apis/ThreadMessagesApi.js +9 -0
  65. package/dist/esm/apis/ThreadsApi.d.ts +21 -0
  66. package/dist/esm/apis/ThreadsApi.js +21 -0
  67. package/dist/esm/apis/UserPermissionsApi.d.ts +12 -0
  68. package/dist/esm/apis/UserPermissionsApi.js +12 -0
  69. package/dist/esm/apis/UsersApi.d.ts +6 -0
  70. package/dist/esm/apis/UsersApi.js +6 -0
  71. package/dist/esm/apis/WorkflowsApi.d.ts +9 -0
  72. package/dist/esm/apis/WorkflowsApi.js +9 -0
  73. package/dist/esm/apis/index.d.ts +1 -0
  74. package/dist/esm/apis/index.js +1 -0
  75. package/dist/esm/models/ApiKeyResponse.d.ts +65 -0
  76. package/dist/esm/models/ApiKeyResponse.js +56 -0
  77. package/dist/esm/models/CreateApiKeyRequest.d.ts +47 -0
  78. package/dist/esm/models/CreateApiKeyRequest.js +49 -0
  79. package/dist/esm/models/CreateApiKeyResponse.d.ts +71 -0
  80. package/dist/esm/models/CreateApiKeyResponse.js +60 -0
  81. package/dist/esm/models/index.d.ts +3 -0
  82. package/dist/esm/models/index.js +3 -0
  83. package/dist/models/ApiKeyResponse.d.ts +65 -0
  84. package/dist/models/ApiKeyResponse.js +64 -0
  85. package/dist/models/CreateApiKeyRequest.d.ts +47 -0
  86. package/dist/models/CreateApiKeyRequest.js +57 -0
  87. package/dist/models/CreateApiKeyResponse.d.ts +71 -0
  88. package/dist/models/CreateApiKeyResponse.js +68 -0
  89. package/dist/models/index.d.ts +3 -0
  90. package/dist/models/index.js +3 -0
  91. package/docs/ApiKeyResponse.md +41 -0
  92. package/docs/ApiKeysApi.md +293 -0
  93. package/docs/AuthApi.md +8 -2
  94. package/docs/ChunkLineagesApi.md +12 -3
  95. package/docs/ChunksApi.md +32 -8
  96. package/docs/CreateApiKeyRequest.md +35 -0
  97. package/docs/CreateApiKeyResponse.md +43 -0
  98. package/docs/DocumentVersionsApi.md +28 -7
  99. package/docs/DocumentsApi.md +28 -7
  100. package/docs/FoldersApi.md +28 -7
  101. package/docs/InvitesApi.md +16 -4
  102. package/docs/PathPartsApi.md +24 -6
  103. package/docs/SectionsApi.md +16 -4
  104. package/docs/TagsApi.md +20 -5
  105. package/docs/TenantsApi.md +32 -8
  106. package/docs/ThreadMessagesApi.md +12 -3
  107. package/docs/ThreadsApi.md +28 -7
  108. package/docs/UserPermissionsApi.md +16 -4
  109. package/docs/UsersApi.md +8 -2
  110. package/docs/WorkflowsApi.md +12 -3
  111. package/package.json +1 -1
  112. package/src/apis/ApiKeysApi.ts +350 -0
  113. package/src/apis/AuthApi.ts +14 -0
  114. package/src/apis/ChunkLineagesApi.ts +21 -0
  115. package/src/apis/ChunksApi.ts +56 -0
  116. package/src/apis/DocumentVersionsApi.ts +49 -0
  117. package/src/apis/DocumentsApi.ts +49 -0
  118. package/src/apis/FoldersApi.ts +49 -0
  119. package/src/apis/InvitesApi.ts +28 -0
  120. package/src/apis/PathPartsApi.ts +42 -0
  121. package/src/apis/SectionsApi.ts +28 -0
  122. package/src/apis/TagsApi.ts +35 -0
  123. package/src/apis/TenantsApi.ts +56 -0
  124. package/src/apis/ThreadMessagesApi.ts +21 -0
  125. package/src/apis/ThreadsApi.ts +49 -0
  126. package/src/apis/UserPermissionsApi.ts +28 -0
  127. package/src/apis/UsersApi.ts +14 -0
  128. package/src/apis/WorkflowsApi.ts +21 -0
  129. package/src/apis/index.ts +1 -0
  130. package/src/models/ApiKeyResponse.ts +110 -0
  131. package/src/models/CreateApiKeyRequest.ts +87 -0
  132. package/src/models/CreateApiKeyResponse.ts +119 -0
  133. package/src/models/index.ts +3 -0
@@ -0,0 +1,43 @@
1
+
2
+ # CreateApiKeyResponse
3
+
4
+ Response after creating an API key. Contains the full key (shown once).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `id` | string
11
+ `name` | string
12
+ `key` | string
13
+ `keySuffix` | string
14
+ `createdAt` | Date
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { CreateApiKeyResponse } from '@knowledge-stack/ksapi'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "id": null,
24
+ "name": null,
25
+ "key": null,
26
+ "keySuffix": null,
27
+ "createdAt": null,
28
+ } satisfies CreateApiKeyResponse
29
+
30
+ console.log(example)
31
+
32
+ // Convert the instance to a JSON string
33
+ const exampleJSON: string = JSON.stringify(example)
34
+ console.log(exampleJSON)
35
+
36
+ // Parse the JSON string back to an object
37
+ const exampleParsed = JSON.parse(exampleJSON) as CreateApiKeyResponse
38
+ console.log(exampleParsed)
39
+ ```
40
+
41
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
42
+
43
+
@@ -16,7 +16,7 @@ All URIs are relative to *http://localhost:8000*
16
16
 
17
17
  ## clearDocumentVersionContents
18
18
 
19
- > ClearVersionContentsResponse clearDocumentVersionContents(versionId, ksUat)
19
+ > ClearVersionContentsResponse clearDocumentVersionContents(versionId, authorization, ksUat)
20
20
 
21
21
  Clear Document Version Contents Handler
22
22
 
@@ -39,6 +39,8 @@ async function example() {
39
39
  // string | DocumentVersion ID
40
40
  versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
41
41
  // string (optional)
42
+ authorization: authorization_example,
43
+ // string (optional)
42
44
  ksUat: ksUat_example,
43
45
  } satisfies ClearDocumentVersionContentsRequest;
44
46
 
@@ -60,6 +62,7 @@ example().catch(console.error);
60
62
  | Name | Type | Description | Notes |
61
63
  |------------- | ------------- | ------------- | -------------|
62
64
  | **versionId** | `string` | DocumentVersion ID | [Defaults to `undefined`] |
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
  ## createDocumentVersion
89
92
 
90
- > DocumentVersionResponse createDocumentVersion(documentId, ksUat)
93
+ > DocumentVersionResponse createDocumentVersion(documentId, authorization, ksUat)
91
94
 
92
95
  Create Document Version Handler
93
96
 
@@ -110,6 +113,8 @@ async function example() {
110
113
  // string | Document ID
111
114
  documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
112
115
  // string (optional)
116
+ authorization: authorization_example,
117
+ // string (optional)
113
118
  ksUat: ksUat_example,
114
119
  } satisfies CreateDocumentVersionRequest;
115
120
 
@@ -131,6 +136,7 @@ example().catch(console.error);
131
136
  | Name | Type | Description | Notes |
132
137
  |------------- | ------------- | ------------- | -------------|
133
138
  | **documentId** | `string` | Document ID | [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
  ## deleteDocumentVersion
160
166
 
161
- > deleteDocumentVersion(versionId, ksUat)
167
+ > deleteDocumentVersion(versionId, authorization, ksUat)
162
168
 
163
169
  Delete Document Version Handler
164
170
 
@@ -181,6 +187,8 @@ async function example() {
181
187
  // string | DocumentVersion ID
182
188
  versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
183
189
  // string (optional)
190
+ authorization: authorization_example,
191
+ // string (optional)
184
192
  ksUat: ksUat_example,
185
193
  } satisfies DeleteDocumentVersionRequest;
186
194
 
@@ -202,6 +210,7 @@ example().catch(console.error);
202
210
  | Name | Type | Description | Notes |
203
211
  |------------- | ------------- | ------------- | -------------|
204
212
  | **versionId** | `string` | DocumentVersion ID | [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
  ## getDocumentVersion
231
240
 
232
- > DocumentVersionResponse getDocumentVersion(versionId, ksUat)
241
+ > DocumentVersionResponse getDocumentVersion(versionId, authorization, ksUat)
233
242
 
234
243
  Get Document Version Handler
235
244
 
@@ -252,6 +261,8 @@ async function example() {
252
261
  // string | DocumentVersion ID
253
262
  versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
254
263
  // string (optional)
264
+ authorization: authorization_example,
265
+ // string (optional)
255
266
  ksUat: ksUat_example,
256
267
  } satisfies GetDocumentVersionRequest;
257
268
 
@@ -273,6 +284,7 @@ example().catch(console.error);
273
284
  | Name | Type | Description | Notes |
274
285
  |------------- | ------------- | ------------- | -------------|
275
286
  | **versionId** | `string` | DocumentVersion ID | [Defaults to `undefined`] |
287
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
276
288
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
277
289
 
278
290
  ### Return type
@@ -300,7 +312,7 @@ No authorization required
300
312
 
301
313
  ## getDocumentVersionContents
302
314
 
303
- > PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator getDocumentVersionContents(versionId, sectionId, limit, offset, ksUat)
315
+ > PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator getDocumentVersionContents(versionId, sectionId, limit, offset, authorization, ksUat)
304
316
 
305
317
  Get Document Version Contents Handler
306
318
 
@@ -329,6 +341,8 @@ async function example() {
329
341
  // number | Number of items to skip (optional)
330
342
  offset: 56,
331
343
  // string (optional)
344
+ authorization: authorization_example,
345
+ // string (optional)
332
346
  ksUat: ksUat_example,
333
347
  } satisfies GetDocumentVersionContentsRequest;
334
348
 
@@ -353,6 +367,7 @@ example().catch(console.error);
353
367
  | **sectionId** | `string` | Optional section ID to scope traversal to a subtree | [Optional] [Defaults to `undefined`] |
354
368
  | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
355
369
  | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
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
  ## listDocumentVersions
382
397
 
383
- > PaginatedResponseDocumentVersionResponse listDocumentVersions(documentId, limit, offset, ksUat)
398
+ > PaginatedResponseDocumentVersionResponse listDocumentVersions(documentId, limit, offset, authorization, ksUat)
384
399
 
385
400
  List Document Versions Handler
386
401
 
@@ -407,6 +422,8 @@ async function example() {
407
422
  // number | Number of items to skip (optional)
408
423
  offset: 56,
409
424
  // string (optional)
425
+ authorization: authorization_example,
426
+ // string (optional)
410
427
  ksUat: ksUat_example,
411
428
  } satisfies ListDocumentVersionsRequest;
412
429
 
@@ -430,6 +447,7 @@ example().catch(console.error);
430
447
  | **documentId** | `string` | Document ID to list versions for | [Defaults to `undefined`] |
431
448
  | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
432
449
  | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
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
  ## updateDocumentVersionMetadata
459
477
 
460
- > DocumentVersionResponse updateDocumentVersionMetadata(versionId, documentVersionMetadataUpdate, ksUat)
478
+ > DocumentVersionResponse updateDocumentVersionMetadata(versionId, documentVersionMetadataUpdate, authorization, ksUat)
461
479
 
462
480
  Update Document Version Metadata Handler
463
481
 
@@ -482,6 +500,8 @@ async function example() {
482
500
  // DocumentVersionMetadataUpdate
483
501
  documentVersionMetadataUpdate: ...,
484
502
  // string (optional)
503
+ authorization: authorization_example,
504
+ // string (optional)
485
505
  ksUat: ksUat_example,
486
506
  } satisfies UpdateDocumentVersionMetadataRequest;
487
507
 
@@ -504,6 +524,7 @@ example().catch(console.error);
504
524
  |------------- | ------------- | ------------- | -------------|
505
525
  | **versionId** | `string` | DocumentVersion ID | [Defaults to `undefined`] |
506
526
  | **documentVersionMetadataUpdate** | [DocumentVersionMetadataUpdate](DocumentVersionMetadataUpdate.md) | | |
527
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
507
528
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
508
529
 
509
530
  ### Return type
@@ -16,7 +16,7 @@ All URIs are relative to *http://localhost:8000*
16
16
 
17
17
  ## createDocument
18
18
 
19
- > DocumentResponse createDocument(createDocumentRequest, ksUat)
19
+ > DocumentResponse createDocument(createDocumentRequest, authorization, ksUat)
20
20
 
21
21
  Create Document Handler
22
22
 
@@ -39,6 +39,8 @@ async function example() {
39
39
  // CreateDocumentRequest
40
40
  createDocumentRequest: ...,
41
41
  // string (optional)
42
+ authorization: authorization_example,
43
+ // string (optional)
42
44
  ksUat: ksUat_example,
43
45
  } satisfies CreateDocumentOperationRequest;
44
46
 
@@ -60,6 +62,7 @@ example().catch(console.error);
60
62
  | Name | Type | Description | Notes |
61
63
  |------------- | ------------- | ------------- | -------------|
62
64
  | **createDocumentRequest** | [CreateDocumentRequest](CreateDocumentRequest.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
  ## deleteDocument
89
92
 
90
- > deleteDocument(documentId, ksUat)
93
+ > deleteDocument(documentId, authorization, ksUat)
91
94
 
92
95
  Delete Document Handler
93
96
 
@@ -110,6 +113,8 @@ async function example() {
110
113
  // string
111
114
  documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
112
115
  // string (optional)
116
+ authorization: authorization_example,
117
+ // string (optional)
113
118
  ksUat: ksUat_example,
114
119
  } satisfies DeleteDocumentRequest;
115
120
 
@@ -131,6 +136,7 @@ example().catch(console.error);
131
136
  | Name | Type | Description | Notes |
132
137
  |------------- | ------------- | ------------- | -------------|
133
138
  | **documentId** | `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
  ## getDocument
160
166
 
161
- > DocumentResponse getDocument(documentId, withTags, ksUat)
167
+ > DocumentResponse getDocument(documentId, withTags, authorization, ksUat)
162
168
 
163
169
  Get Document Handler
164
170
 
@@ -183,6 +189,8 @@ async function example() {
183
189
  // boolean | Include tags in the response (default: false) (optional)
184
190
  withTags: true,
185
191
  // string (optional)
192
+ authorization: authorization_example,
193
+ // string (optional)
186
194
  ksUat: ksUat_example,
187
195
  } satisfies GetDocumentRequest;
188
196
 
@@ -205,6 +213,7 @@ example().catch(console.error);
205
213
  |------------- | ------------- | ------------- | -------------|
206
214
  | **documentId** | `string` | | [Defaults to `undefined`] |
207
215
  | **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
216
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
208
217
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
209
218
 
210
219
  ### Return type
@@ -232,7 +241,7 @@ No authorization required
232
241
 
233
242
  ## ingestDocument
234
243
 
235
- > IngestDocumentResponse ingestDocument(file, pathPartId, ksUat, name, ingestionMode, chunkType, pageDpi)
244
+ > IngestDocumentResponse ingestDocument(file, pathPartId, authorization, ksUat, name, ingestionMode, chunkType, pageDpi)
236
245
 
237
246
  Ingest Document Handler
238
247
 
@@ -257,6 +266,8 @@ async function example() {
257
266
  // string | Parent path part ID (must be a FOLDER type)
258
267
  pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
259
268
  // string (optional)
269
+ authorization: authorization_example,
270
+ // string (optional)
260
271
  ksUat: ksUat_example,
261
272
  // string | Document name (defaults to filename) (optional)
262
273
  name: name_example,
@@ -287,6 +298,7 @@ example().catch(console.error);
287
298
  |------------- | ------------- | ------------- | -------------|
288
299
  | **file** | `Blob` | | [Defaults to `undefined`] |
289
300
  | **pathPartId** | `string` | Parent path part ID (must be a FOLDER type) | [Defaults to `undefined`] |
301
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
290
302
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
291
303
  | **name** | `string` | Document name (defaults to filename) | [Optional] [Defaults to `undefined`] |
292
304
  | **ingestionMode** | `IngestionMode` | | [Optional] [Defaults to `undefined`] [Enum: document, single_chunk] |
@@ -318,7 +330,7 @@ No authorization required
318
330
 
319
331
  ## ingestDocumentVersion
320
332
 
321
- > IngestDocumentResponse ingestDocumentVersion(documentId, file, ksUat, ingestionMode, chunkType, pageDpi)
333
+ > IngestDocumentResponse ingestDocumentVersion(documentId, file, authorization, ksUat, ingestionMode, chunkType, pageDpi)
322
334
 
323
335
  Ingest Document Version Handler
324
336
 
@@ -343,6 +355,8 @@ async function example() {
343
355
  // Blob
344
356
  file: BINARY_DATA_HERE,
345
357
  // string (optional)
358
+ authorization: authorization_example,
359
+ // string (optional)
346
360
  ksUat: ksUat_example,
347
361
  // IngestionMode (optional)
348
362
  ingestionMode: ...,
@@ -371,6 +385,7 @@ example().catch(console.error);
371
385
  |------------- | ------------- | ------------- | -------------|
372
386
  | **documentId** | `string` | Document ID | [Defaults to `undefined`] |
373
387
  | **file** | `Blob` | | [Defaults to `undefined`] |
388
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
374
389
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
375
390
  | **ingestionMode** | `IngestionMode` | | [Optional] [Defaults to `undefined`] [Enum: document, single_chunk] |
376
391
  | **chunkType** | `ChunkType` | | [Optional] [Defaults to `undefined`] [Enum: TEXT, TABLE, IMAGE, UNKNOWN] |
@@ -401,7 +416,7 @@ No authorization required
401
416
 
402
417
  ## listDocuments
403
418
 
404
- > PaginatedResponseDocumentResponse listDocuments(parentPathPartId, sortOrder, withTags, limit, offset, ksUat)
419
+ > PaginatedResponseDocumentResponse listDocuments(parentPathPartId, sortOrder, withTags, limit, offset, authorization, ksUat)
405
420
 
406
421
  List Documents Handler
407
422
 
@@ -432,6 +447,8 @@ async function example() {
432
447
  // number | Number of items to skip (optional)
433
448
  offset: 56,
434
449
  // string (optional)
450
+ authorization: authorization_example,
451
+ // string (optional)
435
452
  ksUat: ksUat_example,
436
453
  } satisfies ListDocumentsRequest;
437
454
 
@@ -457,6 +474,7 @@ example().catch(console.error);
457
474
  | **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
458
475
  | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
459
476
  | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
477
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
460
478
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
461
479
 
462
480
  ### Return type
@@ -484,7 +502,7 @@ No authorization required
484
502
 
485
503
  ## updateDocument
486
504
 
487
- > DocumentResponse updateDocument(documentId, updateDocumentRequest, ksUat)
505
+ > DocumentResponse updateDocument(documentId, updateDocumentRequest, authorization, ksUat)
488
506
 
489
507
  Update Document Handler
490
508
 
@@ -509,6 +527,8 @@ async function example() {
509
527
  // UpdateDocumentRequest
510
528
  updateDocumentRequest: ...,
511
529
  // string (optional)
530
+ authorization: authorization_example,
531
+ // string (optional)
512
532
  ksUat: ksUat_example,
513
533
  } satisfies UpdateDocumentOperationRequest;
514
534
 
@@ -531,6 +551,7 @@ example().catch(console.error);
531
551
  |------------- | ------------- | ------------- | -------------|
532
552
  | **documentId** | `string` | | [Defaults to `undefined`] |
533
553
  | **updateDocumentRequest** | [UpdateDocumentRequest](UpdateDocumentRequest.md) | | |
554
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
534
555
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
535
556
 
536
557
  ### Return type
@@ -16,7 +16,7 @@ All URIs are relative to *http://localhost:8000*
16
16
 
17
17
  ## createFolder
18
18
 
19
- > FolderResponse createFolder(createFolderRequest, ksUat)
19
+ > FolderResponse createFolder(createFolderRequest, authorization, ksUat)
20
20
 
21
21
  Create Folder Handler
22
22
 
@@ -39,6 +39,8 @@ async function example() {
39
39
  // CreateFolderRequest
40
40
  createFolderRequest: ...,
41
41
  // string (optional)
42
+ authorization: authorization_example,
43
+ // string (optional)
42
44
  ksUat: ksUat_example,
43
45
  } satisfies CreateFolderOperationRequest;
44
46
 
@@ -60,6 +62,7 @@ example().catch(console.error);
60
62
  | Name | Type | Description | Notes |
61
63
  |------------- | ------------- | ------------- | -------------|
62
64
  | **createFolderRequest** | [CreateFolderRequest](CreateFolderRequest.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
  ## deleteFolder
89
92
 
90
- > deleteFolder(folderId, ksUat)
93
+ > deleteFolder(folderId, authorization, ksUat)
91
94
 
92
95
  Delete Folder Handler
93
96
 
@@ -110,6 +113,8 @@ async function example() {
110
113
  // string
111
114
  folderId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
112
115
  // string (optional)
116
+ authorization: authorization_example,
117
+ // string (optional)
113
118
  ksUat: ksUat_example,
114
119
  } satisfies DeleteFolderRequest;
115
120
 
@@ -131,6 +136,7 @@ example().catch(console.error);
131
136
  | Name | Type | Description | Notes |
132
137
  |------------- | ------------- | ------------- | -------------|
133
138
  | **folderId** | `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
  ## folderAction
160
166
 
161
- > FolderActionResponse folderAction(folderId, action, ksUat)
167
+ > FolderActionResponse folderAction(folderId, action, authorization, ksUat)
162
168
 
163
169
  Folder Action Handler
164
170
 
@@ -183,6 +189,8 @@ async function example() {
183
189
  // FolderAction | Action to perform
184
190
  action: ...,
185
191
  // string (optional)
192
+ authorization: authorization_example,
193
+ // string (optional)
186
194
  ksUat: ksUat_example,
187
195
  } satisfies FolderActionRequest;
188
196
 
@@ -205,6 +213,7 @@ example().catch(console.error);
205
213
  |------------- | ------------- | ------------- | -------------|
206
214
  | **folderId** | `string` | | [Defaults to `undefined`] |
207
215
  | **action** | `FolderAction` | Action to perform | [Defaults to `undefined`] [Enum: reembed] |
216
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
208
217
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
209
218
 
210
219
  ### Return type
@@ -232,7 +241,7 @@ No authorization required
232
241
 
233
242
  ## getFolder
234
243
 
235
- > FolderResponse getFolder(folderId, withTags, ksUat)
244
+ > FolderResponse getFolder(folderId, withTags, authorization, ksUat)
236
245
 
237
246
  Get Folder Handler
238
247
 
@@ -257,6 +266,8 @@ async function example() {
257
266
  // boolean | Include tags in the response (default: false) (optional)
258
267
  withTags: true,
259
268
  // string (optional)
269
+ authorization: authorization_example,
270
+ // string (optional)
260
271
  ksUat: ksUat_example,
261
272
  } satisfies GetFolderRequest;
262
273
 
@@ -279,6 +290,7 @@ example().catch(console.error);
279
290
  |------------- | ------------- | ------------- | -------------|
280
291
  | **folderId** | `string` | | [Defaults to `undefined`] |
281
292
  | **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
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
  ## listFolderContents
308
320
 
309
- > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, nameLike, limit, offset, ksUat)
321
+ > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, nameLike, limit, offset, authorization, ksUat)
310
322
 
311
323
  List Folder Contents Handler
312
324
 
@@ -341,6 +353,8 @@ async function example() {
341
353
  // number | Number of items to skip (optional)
342
354
  offset: 56,
343
355
  // string (optional)
356
+ authorization: authorization_example,
357
+ // string (optional)
344
358
  ksUat: ksUat_example,
345
359
  } satisfies ListFolderContentsRequest;
346
360
 
@@ -368,6 +382,7 @@ example().catch(console.error);
368
382
  | **nameLike** | `string` | Case-insensitive partial name search filter | [Optional] [Defaults to `undefined`] |
369
383
  | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
370
384
  | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
385
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
371
386
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
372
387
 
373
388
  ### Return type
@@ -395,7 +410,7 @@ No authorization required
395
410
 
396
411
  ## listFolders
397
412
 
398
- > PaginatedResponseFolderResponse listFolders(parentPathPartId, sortOrder, withTags, limit, offset, ksUat)
413
+ > PaginatedResponseFolderResponse listFolders(parentPathPartId, sortOrder, withTags, limit, offset, authorization, ksUat)
399
414
 
400
415
  List Folders Handler
401
416
 
@@ -426,6 +441,8 @@ async function example() {
426
441
  // number | Number of items to skip (optional)
427
442
  offset: 56,
428
443
  // string (optional)
444
+ authorization: authorization_example,
445
+ // string (optional)
429
446
  ksUat: ksUat_example,
430
447
  } satisfies ListFoldersRequest;
431
448
 
@@ -451,6 +468,7 @@ example().catch(console.error);
451
468
  | **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
452
469
  | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
453
470
  | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
471
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
454
472
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
455
473
 
456
474
  ### Return type
@@ -478,7 +496,7 @@ No authorization required
478
496
 
479
497
  ## updateFolder
480
498
 
481
- > FolderResponse updateFolder(folderId, updateFolderRequest, ksUat)
499
+ > FolderResponse updateFolder(folderId, updateFolderRequest, authorization, ksUat)
482
500
 
483
501
  Update Folder Handler
484
502
 
@@ -503,6 +521,8 @@ async function example() {
503
521
  // UpdateFolderRequest
504
522
  updateFolderRequest: ...,
505
523
  // string (optional)
524
+ authorization: authorization_example,
525
+ // string (optional)
506
526
  ksUat: ksUat_example,
507
527
  } satisfies UpdateFolderOperationRequest;
508
528
 
@@ -525,6 +545,7 @@ example().catch(console.error);
525
545
  |------------- | ------------- | ------------- | -------------|
526
546
  | **folderId** | `string` | | [Defaults to `undefined`] |
527
547
  | **updateFolderRequest** | [UpdateFolderRequest](UpdateFolderRequest.md) | | |
548
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
528
549
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
529
550
 
530
551
  ### Return type
@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost:8000*
13
13
 
14
14
  ## acceptInvite
15
15
 
16
- > AcceptInviteResponse acceptInvite(inviteId, ksUat)
16
+ > AcceptInviteResponse acceptInvite(inviteId, authorization, ksUat)
17
17
 
18
18
  Accept Invite
19
19
 
@@ -36,6 +36,8 @@ async function example() {
36
36
  // string
37
37
  inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
38
38
  // string (optional)
39
+ authorization: authorization_example,
40
+ // string (optional)
39
41
  ksUat: ksUat_example,
40
42
  } satisfies AcceptInviteRequest;
41
43
 
@@ -57,6 +59,7 @@ example().catch(console.error);
57
59
  | Name | Type | Description | Notes |
58
60
  |------------- | ------------- | ------------- | -------------|
59
61
  | **inviteId** | `string` | | [Defaults to `undefined`] |
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
  ## createInvite
86
89
 
87
- > InviteResponse createInvite(inviteUserRequest, ksUat)
90
+ > InviteResponse createInvite(inviteUserRequest, authorization, ksUat)
88
91
 
89
92
  Create Invite
90
93
 
@@ -107,6 +110,8 @@ async function example() {
107
110
  // InviteUserRequest
108
111
  inviteUserRequest: ...,
109
112
  // string (optional)
113
+ authorization: authorization_example,
114
+ // string (optional)
110
115
  ksUat: ksUat_example,
111
116
  } satisfies CreateInviteRequest;
112
117
 
@@ -128,6 +133,7 @@ example().catch(console.error);
128
133
  | Name | Type | Description | Notes |
129
134
  |------------- | ------------- | ------------- | -------------|
130
135
  | **inviteUserRequest** | [InviteUserRequest](InviteUserRequest.md) | | |
136
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
131
137
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
132
138
 
133
139
  ### Return type
@@ -155,7 +161,7 @@ No authorization required
155
161
 
156
162
  ## deleteInvite
157
163
 
158
- > deleteInvite(inviteId, ksUat)
164
+ > deleteInvite(inviteId, authorization, ksUat)
159
165
 
160
166
  Delete Invite
161
167
 
@@ -178,6 +184,8 @@ async function example() {
178
184
  // string
179
185
  inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
180
186
  // string (optional)
187
+ authorization: authorization_example,
188
+ // string (optional)
181
189
  ksUat: ksUat_example,
182
190
  } satisfies DeleteInviteRequest;
183
191
 
@@ -199,6 +207,7 @@ example().catch(console.error);
199
207
  | Name | Type | Description | Notes |
200
208
  |------------- | ------------- | ------------- | -------------|
201
209
  | **inviteId** | `string` | | [Defaults to `undefined`] |
210
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
202
211
  | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
203
212
 
204
213
  ### Return type
@@ -226,7 +235,7 @@ No authorization required
226
235
 
227
236
  ## listInvites
228
237
 
229
- > PaginatedResponseInviteResponse listInvites(email, status, limit, offset, ksUat)
238
+ > PaginatedResponseInviteResponse listInvites(email, status, limit, offset, authorization, ksUat)
230
239
 
231
240
  List Invites Handler
232
241
 
@@ -255,6 +264,8 @@ async function example() {
255
264
  // number | Number of items to skip (optional)
256
265
  offset: 56,
257
266
  // string (optional)
267
+ authorization: authorization_example,
268
+ // string (optional)
258
269
  ksUat: ksUat_example,
259
270
  } satisfies ListInvitesRequest;
260
271
 
@@ -279,6 +290,7 @@ example().catch(console.error);
279
290
  | **status** | `InviteStatus` | Filter by invite status (pending, accepted, expired) | [Optional] [Defaults to `undefined`] [Enum: pending, accepted, expired] |
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