@knowledge-stack/ksapi 1.80.1 → 1.82.0

package/src/models/InstructionSnapshot.ts

@@ -0,0 +1,125 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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';
+import type { PartType } from './PartType';
+import {
+    PartTypeFromJSON,
+    PartTypeFromJSONTyped,
+    PartTypeToJSON,
+    PartTypeToJSONTyped,
+} from './PartType';
+
+/**
+ * Snapshot of one instruction document, pinned at trigger time.
+ * 
+ * The instruction file is the workflow's **contract**: the agent reads
+ * this exact ``document_version_id`` for the duration of the run, even
+ * if the document is edited mid-flight or after the run completes.
+ * Reproducibility and audit replay depend on this pinning.
+ * @export
+ * @interface InstructionSnapshot
+ */
+export interface InstructionSnapshot {
+    /**
+     * 
+     * @type {string}
+     * @memberof InstructionSnapshot
+     */
+    pathPartId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof InstructionSnapshot
+     */
+    materializedPath: string;
+    /**
+     * 
+     * @type {PartType}
+     * @memberof InstructionSnapshot
+     */
+    partType: PartType;
+    /**
+     * 
+     * @type {string}
+     * @memberof InstructionSnapshot
+     */
+    documentVersionId: string;
+}
+
+
+export const InstructionSnapshotPropertyValidationAttributesMap: {
+    [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 InstructionSnapshot interface.
+ */
+export function instanceOfInstructionSnapshot(value: object): value is InstructionSnapshot {
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
+    if (!('partType' in value) || value['partType'] === undefined) return false;
+    if (!('documentVersionId' in value) || value['documentVersionId'] === undefined) return false;
+    return true;
+}
+
+export function InstructionSnapshotFromJSON(json: any): InstructionSnapshot {
+    return InstructionSnapshotFromJSONTyped(json, false);
+}
+
+export function InstructionSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): InstructionSnapshot {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pathPartId': json['path_part_id'],
+        'materializedPath': json['materialized_path'],
+        'partType': PartTypeFromJSON(json['part_type']),
+        'documentVersionId': json['document_version_id'],
+    };
+}
+
+export function InstructionSnapshotToJSON(json: any): InstructionSnapshot {
+    return InstructionSnapshotToJSONTyped(json, false);
+}
+
+export function InstructionSnapshotToJSONTyped(value?: InstructionSnapshot | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path_part_id': value['pathPartId'],
+        'materialized_path': value['materializedPath'],
+        'part_type': PartTypeToJSON(value['partType']),
+        'document_version_id': value['documentVersionId'],
+    };
+}
+

package/src/models/InvokeWorkflowRequest.ts

@@ -25,6 +25,12 @@ export interface InvokeWorkflowRequest {
      * @memberof InvokeWorkflowRequest
      */
     idempotencyKey?: string | null;
+    /**
+     * Path part IDs of input documents to pin to this run. Each path_part must be a DOCUMENT readable by the caller. Active document_version_id is captured at trigger time.
+     * @type {Array<string>}
+     * @memberof InvokeWorkflowRequest
+     */
+    inputPathPartIds?: Array<string>;
 }
 export const InvokeWorkflowRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -44,6 +50,10 @@ export const InvokeWorkflowRequestPropertyValidationAttributesMap: {
     idempotencyKey: {
         maxLength: 255,
     },
+    inputPathPartIds: {
+        maxItems: 50,
+        uniqueItems: false,
+    },
 }
 
 
@@ -65,6 +75,7 @@ export function InvokeWorkflowRequestFromJSONTyped(json: any, ignoreDiscriminato
     return {
         
         'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
+        'inputPathPartIds': json['input_path_part_ids'] == null ? undefined : json['input_path_part_ids'],
     };
 }
 
@@ -80,6 +91,7 @@ export function InvokeWorkflowRequestToJSONTyped(value?: InvokeWorkflowRequest |
     return {
         
         'idempotency_key': value['idempotencyKey'],
+        'input_path_part_ids': value['inputPathPartIds'],
     };
 }
 

package/src/models/OnboardingCompanyRequest.ts

@@ -0,0 +1,96 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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';
+/**
+ * Step 1 of onboarding — tenant-wide company info. OWNER/ADMIN only.
+ * @export
+ * @interface OnboardingCompanyRequest
+ */
+export interface OnboardingCompanyRequest {
+    /**
+     * Brief company description (≤5000 chars)
+     * @type {string}
+     * @memberof OnboardingCompanyRequest
+     */
+    description?: string | null;
+    /**
+     * Industry / company type (free text)
+     * @type {string}
+     * @memberof OnboardingCompanyRequest
+     */
+    industry?: string | null;
+}
+export const OnboardingCompanyRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    description: {
+        maxLength: 5000,
+    },
+    industry: {
+        maxLength: 120,
+    },
+}
+
+
+/**
+ * Check if a given object implements the OnboardingCompanyRequest interface.
+ */
+export function instanceOfOnboardingCompanyRequest(value: object): value is OnboardingCompanyRequest {
+    return true;
+}
+
+export function OnboardingCompanyRequestFromJSON(json: any): OnboardingCompanyRequest {
+    return OnboardingCompanyRequestFromJSONTyped(json, false);
+}
+
+export function OnboardingCompanyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingCompanyRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'description': json['description'] == null ? undefined : json['description'],
+        'industry': json['industry'] == null ? undefined : json['industry'],
+    };
+}
+
+export function OnboardingCompanyRequestToJSON(json: any): OnboardingCompanyRequest {
+    return OnboardingCompanyRequestToJSONTyped(json, false);
+}
+
+export function OnboardingCompanyRequestToJSONTyped(value?: OnboardingCompanyRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'description': value['description'],
+        'industry': value['industry'],
+    };
+}
+

package/src/models/OnboardingProfileRequest.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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';
+/**
+ * Step 2 of onboarding — per-user info for the current tenant.
+ * @export
+ * @interface OnboardingProfileRequest
+ */
+export interface OnboardingProfileRequest {
+    /**
+     * User's first name
+     * @type {string}
+     * @memberof OnboardingProfileRequest
+     */
+    firstName?: string | null;
+    /**
+     * User's last name
+     * @type {string}
+     * @memberof OnboardingProfileRequest
+     */
+    lastName?: string | null;
+    /**
+     * What the user does at this tenant
+     * @type {string}
+     * @memberof OnboardingProfileRequest
+     */
+    jobTitle?: string | null;
+}
+export const OnboardingProfileRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    jobTitle: {
+        maxLength: 120,
+    },
+}
+
+
+/**
+ * Check if a given object implements the OnboardingProfileRequest interface.
+ */
+export function instanceOfOnboardingProfileRequest(value: object): value is OnboardingProfileRequest {
+    return true;
+}
+
+export function OnboardingProfileRequestFromJSON(json: any): OnboardingProfileRequest {
+    return OnboardingProfileRequestFromJSONTyped(json, false);
+}
+
+export function OnboardingProfileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingProfileRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['first_name'] == null ? undefined : json['first_name'],
+        'lastName': json['last_name'] == null ? undefined : json['last_name'],
+        'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
+    };
+}
+
+export function OnboardingProfileRequestToJSON(json: any): OnboardingProfileRequest {
+    return OnboardingProfileRequestToJSONTyped(json, false);
+}
+
+export function OnboardingProfileRequestToJSONTyped(value?: OnboardingProfileRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'job_title': value['jobTitle'],
+    };
+}
+

package/src/models/TenantSettingsResponse.ts

@@ -46,6 +46,12 @@ export interface TenantSettingsResponse {
      * @memberof TenantSettingsResponse
      */
     description: string;
+    /**
+     * Industry / company type captured during onboarding
+     * @type {string}
+     * @memberof TenantSettingsResponse
+     */
+    industry?: string | null;
     /**
      * IANA timezone (e.g. 'America/New_York')
      * @type {string}
@@ -102,6 +108,7 @@ export function TenantSettingsResponseFromJSONTyped(json: any, ignoreDiscriminat
         
         'language': SupportedLanguageFromJSON(json['language']),
         'description': json['description'],
+        'industry': json['industry'] == null ? undefined : json['industry'],
         'timezone': json['timezone'],
         'inviteLink': InviteLinkSettingsResponseFromJSON(json['invite_link']),
     };
@@ -120,6 +127,7 @@ export function TenantSettingsResponseToJSONTyped(value?: TenantSettingsResponse
         
         'language': SupportedLanguageToJSON(value['language']),
         'description': value['description'],
+        'industry': value['industry'],
         'timezone': value['timezone'],
         'invite_link': InviteLinkSettingsResponseToJSON(value['inviteLink']),
     };

package/src/models/TenantSettingsUpdate.ts

@@ -46,6 +46,12 @@ export interface TenantSettingsUpdate {
      * @memberof TenantSettingsUpdate
      */
     description?: string | null;
+    /**
+     * Industry / company type captured during onboarding
+     * @type {string}
+     * @memberof TenantSettingsUpdate
+     */
+    industry?: string | null;
     /**
      * IANA timezone (e.g. 'America/New_York')
      * @type {string}
@@ -94,6 +100,12 @@ export const TenantSettingsUpdatePropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
+    description: {
+        maxLength: 5000,
+    },
+    industry: {
+        maxLength: 120,
+    },
 }
 
 
@@ -116,6 +128,7 @@ export function TenantSettingsUpdateFromJSONTyped(json: any, ignoreDiscriminator
         
         'language': json['language'] == null ? undefined : SupportedLanguageFromJSON(json['language']),
         'description': json['description'] == null ? undefined : json['description'],
+        'industry': json['industry'] == null ? undefined : json['industry'],
         'timezone': json['timezone'] == null ? undefined : json['timezone'],
         'brandName': json['brand_name'] == null ? undefined : json['brand_name'],
         'brandColor': json['brand_color'] == null ? undefined : json['brand_color'],
@@ -137,6 +150,7 @@ export function TenantSettingsUpdateToJSONTyped(value?: TenantSettingsUpdate | n
         
         'language': SupportedLanguageToJSON(value['language']),
         'description': value['description'],
+        'industry': value['industry'],
         'timezone': value['timezone'],
         'brand_name': value['brandName'],
         'brand_color': value['brandColor'],

package/src/models/UpdateWorkflowDefinitionRequest.ts

@@ -29,7 +29,12 @@ import {
 } from './WorkflowRunnerType';
 
 /**
- * Full replacement (PUT semantics). All fields are required.
+ * Full replacement (PUT semantics).
+ * 
+ * ``instruction_path_part_ids``:
+ * 
+ * - ``KS_INTERNAL``: must remain ``len == 1`` (the auto-provisioned doc).
+ * - ``SELF_HOSTED``: ``len ≥ 1``; callers may swap or add documents.
  * @export
  * @interface UpdateWorkflowDefinitionRequest
  */

package/src/models/UserResponse.ts

@@ -82,6 +82,18 @@ export interface UserResponse {
      * @memberof UserResponse
      */
     defaultTenantId: string;
+    /**
+     * User's job title at the current tenant (per-membership)
+     * @type {string}
+     * @memberof UserResponse
+     */
+    jobTitle?: string | null;
+    /**
+     * When the user finished onboarding for the current tenant. NULL = wizard should be shown.
+     * @type {Date}
+     * @memberof UserResponse
+     */
+    onboardingCompletedAt?: Date | null;
 }
 
 
@@ -136,6 +148,8 @@ export function UserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'currentTenantId': json['current_tenant_id'],
         'currentTenantRole': TenantUserRoleFromJSON(json['current_tenant_role']),
         'defaultTenantId': json['default_tenant_id'],
+        'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
+        'onboardingCompletedAt': json['onboarding_completed_at'] == null ? undefined : (new Date(json['onboarding_completed_at'])),
     };
 }
 
@@ -158,6 +172,8 @@ export function UserResponseToJSONTyped(value?: UserResponse | null, ignoreDiscr
         'current_tenant_id': value['currentTenantId'],
         'current_tenant_role': TenantUserRoleToJSON(value['currentTenantRole']),
         'default_tenant_id': value['defaultTenantId'],
+        'job_title': value['jobTitle'],
+        'onboarding_completed_at': value['onboardingCompletedAt'] == null ? value['onboardingCompletedAt'] : value['onboardingCompletedAt'].toISOString(),
     };
 }
 

package/src/models/WorkflowRunResponse.ts

@@ -37,6 +37,11 @@ import {
 
 /**
  * Workflow run response.
+ * 
+ * Note: ``run_token_jti`` is intentionally NOT exposed. It's an
+ * internal token identifier persisted on the run row for callback
+ * auth — clients should treat run dispatch state as observable via
+ * ``status`` (RUNNING => dispatched), not via JTI presence.
  * @export
  * @interface WorkflowRunResponse
  */
@@ -95,6 +100,18 @@ export interface WorkflowRunResponse {
      * @memberof WorkflowRunResponse
      */
     error: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof WorkflowRunResponse
+     */
+    inputPathPartIds: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof WorkflowRunResponse
+     */
+    inputVersionIds: Array<string>;
     /**
      * 
      * @type {Date}
@@ -141,6 +158,8 @@ export function instanceOfWorkflowRunResponse(value: object): value is WorkflowR
     if (!('completedAt' in value) || value['completedAt'] === undefined) return false;
     if (!('runSnapshot' in value) || value['runSnapshot'] === undefined) return false;
     if (!('error' in value) || value['error'] === undefined) return false;
+    if (!('inputPathPartIds' in value) || value['inputPathPartIds'] === undefined) return false;
+    if (!('inputVersionIds' in value) || value['inputVersionIds'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
@@ -165,6 +184,8 @@ export function WorkflowRunResponseFromJSONTyped(json: any, ignoreDiscriminator:
         'completedAt': (json['completed_at'] == null ? null : new Date(json['completed_at'])),
         'runSnapshot': WorkflowRunSnapshotFromJSON(json['run_snapshot']),
         'error': json['error'],
+        'inputPathPartIds': json['input_path_part_ids'],
+        'inputVersionIds': json['input_version_ids'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -190,6 +211,8 @@ export function WorkflowRunResponseToJSONTyped(value?: WorkflowRunResponse | nul
         'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
         'run_snapshot': WorkflowRunSnapshotToJSON(value['runSnapshot']),
         'error': value['error'],
+        'input_path_part_ids': value['inputPathPartIds'],
+        'input_version_ids': value['inputVersionIds'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };

package/src/models/WorkflowRunSnapshot.ts

@@ -20,6 +20,13 @@ import {
     ABCDPathSnapshotToJSON,
     ABCDPathSnapshotToJSONTyped,
 } from './ABCDPathSnapshot';
+import type { InstructionSnapshot } from './InstructionSnapshot';
+import {
+    InstructionSnapshotFromJSON,
+    InstructionSnapshotFromJSONTyped,
+    InstructionSnapshotToJSON,
+    InstructionSnapshotToJSONTyped,
+} from './InstructionSnapshot';
 import type { WorkflowRunnerType } from './WorkflowRunnerType';
 import {
     WorkflowRunnerTypeFromJSON,
@@ -72,10 +79,10 @@ export interface WorkflowRunSnapshot {
     sources: Array<ABCDPathSnapshot>;
     /**
      * 
-     * @type {Array<ABCDPathSnapshot>}
+     * @type {Array<InstructionSnapshot>}
      * @memberof WorkflowRunSnapshot
      */
-    instructions: Array<ABCDPathSnapshot>;
+    instructions: Array<InstructionSnapshot>;
     /**
      * 
      * @type {Array<ABCDPathSnapshot>}
@@ -141,7 +148,7 @@ export function WorkflowRunSnapshotFromJSONTyped(json: any, ignoreDiscriminator:
         'userId': json['user_id'],
         'maxRunDurationSeconds': json['max_run_duration_seconds'],
         'sources': ((json['sources'] as Array<any>).map(ABCDPathSnapshotFromJSON)),
-        'instructions': ((json['instructions'] as Array<any>).map(ABCDPathSnapshotFromJSON)),
+        'instructions': ((json['instructions'] as Array<any>).map(InstructionSnapshotFromJSON)),
         'outputs': ((json['outputs'] as Array<any>).map(ABCDPathSnapshotFromJSON)),
         'template': ABCDPathSnapshotFromJSON(json['template']),
     };
@@ -164,7 +171,7 @@ export function WorkflowRunSnapshotToJSONTyped(value?: WorkflowRunSnapshot | nul
         'user_id': value['userId'],
         'max_run_duration_seconds': value['maxRunDurationSeconds'],
         'sources': ((value['sources'] as Array<any>).map(ABCDPathSnapshotToJSON)),
-        'instructions': ((value['instructions'] as Array<any>).map(ABCDPathSnapshotToJSON)),
+        'instructions': ((value['instructions'] as Array<any>).map(InstructionSnapshotToJSON)),
         'outputs': ((value['outputs'] as Array<any>).map(ABCDPathSnapshotToJSON)),
         'template': ABCDPathSnapshotToJSON(value['template']),
     };

package/src/models/WorkflowRunnerType.ts

@@ -18,7 +18,8 @@
  * @export
  */
 export const WorkflowRunnerType = {
-    SelfHosted: 'SELF_HOSTED'
+    SelfHosted: 'SELF_HOSTED',
+    KsInternal: 'KS_INTERNAL'
 } as const;
 export type WorkflowRunnerType = typeof WorkflowRunnerType[keyof typeof WorkflowRunnerType];
 

package/src/models/index.ts

@@ -76,6 +76,7 @@ export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
 export * from './IngestionMode';
+export * from './InstructionSnapshot';
 export * from './InviteLinkSettingsRequest';
 export * from './InviteLinkSettingsResponse';
 export * from './InviteResponse';
@@ -90,6 +91,8 @@ export * from './MembershipResponse';
 export * from './MessageRole';
 export * from './MeteredQuotaStatus';
 export * from './NonFilesystemReferenceType';
+export * from './OnboardingCompanyRequest';
+export * from './OnboardingProfileRequest';
 export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator';
 export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
 export * from './PaginatedResponseDocumentResponse';