@knowledge-stack/ksapi 3.10.2 → 3.12.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.
- package/.openapi-generator/FILES +26 -4
- package/README.md +18 -6
- package/dist/apis/AuthApi.d.ts +12 -9
- package/dist/apis/AuthApi.js +5 -2
- package/dist/apis/FeedbackApi.d.ts +10 -7
- package/dist/apis/FeedbackApi.js +5 -2
- package/dist/apis/InvitesApi.d.ts +39 -1
- package/dist/apis/InvitesApi.js +41 -0
- package/dist/apis/UsersApi.d.ts +51 -59
- package/dist/apis/UsersApi.js +50 -57
- package/dist/esm/apis/AuthApi.d.ts +12 -9
- package/dist/esm/apis/AuthApi.js +6 -3
- package/dist/esm/apis/FeedbackApi.d.ts +10 -7
- package/dist/esm/apis/FeedbackApi.js +5 -2
- package/dist/esm/apis/InvitesApi.d.ts +39 -1
- package/dist/esm/apis/InvitesApi.js +42 -1
- package/dist/esm/apis/UsersApi.d.ts +51 -59
- package/dist/esm/apis/UsersApi.js +51 -58
- package/dist/esm/models/{OnboardingProfileRequest.d.ts → AccessRequestResponse.d.ts} +14 -26
- package/dist/esm/models/{OnboardingCompanyRequest.js → AccessRequestResponse.js} +13 -20
- package/dist/esm/models/AddedBy.d.ts +25 -0
- package/dist/esm/models/AddedBy.js +43 -0
- package/dist/esm/models/CreatePasswordUserRequest.d.ts +6 -0
- package/dist/esm/models/CreatePasswordUserRequest.js +2 -0
- package/dist/esm/models/ErrorResponse.d.ts +2 -0
- package/dist/esm/models/ErrorResponse.js +2 -0
- package/dist/esm/models/FeaturesResponse.d.ts +7 -0
- package/dist/esm/models/FeaturesResponse.js +5 -0
- package/dist/esm/models/GuideModuleProgress.d.ts +66 -0
- package/dist/{models/OnboardingProfileRequest.js → esm/models/GuideModuleProgress.js} +31 -25
- package/dist/esm/models/GuideModuleStatus.d.ts +26 -0
- package/dist/esm/models/GuideModuleStatus.js +44 -0
- package/dist/esm/models/GuideModules.d.ts +126 -0
- package/dist/esm/models/GuideModules.js +69 -0
- package/dist/esm/models/InvitePreviewResponse.d.ts +80 -0
- package/dist/esm/models/InvitePreviewResponse.js +57 -0
- package/dist/esm/models/InvitePreviewState.d.ts +28 -0
- package/dist/esm/models/InvitePreviewState.js +46 -0
- package/dist/esm/models/InviteRejection.d.ts +30 -0
- package/dist/esm/models/InviteRejection.js +48 -0
- package/dist/esm/models/KbSummaryResponse.d.ts +8 -0
- package/dist/esm/models/KbSummaryResponse.js +4 -0
- package/dist/esm/models/{OnboardingCompanyRequest.d.ts → OnboardingState.d.ts} +26 -18
- package/dist/esm/models/{OnboardingProfileRequest.js → OnboardingState.js} +17 -19
- package/dist/esm/models/OnboardingStateUpdate.d.ts +61 -0
- package/dist/esm/models/OnboardingStateUpdate.js +48 -0
- package/dist/esm/models/OnboardingStep.d.ts +27 -0
- package/dist/esm/models/OnboardingStep.js +45 -0
- package/dist/esm/models/SignUpResponse.d.ts +174 -0
- package/dist/esm/models/SignUpResponse.js +107 -0
- package/dist/esm/models/TenantResponse.d.ts +7 -0
- package/dist/esm/models/TenantResponse.js +5 -0
- package/dist/esm/models/TenantUserJoinMethod.d.ts +26 -0
- package/dist/esm/models/TenantUserJoinMethod.js +44 -0
- package/dist/esm/models/UserResponse.d.ts +40 -0
- package/dist/esm/models/UserResponse.js +18 -0
- package/dist/esm/models/index.d.ts +13 -2
- package/dist/esm/models/index.js +13 -2
- package/dist/models/{OnboardingProfileRequest.d.ts → AccessRequestResponse.d.ts} +14 -26
- package/dist/models/{OnboardingCompanyRequest.js → AccessRequestResponse.js} +19 -26
- package/dist/models/AddedBy.d.ts +25 -0
- package/dist/models/AddedBy.js +51 -0
- package/dist/models/CreatePasswordUserRequest.d.ts +6 -0
- package/dist/models/CreatePasswordUserRequest.js +2 -0
- package/dist/models/ErrorResponse.d.ts +2 -0
- package/dist/models/ErrorResponse.js +2 -0
- package/dist/models/FeaturesResponse.d.ts +7 -0
- package/dist/models/FeaturesResponse.js +5 -0
- package/dist/models/GuideModuleProgress.d.ts +66 -0
- package/dist/models/GuideModuleProgress.js +72 -0
- package/dist/models/GuideModuleStatus.d.ts +26 -0
- package/dist/models/GuideModuleStatus.js +52 -0
- package/dist/models/GuideModules.d.ts +126 -0
- package/dist/models/GuideModules.js +77 -0
- package/dist/models/InvitePreviewResponse.d.ts +80 -0
- package/dist/models/InvitePreviewResponse.js +65 -0
- package/dist/models/InvitePreviewState.d.ts +28 -0
- package/dist/models/InvitePreviewState.js +54 -0
- package/dist/models/InviteRejection.d.ts +30 -0
- package/dist/models/InviteRejection.js +56 -0
- package/dist/models/KbSummaryResponse.d.ts +8 -0
- package/dist/models/KbSummaryResponse.js +4 -0
- package/dist/models/{OnboardingCompanyRequest.d.ts → OnboardingState.d.ts} +26 -18
- package/dist/models/OnboardingState.js +56 -0
- package/dist/models/OnboardingStateUpdate.d.ts +61 -0
- package/dist/models/OnboardingStateUpdate.js +56 -0
- package/dist/models/OnboardingStep.d.ts +27 -0
- package/dist/models/OnboardingStep.js +53 -0
- package/dist/models/SignUpResponse.d.ts +174 -0
- package/dist/models/SignUpResponse.js +115 -0
- package/dist/models/TenantResponse.d.ts +7 -0
- package/dist/models/TenantResponse.js +5 -0
- package/dist/models/TenantUserJoinMethod.d.ts +26 -0
- package/dist/models/TenantUserJoinMethod.js +52 -0
- package/dist/models/UserResponse.d.ts +40 -0
- package/dist/models/UserResponse.js +18 -0
- package/dist/models/index.d.ts +13 -2
- package/dist/models/index.js +13 -2
- package/docs/{OnboardingCompanyRequest.md → AccessRequestResponse.md} +6 -9
- package/docs/{OnboardingProfileRequest.md → AddedBy.md} +4 -11
- package/docs/AuthApi.md +8 -5
- package/docs/CreatePasswordUserRequest.md +2 -0
- package/docs/FeaturesResponse.md +2 -0
- package/docs/FeedbackApi.md +8 -5
- package/docs/GuideModuleProgress.md +40 -0
- package/docs/GuideModuleStatus.md +32 -0
- package/docs/GuideModules.md +60 -0
- package/docs/InvitePreviewResponse.md +44 -0
- package/docs/InvitePreviewState.md +32 -0
- package/docs/InviteRejection.md +32 -0
- package/docs/InvitesApi.md +70 -0
- package/docs/KbSummaryResponse.md +2 -0
- package/docs/OnboardingState.md +39 -0
- package/docs/OnboardingStateUpdate.md +38 -0
- package/docs/OnboardingStep.md +32 -0
- package/docs/SignUpResponse.md +74 -0
- package/docs/TenantResponse.md +2 -0
- package/docs/TenantUserJoinMethod.md +32 -0
- package/docs/UserResponse.md +12 -0
- package/docs/UsersApi.md +36 -47
- package/package.json +1 -1
- package/src/apis/AuthApi.ts +20 -10
- package/src/apis/FeedbackApi.ts +14 -7
- package/src/apis/InvitesApi.ts +78 -0
- package/src/apis/UsersApi.ts +91 -110
- package/src/models/{OnboardingCompanyRequest.ts → AccessRequestResponse.ts} +19 -32
- package/src/models/AddedBy.ts +53 -0
- package/src/models/CreatePasswordUserRequest.ts +8 -0
- package/src/models/ErrorResponse.ts +2 -0
- package/src/models/FeaturesResponse.ts +16 -0
- package/src/models/GuideModuleProgress.ts +127 -0
- package/src/models/GuideModuleStatus.ts +54 -0
- package/src/models/GuideModules.ts +194 -0
- package/src/models/InvitePreviewResponse.ts +147 -0
- package/src/models/InvitePreviewState.ts +56 -0
- package/src/models/InviteRejection.ts +58 -0
- package/src/models/KbSummaryResponse.ts +9 -0
- package/src/models/{OnboardingProfileRequest.ts → OnboardingState.ts} +47 -33
- package/src/models/OnboardingStateUpdate.ts +115 -0
- package/src/models/OnboardingStep.ts +55 -0
- package/src/models/SignUpResponse.ts +303 -0
- package/src/models/TenantResponse.ts +16 -0
- package/src/models/TenantUserJoinMethod.ts +54 -0
- package/src/models/UserResponse.ts +77 -0
- package/src/models/index.ts +13 -2
|
@@ -0,0 +1,126 @@
|
|
|
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 type { GuideModuleProgress } from './GuideModuleProgress';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface GuideModules
|
|
17
|
+
*/
|
|
18
|
+
export interface GuideModules {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {GuideModuleProgress}
|
|
22
|
+
* @memberof GuideModules
|
|
23
|
+
*/
|
|
24
|
+
core?: GuideModuleProgress | null;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {GuideModuleProgress}
|
|
28
|
+
* @memberof GuideModules
|
|
29
|
+
*/
|
|
30
|
+
groundedAnswers?: GuideModuleProgress | null;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {GuideModuleProgress}
|
|
34
|
+
* @memberof GuideModules
|
|
35
|
+
*/
|
|
36
|
+
knowledge?: GuideModuleProgress | null;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {GuideModuleProgress}
|
|
40
|
+
* @memberof GuideModules
|
|
41
|
+
*/
|
|
42
|
+
repeatableWork?: GuideModuleProgress | null;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {GuideModuleProgress}
|
|
46
|
+
* @memberof GuideModules
|
|
47
|
+
*/
|
|
48
|
+
access?: GuideModuleProgress | null;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {GuideModuleProgress}
|
|
52
|
+
* @memberof GuideModules
|
|
53
|
+
*/
|
|
54
|
+
administration?: GuideModuleProgress | null;
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
* @type {GuideModuleProgress}
|
|
58
|
+
* @memberof GuideModules
|
|
59
|
+
*/
|
|
60
|
+
documents?: GuideModuleProgress | null;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @type {GuideModuleProgress}
|
|
64
|
+
* @memberof GuideModules
|
|
65
|
+
*/
|
|
66
|
+
workflowRuns?: GuideModuleProgress | null;
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
* @type {GuideModuleProgress}
|
|
70
|
+
* @memberof GuideModules
|
|
71
|
+
*/
|
|
72
|
+
search?: GuideModuleProgress | null;
|
|
73
|
+
/**
|
|
74
|
+
*
|
|
75
|
+
* @type {GuideModuleProgress}
|
|
76
|
+
* @memberof GuideModules
|
|
77
|
+
*/
|
|
78
|
+
workflowSetup?: GuideModuleProgress | null;
|
|
79
|
+
/**
|
|
80
|
+
*
|
|
81
|
+
* @type {GuideModuleProgress}
|
|
82
|
+
* @memberof GuideModules
|
|
83
|
+
*/
|
|
84
|
+
skills?: GuideModuleProgress | null;
|
|
85
|
+
/**
|
|
86
|
+
*
|
|
87
|
+
* @type {GuideModuleProgress}
|
|
88
|
+
* @memberof GuideModules
|
|
89
|
+
*/
|
|
90
|
+
dashboard?: GuideModuleProgress | null;
|
|
91
|
+
/**
|
|
92
|
+
*
|
|
93
|
+
* @type {GuideModuleProgress}
|
|
94
|
+
* @memberof GuideModules
|
|
95
|
+
*/
|
|
96
|
+
groups?: GuideModuleProgress | null;
|
|
97
|
+
/**
|
|
98
|
+
*
|
|
99
|
+
* @type {GuideModuleProgress}
|
|
100
|
+
* @memberof GuideModules
|
|
101
|
+
*/
|
|
102
|
+
auditLog?: GuideModuleProgress | null;
|
|
103
|
+
}
|
|
104
|
+
export declare const GuideModulesPropertyValidationAttributesMap: {
|
|
105
|
+
[property: string]: {
|
|
106
|
+
maxLength?: number;
|
|
107
|
+
minLength?: number;
|
|
108
|
+
pattern?: string;
|
|
109
|
+
maximum?: number;
|
|
110
|
+
exclusiveMaximum?: boolean;
|
|
111
|
+
minimum?: number;
|
|
112
|
+
exclusiveMinimum?: boolean;
|
|
113
|
+
multipleOf?: number;
|
|
114
|
+
maxItems?: number;
|
|
115
|
+
minItems?: number;
|
|
116
|
+
uniqueItems?: boolean;
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
/**
|
|
120
|
+
* Check if a given object implements the GuideModules interface.
|
|
121
|
+
*/
|
|
122
|
+
export declare function instanceOfGuideModules(value: object): value is GuideModules;
|
|
123
|
+
export declare function GuideModulesFromJSON(json: any): GuideModules;
|
|
124
|
+
export declare function GuideModulesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GuideModules;
|
|
125
|
+
export declare function GuideModulesToJSON(json: any): GuideModules;
|
|
126
|
+
export declare function GuideModulesToJSONTyped(value?: GuideModules | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,77 @@
|
|
|
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.GuideModulesPropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfGuideModules = instanceOfGuideModules;
|
|
18
|
+
exports.GuideModulesFromJSON = GuideModulesFromJSON;
|
|
19
|
+
exports.GuideModulesFromJSONTyped = GuideModulesFromJSONTyped;
|
|
20
|
+
exports.GuideModulesToJSON = GuideModulesToJSON;
|
|
21
|
+
exports.GuideModulesToJSONTyped = GuideModulesToJSONTyped;
|
|
22
|
+
const GuideModuleProgress_1 = require("./GuideModuleProgress");
|
|
23
|
+
exports.GuideModulesPropertyValidationAttributesMap = {};
|
|
24
|
+
/**
|
|
25
|
+
* Check if a given object implements the GuideModules interface.
|
|
26
|
+
*/
|
|
27
|
+
function instanceOfGuideModules(value) {
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
function GuideModulesFromJSON(json) {
|
|
31
|
+
return GuideModulesFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
function GuideModulesFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'core': json['core'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['core']),
|
|
39
|
+
'groundedAnswers': json['grounded_answers'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['grounded_answers']),
|
|
40
|
+
'knowledge': json['knowledge'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['knowledge']),
|
|
41
|
+
'repeatableWork': json['repeatable_work'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['repeatable_work']),
|
|
42
|
+
'access': json['access'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['access']),
|
|
43
|
+
'administration': json['administration'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['administration']),
|
|
44
|
+
'documents': json['documents'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['documents']),
|
|
45
|
+
'workflowRuns': json['workflow_runs'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['workflow_runs']),
|
|
46
|
+
'search': json['search'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['search']),
|
|
47
|
+
'workflowSetup': json['workflow_setup'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['workflow_setup']),
|
|
48
|
+
'skills': json['skills'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['skills']),
|
|
49
|
+
'dashboard': json['dashboard'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['dashboard']),
|
|
50
|
+
'groups': json['groups'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['groups']),
|
|
51
|
+
'auditLog': json['audit_log'] == null ? undefined : (0, GuideModuleProgress_1.GuideModuleProgressFromJSON)(json['audit_log']),
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
function GuideModulesToJSON(json) {
|
|
55
|
+
return GuideModulesToJSONTyped(json, false);
|
|
56
|
+
}
|
|
57
|
+
function GuideModulesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
58
|
+
if (value == null) {
|
|
59
|
+
return value;
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
'core': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['core']),
|
|
63
|
+
'grounded_answers': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['groundedAnswers']),
|
|
64
|
+
'knowledge': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['knowledge']),
|
|
65
|
+
'repeatable_work': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['repeatableWork']),
|
|
66
|
+
'access': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['access']),
|
|
67
|
+
'administration': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['administration']),
|
|
68
|
+
'documents': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['documents']),
|
|
69
|
+
'workflow_runs': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['workflowRuns']),
|
|
70
|
+
'search': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['search']),
|
|
71
|
+
'workflow_setup': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['workflowSetup']),
|
|
72
|
+
'skills': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['skills']),
|
|
73
|
+
'dashboard': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['dashboard']),
|
|
74
|
+
'groups': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['groups']),
|
|
75
|
+
'audit_log': (0, GuideModuleProgress_1.GuideModuleProgressToJSON)(value['auditLog']),
|
|
76
|
+
};
|
|
77
|
+
}
|
|
@@ -0,0 +1,80 @@
|
|
|
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 type { TenantUserRole } from './TenantUserRole';
|
|
13
|
+
import type { UserInfo } from './UserInfo';
|
|
14
|
+
import type { InvitePreviewState } from './InvitePreviewState';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface InvitePreviewResponse
|
|
19
|
+
*/
|
|
20
|
+
export interface InvitePreviewResponse {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {InvitePreviewState}
|
|
24
|
+
* @memberof InvitePreviewResponse
|
|
25
|
+
*/
|
|
26
|
+
state: InvitePreviewState;
|
|
27
|
+
/**
|
|
28
|
+
* Invitee email, to lock the form
|
|
29
|
+
* @type {string}
|
|
30
|
+
* @memberof InvitePreviewResponse
|
|
31
|
+
*/
|
|
32
|
+
email?: string | null;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {string}
|
|
36
|
+
* @memberof InvitePreviewResponse
|
|
37
|
+
*/
|
|
38
|
+
tenantName?: string | null;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @type {TenantUserRole}
|
|
42
|
+
* @memberof InvitePreviewResponse
|
|
43
|
+
*/
|
|
44
|
+
role?: TenantUserRole;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {Date}
|
|
48
|
+
* @memberof InvitePreviewResponse
|
|
49
|
+
*/
|
|
50
|
+
expiresAt?: Date | null;
|
|
51
|
+
/**
|
|
52
|
+
* Display name only, no email
|
|
53
|
+
* @type {UserInfo}
|
|
54
|
+
* @memberof InvitePreviewResponse
|
|
55
|
+
*/
|
|
56
|
+
invitedBy?: UserInfo | null;
|
|
57
|
+
}
|
|
58
|
+
export declare const InvitePreviewResponsePropertyValidationAttributesMap: {
|
|
59
|
+
[property: string]: {
|
|
60
|
+
maxLength?: number;
|
|
61
|
+
minLength?: number;
|
|
62
|
+
pattern?: string;
|
|
63
|
+
maximum?: number;
|
|
64
|
+
exclusiveMaximum?: boolean;
|
|
65
|
+
minimum?: number;
|
|
66
|
+
exclusiveMinimum?: boolean;
|
|
67
|
+
multipleOf?: number;
|
|
68
|
+
maxItems?: number;
|
|
69
|
+
minItems?: number;
|
|
70
|
+
uniqueItems?: boolean;
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* Check if a given object implements the InvitePreviewResponse interface.
|
|
75
|
+
*/
|
|
76
|
+
export declare function instanceOfInvitePreviewResponse(value: object): value is InvitePreviewResponse;
|
|
77
|
+
export declare function InvitePreviewResponseFromJSON(json: any): InvitePreviewResponse;
|
|
78
|
+
export declare function InvitePreviewResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvitePreviewResponse;
|
|
79
|
+
export declare function InvitePreviewResponseToJSON(json: any): InvitePreviewResponse;
|
|
80
|
+
export declare function InvitePreviewResponseToJSONTyped(value?: InvitePreviewResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,65 @@
|
|
|
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.InvitePreviewResponsePropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfInvitePreviewResponse = instanceOfInvitePreviewResponse;
|
|
18
|
+
exports.InvitePreviewResponseFromJSON = InvitePreviewResponseFromJSON;
|
|
19
|
+
exports.InvitePreviewResponseFromJSONTyped = InvitePreviewResponseFromJSONTyped;
|
|
20
|
+
exports.InvitePreviewResponseToJSON = InvitePreviewResponseToJSON;
|
|
21
|
+
exports.InvitePreviewResponseToJSONTyped = InvitePreviewResponseToJSONTyped;
|
|
22
|
+
const TenantUserRole_1 = require("./TenantUserRole");
|
|
23
|
+
const UserInfo_1 = require("./UserInfo");
|
|
24
|
+
const InvitePreviewState_1 = require("./InvitePreviewState");
|
|
25
|
+
exports.InvitePreviewResponsePropertyValidationAttributesMap = {};
|
|
26
|
+
/**
|
|
27
|
+
* Check if a given object implements the InvitePreviewResponse interface.
|
|
28
|
+
*/
|
|
29
|
+
function instanceOfInvitePreviewResponse(value) {
|
|
30
|
+
if (!('state' in value) || value['state'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
function InvitePreviewResponseFromJSON(json) {
|
|
35
|
+
return InvitePreviewResponseFromJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
function InvitePreviewResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
38
|
+
if (json == null) {
|
|
39
|
+
return json;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'state': (0, InvitePreviewState_1.InvitePreviewStateFromJSON)(json['state']),
|
|
43
|
+
'email': json['email'] == null ? undefined : json['email'],
|
|
44
|
+
'tenantName': json['tenant_name'] == null ? undefined : json['tenant_name'],
|
|
45
|
+
'role': json['role'] == null ? undefined : (0, TenantUserRole_1.TenantUserRoleFromJSON)(json['role']),
|
|
46
|
+
'expiresAt': json['expires_at'] == null ? undefined : (new Date(json['expires_at'])),
|
|
47
|
+
'invitedBy': json['invited_by'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['invited_by']),
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
function InvitePreviewResponseToJSON(json) {
|
|
51
|
+
return InvitePreviewResponseToJSONTyped(json, false);
|
|
52
|
+
}
|
|
53
|
+
function InvitePreviewResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
54
|
+
if (value == null) {
|
|
55
|
+
return value;
|
|
56
|
+
}
|
|
57
|
+
return {
|
|
58
|
+
'state': (0, InvitePreviewState_1.InvitePreviewStateToJSON)(value['state']),
|
|
59
|
+
'email': value['email'],
|
|
60
|
+
'tenant_name': value['tenantName'],
|
|
61
|
+
'role': (0, TenantUserRole_1.TenantUserRoleToJSON)(value['role']),
|
|
62
|
+
'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
|
|
63
|
+
'invited_by': (0, UserInfo_1.UserInfoToJSON)(value['invitedBy']),
|
|
64
|
+
};
|
|
65
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
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
|
+
*/
|
|
16
|
+
export declare const InvitePreviewState: {
|
|
17
|
+
readonly Valid: 'valid';
|
|
18
|
+
readonly Expired: 'expired';
|
|
19
|
+
readonly Accepted: 'accepted';
|
|
20
|
+
readonly NotFound: 'not_found';
|
|
21
|
+
readonly TenantUnavailable: 'tenant_unavailable';
|
|
22
|
+
};
|
|
23
|
+
export type InvitePreviewState = typeof InvitePreviewState[keyof typeof InvitePreviewState];
|
|
24
|
+
export declare function instanceOfInvitePreviewState(value: any): boolean;
|
|
25
|
+
export declare function InvitePreviewStateFromJSON(json: any): InvitePreviewState;
|
|
26
|
+
export declare function InvitePreviewStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvitePreviewState;
|
|
27
|
+
export declare function InvitePreviewStateToJSON(value?: InvitePreviewState | null): any;
|
|
28
|
+
export declare function InvitePreviewStateToJSONTyped(value: any, ignoreDiscriminator: boolean): InvitePreviewState;
|
|
@@ -0,0 +1,54 @@
|
|
|
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.InvitePreviewState = void 0;
|
|
17
|
+
exports.instanceOfInvitePreviewState = instanceOfInvitePreviewState;
|
|
18
|
+
exports.InvitePreviewStateFromJSON = InvitePreviewStateFromJSON;
|
|
19
|
+
exports.InvitePreviewStateFromJSONTyped = InvitePreviewStateFromJSONTyped;
|
|
20
|
+
exports.InvitePreviewStateToJSON = InvitePreviewStateToJSON;
|
|
21
|
+
exports.InvitePreviewStateToJSONTyped = InvitePreviewStateToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
exports.InvitePreviewState = {
|
|
27
|
+
Valid: 'valid',
|
|
28
|
+
Expired: 'expired',
|
|
29
|
+
Accepted: 'accepted',
|
|
30
|
+
NotFound: 'not_found',
|
|
31
|
+
TenantUnavailable: 'tenant_unavailable'
|
|
32
|
+
};
|
|
33
|
+
function instanceOfInvitePreviewState(value) {
|
|
34
|
+
for (const key in exports.InvitePreviewState) {
|
|
35
|
+
if (Object.prototype.hasOwnProperty.call(exports.InvitePreviewState, key)) {
|
|
36
|
+
if (exports.InvitePreviewState[key] === value) {
|
|
37
|
+
return true;
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
return false;
|
|
42
|
+
}
|
|
43
|
+
function InvitePreviewStateFromJSON(json) {
|
|
44
|
+
return InvitePreviewStateFromJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
function InvitePreviewStateFromJSONTyped(json, ignoreDiscriminator) {
|
|
47
|
+
return json;
|
|
48
|
+
}
|
|
49
|
+
function InvitePreviewStateToJSON(value) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
function InvitePreviewStateToJSONTyped(value, ignoreDiscriminator) {
|
|
53
|
+
return value;
|
|
54
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
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
|
+
*/
|
|
16
|
+
export declare const InviteRejection: {
|
|
17
|
+
readonly NotFound: 'not_found';
|
|
18
|
+
readonly Accepted: 'accepted';
|
|
19
|
+
readonly Expired: 'expired';
|
|
20
|
+
readonly TenantUnavailable: 'tenant_unavailable';
|
|
21
|
+
readonly InvitesDisabled: 'invites_disabled';
|
|
22
|
+
readonly EmailMismatch: 'email_mismatch';
|
|
23
|
+
readonly NoSeat: 'no_seat';
|
|
24
|
+
};
|
|
25
|
+
export type InviteRejection = typeof InviteRejection[keyof typeof InviteRejection];
|
|
26
|
+
export declare function instanceOfInviteRejection(value: any): boolean;
|
|
27
|
+
export declare function InviteRejectionFromJSON(json: any): InviteRejection;
|
|
28
|
+
export declare function InviteRejectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): InviteRejection;
|
|
29
|
+
export declare function InviteRejectionToJSON(value?: InviteRejection | null): any;
|
|
30
|
+
export declare function InviteRejectionToJSONTyped(value: any, ignoreDiscriminator: boolean): InviteRejection;
|
|
@@ -0,0 +1,56 @@
|
|
|
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.InviteRejection = void 0;
|
|
17
|
+
exports.instanceOfInviteRejection = instanceOfInviteRejection;
|
|
18
|
+
exports.InviteRejectionFromJSON = InviteRejectionFromJSON;
|
|
19
|
+
exports.InviteRejectionFromJSONTyped = InviteRejectionFromJSONTyped;
|
|
20
|
+
exports.InviteRejectionToJSON = InviteRejectionToJSON;
|
|
21
|
+
exports.InviteRejectionToJSONTyped = InviteRejectionToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
exports.InviteRejection = {
|
|
27
|
+
NotFound: 'not_found',
|
|
28
|
+
Accepted: 'accepted',
|
|
29
|
+
Expired: 'expired',
|
|
30
|
+
TenantUnavailable: 'tenant_unavailable',
|
|
31
|
+
InvitesDisabled: 'invites_disabled',
|
|
32
|
+
EmailMismatch: 'email_mismatch',
|
|
33
|
+
NoSeat: 'no_seat'
|
|
34
|
+
};
|
|
35
|
+
function instanceOfInviteRejection(value) {
|
|
36
|
+
for (const key in exports.InviteRejection) {
|
|
37
|
+
if (Object.prototype.hasOwnProperty.call(exports.InviteRejection, key)) {
|
|
38
|
+
if (exports.InviteRejection[key] === value) {
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
return false;
|
|
44
|
+
}
|
|
45
|
+
function InviteRejectionFromJSON(json) {
|
|
46
|
+
return InviteRejectionFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
function InviteRejectionFromJSONTyped(json, ignoreDiscriminator) {
|
|
49
|
+
return json;
|
|
50
|
+
}
|
|
51
|
+
function InviteRejectionToJSON(value) {
|
|
52
|
+
return value;
|
|
53
|
+
}
|
|
54
|
+
function InviteRejectionToJSONTyped(value, ignoreDiscriminator) {
|
|
55
|
+
return value;
|
|
56
|
+
}
|
|
@@ -38,6 +38,14 @@ export interface KbSummaryResponse {
|
|
|
38
38
|
documentsByType: {
|
|
39
39
|
[key: string]: number;
|
|
40
40
|
};
|
|
41
|
+
/**
|
|
42
|
+
* Live document count keyed by the active version's pipeline status (pending, processing, completed, failed, cancelled, quota_limit). Documents whose active version was never ingested are absent.
|
|
43
|
+
* @type {{ [key: string]: number; }}
|
|
44
|
+
* @memberof KbSummaryResponse
|
|
45
|
+
*/
|
|
46
|
+
documentsByIngestionStatus: {
|
|
47
|
+
[key: string]: number;
|
|
48
|
+
};
|
|
41
49
|
/**
|
|
42
50
|
*
|
|
43
51
|
* @type {number}
|
|
@@ -31,6 +31,8 @@ function instanceOfKbSummaryResponse(value) {
|
|
|
31
31
|
return false;
|
|
32
32
|
if (!('documentsByType' in value) || value['documentsByType'] === undefined)
|
|
33
33
|
return false;
|
|
34
|
+
if (!('documentsByIngestionStatus' in value) || value['documentsByIngestionStatus'] === undefined)
|
|
35
|
+
return false;
|
|
34
36
|
if (!('documentVersionsTotal' in value) || value['documentVersionsTotal'] === undefined)
|
|
35
37
|
return false;
|
|
36
38
|
if (!('chunksTotal' in value) || value['chunksTotal'] === undefined)
|
|
@@ -72,6 +74,7 @@ function KbSummaryResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
72
74
|
'documentsTotal': json['documents_total'],
|
|
73
75
|
'documentsByOrigin': json['documents_by_origin'],
|
|
74
76
|
'documentsByType': json['documents_by_type'],
|
|
77
|
+
'documentsByIngestionStatus': json['documents_by_ingestion_status'],
|
|
75
78
|
'documentVersionsTotal': json['document_versions_total'],
|
|
76
79
|
'chunksTotal': json['chunks_total'],
|
|
77
80
|
'chunksByType': json['chunks_by_type'],
|
|
@@ -99,6 +102,7 @@ function KbSummaryResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
99
102
|
'documents_total': value['documentsTotal'],
|
|
100
103
|
'documents_by_origin': value['documentsByOrigin'],
|
|
101
104
|
'documents_by_type': value['documentsByType'],
|
|
105
|
+
'documents_by_ingestion_status': value['documentsByIngestionStatus'],
|
|
102
106
|
'document_versions_total': value['documentVersionsTotal'],
|
|
103
107
|
'chunks_total': value['chunksTotal'],
|
|
104
108
|
'chunks_by_type': value['chunksByType'],
|
|
@@ -9,26 +9,34 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { GuideModules } from './GuideModules';
|
|
13
|
+
import type { OnboardingStep } from './OnboardingStep';
|
|
12
14
|
/**
|
|
13
|
-
*
|
|
15
|
+
* Stored state: keys and steps this release does not know are dropped.
|
|
14
16
|
* @export
|
|
15
|
-
* @interface
|
|
17
|
+
* @interface OnboardingState
|
|
16
18
|
*/
|
|
17
|
-
export interface
|
|
19
|
+
export interface OnboardingState {
|
|
18
20
|
/**
|
|
19
|
-
*
|
|
20
|
-
* @type {
|
|
21
|
-
* @memberof
|
|
21
|
+
*
|
|
22
|
+
* @type {OnboardingStep}
|
|
23
|
+
* @memberof OnboardingState
|
|
22
24
|
*/
|
|
23
|
-
|
|
25
|
+
currentStep?: OnboardingStep;
|
|
24
26
|
/**
|
|
25
|
-
*
|
|
26
|
-
* @type {
|
|
27
|
-
* @memberof
|
|
27
|
+
*
|
|
28
|
+
* @type {GuideModules}
|
|
29
|
+
* @memberof OnboardingState
|
|
28
30
|
*/
|
|
29
|
-
|
|
31
|
+
guideModules?: GuideModules;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {boolean}
|
|
35
|
+
* @memberof OnboardingState
|
|
36
|
+
*/
|
|
37
|
+
setupChecklistDismissed?: boolean;
|
|
30
38
|
}
|
|
31
|
-
export declare const
|
|
39
|
+
export declare const OnboardingStatePropertyValidationAttributesMap: {
|
|
32
40
|
[property: string]: {
|
|
33
41
|
maxLength?: number;
|
|
34
42
|
minLength?: number;
|
|
@@ -44,10 +52,10 @@ export declare const OnboardingCompanyRequestPropertyValidationAttributesMap: {
|
|
|
44
52
|
};
|
|
45
53
|
};
|
|
46
54
|
/**
|
|
47
|
-
* Check if a given object implements the
|
|
55
|
+
* Check if a given object implements the OnboardingState interface.
|
|
48
56
|
*/
|
|
49
|
-
export declare function
|
|
50
|
-
export declare function
|
|
51
|
-
export declare function
|
|
52
|
-
export declare function
|
|
53
|
-
export declare function
|
|
57
|
+
export declare function instanceOfOnboardingState(value: object): value is OnboardingState;
|
|
58
|
+
export declare function OnboardingStateFromJSON(json: any): OnboardingState;
|
|
59
|
+
export declare function OnboardingStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingState;
|
|
60
|
+
export declare function OnboardingStateToJSON(json: any): OnboardingState;
|
|
61
|
+
export declare function OnboardingStateToJSONTyped(value?: OnboardingState | null, ignoreDiscriminator?: boolean): any;
|