@knowledge-stack/ksapi 1.154.1 → 1.156.0

package/src/models/BulkRevokeRequest.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Revoke many permissions by their own permission-row ids.
+ * @export
+ * @interface BulkRevokeRequest
+ */
+export interface BulkRevokeRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof BulkRevokeRequest
+     */
+    tenantId: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof BulkRevokeRequest
+     */
+    permissionIds?: Array<string>;
+}
+export const BulkRevokeRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the BulkRevokeRequest interface.
+ */
+export function instanceOfBulkRevokeRequest(value: object): value is BulkRevokeRequest {
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    return true;
+}
+
+export function BulkRevokeRequestFromJSON(json: any): BulkRevokeRequest {
+    return BulkRevokeRequestFromJSONTyped(json, false);
+}
+
+export function BulkRevokeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkRevokeRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tenantId': json['tenant_id'],
+        'permissionIds': json['permission_ids'] == null ? undefined : json['permission_ids'],
+    };
+}
+
+export function BulkRevokeRequestToJSON(json: any): BulkRevokeRequest {
+    return BulkRevokeRequestToJSONTyped(json, false);
+}
+
+export function BulkRevokeRequestToJSONTyped(value?: BulkRevokeRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tenant_id': value['tenantId'],
+        'permission_ids': value['permissionIds'],
+    };
+}
+

package/src/models/BulkTrashRequest.ts

@@ -0,0 +1,82 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Restore or permanently delete the selected trashed objects by PDO id.
+ * @export
+ * @interface BulkTrashRequest
+ */
+export interface BulkTrashRequest {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof BulkTrashRequest
+     */
+    objectIds?: Array<string>;
+}
+export const BulkTrashRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the BulkTrashRequest interface.
+ */
+export function instanceOfBulkTrashRequest(value: object): value is BulkTrashRequest {
+    return true;
+}
+
+export function BulkTrashRequestFromJSON(json: any): BulkTrashRequest {
+    return BulkTrashRequestFromJSONTyped(json, false);
+}
+
+export function BulkTrashRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkTrashRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'objectIds': json['object_ids'] == null ? undefined : json['object_ids'],
+    };
+}
+
+export function BulkTrashRequestToJSON(json: any): BulkTrashRequest {
+    return BulkTrashRequestToJSONTyped(json, false);
+}
+
+export function BulkTrashRequestToJSONTyped(value?: BulkTrashRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'object_ids': value['objectIds'],
+    };
+}
+

package/src/models/CreateUploadRequest.ts

@@ -43,6 +43,12 @@ export interface CreateUploadRequest {
      * @memberof CreateUploadRequest
      */
     sizeBytes: number;
+    /**
+     * Tags applied to the document on completion (mirrors the buffered ingest endpoints so a mixed submit tags recordings too)
+     * @type {Array<string>}
+     * @memberof CreateUploadRequest
+     */
+    tagIds?: Array<string>;
 }
 export const CreateUploadRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -87,6 +93,7 @@ export function CreateUploadRequestFromJSONTyped(json: any, ignoreDiscriminator:
         'name': json['name'],
         'filename': json['filename'],
         'sizeBytes': json['size_bytes'],
+        'tagIds': json['tag_ids'] == null ? undefined : json['tag_ids'],
     };
 }
 
@@ -105,6 +112,7 @@ export function CreateUploadRequestToJSONTyped(value?: CreateUploadRequest | nul
         'name': value['name'],
         'filename': value['filename'],
         'size_bytes': value['sizeBytes'],
+        'tag_ids': value['tagIds'],
     };
 }
 

package/src/models/DocumentVersionMetadata.ts

@@ -110,6 +110,24 @@ export interface DocumentVersionMetadata {
      * @memberof DocumentVersionMetadata
      */
     totalChunks?: number | null;
+    /**
+     * Media (audio/video) duration in milliseconds; null for non-media
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    durationMs?: number | null;
+    /**
+     * ASR-detected language of the media transcript, as returned by the ASR provider; null for non-media or when the provider omits it
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    language?: string | null;
+    /**
+     * Number of transcript segments produced by ASR; null for non-media
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    segmentCount?: number | null;
     /**
      * Total formula cells in the workbook (XLSX only)
      * @type {number}
@@ -222,6 +240,9 @@ export function DocumentVersionMetadataFromJSONTyped(json: any, ignoreDiscrimina
         'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
         'totalSections': json['total_sections'] == null ? undefined : json['total_sections'],
         'totalChunks': json['total_chunks'] == null ? undefined : json['total_chunks'],
+        'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
+        'language': json['language'] == null ? undefined : json['language'],
+        'segmentCount': json['segment_count'] == null ? undefined : json['segment_count'],
         'totalFormulas': json['total_formulas'] == null ? undefined : json['total_formulas'],
         'xlsxParseResultS3': json['xlsx_parse_result_s3'] == null ? undefined : json['xlsx_parse_result_s3'],
         'xlsxNamedRanges': json['xlsx_named_ranges'] == null ? undefined : json['xlsx_named_ranges'],
@@ -257,6 +278,9 @@ export function DocumentVersionMetadataToJSONTyped(value?: DocumentVersionMetada
         'total_pages': value['totalPages'],
         'total_sections': value['totalSections'],
         'total_chunks': value['totalChunks'],
+        'duration_ms': value['durationMs'],
+        'language': value['language'],
+        'segment_count': value['segmentCount'],
         'total_formulas': value['totalFormulas'],
         'xlsx_parse_result_s3': value['xlsxParseResultS3'],
         'xlsx_named_ranges': value['xlsxNamedRanges'],

package/src/models/DocumentVersionMetadataUpdate.ts

@@ -122,6 +122,24 @@ export interface DocumentVersionMetadataUpdate {
      * @memberof DocumentVersionMetadataUpdate
      */
     totalChunks?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    durationMs?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    language?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    segmentCount?: number | null;
     /**
      * 
      * @type {number}
@@ -231,6 +249,9 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json: any, ignoreDisc
         'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
         'totalSections': json['total_sections'] == null ? undefined : json['total_sections'],
         'totalChunks': json['total_chunks'] == null ? undefined : json['total_chunks'],
+        'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
+        'language': json['language'] == null ? undefined : json['language'],
+        'segmentCount': json['segment_count'] == null ? undefined : json['segment_count'],
         'totalFormulas': json['total_formulas'] == null ? undefined : json['total_formulas'],
         'xlsxParseResultS3': json['xlsx_parse_result_s3'] == null ? undefined : json['xlsx_parse_result_s3'],
         'xlsxNamedRanges': json['xlsx_named_ranges'] == null ? undefined : json['xlsx_named_ranges'],
@@ -268,6 +289,9 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value?: DocumentVersion
         'total_pages': value['totalPages'],
         'total_sections': value['totalSections'],
         'total_chunks': value['totalChunks'],
+        'duration_ms': value['durationMs'],
+        'language': value['language'],
+        'segment_count': value['segmentCount'],
         'total_formulas': value['totalFormulas'],
         'xlsx_parse_result_s3': value['xlsxParseResultS3'],
         'xlsx_named_ranges': value['xlsxNamedRanges'],

package/src/models/ErrorResponse.ts

@@ -46,6 +46,7 @@ export interface ErrorResponse {
 export const ErrorResponseCodeEnum = {
     Error: 'error',
     BadRequest: 'bad_request',
+    PermissionLimit: 'permission_limit',
     Unauthorized: 'unauthorized',
     Forbidden: 'forbidden',
     NotFound: 'not_found',

package/src/models/index.ts

@@ -19,10 +19,22 @@ export * from './AskResponse';
 export * from './BlockChangeType';
 export * from './BlockKind';
 export * from './BrandingLogoType';
+export * from './BulkDeleteRequest';
 export * from './BulkDownloadRequest';
+export * from './BulkFailureReason';
+export * from './BulkGrantItem';
+export * from './BulkGrantItemFailure';
+export * from './BulkGrantRequest';
+export * from './BulkGrantResponse';
+export * from './BulkGrantSuccess';
+export * from './BulkItemFailure';
 export * from './BulkModelTablesRequest';
 export * from './BulkModelTablesResponse';
+export * from './BulkMoveRequest';
+export * from './BulkOperationResponse';
+export * from './BulkRevokeRequest';
 export * from './BulkTagRequest';
+export * from './BulkTrashRequest';
 export * from './CatalogColumnResponse';
 export * from './CatalogTableResponse';
 export * from './CellChange';