@knowledge-stack/ksapi 3.11.0 → 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.
Files changed (145) hide show
  1. package/.openapi-generator/FILES +26 -4
  2. package/README.md +18 -6
  3. package/dist/apis/AuthApi.d.ts +12 -9
  4. package/dist/apis/AuthApi.js +5 -2
  5. package/dist/apis/FeedbackApi.d.ts +10 -7
  6. package/dist/apis/FeedbackApi.js +5 -2
  7. package/dist/apis/InvitesApi.d.ts +39 -1
  8. package/dist/apis/InvitesApi.js +41 -0
  9. package/dist/apis/UsersApi.d.ts +51 -59
  10. package/dist/apis/UsersApi.js +50 -57
  11. package/dist/esm/apis/AuthApi.d.ts +12 -9
  12. package/dist/esm/apis/AuthApi.js +6 -3
  13. package/dist/esm/apis/FeedbackApi.d.ts +10 -7
  14. package/dist/esm/apis/FeedbackApi.js +5 -2
  15. package/dist/esm/apis/InvitesApi.d.ts +39 -1
  16. package/dist/esm/apis/InvitesApi.js +42 -1
  17. package/dist/esm/apis/UsersApi.d.ts +51 -59
  18. package/dist/esm/apis/UsersApi.js +51 -58
  19. package/dist/esm/models/{OnboardingProfileRequest.d.ts → AccessRequestResponse.d.ts} +14 -26
  20. package/dist/esm/models/{OnboardingCompanyRequest.js → AccessRequestResponse.js} +13 -20
  21. package/dist/esm/models/AddedBy.d.ts +25 -0
  22. package/dist/esm/models/AddedBy.js +43 -0
  23. package/dist/esm/models/CreatePasswordUserRequest.d.ts +6 -0
  24. package/dist/esm/models/CreatePasswordUserRequest.js +2 -0
  25. package/dist/esm/models/ErrorResponse.d.ts +2 -0
  26. package/dist/esm/models/ErrorResponse.js +2 -0
  27. package/dist/esm/models/FeaturesResponse.d.ts +7 -0
  28. package/dist/esm/models/FeaturesResponse.js +5 -0
  29. package/dist/esm/models/GuideModuleProgress.d.ts +66 -0
  30. package/dist/{models/OnboardingProfileRequest.js → esm/models/GuideModuleProgress.js} +31 -25
  31. package/dist/esm/models/GuideModuleStatus.d.ts +26 -0
  32. package/dist/esm/models/GuideModuleStatus.js +44 -0
  33. package/dist/esm/models/GuideModules.d.ts +126 -0
  34. package/dist/esm/models/GuideModules.js +69 -0
  35. package/dist/esm/models/InvitePreviewResponse.d.ts +80 -0
  36. package/dist/esm/models/InvitePreviewResponse.js +57 -0
  37. package/dist/esm/models/InvitePreviewState.d.ts +28 -0
  38. package/dist/esm/models/InvitePreviewState.js +46 -0
  39. package/dist/esm/models/InviteRejection.d.ts +30 -0
  40. package/dist/esm/models/InviteRejection.js +48 -0
  41. package/dist/esm/models/KbSummaryResponse.d.ts +8 -0
  42. package/dist/esm/models/KbSummaryResponse.js +4 -0
  43. package/dist/esm/models/{OnboardingCompanyRequest.d.ts → OnboardingState.d.ts} +26 -18
  44. package/dist/esm/models/{OnboardingProfileRequest.js → OnboardingState.js} +17 -19
  45. package/dist/esm/models/OnboardingStateUpdate.d.ts +61 -0
  46. package/dist/esm/models/OnboardingStateUpdate.js +48 -0
  47. package/dist/esm/models/OnboardingStep.d.ts +27 -0
  48. package/dist/esm/models/OnboardingStep.js +45 -0
  49. package/dist/esm/models/SignUpResponse.d.ts +174 -0
  50. package/dist/esm/models/SignUpResponse.js +107 -0
  51. package/dist/esm/models/TenantResponse.d.ts +7 -0
  52. package/dist/esm/models/TenantResponse.js +5 -0
  53. package/dist/esm/models/TenantUserJoinMethod.d.ts +26 -0
  54. package/dist/esm/models/TenantUserJoinMethod.js +44 -0
  55. package/dist/esm/models/UserResponse.d.ts +40 -0
  56. package/dist/esm/models/UserResponse.js +18 -0
  57. package/dist/esm/models/index.d.ts +13 -2
  58. package/dist/esm/models/index.js +13 -2
  59. package/dist/models/{OnboardingProfileRequest.d.ts → AccessRequestResponse.d.ts} +14 -26
  60. package/dist/models/{OnboardingCompanyRequest.js → AccessRequestResponse.js} +19 -26
  61. package/dist/models/AddedBy.d.ts +25 -0
  62. package/dist/models/AddedBy.js +51 -0
  63. package/dist/models/CreatePasswordUserRequest.d.ts +6 -0
  64. package/dist/models/CreatePasswordUserRequest.js +2 -0
  65. package/dist/models/ErrorResponse.d.ts +2 -0
  66. package/dist/models/ErrorResponse.js +2 -0
  67. package/dist/models/FeaturesResponse.d.ts +7 -0
  68. package/dist/models/FeaturesResponse.js +5 -0
  69. package/dist/models/GuideModuleProgress.d.ts +66 -0
  70. package/dist/models/GuideModuleProgress.js +72 -0
  71. package/dist/models/GuideModuleStatus.d.ts +26 -0
  72. package/dist/models/GuideModuleStatus.js +52 -0
  73. package/dist/models/GuideModules.d.ts +126 -0
  74. package/dist/models/GuideModules.js +77 -0
  75. package/dist/models/InvitePreviewResponse.d.ts +80 -0
  76. package/dist/models/InvitePreviewResponse.js +65 -0
  77. package/dist/models/InvitePreviewState.d.ts +28 -0
  78. package/dist/models/InvitePreviewState.js +54 -0
  79. package/dist/models/InviteRejection.d.ts +30 -0
  80. package/dist/models/InviteRejection.js +56 -0
  81. package/dist/models/KbSummaryResponse.d.ts +8 -0
  82. package/dist/models/KbSummaryResponse.js +4 -0
  83. package/dist/models/{OnboardingCompanyRequest.d.ts → OnboardingState.d.ts} +26 -18
  84. package/dist/models/OnboardingState.js +56 -0
  85. package/dist/models/OnboardingStateUpdate.d.ts +61 -0
  86. package/dist/models/OnboardingStateUpdate.js +56 -0
  87. package/dist/models/OnboardingStep.d.ts +27 -0
  88. package/dist/models/OnboardingStep.js +53 -0
  89. package/dist/models/SignUpResponse.d.ts +174 -0
  90. package/dist/models/SignUpResponse.js +115 -0
  91. package/dist/models/TenantResponse.d.ts +7 -0
  92. package/dist/models/TenantResponse.js +5 -0
  93. package/dist/models/TenantUserJoinMethod.d.ts +26 -0
  94. package/dist/models/TenantUserJoinMethod.js +52 -0
  95. package/dist/models/UserResponse.d.ts +40 -0
  96. package/dist/models/UserResponse.js +18 -0
  97. package/dist/models/index.d.ts +13 -2
  98. package/dist/models/index.js +13 -2
  99. package/docs/{OnboardingCompanyRequest.md → AccessRequestResponse.md} +6 -9
  100. package/docs/{OnboardingProfileRequest.md → AddedBy.md} +4 -11
  101. package/docs/AuthApi.md +8 -5
  102. package/docs/CreatePasswordUserRequest.md +2 -0
  103. package/docs/FeaturesResponse.md +2 -0
  104. package/docs/FeedbackApi.md +8 -5
  105. package/docs/GuideModuleProgress.md +40 -0
  106. package/docs/GuideModuleStatus.md +32 -0
  107. package/docs/GuideModules.md +60 -0
  108. package/docs/InvitePreviewResponse.md +44 -0
  109. package/docs/InvitePreviewState.md +32 -0
  110. package/docs/InviteRejection.md +32 -0
  111. package/docs/InvitesApi.md +70 -0
  112. package/docs/KbSummaryResponse.md +2 -0
  113. package/docs/OnboardingState.md +39 -0
  114. package/docs/OnboardingStateUpdate.md +38 -0
  115. package/docs/OnboardingStep.md +32 -0
  116. package/docs/SignUpResponse.md +74 -0
  117. package/docs/TenantResponse.md +2 -0
  118. package/docs/TenantUserJoinMethod.md +32 -0
  119. package/docs/UserResponse.md +12 -0
  120. package/docs/UsersApi.md +36 -47
  121. package/package.json +1 -1
  122. package/src/apis/AuthApi.ts +20 -10
  123. package/src/apis/FeedbackApi.ts +14 -7
  124. package/src/apis/InvitesApi.ts +78 -0
  125. package/src/apis/UsersApi.ts +91 -110
  126. package/src/models/{OnboardingCompanyRequest.ts → AccessRequestResponse.ts} +19 -32
  127. package/src/models/AddedBy.ts +53 -0
  128. package/src/models/CreatePasswordUserRequest.ts +8 -0
  129. package/src/models/ErrorResponse.ts +2 -0
  130. package/src/models/FeaturesResponse.ts +16 -0
  131. package/src/models/GuideModuleProgress.ts +127 -0
  132. package/src/models/GuideModuleStatus.ts +54 -0
  133. package/src/models/GuideModules.ts +194 -0
  134. package/src/models/InvitePreviewResponse.ts +147 -0
  135. package/src/models/InvitePreviewState.ts +56 -0
  136. package/src/models/InviteRejection.ts +58 -0
  137. package/src/models/KbSummaryResponse.ts +9 -0
  138. package/src/models/{OnboardingProfileRequest.ts → OnboardingState.ts} +47 -33
  139. package/src/models/OnboardingStateUpdate.ts +115 -0
  140. package/src/models/OnboardingStep.ts +55 -0
  141. package/src/models/SignUpResponse.ts +303 -0
  142. package/src/models/TenantResponse.ts +16 -0
  143. package/src/models/TenantUserJoinMethod.ts +54 -0
  144. package/src/models/UserResponse.ts +77 -0
  145. package/src/models/index.ts +13 -2
@@ -0,0 +1,127 @@
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
+
15
+ import { mapValues } from '../runtime';
16
+ import type { GuideModuleStatus } from './GuideModuleStatus';
17
+ import {
18
+ GuideModuleStatusFromJSON,
19
+ GuideModuleStatusFromJSONTyped,
20
+ GuideModuleStatusToJSON,
21
+ GuideModuleStatusToJSONTyped,
22
+ } from './GuideModuleStatus';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface GuideModuleProgress
28
+ */
29
+ export interface GuideModuleProgress {
30
+ /**
31
+ *
32
+ * @type {GuideModuleStatus}
33
+ * @memberof GuideModuleProgress
34
+ */
35
+ status: GuideModuleStatus;
36
+ /**
37
+ * Index of the last step the person reached
38
+ * @type {number}
39
+ * @memberof GuideModuleProgress
40
+ */
41
+ step: number;
42
+ /**
43
+ * Version of the module definition
44
+ * @type {number}
45
+ * @memberof GuideModuleProgress
46
+ */
47
+ version: number;
48
+ /**
49
+ * Server-stamped when the module first became COMPLETED; a client value is ignored. Null while not completed.
50
+ * @type {Date}
51
+ * @memberof GuideModuleProgress
52
+ */
53
+ completedAt?: Date | null;
54
+ }
55
+
56
+
57
+ export const GuideModuleProgressPropertyValidationAttributesMap: {
58
+ [property: string]: {
59
+ maxLength?: number,
60
+ minLength?: number,
61
+ pattern?: string,
62
+ maximum?: number,
63
+ exclusiveMaximum?: boolean,
64
+ minimum?: number,
65
+ exclusiveMinimum?: boolean,
66
+ multipleOf?: number,
67
+ maxItems?: number,
68
+ minItems?: number,
69
+ uniqueItems?: boolean
70
+ }
71
+ } = {
72
+ step: {
73
+ minimum: 0,
74
+ exclusiveMinimum: false,
75
+ },
76
+ version: {
77
+ minimum: 1,
78
+ exclusiveMinimum: false,
79
+ },
80
+ }
81
+
82
+
83
+ /**
84
+ * Check if a given object implements the GuideModuleProgress interface.
85
+ */
86
+ export function instanceOfGuideModuleProgress(value: object): value is GuideModuleProgress {
87
+ if (!('status' in value) || value['status'] === undefined) return false;
88
+ if (!('step' in value) || value['step'] === undefined) return false;
89
+ if (!('version' in value) || value['version'] === undefined) return false;
90
+ return true;
91
+ }
92
+
93
+ export function GuideModuleProgressFromJSON(json: any): GuideModuleProgress {
94
+ return GuideModuleProgressFromJSONTyped(json, false);
95
+ }
96
+
97
+ export function GuideModuleProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): GuideModuleProgress {
98
+ if (json == null) {
99
+ return json;
100
+ }
101
+ return {
102
+
103
+ 'status': GuideModuleStatusFromJSON(json['status']),
104
+ 'step': json['step'],
105
+ 'version': json['version'],
106
+ 'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
107
+ };
108
+ }
109
+
110
+ export function GuideModuleProgressToJSON(json: any): GuideModuleProgress {
111
+ return GuideModuleProgressToJSONTyped(json, false);
112
+ }
113
+
114
+ export function GuideModuleProgressToJSONTyped(value?: GuideModuleProgress | null, ignoreDiscriminator: boolean = false): any {
115
+ if (value == null) {
116
+ return value;
117
+ }
118
+
119
+ return {
120
+
121
+ 'status': GuideModuleStatusToJSON(value['status']),
122
+ 'step': value['step'],
123
+ 'version': value['version'],
124
+ 'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
125
+ };
126
+ }
127
+
@@ -0,0 +1,54 @@
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
+
15
+
16
+ /**
17
+ *
18
+ * @export
19
+ */
20
+ export const GuideModuleStatus = {
21
+ InProgress: 'IN_PROGRESS',
22
+ Completed: 'COMPLETED',
23
+ Dismissed: 'DISMISSED'
24
+ } as const;
25
+ export type GuideModuleStatus = typeof GuideModuleStatus[keyof typeof GuideModuleStatus];
26
+
27
+
28
+ export function instanceOfGuideModuleStatus(value: any): boolean {
29
+ for (const key in GuideModuleStatus) {
30
+ if (Object.prototype.hasOwnProperty.call(GuideModuleStatus, key)) {
31
+ if (GuideModuleStatus[key as keyof typeof GuideModuleStatus] === value) {
32
+ return true;
33
+ }
34
+ }
35
+ }
36
+ return false;
37
+ }
38
+
39
+ export function GuideModuleStatusFromJSON(json: any): GuideModuleStatus {
40
+ return GuideModuleStatusFromJSONTyped(json, false);
41
+ }
42
+
43
+ export function GuideModuleStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): GuideModuleStatus {
44
+ return json as GuideModuleStatus;
45
+ }
46
+
47
+ export function GuideModuleStatusToJSON(value?: GuideModuleStatus | null): any {
48
+ return value as any;
49
+ }
50
+
51
+ export function GuideModuleStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): GuideModuleStatus {
52
+ return value as GuideModuleStatus;
53
+ }
54
+
@@ -0,0 +1,194 @@
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
+
15
+ import { mapValues } from '../runtime';
16
+ import type { GuideModuleProgress } from './GuideModuleProgress';
17
+ import {
18
+ GuideModuleProgressFromJSON,
19
+ GuideModuleProgressFromJSONTyped,
20
+ GuideModuleProgressToJSON,
21
+ GuideModuleProgressToJSONTyped,
22
+ } from './GuideModuleProgress';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface GuideModules
28
+ */
29
+ export interface GuideModules {
30
+ /**
31
+ *
32
+ * @type {GuideModuleProgress}
33
+ * @memberof GuideModules
34
+ */
35
+ core?: GuideModuleProgress | null;
36
+ /**
37
+ *
38
+ * @type {GuideModuleProgress}
39
+ * @memberof GuideModules
40
+ */
41
+ groundedAnswers?: GuideModuleProgress | null;
42
+ /**
43
+ *
44
+ * @type {GuideModuleProgress}
45
+ * @memberof GuideModules
46
+ */
47
+ knowledge?: GuideModuleProgress | null;
48
+ /**
49
+ *
50
+ * @type {GuideModuleProgress}
51
+ * @memberof GuideModules
52
+ */
53
+ repeatableWork?: GuideModuleProgress | null;
54
+ /**
55
+ *
56
+ * @type {GuideModuleProgress}
57
+ * @memberof GuideModules
58
+ */
59
+ access?: GuideModuleProgress | null;
60
+ /**
61
+ *
62
+ * @type {GuideModuleProgress}
63
+ * @memberof GuideModules
64
+ */
65
+ administration?: GuideModuleProgress | null;
66
+ /**
67
+ *
68
+ * @type {GuideModuleProgress}
69
+ * @memberof GuideModules
70
+ */
71
+ documents?: GuideModuleProgress | null;
72
+ /**
73
+ *
74
+ * @type {GuideModuleProgress}
75
+ * @memberof GuideModules
76
+ */
77
+ workflowRuns?: GuideModuleProgress | null;
78
+ /**
79
+ *
80
+ * @type {GuideModuleProgress}
81
+ * @memberof GuideModules
82
+ */
83
+ search?: GuideModuleProgress | null;
84
+ /**
85
+ *
86
+ * @type {GuideModuleProgress}
87
+ * @memberof GuideModules
88
+ */
89
+ workflowSetup?: GuideModuleProgress | null;
90
+ /**
91
+ *
92
+ * @type {GuideModuleProgress}
93
+ * @memberof GuideModules
94
+ */
95
+ skills?: GuideModuleProgress | null;
96
+ /**
97
+ *
98
+ * @type {GuideModuleProgress}
99
+ * @memberof GuideModules
100
+ */
101
+ dashboard?: GuideModuleProgress | null;
102
+ /**
103
+ *
104
+ * @type {GuideModuleProgress}
105
+ * @memberof GuideModules
106
+ */
107
+ groups?: GuideModuleProgress | null;
108
+ /**
109
+ *
110
+ * @type {GuideModuleProgress}
111
+ * @memberof GuideModules
112
+ */
113
+ auditLog?: GuideModuleProgress | null;
114
+ }
115
+ export const GuideModulesPropertyValidationAttributesMap: {
116
+ [property: string]: {
117
+ maxLength?: number,
118
+ minLength?: number,
119
+ pattern?: string,
120
+ maximum?: number,
121
+ exclusiveMaximum?: boolean,
122
+ minimum?: number,
123
+ exclusiveMinimum?: boolean,
124
+ multipleOf?: number,
125
+ maxItems?: number,
126
+ minItems?: number,
127
+ uniqueItems?: boolean
128
+ }
129
+ } = {
130
+ }
131
+
132
+
133
+ /**
134
+ * Check if a given object implements the GuideModules interface.
135
+ */
136
+ export function instanceOfGuideModules(value: object): value is GuideModules {
137
+ return true;
138
+ }
139
+
140
+ export function GuideModulesFromJSON(json: any): GuideModules {
141
+ return GuideModulesFromJSONTyped(json, false);
142
+ }
143
+
144
+ export function GuideModulesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GuideModules {
145
+ if (json == null) {
146
+ return json;
147
+ }
148
+ return {
149
+
150
+ 'core': json['core'] == null ? undefined : GuideModuleProgressFromJSON(json['core']),
151
+ 'groundedAnswers': json['grounded_answers'] == null ? undefined : GuideModuleProgressFromJSON(json['grounded_answers']),
152
+ 'knowledge': json['knowledge'] == null ? undefined : GuideModuleProgressFromJSON(json['knowledge']),
153
+ 'repeatableWork': json['repeatable_work'] == null ? undefined : GuideModuleProgressFromJSON(json['repeatable_work']),
154
+ 'access': json['access'] == null ? undefined : GuideModuleProgressFromJSON(json['access']),
155
+ 'administration': json['administration'] == null ? undefined : GuideModuleProgressFromJSON(json['administration']),
156
+ 'documents': json['documents'] == null ? undefined : GuideModuleProgressFromJSON(json['documents']),
157
+ 'workflowRuns': json['workflow_runs'] == null ? undefined : GuideModuleProgressFromJSON(json['workflow_runs']),
158
+ 'search': json['search'] == null ? undefined : GuideModuleProgressFromJSON(json['search']),
159
+ 'workflowSetup': json['workflow_setup'] == null ? undefined : GuideModuleProgressFromJSON(json['workflow_setup']),
160
+ 'skills': json['skills'] == null ? undefined : GuideModuleProgressFromJSON(json['skills']),
161
+ 'dashboard': json['dashboard'] == null ? undefined : GuideModuleProgressFromJSON(json['dashboard']),
162
+ 'groups': json['groups'] == null ? undefined : GuideModuleProgressFromJSON(json['groups']),
163
+ 'auditLog': json['audit_log'] == null ? undefined : GuideModuleProgressFromJSON(json['audit_log']),
164
+ };
165
+ }
166
+
167
+ export function GuideModulesToJSON(json: any): GuideModules {
168
+ return GuideModulesToJSONTyped(json, false);
169
+ }
170
+
171
+ export function GuideModulesToJSONTyped(value?: GuideModules | null, ignoreDiscriminator: boolean = false): any {
172
+ if (value == null) {
173
+ return value;
174
+ }
175
+
176
+ return {
177
+
178
+ 'core': GuideModuleProgressToJSON(value['core']),
179
+ 'grounded_answers': GuideModuleProgressToJSON(value['groundedAnswers']),
180
+ 'knowledge': GuideModuleProgressToJSON(value['knowledge']),
181
+ 'repeatable_work': GuideModuleProgressToJSON(value['repeatableWork']),
182
+ 'access': GuideModuleProgressToJSON(value['access']),
183
+ 'administration': GuideModuleProgressToJSON(value['administration']),
184
+ 'documents': GuideModuleProgressToJSON(value['documents']),
185
+ 'workflow_runs': GuideModuleProgressToJSON(value['workflowRuns']),
186
+ 'search': GuideModuleProgressToJSON(value['search']),
187
+ 'workflow_setup': GuideModuleProgressToJSON(value['workflowSetup']),
188
+ 'skills': GuideModuleProgressToJSON(value['skills']),
189
+ 'dashboard': GuideModuleProgressToJSON(value['dashboard']),
190
+ 'groups': GuideModuleProgressToJSON(value['groups']),
191
+ 'audit_log': GuideModuleProgressToJSON(value['auditLog']),
192
+ };
193
+ }
194
+
@@ -0,0 +1,147 @@
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
+
15
+ import { mapValues } from '../runtime';
16
+ import type { TenantUserRole } from './TenantUserRole';
17
+ import {
18
+ TenantUserRoleFromJSON,
19
+ TenantUserRoleFromJSONTyped,
20
+ TenantUserRoleToJSON,
21
+ TenantUserRoleToJSONTyped,
22
+ } from './TenantUserRole';
23
+ import type { UserInfo } from './UserInfo';
24
+ import {
25
+ UserInfoFromJSON,
26
+ UserInfoFromJSONTyped,
27
+ UserInfoToJSON,
28
+ UserInfoToJSONTyped,
29
+ } from './UserInfo';
30
+ import type { InvitePreviewState } from './InvitePreviewState';
31
+ import {
32
+ InvitePreviewStateFromJSON,
33
+ InvitePreviewStateFromJSONTyped,
34
+ InvitePreviewStateToJSON,
35
+ InvitePreviewStateToJSONTyped,
36
+ } from './InvitePreviewState';
37
+
38
+ /**
39
+ *
40
+ * @export
41
+ * @interface InvitePreviewResponse
42
+ */
43
+ export interface InvitePreviewResponse {
44
+ /**
45
+ *
46
+ * @type {InvitePreviewState}
47
+ * @memberof InvitePreviewResponse
48
+ */
49
+ state: InvitePreviewState;
50
+ /**
51
+ * Invitee email, to lock the form
52
+ * @type {string}
53
+ * @memberof InvitePreviewResponse
54
+ */
55
+ email?: string | null;
56
+ /**
57
+ *
58
+ * @type {string}
59
+ * @memberof InvitePreviewResponse
60
+ */
61
+ tenantName?: string | null;
62
+ /**
63
+ *
64
+ * @type {TenantUserRole}
65
+ * @memberof InvitePreviewResponse
66
+ */
67
+ role?: TenantUserRole;
68
+ /**
69
+ *
70
+ * @type {Date}
71
+ * @memberof InvitePreviewResponse
72
+ */
73
+ expiresAt?: Date | null;
74
+ /**
75
+ * Display name only, no email
76
+ * @type {UserInfo}
77
+ * @memberof InvitePreviewResponse
78
+ */
79
+ invitedBy?: UserInfo | null;
80
+ }
81
+
82
+
83
+ export const InvitePreviewResponsePropertyValidationAttributesMap: {
84
+ [property: string]: {
85
+ maxLength?: number,
86
+ minLength?: number,
87
+ pattern?: string,
88
+ maximum?: number,
89
+ exclusiveMaximum?: boolean,
90
+ minimum?: number,
91
+ exclusiveMinimum?: boolean,
92
+ multipleOf?: number,
93
+ maxItems?: number,
94
+ minItems?: number,
95
+ uniqueItems?: boolean
96
+ }
97
+ } = {
98
+ }
99
+
100
+
101
+ /**
102
+ * Check if a given object implements the InvitePreviewResponse interface.
103
+ */
104
+ export function instanceOfInvitePreviewResponse(value: object): value is InvitePreviewResponse {
105
+ if (!('state' in value) || value['state'] === undefined) return false;
106
+ return true;
107
+ }
108
+
109
+ export function InvitePreviewResponseFromJSON(json: any): InvitePreviewResponse {
110
+ return InvitePreviewResponseFromJSONTyped(json, false);
111
+ }
112
+
113
+ export function InvitePreviewResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvitePreviewResponse {
114
+ if (json == null) {
115
+ return json;
116
+ }
117
+ return {
118
+
119
+ 'state': InvitePreviewStateFromJSON(json['state']),
120
+ 'email': json['email'] == null ? undefined : json['email'],
121
+ 'tenantName': json['tenant_name'] == null ? undefined : json['tenant_name'],
122
+ 'role': json['role'] == null ? undefined : TenantUserRoleFromJSON(json['role']),
123
+ 'expiresAt': json['expires_at'] == null ? undefined : (new Date(json['expires_at'])),
124
+ 'invitedBy': json['invited_by'] == null ? undefined : UserInfoFromJSON(json['invited_by']),
125
+ };
126
+ }
127
+
128
+ export function InvitePreviewResponseToJSON(json: any): InvitePreviewResponse {
129
+ return InvitePreviewResponseToJSONTyped(json, false);
130
+ }
131
+
132
+ export function InvitePreviewResponseToJSONTyped(value?: InvitePreviewResponse | null, ignoreDiscriminator: boolean = false): any {
133
+ if (value == null) {
134
+ return value;
135
+ }
136
+
137
+ return {
138
+
139
+ 'state': InvitePreviewStateToJSON(value['state']),
140
+ 'email': value['email'],
141
+ 'tenant_name': value['tenantName'],
142
+ 'role': TenantUserRoleToJSON(value['role']),
143
+ 'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
144
+ 'invited_by': UserInfoToJSON(value['invitedBy']),
145
+ };
146
+ }
147
+
@@ -0,0 +1,56 @@
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
+
15
+
16
+ /**
17
+ *
18
+ * @export
19
+ */
20
+ export const InvitePreviewState = {
21
+ Valid: 'valid',
22
+ Expired: 'expired',
23
+ Accepted: 'accepted',
24
+ NotFound: 'not_found',
25
+ TenantUnavailable: 'tenant_unavailable'
26
+ } as const;
27
+ export type InvitePreviewState = typeof InvitePreviewState[keyof typeof InvitePreviewState];
28
+
29
+
30
+ export function instanceOfInvitePreviewState(value: any): boolean {
31
+ for (const key in InvitePreviewState) {
32
+ if (Object.prototype.hasOwnProperty.call(InvitePreviewState, key)) {
33
+ if (InvitePreviewState[key as keyof typeof InvitePreviewState] === value) {
34
+ return true;
35
+ }
36
+ }
37
+ }
38
+ return false;
39
+ }
40
+
41
+ export function InvitePreviewStateFromJSON(json: any): InvitePreviewState {
42
+ return InvitePreviewStateFromJSONTyped(json, false);
43
+ }
44
+
45
+ export function InvitePreviewStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvitePreviewState {
46
+ return json as InvitePreviewState;
47
+ }
48
+
49
+ export function InvitePreviewStateToJSON(value?: InvitePreviewState | null): any {
50
+ return value as any;
51
+ }
52
+
53
+ export function InvitePreviewStateToJSONTyped(value: any, ignoreDiscriminator: boolean): InvitePreviewState {
54
+ return value as InvitePreviewState;
55
+ }
56
+
@@ -0,0 +1,58 @@
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
+
15
+
16
+ /**
17
+ *
18
+ * @export
19
+ */
20
+ export const InviteRejection = {
21
+ NotFound: 'not_found',
22
+ Accepted: 'accepted',
23
+ Expired: 'expired',
24
+ TenantUnavailable: 'tenant_unavailable',
25
+ InvitesDisabled: 'invites_disabled',
26
+ EmailMismatch: 'email_mismatch',
27
+ NoSeat: 'no_seat'
28
+ } as const;
29
+ export type InviteRejection = typeof InviteRejection[keyof typeof InviteRejection];
30
+
31
+
32
+ export function instanceOfInviteRejection(value: any): boolean {
33
+ for (const key in InviteRejection) {
34
+ if (Object.prototype.hasOwnProperty.call(InviteRejection, key)) {
35
+ if (InviteRejection[key as keyof typeof InviteRejection] === value) {
36
+ return true;
37
+ }
38
+ }
39
+ }
40
+ return false;
41
+ }
42
+
43
+ export function InviteRejectionFromJSON(json: any): InviteRejection {
44
+ return InviteRejectionFromJSONTyped(json, false);
45
+ }
46
+
47
+ export function InviteRejectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): InviteRejection {
48
+ return json as InviteRejection;
49
+ }
50
+
51
+ export function InviteRejectionToJSON(value?: InviteRejection | null): any {
52
+ return value as any;
53
+ }
54
+
55
+ export function InviteRejectionToJSONTyped(value: any, ignoreDiscriminator: boolean): InviteRejection {
56
+ return value as InviteRejection;
57
+ }
58
+