@knowledge-stack/ksapi 1.72.4 → 1.78.0

package/src/models/ScoredChunkResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ChunkMetadata } from './ChunkMetadata';
+import {
+    ChunkMetadataFromJSON,
+    ChunkMetadataFromJSONTyped,
+    ChunkMetadataToJSON,
+    ChunkMetadataToJSONTyped,
+} from './ChunkMetadata';
 import type { ChunkDocumentResponse } from './ChunkDocumentResponse';
 import {
     ChunkDocumentResponseFromJSON,
@@ -20,13 +27,6 @@ import {
     ChunkDocumentResponseToJSON,
     ChunkDocumentResponseToJSONTyped,
 } from './ChunkDocumentResponse';
-import type { ChunkMetadataOutput } from './ChunkMetadataOutput';
-import {
-    ChunkMetadataOutputFromJSON,
-    ChunkMetadataOutputFromJSONTyped,
-    ChunkMetadataOutputToJSON,
-    ChunkMetadataOutputToJSONTyped,
-} from './ChunkMetadataOutput';
 import type { ChunkType } from './ChunkType';
 import {
     ChunkTypeFromJSON,
@@ -80,10 +80,10 @@ export interface ScoredChunkResponse {
     chunkType: ChunkType;
     /**
      * 
-     * @type {ChunkMetadataOutput}
+     * @type {ChunkMetadata}
      * @memberof ScoredChunkResponse
      */
-    chunkMetadata: ChunkMetadataOutput;
+    chunkMetadata: ChunkMetadata;
     /**
      * Number of tokens in chunk content
      * @type {number}
@@ -218,7 +218,7 @@ export function ScoredChunkResponseFromJSONTyped(json: any, ignoreDiscriminator:
         'contentId': json['content_id'],
         'content': json['content'],
         'chunkType': ChunkTypeFromJSON(json['chunk_type']),
-        'chunkMetadata': ChunkMetadataOutputFromJSON(json['chunk_metadata']),
+        'chunkMetadata': ChunkMetadataFromJSON(json['chunk_metadata']),
         'numTokens': json['num_tokens'] == null ? undefined : json['num_tokens'],
         'parentPathId': json['parent_path_id'],
         'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
@@ -251,7 +251,7 @@ export function ScoredChunkResponseToJSONTyped(value?: ScoredChunkResponse | nul
         'content_id': value['contentId'],
         'content': value['content'],
         'chunk_type': ChunkTypeToJSON(value['chunkType']),
-        'chunk_metadata': ChunkMetadataOutputToJSON(value['chunkMetadata']),
+        'chunk_metadata': ChunkMetadataToJSON(value['chunkMetadata']),
         'num_tokens': value['numTokens'],
         'parent_path_id': value['parentPathId'],
         'prev_sibling_path_id': value['prevSiblingPathId'],

package/src/models/SeatQuotaStatus.ts

@@ -0,0 +1,94 @@
+/* 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';
+/**
+ * Live seat count for the tenant.
+ * 
+ * ``used`` is the number of active (non-deactivated) ``TenantUser`` rows.
+ * @export
+ * @interface SeatQuotaStatus
+ */
+export interface SeatQuotaStatus {
+    /**
+     * Active seats currently consumed
+     * @type {number}
+     * @memberof SeatQuotaStatus
+     */
+    used: number;
+    /**
+     * Maximum seats permitted for the tenant
+     * @type {number}
+     * @memberof SeatQuotaStatus
+     */
+    limit: number;
+}
+export const SeatQuotaStatusPropertyValidationAttributesMap: {
+    [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 SeatQuotaStatus interface.
+ */
+export function instanceOfSeatQuotaStatus(value: object): value is SeatQuotaStatus {
+    if (!('used' in value) || value['used'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    return true;
+}
+
+export function SeatQuotaStatusFromJSON(json: any): SeatQuotaStatus {
+    return SeatQuotaStatusFromJSONTyped(json, false);
+}
+
+export function SeatQuotaStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): SeatQuotaStatus {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'used': json['used'],
+        'limit': json['limit'],
+    };
+}
+
+export function SeatQuotaStatusToJSON(json: any): SeatQuotaStatus {
+    return SeatQuotaStatusToJSONTyped(json, false);
+}
+
+export function SeatQuotaStatusToJSONTyped(value?: SeatQuotaStatus | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'used': value['used'],
+        'limit': value['limit'],
+    };
+}
+

package/src/models/SubscriptionPlanResponse.ts

@@ -0,0 +1,161 @@
+/* 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';
+/**
+ * Public-facing plan description.
+ * 
+ * Surfaced via ``GET /public/subscriptions`` (unauth) so the FE can render
+ * the upgrade page even before sign-in. Field names line up 1:1 with
+ * ``SubscriptionPlan`` ORM attributes; callers build the response via
+ * ``SubscriptionPlanResponse.model_validate(plan)`` (``BaseResponse``
+ * enables ``from_attributes=True``).
+ * @export
+ * @interface SubscriptionPlanResponse
+ */
+export interface SubscriptionPlanResponse {
+    /**
+     * Plan ID.
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    id: string;
+    /**
+     * Human-readable plan name.
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    name: string;
+    /**
+     * Per-period cap on ingested pages (PAGE).
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    ingestedPages: number;
+    /**
+     * Per-period cap on agent messages (MESSAGE).
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    messages: number;
+    /**
+     * Per-period cap on searches (SEARCH).
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    searches: number;
+    /**
+     * Upper bound on num_seats accepted by the upgrade endpoint. Admin PATCH may set tenant.seats above this value.
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    maxSeats: number;
+    /**
+     * Whether this plan appears in the public listing. Private plans (custom enterprise tiers) are excluded from ``GET /public/subscriptions`` but their tenant members can still read them via ``GET /v1/tenants/{tenant_id}/subscriptions``.
+     * @type {boolean}
+     * @memberof SubscriptionPlanResponse
+     */
+    _public: boolean;
+    /**
+     * Plan creation timestamp.
+     * @type {Date}
+     * @memberof SubscriptionPlanResponse
+     */
+    createdAt: Date;
+    /**
+     * Last-update timestamp.
+     * @type {Date}
+     * @memberof SubscriptionPlanResponse
+     */
+    updatedAt: Date;
+}
+export const SubscriptionPlanResponsePropertyValidationAttributesMap: {
+    [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 SubscriptionPlanResponse interface.
+ */
+export function instanceOfSubscriptionPlanResponse(value: object): value is SubscriptionPlanResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('ingestedPages' in value) || value['ingestedPages'] === undefined) return false;
+    if (!('messages' in value) || value['messages'] === undefined) return false;
+    if (!('searches' in value) || value['searches'] === undefined) return false;
+    if (!('maxSeats' in value) || value['maxSeats'] === undefined) return false;
+    if (!('_public' in value) || value['_public'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function SubscriptionPlanResponseFromJSON(json: any): SubscriptionPlanResponse {
+    return SubscriptionPlanResponseFromJSONTyped(json, false);
+}
+
+export function SubscriptionPlanResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPlanResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'ingestedPages': json['ingested_pages'],
+        'messages': json['messages'],
+        'searches': json['searches'],
+        'maxSeats': json['max_seats'],
+        '_public': json['public'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function SubscriptionPlanResponseToJSON(json: any): SubscriptionPlanResponse {
+    return SubscriptionPlanResponseToJSONTyped(json, false);
+}
+
+export function SubscriptionPlanResponseToJSONTyped(value?: SubscriptionPlanResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'ingested_pages': value['ingestedPages'],
+        'messages': value['messages'],
+        'searches': value['searches'],
+        'max_seats': value['maxSeats'],
+        'public': value['_public'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+

package/src/models/TenantQuotaStateResponse.ts

@@ -0,0 +1,107 @@
+/* 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 { MeteredQuotaStatus } from './MeteredQuotaStatus';
+import {
+    MeteredQuotaStatusFromJSON,
+    MeteredQuotaStatusFromJSONTyped,
+    MeteredQuotaStatusToJSON,
+    MeteredQuotaStatusToJSONTyped,
+} from './MeteredQuotaStatus';
+import type { SeatQuotaStatus } from './SeatQuotaStatus';
+import {
+    SeatQuotaStatusFromJSON,
+    SeatQuotaStatusFromJSONTyped,
+    SeatQuotaStatusToJSON,
+    SeatQuotaStatusToJSONTyped,
+} from './SeatQuotaStatus';
+
+/**
+ * Tenant's current quota state across all enforced caps.
+ * @export
+ * @interface TenantQuotaStateResponse
+ */
+export interface TenantQuotaStateResponse {
+    /**
+     * One entry per metered resource
+     * @type {Array<MeteredQuotaStatus>}
+     * @memberof TenantQuotaStateResponse
+     */
+    metered: Array<MeteredQuotaStatus>;
+    /**
+     * 
+     * @type {SeatQuotaStatus}
+     * @memberof TenantQuotaStateResponse
+     */
+    seats: SeatQuotaStatus;
+}
+export const TenantQuotaStateResponsePropertyValidationAttributesMap: {
+    [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 TenantQuotaStateResponse interface.
+ */
+export function instanceOfTenantQuotaStateResponse(value: object): value is TenantQuotaStateResponse {
+    if (!('metered' in value) || value['metered'] === undefined) return false;
+    if (!('seats' in value) || value['seats'] === undefined) return false;
+    return true;
+}
+
+export function TenantQuotaStateResponseFromJSON(json: any): TenantQuotaStateResponse {
+    return TenantQuotaStateResponseFromJSONTyped(json, false);
+}
+
+export function TenantQuotaStateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TenantQuotaStateResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'metered': ((json['metered'] as Array<any>).map(MeteredQuotaStatusFromJSON)),
+        'seats': SeatQuotaStatusFromJSON(json['seats']),
+    };
+}
+
+export function TenantQuotaStateResponseToJSON(json: any): TenantQuotaStateResponse {
+    return TenantQuotaStateResponseToJSONTyped(json, false);
+}
+
+export function TenantQuotaStateResponseToJSONTyped(value?: TenantQuotaStateResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'metered': ((value['metered'] as Array<any>).map(MeteredQuotaStatusToJSON)),
+        'seats': SeatQuotaStatusToJSON(value['seats']),
+    };
+}
+

package/src/models/TenantResponse.ts

@@ -64,6 +64,18 @@ export interface TenantResponse {
      * @memberof TenantResponse
      */
     branding?: TenantBrandingResponse;
+    /**
+     * Maximum active members allowed for this tenant.
+     * @type {number}
+     * @memberof TenantResponse
+     */
+    seats: number;
+    /**
+     * FK to the subscription plan governing the tenant's caps. Resolve ``GET /public/subscriptions`` to display plan name and limits.
+     * @type {string}
+     * @memberof TenantResponse
+     */
+    subscriptionId: string;
 }
 export const TenantResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -80,6 +92,10 @@ export const TenantResponsePropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
+    seats: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
 }
 
 
@@ -90,6 +106,8 @@ export function instanceOfTenantResponse(value: object): value is TenantResponse
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('settings' in value) || value['settings'] === undefined) return false;
+    if (!('seats' in value) || value['seats'] === undefined) return false;
+    if (!('subscriptionId' in value) || value['subscriptionId'] === undefined) return false;
     return true;
 }
 
@@ -108,6 +126,8 @@ export function TenantResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'idpConfig': json['idp_config'] == null ? undefined : json['idp_config'],
         'settings': TenantSettingsResponseFromJSON(json['settings']),
         'branding': json['branding'] == null ? undefined : TenantBrandingResponseFromJSON(json['branding']),
+        'seats': json['seats'],
+        'subscriptionId': json['subscription_id'],
     };
 }
 
@@ -127,6 +147,8 @@ export function TenantResponseToJSONTyped(value?: TenantResponse | null, ignoreD
         'idp_config': value['idpConfig'],
         'settings': TenantSettingsResponseToJSON(value['settings']),
         'branding': TenantBrandingResponseToJSON(value['branding']),
+        'seats': value['seats'],
+        'subscription_id': value['subscriptionId'],
     };
 }
 

package/src/models/TenantSettingsResponse.ts

@@ -20,6 +20,13 @@ import {
     SupportedLanguageToJSON,
     SupportedLanguageToJSONTyped,
 } from './SupportedLanguage';
+import type { InviteLinkSettingsResponse } from './InviteLinkSettingsResponse';
+import {
+    InviteLinkSettingsResponseFromJSON,
+    InviteLinkSettingsResponseFromJSONTyped,
+    InviteLinkSettingsResponseToJSON,
+    InviteLinkSettingsResponseToJSONTyped,
+} from './InviteLinkSettingsResponse';
 
 /**
  * Tenant settings as exposed via API (no internal S3 URIs).
@@ -45,6 +52,12 @@ export interface TenantSettingsResponse {
      * @memberof TenantSettingsResponse
      */
     timezone: string;
+    /**
+     * 
+     * @type {InviteLinkSettingsResponse}
+     * @memberof TenantSettingsResponse
+     */
+    inviteLink: InviteLinkSettingsResponse;
 }
 
 
@@ -73,6 +86,7 @@ export function instanceOfTenantSettingsResponse(value: object): value is Tenant
     if (!('language' in value) || value['language'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
     if (!('timezone' in value) || value['timezone'] === undefined) return false;
+    if (!('inviteLink' in value) || value['inviteLink'] === undefined) return false;
     return true;
 }
 
@@ -89,6 +103,7 @@ export function TenantSettingsResponseFromJSONTyped(json: any, ignoreDiscriminat
         'language': SupportedLanguageFromJSON(json['language']),
         'description': json['description'],
         'timezone': json['timezone'],
+        'inviteLink': InviteLinkSettingsResponseFromJSON(json['invite_link']),
     };
 }
 
@@ -106,6 +121,7 @@ export function TenantSettingsResponseToJSONTyped(value?: TenantSettingsResponse
         'language': SupportedLanguageToJSON(value['language']),
         'description': value['description'],
         'timezone': value['timezone'],
+        'invite_link': InviteLinkSettingsResponseToJSON(value['inviteLink']),
     };
 }
 

package/src/models/TenantSettingsUpdate.ts

@@ -20,6 +20,13 @@ import {
     SupportedLanguageToJSON,
     SupportedLanguageToJSONTyped,
 } from './SupportedLanguage';
+import type { InviteLinkSettingsRequest } from './InviteLinkSettingsRequest';
+import {
+    InviteLinkSettingsRequestFromJSON,
+    InviteLinkSettingsRequestFromJSONTyped,
+    InviteLinkSettingsRequestToJSON,
+    InviteLinkSettingsRequestToJSONTyped,
+} from './InviteLinkSettingsRequest';
 
 /**
  * Partial tenant settings update.
@@ -63,6 +70,12 @@ export interface TenantSettingsUpdate {
      * @memberof TenantSettingsUpdate
      */
     themeOverrides?: { [key: string]: string; } | null;
+    /**
+     * 
+     * @type {InviteLinkSettingsRequest}
+     * @memberof TenantSettingsUpdate
+     */
+    inviteLink?: InviteLinkSettingsRequest;
 }
 
 
@@ -107,6 +120,7 @@ export function TenantSettingsUpdateFromJSONTyped(json: any, ignoreDiscriminator
         'brandName': json['brand_name'] == null ? undefined : json['brand_name'],
         'brandColor': json['brand_color'] == null ? undefined : json['brand_color'],
         'themeOverrides': json['theme_overrides'] == null ? undefined : json['theme_overrides'],
+        'inviteLink': json['invite_link'] == null ? undefined : InviteLinkSettingsRequestFromJSON(json['invite_link']),
     };
 }
 
@@ -127,6 +141,7 @@ export function TenantSettingsUpdateToJSONTyped(value?: TenantSettingsUpdate | n
         'brand_name': value['brandName'],
         'brand_color': value['brandColor'],
         'theme_overrides': value['themeOverrides'],
+        'invite_link': InviteLinkSettingsRequestToJSON(value['inviteLink']),
     };
 }
 

package/src/models/ThreadMessageDetailsInput.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { CheckpointDetails } from './CheckpointDetails';
+import {
+    CheckpointDetailsFromJSON,
+    CheckpointDetailsFromJSONTyped,
+    CheckpointDetailsToJSON,
+    CheckpointDetailsToJSONTyped,
+} from './CheckpointDetails';
 import type { StepInput } from './StepInput';
 import {
     StepInputFromJSON,
@@ -33,6 +40,12 @@ export interface ThreadMessageDetailsInput {
      * @memberof ThreadMessageDetailsInput
      */
     steps?: Array<StepInput>;
+    /**
+     * 
+     * @type {CheckpointDetails}
+     * @memberof ThreadMessageDetailsInput
+     */
+    checkpoint?: CheckpointDetails;
 }
 export const ThreadMessageDetailsInputPropertyValidationAttributesMap: {
     [property: string]: {
@@ -70,6 +83,7 @@ export function ThreadMessageDetailsInputFromJSONTyped(json: any, ignoreDiscrimi
     return {
         
         'steps': json['steps'] == null ? undefined : ((json['steps'] as Array<any>).map(StepInputFromJSON)),
+        'checkpoint': json['checkpoint'] == null ? undefined : CheckpointDetailsFromJSON(json['checkpoint']),
     };
 }
 
@@ -85,6 +99,7 @@ export function ThreadMessageDetailsInputToJSONTyped(value?: ThreadMessageDetail
     return {
         
         'steps': value['steps'] == null ? undefined : ((value['steps'] as Array<any>).map(StepInputToJSON)),
+        'checkpoint': CheckpointDetailsToJSON(value['checkpoint']),
     };
 }
 

package/src/models/ThreadMessageDetailsOutput.ts

@@ -20,6 +20,13 @@ import {
     StepOutputToJSON,
     StepOutputToJSONTyped,
 } from './StepOutput';
+import type { CheckpointDetails } from './CheckpointDetails';
+import {
+    CheckpointDetailsFromJSON,
+    CheckpointDetailsFromJSONTyped,
+    CheckpointDetailsToJSON,
+    CheckpointDetailsToJSONTyped,
+} from './CheckpointDetails';
 
 /**
  * 
@@ -33,6 +40,12 @@ export interface ThreadMessageDetailsOutput {
      * @memberof ThreadMessageDetailsOutput
      */
     steps?: Array<StepOutput>;
+    /**
+     * 
+     * @type {CheckpointDetails}
+     * @memberof ThreadMessageDetailsOutput
+     */
+    checkpoint?: CheckpointDetails;
 }
 export const ThreadMessageDetailsOutputPropertyValidationAttributesMap: {
     [property: string]: {
@@ -70,6 +83,7 @@ export function ThreadMessageDetailsOutputFromJSONTyped(json: any, ignoreDiscrim
     return {
         
         'steps': json['steps'] == null ? undefined : ((json['steps'] as Array<any>).map(StepOutputFromJSON)),
+        'checkpoint': json['checkpoint'] == null ? undefined : CheckpointDetailsFromJSON(json['checkpoint']),
     };
 }
 
@@ -85,6 +99,7 @@ export function ThreadMessageDetailsOutputToJSONTyped(value?: ThreadMessageDetai
     return {
         
         'steps': value['steps'] == null ? undefined : ((value['steps'] as Array<any>).map(StepOutputToJSON)),
+        'checkpoint': CheckpointDetailsToJSON(value['checkpoint']),
     };
 }