@knowledge-stack/ksapi 1.66.2 → 1.67.0

package/dist/esm/models/index.js

@@ -0,0 +1,183 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ABCDPathSnapshot';
+export * from './AcceptInviteResponse';
+export * from './AddMemberRequest';
+export * from './AncestryResponse';
+export * from './ApiKeyResponse';
+export * from './Args';
+export * from './BrandingLogoType';
+export * from './BulkTagRequest';
+export * from './ChunkBulkResponse';
+export * from './ChunkContentItem';
+export * from './ChunkDocumentResponse';
+export * from './ChunkDocumentVersionResponse';
+export * from './ChunkLineageResponse';
+export * from './ChunkMetadataInput';
+export * from './ChunkMetadataOutput';
+export * from './ChunkNeighborsResponse';
+export * from './ChunkResponse';
+export * from './ChunkSearchRequest';
+export * from './ChunkType';
+export * from './Citation';
+export * from './ClearVersionContentsResponse';
+export * from './CreateApiKeyRequest';
+export * from './CreateApiKeyResponse';
+export * from './CreateChunkLineageRequest';
+export * from './CreateChunkRequest';
+export * from './CreateDocumentRequest';
+export * from './CreateFolderRequest';
+export * from './CreateGroupPermissionRequest';
+export * from './CreateGroupRequest';
+export * from './CreatePasswordUserRequest';
+export * from './CreatePermissionRequest';
+export * from './CreateSectionRequest';
+export * from './CreateTagRequest';
+export * from './CreateThreadMessageRequest';
+export * from './CreateThreadRequest';
+export * from './CreateWorkflowDefinitionRequest';
+export * from './DirectorySyncResponse';
+export * from './DissolveSectionResponse';
+export * from './DocumentOrigin';
+export * from './DocumentResponse';
+export * from './DocumentType';
+export * from './DocumentVersionAction';
+export * from './DocumentVersionActionResponse';
+export * from './DocumentVersionContentTypeFilter';
+export * from './DocumentVersionMetadata';
+export * from './DocumentVersionMetadataUpdate';
+export * from './DocumentVersionResponse';
+export * from './EmailSentResponse';
+export * from './EmailVerificationRequest';
+export * from './EnrichedCitation';
+export * from './EnrichedThreadMessageContent';
+export * from './FeaturesResponse';
+export * from './FeedbackEventResponse';
+export * from './FeedbackRating';
+export * from './FeedbackReason';
+export * from './FeedbackTargetType';
+export * from './FolderAction';
+export * from './FolderActionResponse';
+export * from './FolderResponse';
+export * from './FolderResponseOrDocumentResponse';
+export * from './GroupPermissionResponse';
+export * from './GroupResponse';
+export * from './HTTPValidationError';
+export * from './HealthCheckResponse';
+export * from './IdpConfig';
+export * from './IdpType';
+export * from './ImageTaxonomy';
+export * from './InformationStatistics';
+export * from './IngestDocumentResponse';
+export * from './IngestionMode';
+export * from './InviteResponse';
+export * from './InviteStatus';
+export * from './InviteUserRequest';
+export * from './InvokeWorkflowRequest';
+export * from './LineageEdgeResponse';
+export * from './LineageGraphResponse';
+export * from './LineageNodeResponse';
+export * from './LocationInner';
+export * from './MembershipResponse';
+export * from './MessageRole';
+export * from './NonFilesystemReferenceType';
+export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator';
+export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
+export * from './PaginatedResponseDocumentResponse';
+export * from './PaginatedResponseDocumentVersionResponse';
+export * from './PaginatedResponseFeedbackEventResponse';
+export * from './PaginatedResponseFolderResponse';
+export * from './PaginatedResponseGroupPermissionResponse';
+export * from './PaginatedResponseGroupResponse';
+export * from './PaginatedResponseInviteResponse';
+export * from './PaginatedResponseMembershipResponse';
+export * from './PaginatedResponsePathPartResponse';
+export * from './PaginatedResponsePermissionResponse';
+export * from './PaginatedResponseTagResponse';
+export * from './PaginatedResponseTenantResponse';
+export * from './PaginatedResponseTenantUserResponse';
+export * from './PaginatedResponseThreadMessageResponse';
+export * from './PaginatedResponseThreadResponse';
+export * from './PaginatedResponseWorkflowDefinitionResponse';
+export * from './PaginatedResponseWorkflowRunResponse';
+export * from './PaginatedResponseWorkflowSummaryResponse';
+export * from './PartType';
+export * from './PasswordResetRequest';
+export * from './PasswordResetWithTokenRequest';
+export * from './PathOrder';
+export * from './PathPartAncestorItem';
+export * from './PathPartResponse';
+export * from './PathPartTagsResponse';
+export * from './PermissionCapability';
+export * from './PermissionResponse';
+export * from './PipelineState';
+export * from './PipelineStatus';
+export * from './Polygon';
+export * from './PolygonReference';
+export * from './ReferenceType';
+export * from './ResolvedReferenceInput';
+export * from './ResolvedReferenceOutput';
+export * from './RootResponse';
+export * from './SSOInitiateResponse';
+export * from './ScoredChunkResponse';
+export * from './SearchSortOrder';
+export * from './SearchType';
+export * from './SearchablePartType';
+export * from './SectionContentItem';
+export * from './SectionContentItemOrChunkContentItem';
+export * from './SectionResponse';
+export * from './SectionSystemMetadata';
+export * from './SelfHostedRunnerConfig';
+export * from './SelfHostedRunnerConfigResponse';
+export * from './SignInRequest';
+export * from './StepInput';
+export * from './StepKind';
+export * from './StepOutput';
+export * from './SubmitFeedbackRequest';
+export * from './SubtreeChunkGroup';
+export * from './SubtreeChunksResponse';
+export * from './SupportedIdP';
+export * from './SupportedLanguage';
+export * from './TagResponse';
+export * from './TemporalWorkflowStatusResponse';
+export * from './TenantBrandingResponse';
+export * from './TenantResponse';
+export * from './TenantSettingsResponse';
+export * from './TenantSettingsUpdate';
+export * from './TenantUserEditRequest';
+export * from './TenantUserResponse';
+export * from './TenantUserRole';
+export * from './ThreadMessageContent';
+export * from './ThreadMessageDetailsInput';
+export * from './ThreadMessageDetailsOutput';
+export * from './ThreadMessageResponse';
+export * from './ThreadResponse';
+export * from './UpdateChunkContentRequest';
+export * from './UpdateChunkMetadataRequest';
+export * from './UpdateDocumentRequest';
+export * from './UpdateFolderRequest';
+export * from './UpdateGroupPermissionRequest';
+export * from './UpdateGroupRequest';
+export * from './UpdatePermissionRequest';
+export * from './UpdateSectionRequest';
+export * from './UpdateTagRequest';
+export * from './UpdateTenantRequest';
+export * from './UpdateThreadRequest';
+export * from './UpdateUserRequest';
+export * from './UpdateWorkflowDefinitionRequest';
+export * from './UserMessageRequest';
+export * from './UserMessageResponse';
+export * from './UserResponse';
+export * from './ValidationError';
+export * from './VersionChunkIdsResponse';
+export * from './WorkflowActionResponse';
+export * from './WorkflowCallbackResponse';
+export * from './WorkflowCancelResponse';
+export * from './WorkflowDefinitionResponse';
+export * from './WorkflowDetailResponse';
+export * from './WorkflowRunCallbackRequest';
+export * from './WorkflowRunResponse';
+export * from './WorkflowRunSnapshot';
+export * from './WorkflowRunStatus';
+export * from './WorkflowRunnerType';
+export * from './WorkflowSummaryResponse';

package/dist/esm/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * 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.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}