@knowledge-stack/ksapi 2.14.4 → 2.15.1

package/src/apis/SkillsApi.ts

@@ -18,6 +18,7 @@ import type {
   ActivateSkillVersionRequest,
   CreateSkillRequest,
   ErrorResponse,
+  ExportSkillsRequest,
   HTTPValidationError,
   PaginatedResponseSkillResponse,
   SearchSkillsRequest,
@@ -35,6 +36,8 @@ import {
     CreateSkillRequestToJSON,
     ErrorResponseFromJSON,
     ErrorResponseToJSON,
+    ExportSkillsRequestFromJSON,
+    ExportSkillsRequestToJSON,
     HTTPValidationErrorFromJSON,
     HTTPValidationErrorToJSON,
     PaginatedResponseSkillResponseFromJSON,
@@ -85,6 +88,10 @@ export interface ExportSkillRequest {
     skillId: string;
 }
 
+export interface ExportSkillsOperationRequest {
+    exportSkillsRequest: ExportSkillsRequest;
+}
+
 export interface GetSkillRequest {
     skillId: string;
     includeFileContents?: boolean;
@@ -298,6 +305,30 @@ export interface SkillsApiInterface {
      */
     exportSkill(requestParameters: ExportSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
 
+    /**
+     * Creates request options for exportSkills without sending the request
+     * @param {ExportSkillsRequest} exportSkillsRequest 
+     * @throws {RequiredError}
+     * @memberof SkillsApiInterface
+     */
+    exportSkillsRequestOpts(requestParameters: ExportSkillsOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Download several skills\' active versions as one ZIP; needs can_read on each.
+     * @summary Export Skills Handler
+     * @param {ExportSkillsRequest} exportSkillsRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SkillsApiInterface
+     */
+    exportSkillsRaw(requestParameters: ExportSkillsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+
+    /**
+     * Download several skills\' active versions as one ZIP; needs can_read on each.
+     * Export Skills Handler
+     */
+    exportSkills(requestParameters: ExportSkillsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+
     /**
      * Creates request options for getSkill without sending the request
      * @param {string} skillId 
@@ -892,6 +923,63 @@ export class SkillsApi extends runtime.BaseAPI implements SkillsApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for exportSkills without sending the request
+     */
+    async exportSkillsRequestOpts(requestParameters: ExportSkillsOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['exportSkillsRequest'] == null) {
+            throw new runtime.RequiredError(
+                'exportSkillsRequest',
+                'Required parameter "exportSkillsRequest" was null or undefined when calling exportSkills().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/skills/export`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ExportSkillsRequestToJSON(requestParameters['exportSkillsRequest']),
+        };
+    }
+
+    /**
+     * Download several skills\' active versions as one ZIP; needs can_read on each.
+     * Export Skills Handler
+     */
+    async exportSkillsRaw(requestParameters: ExportSkillsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.exportSkillsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Download several skills\' active versions as one ZIP; needs can_read on each.
+     * Export Skills Handler
+     */
+    async exportSkills(requestParameters: ExportSkillsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.exportSkillsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getSkill without sending the request
      */

package/src/models/ExportSkillsRequest.ts

@@ -0,0 +1,88 @@
+/* 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';
+/**
+ * Skills to pack into one ZIP, each under a top-level folder named after it.
+ * @export
+ * @interface ExportSkillsRequest
+ */
+export interface ExportSkillsRequest {
+    /**
+     * Skills whose frozen active versions are packed together; duplicates are ignored. Every skill must exist and be readable.
+     * @type {Array<string>}
+     * @memberof ExportSkillsRequest
+     */
+    skillIds: Array<string>;
+}
+export const ExportSkillsRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    skillIds: {
+        maxItems: 50,
+        minItems: 1,
+        uniqueItems: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the ExportSkillsRequest interface.
+ */
+export function instanceOfExportSkillsRequest(value: object): value is ExportSkillsRequest {
+    if (!('skillIds' in value) || value['skillIds'] === undefined) return false;
+    return true;
+}
+
+export function ExportSkillsRequestFromJSON(json: any): ExportSkillsRequest {
+    return ExportSkillsRequestFromJSONTyped(json, false);
+}
+
+export function ExportSkillsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExportSkillsRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'skillIds': json['skill_ids'],
+    };
+}
+
+export function ExportSkillsRequestToJSON(json: any): ExportSkillsRequest {
+    return ExportSkillsRequestToJSONTyped(json, false);
+}
+
+export function ExportSkillsRequestToJSONTyped(value?: ExportSkillsRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'skill_ids': value['skillIds'],
+    };
+}
+

package/src/models/index.ts

@@ -138,6 +138,7 @@ export * from './EnrichedThreadMessageContent';
 export * from './ErrorResponse';
 export * from './EventResponse';
 export * from './ExcludedCommonFile';
+export * from './ExportSkillsRequest';
 export * from './ExtractRequest';
 export * from './ExtractResponse';
 export * from './FeaturesResponse';