@knowledge-stack/ksapi 1.162.0 → 2.4.2

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 (153) hide show
  1. package/.openapi-generator/FILES +20 -2
  2. package/README.md +13 -3
  3. package/dist/apis/BillingApi.d.ts +70 -0
  4. package/dist/apis/BillingApi.js +120 -0
  5. package/dist/apis/DocumentVersionsApi.d.ts +8 -8
  6. package/dist/apis/DocumentVersionsApi.js +4 -4
  7. package/dist/apis/DocumentsApi.d.ts +4 -4
  8. package/dist/apis/DocumentsApi.js +2 -2
  9. package/dist/apis/SubscriptionsApi.d.ts +17 -20
  10. package/dist/apis/SubscriptionsApi.js +6 -9
  11. package/dist/apis/TenantsApi.d.ts +4 -4
  12. package/dist/apis/TenantsApi.js +2 -2
  13. package/dist/apis/TrashApi.d.ts +39 -1
  14. package/dist/apis/TrashApi.js +48 -0
  15. package/dist/apis/WorkflowRunsApi.d.ts +4 -4
  16. package/dist/apis/WorkflowRunsApi.js +2 -2
  17. package/dist/apis/index.d.ts +1 -0
  18. package/dist/apis/index.js +1 -0
  19. package/dist/esm/apis/BillingApi.d.ts +70 -0
  20. package/dist/esm/apis/BillingApi.js +83 -0
  21. package/dist/esm/apis/DocumentVersionsApi.d.ts +8 -8
  22. package/dist/esm/apis/DocumentVersionsApi.js +4 -4
  23. package/dist/esm/apis/DocumentsApi.d.ts +4 -4
  24. package/dist/esm/apis/DocumentsApi.js +2 -2
  25. package/dist/esm/apis/SubscriptionsApi.d.ts +17 -20
  26. package/dist/esm/apis/SubscriptionsApi.js +7 -10
  27. package/dist/esm/apis/TenantsApi.d.ts +4 -4
  28. package/dist/esm/apis/TenantsApi.js +2 -2
  29. package/dist/esm/apis/TrashApi.d.ts +39 -1
  30. package/dist/esm/apis/TrashApi.js +49 -1
  31. package/dist/esm/apis/WorkflowRunsApi.d.ts +4 -4
  32. package/dist/esm/apis/WorkflowRunsApi.js +2 -2
  33. package/dist/esm/apis/index.d.ts +1 -0
  34. package/dist/esm/apis/index.js +1 -0
  35. package/dist/esm/models/BillingInterval.d.ts +25 -0
  36. package/dist/esm/models/BillingInterval.js +43 -0
  37. package/dist/esm/models/BillingPaymentResponse.d.ts +100 -0
  38. package/dist/esm/models/BillingPaymentResponse.js +75 -0
  39. package/dist/esm/models/BillingSystem.d.ts +30 -0
  40. package/dist/esm/models/BillingSystem.js +48 -0
  41. package/dist/esm/models/ChangeSubscriptionRequest.d.ts +34 -0
  42. package/dist/esm/models/ChangeSubscriptionRequest.js +10 -0
  43. package/dist/esm/models/CheckoutAction.d.ts +27 -0
  44. package/dist/esm/models/CheckoutAction.js +45 -0
  45. package/dist/esm/models/CheckoutResponse.d.ts +76 -0
  46. package/dist/esm/models/{SubmitSubscriptionResponse.js → CheckoutResponse.js} +20 -20
  47. package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +19 -0
  48. package/dist/esm/models/CreateWorkflowDefinitionRequest.js +10 -0
  49. package/dist/esm/models/IdpConfig.d.ts +6 -0
  50. package/dist/esm/models/IdpConfig.js +10 -1
  51. package/dist/esm/models/PaginatedResponseBillingPaymentResponse.d.ts +66 -0
  52. package/dist/esm/models/PaginatedResponseBillingPaymentResponse.js +70 -0
  53. package/dist/esm/models/ScheduleCadence.d.ts +32 -0
  54. package/dist/esm/models/ScheduleCadence.js +50 -0
  55. package/dist/esm/models/SubscriptionPlanResponse.d.ts +24 -0
  56. package/dist/esm/models/SubscriptionPlanResponse.js +8 -0
  57. package/dist/esm/models/{SubmitSubscriptionResponse.d.ts → TenantSubscriptionResponse.d.ts} +49 -38
  58. package/dist/esm/models/TenantSubscriptionResponse.js +67 -0
  59. package/dist/esm/models/TrashItemDetailResponse.d.ts +110 -0
  60. package/dist/esm/models/TrashItemDetailResponse.js +81 -0
  61. package/dist/esm/models/TrashItemResponse.d.ts +7 -0
  62. package/dist/esm/models/TrashItemResponse.js +3 -0
  63. package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +19 -0
  64. package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +10 -0
  65. package/dist/esm/models/WorkflowDefinitionResponse.d.ts +19 -0
  66. package/dist/esm/models/WorkflowDefinitionResponse.js +7 -0
  67. package/dist/esm/models/index.d.ts +9 -1
  68. package/dist/esm/models/index.js +9 -1
  69. package/dist/models/BillingInterval.d.ts +25 -0
  70. package/dist/models/BillingInterval.js +51 -0
  71. package/dist/models/BillingPaymentResponse.d.ts +100 -0
  72. package/dist/models/BillingPaymentResponse.js +83 -0
  73. package/dist/models/BillingSystem.d.ts +30 -0
  74. package/dist/models/BillingSystem.js +56 -0
  75. package/dist/models/ChangeSubscriptionRequest.d.ts +34 -0
  76. package/dist/models/ChangeSubscriptionRequest.js +10 -0
  77. package/dist/models/CheckoutAction.d.ts +27 -0
  78. package/dist/models/CheckoutAction.js +53 -0
  79. package/dist/models/CheckoutResponse.d.ts +76 -0
  80. package/dist/models/{SubmitSubscriptionResponse.js → CheckoutResponse.js} +26 -26
  81. package/dist/models/CreateWorkflowDefinitionRequest.d.ts +19 -0
  82. package/dist/models/CreateWorkflowDefinitionRequest.js +10 -0
  83. package/dist/models/IdpConfig.d.ts +6 -0
  84. package/dist/models/IdpConfig.js +10 -1
  85. package/dist/models/PaginatedResponseBillingPaymentResponse.d.ts +66 -0
  86. package/dist/models/PaginatedResponseBillingPaymentResponse.js +78 -0
  87. package/dist/models/ScheduleCadence.d.ts +32 -0
  88. package/dist/models/ScheduleCadence.js +58 -0
  89. package/dist/models/SubscriptionPlanResponse.d.ts +24 -0
  90. package/dist/models/SubscriptionPlanResponse.js +8 -0
  91. package/dist/models/{SubmitSubscriptionResponse.d.ts → TenantSubscriptionResponse.d.ts} +49 -38
  92. package/dist/models/TenantSubscriptionResponse.js +75 -0
  93. package/dist/models/TrashItemDetailResponse.d.ts +110 -0
  94. package/dist/models/TrashItemDetailResponse.js +89 -0
  95. package/dist/models/TrashItemResponse.d.ts +7 -0
  96. package/dist/models/TrashItemResponse.js +3 -0
  97. package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +19 -0
  98. package/dist/models/UpdateWorkflowDefinitionRequest.js +10 -0
  99. package/dist/models/WorkflowDefinitionResponse.d.ts +19 -0
  100. package/dist/models/WorkflowDefinitionResponse.js +7 -0
  101. package/dist/models/index.d.ts +9 -1
  102. package/dist/models/index.js +9 -1
  103. package/docs/BillingApi.md +90 -0
  104. package/docs/BillingInterval.md +33 -0
  105. package/docs/BillingPaymentResponse.md +51 -0
  106. package/docs/BillingSystem.md +33 -0
  107. package/docs/ChangeSubscriptionRequest.md +9 -1
  108. package/docs/CheckoutAction.md +33 -0
  109. package/docs/CheckoutResponse.md +41 -0
  110. package/docs/CreateWorkflowDefinitionRequest.md +6 -0
  111. package/docs/DocumentVersionsApi.md +2 -2
  112. package/docs/DocumentsApi.md +1 -1
  113. package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.md +6 -0
  114. package/docs/IdpConfig.md +2 -0
  115. package/docs/PaginatedResponseBillingPaymentResponse.md +40 -0
  116. package/docs/ScheduleCadence.md +33 -0
  117. package/docs/SubscriptionPlanResponse.md +8 -0
  118. package/docs/SubscriptionsApi.md +7 -10
  119. package/docs/TenantSubscriptionResponse.md +47 -0
  120. package/docs/TenantsApi.md +1 -1
  121. package/docs/TrashApi.md +76 -0
  122. package/docs/TrashItemDetailResponse.md +55 -0
  123. package/docs/TrashItemResponse.md +2 -0
  124. package/docs/UpdateWorkflowDefinitionRequest.md +6 -0
  125. package/docs/WorkflowDefinitionResponse.md +6 -0
  126. package/docs/WorkflowRunsApi.md +1 -1
  127. package/package.json +1 -1
  128. package/src/apis/BillingApi.ts +142 -0
  129. package/src/apis/DocumentVersionsApi.ts +8 -8
  130. package/src/apis/DocumentsApi.ts +4 -4
  131. package/src/apis/SubscriptionsApi.ts +24 -31
  132. package/src/apis/TenantsApi.ts +4 -4
  133. package/src/apis/TrashApi.ts +86 -0
  134. package/src/apis/WorkflowRunsApi.ts +4 -4
  135. package/src/apis/index.ts +1 -0
  136. package/src/models/BillingInterval.ts +53 -0
  137. package/src/models/BillingPaymentResponse.ts +168 -0
  138. package/src/models/BillingSystem.ts +58 -0
  139. package/src/models/ChangeSubscriptionRequest.ts +55 -0
  140. package/src/models/CheckoutAction.ts +55 -0
  141. package/src/models/{SubmitSubscriptionResponse.ts → CheckoutResponse.ts} +61 -47
  142. package/src/models/CreateWorkflowDefinitionRequest.ts +37 -0
  143. package/src/models/IdpConfig.ts +14 -0
  144. package/src/models/PaginatedResponseBillingPaymentResponse.ts +130 -0
  145. package/src/models/ScheduleCadence.ts +60 -0
  146. package/src/models/SubscriptionPlanResponse.ts +32 -0
  147. package/src/models/TenantSubscriptionResponse.ts +159 -0
  148. package/src/models/TrashItemDetailResponse.ts +194 -0
  149. package/src/models/TrashItemResponse.ts +15 -0
  150. package/src/models/UpdateWorkflowDefinitionRequest.ts +37 -0
  151. package/src/models/WorkflowDefinitionResponse.ts +31 -0
  152. package/src/models/index.ts +9 -1
  153. package/docs/SubmitSubscriptionResponse.md +0 -39
@@ -25,6 +25,10 @@ docs/AskRequest.md
25
25
  docs/AskResponse.md
26
26
  docs/AuditEventsApi.md
27
27
  docs/AuthApi.md
28
+ docs/BillingApi.md
29
+ docs/BillingInterval.md
30
+ docs/BillingPaymentResponse.md
31
+ docs/BillingSystem.md
28
32
  docs/BlockChangeType.md
29
33
  docs/BlockKind.md
30
34
  docs/BrandingLogoType.md
@@ -55,6 +59,8 @@ docs/CellDiff.md
55
59
  docs/ChangeClass.md
56
60
  docs/ChangePhoneNumberRequest.md
57
61
  docs/ChangeSubscriptionRequest.md
62
+ docs/CheckoutAction.md
63
+ docs/CheckoutResponse.md
58
64
  docs/CheckpointDetails.md
59
65
  docs/ChunkBulkResponse.md
60
66
  docs/ChunkContentItem.md
@@ -220,6 +226,7 @@ docs/OnboardingCompanyRequest.md
220
226
  docs/OnboardingProfileRequest.md
221
227
  docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.md
222
228
  docs/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md
229
+ docs/PaginatedResponseBillingPaymentResponse.md
223
230
  docs/PaginatedResponseDocumentResponse.md
224
231
  docs/PaginatedResponseDocumentVersionResponse.md
225
232
  docs/PaginatedResponseEventResponse.md
@@ -282,6 +289,7 @@ docs/RunFolder.md
282
289
  docs/RunFolderRef.md
283
290
  docs/RunTimeseriesResponse.md
284
291
  docs/SSOInitiateResponse.md
292
+ docs/ScheduleCadence.md
285
293
  docs/ScoredChunkResponse.md
286
294
  docs/SearchSkillsRequest.md
287
295
  docs/SearchSkillsResponse.md
@@ -316,7 +324,6 @@ docs/StructuredChange.md
316
324
  docs/StructuredChangeType.md
317
325
  docs/StructuredDiff.md
318
326
  docs/SubmitFeedbackRequest.md
319
- docs/SubmitSubscriptionResponse.md
320
327
  docs/SubscriptionPlanResponse.md
321
328
  docs/SubscriptionsApi.md
322
329
  docs/SubtreeChunkGroup.md
@@ -337,6 +344,7 @@ docs/TenantQuotaStateResponse.md
337
344
  docs/TenantResponse.md
338
345
  docs/TenantSettingsResponse.md
339
346
  docs/TenantSettingsUpdate.md
347
+ docs/TenantSubscriptionResponse.md
340
348
  docs/TenantUserEditRequest.md
341
349
  docs/TenantUserOrder.md
342
350
  docs/TenantUserResponse.md
@@ -362,6 +370,7 @@ docs/ToolStatus.md
362
370
  docs/TransferOwnerRequest.md
363
371
  docs/TransferOwnerResponse.md
364
372
  docs/TrashApi.md
373
+ docs/TrashItemDetailResponse.md
365
374
  docs/TrashItemResponse.md
366
375
  docs/UpdateApiConnectionRequest.md
367
376
  docs/UpdateChunkContentRequest.md
@@ -433,6 +442,7 @@ src/apis/ApiConnectionsApi.ts
433
442
  src/apis/ApiKeysApi.ts
434
443
  src/apis/AuditEventsApi.ts
435
444
  src/apis/AuthApi.ts
445
+ src/apis/BillingApi.ts
436
446
  src/apis/BulkDeleteApi.ts
437
447
  src/apis/BulkDownloadApi.ts
438
448
  src/apis/BulkMoveApi.ts
@@ -484,6 +494,9 @@ src/models/AppendMemoryChunkRequest.ts
484
494
  src/models/Args.ts
485
495
  src/models/AskRequest.ts
486
496
  src/models/AskResponse.ts
497
+ src/models/BillingInterval.ts
498
+ src/models/BillingPaymentResponse.ts
499
+ src/models/BillingSystem.ts
487
500
  src/models/BlockChangeType.ts
488
501
  src/models/BlockKind.ts
489
502
  src/models/BrandingLogoType.ts
@@ -511,6 +524,8 @@ src/models/CellDiff.ts
511
524
  src/models/ChangeClass.ts
512
525
  src/models/ChangePhoneNumberRequest.ts
513
526
  src/models/ChangeSubscriptionRequest.ts
527
+ src/models/CheckoutAction.ts
528
+ src/models/CheckoutResponse.ts
514
529
  src/models/CheckpointDetails.ts
515
530
  src/models/ChunkBulkResponse.ts
516
531
  src/models/ChunkContentItem.ts
@@ -664,6 +679,7 @@ src/models/OnboardingCompanyRequest.ts
664
679
  src/models/OnboardingProfileRequest.ts
665
680
  src/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.ts
666
681
  src/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.ts
682
+ src/models/PaginatedResponseBillingPaymentResponse.ts
667
683
  src/models/PaginatedResponseDocumentResponse.ts
668
684
  src/models/PaginatedResponseDocumentVersionResponse.ts
669
685
  src/models/PaginatedResponseEventResponse.ts
@@ -723,6 +739,7 @@ src/models/RunFolder.ts
723
739
  src/models/RunFolderRef.ts
724
740
  src/models/RunTimeseriesResponse.ts
725
741
  src/models/SSOInitiateResponse.ts
742
+ src/models/ScheduleCadence.ts
726
743
  src/models/ScoredChunkResponse.ts
727
744
  src/models/SearchSkillsRequest.ts
728
745
  src/models/SearchSkillsResponse.ts
@@ -755,7 +772,6 @@ src/models/StructuredChange.ts
755
772
  src/models/StructuredChangeType.ts
756
773
  src/models/StructuredDiff.ts
757
774
  src/models/SubmitFeedbackRequest.ts
758
- src/models/SubmitSubscriptionResponse.ts
759
775
  src/models/SubscriptionPlanResponse.ts
760
776
  src/models/SubtreeChunkGroup.ts
761
777
  src/models/SubtreeChunksResponse.ts
@@ -772,6 +788,7 @@ src/models/TenantQuotaStateResponse.ts
772
788
  src/models/TenantResponse.ts
773
789
  src/models/TenantSettingsResponse.ts
774
790
  src/models/TenantSettingsUpdate.ts
791
+ src/models/TenantSubscriptionResponse.ts
775
792
  src/models/TenantUserEditRequest.ts
776
793
  src/models/TenantUserOrder.ts
777
794
  src/models/TenantUserResponse.ts
@@ -793,6 +810,7 @@ src/models/ToolPart.ts
793
810
  src/models/ToolStatus.ts
794
811
  src/models/TransferOwnerRequest.ts
795
812
  src/models/TransferOwnerResponse.ts
813
+ src/models/TrashItemDetailResponse.ts
796
814
  src/models/TrashItemResponse.ts
797
815
  src/models/UpdateApiConnectionRequest.ts
798
816
  src/models/UpdateChunkContentRequest.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@1.162.0
1
+ # @knowledge-stack/ksapi@2.4.2
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -90,6 +90,7 @@ All URIs are relative to *http://localhost:8000*
90
90
  *AuthApi* | [**signout**](docs/AuthApi.md#signout) | **POST** /v1/auth/signout | Signout Handler
91
91
  *AuthApi* | [**ssoSignin**](docs/AuthApi.md#ssosignin) | **GET** /v1/auth/sso/{tenant_id}/signin | Sso Login Handler
92
92
  *AuthApi* | [**validatePwResetCode**](docs/AuthApi.md#validatepwresetcode) | **POST** /v1/auth/pw/validate_reset_code | Validate Reset Code Handler
93
+ *BillingApi* | [**listBillingPayments**](docs/BillingApi.md#listbillingpayments) | **GET** /v1/tenants/{tenant_id}/billing/payments | List Billing Payments Handler
93
94
  *BulkDeleteApi* | [**bulkDelete**](docs/BulkDeleteApi.md#bulkdeleteoperation) | **POST** /v1/bulk-delete | Bulk Delete Handler
94
95
  *BulkDownloadApi* | [**startBulkDownload**](docs/BulkDownloadApi.md#startbulkdownload) | **POST** /v1/bulk-download | Start Bulk Download Handler
95
96
  *BulkMoveApi* | [**bulkMove**](docs/BulkMoveApi.md#bulkmoveoperation) | **POST** /v1/bulk-move | Bulk Move Handler
@@ -259,6 +260,7 @@ All URIs are relative to *http://localhost:8000*
259
260
  *ThreadsApi* | [**updateThread**](docs/ThreadsApi.md#updatethreadoperation) | **PATCH** /v1/threads/{thread_id} | Update Thread Handler
260
261
  *TrashApi* | [**bulkPermanentlyDeleteTrash**](docs/TrashApi.md#bulkpermanentlydeletetrash) | **POST** /v1/trash/bulk-delete | Bulk Permanently Delete Trash Handler
261
262
  *TrashApi* | [**bulkRestoreTrash**](docs/TrashApi.md#bulkrestoretrash) | **POST** /v1/trash/bulk-restore | Bulk Restore Trash Handler
263
+ *TrashApi* | [**getTrashItem**](docs/TrashApi.md#gettrashitem) | **GET** /v1/trash/{path_part_id} | Get Trash Item Handler
262
264
  *TrashApi* | [**listTrash**](docs/TrashApi.md#listtrash) | **GET** /v1/trash | List Trash Handler
263
265
  *TrashApi* | [**permanentlyDeleteTrashItem**](docs/TrashApi.md#permanentlydeletetrashitem) | **DELETE** /v1/trash/{path_part_id} | Permanently Delete Trash Item Handler
264
266
  *TrashApi* | [**restoreTrashItem**](docs/TrashApi.md#restoretrashitem) | **POST** /v1/trash/{path_part_id}/restore | Restore Trash Item Handler
@@ -318,6 +320,9 @@ All URIs are relative to *http://localhost:8000*
318
320
  - [Args](docs/Args.md)
319
321
  - [AskRequest](docs/AskRequest.md)
320
322
  - [AskResponse](docs/AskResponse.md)
323
+ - [BillingInterval](docs/BillingInterval.md)
324
+ - [BillingPaymentResponse](docs/BillingPaymentResponse.md)
325
+ - [BillingSystem](docs/BillingSystem.md)
321
326
  - [BlockChangeType](docs/BlockChangeType.md)
322
327
  - [BlockKind](docs/BlockKind.md)
323
328
  - [BrandingLogoType](docs/BrandingLogoType.md)
@@ -345,6 +350,8 @@ All URIs are relative to *http://localhost:8000*
345
350
  - [ChangeClass](docs/ChangeClass.md)
346
351
  - [ChangePhoneNumberRequest](docs/ChangePhoneNumberRequest.md)
347
352
  - [ChangeSubscriptionRequest](docs/ChangeSubscriptionRequest.md)
353
+ - [CheckoutAction](docs/CheckoutAction.md)
354
+ - [CheckoutResponse](docs/CheckoutResponse.md)
348
355
  - [CheckpointDetails](docs/CheckpointDetails.md)
349
356
  - [ChunkBulkResponse](docs/ChunkBulkResponse.md)
350
357
  - [ChunkContentItem](docs/ChunkContentItem.md)
@@ -498,6 +505,7 @@ All URIs are relative to *http://localhost:8000*
498
505
  - [OnboardingProfileRequest](docs/OnboardingProfileRequest.md)
499
506
  - [PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat](docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat.md)
500
507
  - [PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator](docs/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md)
508
+ - [PaginatedResponseBillingPaymentResponse](docs/PaginatedResponseBillingPaymentResponse.md)
501
509
  - [PaginatedResponseDocumentResponse](docs/PaginatedResponseDocumentResponse.md)
502
510
  - [PaginatedResponseDocumentVersionResponse](docs/PaginatedResponseDocumentVersionResponse.md)
503
511
  - [PaginatedResponseEventResponse](docs/PaginatedResponseEventResponse.md)
@@ -557,6 +565,7 @@ All URIs are relative to *http://localhost:8000*
557
565
  - [RunFolderRef](docs/RunFolderRef.md)
558
566
  - [RunTimeseriesResponse](docs/RunTimeseriesResponse.md)
559
567
  - [SSOInitiateResponse](docs/SSOInitiateResponse.md)
568
+ - [ScheduleCadence](docs/ScheduleCadence.md)
560
569
  - [ScoredChunkResponse](docs/ScoredChunkResponse.md)
561
570
  - [SearchSkillsRequest](docs/SearchSkillsRequest.md)
562
571
  - [SearchSkillsResponse](docs/SearchSkillsResponse.md)
@@ -589,7 +598,6 @@ All URIs are relative to *http://localhost:8000*
589
598
  - [StructuredChangeType](docs/StructuredChangeType.md)
590
599
  - [StructuredDiff](docs/StructuredDiff.md)
591
600
  - [SubmitFeedbackRequest](docs/SubmitFeedbackRequest.md)
592
- - [SubmitSubscriptionResponse](docs/SubmitSubscriptionResponse.md)
593
601
  - [SubscriptionPlanResponse](docs/SubscriptionPlanResponse.md)
594
602
  - [SubtreeChunkGroup](docs/SubtreeChunkGroup.md)
595
603
  - [SubtreeChunksResponse](docs/SubtreeChunksResponse.md)
@@ -606,6 +614,7 @@ All URIs are relative to *http://localhost:8000*
606
614
  - [TenantResponse](docs/TenantResponse.md)
607
615
  - [TenantSettingsResponse](docs/TenantSettingsResponse.md)
608
616
  - [TenantSettingsUpdate](docs/TenantSettingsUpdate.md)
617
+ - [TenantSubscriptionResponse](docs/TenantSubscriptionResponse.md)
609
618
  - [TenantUserEditRequest](docs/TenantUserEditRequest.md)
610
619
  - [TenantUserOrder](docs/TenantUserOrder.md)
611
620
  - [TenantUserResponse](docs/TenantUserResponse.md)
@@ -627,6 +636,7 @@ All URIs are relative to *http://localhost:8000*
627
636
  - [ToolStatus](docs/ToolStatus.md)
628
637
  - [TransferOwnerRequest](docs/TransferOwnerRequest.md)
629
638
  - [TransferOwnerResponse](docs/TransferOwnerResponse.md)
639
+ - [TrashItemDetailResponse](docs/TrashItemDetailResponse.md)
630
640
  - [TrashItemResponse](docs/TrashItemResponse.md)
631
641
  - [UpdateApiConnectionRequest](docs/UpdateApiConnectionRequest.md)
632
642
  - [UpdateChunkContentRequest](docs/UpdateChunkContentRequest.md)
@@ -710,7 +720,7 @@ and is automatically generated by the
710
720
  [OpenAPI Generator](https://openapi-generator.tech) project:
711
721
 
712
722
  - API version: `0.1.0`
713
- - Package version: `1.162.0`
723
+ - Package version: `2.4.2`
714
724
  - Generator version: `7.21.0`
715
725
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
716
726
 
@@ -0,0 +1,70 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { PaginatedResponseBillingPaymentResponse } from '../models/index';
14
+ export interface ListBillingPaymentsRequest {
15
+ tenantId: string;
16
+ limit?: number;
17
+ offset?: number;
18
+ }
19
+ /**
20
+ * BillingApi - interface
21
+ *
22
+ * @export
23
+ * @interface BillingApiInterface
24
+ */
25
+ export interface BillingApiInterface {
26
+ /**
27
+ * Creates request options for listBillingPayments without sending the request
28
+ * @param {string} tenantId
29
+ * @param {number} [limit] Number of items per page
30
+ * @param {number} [offset] Number of items to skip
31
+ * @throws {RequiredError}
32
+ * @memberof BillingApiInterface
33
+ */
34
+ listBillingPaymentsRequestOpts(requestParameters: ListBillingPaymentsRequest): Promise<runtime.RequestOpts>;
35
+ /**
36
+ * Newest-first payment history for the tenant (OWNER/ADMIN only). Backs the billing page\'s receipts list. ``invoice_url`` links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.
37
+ * @summary List Billing Payments Handler
38
+ * @param {string} tenantId
39
+ * @param {number} [limit] Number of items per page
40
+ * @param {number} [offset] Number of items to skip
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ * @memberof BillingApiInterface
44
+ */
45
+ listBillingPaymentsRaw(requestParameters: ListBillingPaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseBillingPaymentResponse>>;
46
+ /**
47
+ * Newest-first payment history for the tenant (OWNER/ADMIN only). Backs the billing page\'s receipts list. ``invoice_url`` links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.
48
+ * List Billing Payments Handler
49
+ */
50
+ listBillingPayments(requestParameters: ListBillingPaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseBillingPaymentResponse>;
51
+ }
52
+ /**
53
+ *
54
+ */
55
+ export declare class BillingApi extends runtime.BaseAPI implements BillingApiInterface {
56
+ /**
57
+ * Creates request options for listBillingPayments without sending the request
58
+ */
59
+ listBillingPaymentsRequestOpts(requestParameters: ListBillingPaymentsRequest): Promise<runtime.RequestOpts>;
60
+ /**
61
+ * Newest-first payment history for the tenant (OWNER/ADMIN only). Backs the billing page\'s receipts list. ``invoice_url`` links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.
62
+ * List Billing Payments Handler
63
+ */
64
+ listBillingPaymentsRaw(requestParameters: ListBillingPaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseBillingPaymentResponse>>;
65
+ /**
66
+ * Newest-first payment history for the tenant (OWNER/ADMIN only). Backs the billing page\'s receipts list. ``invoice_url`` links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.
67
+ * List Billing Payments Handler
68
+ */
69
+ listBillingPayments(requestParameters: ListBillingPaymentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseBillingPaymentResponse>;
70
+ }
@@ -0,0 +1,120 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
16
+ if (k2 === undefined) k2 = k;
17
+ var desc = Object.getOwnPropertyDescriptor(m, k);
18
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
19
+ desc = { enumerable: true, get: function() { return m[k]; } };
20
+ }
21
+ Object.defineProperty(o, k2, desc);
22
+ }) : (function(o, m, k, k2) {
23
+ if (k2 === undefined) k2 = k;
24
+ o[k2] = m[k];
25
+ }));
26
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
27
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
28
+ }) : function(o, v) {
29
+ o["default"] = v;
30
+ });
31
+ var __importStar = (this && this.__importStar) || (function () {
32
+ var ownKeys = function(o) {
33
+ ownKeys = Object.getOwnPropertyNames || function (o) {
34
+ var ar = [];
35
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
36
+ return ar;
37
+ };
38
+ return ownKeys(o);
39
+ };
40
+ return function (mod) {
41
+ if (mod && mod.__esModule) return mod;
42
+ var result = {};
43
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
44
+ __setModuleDefault(result, mod);
45
+ return result;
46
+ };
47
+ })();
48
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
49
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
50
+ return new (P || (P = Promise))(function (resolve, reject) {
51
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
52
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
53
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
54
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
55
+ });
56
+ };
57
+ Object.defineProperty(exports, "__esModule", { value: true });
58
+ exports.BillingApi = void 0;
59
+ const runtime = __importStar(require("../runtime"));
60
+ const index_1 = require("../models/index");
61
+ /**
62
+ *
63
+ */
64
+ class BillingApi extends runtime.BaseAPI {
65
+ /**
66
+ * Creates request options for listBillingPayments without sending the request
67
+ */
68
+ listBillingPaymentsRequestOpts(requestParameters) {
69
+ return __awaiter(this, void 0, void 0, function* () {
70
+ if (requestParameters['tenantId'] == null) {
71
+ throw new runtime.RequiredError('tenantId', 'Required parameter "tenantId" was null or undefined when calling listBillingPayments().');
72
+ }
73
+ const queryParameters = {};
74
+ if (requestParameters['limit'] != null) {
75
+ queryParameters['limit'] = requestParameters['limit'];
76
+ }
77
+ if (requestParameters['offset'] != null) {
78
+ queryParameters['offset'] = requestParameters['offset'];
79
+ }
80
+ const headerParameters = {};
81
+ if (this.configuration && this.configuration.accessToken) {
82
+ const token = this.configuration.accessToken;
83
+ const tokenString = yield token("bearerAuth", []);
84
+ if (tokenString) {
85
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
86
+ }
87
+ }
88
+ let urlPath = `/v1/tenants/{tenant_id}/billing/payments`;
89
+ urlPath = urlPath.replace(`{${"tenant_id"}}`, encodeURIComponent(String(requestParameters['tenantId'])));
90
+ return {
91
+ path: urlPath,
92
+ method: 'GET',
93
+ headers: headerParameters,
94
+ query: queryParameters,
95
+ };
96
+ });
97
+ }
98
+ /**
99
+ * Newest-first payment history for the tenant (OWNER/ADMIN only). Backs the billing page\'s receipts list. ``invoice_url`` links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.
100
+ * List Billing Payments Handler
101
+ */
102
+ listBillingPaymentsRaw(requestParameters, initOverrides) {
103
+ return __awaiter(this, void 0, void 0, function* () {
104
+ const requestOptions = yield this.listBillingPaymentsRequestOpts(requestParameters);
105
+ const response = yield this.request(requestOptions, initOverrides);
106
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseBillingPaymentResponseFromJSON)(jsonValue));
107
+ });
108
+ }
109
+ /**
110
+ * Newest-first payment history for the tenant (OWNER/ADMIN only). Backs the billing page\'s receipts list. ``invoice_url`` links the Stripe-hosted invoice when the payment ran through Stripe; CN (Ping++) payments render an in-app receipt from the row itself.
111
+ * List Billing Payments Handler
112
+ */
113
+ listBillingPayments(requestParameters, initOverrides) {
114
+ return __awaiter(this, void 0, void 0, function* () {
115
+ const response = yield this.listBillingPaymentsRaw(requestParameters, initOverrides);
116
+ return yield response.value();
117
+ });
118
+ }
119
+ }
120
+ exports.BillingApi = BillingApi;
@@ -122,7 +122,7 @@ export interface DocumentVersionsApiInterface {
122
122
  */
123
123
  createDocumentVersionRequestOpts(requestParameters: CreateDocumentVersionRequest): Promise<runtime.RequestOpts>;
124
124
  /**
125
- * Create a new version for a document. The version number is automatically incremented from the highest existing version.
125
+ * Create a new version for a document. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The version number is automatically incremented from the highest existing version.
126
126
  * @summary Create Document Version Handler
127
127
  * @param {string} documentId Document ID
128
128
  * @param {*} [options] Override http request option.
@@ -131,7 +131,7 @@ export interface DocumentVersionsApiInterface {
131
131
  */
132
132
  createDocumentVersionRaw(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
133
133
  /**
134
- * Create a new version for a document. The version number is automatically incremented from the highest existing version.
134
+ * Create a new version for a document. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The version number is automatically incremented from the highest existing version.
135
135
  * Create Document Version Handler
136
136
  */
137
137
  createDocumentVersion(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
@@ -143,7 +143,7 @@ export interface DocumentVersionsApiInterface {
143
143
  */
144
144
  deleteDocumentVersionRequestOpts(requestParameters: DeleteDocumentVersionRequest): Promise<runtime.RequestOpts>;
145
145
  /**
146
- * Delete a document version by its ID. Cannot delete the active version of a document.
146
+ * Delete a document version by its ID. Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Cannot delete the active version of a document.
147
147
  * @summary Delete Document Version Handler
148
148
  * @param {string} versionId DocumentVersion ID
149
149
  * @param {*} [options] Override http request option.
@@ -152,7 +152,7 @@ export interface DocumentVersionsApiInterface {
152
152
  */
153
153
  deleteDocumentVersionRaw(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
154
154
  /**
155
- * Delete a document version by its ID. Cannot delete the active version of a document.
155
+ * Delete a document version by its ID. Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Cannot delete the active version of a document.
156
156
  * Delete Document Version Handler
157
157
  */
158
158
  deleteDocumentVersion(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -376,12 +376,12 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
376
376
  */
377
377
  createDocumentVersionRequestOpts(requestParameters: CreateDocumentVersionRequest): Promise<runtime.RequestOpts>;
378
378
  /**
379
- * Create a new version for a document. The version number is automatically incremented from the highest existing version.
379
+ * Create a new version for a document. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The version number is automatically incremented from the highest existing version.
380
380
  * Create Document Version Handler
381
381
  */
382
382
  createDocumentVersionRaw(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
383
383
  /**
384
- * Create a new version for a document. The version number is automatically incremented from the highest existing version.
384
+ * Create a new version for a document. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The version number is automatically incremented from the highest existing version.
385
385
  * Create Document Version Handler
386
386
  */
387
387
  createDocumentVersion(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
@@ -390,12 +390,12 @@ export declare class DocumentVersionsApi extends runtime.BaseAPI implements Docu
390
390
  */
391
391
  deleteDocumentVersionRequestOpts(requestParameters: DeleteDocumentVersionRequest): Promise<runtime.RequestOpts>;
392
392
  /**
393
- * Delete a document version by its ID. Cannot delete the active version of a document.
393
+ * Delete a document version by its ID. Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Cannot delete the active version of a document.
394
394
  * Delete Document Version Handler
395
395
  */
396
396
  deleteDocumentVersionRaw(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
397
397
  /**
398
- * Delete a document version by its ID. Cannot delete the active version of a document.
398
+ * Delete a document version by its ID. Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Cannot delete the active version of a document.
399
399
  * Delete Document Version Handler
400
400
  */
401
401
  deleteDocumentVersion(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -207,7 +207,7 @@ class DocumentVersionsApi extends runtime.BaseAPI {
207
207
  });
208
208
  }
209
209
  /**
210
- * Create a new version for a document. The version number is automatically incremented from the highest existing version.
210
+ * Create a new version for a document. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The version number is automatically incremented from the highest existing version.
211
211
  * Create Document Version Handler
212
212
  */
213
213
  createDocumentVersionRaw(requestParameters, initOverrides) {
@@ -218,7 +218,7 @@ class DocumentVersionsApi extends runtime.BaseAPI {
218
218
  });
219
219
  }
220
220
  /**
221
- * Create a new version for a document. The version number is automatically incremented from the highest existing version.
221
+ * Create a new version for a document. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The version number is automatically incremented from the highest existing version.
222
222
  * Create Document Version Handler
223
223
  */
224
224
  createDocumentVersion(requestParameters, initOverrides) {
@@ -255,7 +255,7 @@ class DocumentVersionsApi extends runtime.BaseAPI {
255
255
  });
256
256
  }
257
257
  /**
258
- * Delete a document version by its ID. Cannot delete the active version of a document.
258
+ * Delete a document version by its ID. Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Cannot delete the active version of a document.
259
259
  * Delete Document Version Handler
260
260
  */
261
261
  deleteDocumentVersionRaw(requestParameters, initOverrides) {
@@ -266,7 +266,7 @@ class DocumentVersionsApi extends runtime.BaseAPI {
266
266
  });
267
267
  }
268
268
  /**
269
- * Delete a document version by its ID. Cannot delete the active version of a document.
269
+ * Delete a document version by its ID. Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Cannot delete the active version of a document.
270
270
  * Delete Document Version Handler
271
271
  */
272
272
  deleteDocumentVersion(requestParameters, initOverrides) {
@@ -323,7 +323,7 @@ export interface DocumentsApiInterface {
323
323
  */
324
324
  ingestDocumentVersionRequestOpts(requestParameters: IngestDocumentVersionRequest): Promise<runtime.RequestOpts>;
325
325
  /**
326
- * Upload a new file for an existing document, creating a new version and triggering ingestion. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
326
+ * Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
327
327
  * @summary Ingest Document Version Handler
328
328
  * @param {string} documentId Document ID
329
329
  * @param {Blob} file
@@ -339,7 +339,7 @@ export interface DocumentsApiInterface {
339
339
  */
340
340
  ingestDocumentVersionRaw(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
341
341
  /**
342
- * Upload a new file for an existing document, creating a new version and triggering ingestion. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
342
+ * Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
343
343
  * Ingest Document Version Handler
344
344
  */
345
345
  ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
@@ -595,12 +595,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
595
595
  */
596
596
  ingestDocumentVersionRequestOpts(requestParameters: IngestDocumentVersionRequest): Promise<runtime.RequestOpts>;
597
597
  /**
598
- * Upload a new file for an existing document, creating a new version and triggering ingestion. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
598
+ * Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
599
599
  * Ingest Document Version Handler
600
600
  */
601
601
  ingestDocumentVersionRaw(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
602
602
  /**
603
- * Upload a new file for an existing document, creating a new version and triggering ingestion. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
603
+ * Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
604
604
  * Ingest Document Version Handler
605
605
  */
606
606
  ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
@@ -622,7 +622,7 @@ class DocumentsApi extends runtime.BaseAPI {
622
622
  });
623
623
  }
624
624
  /**
625
- * Upload a new file for an existing document, creating a new version and triggering ingestion. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
625
+ * Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
626
626
  * Ingest Document Version Handler
627
627
  */
628
628
  ingestDocumentVersionRaw(requestParameters, initOverrides) {
@@ -633,7 +633,7 @@ class DocumentsApi extends runtime.BaseAPI {
633
633
  });
634
634
  }
635
635
  /**
636
- * Upload a new file for an existing document, creating a new version and triggering ingestion. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
636
+ * Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
637
637
  * Ingest Document Version Handler
638
638
  */
639
639
  ingestDocumentVersion(requestParameters, initOverrides) {