@knowledge-stack/ksapi 2.6.0 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/.openapi-generator/FILES +0 -6
  2. package/README.md +2 -5
  3. package/dist/apis/TenantsApi.d.ts +4 -4
  4. package/dist/apis/TenantsApi.js +2 -2
  5. package/dist/apis/index.d.ts +0 -1
  6. package/dist/apis/index.js +0 -1
  7. package/dist/esm/apis/TenantsApi.d.ts +4 -4
  8. package/dist/esm/apis/TenantsApi.js +2 -2
  9. package/dist/esm/apis/index.d.ts +0 -1
  10. package/dist/esm/apis/index.js +0 -1
  11. package/dist/esm/models/EventResponse.d.ts +0 -6
  12. package/dist/esm/models/EventResponse.js +0 -2
  13. package/dist/esm/models/index.d.ts +0 -2
  14. package/dist/esm/models/index.js +0 -2
  15. package/dist/models/EventResponse.d.ts +0 -6
  16. package/dist/models/EventResponse.js +0 -2
  17. package/dist/models/index.d.ts +0 -2
  18. package/dist/models/index.js +0 -2
  19. package/docs/EventResponse.md +0 -2
  20. package/docs/TenantsApi.md +1 -1
  21. package/package.json +1 -1
  22. package/src/apis/TenantsApi.ts +4 -4
  23. package/src/apis/index.ts +0 -1
  24. package/src/models/EventResponse.ts +0 -8
  25. package/src/models/index.ts +0 -2
  26. package/dist/apis/TenantInvitationsApi.d.ts +0 -67
  27. package/dist/apis/TenantInvitationsApi.js +0 -112
  28. package/dist/esm/apis/TenantInvitationsApi.d.ts +0 -67
  29. package/dist/esm/apis/TenantInvitationsApi.js +0 -75
  30. package/dist/esm/models/AcceptTenantInvitationRequest.d.ts +0 -53
  31. package/dist/esm/models/AcceptTenantInvitationRequest.js +0 -48
  32. package/dist/esm/models/AcceptTenantInvitationResponse.d.ts +0 -59
  33. package/dist/esm/models/AcceptTenantInvitationResponse.js +0 -52
  34. package/dist/models/AcceptTenantInvitationRequest.d.ts +0 -53
  35. package/dist/models/AcceptTenantInvitationRequest.js +0 -56
  36. package/dist/models/AcceptTenantInvitationResponse.d.ts +0 -59
  37. package/dist/models/AcceptTenantInvitationResponse.js +0 -60
  38. package/docs/AcceptTenantInvitationRequest.md +0 -36
  39. package/docs/AcceptTenantInvitationResponse.md +0 -38
  40. package/docs/TenantInvitationsApi.md +0 -85
  41. package/src/apis/TenantInvitationsApi.ts +0 -136
  42. package/src/models/AcceptTenantInvitationRequest.ts +0 -93
  43. package/src/models/AcceptTenantInvitationResponse.ts +0 -101
@@ -1,67 +0,0 @@
1
- /**
2
- * Knowledge Stack API
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 0.1.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import type { AcceptTenantInvitationRequest, AcceptTenantInvitationResponse } from '../models/index';
14
- export interface AcceptTenantInvitationOperationRequest {
15
- invitationId: string;
16
- acceptTenantInvitationRequest: AcceptTenantInvitationRequest;
17
- }
18
- /**
19
- * TenantInvitationsApi - interface
20
- *
21
- * @export
22
- * @interface TenantInvitationsApiInterface
23
- */
24
- export interface TenantInvitationsApiInterface {
25
- /**
26
- * Creates request options for acceptTenantInvitation without sending the request
27
- * @param {string} invitationId
28
- * @param {AcceptTenantInvitationRequest} acceptTenantInvitationRequest
29
- * @throws {RequiredError}
30
- * @memberof TenantInvitationsApiInterface
31
- */
32
- acceptTenantInvitationRequestOpts(requestParameters: AcceptTenantInvitationOperationRequest): Promise<runtime.RequestOpts>;
33
- /**
34
- * 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).
35
- * @summary Accept Tenant Invitation Handler
36
- * @param {string} invitationId
37
- * @param {AcceptTenantInvitationRequest} acceptTenantInvitationRequest
38
- * @param {*} [options] Override http request option.
39
- * @throws {RequiredError}
40
- * @memberof TenantInvitationsApiInterface
41
- */
42
- acceptTenantInvitationRaw(requestParameters: AcceptTenantInvitationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AcceptTenantInvitationResponse>>;
43
- /**
44
- * 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).
45
- * Accept Tenant Invitation Handler
46
- */
47
- acceptTenantInvitation(requestParameters: AcceptTenantInvitationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AcceptTenantInvitationResponse>;
48
- }
49
- /**
50
- *
51
- */
52
- export declare class TenantInvitationsApi extends runtime.BaseAPI implements TenantInvitationsApiInterface {
53
- /**
54
- * Creates request options for acceptTenantInvitation without sending the request
55
- */
56
- acceptTenantInvitationRequestOpts(requestParameters: AcceptTenantInvitationOperationRequest): Promise<runtime.RequestOpts>;
57
- /**
58
- * 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).
59
- * Accept Tenant Invitation Handler
60
- */
61
- acceptTenantInvitationRaw(requestParameters: AcceptTenantInvitationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AcceptTenantInvitationResponse>>;
62
- /**
63
- * 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).
64
- * Accept Tenant Invitation Handler
65
- */
66
- acceptTenantInvitation(requestParameters: AcceptTenantInvitationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AcceptTenantInvitationResponse>;
67
- }
@@ -1,75 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Knowledge Stack API
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 0.1.0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
- return new (P || (P = Promise))(function (resolve, reject) {
17
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
- step((generator = generator.apply(thisArg, _arguments || [])).next());
21
- });
22
- };
23
- import * as runtime from '../runtime';
24
- import { AcceptTenantInvitationRequestToJSON, AcceptTenantInvitationResponseFromJSON, } from '../models/index';
25
- /**
26
- *
27
- */
28
- export class TenantInvitationsApi extends runtime.BaseAPI {
29
- /**
30
- * Creates request options for acceptTenantInvitation without sending the request
31
- */
32
- acceptTenantInvitationRequestOpts(requestParameters) {
33
- return __awaiter(this, void 0, void 0, function* () {
34
- if (requestParameters['invitationId'] == null) {
35
- throw new runtime.RequiredError('invitationId', 'Required parameter "invitationId" was null or undefined when calling acceptTenantInvitation().');
36
- }
37
- if (requestParameters['acceptTenantInvitationRequest'] == null) {
38
- throw new runtime.RequiredError('acceptTenantInvitationRequest', 'Required parameter "acceptTenantInvitationRequest" was null or undefined when calling acceptTenantInvitation().');
39
- }
40
- const queryParameters = {};
41
- const headerParameters = {};
42
- headerParameters['Content-Type'] = 'application/json';
43
- let urlPath = `/v1/tenant-invitations/{invitation_id}/accept`;
44
- urlPath = urlPath.replace(`{${"invitation_id"}}`, encodeURIComponent(String(requestParameters['invitationId'])));
45
- return {
46
- path: urlPath,
47
- method: 'POST',
48
- headers: headerParameters,
49
- query: queryParameters,
50
- body: AcceptTenantInvitationRequestToJSON(requestParameters['acceptTenantInvitationRequest']),
51
- };
52
- });
53
- }
54
- /**
55
- * 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).
56
- * Accept Tenant Invitation Handler
57
- */
58
- acceptTenantInvitationRaw(requestParameters, initOverrides) {
59
- return __awaiter(this, void 0, void 0, function* () {
60
- const requestOptions = yield this.acceptTenantInvitationRequestOpts(requestParameters);
61
- const response = yield this.request(requestOptions, initOverrides);
62
- return new runtime.JSONApiResponse(response, (jsonValue) => AcceptTenantInvitationResponseFromJSON(jsonValue));
63
- });
64
- }
65
- /**
66
- * 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).
67
- * Accept Tenant Invitation Handler
68
- */
69
- acceptTenantInvitation(requestParameters, initOverrides) {
70
- return __awaiter(this, void 0, void 0, function* () {
71
- const response = yield this.acceptTenantInvitationRaw(requestParameters, initOverrides);
72
- return yield response.value();
73
- });
74
- }
75
- }
@@ -1,53 +0,0 @@
1
- /**
2
- * Knowledge Stack API
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 0.1.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @interface AcceptTenantInvitationRequest
16
- */
17
- export interface AcceptTenantInvitationRequest {
18
- /**
19
- * Required only when the owner has no existing KS account.
20
- * @type {string}
21
- * @memberof AcceptTenantInvitationRequest
22
- */
23
- password?: string | null;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof AcceptTenantInvitationRequest
28
- */
29
- firstName?: string | null;
30
- }
31
- export declare const AcceptTenantInvitationRequestPropertyValidationAttributesMap: {
32
- [property: string]: {
33
- maxLength?: number;
34
- minLength?: number;
35
- pattern?: string;
36
- maximum?: number;
37
- exclusiveMaximum?: boolean;
38
- minimum?: number;
39
- exclusiveMinimum?: boolean;
40
- multipleOf?: number;
41
- maxItems?: number;
42
- minItems?: number;
43
- uniqueItems?: boolean;
44
- };
45
- };
46
- /**
47
- * Check if a given object implements the AcceptTenantInvitationRequest interface.
48
- */
49
- export declare function instanceOfAcceptTenantInvitationRequest(value: object): value is AcceptTenantInvitationRequest;
50
- export declare function AcceptTenantInvitationRequestFromJSON(json: any): AcceptTenantInvitationRequest;
51
- export declare function AcceptTenantInvitationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AcceptTenantInvitationRequest;
52
- export declare function AcceptTenantInvitationRequestToJSON(json: any): AcceptTenantInvitationRequest;
53
- export declare function AcceptTenantInvitationRequestToJSONTyped(value?: AcceptTenantInvitationRequest | null, ignoreDiscriminator?: boolean): any;
@@ -1,48 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Knowledge Stack API
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 0.1.0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export const AcceptTenantInvitationRequestPropertyValidationAttributesMap = {
15
- password: {
16
- minLength: 8,
17
- },
18
- };
19
- /**
20
- * Check if a given object implements the AcceptTenantInvitationRequest interface.
21
- */
22
- export function instanceOfAcceptTenantInvitationRequest(value) {
23
- return true;
24
- }
25
- export function AcceptTenantInvitationRequestFromJSON(json) {
26
- return AcceptTenantInvitationRequestFromJSONTyped(json, false);
27
- }
28
- export function AcceptTenantInvitationRequestFromJSONTyped(json, ignoreDiscriminator) {
29
- if (json == null) {
30
- return json;
31
- }
32
- return {
33
- 'password': json['password'] == null ? undefined : json['password'],
34
- 'firstName': json['first_name'] == null ? undefined : json['first_name'],
35
- };
36
- }
37
- export function AcceptTenantInvitationRequestToJSON(json) {
38
- return AcceptTenantInvitationRequestToJSONTyped(json, false);
39
- }
40
- export function AcceptTenantInvitationRequestToJSONTyped(value, ignoreDiscriminator = false) {
41
- if (value == null) {
42
- return value;
43
- }
44
- return {
45
- 'password': value['password'],
46
- 'first_name': value['firstName'],
47
- };
48
- }
@@ -1,59 +0,0 @@
1
- /**
2
- * Knowledge Stack API
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 0.1.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @interface AcceptTenantInvitationResponse
16
- */
17
- export interface AcceptTenantInvitationResponse {
18
- /**
19
- *
20
- * @type {string}
21
- * @memberof AcceptTenantInvitationResponse
22
- */
23
- tenantId: string;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof AcceptTenantInvitationResponse
28
- */
29
- tenantName: string;
30
- /**
31
- *
32
- * @type {string}
33
- * @memberof AcceptTenantInvitationResponse
34
- */
35
- userId: string;
36
- }
37
- export declare const AcceptTenantInvitationResponsePropertyValidationAttributesMap: {
38
- [property: string]: {
39
- maxLength?: number;
40
- minLength?: number;
41
- pattern?: string;
42
- maximum?: number;
43
- exclusiveMaximum?: boolean;
44
- minimum?: number;
45
- exclusiveMinimum?: boolean;
46
- multipleOf?: number;
47
- maxItems?: number;
48
- minItems?: number;
49
- uniqueItems?: boolean;
50
- };
51
- };
52
- /**
53
- * Check if a given object implements the AcceptTenantInvitationResponse interface.
54
- */
55
- export declare function instanceOfAcceptTenantInvitationResponse(value: object): value is AcceptTenantInvitationResponse;
56
- export declare function AcceptTenantInvitationResponseFromJSON(json: any): AcceptTenantInvitationResponse;
57
- export declare function AcceptTenantInvitationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AcceptTenantInvitationResponse;
58
- export declare function AcceptTenantInvitationResponseToJSON(json: any): AcceptTenantInvitationResponse;
59
- export declare function AcceptTenantInvitationResponseToJSONTyped(value?: AcceptTenantInvitationResponse | null, ignoreDiscriminator?: boolean): any;
@@ -1,52 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Knowledge Stack API
5
- * 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.
6
- *
7
- * The version of the OpenAPI document: 0.1.0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export const AcceptTenantInvitationResponsePropertyValidationAttributesMap = {};
15
- /**
16
- * Check if a given object implements the AcceptTenantInvitationResponse interface.
17
- */
18
- export function instanceOfAcceptTenantInvitationResponse(value) {
19
- if (!('tenantId' in value) || value['tenantId'] === undefined)
20
- return false;
21
- if (!('tenantName' in value) || value['tenantName'] === undefined)
22
- return false;
23
- if (!('userId' in value) || value['userId'] === undefined)
24
- return false;
25
- return true;
26
- }
27
- export function AcceptTenantInvitationResponseFromJSON(json) {
28
- return AcceptTenantInvitationResponseFromJSONTyped(json, false);
29
- }
30
- export function AcceptTenantInvitationResponseFromJSONTyped(json, ignoreDiscriminator) {
31
- if (json == null) {
32
- return json;
33
- }
34
- return {
35
- 'tenantId': json['tenant_id'],
36
- 'tenantName': json['tenant_name'],
37
- 'userId': json['user_id'],
38
- };
39
- }
40
- export function AcceptTenantInvitationResponseToJSON(json) {
41
- return AcceptTenantInvitationResponseToJSONTyped(json, false);
42
- }
43
- export function AcceptTenantInvitationResponseToJSONTyped(value, ignoreDiscriminator = false) {
44
- if (value == null) {
45
- return value;
46
- }
47
- return {
48
- 'tenant_id': value['tenantId'],
49
- 'tenant_name': value['tenantName'],
50
- 'user_id': value['userId'],
51
- };
52
- }
@@ -1,53 +0,0 @@
1
- /**
2
- * Knowledge Stack API
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 0.1.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @interface AcceptTenantInvitationRequest
16
- */
17
- export interface AcceptTenantInvitationRequest {
18
- /**
19
- * Required only when the owner has no existing KS account.
20
- * @type {string}
21
- * @memberof AcceptTenantInvitationRequest
22
- */
23
- password?: string | null;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof AcceptTenantInvitationRequest
28
- */
29
- firstName?: string | null;
30
- }
31
- export declare const AcceptTenantInvitationRequestPropertyValidationAttributesMap: {
32
- [property: string]: {
33
- maxLength?: number;
34
- minLength?: number;
35
- pattern?: string;
36
- maximum?: number;
37
- exclusiveMaximum?: boolean;
38
- minimum?: number;
39
- exclusiveMinimum?: boolean;
40
- multipleOf?: number;
41
- maxItems?: number;
42
- minItems?: number;
43
- uniqueItems?: boolean;
44
- };
45
- };
46
- /**
47
- * Check if a given object implements the AcceptTenantInvitationRequest interface.
48
- */
49
- export declare function instanceOfAcceptTenantInvitationRequest(value: object): value is AcceptTenantInvitationRequest;
50
- export declare function AcceptTenantInvitationRequestFromJSON(json: any): AcceptTenantInvitationRequest;
51
- export declare function AcceptTenantInvitationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AcceptTenantInvitationRequest;
52
- export declare function AcceptTenantInvitationRequestToJSON(json: any): AcceptTenantInvitationRequest;
53
- export declare function AcceptTenantInvitationRequestToJSONTyped(value?: AcceptTenantInvitationRequest | null, ignoreDiscriminator?: boolean): any;
@@ -1,56 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Knowledge Stack API
6
- * 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.
7
- *
8
- * The version of the OpenAPI document: 0.1.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.AcceptTenantInvitationRequestPropertyValidationAttributesMap = void 0;
17
- exports.instanceOfAcceptTenantInvitationRequest = instanceOfAcceptTenantInvitationRequest;
18
- exports.AcceptTenantInvitationRequestFromJSON = AcceptTenantInvitationRequestFromJSON;
19
- exports.AcceptTenantInvitationRequestFromJSONTyped = AcceptTenantInvitationRequestFromJSONTyped;
20
- exports.AcceptTenantInvitationRequestToJSON = AcceptTenantInvitationRequestToJSON;
21
- exports.AcceptTenantInvitationRequestToJSONTyped = AcceptTenantInvitationRequestToJSONTyped;
22
- exports.AcceptTenantInvitationRequestPropertyValidationAttributesMap = {
23
- password: {
24
- minLength: 8,
25
- },
26
- };
27
- /**
28
- * Check if a given object implements the AcceptTenantInvitationRequest interface.
29
- */
30
- function instanceOfAcceptTenantInvitationRequest(value) {
31
- return true;
32
- }
33
- function AcceptTenantInvitationRequestFromJSON(json) {
34
- return AcceptTenantInvitationRequestFromJSONTyped(json, false);
35
- }
36
- function AcceptTenantInvitationRequestFromJSONTyped(json, ignoreDiscriminator) {
37
- if (json == null) {
38
- return json;
39
- }
40
- return {
41
- 'password': json['password'] == null ? undefined : json['password'],
42
- 'firstName': json['first_name'] == null ? undefined : json['first_name'],
43
- };
44
- }
45
- function AcceptTenantInvitationRequestToJSON(json) {
46
- return AcceptTenantInvitationRequestToJSONTyped(json, false);
47
- }
48
- function AcceptTenantInvitationRequestToJSONTyped(value, ignoreDiscriminator = false) {
49
- if (value == null) {
50
- return value;
51
- }
52
- return {
53
- 'password': value['password'],
54
- 'first_name': value['firstName'],
55
- };
56
- }
@@ -1,59 +0,0 @@
1
- /**
2
- * Knowledge Stack API
3
- * 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.
4
- *
5
- * The version of the OpenAPI document: 0.1.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @interface AcceptTenantInvitationResponse
16
- */
17
- export interface AcceptTenantInvitationResponse {
18
- /**
19
- *
20
- * @type {string}
21
- * @memberof AcceptTenantInvitationResponse
22
- */
23
- tenantId: string;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof AcceptTenantInvitationResponse
28
- */
29
- tenantName: string;
30
- /**
31
- *
32
- * @type {string}
33
- * @memberof AcceptTenantInvitationResponse
34
- */
35
- userId: string;
36
- }
37
- export declare const AcceptTenantInvitationResponsePropertyValidationAttributesMap: {
38
- [property: string]: {
39
- maxLength?: number;
40
- minLength?: number;
41
- pattern?: string;
42
- maximum?: number;
43
- exclusiveMaximum?: boolean;
44
- minimum?: number;
45
- exclusiveMinimum?: boolean;
46
- multipleOf?: number;
47
- maxItems?: number;
48
- minItems?: number;
49
- uniqueItems?: boolean;
50
- };
51
- };
52
- /**
53
- * Check if a given object implements the AcceptTenantInvitationResponse interface.
54
- */
55
- export declare function instanceOfAcceptTenantInvitationResponse(value: object): value is AcceptTenantInvitationResponse;
56
- export declare function AcceptTenantInvitationResponseFromJSON(json: any): AcceptTenantInvitationResponse;
57
- export declare function AcceptTenantInvitationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AcceptTenantInvitationResponse;
58
- export declare function AcceptTenantInvitationResponseToJSON(json: any): AcceptTenantInvitationResponse;
59
- export declare function AcceptTenantInvitationResponseToJSONTyped(value?: AcceptTenantInvitationResponse | null, ignoreDiscriminator?: boolean): any;
@@ -1,60 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Knowledge Stack API
6
- * 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.
7
- *
8
- * The version of the OpenAPI document: 0.1.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.AcceptTenantInvitationResponsePropertyValidationAttributesMap = void 0;
17
- exports.instanceOfAcceptTenantInvitationResponse = instanceOfAcceptTenantInvitationResponse;
18
- exports.AcceptTenantInvitationResponseFromJSON = AcceptTenantInvitationResponseFromJSON;
19
- exports.AcceptTenantInvitationResponseFromJSONTyped = AcceptTenantInvitationResponseFromJSONTyped;
20
- exports.AcceptTenantInvitationResponseToJSON = AcceptTenantInvitationResponseToJSON;
21
- exports.AcceptTenantInvitationResponseToJSONTyped = AcceptTenantInvitationResponseToJSONTyped;
22
- exports.AcceptTenantInvitationResponsePropertyValidationAttributesMap = {};
23
- /**
24
- * Check if a given object implements the AcceptTenantInvitationResponse interface.
25
- */
26
- function instanceOfAcceptTenantInvitationResponse(value) {
27
- if (!('tenantId' in value) || value['tenantId'] === undefined)
28
- return false;
29
- if (!('tenantName' in value) || value['tenantName'] === undefined)
30
- return false;
31
- if (!('userId' in value) || value['userId'] === undefined)
32
- return false;
33
- return true;
34
- }
35
- function AcceptTenantInvitationResponseFromJSON(json) {
36
- return AcceptTenantInvitationResponseFromJSONTyped(json, false);
37
- }
38
- function AcceptTenantInvitationResponseFromJSONTyped(json, ignoreDiscriminator) {
39
- if (json == null) {
40
- return json;
41
- }
42
- return {
43
- 'tenantId': json['tenant_id'],
44
- 'tenantName': json['tenant_name'],
45
- 'userId': json['user_id'],
46
- };
47
- }
48
- function AcceptTenantInvitationResponseToJSON(json) {
49
- return AcceptTenantInvitationResponseToJSONTyped(json, false);
50
- }
51
- function AcceptTenantInvitationResponseToJSONTyped(value, ignoreDiscriminator = false) {
52
- if (value == null) {
53
- return value;
54
- }
55
- return {
56
- 'tenant_id': value['tenantId'],
57
- 'tenant_name': value['tenantName'],
58
- 'user_id': value['userId'],
59
- };
60
- }
@@ -1,36 +0,0 @@
1
-
2
- # AcceptTenantInvitationRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `password` | string
10
- `firstName` | string
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import type { AcceptTenantInvitationRequest } from '@knowledge-stack/ksapi'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "password": null,
20
- "firstName": null,
21
- } satisfies AcceptTenantInvitationRequest
22
-
23
- console.log(example)
24
-
25
- // Convert the instance to a JSON string
26
- const exampleJSON: string = JSON.stringify(example)
27
- console.log(exampleJSON)
28
-
29
- // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as AcceptTenantInvitationRequest
31
- console.log(exampleParsed)
32
- ```
33
-
34
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
-
36
-