@knowledge-stack/ksapi 2.6.0 → 2.8.0

package/docs/AcceptTenantInvitationResponse.md

@@ -1,38 +0,0 @@
-
-# AcceptTenantInvitationResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`tenantId` | string
-`tenantName` | string
-`userId` | string
-
-## Example
-
-```typescript
-import type { AcceptTenantInvitationResponse } from '@knowledge-stack/ksapi'
-
-// TODO: Update the object below with actual values
-const example = {
-  "tenantId": null,
-  "tenantName": null,
-  "userId": null,
-} satisfies AcceptTenantInvitationResponse
-
-console.log(example)
-
-// Convert the instance to a JSON string
-const exampleJSON: string = JSON.stringify(example)
-console.log(exampleJSON)
-
-// Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as AcceptTenantInvitationResponse
-console.log(exampleParsed)
-```
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-

package/docs/TenantInvitationsApi.md

@@ -1,85 +0,0 @@
-# TenantInvitationsApi
-
-All URIs are relative to *http://localhost:8000*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**acceptTenantInvitation**](TenantInvitationsApi.md#accepttenantinvitationoperation) | **POST** /v1/tenant-invitations/{invitation_id}/accept | Accept Tenant Invitation Handler |
-
-
-
-## acceptTenantInvitation
-
-> AcceptTenantInvitationResponse acceptTenantInvitation(invitationId, acceptTenantInvitationRequest)
-
-Accept Tenant Invitation Handler
-
-Accept an invitation, creating the customer tenant and its OWNER.  New owner: supply ``password`` — the account is created and signed in. Existing owner: accept while signed in as ``owner_email`` (no password).
-
-### Example
-
-```ts
-import {
-  Configuration,
-  TenantInvitationsApi,
-} from '@knowledge-stack/ksapi';
-import type { AcceptTenantInvitationOperationRequest } from '@knowledge-stack/ksapi';
-
-async function example() {
-  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const config = new Configuration({ 
-    // To configure API key authorization: cookieAuth
-    apiKey: "YOUR API KEY",
-  });
-  const api = new TenantInvitationsApi(config);
-
-  const body = {
-    // string
-    invitationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // AcceptTenantInvitationRequest
-    acceptTenantInvitationRequest: ...,
-  } satisfies AcceptTenantInvitationOperationRequest;
-
-  try {
-    const data = await api.acceptTenantInvitation(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **invitationId** | `string` |  | [Defaults to `undefined`] |
-| **acceptTenantInvitationRequest** | [AcceptTenantInvitationRequest](AcceptTenantInvitationRequest.md) |  | |
-
-### Return type
-
-[**AcceptTenantInvitationResponse**](AcceptTenantInvitationResponse.md)
-
-### Authorization
-
-[cookieAuth](../README.md#cookieAuth)
-
-### HTTP request headers
-
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
-| **422** | Validation Error |  -  |
-| **0** | Error response. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-

package/src/apis/TenantInvitationsApi.ts

@@ -1,136 +0,0 @@
-/* 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 * as runtime from '../runtime';
-import type {
-  AcceptTenantInvitationRequest,
-  AcceptTenantInvitationResponse,
-  ErrorResponse,
-  HTTPValidationError,
-} from '../models/index';
-import {
-    AcceptTenantInvitationRequestFromJSON,
-    AcceptTenantInvitationRequestToJSON,
-    AcceptTenantInvitationResponseFromJSON,
-    AcceptTenantInvitationResponseToJSON,
-    ErrorResponseFromJSON,
-    ErrorResponseToJSON,
-    HTTPValidationErrorFromJSON,
-    HTTPValidationErrorToJSON,
-} from '../models/index';
-
-export interface AcceptTenantInvitationOperationRequest {
-    invitationId: string;
-    acceptTenantInvitationRequest: AcceptTenantInvitationRequest;
-}
-
-/**
- * TenantInvitationsApi - interface
- * 
- * @export
- * @interface TenantInvitationsApiInterface
- */
-export interface TenantInvitationsApiInterface {
-    /**
-     * Creates request options for acceptTenantInvitation without sending the request
-     * @param {string} invitationId 
-     * @param {AcceptTenantInvitationRequest} acceptTenantInvitationRequest 
-     * @throws {RequiredError}
-     * @memberof TenantInvitationsApiInterface
-     */
-    acceptTenantInvitationRequestOpts(requestParameters: AcceptTenantInvitationOperationRequest): Promise<runtime.RequestOpts>;
-
-    /**
-     * Accept an invitation, creating the customer tenant and its OWNER.  New owner: supply ``password`` — the account is created and signed in. Existing owner: accept while signed in as ``owner_email`` (no password).
-     * @summary Accept Tenant Invitation Handler
-     * @param {string} invitationId 
-     * @param {AcceptTenantInvitationRequest} acceptTenantInvitationRequest 
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TenantInvitationsApiInterface
-     */
-    acceptTenantInvitationRaw(requestParameters: AcceptTenantInvitationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AcceptTenantInvitationResponse>>;
-
-    /**
-     * Accept an invitation, creating the customer tenant and its OWNER.  New owner: supply ``password`` — the account is created and signed in. Existing owner: accept while signed in as ``owner_email`` (no password).
-     * Accept Tenant Invitation Handler
-     */
-    acceptTenantInvitation(requestParameters: AcceptTenantInvitationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AcceptTenantInvitationResponse>;
-
-}
-
-/**
- * 
- */
-export class TenantInvitationsApi extends runtime.BaseAPI implements TenantInvitationsApiInterface {
-
-    /**
-     * Creates request options for acceptTenantInvitation without sending the request
-     */
-    async acceptTenantInvitationRequestOpts(requestParameters: AcceptTenantInvitationOperationRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['invitationId'] == null) {
-            throw new runtime.RequiredError(
-                'invitationId',
-                'Required parameter "invitationId" was null or undefined when calling acceptTenantInvitation().'
-            );
-        }
-
-        if (requestParameters['acceptTenantInvitationRequest'] == null) {
-            throw new runtime.RequiredError(
-                'acceptTenantInvitationRequest',
-                'Required parameter "acceptTenantInvitationRequest" was null or undefined when calling acceptTenantInvitation().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/v1/tenant-invitations/{invitation_id}/accept`;
-        urlPath = urlPath.replace(`{${"invitation_id"}}`, encodeURIComponent(String(requestParameters['invitationId'])));
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: AcceptTenantInvitationRequestToJSON(requestParameters['acceptTenantInvitationRequest']),
-        };
-    }
-
-    /**
-     * Accept an invitation, creating the customer tenant and its OWNER.  New owner: supply ``password`` — the account is created and signed in. Existing owner: accept while signed in as ``owner_email`` (no password).
-     * Accept Tenant Invitation Handler
-     */
-    async acceptTenantInvitationRaw(requestParameters: AcceptTenantInvitationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AcceptTenantInvitationResponse>> {
-        const requestOptions = await this.acceptTenantInvitationRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => AcceptTenantInvitationResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Accept an invitation, creating the customer tenant and its OWNER.  New owner: supply ``password`` — the account is created and signed in. Existing owner: accept while signed in as ``owner_email`` (no password).
-     * Accept Tenant Invitation Handler
-     */
-    async acceptTenantInvitation(requestParameters: AcceptTenantInvitationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AcceptTenantInvitationResponse> {
-        const response = await this.acceptTenantInvitationRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}

package/src/models/AcceptTenantInvitationRequest.ts

@@ -1,93 +0,0 @@
-/* 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';
-/**
- * 
- * @export
- * @interface AcceptTenantInvitationRequest
- */
-export interface AcceptTenantInvitationRequest {
-    /**
-     * Required only when the owner has no existing KS account.
-     * @type {string}
-     * @memberof AcceptTenantInvitationRequest
-     */
-    password?: string | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof AcceptTenantInvitationRequest
-     */
-    firstName?: string | null;
-}
-export const AcceptTenantInvitationRequestPropertyValidationAttributesMap: {
-    [property: string]: {
-        maxLength?: number,
-        minLength?: number,
-        pattern?: string,
-        maximum?: number,
-        exclusiveMaximum?: boolean,
-        minimum?: number,
-        exclusiveMinimum?: boolean,
-        multipleOf?: number,
-        maxItems?: number,
-        minItems?: number,
-        uniqueItems?: boolean
-    }
-} = {
-    password: {
-        minLength: 8,
-    },
-}
-
-
-/**
- * Check if a given object implements the AcceptTenantInvitationRequest interface.
- */
-export function instanceOfAcceptTenantInvitationRequest(value: object): value is AcceptTenantInvitationRequest {
-    return true;
-}
-
-export function AcceptTenantInvitationRequestFromJSON(json: any): AcceptTenantInvitationRequest {
-    return AcceptTenantInvitationRequestFromJSONTyped(json, false);
-}
-
-export function AcceptTenantInvitationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AcceptTenantInvitationRequest {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'password': json['password'] == null ? undefined : json['password'],
-        'firstName': json['first_name'] == null ? undefined : json['first_name'],
-    };
-}
-
-export function AcceptTenantInvitationRequestToJSON(json: any): AcceptTenantInvitationRequest {
-    return AcceptTenantInvitationRequestToJSONTyped(json, false);
-}
-
-export function AcceptTenantInvitationRequestToJSONTyped(value?: AcceptTenantInvitationRequest | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'password': value['password'],
-        'first_name': value['firstName'],
-    };
-}
-

package/src/models/AcceptTenantInvitationResponse.ts

@@ -1,101 +0,0 @@
-/* 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';
-/**
- * 
- * @export
- * @interface AcceptTenantInvitationResponse
- */
-export interface AcceptTenantInvitationResponse {
-    /**
-     * 
-     * @type {string}
-     * @memberof AcceptTenantInvitationResponse
-     */
-    tenantId: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AcceptTenantInvitationResponse
-     */
-    tenantName: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof AcceptTenantInvitationResponse
-     */
-    userId: string;
-}
-export const AcceptTenantInvitationResponsePropertyValidationAttributesMap: {
-    [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 AcceptTenantInvitationResponse interface.
- */
-export function instanceOfAcceptTenantInvitationResponse(value: object): value is AcceptTenantInvitationResponse {
-    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
-    if (!('tenantName' in value) || value['tenantName'] === undefined) return false;
-    if (!('userId' in value) || value['userId'] === undefined) return false;
-    return true;
-}
-
-export function AcceptTenantInvitationResponseFromJSON(json: any): AcceptTenantInvitationResponse {
-    return AcceptTenantInvitationResponseFromJSONTyped(json, false);
-}
-
-export function AcceptTenantInvitationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AcceptTenantInvitationResponse {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'tenantId': json['tenant_id'],
-        'tenantName': json['tenant_name'],
-        'userId': json['user_id'],
-    };
-}
-
-export function AcceptTenantInvitationResponseToJSON(json: any): AcceptTenantInvitationResponse {
-    return AcceptTenantInvitationResponseToJSONTyped(json, false);
-}
-
-export function AcceptTenantInvitationResponseToJSONTyped(value?: AcceptTenantInvitationResponse | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'tenant_id': value['tenantId'],
-        'tenant_name': value['tenantName'],
-        'user_id': value['userId'],
-    };
-}
-