@knowledge-stack/ksapi 1.5.0 → 1.7.0

package/dist/esm/models/SectionResponse.d.ts

@@ -0,0 +1,101 @@
+/**
+ * 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.
+ */
+/**
+ * Section response model.
+ * @export
+ * @interface SectionResponse
+ */
+export interface SectionResponse {
+    /**
+     * Section ID
+     * @type {string}
+     * @memberof SectionResponse
+     */
+    id: string;
+    /**
+     * PathPart ID
+     * @type {string}
+     * @memberof SectionResponse
+     */
+    pathPartId: string;
+    /**
+     * Section name
+     * @type {string}
+     * @memberof SectionResponse
+     */
+    name: string;
+    /**
+     * Page number in source document
+     * @type {number}
+     * @memberof SectionResponse
+     */
+    pageNumber?: number;
+    /**
+     * Parent PathPart ID
+     * @type {string}
+     * @memberof SectionResponse
+     */
+    parentId: string;
+    /**
+     * Previous sibling PathPart ID
+     * @type {string}
+     * @memberof SectionResponse
+     */
+    prevSiblingPathId?: string;
+    /**
+     * Next sibling PathPart ID
+     * @type {string}
+     * @memberof SectionResponse
+     */
+    nextSiblingId?: string;
+    /**
+     * Tenant ID
+     * @type {string}
+     * @memberof SectionResponse
+     */
+    tenantId: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof SectionResponse
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof SectionResponse
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the SectionResponse interface.
+ */
+export declare function instanceOfSectionResponse(value: object): value is SectionResponse;
+export declare function SectionResponseFromJSON(json: any): SectionResponse;
+export declare function SectionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SectionResponse;
+export declare function SectionResponseToJSON(json: any): SectionResponse;
+export declare function SectionResponseToJSONTyped(value?: SectionResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const SectionResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/esm/models/SectionResponse.js

@@ -0,0 +1,74 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the SectionResponse interface.
+ */
+export function instanceOfSectionResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('parentId' in value) || value['parentId'] === undefined)
+        return false;
+    if (!('tenantId' in value) || value['tenantId'] === 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 SectionResponseFromJSON(json) {
+    return SectionResponseFromJSONTyped(json, false);
+}
+export function SectionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'pathPartId': json['path_part_id'],
+        'name': json['name'],
+        'pageNumber': json['page_number'] == null ? undefined : json['page_number'],
+        'parentId': json['parent_id'],
+        'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
+        'nextSiblingId': json['next_sibling_id'] == null ? undefined : json['next_sibling_id'],
+        'tenantId': json['tenant_id'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+export function SectionResponseToJSON(json) {
+    return SectionResponseToJSONTyped(json, false);
+}
+export function SectionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'path_part_id': value['pathPartId'],
+        'name': value['name'],
+        'page_number': value['pageNumber'],
+        'parent_id': value['parentId'],
+        'prev_sibling_path_id': value['prevSiblingPathId'],
+        'next_sibling_id': value['nextSiblingId'],
+        'tenant_id': value['tenantId'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+export const SectionResponsePropertyValidationAttributesMap = {};

package/dist/esm/models/UpdateSectionRequest.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+/**
+ * Request to update a section.
+ * @export
+ * @interface UpdateSectionRequest
+ */
+export interface UpdateSectionRequest {
+    /**
+     * New section name (can contain any characters)
+     * @type {string}
+     * @memberof UpdateSectionRequest
+     */
+    name?: string;
+    /**
+     * New page number (must be > 0)
+     * @type {number}
+     * @memberof UpdateSectionRequest
+     */
+    pageNumber?: number;
+    /**
+     * Move after this sibling PathPart ID
+     * @type {string}
+     * @memberof UpdateSectionRequest
+     */
+    prevSiblingPathId?: string;
+    /**
+     * Set to true to move to head of sibling list. This is needed since prev_sibling_path_id = None means no update
+     * @type {boolean}
+     * @memberof UpdateSectionRequest
+     */
+    moveToHead?: boolean;
+}
+/**
+ * Check if a given object implements the UpdateSectionRequest interface.
+ */
+export declare function instanceOfUpdateSectionRequest(value: object): value is UpdateSectionRequest;
+export declare function UpdateSectionRequestFromJSON(json: any): UpdateSectionRequest;
+export declare function UpdateSectionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSectionRequest;
+export declare function UpdateSectionRequestToJSON(json: any): UpdateSectionRequest;
+export declare function UpdateSectionRequestToJSONTyped(value?: UpdateSectionRequest | null, ignoreDiscriminator?: boolean): any;
+export declare const UpdateSectionRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/esm/models/UpdateSectionRequest.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the UpdateSectionRequest interface.
+ */
+export function instanceOfUpdateSectionRequest(value) {
+    return true;
+}
+export function UpdateSectionRequestFromJSON(json) {
+    return UpdateSectionRequestFromJSONTyped(json, false);
+}
+export function UpdateSectionRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'pageNumber': json['page_number'] == null ? undefined : json['page_number'],
+        'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
+        'moveToHead': json['move_to_head'] == null ? undefined : json['move_to_head'],
+    };
+}
+export function UpdateSectionRequestToJSON(json) {
+    return UpdateSectionRequestToJSONTyped(json, false);
+}
+export function UpdateSectionRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'page_number': value['pageNumber'],
+        'prev_sibling_path_id': value['prevSiblingPathId'],
+        'move_to_head': value['moveToHead'],
+    };
+}
+export const UpdateSectionRequestPropertyValidationAttributesMap = {
+    name: {
+        maxLength: 255,
+        minLength: 1,
+    },
+};

package/dist/esm/models/index.d.ts

@@ -1,6 +1,7 @@
 export * from './CreateDocumentRequest';
 export * from './CreateFolderRequest';
 export * from './CreatePasswordUserRequest';
+export * from './CreateSectionRequest';
 export * from './CreateTenantRequest';
 export * from './DocumentOrigin';
 export * from './DocumentResponse';
@@ -17,6 +18,7 @@ export * from './InviteStatus';
 export * from './InviteUserRequest';
 export * from './OAuth2Config';
 export * from './PaginatedResponseDocumentResponse';
+export * from './PaginatedResponseDocumentVersionResponse';
 export * from './PaginatedResponseFolderResponse';
 export * from './PaginatedResponseInviteResponse';
 export * from './PaginatedResponsePathPartResponse';
@@ -28,12 +30,14 @@ export * from './PasswordResetWithTokenRequest';
 export * from './PathOrder';
 export * from './PathPartResponse';
 export * from './RootResponse';
+export * from './SectionResponse';
 export * from './SignInRequest';
 export * from './TenantResponse';
 export * from './TenantUserInTenantResponse';
 export * from './TenantUserRole';
 export * from './UpdateDocumentRequest';
 export * from './UpdateFolderRequest';
+export * from './UpdateSectionRequest';
 export * from './UpdateTenantRequest';
 export * from './UpdateUserRequest';
 export * from './UserResponse';

package/dist/esm/models/index.js

@@ -3,6 +3,7 @@
 export * from './CreateDocumentRequest';
 export * from './CreateFolderRequest';
 export * from './CreatePasswordUserRequest';
+export * from './CreateSectionRequest';
 export * from './CreateTenantRequest';
 export * from './DocumentOrigin';
 export * from './DocumentResponse';
@@ -19,6 +20,7 @@ export * from './InviteStatus';
 export * from './InviteUserRequest';
 export * from './OAuth2Config';
 export * from './PaginatedResponseDocumentResponse';
+export * from './PaginatedResponseDocumentVersionResponse';
 export * from './PaginatedResponseFolderResponse';
 export * from './PaginatedResponseInviteResponse';
 export * from './PaginatedResponsePathPartResponse';
@@ -30,12 +32,14 @@ export * from './PasswordResetWithTokenRequest';
 export * from './PathOrder';
 export * from './PathPartResponse';
 export * from './RootResponse';
+export * from './SectionResponse';
 export * from './SignInRequest';
 export * from './TenantResponse';
 export * from './TenantUserInTenantResponse';
 export * from './TenantUserRole';
 export * from './UpdateDocumentRequest';
 export * from './UpdateFolderRequest';
+export * from './UpdateSectionRequest';
 export * from './UpdateTenantRequest';
 export * from './UpdateUserRequest';
 export * from './UserResponse';

package/dist/models/CreateSectionRequest.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+/**
+ * Request to create a new section.
+ * @export
+ * @interface CreateSectionRequest
+ */
+export interface CreateSectionRequest {
+    /**
+     * Section name (can contain any characters)
+     * @type {string}
+     * @memberof CreateSectionRequest
+     */
+    name: string;
+    /**
+     * Parent PathPart ID (must be DOCUMENT_VERSION or SECTION)
+     * @type {string}
+     * @memberof CreateSectionRequest
+     */
+    parentPathId: string;
+    /**
+     * Page number in source document (must be > 0)
+     * @type {number}
+     * @memberof CreateSectionRequest
+     */
+    pageNumber?: number;
+    /**
+     * PathPart ID to insert after (null = append to tail)
+     * @type {string}
+     * @memberof CreateSectionRequest
+     */
+    prevSiblingPathId?: string;
+}
+/**
+ * Check if a given object implements the CreateSectionRequest interface.
+ */
+export declare function instanceOfCreateSectionRequest(value: object): value is CreateSectionRequest;
+export declare function CreateSectionRequestFromJSON(json: any): CreateSectionRequest;
+export declare function CreateSectionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSectionRequest;
+export declare function CreateSectionRequestToJSON(json: any): CreateSectionRequest;
+export declare function CreateSectionRequestToJSONTyped(value?: CreateSectionRequest | null, ignoreDiscriminator?: boolean): any;
+export declare const CreateSectionRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/models/CreateSectionRequest.js

@@ -0,0 +1,65 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateSectionRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfCreateSectionRequest = instanceOfCreateSectionRequest;
+exports.CreateSectionRequestFromJSON = CreateSectionRequestFromJSON;
+exports.CreateSectionRequestFromJSONTyped = CreateSectionRequestFromJSONTyped;
+exports.CreateSectionRequestToJSON = CreateSectionRequestToJSON;
+exports.CreateSectionRequestToJSONTyped = CreateSectionRequestToJSONTyped;
+/**
+ * Check if a given object implements the CreateSectionRequest interface.
+ */
+function instanceOfCreateSectionRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('parentPathId' in value) || value['parentPathId'] === undefined)
+        return false;
+    return true;
+}
+function CreateSectionRequestFromJSON(json) {
+    return CreateSectionRequestFromJSONTyped(json, false);
+}
+function CreateSectionRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'parentPathId': json['parent_path_id'],
+        'pageNumber': json['page_number'] == null ? undefined : json['page_number'],
+        'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
+    };
+}
+function CreateSectionRequestToJSON(json) {
+    return CreateSectionRequestToJSONTyped(json, false);
+}
+function CreateSectionRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'parent_path_id': value['parentPathId'],
+        'page_number': value['pageNumber'],
+        'prev_sibling_path_id': value['prevSiblingPathId'],
+    };
+}
+exports.CreateSectionRequestPropertyValidationAttributesMap = {
+    name: {
+        maxLength: 255,
+        minLength: 1,
+    },
+};

package/dist/models/DocumentVersionResponse.d.ts

@@ -13,7 +13,7 @@
  * DocumentVersion response model.
  *
  * Shared schema for DocumentVersion responses, used by Document endpoints
- * and future DocumentVersion endpoints.
+ * and DocumentVersion endpoints.
  * @export
  * @interface DocumentVersionResponse
  */

package/dist/models/PaginatedResponseDocumentVersionResponse.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 type { DocumentVersionResponse } from './DocumentVersionResponse';
+/**
+ *
+ * @export
+ * @interface PaginatedResponseDocumentVersionResponse
+ */
+export interface PaginatedResponseDocumentVersionResponse {
+    /**
+     * List of items
+     * @type {Array<DocumentVersionResponse>}
+     * @memberof PaginatedResponseDocumentVersionResponse
+     */
+    items: Array<DocumentVersionResponse>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof PaginatedResponseDocumentVersionResponse
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof PaginatedResponseDocumentVersionResponse
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof PaginatedResponseDocumentVersionResponse
+     */
+    offset: number;
+}
+/**
+ * Check if a given object implements the PaginatedResponseDocumentVersionResponse interface.
+ */
+export declare function instanceOfPaginatedResponseDocumentVersionResponse(value: object): value is PaginatedResponseDocumentVersionResponse;
+export declare function PaginatedResponseDocumentVersionResponseFromJSON(json: any): PaginatedResponseDocumentVersionResponse;
+export declare function PaginatedResponseDocumentVersionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseDocumentVersionResponse;
+export declare function PaginatedResponseDocumentVersionResponseToJSON(json: any): PaginatedResponseDocumentVersionResponse;
+export declare function PaginatedResponseDocumentVersionResponseToJSONTyped(value?: PaginatedResponseDocumentVersionResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const PaginatedResponseDocumentVersionResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/models/PaginatedResponseDocumentVersionResponse.js

@@ -0,0 +1,78 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginatedResponseDocumentVersionResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfPaginatedResponseDocumentVersionResponse = instanceOfPaginatedResponseDocumentVersionResponse;
+exports.PaginatedResponseDocumentVersionResponseFromJSON = PaginatedResponseDocumentVersionResponseFromJSON;
+exports.PaginatedResponseDocumentVersionResponseFromJSONTyped = PaginatedResponseDocumentVersionResponseFromJSONTyped;
+exports.PaginatedResponseDocumentVersionResponseToJSON = PaginatedResponseDocumentVersionResponseToJSON;
+exports.PaginatedResponseDocumentVersionResponseToJSONTyped = PaginatedResponseDocumentVersionResponseToJSONTyped;
+const DocumentVersionResponse_1 = require("./DocumentVersionResponse");
+/**
+ * Check if a given object implements the PaginatedResponseDocumentVersionResponse interface.
+ */
+function instanceOfPaginatedResponseDocumentVersionResponse(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('limit' in value) || value['limit'] === undefined)
+        return false;
+    if (!('offset' in value) || value['offset'] === undefined)
+        return false;
+    return true;
+}
+function PaginatedResponseDocumentVersionResponseFromJSON(json) {
+    return PaginatedResponseDocumentVersionResponseFromJSONTyped(json, false);
+}
+function PaginatedResponseDocumentVersionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(DocumentVersionResponse_1.DocumentVersionResponseFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+function PaginatedResponseDocumentVersionResponseToJSON(json) {
+    return PaginatedResponseDocumentVersionResponseToJSONTyped(json, false);
+}
+function PaginatedResponseDocumentVersionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(DocumentVersionResponse_1.DocumentVersionResponseToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+exports.PaginatedResponseDocumentVersionResponsePropertyValidationAttributesMap = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+};