@knowledge-stack/ksapi 1.62.2 → 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.
Files changed (167) hide show
  1. package/.openapi-generator/FILES +48 -0
  2. package/README.md +36 -2
  3. package/dist/apis/FeedbackApi.d.ts +170 -0
  4. package/dist/apis/FeedbackApi.js +176 -0
  5. package/dist/apis/WorkflowDefinitionsApi.d.ts +328 -0
  6. package/dist/apis/WorkflowDefinitionsApi.js +345 -0
  7. package/dist/apis/WorkflowRunsApi.d.ts +146 -0
  8. package/dist/apis/WorkflowRunsApi.js +160 -0
  9. package/dist/apis/index.d.ts +3 -0
  10. package/dist/apis/index.js +3 -0
  11. package/dist/esm/apis/FeedbackApi.d.ts +170 -0
  12. package/dist/esm/apis/FeedbackApi.js +172 -0
  13. package/dist/esm/apis/WorkflowDefinitionsApi.d.ts +328 -0
  14. package/dist/esm/apis/WorkflowDefinitionsApi.js +341 -0
  15. package/dist/esm/apis/WorkflowRunsApi.d.ts +146 -0
  16. package/dist/esm/apis/WorkflowRunsApi.js +156 -0
  17. package/dist/esm/apis/index.d.ts +3 -0
  18. package/dist/esm/apis/index.js +3 -0
  19. package/dist/esm/models/ABCDPathSnapshot.d.ts +60 -0
  20. package/dist/esm/models/ABCDPathSnapshot.js +53 -0
  21. package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +97 -0
  22. package/dist/esm/models/CreateWorkflowDefinitionRequest.js +95 -0
  23. package/dist/esm/models/FeedbackEventResponse.d.ts +106 -0
  24. package/dist/esm/models/FeedbackEventResponse.js +83 -0
  25. package/dist/esm/models/FeedbackRating.d.ts +25 -0
  26. package/dist/esm/models/FeedbackRating.js +43 -0
  27. package/dist/esm/models/FeedbackReason.d.ts +34 -0
  28. package/dist/esm/models/FeedbackReason.js +52 -0
  29. package/dist/esm/models/FeedbackTargetType.d.ts +28 -0
  30. package/dist/esm/models/FeedbackTargetType.js +46 -0
  31. package/dist/esm/models/InvokeWorkflowRequest.d.ts +47 -0
  32. package/dist/esm/models/InvokeWorkflowRequest.js +46 -0
  33. package/dist/esm/models/PaginatedResponseFeedbackEventResponse.d.ts +66 -0
  34. package/dist/esm/models/PaginatedResponseFeedbackEventResponse.js +70 -0
  35. package/dist/esm/models/PaginatedResponseWorkflowDefinitionResponse.d.ts +66 -0
  36. package/dist/esm/models/PaginatedResponseWorkflowDefinitionResponse.js +70 -0
  37. package/dist/esm/models/PaginatedResponseWorkflowRunResponse.d.ts +66 -0
  38. package/dist/esm/models/PaginatedResponseWorkflowRunResponse.js +70 -0
  39. package/dist/esm/models/PartType.d.ts +2 -0
  40. package/dist/esm/models/PartType.js +3 -1
  41. package/dist/esm/models/ReferenceType.d.ts +2 -0
  42. package/dist/esm/models/ReferenceType.js +2 -0
  43. package/dist/esm/models/SelfHostedRunnerConfig.d.ts +53 -0
  44. package/dist/esm/models/SelfHostedRunnerConfig.js +53 -0
  45. package/dist/esm/models/SelfHostedRunnerConfigResponse.d.ts +47 -0
  46. package/dist/esm/models/SelfHostedRunnerConfigResponse.js +49 -0
  47. package/dist/esm/models/SubmitFeedbackRequest.d.ts +82 -0
  48. package/dist/esm/models/SubmitFeedbackRequest.js +65 -0
  49. package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +103 -0
  50. package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +97 -0
  51. package/dist/esm/models/WorkflowCallbackResponse.d.ts +47 -0
  52. package/dist/esm/models/WorkflowCallbackResponse.js +44 -0
  53. package/dist/esm/models/WorkflowDefinitionResponse.d.ts +121 -0
  54. package/dist/esm/models/WorkflowDefinitionResponse.js +94 -0
  55. package/dist/esm/models/WorkflowRunCallbackRequest.d.ts +61 -0
  56. package/dist/esm/models/WorkflowRunCallbackRequest.js +57 -0
  57. package/dist/esm/models/WorkflowRunResponse.d.ts +110 -0
  58. package/dist/esm/models/WorkflowRunResponse.js +87 -0
  59. package/dist/esm/models/WorkflowRunSnapshot.d.ts +97 -0
  60. package/dist/esm/models/WorkflowRunSnapshot.js +78 -0
  61. package/dist/esm/models/WorkflowRunStatus.d.ts +27 -0
  62. package/dist/esm/models/WorkflowRunStatus.js +45 -0
  63. package/dist/esm/models/WorkflowRunnerType.d.ts +24 -0
  64. package/dist/esm/models/WorkflowRunnerType.js +42 -0
  65. package/dist/esm/models/index.d.ts +21 -0
  66. package/dist/esm/models/index.js +21 -0
  67. package/dist/models/ABCDPathSnapshot.d.ts +60 -0
  68. package/dist/models/ABCDPathSnapshot.js +61 -0
  69. package/dist/models/CreateWorkflowDefinitionRequest.d.ts +97 -0
  70. package/dist/models/CreateWorkflowDefinitionRequest.js +103 -0
  71. package/dist/models/FeedbackEventResponse.d.ts +106 -0
  72. package/dist/models/FeedbackEventResponse.js +91 -0
  73. package/dist/models/FeedbackRating.d.ts +25 -0
  74. package/dist/models/FeedbackRating.js +51 -0
  75. package/dist/models/FeedbackReason.d.ts +34 -0
  76. package/dist/models/FeedbackReason.js +60 -0
  77. package/dist/models/FeedbackTargetType.d.ts +28 -0
  78. package/dist/models/FeedbackTargetType.js +54 -0
  79. package/dist/models/InvokeWorkflowRequest.d.ts +47 -0
  80. package/dist/models/InvokeWorkflowRequest.js +54 -0
  81. package/dist/models/PaginatedResponseFeedbackEventResponse.d.ts +66 -0
  82. package/dist/models/PaginatedResponseFeedbackEventResponse.js +78 -0
  83. package/dist/models/PaginatedResponseWorkflowDefinitionResponse.d.ts +66 -0
  84. package/dist/models/PaginatedResponseWorkflowDefinitionResponse.js +78 -0
  85. package/dist/models/PaginatedResponseWorkflowRunResponse.d.ts +66 -0
  86. package/dist/models/PaginatedResponseWorkflowRunResponse.js +78 -0
  87. package/dist/models/PartType.d.ts +2 -0
  88. package/dist/models/PartType.js +3 -1
  89. package/dist/models/ReferenceType.d.ts +2 -0
  90. package/dist/models/ReferenceType.js +2 -0
  91. package/dist/models/SelfHostedRunnerConfig.d.ts +53 -0
  92. package/dist/models/SelfHostedRunnerConfig.js +61 -0
  93. package/dist/models/SelfHostedRunnerConfigResponse.d.ts +47 -0
  94. package/dist/models/SelfHostedRunnerConfigResponse.js +57 -0
  95. package/dist/models/SubmitFeedbackRequest.d.ts +82 -0
  96. package/dist/models/SubmitFeedbackRequest.js +73 -0
  97. package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +103 -0
  98. package/dist/models/UpdateWorkflowDefinitionRequest.js +105 -0
  99. package/dist/models/WorkflowCallbackResponse.d.ts +47 -0
  100. package/dist/models/WorkflowCallbackResponse.js +52 -0
  101. package/dist/models/WorkflowDefinitionResponse.d.ts +121 -0
  102. package/dist/models/WorkflowDefinitionResponse.js +102 -0
  103. package/dist/models/WorkflowRunCallbackRequest.d.ts +61 -0
  104. package/dist/models/WorkflowRunCallbackRequest.js +65 -0
  105. package/dist/models/WorkflowRunResponse.d.ts +110 -0
  106. package/dist/models/WorkflowRunResponse.js +95 -0
  107. package/dist/models/WorkflowRunSnapshot.d.ts +97 -0
  108. package/dist/models/WorkflowRunSnapshot.js +86 -0
  109. package/dist/models/WorkflowRunStatus.d.ts +27 -0
  110. package/dist/models/WorkflowRunStatus.js +53 -0
  111. package/dist/models/WorkflowRunnerType.d.ts +24 -0
  112. package/dist/models/WorkflowRunnerType.js +50 -0
  113. package/dist/models/index.d.ts +21 -0
  114. package/dist/models/index.js +21 -0
  115. package/docs/ABCDPathSnapshot.md +39 -0
  116. package/docs/CreateWorkflowDefinitionRequest.md +51 -0
  117. package/docs/FeedbackApi.md +245 -0
  118. package/docs/FeedbackEventResponse.md +53 -0
  119. package/docs/FeedbackRating.md +32 -0
  120. package/docs/FeedbackReason.md +32 -0
  121. package/docs/FeedbackTargetType.md +32 -0
  122. package/docs/InvokeWorkflowRequest.md +35 -0
  123. package/docs/PaginatedResponseFeedbackEventResponse.md +40 -0
  124. package/docs/PaginatedResponseWorkflowDefinitionResponse.md +40 -0
  125. package/docs/PaginatedResponseWorkflowRunResponse.md +40 -0
  126. package/docs/SelfHostedRunnerConfig.md +37 -0
  127. package/docs/SelfHostedRunnerConfigResponse.md +35 -0
  128. package/docs/SubmitFeedbackRequest.md +45 -0
  129. package/docs/UpdateWorkflowDefinitionRequest.md +53 -0
  130. package/docs/WorkflowCallbackResponse.md +35 -0
  131. package/docs/WorkflowDefinitionResponse.md +59 -0
  132. package/docs/WorkflowDefinitionsApi.md +534 -0
  133. package/docs/WorkflowRunCallbackRequest.md +37 -0
  134. package/docs/WorkflowRunResponse.md +55 -0
  135. package/docs/WorkflowRunSnapshot.md +51 -0
  136. package/docs/WorkflowRunStatus.md +33 -0
  137. package/docs/WorkflowRunnerType.md +33 -0
  138. package/docs/WorkflowRunsApi.md +224 -0
  139. package/package.json +1 -1
  140. package/src/apis/FeedbackApi.ts +334 -0
  141. package/src/apis/WorkflowDefinitionsApi.ts +678 -0
  142. package/src/apis/WorkflowRunsApi.ts +296 -0
  143. package/src/apis/index.ts +3 -0
  144. package/src/models/ABCDPathSnapshot.ts +111 -0
  145. package/src/models/CreateWorkflowDefinitionRequest.ts +192 -0
  146. package/src/models/FeedbackEventResponse.ts +188 -0
  147. package/src/models/FeedbackRating.ts +53 -0
  148. package/src/models/FeedbackReason.ts +62 -0
  149. package/src/models/FeedbackTargetType.ts +56 -0
  150. package/src/models/InvokeWorkflowRequest.ts +85 -0
  151. package/src/models/PaginatedResponseFeedbackEventResponse.ts +130 -0
  152. package/src/models/PaginatedResponseWorkflowDefinitionResponse.ts +130 -0
  153. package/src/models/PaginatedResponseWorkflowRunResponse.ts +130 -0
  154. package/src/models/PartType.ts +3 -1
  155. package/src/models/ReferenceType.ts +2 -0
  156. package/src/models/SelfHostedRunnerConfig.ts +96 -0
  157. package/src/models/SelfHostedRunnerConfigResponse.ts +87 -0
  158. package/src/models/SubmitFeedbackRequest.ts +152 -0
  159. package/src/models/UpdateWorkflowDefinitionRequest.ts +200 -0
  160. package/src/models/WorkflowCallbackResponse.ts +83 -0
  161. package/src/models/WorkflowDefinitionResponse.ts +208 -0
  162. package/src/models/WorkflowRunCallbackRequest.ts +105 -0
  163. package/src/models/WorkflowRunResponse.ts +197 -0
  164. package/src/models/WorkflowRunSnapshot.ts +172 -0
  165. package/src/models/WorkflowRunStatus.ts +55 -0
  166. package/src/models/WorkflowRunnerType.ts +52 -0
  167. package/src/models/index.ts +21 -0
@@ -0,0 +1,678 @@
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
+ import * as runtime from '../runtime';
17
+ import type {
18
+ CreateWorkflowDefinitionRequest,
19
+ HTTPValidationError,
20
+ InvokeWorkflowRequest,
21
+ PaginatedResponseWorkflowDefinitionResponse,
22
+ PaginatedResponseWorkflowRunResponse,
23
+ UpdateWorkflowDefinitionRequest,
24
+ WorkflowDefinitionResponse,
25
+ WorkflowRunResponse,
26
+ } from '../models/index';
27
+ import {
28
+ CreateWorkflowDefinitionRequestFromJSON,
29
+ CreateWorkflowDefinitionRequestToJSON,
30
+ HTTPValidationErrorFromJSON,
31
+ HTTPValidationErrorToJSON,
32
+ InvokeWorkflowRequestFromJSON,
33
+ InvokeWorkflowRequestToJSON,
34
+ PaginatedResponseWorkflowDefinitionResponseFromJSON,
35
+ PaginatedResponseWorkflowDefinitionResponseToJSON,
36
+ PaginatedResponseWorkflowRunResponseFromJSON,
37
+ PaginatedResponseWorkflowRunResponseToJSON,
38
+ UpdateWorkflowDefinitionRequestFromJSON,
39
+ UpdateWorkflowDefinitionRequestToJSON,
40
+ WorkflowDefinitionResponseFromJSON,
41
+ WorkflowDefinitionResponseToJSON,
42
+ WorkflowRunResponseFromJSON,
43
+ WorkflowRunResponseToJSON,
44
+ } from '../models/index';
45
+
46
+ export interface CreateWorkflowDefinitionOperationRequest {
47
+ createWorkflowDefinitionRequest: CreateWorkflowDefinitionRequest;
48
+ authorization?: string | null;
49
+ ksUat?: string | null;
50
+ }
51
+
52
+ export interface DeleteWorkflowDefinitionRequest {
53
+ definitionId: string;
54
+ authorization?: string | null;
55
+ ksUat?: string | null;
56
+ }
57
+
58
+ export interface GetWorkflowDefinitionRequest {
59
+ definitionId: string;
60
+ authorization?: string | null;
61
+ ksUat?: string | null;
62
+ }
63
+
64
+ export interface InvokeWorkflowOperationRequest {
65
+ definitionId: string;
66
+ invokeWorkflowRequest: InvokeWorkflowRequest;
67
+ authorization?: string | null;
68
+ ksUat?: string | null;
69
+ }
70
+
71
+ export interface ListWorkflowDefinitionsRequest {
72
+ limit?: number;
73
+ offset?: number;
74
+ authorization?: string | null;
75
+ ksUat?: string | null;
76
+ }
77
+
78
+ export interface ListWorkflowRunsRequest {
79
+ definitionId: string;
80
+ limit?: number;
81
+ offset?: number;
82
+ authorization?: string | null;
83
+ ksUat?: string | null;
84
+ }
85
+
86
+ export interface UpdateWorkflowDefinitionOperationRequest {
87
+ definitionId: string;
88
+ updateWorkflowDefinitionRequest: UpdateWorkflowDefinitionRequest;
89
+ authorization?: string | null;
90
+ ksUat?: string | null;
91
+ }
92
+
93
+ /**
94
+ * WorkflowDefinitionsApi - interface
95
+ *
96
+ * @export
97
+ * @interface WorkflowDefinitionsApiInterface
98
+ */
99
+ export interface WorkflowDefinitionsApiInterface {
100
+ /**
101
+ * Creates request options for createWorkflowDefinition without sending the request
102
+ * @param {CreateWorkflowDefinitionRequest} createWorkflowDefinitionRequest
103
+ * @param {string} [authorization]
104
+ * @param {string} [ksUat]
105
+ * @throws {RequiredError}
106
+ * @memberof WorkflowDefinitionsApiInterface
107
+ */
108
+ createWorkflowDefinitionRequestOpts(requestParameters: CreateWorkflowDefinitionOperationRequest): Promise<runtime.RequestOpts>;
109
+
110
+ /**
111
+ *
112
+ * @summary Create Workflow Definition Handler
113
+ * @param {CreateWorkflowDefinitionRequest} createWorkflowDefinitionRequest
114
+ * @param {string} [authorization]
115
+ * @param {string} [ksUat]
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ * @memberof WorkflowDefinitionsApiInterface
119
+ */
120
+ createWorkflowDefinitionRaw(requestParameters: CreateWorkflowDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDefinitionResponse>>;
121
+
122
+ /**
123
+ * Create Workflow Definition Handler
124
+ */
125
+ createWorkflowDefinition(requestParameters: CreateWorkflowDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDefinitionResponse>;
126
+
127
+ /**
128
+ * Creates request options for deleteWorkflowDefinition without sending the request
129
+ * @param {string} definitionId
130
+ * @param {string} [authorization]
131
+ * @param {string} [ksUat]
132
+ * @throws {RequiredError}
133
+ * @memberof WorkflowDefinitionsApiInterface
134
+ */
135
+ deleteWorkflowDefinitionRequestOpts(requestParameters: DeleteWorkflowDefinitionRequest): Promise<runtime.RequestOpts>;
136
+
137
+ /**
138
+ *
139
+ * @summary Delete Workflow Definition Handler
140
+ * @param {string} definitionId
141
+ * @param {string} [authorization]
142
+ * @param {string} [ksUat]
143
+ * @param {*} [options] Override http request option.
144
+ * @throws {RequiredError}
145
+ * @memberof WorkflowDefinitionsApiInterface
146
+ */
147
+ deleteWorkflowDefinitionRaw(requestParameters: DeleteWorkflowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
148
+
149
+ /**
150
+ * Delete Workflow Definition Handler
151
+ */
152
+ deleteWorkflowDefinition(requestParameters: DeleteWorkflowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
153
+
154
+ /**
155
+ * Creates request options for getWorkflowDefinition without sending the request
156
+ * @param {string} definitionId
157
+ * @param {string} [authorization]
158
+ * @param {string} [ksUat]
159
+ * @throws {RequiredError}
160
+ * @memberof WorkflowDefinitionsApiInterface
161
+ */
162
+ getWorkflowDefinitionRequestOpts(requestParameters: GetWorkflowDefinitionRequest): Promise<runtime.RequestOpts>;
163
+
164
+ /**
165
+ *
166
+ * @summary Get Workflow Definition Handler
167
+ * @param {string} definitionId
168
+ * @param {string} [authorization]
169
+ * @param {string} [ksUat]
170
+ * @param {*} [options] Override http request option.
171
+ * @throws {RequiredError}
172
+ * @memberof WorkflowDefinitionsApiInterface
173
+ */
174
+ getWorkflowDefinitionRaw(requestParameters: GetWorkflowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDefinitionResponse>>;
175
+
176
+ /**
177
+ * Get Workflow Definition Handler
178
+ */
179
+ getWorkflowDefinition(requestParameters: GetWorkflowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDefinitionResponse>;
180
+
181
+ /**
182
+ * Creates request options for invokeWorkflow without sending the request
183
+ * @param {string} definitionId
184
+ * @param {InvokeWorkflowRequest} invokeWorkflowRequest
185
+ * @param {string} [authorization]
186
+ * @param {string} [ksUat]
187
+ * @throws {RequiredError}
188
+ * @memberof WorkflowDefinitionsApiInterface
189
+ */
190
+ invokeWorkflowRequestOpts(requestParameters: InvokeWorkflowOperationRequest): Promise<runtime.RequestOpts>;
191
+
192
+ /**
193
+ *
194
+ * @summary Invoke Workflow Handler
195
+ * @param {string} definitionId
196
+ * @param {InvokeWorkflowRequest} invokeWorkflowRequest
197
+ * @param {string} [authorization]
198
+ * @param {string} [ksUat]
199
+ * @param {*} [options] Override http request option.
200
+ * @throws {RequiredError}
201
+ * @memberof WorkflowDefinitionsApiInterface
202
+ */
203
+ invokeWorkflowRaw(requestParameters: InvokeWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
204
+
205
+ /**
206
+ * Invoke Workflow Handler
207
+ */
208
+ invokeWorkflow(requestParameters: InvokeWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
209
+
210
+ /**
211
+ * Creates request options for listWorkflowDefinitions without sending the request
212
+ * @param {number} [limit] Number of items per page
213
+ * @param {number} [offset] Number of items to skip
214
+ * @param {string} [authorization]
215
+ * @param {string} [ksUat]
216
+ * @throws {RequiredError}
217
+ * @memberof WorkflowDefinitionsApiInterface
218
+ */
219
+ listWorkflowDefinitionsRequestOpts(requestParameters: ListWorkflowDefinitionsRequest): Promise<runtime.RequestOpts>;
220
+
221
+ /**
222
+ *
223
+ * @summary List Workflow Definitions Handler
224
+ * @param {number} [limit] Number of items per page
225
+ * @param {number} [offset] Number of items to skip
226
+ * @param {string} [authorization]
227
+ * @param {string} [ksUat]
228
+ * @param {*} [options] Override http request option.
229
+ * @throws {RequiredError}
230
+ * @memberof WorkflowDefinitionsApiInterface
231
+ */
232
+ listWorkflowDefinitionsRaw(requestParameters: ListWorkflowDefinitionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowDefinitionResponse>>;
233
+
234
+ /**
235
+ * List Workflow Definitions Handler
236
+ */
237
+ listWorkflowDefinitions(requestParameters: ListWorkflowDefinitionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowDefinitionResponse>;
238
+
239
+ /**
240
+ * Creates request options for listWorkflowRuns without sending the request
241
+ * @param {string} definitionId
242
+ * @param {number} [limit] Number of items per page
243
+ * @param {number} [offset] Number of items to skip
244
+ * @param {string} [authorization]
245
+ * @param {string} [ksUat]
246
+ * @throws {RequiredError}
247
+ * @memberof WorkflowDefinitionsApiInterface
248
+ */
249
+ listWorkflowRunsRequestOpts(requestParameters: ListWorkflowRunsRequest): Promise<runtime.RequestOpts>;
250
+
251
+ /**
252
+ *
253
+ * @summary List Workflow Runs Handler
254
+ * @param {string} definitionId
255
+ * @param {number} [limit] Number of items per page
256
+ * @param {number} [offset] Number of items to skip
257
+ * @param {string} [authorization]
258
+ * @param {string} [ksUat]
259
+ * @param {*} [options] Override http request option.
260
+ * @throws {RequiredError}
261
+ * @memberof WorkflowDefinitionsApiInterface
262
+ */
263
+ listWorkflowRunsRaw(requestParameters: ListWorkflowRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowRunResponse>>;
264
+
265
+ /**
266
+ * List Workflow Runs Handler
267
+ */
268
+ listWorkflowRuns(requestParameters: ListWorkflowRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowRunResponse>;
269
+
270
+ /**
271
+ * Creates request options for updateWorkflowDefinition without sending the request
272
+ * @param {string} definitionId
273
+ * @param {UpdateWorkflowDefinitionRequest} updateWorkflowDefinitionRequest
274
+ * @param {string} [authorization]
275
+ * @param {string} [ksUat]
276
+ * @throws {RequiredError}
277
+ * @memberof WorkflowDefinitionsApiInterface
278
+ */
279
+ updateWorkflowDefinitionRequestOpts(requestParameters: UpdateWorkflowDefinitionOperationRequest): Promise<runtime.RequestOpts>;
280
+
281
+ /**
282
+ *
283
+ * @summary Update Workflow Definition Handler
284
+ * @param {string} definitionId
285
+ * @param {UpdateWorkflowDefinitionRequest} updateWorkflowDefinitionRequest
286
+ * @param {string} [authorization]
287
+ * @param {string} [ksUat]
288
+ * @param {*} [options] Override http request option.
289
+ * @throws {RequiredError}
290
+ * @memberof WorkflowDefinitionsApiInterface
291
+ */
292
+ updateWorkflowDefinitionRaw(requestParameters: UpdateWorkflowDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDefinitionResponse>>;
293
+
294
+ /**
295
+ * Update Workflow Definition Handler
296
+ */
297
+ updateWorkflowDefinition(requestParameters: UpdateWorkflowDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDefinitionResponse>;
298
+
299
+ }
300
+
301
+ /**
302
+ *
303
+ */
304
+ export class WorkflowDefinitionsApi extends runtime.BaseAPI implements WorkflowDefinitionsApiInterface {
305
+
306
+ /**
307
+ * Creates request options for createWorkflowDefinition without sending the request
308
+ */
309
+ async createWorkflowDefinitionRequestOpts(requestParameters: CreateWorkflowDefinitionOperationRequest): Promise<runtime.RequestOpts> {
310
+ if (requestParameters['createWorkflowDefinitionRequest'] == null) {
311
+ throw new runtime.RequiredError(
312
+ 'createWorkflowDefinitionRequest',
313
+ 'Required parameter "createWorkflowDefinitionRequest" was null or undefined when calling createWorkflowDefinition().'
314
+ );
315
+ }
316
+
317
+ const queryParameters: any = {};
318
+
319
+ const headerParameters: runtime.HTTPHeaders = {};
320
+
321
+ headerParameters['Content-Type'] = 'application/json';
322
+
323
+ if (requestParameters['authorization'] != null) {
324
+ headerParameters['authorization'] = String(requestParameters['authorization']);
325
+ }
326
+
327
+
328
+ let urlPath = `/v1/workflow-definitions`;
329
+
330
+ return {
331
+ path: urlPath,
332
+ method: 'POST',
333
+ headers: headerParameters,
334
+ query: queryParameters,
335
+ body: CreateWorkflowDefinitionRequestToJSON(requestParameters['createWorkflowDefinitionRequest']),
336
+ };
337
+ }
338
+
339
+ /**
340
+ * Create Workflow Definition Handler
341
+ */
342
+ async createWorkflowDefinitionRaw(requestParameters: CreateWorkflowDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDefinitionResponse>> {
343
+ const requestOptions = await this.createWorkflowDefinitionRequestOpts(requestParameters);
344
+ const response = await this.request(requestOptions, initOverrides);
345
+
346
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDefinitionResponseFromJSON(jsonValue));
347
+ }
348
+
349
+ /**
350
+ * Create Workflow Definition Handler
351
+ */
352
+ async createWorkflowDefinition(requestParameters: CreateWorkflowDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDefinitionResponse> {
353
+ const response = await this.createWorkflowDefinitionRaw(requestParameters, initOverrides);
354
+ return await response.value();
355
+ }
356
+
357
+ /**
358
+ * Creates request options for deleteWorkflowDefinition without sending the request
359
+ */
360
+ async deleteWorkflowDefinitionRequestOpts(requestParameters: DeleteWorkflowDefinitionRequest): Promise<runtime.RequestOpts> {
361
+ if (requestParameters['definitionId'] == null) {
362
+ throw new runtime.RequiredError(
363
+ 'definitionId',
364
+ 'Required parameter "definitionId" was null or undefined when calling deleteWorkflowDefinition().'
365
+ );
366
+ }
367
+
368
+ const queryParameters: any = {};
369
+
370
+ const headerParameters: runtime.HTTPHeaders = {};
371
+
372
+ if (requestParameters['authorization'] != null) {
373
+ headerParameters['authorization'] = String(requestParameters['authorization']);
374
+ }
375
+
376
+
377
+ let urlPath = `/v1/workflow-definitions/{definition_id}`;
378
+ urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
379
+
380
+ return {
381
+ path: urlPath,
382
+ method: 'DELETE',
383
+ headers: headerParameters,
384
+ query: queryParameters,
385
+ };
386
+ }
387
+
388
+ /**
389
+ * Delete Workflow Definition Handler
390
+ */
391
+ async deleteWorkflowDefinitionRaw(requestParameters: DeleteWorkflowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
392
+ const requestOptions = await this.deleteWorkflowDefinitionRequestOpts(requestParameters);
393
+ const response = await this.request(requestOptions, initOverrides);
394
+
395
+ return new runtime.VoidApiResponse(response);
396
+ }
397
+
398
+ /**
399
+ * Delete Workflow Definition Handler
400
+ */
401
+ async deleteWorkflowDefinition(requestParameters: DeleteWorkflowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
402
+ await this.deleteWorkflowDefinitionRaw(requestParameters, initOverrides);
403
+ }
404
+
405
+ /**
406
+ * Creates request options for getWorkflowDefinition without sending the request
407
+ */
408
+ async getWorkflowDefinitionRequestOpts(requestParameters: GetWorkflowDefinitionRequest): Promise<runtime.RequestOpts> {
409
+ if (requestParameters['definitionId'] == null) {
410
+ throw new runtime.RequiredError(
411
+ 'definitionId',
412
+ 'Required parameter "definitionId" was null or undefined when calling getWorkflowDefinition().'
413
+ );
414
+ }
415
+
416
+ const queryParameters: any = {};
417
+
418
+ const headerParameters: runtime.HTTPHeaders = {};
419
+
420
+ if (requestParameters['authorization'] != null) {
421
+ headerParameters['authorization'] = String(requestParameters['authorization']);
422
+ }
423
+
424
+
425
+ let urlPath = `/v1/workflow-definitions/{definition_id}`;
426
+ urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
427
+
428
+ return {
429
+ path: urlPath,
430
+ method: 'GET',
431
+ headers: headerParameters,
432
+ query: queryParameters,
433
+ };
434
+ }
435
+
436
+ /**
437
+ * Get Workflow Definition Handler
438
+ */
439
+ async getWorkflowDefinitionRaw(requestParameters: GetWorkflowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDefinitionResponse>> {
440
+ const requestOptions = await this.getWorkflowDefinitionRequestOpts(requestParameters);
441
+ const response = await this.request(requestOptions, initOverrides);
442
+
443
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDefinitionResponseFromJSON(jsonValue));
444
+ }
445
+
446
+ /**
447
+ * Get Workflow Definition Handler
448
+ */
449
+ async getWorkflowDefinition(requestParameters: GetWorkflowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDefinitionResponse> {
450
+ const response = await this.getWorkflowDefinitionRaw(requestParameters, initOverrides);
451
+ return await response.value();
452
+ }
453
+
454
+ /**
455
+ * Creates request options for invokeWorkflow without sending the request
456
+ */
457
+ async invokeWorkflowRequestOpts(requestParameters: InvokeWorkflowOperationRequest): Promise<runtime.RequestOpts> {
458
+ if (requestParameters['definitionId'] == null) {
459
+ throw new runtime.RequiredError(
460
+ 'definitionId',
461
+ 'Required parameter "definitionId" was null or undefined when calling invokeWorkflow().'
462
+ );
463
+ }
464
+
465
+ if (requestParameters['invokeWorkflowRequest'] == null) {
466
+ throw new runtime.RequiredError(
467
+ 'invokeWorkflowRequest',
468
+ 'Required parameter "invokeWorkflowRequest" was null or undefined when calling invokeWorkflow().'
469
+ );
470
+ }
471
+
472
+ const queryParameters: any = {};
473
+
474
+ const headerParameters: runtime.HTTPHeaders = {};
475
+
476
+ headerParameters['Content-Type'] = 'application/json';
477
+
478
+ if (requestParameters['authorization'] != null) {
479
+ headerParameters['authorization'] = String(requestParameters['authorization']);
480
+ }
481
+
482
+
483
+ let urlPath = `/v1/workflow-definitions/{definition_id}/invoke`;
484
+ urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
485
+
486
+ return {
487
+ path: urlPath,
488
+ method: 'POST',
489
+ headers: headerParameters,
490
+ query: queryParameters,
491
+ body: InvokeWorkflowRequestToJSON(requestParameters['invokeWorkflowRequest']),
492
+ };
493
+ }
494
+
495
+ /**
496
+ * Invoke Workflow Handler
497
+ */
498
+ async invokeWorkflowRaw(requestParameters: InvokeWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>> {
499
+ const requestOptions = await this.invokeWorkflowRequestOpts(requestParameters);
500
+ const response = await this.request(requestOptions, initOverrides);
501
+
502
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowRunResponseFromJSON(jsonValue));
503
+ }
504
+
505
+ /**
506
+ * Invoke Workflow Handler
507
+ */
508
+ async invokeWorkflow(requestParameters: InvokeWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse> {
509
+ const response = await this.invokeWorkflowRaw(requestParameters, initOverrides);
510
+ return await response.value();
511
+ }
512
+
513
+ /**
514
+ * Creates request options for listWorkflowDefinitions without sending the request
515
+ */
516
+ async listWorkflowDefinitionsRequestOpts(requestParameters: ListWorkflowDefinitionsRequest): Promise<runtime.RequestOpts> {
517
+ const queryParameters: any = {};
518
+
519
+ if (requestParameters['limit'] != null) {
520
+ queryParameters['limit'] = requestParameters['limit'];
521
+ }
522
+
523
+ if (requestParameters['offset'] != null) {
524
+ queryParameters['offset'] = requestParameters['offset'];
525
+ }
526
+
527
+ const headerParameters: runtime.HTTPHeaders = {};
528
+
529
+ if (requestParameters['authorization'] != null) {
530
+ headerParameters['authorization'] = String(requestParameters['authorization']);
531
+ }
532
+
533
+
534
+ let urlPath = `/v1/workflow-definitions`;
535
+
536
+ return {
537
+ path: urlPath,
538
+ method: 'GET',
539
+ headers: headerParameters,
540
+ query: queryParameters,
541
+ };
542
+ }
543
+
544
+ /**
545
+ * List Workflow Definitions Handler
546
+ */
547
+ async listWorkflowDefinitionsRaw(requestParameters: ListWorkflowDefinitionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowDefinitionResponse>> {
548
+ const requestOptions = await this.listWorkflowDefinitionsRequestOpts(requestParameters);
549
+ const response = await this.request(requestOptions, initOverrides);
550
+
551
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseWorkflowDefinitionResponseFromJSON(jsonValue));
552
+ }
553
+
554
+ /**
555
+ * List Workflow Definitions Handler
556
+ */
557
+ async listWorkflowDefinitions(requestParameters: ListWorkflowDefinitionsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowDefinitionResponse> {
558
+ const response = await this.listWorkflowDefinitionsRaw(requestParameters, initOverrides);
559
+ return await response.value();
560
+ }
561
+
562
+ /**
563
+ * Creates request options for listWorkflowRuns without sending the request
564
+ */
565
+ async listWorkflowRunsRequestOpts(requestParameters: ListWorkflowRunsRequest): Promise<runtime.RequestOpts> {
566
+ if (requestParameters['definitionId'] == null) {
567
+ throw new runtime.RequiredError(
568
+ 'definitionId',
569
+ 'Required parameter "definitionId" was null or undefined when calling listWorkflowRuns().'
570
+ );
571
+ }
572
+
573
+ const queryParameters: any = {};
574
+
575
+ if (requestParameters['limit'] != null) {
576
+ queryParameters['limit'] = requestParameters['limit'];
577
+ }
578
+
579
+ if (requestParameters['offset'] != null) {
580
+ queryParameters['offset'] = requestParameters['offset'];
581
+ }
582
+
583
+ const headerParameters: runtime.HTTPHeaders = {};
584
+
585
+ if (requestParameters['authorization'] != null) {
586
+ headerParameters['authorization'] = String(requestParameters['authorization']);
587
+ }
588
+
589
+
590
+ let urlPath = `/v1/workflow-definitions/{definition_id}/runs`;
591
+ urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
592
+
593
+ return {
594
+ path: urlPath,
595
+ method: 'GET',
596
+ headers: headerParameters,
597
+ query: queryParameters,
598
+ };
599
+ }
600
+
601
+ /**
602
+ * List Workflow Runs Handler
603
+ */
604
+ async listWorkflowRunsRaw(requestParameters: ListWorkflowRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowRunResponse>> {
605
+ const requestOptions = await this.listWorkflowRunsRequestOpts(requestParameters);
606
+ const response = await this.request(requestOptions, initOverrides);
607
+
608
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseWorkflowRunResponseFromJSON(jsonValue));
609
+ }
610
+
611
+ /**
612
+ * List Workflow Runs Handler
613
+ */
614
+ async listWorkflowRuns(requestParameters: ListWorkflowRunsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowRunResponse> {
615
+ const response = await this.listWorkflowRunsRaw(requestParameters, initOverrides);
616
+ return await response.value();
617
+ }
618
+
619
+ /**
620
+ * Creates request options for updateWorkflowDefinition without sending the request
621
+ */
622
+ async updateWorkflowDefinitionRequestOpts(requestParameters: UpdateWorkflowDefinitionOperationRequest): Promise<runtime.RequestOpts> {
623
+ if (requestParameters['definitionId'] == null) {
624
+ throw new runtime.RequiredError(
625
+ 'definitionId',
626
+ 'Required parameter "definitionId" was null or undefined when calling updateWorkflowDefinition().'
627
+ );
628
+ }
629
+
630
+ if (requestParameters['updateWorkflowDefinitionRequest'] == null) {
631
+ throw new runtime.RequiredError(
632
+ 'updateWorkflowDefinitionRequest',
633
+ 'Required parameter "updateWorkflowDefinitionRequest" was null or undefined when calling updateWorkflowDefinition().'
634
+ );
635
+ }
636
+
637
+ const queryParameters: any = {};
638
+
639
+ const headerParameters: runtime.HTTPHeaders = {};
640
+
641
+ headerParameters['Content-Type'] = 'application/json';
642
+
643
+ if (requestParameters['authorization'] != null) {
644
+ headerParameters['authorization'] = String(requestParameters['authorization']);
645
+ }
646
+
647
+
648
+ let urlPath = `/v1/workflow-definitions/{definition_id}`;
649
+ urlPath = urlPath.replace(`{${"definition_id"}}`, encodeURIComponent(String(requestParameters['definitionId'])));
650
+
651
+ return {
652
+ path: urlPath,
653
+ method: 'PUT',
654
+ headers: headerParameters,
655
+ query: queryParameters,
656
+ body: UpdateWorkflowDefinitionRequestToJSON(requestParameters['updateWorkflowDefinitionRequest']),
657
+ };
658
+ }
659
+
660
+ /**
661
+ * Update Workflow Definition Handler
662
+ */
663
+ async updateWorkflowDefinitionRaw(requestParameters: UpdateWorkflowDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDefinitionResponse>> {
664
+ const requestOptions = await this.updateWorkflowDefinitionRequestOpts(requestParameters);
665
+ const response = await this.request(requestOptions, initOverrides);
666
+
667
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDefinitionResponseFromJSON(jsonValue));
668
+ }
669
+
670
+ /**
671
+ * Update Workflow Definition Handler
672
+ */
673
+ async updateWorkflowDefinition(requestParameters: UpdateWorkflowDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDefinitionResponse> {
674
+ const response = await this.updateWorkflowDefinitionRaw(requestParameters, initOverrides);
675
+ return await response.value();
676
+ }
677
+
678
+ }