@knowledge-stack/ksapi 1.80.1 → 1.82.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 +6 -0
- package/README.md +8 -2
- package/dist/apis/UsersApi.d.ts +130 -1
- package/dist/apis/UsersApi.js +130 -0
- package/dist/apis/WorkflowDefinitionsApi.d.ts +4 -1
- package/dist/apis/WorkflowDefinitionsApi.js +2 -0
- package/dist/esm/apis/UsersApi.d.ts +130 -1
- package/dist/esm/apis/UsersApi.js +131 -1
- package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +4 -1
- package/dist/esm/apis/WorkflowDefinitionsApi.js +2 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +8 -1
- package/dist/esm/models/CreateWorkflowDefinitionRequest.js +1 -4
- package/dist/esm/models/InstructionSnapshot.d.ts +71 -0
- package/dist/esm/models/InstructionSnapshot.js +57 -0
- package/dist/esm/models/InvokeWorkflowRequest.d.ts +6 -0
- package/dist/esm/models/InvokeWorkflowRequest.js +6 -0
- package/dist/esm/models/OnboardingCompanyRequest.d.ts +53 -0
- package/dist/esm/models/OnboardingCompanyRequest.js +51 -0
- package/dist/esm/models/OnboardingProfileRequest.d.ts +59 -0
- package/dist/esm/models/OnboardingProfileRequest.js +50 -0
- package/dist/esm/models/TenantSettingsResponse.d.ts +6 -0
- package/dist/esm/models/TenantSettingsResponse.js +2 -0
- package/dist/esm/models/TenantSettingsUpdate.d.ts +6 -0
- package/dist/esm/models/TenantSettingsUpdate.js +10 -1
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +6 -1
- package/dist/esm/models/UserResponse.d.ts +12 -0
- package/dist/esm/models/UserResponse.js +4 -0
- package/dist/esm/models/WorkflowRunResponse.d.ts +17 -0
- package/dist/esm/models/WorkflowRunResponse.js +8 -0
- package/dist/esm/models/WorkflowRunSnapshot.d.ts +3 -2
- package/dist/esm/models/WorkflowRunSnapshot.js +3 -2
- package/dist/esm/models/WorkflowRunnerType.d.ts +1 -0
- package/dist/esm/models/WorkflowRunnerType.js +2 -1
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +8 -1
- package/dist/models/CreateWorkflowDefinitionRequest.js +1 -4
- package/dist/models/InstructionSnapshot.d.ts +71 -0
- package/dist/models/InstructionSnapshot.js +65 -0
- package/dist/models/InvokeWorkflowRequest.d.ts +6 -0
- package/dist/models/InvokeWorkflowRequest.js +6 -0
- package/dist/models/OnboardingCompanyRequest.d.ts +53 -0
- package/dist/models/OnboardingCompanyRequest.js +59 -0
- package/dist/models/OnboardingProfileRequest.d.ts +59 -0
- package/dist/models/OnboardingProfileRequest.js +58 -0
- package/dist/models/TenantSettingsResponse.d.ts +6 -0
- package/dist/models/TenantSettingsResponse.js +2 -0
- package/dist/models/TenantSettingsUpdate.d.ts +6 -0
- package/dist/models/TenantSettingsUpdate.js +10 -1
- package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +6 -1
- package/dist/models/UserResponse.d.ts +12 -0
- package/dist/models/UserResponse.js +4 -0
- package/dist/models/WorkflowRunResponse.d.ts +17 -0
- package/dist/models/WorkflowRunResponse.js +8 -0
- package/dist/models/WorkflowRunSnapshot.d.ts +3 -2
- package/dist/models/WorkflowRunSnapshot.js +3 -2
- package/dist/models/WorkflowRunnerType.d.ts +1 -0
- package/dist/models/WorkflowRunnerType.js +2 -1
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/CreateWorkflowDefinitionRequest.md +1 -1
- package/docs/InstructionSnapshot.md +41 -0
- package/docs/InvokeWorkflowRequest.md +2 -0
- package/docs/OnboardingCompanyRequest.md +37 -0
- package/docs/OnboardingProfileRequest.md +39 -0
- package/docs/TenantSettingsResponse.md +2 -0
- package/docs/TenantSettingsUpdate.md +2 -0
- package/docs/UpdateWorkflowDefinitionRequest.md +1 -1
- package/docs/UserResponse.md +4 -0
- package/docs/UsersApi.md +222 -0
- package/docs/WorkflowDefinitionsApi.md +2 -0
- package/docs/WorkflowRunResponse.md +5 -1
- package/docs/WorkflowRunSnapshot.md +1 -1
- package/package.json +1 -1
- package/src/apis/UsersApi.ts +254 -0
- package/src/apis/WorkflowDefinitionsApi.ts +4 -1
- package/src/models/CreateWorkflowDefinitionRequest.ts +9 -4
- package/src/models/InstructionSnapshot.ts +125 -0
- package/src/models/InvokeWorkflowRequest.ts +12 -0
- package/src/models/OnboardingCompanyRequest.ts +96 -0
- package/src/models/OnboardingProfileRequest.ts +101 -0
- package/src/models/TenantSettingsResponse.ts +8 -0
- package/src/models/TenantSettingsUpdate.ts +14 -0
- package/src/models/UpdateWorkflowDefinitionRequest.ts +6 -1
- package/src/models/UserResponse.ts +16 -0
- package/src/models/WorkflowRunResponse.ts +23 -0
- package/src/models/WorkflowRunSnapshot.ts +11 -4
- package/src/models/WorkflowRunnerType.ts +2 -1
- package/src/models/index.ts +3 -0
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
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.OnboardingProfileRequestPropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfOnboardingProfileRequest = instanceOfOnboardingProfileRequest;
|
|
18
|
+
exports.OnboardingProfileRequestFromJSON = OnboardingProfileRequestFromJSON;
|
|
19
|
+
exports.OnboardingProfileRequestFromJSONTyped = OnboardingProfileRequestFromJSONTyped;
|
|
20
|
+
exports.OnboardingProfileRequestToJSON = OnboardingProfileRequestToJSON;
|
|
21
|
+
exports.OnboardingProfileRequestToJSONTyped = OnboardingProfileRequestToJSONTyped;
|
|
22
|
+
exports.OnboardingProfileRequestPropertyValidationAttributesMap = {
|
|
23
|
+
jobTitle: {
|
|
24
|
+
maxLength: 120,
|
|
25
|
+
},
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* Check if a given object implements the OnboardingProfileRequest interface.
|
|
29
|
+
*/
|
|
30
|
+
function instanceOfOnboardingProfileRequest(value) {
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
function OnboardingProfileRequestFromJSON(json) {
|
|
34
|
+
return OnboardingProfileRequestFromJSONTyped(json, false);
|
|
35
|
+
}
|
|
36
|
+
function OnboardingProfileRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
37
|
+
if (json == null) {
|
|
38
|
+
return json;
|
|
39
|
+
}
|
|
40
|
+
return {
|
|
41
|
+
'firstName': json['first_name'] == null ? undefined : json['first_name'],
|
|
42
|
+
'lastName': json['last_name'] == null ? undefined : json['last_name'],
|
|
43
|
+
'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
function OnboardingProfileRequestToJSON(json) {
|
|
47
|
+
return OnboardingProfileRequestToJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
function OnboardingProfileRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
50
|
+
if (value == null) {
|
|
51
|
+
return value;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'first_name': value['firstName'],
|
|
55
|
+
'last_name': value['lastName'],
|
|
56
|
+
'job_title': value['jobTitle'],
|
|
57
|
+
};
|
|
58
|
+
}
|
|
@@ -29,6 +29,12 @@ export interface TenantSettingsResponse {
|
|
|
29
29
|
* @memberof TenantSettingsResponse
|
|
30
30
|
*/
|
|
31
31
|
description: string;
|
|
32
|
+
/**
|
|
33
|
+
* Industry / company type captured during onboarding
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof TenantSettingsResponse
|
|
36
|
+
*/
|
|
37
|
+
industry?: string | null;
|
|
32
38
|
/**
|
|
33
39
|
* IANA timezone (e.g. 'America/New_York')
|
|
34
40
|
* @type {string}
|
|
@@ -46,6 +46,7 @@ function TenantSettingsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
46
46
|
return {
|
|
47
47
|
'language': (0, SupportedLanguage_1.SupportedLanguageFromJSON)(json['language']),
|
|
48
48
|
'description': json['description'],
|
|
49
|
+
'industry': json['industry'] == null ? undefined : json['industry'],
|
|
49
50
|
'timezone': json['timezone'],
|
|
50
51
|
'inviteLink': (0, InviteLinkSettingsResponse_1.InviteLinkSettingsResponseFromJSON)(json['invite_link']),
|
|
51
52
|
};
|
|
@@ -60,6 +61,7 @@ function TenantSettingsResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
60
61
|
return {
|
|
61
62
|
'language': (0, SupportedLanguage_1.SupportedLanguageToJSON)(value['language']),
|
|
62
63
|
'description': value['description'],
|
|
64
|
+
'industry': value['industry'],
|
|
63
65
|
'timezone': value['timezone'],
|
|
64
66
|
'invite_link': (0, InviteLinkSettingsResponse_1.InviteLinkSettingsResponseToJSON)(value['inviteLink']),
|
|
65
67
|
};
|
|
@@ -29,6 +29,12 @@ export interface TenantSettingsUpdate {
|
|
|
29
29
|
* @memberof TenantSettingsUpdate
|
|
30
30
|
*/
|
|
31
31
|
description?: string | null;
|
|
32
|
+
/**
|
|
33
|
+
* Industry / company type captured during onboarding
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof TenantSettingsUpdate
|
|
36
|
+
*/
|
|
37
|
+
industry?: string | null;
|
|
32
38
|
/**
|
|
33
39
|
* IANA timezone (e.g. 'America/New_York')
|
|
34
40
|
* @type {string}
|
|
@@ -21,7 +21,14 @@ exports.TenantSettingsUpdateToJSON = TenantSettingsUpdateToJSON;
|
|
|
21
21
|
exports.TenantSettingsUpdateToJSONTyped = TenantSettingsUpdateToJSONTyped;
|
|
22
22
|
const SupportedLanguage_1 = require("./SupportedLanguage");
|
|
23
23
|
const InviteLinkSettingsRequest_1 = require("./InviteLinkSettingsRequest");
|
|
24
|
-
exports.TenantSettingsUpdatePropertyValidationAttributesMap = {
|
|
24
|
+
exports.TenantSettingsUpdatePropertyValidationAttributesMap = {
|
|
25
|
+
description: {
|
|
26
|
+
maxLength: 5000,
|
|
27
|
+
},
|
|
28
|
+
industry: {
|
|
29
|
+
maxLength: 120,
|
|
30
|
+
},
|
|
31
|
+
};
|
|
25
32
|
/**
|
|
26
33
|
* Check if a given object implements the TenantSettingsUpdate interface.
|
|
27
34
|
*/
|
|
@@ -38,6 +45,7 @@ function TenantSettingsUpdateFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
45
|
return {
|
|
39
46
|
'language': json['language'] == null ? undefined : (0, SupportedLanguage_1.SupportedLanguageFromJSON)(json['language']),
|
|
40
47
|
'description': json['description'] == null ? undefined : json['description'],
|
|
48
|
+
'industry': json['industry'] == null ? undefined : json['industry'],
|
|
41
49
|
'timezone': json['timezone'] == null ? undefined : json['timezone'],
|
|
42
50
|
'brandName': json['brand_name'] == null ? undefined : json['brand_name'],
|
|
43
51
|
'brandColor': json['brand_color'] == null ? undefined : json['brand_color'],
|
|
@@ -55,6 +63,7 @@ function TenantSettingsUpdateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
55
63
|
return {
|
|
56
64
|
'language': (0, SupportedLanguage_1.SupportedLanguageToJSON)(value['language']),
|
|
57
65
|
'description': value['description'],
|
|
66
|
+
'industry': value['industry'],
|
|
58
67
|
'timezone': value['timezone'],
|
|
59
68
|
'brand_name': value['brandName'],
|
|
60
69
|
'brand_color': value['brandColor'],
|
|
@@ -12,7 +12,12 @@
|
|
|
12
12
|
import type { SelfHostedRunnerConfig } from './SelfHostedRunnerConfig';
|
|
13
13
|
import type { WorkflowRunnerType } from './WorkflowRunnerType';
|
|
14
14
|
/**
|
|
15
|
-
* Full replacement (PUT semantics).
|
|
15
|
+
* Full replacement (PUT semantics).
|
|
16
|
+
*
|
|
17
|
+
* ``instruction_path_part_ids``:
|
|
18
|
+
*
|
|
19
|
+
* - ``KS_INTERNAL``: must remain ``len == 1`` (the auto-provisioned doc).
|
|
20
|
+
* - ``SELF_HOSTED``: ``len ≥ 1``; callers may swap or add documents.
|
|
16
21
|
* @export
|
|
17
22
|
* @interface UpdateWorkflowDefinitionRequest
|
|
18
23
|
*/
|
|
@@ -65,6 +65,18 @@ export interface UserResponse {
|
|
|
65
65
|
* @memberof UserResponse
|
|
66
66
|
*/
|
|
67
67
|
defaultTenantId: string;
|
|
68
|
+
/**
|
|
69
|
+
* User's job title at the current tenant (per-membership)
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof UserResponse
|
|
72
|
+
*/
|
|
73
|
+
jobTitle?: string | null;
|
|
74
|
+
/**
|
|
75
|
+
* When the user finished onboarding for the current tenant. NULL = wizard should be shown.
|
|
76
|
+
* @type {Date}
|
|
77
|
+
* @memberof UserResponse
|
|
78
|
+
*/
|
|
79
|
+
onboardingCompletedAt?: Date | null;
|
|
68
80
|
}
|
|
69
81
|
export declare const UserResponsePropertyValidationAttributesMap: {
|
|
70
82
|
[property: string]: {
|
|
@@ -60,6 +60,8 @@ function UserResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
60
60
|
'currentTenantId': json['current_tenant_id'],
|
|
61
61
|
'currentTenantRole': (0, TenantUserRole_1.TenantUserRoleFromJSON)(json['current_tenant_role']),
|
|
62
62
|
'defaultTenantId': json['default_tenant_id'],
|
|
63
|
+
'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
|
|
64
|
+
'onboardingCompletedAt': json['onboarding_completed_at'] == null ? undefined : (new Date(json['onboarding_completed_at'])),
|
|
63
65
|
};
|
|
64
66
|
}
|
|
65
67
|
function UserResponseToJSON(json) {
|
|
@@ -78,5 +80,7 @@ function UserResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
78
80
|
'current_tenant_id': value['currentTenantId'],
|
|
79
81
|
'current_tenant_role': (0, TenantUserRole_1.TenantUserRoleToJSON)(value['currentTenantRole']),
|
|
80
82
|
'default_tenant_id': value['defaultTenantId'],
|
|
83
|
+
'job_title': value['jobTitle'],
|
|
84
|
+
'onboarding_completed_at': value['onboardingCompletedAt'] == null ? value['onboardingCompletedAt'] : value['onboardingCompletedAt'].toISOString(),
|
|
81
85
|
};
|
|
82
86
|
}
|
|
@@ -14,6 +14,11 @@ import type { WorkflowRunStatus } from './WorkflowRunStatus';
|
|
|
14
14
|
import type { WorkflowRunnerType } from './WorkflowRunnerType';
|
|
15
15
|
/**
|
|
16
16
|
* Workflow run response.
|
|
17
|
+
*
|
|
18
|
+
* Note: ``run_token_jti`` is intentionally NOT exposed. It's an
|
|
19
|
+
* internal token identifier persisted on the run row for callback
|
|
20
|
+
* auth — clients should treat run dispatch state as observable via
|
|
21
|
+
* ``status`` (RUNNING => dispatched), not via JTI presence.
|
|
17
22
|
* @export
|
|
18
23
|
* @interface WorkflowRunResponse
|
|
19
24
|
*/
|
|
@@ -72,6 +77,18 @@ export interface WorkflowRunResponse {
|
|
|
72
77
|
* @memberof WorkflowRunResponse
|
|
73
78
|
*/
|
|
74
79
|
error: string | null;
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @type {Array<string>}
|
|
83
|
+
* @memberof WorkflowRunResponse
|
|
84
|
+
*/
|
|
85
|
+
inputPathPartIds: Array<string>;
|
|
86
|
+
/**
|
|
87
|
+
*
|
|
88
|
+
* @type {Array<string>}
|
|
89
|
+
* @memberof WorkflowRunResponse
|
|
90
|
+
*/
|
|
91
|
+
inputVersionIds: Array<string>;
|
|
75
92
|
/**
|
|
76
93
|
*
|
|
77
94
|
* @type {Date}
|
|
@@ -45,6 +45,10 @@ function instanceOfWorkflowRunResponse(value) {
|
|
|
45
45
|
return false;
|
|
46
46
|
if (!('error' in value) || value['error'] === undefined)
|
|
47
47
|
return false;
|
|
48
|
+
if (!('inputPathPartIds' in value) || value['inputPathPartIds'] === undefined)
|
|
49
|
+
return false;
|
|
50
|
+
if (!('inputVersionIds' in value) || value['inputVersionIds'] === undefined)
|
|
51
|
+
return false;
|
|
48
52
|
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
49
53
|
return false;
|
|
50
54
|
if (!('updatedAt' in value) || value['updatedAt'] === undefined)
|
|
@@ -68,6 +72,8 @@ function WorkflowRunResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
68
72
|
'completedAt': (json['completed_at'] == null ? null : new Date(json['completed_at'])),
|
|
69
73
|
'runSnapshot': (0, WorkflowRunSnapshot_1.WorkflowRunSnapshotFromJSON)(json['run_snapshot']),
|
|
70
74
|
'error': json['error'],
|
|
75
|
+
'inputPathPartIds': json['input_path_part_ids'],
|
|
76
|
+
'inputVersionIds': json['input_version_ids'],
|
|
71
77
|
'createdAt': (new Date(json['created_at'])),
|
|
72
78
|
'updatedAt': (new Date(json['updated_at'])),
|
|
73
79
|
};
|
|
@@ -89,6 +95,8 @@ function WorkflowRunResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
89
95
|
'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
|
|
90
96
|
'run_snapshot': (0, WorkflowRunSnapshot_1.WorkflowRunSnapshotToJSON)(value['runSnapshot']),
|
|
91
97
|
'error': value['error'],
|
|
98
|
+
'input_path_part_ids': value['inputPathPartIds'],
|
|
99
|
+
'input_version_ids': value['inputVersionIds'],
|
|
92
100
|
'created_at': value['createdAt'].toISOString(),
|
|
93
101
|
'updated_at': value['updatedAt'].toISOString(),
|
|
94
102
|
};
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { ABCDPathSnapshot } from './ABCDPathSnapshot';
|
|
13
|
+
import type { InstructionSnapshot } from './InstructionSnapshot';
|
|
13
14
|
import type { WorkflowRunnerType } from './WorkflowRunnerType';
|
|
14
15
|
/**
|
|
15
16
|
* Frozen ABCD configuration captured at workflow trigger time.
|
|
@@ -55,10 +56,10 @@ export interface WorkflowRunSnapshot {
|
|
|
55
56
|
sources: Array<ABCDPathSnapshot>;
|
|
56
57
|
/**
|
|
57
58
|
*
|
|
58
|
-
* @type {Array<
|
|
59
|
+
* @type {Array<InstructionSnapshot>}
|
|
59
60
|
* @memberof WorkflowRunSnapshot
|
|
60
61
|
*/
|
|
61
|
-
instructions: Array<
|
|
62
|
+
instructions: Array<InstructionSnapshot>;
|
|
62
63
|
/**
|
|
63
64
|
*
|
|
64
65
|
* @type {Array<ABCDPathSnapshot>}
|
|
@@ -20,6 +20,7 @@ exports.WorkflowRunSnapshotFromJSONTyped = WorkflowRunSnapshotFromJSONTyped;
|
|
|
20
20
|
exports.WorkflowRunSnapshotToJSON = WorkflowRunSnapshotToJSON;
|
|
21
21
|
exports.WorkflowRunSnapshotToJSONTyped = WorkflowRunSnapshotToJSONTyped;
|
|
22
22
|
const ABCDPathSnapshot_1 = require("./ABCDPathSnapshot");
|
|
23
|
+
const InstructionSnapshot_1 = require("./InstructionSnapshot");
|
|
23
24
|
const WorkflowRunnerType_1 = require("./WorkflowRunnerType");
|
|
24
25
|
exports.WorkflowRunSnapshotPropertyValidationAttributesMap = {};
|
|
25
26
|
/**
|
|
@@ -60,7 +61,7 @@ function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
60
61
|
'userId': json['user_id'],
|
|
61
62
|
'maxRunDurationSeconds': json['max_run_duration_seconds'],
|
|
62
63
|
'sources': (json['sources'].map(ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)),
|
|
63
|
-
'instructions': (json['instructions'].map(
|
|
64
|
+
'instructions': (json['instructions'].map(InstructionSnapshot_1.InstructionSnapshotFromJSON)),
|
|
64
65
|
'outputs': (json['outputs'].map(ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)),
|
|
65
66
|
'template': (0, ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)(json['template']),
|
|
66
67
|
};
|
|
@@ -79,7 +80,7 @@ function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
79
80
|
'user_id': value['userId'],
|
|
80
81
|
'max_run_duration_seconds': value['maxRunDurationSeconds'],
|
|
81
82
|
'sources': (value['sources'].map(ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)),
|
|
82
|
-
'instructions': (value['instructions'].map(
|
|
83
|
+
'instructions': (value['instructions'].map(InstructionSnapshot_1.InstructionSnapshotToJSON)),
|
|
83
84
|
'outputs': (value['outputs'].map(ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)),
|
|
84
85
|
'template': (0, ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)(value['template']),
|
|
85
86
|
};
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
*/
|
|
16
16
|
export declare const WorkflowRunnerType: {
|
|
17
17
|
readonly SelfHosted: "SELF_HOSTED";
|
|
18
|
+
readonly KsInternal: "KS_INTERNAL";
|
|
18
19
|
};
|
|
19
20
|
export type WorkflowRunnerType = typeof WorkflowRunnerType[keyof typeof WorkflowRunnerType];
|
|
20
21
|
export declare function instanceOfWorkflowRunnerType(value: any): boolean;
|
|
@@ -24,7 +24,8 @@ exports.WorkflowRunnerTypeToJSONTyped = WorkflowRunnerTypeToJSONTyped;
|
|
|
24
24
|
* @export
|
|
25
25
|
*/
|
|
26
26
|
exports.WorkflowRunnerType = {
|
|
27
|
-
SelfHosted: 'SELF_HOSTED'
|
|
27
|
+
SelfHosted: 'SELF_HOSTED',
|
|
28
|
+
KsInternal: 'KS_INTERNAL'
|
|
28
29
|
};
|
|
29
30
|
function instanceOfWorkflowRunnerType(value) {
|
|
30
31
|
for (const key in exports.WorkflowRunnerType) {
|
package/dist/models/index.d.ts
CHANGED
|
@@ -74,6 +74,7 @@ export * from './ImageTaxonomy';
|
|
|
74
74
|
export * from './InformationStatistics';
|
|
75
75
|
export * from './IngestDocumentResponse';
|
|
76
76
|
export * from './IngestionMode';
|
|
77
|
+
export * from './InstructionSnapshot';
|
|
77
78
|
export * from './InviteLinkSettingsRequest';
|
|
78
79
|
export * from './InviteLinkSettingsResponse';
|
|
79
80
|
export * from './InviteResponse';
|
|
@@ -88,6 +89,8 @@ export * from './MembershipResponse';
|
|
|
88
89
|
export * from './MessageRole';
|
|
89
90
|
export * from './MeteredQuotaStatus';
|
|
90
91
|
export * from './NonFilesystemReferenceType';
|
|
92
|
+
export * from './OnboardingCompanyRequest';
|
|
93
|
+
export * from './OnboardingProfileRequest';
|
|
91
94
|
export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator';
|
|
92
95
|
export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
|
|
93
96
|
export * from './PaginatedResponseDocumentResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -92,6 +92,7 @@ __exportStar(require("./ImageTaxonomy"), exports);
|
|
|
92
92
|
__exportStar(require("./InformationStatistics"), exports);
|
|
93
93
|
__exportStar(require("./IngestDocumentResponse"), exports);
|
|
94
94
|
__exportStar(require("./IngestionMode"), exports);
|
|
95
|
+
__exportStar(require("./InstructionSnapshot"), exports);
|
|
95
96
|
__exportStar(require("./InviteLinkSettingsRequest"), exports);
|
|
96
97
|
__exportStar(require("./InviteLinkSettingsResponse"), exports);
|
|
97
98
|
__exportStar(require("./InviteResponse"), exports);
|
|
@@ -106,6 +107,8 @@ __exportStar(require("./MembershipResponse"), exports);
|
|
|
106
107
|
__exportStar(require("./MessageRole"), exports);
|
|
107
108
|
__exportStar(require("./MeteredQuotaStatus"), exports);
|
|
108
109
|
__exportStar(require("./NonFilesystemReferenceType"), exports);
|
|
110
|
+
__exportStar(require("./OnboardingCompanyRequest"), exports);
|
|
111
|
+
__exportStar(require("./OnboardingProfileRequest"), exports);
|
|
109
112
|
__exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator"), exports);
|
|
110
113
|
__exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
|
|
111
114
|
__exportStar(require("./PaginatedResponseDocumentResponse"), exports);
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# CreateWorkflowDefinitionRequest
|
|
3
3
|
|
|
4
|
-
Create a new workflow definition.
|
|
4
|
+
Create a new workflow definition. ``instruction_path_part_ids`` semantics depend on ``runner_type``: - ``KS_INTERNAL``: must be empty (``[]``); the server auto-provisions a single ``instruction.md`` and stores ``[doc.path_part_id]``. - ``SELF_HOSTED``: caller-supplied list of one-or-more document PathPart IDs. Must contain at least one entry.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# InstructionSnapshot
|
|
3
|
+
|
|
4
|
+
Snapshot of one instruction document, pinned at trigger time. The instruction file is the workflow\'s **contract**: the agent reads this exact ``document_version_id`` for the duration of the run, even if the document is edited mid-flight or after the run completes. Reproducibility and audit replay depend on this pinning.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`pathPartId` | string
|
|
11
|
+
`materializedPath` | string
|
|
12
|
+
`partType` | [PartType](PartType.md)
|
|
13
|
+
`documentVersionId` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { InstructionSnapshot } from '@knowledge-stack/ksapi'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"pathPartId": null,
|
|
23
|
+
"materializedPath": null,
|
|
24
|
+
"partType": null,
|
|
25
|
+
"documentVersionId": null,
|
|
26
|
+
} satisfies InstructionSnapshot
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as InstructionSnapshot
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -8,6 +8,7 @@ Request body for invoking a workflow definition.
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`idempotencyKey` | string
|
|
11
|
+
`inputPathPartIds` | Array<string>
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -17,6 +18,7 @@ import type { InvokeWorkflowRequest } from '@knowledge-stack/ksapi'
|
|
|
17
18
|
// TODO: Update the object below with actual values
|
|
18
19
|
const example = {
|
|
19
20
|
"idempotencyKey": null,
|
|
21
|
+
"inputPathPartIds": null,
|
|
20
22
|
} satisfies InvokeWorkflowRequest
|
|
21
23
|
|
|
22
24
|
console.log(example)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# OnboardingCompanyRequest
|
|
3
|
+
|
|
4
|
+
Step 1 of onboarding — tenant-wide company info. OWNER/ADMIN only.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`description` | string
|
|
11
|
+
`industry` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { OnboardingCompanyRequest } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"description": null,
|
|
21
|
+
"industry": null,
|
|
22
|
+
} satisfies OnboardingCompanyRequest
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as OnboardingCompanyRequest
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# OnboardingProfileRequest
|
|
3
|
+
|
|
4
|
+
Step 2 of onboarding — per-user info for the current tenant.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`firstName` | string
|
|
11
|
+
`lastName` | string
|
|
12
|
+
`jobTitle` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { OnboardingProfileRequest } from '@knowledge-stack/ksapi'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"firstName": null,
|
|
22
|
+
"lastName": null,
|
|
23
|
+
"jobTitle": null,
|
|
24
|
+
} satisfies OnboardingProfileRequest
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as OnboardingProfileRequest
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
|
@@ -9,6 +9,7 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`language` | [SupportedLanguage](SupportedLanguage.md)
|
|
11
11
|
`description` | string
|
|
12
|
+
`industry` | string
|
|
12
13
|
`timezone` | string
|
|
13
14
|
`inviteLink` | [InviteLinkSettingsResponse](InviteLinkSettingsResponse.md)
|
|
14
15
|
|
|
@@ -21,6 +22,7 @@ import type { TenantSettingsResponse } from '@knowledge-stack/ksapi'
|
|
|
21
22
|
const example = {
|
|
22
23
|
"language": null,
|
|
23
24
|
"description": null,
|
|
25
|
+
"industry": null,
|
|
24
26
|
"timezone": null,
|
|
25
27
|
"inviteLink": null,
|
|
26
28
|
} satisfies TenantSettingsResponse
|
|
@@ -9,6 +9,7 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`language` | [SupportedLanguage](SupportedLanguage.md)
|
|
11
11
|
`description` | string
|
|
12
|
+
`industry` | string
|
|
12
13
|
`timezone` | string
|
|
13
14
|
`brandName` | string
|
|
14
15
|
`brandColor` | string
|
|
@@ -24,6 +25,7 @@ import type { TenantSettingsUpdate } from '@knowledge-stack/ksapi'
|
|
|
24
25
|
const example = {
|
|
25
26
|
"language": null,
|
|
26
27
|
"description": null,
|
|
28
|
+
"industry": null,
|
|
27
29
|
"timezone": null,
|
|
28
30
|
"brandName": null,
|
|
29
31
|
"brandColor": null,
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# UpdateWorkflowDefinitionRequest
|
|
3
3
|
|
|
4
|
-
Full replacement (PUT semantics).
|
|
4
|
+
Full replacement (PUT semantics). ``instruction_path_part_ids``: - ``KS_INTERNAL``: must remain ``len == 1`` (the auto-provisioned doc). - ``SELF_HOSTED``: ``len ≥ 1``; callers may swap or add documents.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
package/docs/UserResponse.md
CHANGED
|
@@ -14,6 +14,8 @@ Name | Type
|
|
|
14
14
|
`currentTenantId` | string
|
|
15
15
|
`currentTenantRole` | [TenantUserRole](TenantUserRole.md)
|
|
16
16
|
`defaultTenantId` | string
|
|
17
|
+
`jobTitle` | string
|
|
18
|
+
`onboardingCompletedAt` | Date
|
|
17
19
|
|
|
18
20
|
## Example
|
|
19
21
|
|
|
@@ -30,6 +32,8 @@ const example = {
|
|
|
30
32
|
"currentTenantId": null,
|
|
31
33
|
"currentTenantRole": null,
|
|
32
34
|
"defaultTenantId": null,
|
|
35
|
+
"jobTitle": null,
|
|
36
|
+
"onboardingCompletedAt": null,
|
|
33
37
|
} satisfies UserResponse
|
|
34
38
|
|
|
35
39
|
console.log(example)
|