@knowledge-stack/ksapi 1.118.0 → 1.120.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +44 -4
- package/README.md +28 -4
- package/dist/apis/DataSourcesApi.d.ts +170 -9
- package/dist/apis/DataSourcesApi.js +207 -4
- package/dist/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/apis/DocumentVersionsApi.js +2 -2
- package/dist/apis/FoldersApi.d.ts +9 -9
- package/dist/apis/FoldersApi.js +2 -2
- package/dist/esm/apis/DataSourcesApi.d.ts +170 -9
- package/dist/esm/apis/DataSourcesApi.js +208 -5
- package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/esm/apis/DocumentVersionsApi.js +2 -2
- package/dist/esm/apis/FoldersApi.d.ts +9 -9
- package/dist/esm/apis/FoldersApi.js +3 -3
- package/dist/esm/models/BlockChangeType.d.ts +26 -0
- package/dist/esm/models/BlockChangeType.js +44 -0
- package/dist/esm/models/BlockKind.d.ts +28 -0
- package/dist/esm/models/BlockKind.js +46 -0
- package/dist/esm/models/BulkModelTablesRequest.d.ts +48 -0
- package/dist/esm/models/BulkModelTablesRequest.js +50 -0
- package/dist/esm/models/BulkModelTablesResponse.d.ts +48 -0
- package/dist/esm/models/BulkModelTablesResponse.js +45 -0
- package/dist/esm/models/CellChange.d.ts +47 -0
- package/dist/esm/models/CellChange.js +14 -0
- package/dist/esm/models/CellDiff.d.ts +7 -0
- package/dist/esm/models/CellDiff.js +5 -0
- package/dist/esm/models/ChangeClass.d.ts +29 -0
- package/dist/esm/models/ChangeClass.js +47 -0
- package/dist/esm/models/CommonFileExclusionReason.d.ts +29 -0
- package/dist/esm/models/CommonFileExclusionReason.js +47 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.js +6 -0
- package/dist/esm/models/DataSourceDescriptionResponse.d.ts +53 -0
- package/dist/esm/models/DataSourceDescriptionResponse.js +48 -0
- package/dist/esm/models/DataSourceDetailResponse.d.ts +13 -4
- package/dist/esm/models/DataSourceDetailResponse.js +6 -4
- package/dist/esm/models/DataSourceSchemaListItem.d.ts +53 -0
- package/dist/esm/models/DataSourceSchemaListItem.js +48 -0
- package/dist/esm/models/DataSourceSchemaListResponse.d.ts +3 -3
- package/dist/esm/models/DataSourceSchemaListResponse.js +3 -3
- package/dist/esm/models/DataSourceSchemaResponse.d.ts +95 -1
- package/dist/esm/models/DataSourceSchemaResponse.js +61 -0
- package/dist/esm/models/DataSourceTableResponse.d.ts +8 -5
- package/dist/esm/models/DataSourceTableResponse.js +4 -2
- package/dist/esm/models/DiffFormat.d.ts +2 -0
- package/dist/esm/models/DiffFormat.js +3 -1
- package/dist/esm/models/DocumentBlockChange.d.ts +174 -0
- package/dist/esm/models/DocumentBlockChange.js +97 -0
- package/dist/esm/models/DocumentDiff.d.ts +102 -0
- package/dist/esm/models/DocumentDiff.js +77 -0
- package/dist/esm/models/ExcludedCommonFile.d.ts +58 -0
- package/dist/esm/models/ExcludedCommonFile.js +49 -0
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +11 -6
- package/dist/esm/models/InputOrigin.d.ts +30 -0
- package/dist/esm/models/InputOrigin.js +48 -0
- package/dist/esm/models/InputSnapshot.d.ts +7 -0
- package/dist/esm/models/InputSnapshot.js +3 -0
- package/dist/esm/models/ModelTableResult.d.ts +81 -0
- package/dist/esm/models/ModelTableResult.js +63 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
- package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +12 -12
- package/dist/esm/models/PartType.d.ts +1 -0
- package/dist/esm/models/PartType.js +1 -0
- package/dist/esm/models/PixelRegion.d.ts +65 -0
- package/dist/esm/models/PixelRegion.js +56 -0
- package/dist/esm/models/ReferenceType.d.ts +1 -0
- package/dist/esm/models/ReferenceType.js +1 -0
- package/dist/esm/models/RevisionEdit.d.ts +71 -0
- package/dist/esm/models/RevisionEdit.js +57 -0
- package/dist/esm/models/SearchablePartType.d.ts +2 -0
- package/dist/esm/models/SearchablePartType.js +2 -0
- package/dist/esm/models/SheetVisibilityChange.d.ts +63 -0
- package/dist/esm/models/SheetVisibilityChange.js +52 -0
- package/dist/esm/models/StructuredChange.d.ts +69 -0
- package/dist/esm/models/StructuredChange.js +57 -0
- package/dist/esm/models/StructuredChangeType.d.ts +26 -0
- package/dist/esm/models/StructuredChangeType.js +44 -0
- package/dist/esm/models/StructuredDiff.d.ts +82 -0
- package/dist/esm/models/StructuredDiff.js +65 -0
- package/dist/esm/models/TableCellChange.d.ts +72 -0
- package/dist/esm/models/TableCellChange.js +61 -0
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +6 -0
- package/dist/esm/models/VersionDiffResponse.d.ts +72 -1
- package/dist/esm/models/VersionDiffResponse.js +25 -0
- package/dist/esm/models/WorkflowDefinitionResponse.d.ts +6 -0
- package/dist/esm/models/WorkflowDefinitionResponse.js +2 -0
- package/dist/esm/models/WorkflowRunResponse.d.ts +7 -0
- package/dist/esm/models/WorkflowRunResponse.js +3 -0
- package/dist/esm/models/WorkflowRunSnapshot.d.ts +7 -0
- package/dist/esm/models/WorkflowRunSnapshot.js +3 -0
- package/dist/esm/models/index.d.ts +22 -2
- package/dist/esm/models/index.js +22 -2
- package/dist/models/BlockChangeType.d.ts +26 -0
- package/dist/models/BlockChangeType.js +52 -0
- package/dist/models/BlockKind.d.ts +28 -0
- package/dist/models/BlockKind.js +54 -0
- package/dist/models/BulkModelTablesRequest.d.ts +48 -0
- package/dist/models/BulkModelTablesRequest.js +58 -0
- package/dist/models/BulkModelTablesResponse.d.ts +48 -0
- package/dist/models/BulkModelTablesResponse.js +53 -0
- package/dist/models/CellChange.d.ts +47 -0
- package/dist/models/CellChange.js +14 -0
- package/dist/models/CellDiff.d.ts +7 -0
- package/dist/models/CellDiff.js +5 -0
- package/dist/models/ChangeClass.d.ts +29 -0
- package/dist/models/ChangeClass.js +55 -0
- package/dist/models/CommonFileExclusionReason.d.ts +29 -0
- package/dist/models/CommonFileExclusionReason.js +55 -0
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/models/CreateWorkflowDefinitionRequest.js +6 -0
- package/dist/models/DataSourceDescriptionResponse.d.ts +53 -0
- package/dist/models/DataSourceDescriptionResponse.js +56 -0
- package/dist/models/DataSourceDetailResponse.d.ts +13 -4
- package/dist/models/DataSourceDetailResponse.js +6 -4
- package/dist/models/DataSourceSchemaListItem.d.ts +53 -0
- package/dist/models/DataSourceSchemaListItem.js +56 -0
- package/dist/models/DataSourceSchemaListResponse.d.ts +3 -3
- package/dist/models/DataSourceSchemaListResponse.js +3 -3
- package/dist/models/DataSourceSchemaResponse.d.ts +95 -1
- package/dist/models/DataSourceSchemaResponse.js +62 -1
- package/dist/models/DataSourceTableResponse.d.ts +8 -5
- package/dist/models/DataSourceTableResponse.js +4 -2
- package/dist/models/DiffFormat.d.ts +2 -0
- package/dist/models/DiffFormat.js +3 -1
- package/dist/models/DocumentBlockChange.d.ts +174 -0
- package/dist/models/DocumentBlockChange.js +105 -0
- package/dist/models/DocumentDiff.d.ts +102 -0
- package/dist/models/DocumentDiff.js +85 -0
- package/dist/models/ExcludedCommonFile.d.ts +58 -0
- package/dist/models/ExcludedCommonFile.js +57 -0
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +15 -10
- package/dist/models/InputOrigin.d.ts +30 -0
- package/dist/models/InputOrigin.js +56 -0
- package/dist/models/InputSnapshot.d.ts +7 -0
- package/dist/models/InputSnapshot.js +3 -0
- package/dist/models/ModelTableResult.d.ts +81 -0
- package/dist/models/ModelTableResult.js +71 -0
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
- package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +18 -18
- package/dist/models/PartType.d.ts +1 -0
- package/dist/models/PartType.js +1 -0
- package/dist/models/PixelRegion.d.ts +65 -0
- package/dist/models/PixelRegion.js +64 -0
- package/dist/models/ReferenceType.d.ts +1 -0
- package/dist/models/ReferenceType.js +1 -0
- package/dist/models/RevisionEdit.d.ts +71 -0
- package/dist/models/RevisionEdit.js +65 -0
- package/dist/models/SearchablePartType.d.ts +2 -0
- package/dist/models/SearchablePartType.js +2 -0
- package/dist/models/SheetVisibilityChange.d.ts +63 -0
- package/dist/models/SheetVisibilityChange.js +60 -0
- package/dist/models/StructuredChange.d.ts +69 -0
- package/dist/models/StructuredChange.js +65 -0
- package/dist/models/StructuredChangeType.d.ts +26 -0
- package/dist/models/StructuredChangeType.js +52 -0
- package/dist/models/StructuredDiff.d.ts +82 -0
- package/dist/models/StructuredDiff.js +73 -0
- package/dist/models/TableCellChange.d.ts +72 -0
- package/dist/models/TableCellChange.js +69 -0
- package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +6 -0
- package/dist/models/UpdateWorkflowDefinitionRequest.js +6 -0
- package/dist/models/VersionDiffResponse.d.ts +72 -1
- package/dist/models/VersionDiffResponse.js +25 -0
- package/dist/models/WorkflowDefinitionResponse.d.ts +6 -0
- package/dist/models/WorkflowDefinitionResponse.js +2 -0
- package/dist/models/WorkflowRunResponse.d.ts +7 -0
- package/dist/models/WorkflowRunResponse.js +3 -0
- package/dist/models/WorkflowRunSnapshot.d.ts +7 -0
- package/dist/models/WorkflowRunSnapshot.js +3 -0
- package/dist/models/index.d.ts +22 -2
- package/dist/models/index.js +22 -2
- package/docs/BlockChangeType.md +32 -0
- package/docs/BlockKind.md +32 -0
- package/docs/BulkModelTablesRequest.md +35 -0
- package/docs/BulkModelTablesResponse.md +35 -0
- package/docs/CellChange.md +15 -1
- package/docs/CellDiff.md +2 -0
- package/docs/ChangeClass.md +33 -0
- package/docs/ChunksApi.md +1 -1
- package/docs/CommonFileExclusionReason.md +33 -0
- package/docs/CreateWorkflowDefinitionRequest.md +2 -0
- package/docs/DataSourceDescriptionResponse.md +37 -0
- package/docs/DataSourceDetailResponse.md +5 -3
- package/docs/DataSourceSchemaListItem.md +37 -0
- package/docs/DataSourceSchemaListResponse.md +1 -1
- package/docs/DataSourceSchemaResponse.md +29 -0
- package/docs/DataSourceTableResponse.md +3 -3
- package/docs/DataSourcesApi.md +315 -2
- package/docs/DocumentBlockChange.md +73 -0
- package/docs/DocumentDiff.md +51 -0
- package/docs/DocumentVersionsApi.md +1 -1
- package/docs/ExcludedCommonFile.md +37 -0
- package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md} +16 -6
- package/docs/FoldersApi.md +5 -5
- package/docs/InputOrigin.md +33 -0
- package/docs/InputSnapshot.md +2 -0
- package/docs/ModelTableResult.md +43 -0
- package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md} +5 -5
- package/docs/PixelRegion.md +41 -0
- package/docs/RevisionEdit.md +41 -0
- package/docs/SheetVisibilityChange.md +39 -0
- package/docs/StructuredChange.md +41 -0
- package/docs/StructuredChangeType.md +32 -0
- package/docs/StructuredDiff.md +45 -0
- package/docs/TableCellChange.md +43 -0
- package/docs/UpdateWorkflowDefinitionRequest.md +2 -0
- package/docs/VersionDiffResponse.md +23 -1
- package/docs/WorkflowDefinitionResponse.md +2 -0
- package/docs/WorkflowRunResponse.md +2 -0
- package/docs/WorkflowRunSnapshot.md +2 -0
- package/package.json +1 -1
- package/src/apis/DataSourcesApi.ts +382 -8
- package/src/apis/DocumentVersionsApi.ts +4 -4
- package/src/apis/FoldersApi.ts +13 -13
- package/src/models/BlockChangeType.ts +54 -0
- package/src/models/BlockKind.ts +56 -0
- package/src/models/BulkModelTablesRequest.ts +95 -0
- package/src/models/BulkModelTablesResponse.ts +91 -0
- package/src/models/CellChange.ts +61 -0
- package/src/models/CellDiff.ts +16 -0
- package/src/models/ChangeClass.ts +57 -0
- package/src/models/CommonFileExclusionReason.ts +57 -0
- package/src/models/CreateWorkflowDefinitionRequest.ts +12 -0
- package/src/models/DataSourceDescriptionResponse.ts +92 -0
- package/src/models/DataSourceDetailResponse.ts +24 -13
- package/src/models/DataSourceSchemaListItem.ts +92 -0
- package/src/models/DataSourceSchemaListResponse.ts +10 -10
- package/src/models/DataSourceSchemaResponse.ts +157 -1
- package/src/models/DataSourceTableResponse.ts +11 -7
- package/src/models/DiffFormat.ts +3 -1
- package/src/models/DocumentBlockChange.ts +297 -0
- package/src/models/DocumentDiff.ts +169 -0
- package/src/models/ExcludedCommonFile.ts +106 -0
- package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.ts} +19 -8
- package/src/models/InputOrigin.ts +58 -0
- package/src/models/InputSnapshot.ts +16 -0
- package/src/models/ModelTableResult.ts +136 -0
- package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts} +25 -25
- package/src/models/PartType.ts +1 -0
- package/src/models/PixelRegion.ts +110 -0
- package/src/models/ReferenceType.ts +1 -0
- package/src/models/RevisionEdit.ts +125 -0
- package/src/models/SearchablePartType.ts +2 -0
- package/src/models/SheetVisibilityChange.ts +105 -0
- package/src/models/StructuredChange.ts +123 -0
- package/src/models/StructuredChangeType.ts +54 -0
- package/src/models/StructuredDiff.ts +140 -0
- package/src/models/TableCellChange.ts +129 -0
- package/src/models/UpdateWorkflowDefinitionRequest.ts +12 -0
- package/src/models/VersionDiffResponse.ts +112 -1
- package/src/models/WorkflowDefinitionResponse.ts +8 -0
- package/src/models/WorkflowRunResponse.ts +15 -0
- package/src/models/WorkflowRunSnapshot.ts +15 -0
- package/src/models/index.ts +22 -2
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -32,6 +32,7 @@ Name | Type
|
|
|
32
32
|
`isActive` | boolean
|
|
33
33
|
`approvalRequired` | boolean
|
|
34
34
|
`isTemplate` | boolean
|
|
35
|
+
`commonFilePathPartIds` | Array<string>
|
|
35
36
|
`createdFromId` | string
|
|
36
37
|
`copyCount` | number
|
|
37
38
|
`workflowDefinitionId` | string
|
|
@@ -48,11 +49,15 @@ Name | Type
|
|
|
48
49
|
`discussionsPathPartId` | string
|
|
49
50
|
`inputPathPartIds` | Array<string>
|
|
50
51
|
`outputsPathPartIds` | Array<string>
|
|
52
|
+
`excludedCommonFiles` | [Array<ExcludedCommonFile>](ExcludedCommonFile.md)
|
|
51
53
|
`runThreadId` | string
|
|
52
54
|
`engine` | [DataSourceEngine](DataSourceEngine.md)
|
|
53
55
|
`dataSourceId` | string
|
|
54
|
-
`tableName` | string
|
|
55
56
|
`schemaName` | string
|
|
57
|
+
`isDefault` | boolean
|
|
58
|
+
`tables` | [Array<DataSourceTableResponse>](DataSourceTableResponse.md)
|
|
59
|
+
`dataSourceSchemaId` | string
|
|
60
|
+
`tableName` | string
|
|
56
61
|
`columnConfig` | Array<{ [key: string]: any; }>
|
|
57
62
|
`baseUrl` | string
|
|
58
63
|
`networkClass` | [NetworkClass](NetworkClass.md)
|
|
@@ -64,7 +69,7 @@ Name | Type
|
|
|
64
69
|
## Example
|
|
65
70
|
|
|
66
71
|
```typescript
|
|
67
|
-
import type {
|
|
72
|
+
import type { FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse } from '@knowledge-stack/ksapi'
|
|
68
73
|
|
|
69
74
|
// TODO: Update the object below with actual values
|
|
70
75
|
const example = {
|
|
@@ -94,6 +99,7 @@ const example = {
|
|
|
94
99
|
"isActive": null,
|
|
95
100
|
"approvalRequired": null,
|
|
96
101
|
"isTemplate": null,
|
|
102
|
+
"commonFilePathPartIds": null,
|
|
97
103
|
"createdFromId": null,
|
|
98
104
|
"copyCount": null,
|
|
99
105
|
"workflowDefinitionId": null,
|
|
@@ -110,11 +116,15 @@ const example = {
|
|
|
110
116
|
"discussionsPathPartId": null,
|
|
111
117
|
"inputPathPartIds": null,
|
|
112
118
|
"outputsPathPartIds": null,
|
|
119
|
+
"excludedCommonFiles": null,
|
|
113
120
|
"runThreadId": null,
|
|
114
121
|
"engine": null,
|
|
115
122
|
"dataSourceId": null,
|
|
116
|
-
"tableName": null,
|
|
117
123
|
"schemaName": null,
|
|
124
|
+
"isDefault": null,
|
|
125
|
+
"tables": null,
|
|
126
|
+
"dataSourceSchemaId": null,
|
|
127
|
+
"tableName": null,
|
|
118
128
|
"columnConfig": null,
|
|
119
129
|
"baseUrl": null,
|
|
120
130
|
"networkClass": null,
|
|
@@ -122,7 +132,7 @@ const example = {
|
|
|
122
132
|
"apiDocs": null,
|
|
123
133
|
"disclaimerAcceptedAt": null,
|
|
124
134
|
"disclaimerAcceptedBy": null,
|
|
125
|
-
} satisfies
|
|
135
|
+
} satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
|
|
126
136
|
|
|
127
137
|
console.log(example)
|
|
128
138
|
|
|
@@ -131,7 +141,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
131
141
|
console.log(exampleJSON)
|
|
132
142
|
|
|
133
143
|
// Parse the JSON string back to an object
|
|
134
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
144
|
+
const exampleParsed = JSON.parse(exampleJSON) as FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse
|
|
135
145
|
console.log(exampleParsed)
|
|
136
146
|
```
|
|
137
147
|
|
package/docs/FoldersApi.md
CHANGED
|
@@ -321,7 +321,7 @@ example().catch(console.error);
|
|
|
321
321
|
|
|
322
322
|
## listFolderContents
|
|
323
323
|
|
|
324
|
-
>
|
|
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
|
-
[**
|
|
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
|
-
>
|
|
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
|
-
[**
|
|
588
|
+
[**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md)
|
|
589
589
|
|
|
590
590
|
### Authorization
|
|
591
591
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# InputOrigin
|
|
3
|
+
|
|
4
|
+
Where a run-snapshot input came from, for auditability. A run\'s pinned inputs are merged from three sources at Start; this tags each so an auditor / the FE can tell a definition-mandated common file apart from a file the run\'s creator chose.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { InputOrigin } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies InputOrigin
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as InputOrigin
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
package/docs/InputSnapshot.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`pathPartId` | string
|
|
11
11
|
`materializedPath` | string
|
|
12
12
|
`partType` | string
|
|
13
|
+
`origin` | [InputOrigin](InputOrigin.md)
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -21,6 +22,7 @@ const example = {
|
|
|
21
22
|
"pathPartId": null,
|
|
22
23
|
"materializedPath": null,
|
|
23
24
|
"partType": null,
|
|
25
|
+
"origin": null,
|
|
24
26
|
} satisfies InputSnapshot
|
|
25
27
|
|
|
26
28
|
console.log(example)
|
|
@@ -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
|
-
#
|
|
2
|
+
# PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`items` | [Array<
|
|
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 {
|
|
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
|
|
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
|
|
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
|
+
|
|
@@ -14,6 +14,7 @@ Name | Type
|
|
|
14
14
|
`parentPathPartId` | string
|
|
15
15
|
`isActive` | boolean
|
|
16
16
|
`approvalRequired` | boolean
|
|
17
|
+
`commonFilePathPartIds` | Array<string>
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -29,6 +30,7 @@ const example = {
|
|
|
29
30
|
"parentPathPartId": null,
|
|
30
31
|
"isActive": null,
|
|
31
32
|
"approvalRequired": null,
|
|
33
|
+
"commonFilePathPartIds": null,
|
|
32
34
|
} satisfies UpdateWorkflowDefinitionRequest
|
|
33
35
|
|
|
34
36
|
console.log(example)
|
|
@@ -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
|
|
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)
|
|
@@ -20,6 +20,7 @@ Name | Type
|
|
|
20
20
|
`isActive` | boolean
|
|
21
21
|
`approvalRequired` | boolean
|
|
22
22
|
`isTemplate` | boolean
|
|
23
|
+
`commonFilePathPartIds` | Array<string>
|
|
23
24
|
`createdFromId` | string
|
|
24
25
|
`copyCount` | number
|
|
25
26
|
`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
|
|
@@ -48,6 +49,7 @@ const example = {
|
|
|
48
49
|
"isActive": null,
|
|
49
50
|
"approvalRequired": null,
|
|
50
51
|
"isTemplate": null,
|
|
52
|
+
"commonFilePathPartIds": null,
|
|
51
53
|
"createdFromId": null,
|
|
52
54
|
"copyCount": null,
|
|
53
55
|
"approvalState": null,
|
|
@@ -29,6 +29,7 @@ Name | Type
|
|
|
29
29
|
`discussionsPathPartId` | string
|
|
30
30
|
`inputPathPartIds` | Array<string>
|
|
31
31
|
`outputsPathPartIds` | Array<string>
|
|
32
|
+
`excludedCommonFiles` | [Array<ExcludedCommonFile>](ExcludedCommonFile.md)
|
|
32
33
|
`runThreadId` | string
|
|
33
34
|
`owner` | [UserInfo](UserInfo.md)
|
|
34
35
|
`createdAt` | Date
|
|
@@ -64,6 +65,7 @@ const example = {
|
|
|
64
65
|
"discussionsPathPartId": null,
|
|
65
66
|
"inputPathPartIds": null,
|
|
66
67
|
"outputsPathPartIds": null,
|
|
68
|
+
"excludedCommonFiles": null,
|
|
67
69
|
"runThreadId": null,
|
|
68
70
|
"owner": null,
|
|
69
71
|
"createdAt": null,
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`maxRunDurationSeconds` | number
|
|
12
12
|
`instruction` | [InstructionSnapshot](InstructionSnapshot.md)
|
|
13
13
|
`inputs` | [Array<InputSnapshot>](InputSnapshot.md)
|
|
14
|
+
`excludedCommonFiles` | [Array<ExcludedCommonFile>](ExcludedCommonFile.md)
|
|
14
15
|
`userMessage` | string
|
|
15
16
|
|
|
16
17
|
## Example
|
|
@@ -24,6 +25,7 @@ const example = {
|
|
|
24
25
|
"maxRunDurationSeconds": null,
|
|
25
26
|
"instruction": null,
|
|
26
27
|
"inputs": null,
|
|
28
|
+
"excludedCommonFiles": null,
|
|
27
29
|
"userMessage": null,
|
|
28
30
|
} satisfies WorkflowRunSnapshot
|
|
29
31
|
|