@knowledge-stack/ksapi 1.63.0 → 1.64.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 +34 -0
- package/README.md +27 -2
- package/dist/apis/WorkflowDefinitionsApi.d.ts +328 -0
- package/dist/apis/WorkflowDefinitionsApi.js +345 -0
- package/dist/apis/WorkflowRunsApi.d.ts +146 -0
- package/dist/apis/WorkflowRunsApi.js +160 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +328 -0
- package/dist/esm/apis/WorkflowDefinitionsApi.js +341 -0
- package/dist/esm/apis/WorkflowRunsApi.d.ts +146 -0
- package/dist/esm/apis/WorkflowRunsApi.js +156 -0
- package/dist/esm/apis/index.d.ts +2 -0
- package/dist/esm/apis/index.js +2 -0
- package/dist/esm/models/ABCDPathSnapshot.d.ts +60 -0
- package/dist/esm/models/ABCDPathSnapshot.js +53 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +97 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.js +95 -0
- package/dist/esm/models/InvokeWorkflowRequest.d.ts +47 -0
- package/dist/esm/models/InvokeWorkflowRequest.js +46 -0
- package/dist/esm/models/PaginatedResponseWorkflowDefinitionResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseWorkflowDefinitionResponse.js +70 -0
- package/dist/esm/models/PaginatedResponseWorkflowRunResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseWorkflowRunResponse.js +70 -0
- package/dist/esm/models/PartType.d.ts +2 -0
- package/dist/esm/models/PartType.js +3 -1
- package/dist/esm/models/ReferenceType.d.ts +2 -0
- package/dist/esm/models/ReferenceType.js +2 -0
- package/dist/esm/models/SelfHostedRunnerConfig.d.ts +53 -0
- package/dist/esm/models/SelfHostedRunnerConfig.js +53 -0
- package/dist/esm/models/SelfHostedRunnerConfigResponse.d.ts +47 -0
- package/dist/esm/models/SelfHostedRunnerConfigResponse.js +49 -0
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +103 -0
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +97 -0
- package/dist/esm/models/WorkflowCallbackResponse.d.ts +47 -0
- package/dist/esm/models/WorkflowCallbackResponse.js +44 -0
- package/dist/esm/models/WorkflowDefinitionResponse.d.ts +121 -0
- package/dist/esm/models/WorkflowDefinitionResponse.js +94 -0
- package/dist/esm/models/WorkflowRunCallbackRequest.d.ts +61 -0
- package/dist/esm/models/WorkflowRunCallbackRequest.js +57 -0
- package/dist/esm/models/WorkflowRunResponse.d.ts +110 -0
- package/dist/esm/models/WorkflowRunResponse.js +87 -0
- package/dist/esm/models/WorkflowRunSnapshot.d.ts +97 -0
- package/dist/esm/models/WorkflowRunSnapshot.js +78 -0
- package/dist/esm/models/WorkflowRunStatus.d.ts +27 -0
- package/dist/esm/models/WorkflowRunStatus.js +45 -0
- package/dist/esm/models/WorkflowRunnerType.d.ts +24 -0
- package/dist/esm/models/WorkflowRunnerType.js +42 -0
- package/dist/esm/models/index.d.ts +15 -0
- package/dist/esm/models/index.js +15 -0
- package/dist/models/ABCDPathSnapshot.d.ts +60 -0
- package/dist/models/ABCDPathSnapshot.js +61 -0
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +97 -0
- package/dist/models/CreateWorkflowDefinitionRequest.js +103 -0
- package/dist/models/InvokeWorkflowRequest.d.ts +47 -0
- package/dist/models/InvokeWorkflowRequest.js +54 -0
- package/dist/models/PaginatedResponseWorkflowDefinitionResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseWorkflowDefinitionResponse.js +78 -0
- package/dist/models/PaginatedResponseWorkflowRunResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseWorkflowRunResponse.js +78 -0
- package/dist/models/PartType.d.ts +2 -0
- package/dist/models/PartType.js +3 -1
- package/dist/models/ReferenceType.d.ts +2 -0
- package/dist/models/ReferenceType.js +2 -0
- package/dist/models/SelfHostedRunnerConfig.d.ts +53 -0
- package/dist/models/SelfHostedRunnerConfig.js +61 -0
- package/dist/models/SelfHostedRunnerConfigResponse.d.ts +47 -0
- package/dist/models/SelfHostedRunnerConfigResponse.js +57 -0
- package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +103 -0
- package/dist/models/UpdateWorkflowDefinitionRequest.js +105 -0
- package/dist/models/WorkflowCallbackResponse.d.ts +47 -0
- package/dist/models/WorkflowCallbackResponse.js +52 -0
- package/dist/models/WorkflowDefinitionResponse.d.ts +121 -0
- package/dist/models/WorkflowDefinitionResponse.js +102 -0
- package/dist/models/WorkflowRunCallbackRequest.d.ts +61 -0
- package/dist/models/WorkflowRunCallbackRequest.js +65 -0
- package/dist/models/WorkflowRunResponse.d.ts +110 -0
- package/dist/models/WorkflowRunResponse.js +95 -0
- package/dist/models/WorkflowRunSnapshot.d.ts +97 -0
- package/dist/models/WorkflowRunSnapshot.js +86 -0
- package/dist/models/WorkflowRunStatus.d.ts +27 -0
- package/dist/models/WorkflowRunStatus.js +53 -0
- package/dist/models/WorkflowRunnerType.d.ts +24 -0
- package/dist/models/WorkflowRunnerType.js +50 -0
- package/dist/models/index.d.ts +15 -0
- package/dist/models/index.js +15 -0
- package/docs/ABCDPathSnapshot.md +39 -0
- package/docs/CreateWorkflowDefinitionRequest.md +51 -0
- package/docs/InvokeWorkflowRequest.md +35 -0
- package/docs/PaginatedResponseWorkflowDefinitionResponse.md +40 -0
- package/docs/PaginatedResponseWorkflowRunResponse.md +40 -0
- package/docs/SelfHostedRunnerConfig.md +37 -0
- package/docs/SelfHostedRunnerConfigResponse.md +35 -0
- package/docs/UpdateWorkflowDefinitionRequest.md +53 -0
- package/docs/WorkflowCallbackResponse.md +35 -0
- package/docs/WorkflowDefinitionResponse.md +59 -0
- package/docs/WorkflowDefinitionsApi.md +534 -0
- package/docs/WorkflowRunCallbackRequest.md +37 -0
- package/docs/WorkflowRunResponse.md +55 -0
- package/docs/WorkflowRunSnapshot.md +51 -0
- package/docs/WorkflowRunStatus.md +33 -0
- package/docs/WorkflowRunnerType.md +33 -0
- package/docs/WorkflowRunsApi.md +224 -0
- package/package.json +1 -1
- package/src/apis/WorkflowDefinitionsApi.ts +678 -0
- package/src/apis/WorkflowRunsApi.ts +296 -0
- package/src/apis/index.ts +2 -0
- package/src/models/ABCDPathSnapshot.ts +111 -0
- package/src/models/CreateWorkflowDefinitionRequest.ts +192 -0
- package/src/models/InvokeWorkflowRequest.ts +85 -0
- package/src/models/PaginatedResponseWorkflowDefinitionResponse.ts +130 -0
- package/src/models/PaginatedResponseWorkflowRunResponse.ts +130 -0
- package/src/models/PartType.ts +3 -1
- package/src/models/ReferenceType.ts +2 -0
- package/src/models/SelfHostedRunnerConfig.ts +96 -0
- package/src/models/SelfHostedRunnerConfigResponse.ts +87 -0
- package/src/models/UpdateWorkflowDefinitionRequest.ts +200 -0
- package/src/models/WorkflowCallbackResponse.ts +83 -0
- package/src/models/WorkflowDefinitionResponse.ts +208 -0
- package/src/models/WorkflowRunCallbackRequest.ts +105 -0
- package/src/models/WorkflowRunResponse.ts +197 -0
- package/src/models/WorkflowRunSnapshot.ts +172 -0
- package/src/models/WorkflowRunStatus.ts +55 -0
- package/src/models/WorkflowRunnerType.ts +52 -0
- package/src/models/index.ts +15 -0
|
@@ -0,0 +1,53 @@
|
|
|
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.WorkflowRunStatus = void 0;
|
|
17
|
+
exports.instanceOfWorkflowRunStatus = instanceOfWorkflowRunStatus;
|
|
18
|
+
exports.WorkflowRunStatusFromJSON = WorkflowRunStatusFromJSON;
|
|
19
|
+
exports.WorkflowRunStatusFromJSONTyped = WorkflowRunStatusFromJSONTyped;
|
|
20
|
+
exports.WorkflowRunStatusToJSON = WorkflowRunStatusToJSON;
|
|
21
|
+
exports.WorkflowRunStatusToJSONTyped = WorkflowRunStatusToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* Lifecycle status of a workflow run.
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
exports.WorkflowRunStatus = {
|
|
27
|
+
Pending: 'PENDING',
|
|
28
|
+
Running: 'RUNNING',
|
|
29
|
+
Completed: 'COMPLETED',
|
|
30
|
+
Failed: 'FAILED'
|
|
31
|
+
};
|
|
32
|
+
function instanceOfWorkflowRunStatus(value) {
|
|
33
|
+
for (const key in exports.WorkflowRunStatus) {
|
|
34
|
+
if (Object.prototype.hasOwnProperty.call(exports.WorkflowRunStatus, key)) {
|
|
35
|
+
if (exports.WorkflowRunStatus[key] === value) {
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
return false;
|
|
41
|
+
}
|
|
42
|
+
function WorkflowRunStatusFromJSON(json) {
|
|
43
|
+
return WorkflowRunStatusFromJSONTyped(json, false);
|
|
44
|
+
}
|
|
45
|
+
function WorkflowRunStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
46
|
+
return json;
|
|
47
|
+
}
|
|
48
|
+
function WorkflowRunStatusToJSON(value) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
|
51
|
+
function WorkflowRunStatusToJSONTyped(value, ignoreDiscriminator) {
|
|
52
|
+
return value;
|
|
53
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
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
|
+
* Runner that executes the workflow.
|
|
14
|
+
* @export
|
|
15
|
+
*/
|
|
16
|
+
export declare const WorkflowRunnerType: {
|
|
17
|
+
readonly SelfHosted: "SELF_HOSTED";
|
|
18
|
+
};
|
|
19
|
+
export type WorkflowRunnerType = typeof WorkflowRunnerType[keyof typeof WorkflowRunnerType];
|
|
20
|
+
export declare function instanceOfWorkflowRunnerType(value: any): boolean;
|
|
21
|
+
export declare function WorkflowRunnerTypeFromJSON(json: any): WorkflowRunnerType;
|
|
22
|
+
export declare function WorkflowRunnerTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunnerType;
|
|
23
|
+
export declare function WorkflowRunnerTypeToJSON(value?: WorkflowRunnerType | null): any;
|
|
24
|
+
export declare function WorkflowRunnerTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowRunnerType;
|
|
@@ -0,0 +1,50 @@
|
|
|
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.WorkflowRunnerType = void 0;
|
|
17
|
+
exports.instanceOfWorkflowRunnerType = instanceOfWorkflowRunnerType;
|
|
18
|
+
exports.WorkflowRunnerTypeFromJSON = WorkflowRunnerTypeFromJSON;
|
|
19
|
+
exports.WorkflowRunnerTypeFromJSONTyped = WorkflowRunnerTypeFromJSONTyped;
|
|
20
|
+
exports.WorkflowRunnerTypeToJSON = WorkflowRunnerTypeToJSON;
|
|
21
|
+
exports.WorkflowRunnerTypeToJSONTyped = WorkflowRunnerTypeToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* Runner that executes the workflow.
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
exports.WorkflowRunnerType = {
|
|
27
|
+
SelfHosted: 'SELF_HOSTED'
|
|
28
|
+
};
|
|
29
|
+
function instanceOfWorkflowRunnerType(value) {
|
|
30
|
+
for (const key in exports.WorkflowRunnerType) {
|
|
31
|
+
if (Object.prototype.hasOwnProperty.call(exports.WorkflowRunnerType, key)) {
|
|
32
|
+
if (exports.WorkflowRunnerType[key] === value) {
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
return false;
|
|
38
|
+
}
|
|
39
|
+
function WorkflowRunnerTypeFromJSON(json) {
|
|
40
|
+
return WorkflowRunnerTypeFromJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
function WorkflowRunnerTypeFromJSONTyped(json, ignoreDiscriminator) {
|
|
43
|
+
return json;
|
|
44
|
+
}
|
|
45
|
+
function WorkflowRunnerTypeToJSON(value) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
function WorkflowRunnerTypeToJSONTyped(value, ignoreDiscriminator) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * from './ABCDPathSnapshot';
|
|
1
2
|
export * from './AcceptInviteResponse';
|
|
2
3
|
export * from './AddMemberRequest';
|
|
3
4
|
export * from './AncestryResponse';
|
|
@@ -33,6 +34,7 @@ export * from './CreateTagRequest';
|
|
|
33
34
|
export * from './CreateTenantRequest';
|
|
34
35
|
export * from './CreateThreadMessageRequest';
|
|
35
36
|
export * from './CreateThreadRequest';
|
|
37
|
+
export * from './CreateWorkflowDefinitionRequest';
|
|
36
38
|
export * from './DissolveSectionResponse';
|
|
37
39
|
export * from './DocumentOrigin';
|
|
38
40
|
export * from './DocumentResponse';
|
|
@@ -68,6 +70,7 @@ export * from './IngestionMode';
|
|
|
68
70
|
export * from './InviteResponse';
|
|
69
71
|
export * from './InviteStatus';
|
|
70
72
|
export * from './InviteUserRequest';
|
|
73
|
+
export * from './InvokeWorkflowRequest';
|
|
71
74
|
export * from './LineageEdgeResponse';
|
|
72
75
|
export * from './LineageGraphResponse';
|
|
73
76
|
export * from './LineageNodeResponse';
|
|
@@ -93,6 +96,8 @@ export * from './PaginatedResponseTenantResponse';
|
|
|
93
96
|
export * from './PaginatedResponseTenantUserResponse';
|
|
94
97
|
export * from './PaginatedResponseThreadMessageResponse';
|
|
95
98
|
export * from './PaginatedResponseThreadResponse';
|
|
99
|
+
export * from './PaginatedResponseWorkflowDefinitionResponse';
|
|
100
|
+
export * from './PaginatedResponseWorkflowRunResponse';
|
|
96
101
|
export * from './PaginatedResponseWorkflowSummaryResponse';
|
|
97
102
|
export * from './PartType';
|
|
98
103
|
export * from './PasswordResetRequest';
|
|
@@ -120,6 +125,8 @@ export * from './SectionContentItem';
|
|
|
120
125
|
export * from './SectionContentItemOrChunkContentItem';
|
|
121
126
|
export * from './SectionResponse';
|
|
122
127
|
export * from './SectionSystemMetadata';
|
|
128
|
+
export * from './SelfHostedRunnerConfig';
|
|
129
|
+
export * from './SelfHostedRunnerConfigResponse';
|
|
123
130
|
export * from './SignInRequest';
|
|
124
131
|
export * from './StepInput';
|
|
125
132
|
export * from './StepKind';
|
|
@@ -154,12 +161,20 @@ export * from './UpdateTagRequest';
|
|
|
154
161
|
export * from './UpdateTenantRequest';
|
|
155
162
|
export * from './UpdateThreadRequest';
|
|
156
163
|
export * from './UpdateUserRequest';
|
|
164
|
+
export * from './UpdateWorkflowDefinitionRequest';
|
|
157
165
|
export * from './UserMessageRequest';
|
|
158
166
|
export * from './UserMessageResponse';
|
|
159
167
|
export * from './UserResponse';
|
|
160
168
|
export * from './ValidationError';
|
|
161
169
|
export * from './VersionChunkIdsResponse';
|
|
162
170
|
export * from './WorkflowActionResponse';
|
|
171
|
+
export * from './WorkflowCallbackResponse';
|
|
163
172
|
export * from './WorkflowCancelResponse';
|
|
173
|
+
export * from './WorkflowDefinitionResponse';
|
|
164
174
|
export * from './WorkflowDetailResponse';
|
|
175
|
+
export * from './WorkflowRunCallbackRequest';
|
|
176
|
+
export * from './WorkflowRunResponse';
|
|
177
|
+
export * from './WorkflowRunSnapshot';
|
|
178
|
+
export * from './WorkflowRunStatus';
|
|
179
|
+
export * from './WorkflowRunnerType';
|
|
165
180
|
export * from './WorkflowSummaryResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
/* tslint:disable */
|
|
18
18
|
/* eslint-disable */
|
|
19
|
+
__exportStar(require("./ABCDPathSnapshot"), exports);
|
|
19
20
|
__exportStar(require("./AcceptInviteResponse"), exports);
|
|
20
21
|
__exportStar(require("./AddMemberRequest"), exports);
|
|
21
22
|
__exportStar(require("./AncestryResponse"), exports);
|
|
@@ -51,6 +52,7 @@ __exportStar(require("./CreateTagRequest"), exports);
|
|
|
51
52
|
__exportStar(require("./CreateTenantRequest"), exports);
|
|
52
53
|
__exportStar(require("./CreateThreadMessageRequest"), exports);
|
|
53
54
|
__exportStar(require("./CreateThreadRequest"), exports);
|
|
55
|
+
__exportStar(require("./CreateWorkflowDefinitionRequest"), exports);
|
|
54
56
|
__exportStar(require("./DissolveSectionResponse"), exports);
|
|
55
57
|
__exportStar(require("./DocumentOrigin"), exports);
|
|
56
58
|
__exportStar(require("./DocumentResponse"), exports);
|
|
@@ -86,6 +88,7 @@ __exportStar(require("./IngestionMode"), exports);
|
|
|
86
88
|
__exportStar(require("./InviteResponse"), exports);
|
|
87
89
|
__exportStar(require("./InviteStatus"), exports);
|
|
88
90
|
__exportStar(require("./InviteUserRequest"), exports);
|
|
91
|
+
__exportStar(require("./InvokeWorkflowRequest"), exports);
|
|
89
92
|
__exportStar(require("./LineageEdgeResponse"), exports);
|
|
90
93
|
__exportStar(require("./LineageGraphResponse"), exports);
|
|
91
94
|
__exportStar(require("./LineageNodeResponse"), exports);
|
|
@@ -111,6 +114,8 @@ __exportStar(require("./PaginatedResponseTenantResponse"), exports);
|
|
|
111
114
|
__exportStar(require("./PaginatedResponseTenantUserResponse"), exports);
|
|
112
115
|
__exportStar(require("./PaginatedResponseThreadMessageResponse"), exports);
|
|
113
116
|
__exportStar(require("./PaginatedResponseThreadResponse"), exports);
|
|
117
|
+
__exportStar(require("./PaginatedResponseWorkflowDefinitionResponse"), exports);
|
|
118
|
+
__exportStar(require("./PaginatedResponseWorkflowRunResponse"), exports);
|
|
114
119
|
__exportStar(require("./PaginatedResponseWorkflowSummaryResponse"), exports);
|
|
115
120
|
__exportStar(require("./PartType"), exports);
|
|
116
121
|
__exportStar(require("./PasswordResetRequest"), exports);
|
|
@@ -138,6 +143,8 @@ __exportStar(require("./SectionContentItem"), exports);
|
|
|
138
143
|
__exportStar(require("./SectionContentItemOrChunkContentItem"), exports);
|
|
139
144
|
__exportStar(require("./SectionResponse"), exports);
|
|
140
145
|
__exportStar(require("./SectionSystemMetadata"), exports);
|
|
146
|
+
__exportStar(require("./SelfHostedRunnerConfig"), exports);
|
|
147
|
+
__exportStar(require("./SelfHostedRunnerConfigResponse"), exports);
|
|
141
148
|
__exportStar(require("./SignInRequest"), exports);
|
|
142
149
|
__exportStar(require("./StepInput"), exports);
|
|
143
150
|
__exportStar(require("./StepKind"), exports);
|
|
@@ -172,12 +179,20 @@ __exportStar(require("./UpdateTagRequest"), exports);
|
|
|
172
179
|
__exportStar(require("./UpdateTenantRequest"), exports);
|
|
173
180
|
__exportStar(require("./UpdateThreadRequest"), exports);
|
|
174
181
|
__exportStar(require("./UpdateUserRequest"), exports);
|
|
182
|
+
__exportStar(require("./UpdateWorkflowDefinitionRequest"), exports);
|
|
175
183
|
__exportStar(require("./UserMessageRequest"), exports);
|
|
176
184
|
__exportStar(require("./UserMessageResponse"), exports);
|
|
177
185
|
__exportStar(require("./UserResponse"), exports);
|
|
178
186
|
__exportStar(require("./ValidationError"), exports);
|
|
179
187
|
__exportStar(require("./VersionChunkIdsResponse"), exports);
|
|
180
188
|
__exportStar(require("./WorkflowActionResponse"), exports);
|
|
189
|
+
__exportStar(require("./WorkflowCallbackResponse"), exports);
|
|
181
190
|
__exportStar(require("./WorkflowCancelResponse"), exports);
|
|
191
|
+
__exportStar(require("./WorkflowDefinitionResponse"), exports);
|
|
182
192
|
__exportStar(require("./WorkflowDetailResponse"), exports);
|
|
193
|
+
__exportStar(require("./WorkflowRunCallbackRequest"), exports);
|
|
194
|
+
__exportStar(require("./WorkflowRunResponse"), exports);
|
|
195
|
+
__exportStar(require("./WorkflowRunSnapshot"), exports);
|
|
196
|
+
__exportStar(require("./WorkflowRunStatus"), exports);
|
|
197
|
+
__exportStar(require("./WorkflowRunnerType"), exports);
|
|
183
198
|
__exportStar(require("./WorkflowSummaryResponse"), exports);
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# ABCDPathSnapshot
|
|
3
|
+
|
|
4
|
+
Snapshot of a single ABCD path reference at trigger time.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`pathPartId` | string
|
|
11
|
+
`materializedPath` | string
|
|
12
|
+
`partType` | [PartType](PartType.md)
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { ABCDPathSnapshot } from '@knowledge-stack/ksapi'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"pathPartId": null,
|
|
22
|
+
"materializedPath": null,
|
|
23
|
+
"partType": null,
|
|
24
|
+
} satisfies ABCDPathSnapshot
|
|
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 ABCDPathSnapshot
|
|
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
|
+
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateWorkflowDefinitionRequest
|
|
3
|
+
|
|
4
|
+
Create a new workflow definition.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`name` | string
|
|
11
|
+
`description` | string
|
|
12
|
+
`runnerType` | [WorkflowRunnerType](WorkflowRunnerType.md)
|
|
13
|
+
`runnerConfig` | [SelfHostedRunnerConfig](SelfHostedRunnerConfig.md)
|
|
14
|
+
`maxRunDurationSeconds` | number
|
|
15
|
+
`sourcePathPartIds` | Array<string>
|
|
16
|
+
`instructionPathPartIds` | Array<string>
|
|
17
|
+
`outputPathPartIds` | Array<string>
|
|
18
|
+
`templatePathPartId` | string
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { CreateWorkflowDefinitionRequest } from '@knowledge-stack/ksapi'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"name": null,
|
|
28
|
+
"description": null,
|
|
29
|
+
"runnerType": null,
|
|
30
|
+
"runnerConfig": null,
|
|
31
|
+
"maxRunDurationSeconds": null,
|
|
32
|
+
"sourcePathPartIds": null,
|
|
33
|
+
"instructionPathPartIds": null,
|
|
34
|
+
"outputPathPartIds": null,
|
|
35
|
+
"templatePathPartId": null,
|
|
36
|
+
} satisfies CreateWorkflowDefinitionRequest
|
|
37
|
+
|
|
38
|
+
console.log(example)
|
|
39
|
+
|
|
40
|
+
// Convert the instance to a JSON string
|
|
41
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
42
|
+
console.log(exampleJSON)
|
|
43
|
+
|
|
44
|
+
// Parse the JSON string back to an object
|
|
45
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateWorkflowDefinitionRequest
|
|
46
|
+
console.log(exampleParsed)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
50
|
+
|
|
51
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
# InvokeWorkflowRequest
|
|
3
|
+
|
|
4
|
+
Request body for invoking a workflow definition.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`idempotencyKey` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { InvokeWorkflowRequest } from '@knowledge-stack/ksapi'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"idempotencyKey": null,
|
|
20
|
+
} satisfies InvokeWorkflowRequest
|
|
21
|
+
|
|
22
|
+
console.log(example)
|
|
23
|
+
|
|
24
|
+
// Convert the instance to a JSON string
|
|
25
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
26
|
+
console.log(exampleJSON)
|
|
27
|
+
|
|
28
|
+
// Parse the JSON string back to an object
|
|
29
|
+
const exampleParsed = JSON.parse(exampleJSON) as InvokeWorkflowRequest
|
|
30
|
+
console.log(exampleParsed)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
34
|
+
|
|
35
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedResponseWorkflowDefinitionResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`items` | [Array<WorkflowDefinitionResponse>](WorkflowDefinitionResponse.md)
|
|
10
|
+
`total` | number
|
|
11
|
+
`limit` | number
|
|
12
|
+
`offset` | number
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { PaginatedResponseWorkflowDefinitionResponse } from '@knowledge-stack/ksapi'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"items": null,
|
|
22
|
+
"total": null,
|
|
23
|
+
"limit": null,
|
|
24
|
+
"offset": null,
|
|
25
|
+
} satisfies PaginatedResponseWorkflowDefinitionResponse
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseWorkflowDefinitionResponse
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedResponseWorkflowRunResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`items` | [Array<WorkflowRunResponse>](WorkflowRunResponse.md)
|
|
10
|
+
`total` | number
|
|
11
|
+
`limit` | number
|
|
12
|
+
`offset` | number
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { PaginatedResponseWorkflowRunResponse } from '@knowledge-stack/ksapi'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"items": null,
|
|
22
|
+
"total": null,
|
|
23
|
+
"limit": null,
|
|
24
|
+
"offset": null,
|
|
25
|
+
} satisfies PaginatedResponseWorkflowRunResponse
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseWorkflowRunResponse
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# SelfHostedRunnerConfig
|
|
3
|
+
|
|
4
|
+
Configuration for self-hosted workflow runner.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`url` | string
|
|
11
|
+
`webhookSecret` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { SelfHostedRunnerConfig } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"url": null,
|
|
21
|
+
"webhookSecret": null,
|
|
22
|
+
} satisfies SelfHostedRunnerConfig
|
|
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 SelfHostedRunnerConfig
|
|
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,35 @@
|
|
|
1
|
+
|
|
2
|
+
# SelfHostedRunnerConfigResponse
|
|
3
|
+
|
|
4
|
+
Response-safe version of runner config — excludes webhook_secret.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`url` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { SelfHostedRunnerConfigResponse } from '@knowledge-stack/ksapi'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"url": null,
|
|
20
|
+
} satisfies SelfHostedRunnerConfigResponse
|
|
21
|
+
|
|
22
|
+
console.log(example)
|
|
23
|
+
|
|
24
|
+
// Convert the instance to a JSON string
|
|
25
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
26
|
+
console.log(exampleJSON)
|
|
27
|
+
|
|
28
|
+
// Parse the JSON string back to an object
|
|
29
|
+
const exampleParsed = JSON.parse(exampleJSON) as SelfHostedRunnerConfigResponse
|
|
30
|
+
console.log(exampleParsed)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
34
|
+
|
|
35
|
+
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateWorkflowDefinitionRequest
|
|
3
|
+
|
|
4
|
+
Full replacement (PUT semantics). All fields are required.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`name` | string
|
|
11
|
+
`description` | string
|
|
12
|
+
`runnerType` | [WorkflowRunnerType](WorkflowRunnerType.md)
|
|
13
|
+
`runnerConfig` | [SelfHostedRunnerConfig](SelfHostedRunnerConfig.md)
|
|
14
|
+
`maxRunDurationSeconds` | number
|
|
15
|
+
`sourcePathPartIds` | Array<string>
|
|
16
|
+
`instructionPathPartIds` | Array<string>
|
|
17
|
+
`outputPathPartIds` | Array<string>
|
|
18
|
+
`templatePathPartId` | string
|
|
19
|
+
`isActive` | boolean
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import type { UpdateWorkflowDefinitionRequest } from '@knowledge-stack/ksapi'
|
|
25
|
+
|
|
26
|
+
// TODO: Update the object below with actual values
|
|
27
|
+
const example = {
|
|
28
|
+
"name": null,
|
|
29
|
+
"description": null,
|
|
30
|
+
"runnerType": null,
|
|
31
|
+
"runnerConfig": null,
|
|
32
|
+
"maxRunDurationSeconds": null,
|
|
33
|
+
"sourcePathPartIds": null,
|
|
34
|
+
"instructionPathPartIds": null,
|
|
35
|
+
"outputPathPartIds": null,
|
|
36
|
+
"templatePathPartId": null,
|
|
37
|
+
"isActive": null,
|
|
38
|
+
} satisfies UpdateWorkflowDefinitionRequest
|
|
39
|
+
|
|
40
|
+
console.log(example)
|
|
41
|
+
|
|
42
|
+
// Convert the instance to a JSON string
|
|
43
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
44
|
+
console.log(exampleJSON)
|
|
45
|
+
|
|
46
|
+
// Parse the JSON string back to an object
|
|
47
|
+
const exampleParsed = JSON.parse(exampleJSON) as UpdateWorkflowDefinitionRequest
|
|
48
|
+
console.log(exampleParsed)
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
52
|
+
|
|
53
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
# WorkflowCallbackResponse
|
|
3
|
+
|
|
4
|
+
Response from the runner callback endpoint.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`status` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { WorkflowCallbackResponse } from '@knowledge-stack/ksapi'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"status": null,
|
|
20
|
+
} satisfies WorkflowCallbackResponse
|
|
21
|
+
|
|
22
|
+
console.log(example)
|
|
23
|
+
|
|
24
|
+
// Convert the instance to a JSON string
|
|
25
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
26
|
+
console.log(exampleJSON)
|
|
27
|
+
|
|
28
|
+
// Parse the JSON string back to an object
|
|
29
|
+
const exampleParsed = JSON.parse(exampleJSON) as WorkflowCallbackResponse
|
|
30
|
+
console.log(exampleParsed)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
34
|
+
|
|
35
|
+
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
|
|
2
|
+
# WorkflowDefinitionResponse
|
|
3
|
+
|
|
4
|
+
Workflow definition response.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`id` | string
|
|
11
|
+
`name` | string
|
|
12
|
+
`description` | string
|
|
13
|
+
`runnerType` | [WorkflowRunnerType](WorkflowRunnerType.md)
|
|
14
|
+
`runnerConfig` | [SelfHostedRunnerConfigResponse](SelfHostedRunnerConfigResponse.md)
|
|
15
|
+
`maxRunDurationSeconds` | number
|
|
16
|
+
`sourcePathPartIds` | Array<string>
|
|
17
|
+
`instructionPathPartIds` | Array<string>
|
|
18
|
+
`outputPathPartIds` | Array<string>
|
|
19
|
+
`templatePathPartId` | string
|
|
20
|
+
`isActive` | boolean
|
|
21
|
+
`createdAt` | Date
|
|
22
|
+
`updatedAt` | Date
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import type { WorkflowDefinitionResponse } from '@knowledge-stack/ksapi'
|
|
28
|
+
|
|
29
|
+
// TODO: Update the object below with actual values
|
|
30
|
+
const example = {
|
|
31
|
+
"id": null,
|
|
32
|
+
"name": null,
|
|
33
|
+
"description": null,
|
|
34
|
+
"runnerType": null,
|
|
35
|
+
"runnerConfig": null,
|
|
36
|
+
"maxRunDurationSeconds": null,
|
|
37
|
+
"sourcePathPartIds": null,
|
|
38
|
+
"instructionPathPartIds": null,
|
|
39
|
+
"outputPathPartIds": null,
|
|
40
|
+
"templatePathPartId": null,
|
|
41
|
+
"isActive": null,
|
|
42
|
+
"createdAt": null,
|
|
43
|
+
"updatedAt": null,
|
|
44
|
+
} satisfies WorkflowDefinitionResponse
|
|
45
|
+
|
|
46
|
+
console.log(example)
|
|
47
|
+
|
|
48
|
+
// Convert the instance to a JSON string
|
|
49
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
50
|
+
console.log(exampleJSON)
|
|
51
|
+
|
|
52
|
+
// Parse the JSON string back to an object
|
|
53
|
+
const exampleParsed = JSON.parse(exampleJSON) as WorkflowDefinitionResponse
|
|
54
|
+
console.log(exampleParsed)
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
58
|
+
|
|
59
|
+
|