@knowledge-stack/ksapi 1.57.0 → 1.58.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 (35) hide show
  1. package/.openapi-generator/FILES +4 -2
  2. package/README.md +9 -6
  3. package/dist/apis/WorkflowsApi.d.ts +144 -59
  4. package/dist/apis/WorkflowsApi.js +131 -49
  5. package/dist/esm/apis/WorkflowsApi.d.ts +144 -59
  6. package/dist/esm/apis/WorkflowsApi.js +132 -50
  7. package/dist/esm/models/TemporalWorkflowStatusResponse.d.ts +83 -0
  8. package/dist/esm/models/TemporalWorkflowStatusResponse.js +66 -0
  9. package/dist/esm/models/WorkflowActionResponse.d.ts +1 -1
  10. package/dist/esm/models/WorkflowCancelResponse.d.ts +53 -0
  11. package/dist/esm/models/WorkflowCancelResponse.js +48 -0
  12. package/dist/esm/models/index.d.ts +2 -1
  13. package/dist/esm/models/index.js +2 -1
  14. package/dist/models/TemporalWorkflowStatusResponse.d.ts +83 -0
  15. package/dist/models/TemporalWorkflowStatusResponse.js +74 -0
  16. package/dist/models/WorkflowActionResponse.d.ts +1 -1
  17. package/dist/models/WorkflowCancelResponse.d.ts +53 -0
  18. package/dist/models/WorkflowCancelResponse.js +56 -0
  19. package/dist/models/index.d.ts +2 -1
  20. package/dist/models/index.js +2 -1
  21. package/docs/TemporalWorkflowStatusResponse.md +47 -0
  22. package/docs/WorkflowActionResponse.md +1 -1
  23. package/docs/{WorkflowAction.md → WorkflowCancelResponse.md} +9 -5
  24. package/docs/WorkflowsApi.md +183 -36
  25. package/package.json +1 -1
  26. package/src/apis/WorkflowsApi.ts +249 -90
  27. package/src/models/TemporalWorkflowStatusResponse.ts +136 -0
  28. package/src/models/WorkflowActionResponse.ts +1 -1
  29. package/src/models/WorkflowCancelResponse.ts +92 -0
  30. package/src/models/index.ts +2 -1
  31. package/dist/esm/models/WorkflowAction.d.ts +0 -25
  32. package/dist/esm/models/WorkflowAction.js +0 -43
  33. package/dist/models/WorkflowAction.d.ts +0 -25
  34. package/dist/models/WorkflowAction.js +0 -51
  35. package/src/models/WorkflowAction.ts +0 -53
@@ -0,0 +1,136 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
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
+ /**
17
+ * Generic Temporal workflow status — no DB interaction.
18
+ * @export
19
+ * @interface TemporalWorkflowStatusResponse
20
+ */
21
+ export interface TemporalWorkflowStatusResponse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof TemporalWorkflowStatusResponse
26
+ */
27
+ workflowId: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof TemporalWorkflowStatusResponse
32
+ */
33
+ temporalStatus: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof TemporalWorkflowStatusResponse
38
+ */
39
+ workflowType: string;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof TemporalWorkflowStatusResponse
44
+ */
45
+ taskQueue: string;
46
+ /**
47
+ *
48
+ * @type {Date}
49
+ * @memberof TemporalWorkflowStatusResponse
50
+ */
51
+ startTime: Date;
52
+ /**
53
+ *
54
+ * @type {Date}
55
+ * @memberof TemporalWorkflowStatusResponse
56
+ */
57
+ closeTime?: Date | null;
58
+ /**
59
+ *
60
+ * @type {string}
61
+ * @memberof TemporalWorkflowStatusResponse
62
+ */
63
+ runId: string;
64
+ }
65
+
66
+ /**
67
+ * Check if a given object implements the TemporalWorkflowStatusResponse interface.
68
+ */
69
+ export function instanceOfTemporalWorkflowStatusResponse(value: object): value is TemporalWorkflowStatusResponse {
70
+ if (!('workflowId' in value) || value['workflowId'] === undefined) return false;
71
+ if (!('temporalStatus' in value) || value['temporalStatus'] === undefined) return false;
72
+ if (!('workflowType' in value) || value['workflowType'] === undefined) return false;
73
+ if (!('taskQueue' in value) || value['taskQueue'] === undefined) return false;
74
+ if (!('startTime' in value) || value['startTime'] === undefined) return false;
75
+ if (!('runId' in value) || value['runId'] === undefined) return false;
76
+ return true;
77
+ }
78
+
79
+ export function TemporalWorkflowStatusResponseFromJSON(json: any): TemporalWorkflowStatusResponse {
80
+ return TemporalWorkflowStatusResponseFromJSONTyped(json, false);
81
+ }
82
+
83
+ export function TemporalWorkflowStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemporalWorkflowStatusResponse {
84
+ if (json == null) {
85
+ return json;
86
+ }
87
+ return {
88
+
89
+ 'workflowId': json['workflow_id'],
90
+ 'temporalStatus': json['temporal_status'],
91
+ 'workflowType': json['workflow_type'],
92
+ 'taskQueue': json['task_queue'],
93
+ 'startTime': (new Date(json['start_time'])),
94
+ 'closeTime': json['close_time'] == null ? undefined : (new Date(json['close_time'])),
95
+ 'runId': json['run_id'],
96
+ };
97
+ }
98
+
99
+ export function TemporalWorkflowStatusResponseToJSON(json: any): TemporalWorkflowStatusResponse {
100
+ return TemporalWorkflowStatusResponseToJSONTyped(json, false);
101
+ }
102
+
103
+ export function TemporalWorkflowStatusResponseToJSONTyped(value?: TemporalWorkflowStatusResponse | null, ignoreDiscriminator: boolean = false): any {
104
+ if (value == null) {
105
+ return value;
106
+ }
107
+
108
+ return {
109
+
110
+ 'workflow_id': value['workflowId'],
111
+ 'temporal_status': value['temporalStatus'],
112
+ 'workflow_type': value['workflowType'],
113
+ 'task_queue': value['taskQueue'],
114
+ 'start_time': value['startTime'].toISOString(),
115
+ 'close_time': value['closeTime'] == null ? value['closeTime'] : value['closeTime'].toISOString(),
116
+ 'run_id': value['runId'],
117
+ };
118
+ }
119
+
120
+ export const TemporalWorkflowStatusResponsePropertyValidationAttributesMap: {
121
+ [property: string]: {
122
+ maxLength?: number,
123
+ minLength?: number,
124
+ pattern?: string,
125
+ maximum?: number,
126
+ exclusiveMaximum?: boolean,
127
+ minimum?: number,
128
+ exclusiveMinimum?: boolean,
129
+ multipleOf?: number,
130
+ maxItems?: number,
131
+ minItems?: number,
132
+ uniqueItems?: boolean
133
+ }
134
+ } = {
135
+ }
136
+
@@ -14,7 +14,7 @@
14
14
 
15
15
  import { mapValues } from '../runtime';
16
16
  /**
17
- * POST response for cancel/rerun.
17
+ * POST response for rerun.
18
18
  * @export
19
19
  * @interface WorkflowActionResponse
20
20
  */
@@ -0,0 +1,92 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
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
+ /**
17
+ * Response for generic workflow cancellation.
18
+ * @export
19
+ * @interface WorkflowCancelResponse
20
+ */
21
+ export interface WorkflowCancelResponse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof WorkflowCancelResponse
26
+ */
27
+ workflowId: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof WorkflowCancelResponse
32
+ */
33
+ message: string;
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the WorkflowCancelResponse interface.
38
+ */
39
+ export function instanceOfWorkflowCancelResponse(value: object): value is WorkflowCancelResponse {
40
+ if (!('workflowId' in value) || value['workflowId'] === undefined) return false;
41
+ if (!('message' in value) || value['message'] === undefined) return false;
42
+ return true;
43
+ }
44
+
45
+ export function WorkflowCancelResponseFromJSON(json: any): WorkflowCancelResponse {
46
+ return WorkflowCancelResponseFromJSONTyped(json, false);
47
+ }
48
+
49
+ export function WorkflowCancelResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowCancelResponse {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+
55
+ 'workflowId': json['workflow_id'],
56
+ 'message': json['message'],
57
+ };
58
+ }
59
+
60
+ export function WorkflowCancelResponseToJSON(json: any): WorkflowCancelResponse {
61
+ return WorkflowCancelResponseToJSONTyped(json, false);
62
+ }
63
+
64
+ export function WorkflowCancelResponseToJSONTyped(value?: WorkflowCancelResponse | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'workflow_id': value['workflowId'],
72
+ 'message': value['message'],
73
+ };
74
+ }
75
+
76
+ export const WorkflowCancelResponsePropertyValidationAttributesMap: {
77
+ [property: string]: {
78
+ maxLength?: number,
79
+ minLength?: number,
80
+ pattern?: string,
81
+ maximum?: number,
82
+ exclusiveMaximum?: boolean,
83
+ minimum?: number,
84
+ exclusiveMinimum?: boolean,
85
+ multipleOf?: number,
86
+ maxItems?: number,
87
+ minItems?: number,
88
+ uniqueItems?: boolean
89
+ }
90
+ } = {
91
+ }
92
+
@@ -110,6 +110,7 @@ export * from './SubtreeChunkGroup';
110
110
  export * from './SubtreeChunksResponse';
111
111
  export * from './SupportedLanguage';
112
112
  export * from './TagResponse';
113
+ export * from './TemporalWorkflowStatusResponse';
113
114
  export * from './TenantBrandingResponse';
114
115
  export * from './TenantResponse';
115
116
  export * from './TenantSettingsResponse';
@@ -137,7 +138,7 @@ export * from './UserMessageResponse';
137
138
  export * from './UserResponse';
138
139
  export * from './ValidationError';
139
140
  export * from './VersionChunkIdsResponse';
140
- export * from './WorkflowAction';
141
141
  export * from './WorkflowActionResponse';
142
+ export * from './WorkflowCancelResponse';
142
143
  export * from './WorkflowDetailResponse';
143
144
  export * from './WorkflowSummaryResponse';
@@ -1,25 +0,0 @@
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
- * Supported workflow actions.
14
- * @export
15
- */
16
- export declare const WorkflowAction: {
17
- readonly Rerun: "rerun";
18
- readonly Cancel: "cancel";
19
- };
20
- export type WorkflowAction = typeof WorkflowAction[keyof typeof WorkflowAction];
21
- export declare function instanceOfWorkflowAction(value: any): boolean;
22
- export declare function WorkflowActionFromJSON(json: any): WorkflowAction;
23
- export declare function WorkflowActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowAction;
24
- export declare function WorkflowActionToJSON(value?: WorkflowAction | null): any;
25
- export declare function WorkflowActionToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowAction;
@@ -1,43 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Knowledge Stack API
5
- * Knowledge Stack backend API for authentication and knowledge management
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
- * Supported workflow actions.
16
- * @export
17
- */
18
- export const WorkflowAction = {
19
- Rerun: 'rerun',
20
- Cancel: 'cancel'
21
- };
22
- export function instanceOfWorkflowAction(value) {
23
- for (const key in WorkflowAction) {
24
- if (Object.prototype.hasOwnProperty.call(WorkflowAction, key)) {
25
- if (WorkflowAction[key] === value) {
26
- return true;
27
- }
28
- }
29
- }
30
- return false;
31
- }
32
- export function WorkflowActionFromJSON(json) {
33
- return WorkflowActionFromJSONTyped(json, false);
34
- }
35
- export function WorkflowActionFromJSONTyped(json, ignoreDiscriminator) {
36
- return json;
37
- }
38
- export function WorkflowActionToJSON(value) {
39
- return value;
40
- }
41
- export function WorkflowActionToJSONTyped(value, ignoreDiscriminator) {
42
- return value;
43
- }
@@ -1,25 +0,0 @@
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
- * Supported workflow actions.
14
- * @export
15
- */
16
- export declare const WorkflowAction: {
17
- readonly Rerun: "rerun";
18
- readonly Cancel: "cancel";
19
- };
20
- export type WorkflowAction = typeof WorkflowAction[keyof typeof WorkflowAction];
21
- export declare function instanceOfWorkflowAction(value: any): boolean;
22
- export declare function WorkflowActionFromJSON(json: any): WorkflowAction;
23
- export declare function WorkflowActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowAction;
24
- export declare function WorkflowActionToJSON(value?: WorkflowAction | null): any;
25
- export declare function WorkflowActionToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowAction;
@@ -1,51 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Knowledge Stack API
6
- * Knowledge Stack backend API for authentication and knowledge management
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.WorkflowAction = void 0;
17
- exports.instanceOfWorkflowAction = instanceOfWorkflowAction;
18
- exports.WorkflowActionFromJSON = WorkflowActionFromJSON;
19
- exports.WorkflowActionFromJSONTyped = WorkflowActionFromJSONTyped;
20
- exports.WorkflowActionToJSON = WorkflowActionToJSON;
21
- exports.WorkflowActionToJSONTyped = WorkflowActionToJSONTyped;
22
- /**
23
- * Supported workflow actions.
24
- * @export
25
- */
26
- exports.WorkflowAction = {
27
- Rerun: 'rerun',
28
- Cancel: 'cancel'
29
- };
30
- function instanceOfWorkflowAction(value) {
31
- for (const key in exports.WorkflowAction) {
32
- if (Object.prototype.hasOwnProperty.call(exports.WorkflowAction, key)) {
33
- if (exports.WorkflowAction[key] === value) {
34
- return true;
35
- }
36
- }
37
- }
38
- return false;
39
- }
40
- function WorkflowActionFromJSON(json) {
41
- return WorkflowActionFromJSONTyped(json, false);
42
- }
43
- function WorkflowActionFromJSONTyped(json, ignoreDiscriminator) {
44
- return json;
45
- }
46
- function WorkflowActionToJSON(value) {
47
- return value;
48
- }
49
- function WorkflowActionToJSONTyped(value, ignoreDiscriminator) {
50
- return value;
51
- }
@@ -1,53 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Knowledge Stack API
5
- * Knowledge Stack backend API for authentication and knowledge management
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
- * Supported workflow actions.
18
- * @export
19
- */
20
- export const WorkflowAction = {
21
- Rerun: 'rerun',
22
- Cancel: 'cancel'
23
- } as const;
24
- export type WorkflowAction = typeof WorkflowAction[keyof typeof WorkflowAction];
25
-
26
-
27
- export function instanceOfWorkflowAction(value: any): boolean {
28
- for (const key in WorkflowAction) {
29
- if (Object.prototype.hasOwnProperty.call(WorkflowAction, key)) {
30
- if (WorkflowAction[key as keyof typeof WorkflowAction] === value) {
31
- return true;
32
- }
33
- }
34
- }
35
- return false;
36
- }
37
-
38
- export function WorkflowActionFromJSON(json: any): WorkflowAction {
39
- return WorkflowActionFromJSONTyped(json, false);
40
- }
41
-
42
- export function WorkflowActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowAction {
43
- return json as WorkflowAction;
44
- }
45
-
46
- export function WorkflowActionToJSON(value?: WorkflowAction | null): any {
47
- return value as any;
48
- }
49
-
50
- export function WorkflowActionToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowAction {
51
- return value as WorkflowAction;
52
- }
53
-