@knowledge-stack/ksapi 1.117.0 → 1.119.0

package/docs/InputSnapshot.md

@@ -1,7 +1,7 @@
 
 # InputSnapshot
 
-One entry of a run\'s input scope, self-describing its pin semantics.  ``part_type`` is the kind discriminator:  * ``DOCUMENT_VERSION`` — a pinned document version. The DOCUMENT in   the request scope was resolved to its active version at trigger   time; ``path_part_id`` is that DOCUMENT_VERSION path_part and the   entry does not float. * ``FOLDER`` — a live folder reference. ``path_part_id`` is the   FOLDER path_part itself; its contents are NOT captured here and   are enumerated live by the runner (see ``materialized_path`` for   subtree scoping).  The underlying PDO id (DocumentVersion or Folder) is resolved live at run time from ``path_part.metadata_obj_id``, not stored here.
+One entry of a run\'s input scope, self-describing its pin semantics.  ``part_type`` is the kind discriminator:  * ``DOCUMENT_VERSION`` — a pinned document version. The DOCUMENT in   the request scope was resolved to its active version at trigger   time; ``path_part_id`` is that DOCUMENT_VERSION path_part and the   entry does not float. * ``FOLDER`` — a live folder reference. ``path_part_id`` is the   FOLDER path_part itself; its contents are NOT captured here and   are enumerated live by the runner (see ``materialized_path`` for   subtree scoping). * ``DATA_SOURCE`` / ``API_CONNECTION`` — a live connector reference   (DB / API). ``path_part_id`` is the connector path_part itself; the   runner queries it live via its connector tools, nothing is captured   here.  The underlying PDO id (DocumentVersion / Folder / connector) is resolved live at run time from ``path_part.metadata_obj_id``, not stored here.
 
 ## Properties
 

package/docs/ModelTableResult.md

@@ -0,0 +1,43 @@
+
+# ModelTableResult
+
+Per-item outcome of a bulk table import.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tableName` | string
+`schemaName` | string
+`status` | string
+`table` | [DataSourceTableResponse](DataSourceTableResponse.md)
+`error` | string
+
+## Example
+
+```typescript
+import type { ModelTableResult } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tableName": null,
+  "schemaName": null,
+  "status": null,
+  "table": null,
+  "error": null,
+} satisfies ModelTableResult
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ModelTableResult
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md}

@@ -1,12 +1,12 @@
 
-# PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator
+# PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`items` | [Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse>](FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md)
+`items` | [Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse>](FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md)
 `total` | number
 `limit` | number
 `offset` | number
@@ -14,7 +14,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator } from '@knowledge-stack/ksapi'
+import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -22,7 +22,7 @@ const example = {
   "total": null,
   "limit": null,
   "offset": null,
-} satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator
+} satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator
 
 console.log(example)
 
@@ -31,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator
 console.log(exampleParsed)
 ```
 

package/docs/PixelRegion.md

@@ -0,0 +1,41 @@
+
+# PixelRegion
+
+A changed rectangle within an image, in the new image\'s pixel space.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`x` | number
+`y` | number
+`width` | number
+`height` | number
+
+## Example
+
+```typescript
+import type { PixelRegion } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "x": null,
+  "y": null,
+  "width": null,
+  "height": null,
+} satisfies PixelRegion
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PixelRegion
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RevisionEdit.md

@@ -0,0 +1,41 @@
+
+# RevisionEdit
+
+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.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | [BlockChangeType](BlockChangeType.md)
+`author` | string
+`date` | string
+`text` | string
+
+## Example
+
+```typescript
+import type { RevisionEdit } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "author": null,
+  "date": null,
+  "text": null,
+} satisfies RevisionEdit
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RevisionEdit
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SheetVisibilityChange.md

@@ -0,0 +1,39 @@
+
+# SheetVisibilityChange
+
+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.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sheet` | string
+`oldState` | string
+`newState` | string
+
+## Example
+
+```typescript
+import type { SheetVisibilityChange } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sheet": null,
+  "oldState": null,
+  "newState": null,
+} satisfies SheetVisibilityChange
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SheetVisibilityChange
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/StructuredChange.md

@@ -0,0 +1,41 @@
+
+# StructuredChange
+
+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.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+`old` | string
+`_new` | string
+`type` | [StructuredChangeType](StructuredChangeType.md)
+
+## Example
+
+```typescript
+import type { StructuredChange } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "old": null,
+  "_new": null,
+  "type": null,
+} satisfies StructuredChange
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as StructuredChange
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/StructuredChangeType.md

@@ -0,0 +1,32 @@
+
+# StructuredChangeType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { StructuredChangeType } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies StructuredChangeType
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as StructuredChangeType
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/StructuredDiff.md

@@ -0,0 +1,45 @@
+
+# StructuredDiff
+
+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.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`changes` | [Array<StructuredChange>](StructuredChange.md)
+`added` | number
+`removed` | number
+`modified` | number
+`truncated` | boolean
+`omitted` | number
+
+## Example
+
+```typescript
+import type { StructuredDiff } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "changes": null,
+  "added": null,
+  "removed": null,
+  "modified": null,
+  "truncated": null,
+  "omitted": null,
+} satisfies StructuredDiff
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as StructuredDiff
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TableCellChange.md

@@ -0,0 +1,43 @@
+
+# TableCellChange
+
+One changed table cell (``old`` null for added, ``new`` for removed).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`row` | number
+`col` | number
+`type` | [BlockChangeType](BlockChangeType.md)
+`old` | string
+`_new` | string
+
+## Example
+
+```typescript
+import type { TableCellChange } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "row": null,
+  "col": null,
+  "type": null,
+  "old": null,
+  "_new": null,
+} satisfies TableCellChange
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TableCellChange
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UpdateApiConnectionRequest.md

@@ -1,12 +1,14 @@
 
 # UpdateApiConnectionRequest
 
-Partial update (PATCH). A risk-increasing change re-arms the disclaimer.
+Partial update (PATCH). A risk-increasing change re-arms the disclaimer.  ``name`` renames the connection and ``parent_path_part_id`` moves it under a new FOLDER; neither is a risk-increasing change, so a rename/move alone leaves the disclaimer intact.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`name` | string
+`parentPathPartId` | string
 `baseUrl` | string
 `networkClass` | [NetworkClass](NetworkClass.md)
 `verifyTls` | boolean
@@ -20,6 +22,8 @@ import type { UpdateApiConnectionRequest } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
+  "name": null,
+  "parentPathPartId": null,
   "baseUrl": null,
   "networkClass": null,
   "verifyTls": null,

package/docs/UpdateDataSourceRequest.md

@@ -0,0 +1,37 @@
+
+# UpdateDataSourceRequest
+
+Rename and/or move a connector (PATCH). Both fields optional.  A body with both ``None`` is rejected as a no-op 400. ``name`` renames the connector path_part; ``parent_path_part_id`` moves it under a new FOLDER (the move cascades ``materialized_path`` to the modeled-table children). Connection credentials and engine are not editable here.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`parentPathPartId` | string
+
+## Example
+
+```typescript
+import type { UpdateDataSourceRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "parentPathPartId": null,
+} satisfies UpdateDataSourceRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UpdateDataSourceRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/VersionDiffResponse.md

@@ -1,7 +1,7 @@
 
 # VersionDiffResponse
 
-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).
+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).
 
 ## Properties
 
@@ -14,6 +14,17 @@ Name | Type
 `format` | [DiffFormat](DiffFormat.md)
 `text` | [TextDiff](TextDiff.md)
 `cells` | [CellDiff](CellDiff.md)
+`structured` | [StructuredDiff](StructuredDiff.md)
+`document` | [DocumentDiff](DocumentDiff.md)
+`degraded` | boolean
+`degradedReason` | string
+`algorithmVersion` | string
+`fromContentHash` | string
+`toContentHash` | string
+`fromUploader` | [UserInfo](UserInfo.md)
+`toUploader` | [UserInfo](UserInfo.md)
+`fromUploadedAt` | Date
+`toUploadedAt` | Date
 
 ## Example
 
@@ -29,6 +40,17 @@ const example = {
   "format": null,
   "text": null,
   "cells": null,
+  "structured": null,
+  "document": null,
+  "degraded": null,
+  "degradedReason": null,
+  "algorithmVersion": null,
+  "fromContentHash": null,
+  "toContentHash": null,
+  "fromUploader": null,
+  "toUploader": null,
+  "fromUploadedAt": null,
+  "toUploadedAt": null,
 } satisfies VersionDiffResponse
 
 console.log(example)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.117.0",
+  "version": "1.119.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {