@squonk/data-manager-client 3.3.2 → 4.0.0-rc.2
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/accounting/accounting.cjs.map +1 -1
- package/accounting/accounting.js.map +1 -1
- package/admin/admin.cjs +10 -10
- package/admin/admin.cjs.map +1 -1
- package/admin/admin.js +10 -10
- package/admin/admin.js.map +1 -1
- package/application/application.cjs.map +1 -1
- package/application/application.js.map +1 -1
- package/configuration/configuration.cjs +44 -1
- package/configuration/configuration.cjs.map +1 -1
- package/configuration/configuration.d.cts +59 -2
- package/configuration/configuration.d.ts +59 -2
- package/configuration/configuration.js +43 -0
- package/configuration/configuration.js.map +1 -1
- package/dataset/dataset.cjs +11 -11
- package/dataset/dataset.cjs.map +1 -1
- package/dataset/dataset.js +11 -11
- package/dataset/dataset.js.map +1 -1
- package/digest/digest.cjs.map +1 -1
- package/digest/digest.js.map +1 -1
- package/exchange-rate/exchange-rate.cjs +10 -10
- package/exchange-rate/exchange-rate.cjs.map +1 -1
- package/exchange-rate/exchange-rate.js +10 -10
- package/exchange-rate/exchange-rate.js.map +1 -1
- package/file-and-path/file-and-path.cjs +10 -10
- package/file-and-path/file-and-path.cjs.map +1 -1
- package/file-and-path/file-and-path.js +10 -10
- package/file-and-path/file-and-path.js.map +1 -1
- package/index.cjs +39 -1
- package/index.cjs.map +1 -1
- package/index.d.cts +355 -18
- package/index.d.ts +355 -18
- package/index.js +38 -0
- package/index.js.map +1 -1
- package/instance/instance.cjs +24 -24
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.js +24 -24
- package/instance/instance.js.map +1 -1
- package/inventory/inventory.cjs.map +1 -1
- package/inventory/inventory.js.map +1 -1
- package/job/job.cjs.map +1 -1
- package/job/job.js.map +1 -1
- package/metadata/metadata.cjs +10 -10
- package/metadata/metadata.cjs.map +1 -1
- package/metadata/metadata.js +10 -10
- package/metadata/metadata.js.map +1 -1
- package/package.json +1 -1
- package/project/project.cjs +11 -11
- package/project/project.cjs.map +1 -1
- package/project/project.js +11 -11
- package/project/project.js.map +1 -1
- package/src/accounting/accounting.ts +2 -2
- package/src/admin/admin.ts +12 -12
- package/src/application/application.ts +2 -2
- package/src/configuration/configuration.ts +144 -2
- package/src/data-manager-api.schemas.ts +399 -17
- package/src/dataset/dataset.ts +13 -13
- package/src/digest/digest.ts +2 -2
- package/src/exchange-rate/exchange-rate.ts +12 -12
- package/src/file-and-path/file-and-path.ts +12 -12
- package/src/instance/instance.ts +26 -26
- package/src/inventory/inventory.ts +2 -2
- package/src/job/job.ts +2 -2
- package/src/metadata/metadata.ts +12 -12
- package/src/project/project.ts +13 -13
- package/src/task/task.ts +2 -2
- package/src/type/type.ts +2 -2
- package/src/user/user.ts +14 -14
- package/src/workflow/workflow.ts +1399 -0
- package/task/task.cjs.map +1 -1
- package/task/task.js.map +1 -1
- package/type/type.cjs.map +1 -1
- package/type/type.js.map +1 -1
- package/user/user.cjs +11 -11
- package/user/user.cjs.map +1 -1
- package/user/user.d.cts +1 -1
- package/user/user.d.ts +1 -1
- package/user/user.js +11 -11
- package/user/user.js.map +1 -1
- package/workflow/package.json +7 -0
- package/workflow/workflow.cjs +489 -0
- package/workflow/workflow.cjs.map +1 -0
- package/workflow/workflow.d.cts +572 -0
- package/workflow/workflow.d.ts +572 -0
- package/workflow/workflow.js +489 -0
- package/workflow/workflow.js.map +1 -0
|
@@ -0,0 +1,1399 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
/**
|
|
3
|
+
* Generated by orval v7.4.1 🍺
|
|
4
|
+
* Do not edit manually.
|
|
5
|
+
* Dataset Manager API
|
|
6
|
+
* The Dataset Manager API service.
|
|
7
|
+
|
|
8
|
+
A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
|
|
9
|
+
|
|
10
|
+
* OpenAPI spec version: 4.0
|
|
11
|
+
*/
|
|
12
|
+
import {
|
|
13
|
+
useMutation,
|
|
14
|
+
useQuery,
|
|
15
|
+
useSuspenseQuery
|
|
16
|
+
} from '@tanstack/react-query'
|
|
17
|
+
import type {
|
|
18
|
+
DataTag,
|
|
19
|
+
DefinedInitialDataOptions,
|
|
20
|
+
DefinedUseQueryResult,
|
|
21
|
+
MutationFunction,
|
|
22
|
+
QueryFunction,
|
|
23
|
+
QueryKey,
|
|
24
|
+
UndefinedInitialDataOptions,
|
|
25
|
+
UseMutationOptions,
|
|
26
|
+
UseMutationResult,
|
|
27
|
+
UseQueryOptions,
|
|
28
|
+
UseQueryResult,
|
|
29
|
+
UseSuspenseQueryOptions,
|
|
30
|
+
UseSuspenseQueryResult
|
|
31
|
+
} from '@tanstack/react-query'
|
|
32
|
+
import type {
|
|
33
|
+
DmError,
|
|
34
|
+
RunningWorkflowGetAllResponse,
|
|
35
|
+
RunningWorkflowGetResponse,
|
|
36
|
+
RunningWorkflowStepsGetResponse,
|
|
37
|
+
WorkflowDefinitionGetResponse,
|
|
38
|
+
WorkflowGetAllResponse,
|
|
39
|
+
WorkflowGetResponse,
|
|
40
|
+
WorkflowPatchBodyBody,
|
|
41
|
+
WorkflowPatchResponse,
|
|
42
|
+
WorkflowPostBodyBody,
|
|
43
|
+
WorkflowPostResponse,
|
|
44
|
+
WorkflowRunPostBodyBody,
|
|
45
|
+
WorkflowRunPostResponse,
|
|
46
|
+
WorkflowVersionPutBodyBody,
|
|
47
|
+
WorkflowVersionPutResponse
|
|
48
|
+
} from '../data-manager-api.schemas'
|
|
49
|
+
import { customInstance } from '.././custom-instance';
|
|
50
|
+
import type { ErrorType } from '.././custom-instance';
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Get a list of all Workflows available to you. The Workflows are listed in reverse chronological order of creation, where the most recent that was created is first in the list.
|
|
58
|
+
|
|
59
|
+
* @summary Get all Workflows available to you
|
|
60
|
+
*/
|
|
61
|
+
export const getWorkflows = (
|
|
62
|
+
|
|
63
|
+
options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
|
|
64
|
+
) => {
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
return customInstance<WorkflowGetAllResponse>(
|
|
68
|
+
{url: `/workflow`, method: 'GET', signal
|
|
69
|
+
},
|
|
70
|
+
options);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
export const getGetWorkflowsQueryKey = () => {
|
|
75
|
+
return ["data-manager-api", `/workflow`] as const;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
export const getGetWorkflowsQueryOptions = <TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
80
|
+
) => {
|
|
81
|
+
|
|
82
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
83
|
+
|
|
84
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowsQueryKey();
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflows>>> = ({ signal }) => getWorkflows(requestOptions, signal);
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
return { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export type GetWorkflowsQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflows>>>
|
|
98
|
+
export type GetWorkflowsQueryError = ErrorType<void>
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
export function useGetWorkflows<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(
|
|
102
|
+
options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>> & Pick<
|
|
103
|
+
DefinedInitialDataOptions<
|
|
104
|
+
Awaited<ReturnType<typeof getWorkflows>>,
|
|
105
|
+
TError,
|
|
106
|
+
TData
|
|
107
|
+
> , 'initialData'
|
|
108
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
109
|
+
|
|
110
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
111
|
+
export function useGetWorkflows<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(
|
|
112
|
+
options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>> & Pick<
|
|
113
|
+
UndefinedInitialDataOptions<
|
|
114
|
+
Awaited<ReturnType<typeof getWorkflows>>,
|
|
115
|
+
TError,
|
|
116
|
+
TData
|
|
117
|
+
> , 'initialData'
|
|
118
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
119
|
+
|
|
120
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
121
|
+
export function useGetWorkflows<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(
|
|
122
|
+
options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
123
|
+
|
|
124
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
125
|
+
/**
|
|
126
|
+
* @summary Get all Workflows available to you
|
|
127
|
+
*/
|
|
128
|
+
|
|
129
|
+
export function useGetWorkflows<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(
|
|
130
|
+
options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
131
|
+
|
|
132
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
133
|
+
|
|
134
|
+
const queryOptions = getGetWorkflowsQueryOptions(options)
|
|
135
|
+
|
|
136
|
+
const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
137
|
+
|
|
138
|
+
query.queryKey = queryOptions.queryKey ;
|
|
139
|
+
|
|
140
|
+
return query;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
export const getGetWorkflowsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
146
|
+
) => {
|
|
147
|
+
|
|
148
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
149
|
+
|
|
150
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowsQueryKey();
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflows>>> = ({ signal }) => getWorkflows(requestOptions, signal);
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
export type GetWorkflowsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflows>>>
|
|
164
|
+
export type GetWorkflowsSuspenseQueryError = ErrorType<void>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
export function useGetWorkflowsSuspense<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(
|
|
168
|
+
options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
169
|
+
|
|
170
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
171
|
+
export function useGetWorkflowsSuspense<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(
|
|
172
|
+
options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
173
|
+
|
|
174
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
175
|
+
export function useGetWorkflowsSuspense<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(
|
|
176
|
+
options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
177
|
+
|
|
178
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
179
|
+
/**
|
|
180
|
+
* @summary Get all Workflows available to you
|
|
181
|
+
*/
|
|
182
|
+
|
|
183
|
+
export function useGetWorkflowsSuspense<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(
|
|
184
|
+
options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
185
|
+
|
|
186
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
187
|
+
|
|
188
|
+
const queryOptions = getGetWorkflowsSuspenseQueryOptions(options)
|
|
189
|
+
|
|
190
|
+
const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
191
|
+
|
|
192
|
+
query.queryKey = queryOptions.queryKey ;
|
|
193
|
+
|
|
194
|
+
return query;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* Creates a new workflow record.
|
|
201
|
+
|
|
202
|
+
* @summary Create a new Workflow
|
|
203
|
+
*/
|
|
204
|
+
export const createWorkflow = (
|
|
205
|
+
workflowPostBodyBody: WorkflowPostBodyBody,
|
|
206
|
+
options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
|
|
207
|
+
) => {
|
|
208
|
+
|
|
209
|
+
const formData = new FormData();
|
|
210
|
+
formData.append('name', workflowPostBodyBody.name)
|
|
211
|
+
if(workflowPostBodyBody.definition !== undefined) {
|
|
212
|
+
formData.append('definition', workflowPostBodyBody.definition)
|
|
213
|
+
}
|
|
214
|
+
if(workflowPostBodyBody.definition_file !== undefined) {
|
|
215
|
+
formData.append('definition_file', workflowPostBodyBody.definition_file)
|
|
216
|
+
}
|
|
217
|
+
formData.append('scope', workflowPostBodyBody.scope)
|
|
218
|
+
if(workflowPostBodyBody.scope_id !== undefined) {
|
|
219
|
+
formData.append('scope_id', workflowPostBodyBody.scope_id)
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
return customInstance<WorkflowPostResponse>(
|
|
223
|
+
{url: `/workflow`, method: 'POST',
|
|
224
|
+
headers: {'Content-Type': 'multipart/form-data', },
|
|
225
|
+
data: formData, signal
|
|
226
|
+
},
|
|
227
|
+
options);
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
export const getCreateWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof createWorkflow>>, TError = ErrorType<void>,
|
|
233
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: WorkflowPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
234
|
+
) => {
|
|
235
|
+
const mutationKey = ['createWorkflow'];
|
|
236
|
+
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
237
|
+
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
238
|
+
options
|
|
239
|
+
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
240
|
+
: {mutation: { mutationKey, }, request: undefined};
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
const mutationFn: MutationFunction<Awaited<ReturnType<typeof createWorkflow>>, {data: WorkflowPostBodyBody}> = (props) => {
|
|
246
|
+
const {data} = props ?? {};
|
|
247
|
+
|
|
248
|
+
return createWorkflow(data,requestOptions)
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{data: WorkflowPostBodyBody}, TContext>}
|
|
255
|
+
|
|
256
|
+
export type CreateWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof createWorkflow>>>
|
|
257
|
+
export type CreateWorkflowMutationBody = WorkflowPostBodyBody
|
|
258
|
+
export type CreateWorkflowMutationError = ErrorType<void>
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* @summary Create a new Workflow
|
|
262
|
+
*/
|
|
263
|
+
export const useCreateWorkflow = <TData = Awaited<ReturnType<typeof createWorkflow>>, TError = ErrorType<void>,
|
|
264
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: WorkflowPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
265
|
+
): UseMutationResult<
|
|
266
|
+
TData,
|
|
267
|
+
TError,
|
|
268
|
+
{data: WorkflowPostBodyBody},
|
|
269
|
+
TContext
|
|
270
|
+
> => {
|
|
271
|
+
|
|
272
|
+
const mutationOptions = getCreateWorkflowMutationOptions(options);
|
|
273
|
+
|
|
274
|
+
return useMutation(mutationOptions);
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* Get details of a specific Workflow available to you.
|
|
278
|
+
|
|
279
|
+
* @summary Get details of a specific Workflow
|
|
280
|
+
*/
|
|
281
|
+
export const getWorkflow = (
|
|
282
|
+
workflowId: string,
|
|
283
|
+
options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
|
|
284
|
+
) => {
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
return customInstance<WorkflowGetResponse>(
|
|
288
|
+
{url: `/workflow/${workflowId}`, method: 'GET', signal
|
|
289
|
+
},
|
|
290
|
+
options);
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
export const getGetWorkflowQueryKey = (workflowId: string,) => {
|
|
295
|
+
return ["data-manager-api", `/workflow/${workflowId}`] as const;
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
export const getGetWorkflowQueryOptions = <TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
300
|
+
) => {
|
|
301
|
+
|
|
302
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
303
|
+
|
|
304
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowQueryKey(workflowId);
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflow>>> = ({ signal }) => getWorkflow(workflowId, requestOptions, signal);
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
return { queryKey, queryFn, enabled: !!(workflowId), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
export type GetWorkflowQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflow>>>
|
|
318
|
+
export type GetWorkflowQueryError = ErrorType<void | DmError>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
export function useGetWorkflow<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
322
|
+
workflowId: string, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>> & Pick<
|
|
323
|
+
DefinedInitialDataOptions<
|
|
324
|
+
Awaited<ReturnType<typeof getWorkflow>>,
|
|
325
|
+
TError,
|
|
326
|
+
TData
|
|
327
|
+
> , 'initialData'
|
|
328
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
329
|
+
|
|
330
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
331
|
+
export function useGetWorkflow<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
332
|
+
workflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>> & Pick<
|
|
333
|
+
UndefinedInitialDataOptions<
|
|
334
|
+
Awaited<ReturnType<typeof getWorkflow>>,
|
|
335
|
+
TError,
|
|
336
|
+
TData
|
|
337
|
+
> , 'initialData'
|
|
338
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
339
|
+
|
|
340
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
341
|
+
export function useGetWorkflow<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
342
|
+
workflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
343
|
+
|
|
344
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
345
|
+
/**
|
|
346
|
+
* @summary Get details of a specific Workflow
|
|
347
|
+
*/
|
|
348
|
+
|
|
349
|
+
export function useGetWorkflow<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
350
|
+
workflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
351
|
+
|
|
352
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
353
|
+
|
|
354
|
+
const queryOptions = getGetWorkflowQueryOptions(workflowId,options)
|
|
355
|
+
|
|
356
|
+
const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
357
|
+
|
|
358
|
+
query.queryKey = queryOptions.queryKey ;
|
|
359
|
+
|
|
360
|
+
return query;
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
export const getGetWorkflowSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
366
|
+
) => {
|
|
367
|
+
|
|
368
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
369
|
+
|
|
370
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowQueryKey(workflowId);
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflow>>> = ({ signal }) => getWorkflow(workflowId, requestOptions, signal);
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
381
|
+
}
|
|
382
|
+
|
|
383
|
+
export type GetWorkflowSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflow>>>
|
|
384
|
+
export type GetWorkflowSuspenseQueryError = ErrorType<void | DmError>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
export function useGetWorkflowSuspense<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
388
|
+
workflowId: string, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
389
|
+
|
|
390
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
391
|
+
export function useGetWorkflowSuspense<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
392
|
+
workflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
393
|
+
|
|
394
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
395
|
+
export function useGetWorkflowSuspense<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
396
|
+
workflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
397
|
+
|
|
398
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
399
|
+
/**
|
|
400
|
+
* @summary Get details of a specific Workflow
|
|
401
|
+
*/
|
|
402
|
+
|
|
403
|
+
export function useGetWorkflowSuspense<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
404
|
+
workflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
405
|
+
|
|
406
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
407
|
+
|
|
408
|
+
const queryOptions = getGetWorkflowSuspenseQueryOptions(workflowId,options)
|
|
409
|
+
|
|
410
|
+
const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
411
|
+
|
|
412
|
+
query.queryKey = queryOptions.queryKey ;
|
|
413
|
+
|
|
414
|
+
return query;
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* The Workflow is deleted.
|
|
421
|
+
|
|
422
|
+
You cannot delete a Workflow if it is the _source_ of a versioned workflow.
|
|
423
|
+
|
|
424
|
+
* @summary Delete a Workflow
|
|
425
|
+
*/
|
|
426
|
+
export const deleteWorkflow = (
|
|
427
|
+
workflowId: string,
|
|
428
|
+
options?: SecondParameter<typeof customInstance>,) => {
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
return customInstance<void>(
|
|
432
|
+
{url: `/workflow/${workflowId}`, method: 'DELETE'
|
|
433
|
+
},
|
|
434
|
+
options);
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
export const getDeleteWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof deleteWorkflow>>, TError = ErrorType<void | DmError>,
|
|
440
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
441
|
+
) => {
|
|
442
|
+
const mutationKey = ['deleteWorkflow'];
|
|
443
|
+
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
444
|
+
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
445
|
+
options
|
|
446
|
+
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
447
|
+
: {mutation: { mutationKey, }, request: undefined};
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
const mutationFn: MutationFunction<Awaited<ReturnType<typeof deleteWorkflow>>, {workflowId: string}> = (props) => {
|
|
453
|
+
const {workflowId} = props ?? {};
|
|
454
|
+
|
|
455
|
+
return deleteWorkflow(workflowId,requestOptions)
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{workflowId: string}, TContext>}
|
|
462
|
+
|
|
463
|
+
export type DeleteWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof deleteWorkflow>>>
|
|
464
|
+
|
|
465
|
+
export type DeleteWorkflowMutationError = ErrorType<void | DmError>
|
|
466
|
+
|
|
467
|
+
/**
|
|
468
|
+
* @summary Delete a Workflow
|
|
469
|
+
*/
|
|
470
|
+
export const useDeleteWorkflow = <TData = Awaited<ReturnType<typeof deleteWorkflow>>, TError = ErrorType<void | DmError>,
|
|
471
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
472
|
+
): UseMutationResult<
|
|
473
|
+
TData,
|
|
474
|
+
TError,
|
|
475
|
+
{workflowId: string},
|
|
476
|
+
TContext
|
|
477
|
+
> => {
|
|
478
|
+
|
|
479
|
+
const mutationOptions = getDeleteWorkflowMutationOptions(options);
|
|
480
|
+
|
|
481
|
+
return useMutation(mutationOptions);
|
|
482
|
+
}
|
|
483
|
+
/**
|
|
484
|
+
* The Workflow is updated according to the patch parameters.
|
|
485
|
+
|
|
486
|
+
In **PRODUCTION** mode you cannot alter a Workflow that has been versioned. In **DEVELOPMENT** mode you cannot alter a Workflow that is the source of Running Workflow that is running.
|
|
487
|
+
|
|
488
|
+
* @summary Update a Workflow
|
|
489
|
+
*/
|
|
490
|
+
export const updateWorkflow = (
|
|
491
|
+
workflowId: string,
|
|
492
|
+
workflowPatchBodyBody: WorkflowPatchBodyBody,
|
|
493
|
+
options?: SecondParameter<typeof customInstance>,) => {
|
|
494
|
+
|
|
495
|
+
const formData = new FormData();
|
|
496
|
+
if(workflowPatchBodyBody.name !== undefined) {
|
|
497
|
+
formData.append('name', workflowPatchBodyBody.name)
|
|
498
|
+
}
|
|
499
|
+
if(workflowPatchBodyBody.definition !== undefined) {
|
|
500
|
+
formData.append('definition', workflowPatchBodyBody.definition)
|
|
501
|
+
}
|
|
502
|
+
if(workflowPatchBodyBody.definition_file !== undefined) {
|
|
503
|
+
formData.append('definition_file', workflowPatchBodyBody.definition_file)
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
return customInstance<WorkflowPatchResponse>(
|
|
507
|
+
{url: `/workflow/${workflowId}`, method: 'PATCH',
|
|
508
|
+
headers: {'Content-Type': 'multipart/form-data', },
|
|
509
|
+
data: formData
|
|
510
|
+
},
|
|
511
|
+
options);
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
export const getUpdateWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof updateWorkflow>>, TError = ErrorType<void | DmError>,
|
|
517
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowPatchBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
518
|
+
) => {
|
|
519
|
+
const mutationKey = ['updateWorkflow'];
|
|
520
|
+
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
521
|
+
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
522
|
+
options
|
|
523
|
+
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
524
|
+
: {mutation: { mutationKey, }, request: undefined};
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
const mutationFn: MutationFunction<Awaited<ReturnType<typeof updateWorkflow>>, {workflowId: string;data: WorkflowPatchBodyBody}> = (props) => {
|
|
530
|
+
const {workflowId,data} = props ?? {};
|
|
531
|
+
|
|
532
|
+
return updateWorkflow(workflowId,data,requestOptions)
|
|
533
|
+
}
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowPatchBodyBody}, TContext>}
|
|
539
|
+
|
|
540
|
+
export type UpdateWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof updateWorkflow>>>
|
|
541
|
+
export type UpdateWorkflowMutationBody = WorkflowPatchBodyBody
|
|
542
|
+
export type UpdateWorkflowMutationError = ErrorType<void | DmError>
|
|
543
|
+
|
|
544
|
+
/**
|
|
545
|
+
* @summary Update a Workflow
|
|
546
|
+
*/
|
|
547
|
+
export const useUpdateWorkflow = <TData = Awaited<ReturnType<typeof updateWorkflow>>, TError = ErrorType<void | DmError>,
|
|
548
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowPatchBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
549
|
+
): UseMutationResult<
|
|
550
|
+
TData,
|
|
551
|
+
TError,
|
|
552
|
+
{workflowId: string;data: WorkflowPatchBodyBody},
|
|
553
|
+
TContext
|
|
554
|
+
> => {
|
|
555
|
+
|
|
556
|
+
const mutationOptions = getUpdateWorkflowMutationOptions(options);
|
|
557
|
+
|
|
558
|
+
return useMutation(mutationOptions);
|
|
559
|
+
}
|
|
560
|
+
/**
|
|
561
|
+
* Due to its potential size and complexity the definition is not returned with the Workflow. Instead, to retrieve the definition you need to call this endpoint. A string-encoded YAML document is returned.
|
|
562
|
+
|
|
563
|
+
* @summary Gets the full definition of a Workflow
|
|
564
|
+
*/
|
|
565
|
+
export const getWorkflowDefinition = (
|
|
566
|
+
workflowId: string,
|
|
567
|
+
options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
|
|
568
|
+
) => {
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
return customInstance<WorkflowDefinitionGetResponse>(
|
|
572
|
+
{url: `/workflow/${workflowId}/definition`, method: 'GET', signal
|
|
573
|
+
},
|
|
574
|
+
options);
|
|
575
|
+
}
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
export const getGetWorkflowDefinitionQueryKey = (workflowId: string,) => {
|
|
579
|
+
return ["data-manager-api", `/workflow/${workflowId}/definition`] as const;
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
export const getGetWorkflowDefinitionQueryOptions = <TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
584
|
+
) => {
|
|
585
|
+
|
|
586
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
587
|
+
|
|
588
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowDefinitionQueryKey(workflowId);
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflowDefinition>>> = ({ signal }) => getWorkflowDefinition(workflowId, requestOptions, signal);
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
return { queryKey, queryFn, enabled: !!(workflowId), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
599
|
+
}
|
|
600
|
+
|
|
601
|
+
export type GetWorkflowDefinitionQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflowDefinition>>>
|
|
602
|
+
export type GetWorkflowDefinitionQueryError = ErrorType<void | DmError>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
export function useGetWorkflowDefinition<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(
|
|
606
|
+
workflowId: string, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>> & Pick<
|
|
607
|
+
DefinedInitialDataOptions<
|
|
608
|
+
Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
609
|
+
TError,
|
|
610
|
+
TData
|
|
611
|
+
> , 'initialData'
|
|
612
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
613
|
+
|
|
614
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
615
|
+
export function useGetWorkflowDefinition<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(
|
|
616
|
+
workflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>> & Pick<
|
|
617
|
+
UndefinedInitialDataOptions<
|
|
618
|
+
Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
619
|
+
TError,
|
|
620
|
+
TData
|
|
621
|
+
> , 'initialData'
|
|
622
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
623
|
+
|
|
624
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
625
|
+
export function useGetWorkflowDefinition<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(
|
|
626
|
+
workflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
627
|
+
|
|
628
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
629
|
+
/**
|
|
630
|
+
* @summary Gets the full definition of a Workflow
|
|
631
|
+
*/
|
|
632
|
+
|
|
633
|
+
export function useGetWorkflowDefinition<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(
|
|
634
|
+
workflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
635
|
+
|
|
636
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
637
|
+
|
|
638
|
+
const queryOptions = getGetWorkflowDefinitionQueryOptions(workflowId,options)
|
|
639
|
+
|
|
640
|
+
const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
641
|
+
|
|
642
|
+
query.queryKey = queryOptions.queryKey ;
|
|
643
|
+
|
|
644
|
+
return query;
|
|
645
|
+
}
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
export const getGetWorkflowDefinitionSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
650
|
+
) => {
|
|
651
|
+
|
|
652
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
653
|
+
|
|
654
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowDefinitionQueryKey(workflowId);
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflowDefinition>>> = ({ signal }) => getWorkflowDefinition(workflowId, requestOptions, signal);
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
export type GetWorkflowDefinitionSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflowDefinition>>>
|
|
668
|
+
export type GetWorkflowDefinitionSuspenseQueryError = ErrorType<void | DmError>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
export function useGetWorkflowDefinitionSuspense<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(
|
|
672
|
+
workflowId: string, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
673
|
+
|
|
674
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
675
|
+
export function useGetWorkflowDefinitionSuspense<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(
|
|
676
|
+
workflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
677
|
+
|
|
678
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
679
|
+
export function useGetWorkflowDefinitionSuspense<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(
|
|
680
|
+
workflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
681
|
+
|
|
682
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
683
|
+
/**
|
|
684
|
+
* @summary Gets the full definition of a Workflow
|
|
685
|
+
*/
|
|
686
|
+
|
|
687
|
+
export function useGetWorkflowDefinitionSuspense<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(
|
|
688
|
+
workflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
689
|
+
|
|
690
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
691
|
+
|
|
692
|
+
const queryOptions = getGetWorkflowDefinitionSuspenseQueryOptions(workflowId,options)
|
|
693
|
+
|
|
694
|
+
const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
695
|
+
|
|
696
|
+
query.queryKey = queryOptions.queryKey ;
|
|
697
|
+
|
|
698
|
+
return query;
|
|
699
|
+
}
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
/**
|
|
704
|
+
* Runs a Workflow.
|
|
705
|
+
|
|
706
|
+
* @summary Run a Workflow
|
|
707
|
+
*/
|
|
708
|
+
export const runWorkflow = (
|
|
709
|
+
workflowId: string,
|
|
710
|
+
workflowRunPostBodyBody: WorkflowRunPostBodyBody,
|
|
711
|
+
options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
|
|
712
|
+
) => {
|
|
713
|
+
|
|
714
|
+
const formUrlEncoded = new URLSearchParams();
|
|
715
|
+
formUrlEncoded.append('project_id', workflowRunPostBodyBody.project_id)
|
|
716
|
+
formUrlEncoded.append('as_name', workflowRunPostBodyBody.as_name)
|
|
717
|
+
if(workflowRunPostBodyBody.variables !== undefined) {
|
|
718
|
+
formUrlEncoded.append('variables', workflowRunPostBodyBody.variables)
|
|
719
|
+
}
|
|
720
|
+
if(workflowRunPostBodyBody.debug !== undefined) {
|
|
721
|
+
formUrlEncoded.append('debug', workflowRunPostBodyBody.debug)
|
|
722
|
+
}
|
|
723
|
+
|
|
724
|
+
return customInstance<WorkflowRunPostResponse>(
|
|
725
|
+
{url: `/workflow/${workflowId}/run`, method: 'POST',
|
|
726
|
+
headers: {'Content-Type': 'application/x-www-form-urlencoded', },
|
|
727
|
+
data: formUrlEncoded, signal
|
|
728
|
+
},
|
|
729
|
+
options);
|
|
730
|
+
}
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
export const getRunWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof runWorkflow>>, TError = ErrorType<void | DmError>,
|
|
735
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowRunPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
736
|
+
) => {
|
|
737
|
+
const mutationKey = ['runWorkflow'];
|
|
738
|
+
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
739
|
+
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
740
|
+
options
|
|
741
|
+
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
742
|
+
: {mutation: { mutationKey, }, request: undefined};
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
const mutationFn: MutationFunction<Awaited<ReturnType<typeof runWorkflow>>, {workflowId: string;data: WorkflowRunPostBodyBody}> = (props) => {
|
|
748
|
+
const {workflowId,data} = props ?? {};
|
|
749
|
+
|
|
750
|
+
return runWorkflow(workflowId,data,requestOptions)
|
|
751
|
+
}
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowRunPostBodyBody}, TContext>}
|
|
757
|
+
|
|
758
|
+
export type RunWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof runWorkflow>>>
|
|
759
|
+
export type RunWorkflowMutationBody = WorkflowRunPostBodyBody
|
|
760
|
+
export type RunWorkflowMutationError = ErrorType<void | DmError>
|
|
761
|
+
|
|
762
|
+
/**
|
|
763
|
+
* @summary Run a Workflow
|
|
764
|
+
*/
|
|
765
|
+
export const useRunWorkflow = <TData = Awaited<ReturnType<typeof runWorkflow>>, TError = ErrorType<void | DmError>,
|
|
766
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowRunPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
767
|
+
): UseMutationResult<
|
|
768
|
+
TData,
|
|
769
|
+
TError,
|
|
770
|
+
{workflowId: string;data: WorkflowRunPostBodyBody},
|
|
771
|
+
TContext
|
|
772
|
+
> => {
|
|
773
|
+
|
|
774
|
+
const mutationOptions = getRunWorkflowMutationOptions(options);
|
|
775
|
+
|
|
776
|
+
return useMutation(mutationOptions);
|
|
777
|
+
}
|
|
778
|
+
/**
|
|
779
|
+
* The Workflow is first copied, leaving the original. The version (a string) is then applied to the copy of the Workflow, the `source_id` of the copy is set to the Workflow being copied, and the new Workflow ID is returned.
|
|
780
|
+
|
|
781
|
+
When you apply a version to a Workflow you are making a commitment not to alter it. If you want to change the workflow you will need to return to the `source`, Workflow, modify that and then version it again.
|
|
782
|
+
|
|
783
|
+
* @summary Applied a version to the Workflow
|
|
784
|
+
*/
|
|
785
|
+
export const versionWorkflow = (
|
|
786
|
+
workflowId: string,
|
|
787
|
+
workflowVersionPutBodyBody: WorkflowVersionPutBodyBody,
|
|
788
|
+
options?: SecondParameter<typeof customInstance>,) => {
|
|
789
|
+
|
|
790
|
+
const formUrlEncoded = new URLSearchParams();
|
|
791
|
+
formUrlEncoded.append('version', workflowVersionPutBodyBody.version)
|
|
792
|
+
|
|
793
|
+
return customInstance<WorkflowVersionPutResponse>(
|
|
794
|
+
{url: `/workflow/${workflowId}/version`, method: 'PUT',
|
|
795
|
+
headers: {'Content-Type': 'application/x-www-form-urlencoded', },
|
|
796
|
+
data: formUrlEncoded
|
|
797
|
+
},
|
|
798
|
+
options);
|
|
799
|
+
}
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
export const getVersionWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof versionWorkflow>>, TError = ErrorType<void | DmError>,
|
|
804
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowVersionPutBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
805
|
+
) => {
|
|
806
|
+
const mutationKey = ['versionWorkflow'];
|
|
807
|
+
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
808
|
+
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
809
|
+
options
|
|
810
|
+
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
811
|
+
: {mutation: { mutationKey, }, request: undefined};
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
const mutationFn: MutationFunction<Awaited<ReturnType<typeof versionWorkflow>>, {workflowId: string;data: WorkflowVersionPutBodyBody}> = (props) => {
|
|
817
|
+
const {workflowId,data} = props ?? {};
|
|
818
|
+
|
|
819
|
+
return versionWorkflow(workflowId,data,requestOptions)
|
|
820
|
+
}
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowVersionPutBodyBody}, TContext>}
|
|
826
|
+
|
|
827
|
+
export type VersionWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof versionWorkflow>>>
|
|
828
|
+
export type VersionWorkflowMutationBody = WorkflowVersionPutBodyBody
|
|
829
|
+
export type VersionWorkflowMutationError = ErrorType<void | DmError>
|
|
830
|
+
|
|
831
|
+
/**
|
|
832
|
+
* @summary Applied a version to the Workflow
|
|
833
|
+
*/
|
|
834
|
+
export const useVersionWorkflow = <TData = Awaited<ReturnType<typeof versionWorkflow>>, TError = ErrorType<void | DmError>,
|
|
835
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowVersionPutBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
836
|
+
): UseMutationResult<
|
|
837
|
+
TData,
|
|
838
|
+
TError,
|
|
839
|
+
{workflowId: string;data: WorkflowVersionPutBodyBody},
|
|
840
|
+
TContext
|
|
841
|
+
> => {
|
|
842
|
+
|
|
843
|
+
const mutationOptions = getVersionWorkflowMutationOptions(options);
|
|
844
|
+
|
|
845
|
+
return useMutation(mutationOptions);
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* Get a list of all Running Workflows available to you. The Running Workflows are listed in chronological order of the start time, where the first that was executed is the first in the list.
|
|
849
|
+
|
|
850
|
+
* @summary Get all Running Workflows available to you
|
|
851
|
+
*/
|
|
852
|
+
export const getRunningWorkflows = (
|
|
853
|
+
|
|
854
|
+
options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
|
|
855
|
+
) => {
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
return customInstance<RunningWorkflowGetAllResponse>(
|
|
859
|
+
{url: `/running-workflow`, method: 'GET', signal
|
|
860
|
+
},
|
|
861
|
+
options);
|
|
862
|
+
}
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
export const getGetRunningWorkflowsQueryKey = () => {
|
|
866
|
+
return ["data-manager-api", `/running-workflow`] as const;
|
|
867
|
+
}
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
export const getGetRunningWorkflowsQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
871
|
+
) => {
|
|
872
|
+
|
|
873
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
874
|
+
|
|
875
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowsQueryKey();
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflows>>> = ({ signal }) => getRunningWorkflows(requestOptions, signal);
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
return { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
886
|
+
}
|
|
887
|
+
|
|
888
|
+
export type GetRunningWorkflowsQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflows>>>
|
|
889
|
+
export type GetRunningWorkflowsQueryError = ErrorType<void>
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
|
|
893
|
+
options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>> & Pick<
|
|
894
|
+
DefinedInitialDataOptions<
|
|
895
|
+
Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
896
|
+
TError,
|
|
897
|
+
TData
|
|
898
|
+
> , 'initialData'
|
|
899
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
900
|
+
|
|
901
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
902
|
+
export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
|
|
903
|
+
options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>> & Pick<
|
|
904
|
+
UndefinedInitialDataOptions<
|
|
905
|
+
Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
906
|
+
TError,
|
|
907
|
+
TData
|
|
908
|
+
> , 'initialData'
|
|
909
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
910
|
+
|
|
911
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
912
|
+
export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
|
|
913
|
+
options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
914
|
+
|
|
915
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
916
|
+
/**
|
|
917
|
+
* @summary Get all Running Workflows available to you
|
|
918
|
+
*/
|
|
919
|
+
|
|
920
|
+
export function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
|
|
921
|
+
options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
922
|
+
|
|
923
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
924
|
+
|
|
925
|
+
const queryOptions = getGetRunningWorkflowsQueryOptions(options)
|
|
926
|
+
|
|
927
|
+
const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
928
|
+
|
|
929
|
+
query.queryKey = queryOptions.queryKey ;
|
|
930
|
+
|
|
931
|
+
return query;
|
|
932
|
+
}
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
export const getGetRunningWorkflowsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
937
|
+
) => {
|
|
938
|
+
|
|
939
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
940
|
+
|
|
941
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowsQueryKey();
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflows>>> = ({ signal }) => getRunningWorkflows(requestOptions, signal);
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
952
|
+
}
|
|
953
|
+
|
|
954
|
+
export type GetRunningWorkflowsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflows>>>
|
|
955
|
+
export type GetRunningWorkflowsSuspenseQueryError = ErrorType<void>
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
export function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
|
|
959
|
+
options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
960
|
+
|
|
961
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
962
|
+
export function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
|
|
963
|
+
options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
964
|
+
|
|
965
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
966
|
+
export function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
|
|
967
|
+
options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
968
|
+
|
|
969
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
970
|
+
/**
|
|
971
|
+
* @summary Get all Running Workflows available to you
|
|
972
|
+
*/
|
|
973
|
+
|
|
974
|
+
export function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(
|
|
975
|
+
options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
976
|
+
|
|
977
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
978
|
+
|
|
979
|
+
const queryOptions = getGetRunningWorkflowsSuspenseQueryOptions(options)
|
|
980
|
+
|
|
981
|
+
const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
982
|
+
|
|
983
|
+
query.queryKey = queryOptions.queryKey ;
|
|
984
|
+
|
|
985
|
+
return query;
|
|
986
|
+
}
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
/**
|
|
991
|
+
* Get details of a specific Running Workflow available to you.
|
|
992
|
+
|
|
993
|
+
* @summary Get details of a specific Running Workflow
|
|
994
|
+
*/
|
|
995
|
+
export const getRunningWorkflow = (
|
|
996
|
+
runningWorkflowId: string,
|
|
997
|
+
options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
|
|
998
|
+
) => {
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
return customInstance<RunningWorkflowGetResponse>(
|
|
1002
|
+
{url: `/running-workflow/${runningWorkflowId}`, method: 'GET', signal
|
|
1003
|
+
},
|
|
1004
|
+
options);
|
|
1005
|
+
}
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
export const getGetRunningWorkflowQueryKey = (runningWorkflowId: string,) => {
|
|
1009
|
+
return ["data-manager-api", `/running-workflow/${runningWorkflowId}`] as const;
|
|
1010
|
+
}
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
export const getGetRunningWorkflowQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1014
|
+
) => {
|
|
1015
|
+
|
|
1016
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
1017
|
+
|
|
1018
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowQueryKey(runningWorkflowId);
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflow>>> = ({ signal }) => getRunningWorkflow(runningWorkflowId, requestOptions, signal);
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
return { queryKey, queryFn, enabled: !!(runningWorkflowId), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1029
|
+
}
|
|
1030
|
+
|
|
1031
|
+
export type GetRunningWorkflowQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflow>>>
|
|
1032
|
+
export type GetRunningWorkflowQueryError = ErrorType<void | DmError>
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
export function useGetRunningWorkflow<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
1036
|
+
runningWorkflowId: string, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>> & Pick<
|
|
1037
|
+
DefinedInitialDataOptions<
|
|
1038
|
+
Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1039
|
+
TError,
|
|
1040
|
+
TData
|
|
1041
|
+
> , 'initialData'
|
|
1042
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
1043
|
+
|
|
1044
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1045
|
+
export function useGetRunningWorkflow<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
1046
|
+
runningWorkflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>> & Pick<
|
|
1047
|
+
UndefinedInitialDataOptions<
|
|
1048
|
+
Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1049
|
+
TError,
|
|
1050
|
+
TData
|
|
1051
|
+
> , 'initialData'
|
|
1052
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
1053
|
+
|
|
1054
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1055
|
+
export function useGetRunningWorkflow<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
1056
|
+
runningWorkflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1057
|
+
|
|
1058
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1059
|
+
/**
|
|
1060
|
+
* @summary Get details of a specific Running Workflow
|
|
1061
|
+
*/
|
|
1062
|
+
|
|
1063
|
+
export function useGetRunningWorkflow<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
1064
|
+
runningWorkflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1065
|
+
|
|
1066
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1067
|
+
|
|
1068
|
+
const queryOptions = getGetRunningWorkflowQueryOptions(runningWorkflowId,options)
|
|
1069
|
+
|
|
1070
|
+
const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1071
|
+
|
|
1072
|
+
query.queryKey = queryOptions.queryKey ;
|
|
1073
|
+
|
|
1074
|
+
return query;
|
|
1075
|
+
}
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
export const getGetRunningWorkflowSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1080
|
+
) => {
|
|
1081
|
+
|
|
1082
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
1083
|
+
|
|
1084
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowQueryKey(runningWorkflowId);
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflow>>> = ({ signal }) => getRunningWorkflow(runningWorkflowId, requestOptions, signal);
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1095
|
+
}
|
|
1096
|
+
|
|
1097
|
+
export type GetRunningWorkflowSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflow>>>
|
|
1098
|
+
export type GetRunningWorkflowSuspenseQueryError = ErrorType<void | DmError>
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
export function useGetRunningWorkflowSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
1102
|
+
runningWorkflowId: string, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1103
|
+
|
|
1104
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1105
|
+
export function useGetRunningWorkflowSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
1106
|
+
runningWorkflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1107
|
+
|
|
1108
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1109
|
+
export function useGetRunningWorkflowSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
1110
|
+
runningWorkflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1111
|
+
|
|
1112
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1113
|
+
/**
|
|
1114
|
+
* @summary Get details of a specific Running Workflow
|
|
1115
|
+
*/
|
|
1116
|
+
|
|
1117
|
+
export function useGetRunningWorkflowSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(
|
|
1118
|
+
runningWorkflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1119
|
+
|
|
1120
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1121
|
+
|
|
1122
|
+
const queryOptions = getGetRunningWorkflowSuspenseQueryOptions(runningWorkflowId,options)
|
|
1123
|
+
|
|
1124
|
+
const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1125
|
+
|
|
1126
|
+
query.queryKey = queryOptions.queryKey ;
|
|
1127
|
+
|
|
1128
|
+
return query;
|
|
1129
|
+
}
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
/**
|
|
1134
|
+
* If the Running Workflow has stopped it is deleted.
|
|
1135
|
+
|
|
1136
|
+
* @summary Delete a Running Workflow
|
|
1137
|
+
*/
|
|
1138
|
+
export const deleteRunningWorkflow = (
|
|
1139
|
+
runningWorkflowId: string,
|
|
1140
|
+
options?: SecondParameter<typeof customInstance>,) => {
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
return customInstance<void>(
|
|
1144
|
+
{url: `/running-workflow/${runningWorkflowId}`, method: 'DELETE'
|
|
1145
|
+
},
|
|
1146
|
+
options);
|
|
1147
|
+
}
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
export const getDeleteRunningWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof deleteRunningWorkflow>>, TError = ErrorType<void | DmError>,
|
|
1152
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
1153
|
+
) => {
|
|
1154
|
+
const mutationKey = ['deleteRunningWorkflow'];
|
|
1155
|
+
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
1156
|
+
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
1157
|
+
options
|
|
1158
|
+
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
1159
|
+
: {mutation: { mutationKey, }, request: undefined};
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
const mutationFn: MutationFunction<Awaited<ReturnType<typeof deleteRunningWorkflow>>, {runningWorkflowId: string}> = (props) => {
|
|
1165
|
+
const {runningWorkflowId} = props ?? {};
|
|
1166
|
+
|
|
1167
|
+
return deleteRunningWorkflow(runningWorkflowId,requestOptions)
|
|
1168
|
+
}
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>}
|
|
1174
|
+
|
|
1175
|
+
export type DeleteRunningWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof deleteRunningWorkflow>>>
|
|
1176
|
+
|
|
1177
|
+
export type DeleteRunningWorkflowMutationError = ErrorType<void | DmError>
|
|
1178
|
+
|
|
1179
|
+
/**
|
|
1180
|
+
* @summary Delete a Running Workflow
|
|
1181
|
+
*/
|
|
1182
|
+
export const useDeleteRunningWorkflow = <TData = Awaited<ReturnType<typeof deleteRunningWorkflow>>, TError = ErrorType<void | DmError>,
|
|
1183
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
1184
|
+
): UseMutationResult<
|
|
1185
|
+
TData,
|
|
1186
|
+
TError,
|
|
1187
|
+
{runningWorkflowId: string},
|
|
1188
|
+
TContext
|
|
1189
|
+
> => {
|
|
1190
|
+
|
|
1191
|
+
const mutationOptions = getDeleteRunningWorkflowMutationOptions(options);
|
|
1192
|
+
|
|
1193
|
+
return useMutation(mutationOptions);
|
|
1194
|
+
}
|
|
1195
|
+
/**
|
|
1196
|
+
* Stops a Running Workflow.
|
|
1197
|
+
|
|
1198
|
+
* @summary Stop a Running Workflow
|
|
1199
|
+
*/
|
|
1200
|
+
export const stopRunningWorkflow = (
|
|
1201
|
+
runningWorkflowId: string,
|
|
1202
|
+
options?: SecondParameter<typeof customInstance>,) => {
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
return customInstance<void>(
|
|
1206
|
+
{url: `/running-workflow/${runningWorkflowId}/stop`, method: 'PUT'
|
|
1207
|
+
},
|
|
1208
|
+
options);
|
|
1209
|
+
}
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
export const getStopRunningWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof stopRunningWorkflow>>, TError = ErrorType<void | DmError>,
|
|
1214
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
1215
|
+
) => {
|
|
1216
|
+
const mutationKey = ['stopRunningWorkflow'];
|
|
1217
|
+
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
1218
|
+
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
1219
|
+
options
|
|
1220
|
+
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
1221
|
+
: {mutation: { mutationKey, }, request: undefined};
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
const mutationFn: MutationFunction<Awaited<ReturnType<typeof stopRunningWorkflow>>, {runningWorkflowId: string}> = (props) => {
|
|
1227
|
+
const {runningWorkflowId} = props ?? {};
|
|
1228
|
+
|
|
1229
|
+
return stopRunningWorkflow(runningWorkflowId,requestOptions)
|
|
1230
|
+
}
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>}
|
|
1236
|
+
|
|
1237
|
+
export type StopRunningWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof stopRunningWorkflow>>>
|
|
1238
|
+
|
|
1239
|
+
export type StopRunningWorkflowMutationError = ErrorType<void | DmError>
|
|
1240
|
+
|
|
1241
|
+
/**
|
|
1242
|
+
* @summary Stop a Running Workflow
|
|
1243
|
+
*/
|
|
1244
|
+
export const useStopRunningWorkflow = <TData = Awaited<ReturnType<typeof stopRunningWorkflow>>, TError = ErrorType<void | DmError>,
|
|
1245
|
+
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
1246
|
+
): UseMutationResult<
|
|
1247
|
+
TData,
|
|
1248
|
+
TError,
|
|
1249
|
+
{runningWorkflowId: string},
|
|
1250
|
+
TContext
|
|
1251
|
+
> => {
|
|
1252
|
+
|
|
1253
|
+
const mutationOptions = getStopRunningWorkflowMutationOptions(options);
|
|
1254
|
+
|
|
1255
|
+
return useMutation(mutationOptions);
|
|
1256
|
+
}
|
|
1257
|
+
/**
|
|
1258
|
+
* Gets the Running Workflow step results for WWorkflow steps that are running (or have run). The steps are listed in chronological order of start time, where the first executed step is the first in the list.
|
|
1259
|
+
|
|
1260
|
+
* @summary Get all the Running Workflow Steps
|
|
1261
|
+
*/
|
|
1262
|
+
export const getRunningWorkflowSteps = (
|
|
1263
|
+
runningWorkflowId: string,
|
|
1264
|
+
options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
|
|
1265
|
+
) => {
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
return customInstance<RunningWorkflowStepsGetResponse>(
|
|
1269
|
+
{url: `/running-workflow/${runningWorkflowId}/steps`, method: 'GET', signal
|
|
1270
|
+
},
|
|
1271
|
+
options);
|
|
1272
|
+
}
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
export const getGetRunningWorkflowStepsQueryKey = (runningWorkflowId: string,) => {
|
|
1276
|
+
return ["data-manager-api", `/running-workflow/${runningWorkflowId}/steps`] as const;
|
|
1277
|
+
}
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
export const getGetRunningWorkflowStepsQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1281
|
+
) => {
|
|
1282
|
+
|
|
1283
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
1284
|
+
|
|
1285
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowStepsQueryKey(runningWorkflowId);
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflowSteps>>> = ({ signal }) => getRunningWorkflowSteps(runningWorkflowId, requestOptions, signal);
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
return { queryKey, queryFn, enabled: !!(runningWorkflowId), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1296
|
+
}
|
|
1297
|
+
|
|
1298
|
+
export type GetRunningWorkflowStepsQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflowSteps>>>
|
|
1299
|
+
export type GetRunningWorkflowStepsQueryError = ErrorType<void | DmError>
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
export function useGetRunningWorkflowSteps<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(
|
|
1303
|
+
runningWorkflowId: string, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>> & Pick<
|
|
1304
|
+
DefinedInitialDataOptions<
|
|
1305
|
+
Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1306
|
+
TError,
|
|
1307
|
+
TData
|
|
1308
|
+
> , 'initialData'
|
|
1309
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
1310
|
+
|
|
1311
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1312
|
+
export function useGetRunningWorkflowSteps<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(
|
|
1313
|
+
runningWorkflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>> & Pick<
|
|
1314
|
+
UndefinedInitialDataOptions<
|
|
1315
|
+
Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1316
|
+
TError,
|
|
1317
|
+
TData
|
|
1318
|
+
> , 'initialData'
|
|
1319
|
+
>, request?: SecondParameter<typeof customInstance>}
|
|
1320
|
+
|
|
1321
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1322
|
+
export function useGetRunningWorkflowSteps<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(
|
|
1323
|
+
runningWorkflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1324
|
+
|
|
1325
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1326
|
+
/**
|
|
1327
|
+
* @summary Get all the Running Workflow Steps
|
|
1328
|
+
*/
|
|
1329
|
+
|
|
1330
|
+
export function useGetRunningWorkflowSteps<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(
|
|
1331
|
+
runningWorkflowId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1332
|
+
|
|
1333
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1334
|
+
|
|
1335
|
+
const queryOptions = getGetRunningWorkflowStepsQueryOptions(runningWorkflowId,options)
|
|
1336
|
+
|
|
1337
|
+
const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1338
|
+
|
|
1339
|
+
query.queryKey = queryOptions.queryKey ;
|
|
1340
|
+
|
|
1341
|
+
return query;
|
|
1342
|
+
}
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
export const getGetRunningWorkflowStepsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1347
|
+
) => {
|
|
1348
|
+
|
|
1349
|
+
const {query: queryOptions, request: requestOptions} = options ?? {};
|
|
1350
|
+
|
|
1351
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowStepsQueryKey(runningWorkflowId);
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflowSteps>>> = ({ signal }) => getRunningWorkflowSteps(runningWorkflowId, requestOptions, signal);
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1362
|
+
}
|
|
1363
|
+
|
|
1364
|
+
export type GetRunningWorkflowStepsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflowSteps>>>
|
|
1365
|
+
export type GetRunningWorkflowStepsSuspenseQueryError = ErrorType<void | DmError>
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
export function useGetRunningWorkflowStepsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(
|
|
1369
|
+
runningWorkflowId: string, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1370
|
+
|
|
1371
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1372
|
+
export function useGetRunningWorkflowStepsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(
|
|
1373
|
+
runningWorkflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1374
|
+
|
|
1375
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1376
|
+
export function useGetRunningWorkflowStepsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(
|
|
1377
|
+
runningWorkflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1378
|
+
|
|
1379
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
1380
|
+
/**
|
|
1381
|
+
* @summary Get all the Running Workflow Steps
|
|
1382
|
+
*/
|
|
1383
|
+
|
|
1384
|
+
export function useGetRunningWorkflowStepsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(
|
|
1385
|
+
runningWorkflowId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
|
|
1386
|
+
|
|
1387
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1388
|
+
|
|
1389
|
+
const queryOptions = getGetRunningWorkflowStepsSuspenseQueryOptions(runningWorkflowId,options)
|
|
1390
|
+
|
|
1391
|
+
const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1392
|
+
|
|
1393
|
+
query.queryKey = queryOptions.queryKey ;
|
|
1394
|
+
|
|
1395
|
+
return query;
|
|
1396
|
+
}
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
|