@knowledge-stack/ksapi 1.118.0 → 1.119.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 (205) hide show
  1. package/.openapi-generator/FILES +38 -4
  2. package/README.md +25 -4
  3. package/dist/apis/DataSourcesApi.d.ts +170 -9
  4. package/dist/apis/DataSourcesApi.js +207 -4
  5. package/dist/apis/DocumentVersionsApi.d.ts +4 -4
  6. package/dist/apis/DocumentVersionsApi.js +2 -2
  7. package/dist/apis/FoldersApi.d.ts +9 -9
  8. package/dist/apis/FoldersApi.js +2 -2
  9. package/dist/esm/apis/DataSourcesApi.d.ts +170 -9
  10. package/dist/esm/apis/DataSourcesApi.js +208 -5
  11. package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
  12. package/dist/esm/apis/DocumentVersionsApi.js +2 -2
  13. package/dist/esm/apis/FoldersApi.d.ts +9 -9
  14. package/dist/esm/apis/FoldersApi.js +3 -3
  15. package/dist/esm/models/BlockChangeType.d.ts +26 -0
  16. package/dist/esm/models/BlockChangeType.js +44 -0
  17. package/dist/esm/models/BlockKind.d.ts +28 -0
  18. package/dist/esm/models/BlockKind.js +46 -0
  19. package/dist/esm/models/BulkModelTablesRequest.d.ts +48 -0
  20. package/dist/esm/models/BulkModelTablesRequest.js +50 -0
  21. package/dist/esm/models/BulkModelTablesResponse.d.ts +48 -0
  22. package/dist/esm/models/BulkModelTablesResponse.js +45 -0
  23. package/dist/esm/models/CellChange.d.ts +47 -0
  24. package/dist/esm/models/CellChange.js +14 -0
  25. package/dist/esm/models/CellDiff.d.ts +7 -0
  26. package/dist/esm/models/CellDiff.js +5 -0
  27. package/dist/esm/models/ChangeClass.d.ts +29 -0
  28. package/dist/esm/models/ChangeClass.js +47 -0
  29. package/dist/esm/models/DataSourceDescriptionResponse.d.ts +53 -0
  30. package/dist/esm/models/DataSourceDescriptionResponse.js +48 -0
  31. package/dist/esm/models/DataSourceDetailResponse.d.ts +13 -4
  32. package/dist/esm/models/DataSourceDetailResponse.js +6 -4
  33. package/dist/esm/models/DataSourceSchemaListItem.d.ts +53 -0
  34. package/dist/esm/models/DataSourceSchemaListItem.js +48 -0
  35. package/dist/esm/models/DataSourceSchemaListResponse.d.ts +3 -3
  36. package/dist/esm/models/DataSourceSchemaListResponse.js +3 -3
  37. package/dist/esm/models/DataSourceSchemaResponse.d.ts +95 -1
  38. package/dist/esm/models/DataSourceSchemaResponse.js +61 -0
  39. package/dist/esm/models/DataSourceTableResponse.d.ts +8 -5
  40. package/dist/esm/models/DataSourceTableResponse.js +4 -2
  41. package/dist/esm/models/DiffFormat.d.ts +2 -0
  42. package/dist/esm/models/DiffFormat.js +3 -1
  43. package/dist/esm/models/DocumentBlockChange.d.ts +174 -0
  44. package/dist/esm/models/DocumentBlockChange.js +97 -0
  45. package/dist/esm/models/DocumentDiff.d.ts +102 -0
  46. package/dist/esm/models/DocumentDiff.js +77 -0
  47. package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
  48. package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +11 -6
  49. package/dist/esm/models/ModelTableResult.d.ts +81 -0
  50. package/dist/esm/models/ModelTableResult.js +63 -0
  51. package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
  52. package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +12 -12
  53. package/dist/esm/models/PartType.d.ts +1 -0
  54. package/dist/esm/models/PartType.js +1 -0
  55. package/dist/esm/models/PixelRegion.d.ts +65 -0
  56. package/dist/esm/models/PixelRegion.js +56 -0
  57. package/dist/esm/models/ReferenceType.d.ts +1 -0
  58. package/dist/esm/models/ReferenceType.js +1 -0
  59. package/dist/esm/models/RevisionEdit.d.ts +71 -0
  60. package/dist/esm/models/RevisionEdit.js +57 -0
  61. package/dist/esm/models/SearchablePartType.d.ts +2 -0
  62. package/dist/esm/models/SearchablePartType.js +2 -0
  63. package/dist/esm/models/SheetVisibilityChange.d.ts +63 -0
  64. package/dist/esm/models/SheetVisibilityChange.js +52 -0
  65. package/dist/esm/models/StructuredChange.d.ts +69 -0
  66. package/dist/esm/models/StructuredChange.js +57 -0
  67. package/dist/esm/models/StructuredChangeType.d.ts +26 -0
  68. package/dist/esm/models/StructuredChangeType.js +44 -0
  69. package/dist/esm/models/StructuredDiff.d.ts +82 -0
  70. package/dist/esm/models/StructuredDiff.js +65 -0
  71. package/dist/esm/models/TableCellChange.d.ts +72 -0
  72. package/dist/esm/models/TableCellChange.js +61 -0
  73. package/dist/esm/models/VersionDiffResponse.d.ts +72 -1
  74. package/dist/esm/models/VersionDiffResponse.js +25 -0
  75. package/dist/esm/models/index.d.ts +19 -2
  76. package/dist/esm/models/index.js +19 -2
  77. package/dist/models/BlockChangeType.d.ts +26 -0
  78. package/dist/models/BlockChangeType.js +52 -0
  79. package/dist/models/BlockKind.d.ts +28 -0
  80. package/dist/models/BlockKind.js +54 -0
  81. package/dist/models/BulkModelTablesRequest.d.ts +48 -0
  82. package/dist/models/BulkModelTablesRequest.js +58 -0
  83. package/dist/models/BulkModelTablesResponse.d.ts +48 -0
  84. package/dist/models/BulkModelTablesResponse.js +53 -0
  85. package/dist/models/CellChange.d.ts +47 -0
  86. package/dist/models/CellChange.js +14 -0
  87. package/dist/models/CellDiff.d.ts +7 -0
  88. package/dist/models/CellDiff.js +5 -0
  89. package/dist/models/ChangeClass.d.ts +29 -0
  90. package/dist/models/ChangeClass.js +55 -0
  91. package/dist/models/DataSourceDescriptionResponse.d.ts +53 -0
  92. package/dist/models/DataSourceDescriptionResponse.js +56 -0
  93. package/dist/models/DataSourceDetailResponse.d.ts +13 -4
  94. package/dist/models/DataSourceDetailResponse.js +6 -4
  95. package/dist/models/DataSourceSchemaListItem.d.ts +53 -0
  96. package/dist/models/DataSourceSchemaListItem.js +56 -0
  97. package/dist/models/DataSourceSchemaListResponse.d.ts +3 -3
  98. package/dist/models/DataSourceSchemaListResponse.js +3 -3
  99. package/dist/models/DataSourceSchemaResponse.d.ts +95 -1
  100. package/dist/models/DataSourceSchemaResponse.js +62 -1
  101. package/dist/models/DataSourceTableResponse.d.ts +8 -5
  102. package/dist/models/DataSourceTableResponse.js +4 -2
  103. package/dist/models/DiffFormat.d.ts +2 -0
  104. package/dist/models/DiffFormat.js +3 -1
  105. package/dist/models/DocumentBlockChange.d.ts +174 -0
  106. package/dist/models/DocumentBlockChange.js +105 -0
  107. package/dist/models/DocumentDiff.d.ts +102 -0
  108. package/dist/models/DocumentDiff.js +85 -0
  109. package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
  110. package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +15 -10
  111. package/dist/models/ModelTableResult.d.ts +81 -0
  112. package/dist/models/ModelTableResult.js +71 -0
  113. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
  114. package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +18 -18
  115. package/dist/models/PartType.d.ts +1 -0
  116. package/dist/models/PartType.js +1 -0
  117. package/dist/models/PixelRegion.d.ts +65 -0
  118. package/dist/models/PixelRegion.js +64 -0
  119. package/dist/models/ReferenceType.d.ts +1 -0
  120. package/dist/models/ReferenceType.js +1 -0
  121. package/dist/models/RevisionEdit.d.ts +71 -0
  122. package/dist/models/RevisionEdit.js +65 -0
  123. package/dist/models/SearchablePartType.d.ts +2 -0
  124. package/dist/models/SearchablePartType.js +2 -0
  125. package/dist/models/SheetVisibilityChange.d.ts +63 -0
  126. package/dist/models/SheetVisibilityChange.js +60 -0
  127. package/dist/models/StructuredChange.d.ts +69 -0
  128. package/dist/models/StructuredChange.js +65 -0
  129. package/dist/models/StructuredChangeType.d.ts +26 -0
  130. package/dist/models/StructuredChangeType.js +52 -0
  131. package/dist/models/StructuredDiff.d.ts +82 -0
  132. package/dist/models/StructuredDiff.js +73 -0
  133. package/dist/models/TableCellChange.d.ts +72 -0
  134. package/dist/models/TableCellChange.js +69 -0
  135. package/dist/models/VersionDiffResponse.d.ts +72 -1
  136. package/dist/models/VersionDiffResponse.js +25 -0
  137. package/dist/models/index.d.ts +19 -2
  138. package/dist/models/index.js +19 -2
  139. package/docs/BlockChangeType.md +32 -0
  140. package/docs/BlockKind.md +32 -0
  141. package/docs/BulkModelTablesRequest.md +35 -0
  142. package/docs/BulkModelTablesResponse.md +35 -0
  143. package/docs/CellChange.md +15 -1
  144. package/docs/CellDiff.md +2 -0
  145. package/docs/ChangeClass.md +33 -0
  146. package/docs/ChunksApi.md +1 -1
  147. package/docs/DataSourceDescriptionResponse.md +37 -0
  148. package/docs/DataSourceDetailResponse.md +5 -3
  149. package/docs/DataSourceSchemaListItem.md +37 -0
  150. package/docs/DataSourceSchemaListResponse.md +1 -1
  151. package/docs/DataSourceSchemaResponse.md +29 -0
  152. package/docs/DataSourceTableResponse.md +3 -3
  153. package/docs/DataSourcesApi.md +315 -2
  154. package/docs/DocumentBlockChange.md +73 -0
  155. package/docs/DocumentDiff.md +51 -0
  156. package/docs/DocumentVersionsApi.md +1 -1
  157. package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md} +12 -6
  158. package/docs/FoldersApi.md +5 -5
  159. package/docs/ModelTableResult.md +43 -0
  160. package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md} +5 -5
  161. package/docs/PixelRegion.md +41 -0
  162. package/docs/RevisionEdit.md +41 -0
  163. package/docs/SheetVisibilityChange.md +39 -0
  164. package/docs/StructuredChange.md +41 -0
  165. package/docs/StructuredChangeType.md +32 -0
  166. package/docs/StructuredDiff.md +45 -0
  167. package/docs/TableCellChange.md +43 -0
  168. package/docs/VersionDiffResponse.md +23 -1
  169. package/package.json +1 -1
  170. package/src/apis/DataSourcesApi.ts +382 -8
  171. package/src/apis/DocumentVersionsApi.ts +4 -4
  172. package/src/apis/FoldersApi.ts +13 -13
  173. package/src/models/BlockChangeType.ts +54 -0
  174. package/src/models/BlockKind.ts +56 -0
  175. package/src/models/BulkModelTablesRequest.ts +95 -0
  176. package/src/models/BulkModelTablesResponse.ts +91 -0
  177. package/src/models/CellChange.ts +61 -0
  178. package/src/models/CellDiff.ts +16 -0
  179. package/src/models/ChangeClass.ts +57 -0
  180. package/src/models/DataSourceDescriptionResponse.ts +92 -0
  181. package/src/models/DataSourceDetailResponse.ts +24 -13
  182. package/src/models/DataSourceSchemaListItem.ts +92 -0
  183. package/src/models/DataSourceSchemaListResponse.ts +10 -10
  184. package/src/models/DataSourceSchemaResponse.ts +157 -1
  185. package/src/models/DataSourceTableResponse.ts +11 -7
  186. package/src/models/DiffFormat.ts +3 -1
  187. package/src/models/DocumentBlockChange.ts +297 -0
  188. package/src/models/DocumentDiff.ts +169 -0
  189. package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.ts} +19 -8
  190. package/src/models/ModelTableResult.ts +136 -0
  191. package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts} +25 -25
  192. package/src/models/PartType.ts +1 -0
  193. package/src/models/PixelRegion.ts +110 -0
  194. package/src/models/ReferenceType.ts +1 -0
  195. package/src/models/RevisionEdit.ts +125 -0
  196. package/src/models/SearchablePartType.ts +2 -0
  197. package/src/models/SheetVisibilityChange.ts +105 -0
  198. package/src/models/StructuredChange.ts +123 -0
  199. package/src/models/StructuredChangeType.ts +54 -0
  200. package/src/models/StructuredDiff.ts +140 -0
  201. package/src/models/TableCellChange.ts +129 -0
  202. package/src/models/VersionDiffResponse.ts +112 -1
  203. package/src/models/index.ts +19 -2
  204. package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
  205. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
@@ -0,0 +1,51 @@
1
+
2
+ # DocumentDiff
3
+
4
+ A structured block diff of two Word (.docx) versions. ``added``/``removed``/``modified`` are full totals; ``blocks`` is capped and ``omitted_blocks`` reports exactly how many were dropped (never a silent cap). ``surfaces_checked`` attests which OOXML surfaces were diffed, ``unaccepted_revisions`` counts tracked changes present (the rendered text may not be final), and ``decode_degraded`` flags a partial parse.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `blocks` | [Array<DocumentBlockChange>](DocumentBlockChange.md)
11
+ `added` | number
12
+ `removed` | number
13
+ `modified` | number
14
+ `truncated` | boolean
15
+ `omittedBlocks` | number
16
+ `surfacesChecked` | Array<string>
17
+ `unacceptedRevisions` | number
18
+ `decodeDegraded` | boolean
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import type { DocumentDiff } from '@knowledge-stack/ksapi'
24
+
25
+ // TODO: Update the object below with actual values
26
+ const example = {
27
+ "blocks": null,
28
+ "added": null,
29
+ "removed": null,
30
+ "modified": null,
31
+ "truncated": null,
32
+ "omittedBlocks": null,
33
+ "surfacesChecked": null,
34
+ "unacceptedRevisions": null,
35
+ "decodeDegraded": null,
36
+ } satisfies DocumentDiff
37
+
38
+ console.log(example)
39
+
40
+ // Convert the instance to a JSON string
41
+ const exampleJSON: string = JSON.stringify(example)
42
+ console.log(exampleJSON)
43
+
44
+ // Parse the JSON string back to an object
45
+ const exampleParsed = JSON.parse(exampleJSON) as DocumentDiff
46
+ console.log(exampleParsed)
47
+ ```
48
+
49
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
50
+
51
+
@@ -567,7 +567,7 @@ example().catch(console.error);
567
567
 
568
568
  Get Document Version Diff Handler
569
569
 
570
- Side-by-side diff of a version against a previous one of the same document. Diffs the two versions\' plaintext on the fly (no stored diff), so any pair of versions can be compared. ``from_version_id`` defaults to the immediate predecessor; the first version diffs against empty (all additions). Requires read permission on the document.
570
+ Side-by-side diff of a version against a previous one of the same document. Diffs the two versions on the fly (no stored diff), so any pair of versions can be compared. ``from_version_id`` defaults to the immediate predecessor; the first version diffs against empty (all additions). Requires read permission on both versions. Viewing a diff is a sensitive read, so it emits a ``document.diff.viewed`` audit event (a durable write on this GET, by design — like a download).
571
571
 
572
572
  ### Example
573
573
 
@@ -1,5 +1,5 @@
1
1
 
2
- # FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse
2
+ # FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
3
3
 
4
4
 
5
5
  ## Properties
@@ -51,8 +51,11 @@ Name | Type
51
51
  `runThreadId` | string
52
52
  `engine` | [DataSourceEngine](DataSourceEngine.md)
53
53
  `dataSourceId` | string
54
- `tableName` | string
55
54
  `schemaName` | string
55
+ `isDefault` | boolean
56
+ `tables` | [Array<DataSourceTableResponse>](DataSourceTableResponse.md)
57
+ `dataSourceSchemaId` | string
58
+ `tableName` | string
56
59
  `columnConfig` | Array<{ [key: string]: any; }>
57
60
  `baseUrl` | string
58
61
  `networkClass` | [NetworkClass](NetworkClass.md)
@@ -64,7 +67,7 @@ Name | Type
64
67
  ## Example
65
68
 
66
69
  ```typescript
67
- import type { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse } from '@knowledge-stack/ksapi'
70
+ import type { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse } from '@knowledge-stack/ksapi'
68
71
 
69
72
  // TODO: Update the object below with actual values
70
73
  const example = {
@@ -113,8 +116,11 @@ const example = {
113
116
  "runThreadId": null,
114
117
  "engine": null,
115
118
  "dataSourceId": null,
116
- "tableName": null,
117
119
  "schemaName": null,
120
+ "isDefault": null,
121
+ "tables": null,
122
+ "dataSourceSchemaId": null,
123
+ "tableName": null,
118
124
  "columnConfig": null,
119
125
  "baseUrl": null,
120
126
  "networkClass": null,
@@ -122,7 +128,7 @@ const example = {
122
128
  "apiDocs": null,
123
129
  "disclaimerAcceptedAt": null,
124
130
  "disclaimerAcceptedBy": null,
125
- } satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse
131
+ } satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
126
132
 
127
133
  console.log(example)
128
134
 
@@ -131,7 +137,7 @@ const exampleJSON: string = JSON.stringify(example)
131
137
  console.log(exampleJSON)
132
138
 
133
139
  // Parse the JSON string back to an object
134
- const exampleParsed = JSON.parse(exampleJSON) as FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse
140
+ const exampleParsed = JSON.parse(exampleJSON) as FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
135
141
  console.log(exampleParsed)
136
142
  ```
137
143
 
@@ -321,7 +321,7 @@ example().catch(console.error);
321
321
 
322
322
  ## listFolderContents
323
323
 
324
- > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset)
324
+ > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset)
325
325
 
326
326
  List Folder Contents Handler
327
327
 
@@ -387,7 +387,7 @@ example().catch(console.error);
387
387
 
388
388
  ### Return type
389
389
 
390
- [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
390
+ [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
391
391
 
392
392
  ### Authorization
393
393
 
@@ -516,7 +516,7 @@ example().catch(console.error);
516
516
 
517
517
  ## searchItems
518
518
 
519
- > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator searchItems(nameLike, sortOrder, partType, withTags, parentPathPartId, limit, offset)
519
+ > PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator searchItems(nameLike, sortOrder, partType, withTags, parentPathPartId, limit, offset)
520
520
 
521
521
  Search Items Handler
522
522
 
@@ -577,7 +577,7 @@ example().catch(console.error);
577
577
  |------------- | ------------- | ------------- | -------------|
578
578
  | **nameLike** | `string` | Case-insensitive partial name search | [Defaults to `undefined`] |
579
579
  | **sortOrder** | `SearchSortOrder` | Sort order for results (default: NAME) | [Optional] [Defaults to `undefined`] [Enum: NAME, UPDATED_AT, CREATED_AT] |
580
- | **partType** | `SearchablePartType` | Filter by item type (default: all searchable types) | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, API_CONNECTION] |
580
+ | **partType** | `SearchablePartType` | Filter by item type (default: all searchable types) | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_SCHEMA, DATA_SOURCE_TABLE, API_CONNECTION] |
581
581
  | **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
582
582
  | **parentPathPartId** | `string` | Scope search to descendants of this folder\'s path part | [Optional] [Defaults to `undefined`] |
583
583
  | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
@@ -585,7 +585,7 @@ example().catch(console.error);
585
585
 
586
586
  ### Return type
587
587
 
588
- [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
588
+ [**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
589
589
 
590
590
  ### Authorization
591
591
 
@@ -0,0 +1,43 @@
1
+
2
+ # ModelTableResult
3
+
4
+ Per-item outcome of a bulk table import.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `tableName` | string
11
+ `schemaName` | string
12
+ `status` | string
13
+ `table` | [DataSourceTableResponse](DataSourceTableResponse.md)
14
+ `error` | string
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { ModelTableResult } from '@knowledge-stack/ksapi'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "tableName": null,
24
+ "schemaName": null,
25
+ "status": null,
26
+ "table": null,
27
+ "error": null,
28
+ } satisfies ModelTableResult
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 ModelTableResult
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
+
@@ -1,12 +1,12 @@
1
1
 
2
- # PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator
2
+ # PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `items` | [Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse>](FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md)
9
+ `items` | [Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse>](FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md)
10
10
  `total` | number
11
11
  `limit` | number
12
12
  `offset` | number
@@ -14,7 +14,7 @@ Name | Type
14
14
  ## Example
15
15
 
16
16
  ```typescript
17
- import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator } from '@knowledge-stack/ksapi'
17
+ import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator } from '@knowledge-stack/ksapi'
18
18
 
19
19
  // TODO: Update the object below with actual values
20
20
  const example = {
@@ -22,7 +22,7 @@ const example = {
22
22
  "total": null,
23
23
  "limit": null,
24
24
  "offset": null,
25
- } satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator
25
+ } satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator
26
26
 
27
27
  console.log(example)
28
28
 
@@ -31,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
31
31
  console.log(exampleJSON)
32
32
 
33
33
  // Parse the JSON string back to an object
34
- const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator
34
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator
35
35
  console.log(exampleParsed)
36
36
  ```
37
37
 
@@ -0,0 +1,41 @@
1
+
2
+ # PixelRegion
3
+
4
+ A changed rectangle within an image, in the new image\'s pixel space.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `x` | number
11
+ `y` | number
12
+ `width` | number
13
+ `height` | number
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { PixelRegion } from '@knowledge-stack/ksapi'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "x": null,
23
+ "y": null,
24
+ "width": null,
25
+ "height": null,
26
+ } satisfies PixelRegion
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as PixelRegion
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # RevisionEdit
3
+
4
+ One tracked (un-accepted) change in a paragraph — the redline evidence. ``type`` is ``added`` for an insertion (``w:ins``) and ``removed`` for a deletion (``w:del``). ``author``/``date`` are the proposer and timestamp the editor recorded (may be null). A block carries these so an auditor sees who proposed what, and so finalizing a pending change is never invisible.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `type` | [BlockChangeType](BlockChangeType.md)
11
+ `author` | string
12
+ `date` | string
13
+ `text` | string
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { RevisionEdit } from '@knowledge-stack/ksapi'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "type": null,
23
+ "author": null,
24
+ "date": null,
25
+ "text": null,
26
+ } satisfies RevisionEdit
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as RevisionEdit
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,39 @@
1
+
2
+ # SheetVisibilityChange
3
+
4
+ A worksheet that became hidden or visible. Hidden data is an audit red flag (a sheet quietly hidden between versions), so a ``visible``↔``hidden``/``veryHidden`` transition is surfaced. ``old_state``/ ``new_state`` is null when the sheet was added or removed.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `sheet` | string
11
+ `oldState` | string
12
+ `newState` | string
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { SheetVisibilityChange } from '@knowledge-stack/ksapi'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "sheet": null,
22
+ "oldState": null,
23
+ "newState": null,
24
+ } satisfies SheetVisibilityChange
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as SheetVisibilityChange
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -0,0 +1,41 @@
1
+
2
+ # StructuredChange
3
+
4
+ One changed key-path in a JSON/YAML document. ``path`` is a dotted/indexed locator like ``services.web.image`` or ``items[3].qty``. ``old`` is null for added, ``new`` is null for removed.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `path` | string
11
+ `old` | string
12
+ `_new` | string
13
+ `type` | [StructuredChangeType](StructuredChangeType.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { StructuredChange } from '@knowledge-stack/ksapi'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "path": null,
23
+ "old": null,
24
+ "_new": null,
25
+ "type": null,
26
+ } satisfies StructuredChange
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as StructuredChange
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,32 @@
1
+
2
+ # StructuredChangeType
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import type { StructuredChangeType } from '@knowledge-stack/ksapi'
14
+
15
+ // TODO: Update the object below with actual values
16
+ const example = {
17
+ } satisfies StructuredChangeType
18
+
19
+ console.log(example)
20
+
21
+ // Convert the instance to a JSON string
22
+ const exampleJSON: string = JSON.stringify(example)
23
+ console.log(exampleJSON)
24
+
25
+ // Parse the JSON string back to an object
26
+ const exampleParsed = JSON.parse(exampleJSON) as StructuredChangeType
27
+ console.log(exampleParsed)
28
+ ```
29
+
30
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
31
+
32
+
@@ -0,0 +1,45 @@
1
+
2
+ # StructuredDiff
3
+
4
+ A key-path diff of two JSON/YAML versions. ``added``/``removed``/``modified`` are full totals; ``changes`` is capped at the engine limit and ``omitted`` reports exactly how many were dropped, so a truncated diff never silently hides a change.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `changes` | [Array<StructuredChange>](StructuredChange.md)
11
+ `added` | number
12
+ `removed` | number
13
+ `modified` | number
14
+ `truncated` | boolean
15
+ `omitted` | number
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import type { StructuredDiff } from '@knowledge-stack/ksapi'
21
+
22
+ // TODO: Update the object below with actual values
23
+ const example = {
24
+ "changes": null,
25
+ "added": null,
26
+ "removed": null,
27
+ "modified": null,
28
+ "truncated": null,
29
+ "omitted": null,
30
+ } satisfies StructuredDiff
31
+
32
+ console.log(example)
33
+
34
+ // Convert the instance to a JSON string
35
+ const exampleJSON: string = JSON.stringify(example)
36
+ console.log(exampleJSON)
37
+
38
+ // Parse the JSON string back to an object
39
+ const exampleParsed = JSON.parse(exampleJSON) as StructuredDiff
40
+ console.log(exampleParsed)
41
+ ```
42
+
43
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
44
+
45
+
@@ -0,0 +1,43 @@
1
+
2
+ # TableCellChange
3
+
4
+ One changed table cell (``old`` null for added, ``new`` for removed).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `row` | number
11
+ `col` | number
12
+ `type` | [BlockChangeType](BlockChangeType.md)
13
+ `old` | string
14
+ `_new` | string
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { TableCellChange } from '@knowledge-stack/ksapi'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "row": null,
24
+ "col": null,
25
+ "type": null,
26
+ "old": null,
27
+ "_new": null,
28
+ } satisfies TableCellChange
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 TableCellChange
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
+
@@ -1,7 +1,7 @@
1
1
 
2
2
  # VersionDiffResponse
3
3
 
4
- The diff between two document versions. ``format`` selects the populated payload: ``text`` (side-by-side line diff, for Word/PDF/text) or ``cells`` (cell-level diff, for spreadsheets).
4
+ The diff between two document versions. ``format`` selects the populated payload: ``text`` (side-by-side line diff, for PDF/Markdown/text), ``cells`` (cell-level diff, for spreadsheets), ``structured`` (key-path diff, for JSON/YAML), or ``document`` (structured block diff, for Word .docx).
5
5
 
6
6
  ## Properties
7
7
 
@@ -14,6 +14,17 @@ Name | Type
14
14
  `format` | [DiffFormat](DiffFormat.md)
15
15
  `text` | [TextDiff](TextDiff.md)
16
16
  `cells` | [CellDiff](CellDiff.md)
17
+ `structured` | [StructuredDiff](StructuredDiff.md)
18
+ `document` | [DocumentDiff](DocumentDiff.md)
19
+ `degraded` | boolean
20
+ `degradedReason` | string
21
+ `algorithmVersion` | string
22
+ `fromContentHash` | string
23
+ `toContentHash` | string
24
+ `fromUploader` | [UserInfo](UserInfo.md)
25
+ `toUploader` | [UserInfo](UserInfo.md)
26
+ `fromUploadedAt` | Date
27
+ `toUploadedAt` | Date
17
28
 
18
29
  ## Example
19
30
 
@@ -29,6 +40,17 @@ const example = {
29
40
  "format": null,
30
41
  "text": null,
31
42
  "cells": null,
43
+ "structured": null,
44
+ "document": null,
45
+ "degraded": null,
46
+ "degradedReason": null,
47
+ "algorithmVersion": null,
48
+ "fromContentHash": null,
49
+ "toContentHash": null,
50
+ "fromUploader": null,
51
+ "toUploader": null,
52
+ "fromUploadedAt": null,
53
+ "toUploadedAt": null,
32
54
  } satisfies VersionDiffResponse
33
55
 
34
56
  console.log(example)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowledge-stack/ksapi",
3
- "version": "1.118.0",
3
+ "version": "1.119.0",
4
4
  "description": "OpenAPI client for @knowledge-stack/ksapi",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {