@squonk/data-manager-client 4.2.0 → 4.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/accounting/accounting.cjs +96 -95
- package/accounting/accounting.cjs.map +1 -1
- package/accounting/accounting.d.cts +47 -47
- package/accounting/accounting.d.ts +47 -47
- package/accounting/accounting.js +102 -101
- package/accounting/accounting.js.map +1 -1
- package/admin/admin.cjs +120 -145
- package/admin/admin.cjs.map +1 -1
- package/admin/admin.d.cts +121 -121
- package/admin/admin.d.ts +121 -121
- package/admin/admin.js +127 -152
- package/admin/admin.js.map +1 -1
- package/application/application.cjs +39 -43
- package/application/application.cjs.map +1 -1
- package/application/application.d.cts +25 -25
- package/application/application.d.ts +25 -25
- package/application/application.js +42 -46
- package/application/application.js.map +1 -1
- package/chunk-OYRETEBZ.js +25 -0
- package/chunk-OYRETEBZ.js.map +1 -0
- package/{chunk-TKLTUR4R.cjs → chunk-RB2KVIEK.cjs} +1 -1
- package/chunk-RB2KVIEK.cjs.map +1 -0
- package/{chunk-EBOQPVLG.js → chunk-XYDLYMQ2.js} +1 -1
- package/chunk-XYDLYMQ2.js.map +1 -0
- package/chunk-ZLY5XEOQ.cjs +25 -0
- package/chunk-ZLY5XEOQ.cjs.map +1 -0
- package/configuration/configuration.cjs +38 -45
- package/configuration/configuration.cjs.map +1 -1
- package/configuration/configuration.d.cts +25 -25
- package/configuration/configuration.d.ts +25 -25
- package/configuration/configuration.js +42 -49
- package/configuration/configuration.js.map +1 -1
- package/dataset/dataset.cjs +126 -141
- package/dataset/dataset.cjs.map +1 -1
- package/dataset/dataset.d.cts +102 -102
- package/dataset/dataset.d.ts +102 -102
- package/dataset/dataset.js +132 -147
- package/dataset/dataset.js.map +1 -1
- package/digest/digest.cjs +22 -24
- package/digest/digest.cjs.map +1 -1
- package/digest/digest.d.cts +14 -14
- package/digest/digest.d.ts +14 -14
- package/digest/digest.js +24 -26
- package/digest/digest.js.map +1 -1
- package/exchange-rate/exchange-rate.cjs +111 -109
- package/exchange-rate/exchange-rate.cjs.map +1 -1
- package/exchange-rate/exchange-rate.d.cts +69 -69
- package/exchange-rate/exchange-rate.d.ts +69 -69
- package/exchange-rate/exchange-rate.js +117 -115
- package/exchange-rate/exchange-rate.js.map +1 -1
- package/file-and-path/file-and-path.cjs +93 -138
- package/file-and-path/file-and-path.cjs.map +1 -1
- package/file-and-path/file-and-path.d.cts +102 -102
- package/file-and-path/file-and-path.d.ts +102 -102
- package/file-and-path/file-and-path.js +105 -150
- package/file-and-path/file-and-path.js.map +1 -1
- package/index.cjs +80 -102
- package/index.cjs.map +1 -1
- package/index.d.cts +2401 -2326
- package/index.d.ts +2401 -2326
- package/index.js +79 -101
- package/index.js.map +1 -1
- package/instance/instance.cjs +100 -107
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.d.cts +76 -76
- package/instance/instance.d.ts +76 -76
- package/instance/instance.js +105 -112
- package/instance/instance.js.map +1 -1
- package/inventory/inventory.cjs +22 -25
- package/inventory/inventory.cjs.map +1 -1
- package/inventory/inventory.d.cts +14 -14
- package/inventory/inventory.d.ts +14 -14
- package/inventory/inventory.js +24 -27
- package/inventory/inventory.js.map +1 -1
- package/job/job.cjs +55 -67
- package/job/job.cjs.map +1 -1
- package/job/job.d.cts +36 -36
- package/job/job.d.ts +36 -36
- package/job/job.js +60 -72
- package/job/job.js.map +1 -1
- package/metadata/metadata.cjs +61 -59
- package/metadata/metadata.cjs.map +1 -1
- package/metadata/metadata.d.cts +47 -47
- package/metadata/metadata.d.ts +47 -47
- package/metadata/metadata.js +65 -63
- package/metadata/metadata.js.map +1 -1
- package/package.json +13 -16
- package/project/project.cjs +165 -186
- package/project/project.cjs.map +1 -1
- package/project/project.d.cts +157 -157
- package/project/project.d.ts +157 -157
- package/project/project.js +172 -193
- package/project/project.js.map +1 -1
- package/src/accounting/accounting.ts +767 -461
- package/src/admin/admin.ts +1187 -787
- package/src/application/application.ts +377 -231
- package/src/configuration/configuration.ts +348 -237
- package/src/custom-instance.ts +3 -3
- package/src/data-manager-api.schemas.ts +2538 -2492
- package/src/dataset/dataset.ts +1199 -792
- package/src/digest/digest.ts +198 -122
- package/src/exchange-rate/exchange-rate.ts +1088 -612
- package/src/file-and-path/file-and-path.ts +869 -616
- package/src/index.ts +2 -2
- package/src/instance/instance.ts +804 -539
- package/src/inventory/inventory.ts +200 -122
- package/src/job/job.ts +556 -348
- package/src/metadata/metadata.ts +587 -371
- package/src/options-mutator.ts +27 -0
- package/src/project/project.ts +1576 -1034
- package/src/task/task.ts +434 -295
- package/src/type/type.ts +180 -126
- package/src/user/user.ts +846 -398
- package/src/workflow/workflow.ts +1750 -1089
- package/task/task.cjs +45 -59
- package/task/task.cjs.map +1 -1
- package/task/task.d.cts +33 -33
- package/task/task.d.ts +33 -33
- package/task/task.js +51 -65
- package/task/task.js.map +1 -1
- package/type/type.cjs +21 -26
- package/type/type.cjs.map +1 -1
- package/type/type.d.cts +14 -14
- package/type/type.d.ts +14 -14
- package/type/type.js +24 -29
- package/type/type.js.map +1 -1
- package/user/user.cjs +114 -80
- package/user/user.cjs.map +1 -1
- package/user/user.d.cts +107 -48
- package/user/user.d.ts +107 -48
- package/user/user.js +120 -86
- package/user/user.js.map +1 -1
- package/workflow/workflow.cjs +179 -193
- package/workflow/workflow.cjs.map +1 -1
- package/workflow/workflow.d.cts +146 -146
- package/workflow/workflow.d.ts +146 -146
- package/workflow/workflow.js +187 -201
- package/workflow/workflow.js.map +1 -1
- package/chunk-EBOQPVLG.js.map +0 -1
- package/chunk-TKLTUR4R.cjs.map +0 -1
package/src/workflow/workflow.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
// @ts-nocheck
|
|
2
1
|
/**
|
|
3
|
-
* Generated by orval v7.
|
|
2
|
+
* Generated by orval v7.10.0 🍺
|
|
4
3
|
* Do not edit manually.
|
|
5
4
|
* Dataset Manager API
|
|
6
5
|
* The Dataset Manager API service.
|
|
@@ -9,16 +8,13 @@ A service that allows *registered* users to make **Datasets** and associated **M
|
|
|
9
8
|
|
|
10
9
|
* OpenAPI spec version: 4.1
|
|
11
10
|
*/
|
|
12
|
-
import {
|
|
13
|
-
useMutation,
|
|
14
|
-
useQuery,
|
|
15
|
-
useSuspenseQuery
|
|
16
|
-
} from '@tanstack/react-query'
|
|
11
|
+
import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
|
|
17
12
|
import type {
|
|
18
13
|
DataTag,
|
|
19
14
|
DefinedInitialDataOptions,
|
|
20
15
|
DefinedUseQueryResult,
|
|
21
16
|
MutationFunction,
|
|
17
|
+
QueryClient,
|
|
22
18
|
QueryFunction,
|
|
23
19
|
QueryKey,
|
|
24
20
|
UndefinedInitialDataOptions,
|
|
@@ -27,8 +23,9 @@ import type {
|
|
|
27
23
|
UseQueryOptions,
|
|
28
24
|
UseQueryResult,
|
|
29
25
|
UseSuspenseQueryOptions,
|
|
30
|
-
UseSuspenseQueryResult
|
|
31
|
-
} from
|
|
26
|
+
UseSuspenseQueryResult,
|
|
27
|
+
} from "@tanstack/react-query";
|
|
28
|
+
|
|
32
29
|
import type {
|
|
33
30
|
DmError,
|
|
34
31
|
GetRunningWorkflowsParams,
|
|
@@ -45,14 +42,15 @@ import type {
|
|
|
45
42
|
WorkflowRunPostBodyBody,
|
|
46
43
|
WorkflowRunPostResponse,
|
|
47
44
|
WorkflowVersionPutBodyBody,
|
|
48
|
-
WorkflowVersionPutResponse
|
|
49
|
-
} from
|
|
50
|
-
import { customInstance } from '.././custom-instance';
|
|
51
|
-
import type { ErrorType } from '.././custom-instance';
|
|
52
|
-
|
|
45
|
+
WorkflowVersionPutResponse,
|
|
46
|
+
} from "../data-manager-api.schemas";
|
|
53
47
|
|
|
54
|
-
|
|
48
|
+
import { customInstance } from ".././custom-instance";
|
|
49
|
+
import type { ErrorType } from ".././custom-instance";
|
|
50
|
+
import { queryMutator } from ".././options-mutator";
|
|
51
|
+
import { mutationMutator } from ".././options-mutator";
|
|
55
52
|
|
|
53
|
+
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
56
54
|
|
|
57
55
|
/**
|
|
58
56
|
* 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.
|
|
@@ -60,363 +58,528 @@ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
|
|
|
60
58
|
* @summary Get all Workflows available to you
|
|
61
59
|
*/
|
|
62
60
|
export const getWorkflows = (
|
|
63
|
-
|
|
64
|
-
|
|
61
|
+
options?: SecondParameter<typeof customInstance>,
|
|
62
|
+
signal?: AbortSignal,
|
|
65
63
|
) => {
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
options);
|
|
72
|
-
}
|
|
73
|
-
|
|
64
|
+
return customInstance<WorkflowGetAllResponse>(
|
|
65
|
+
{ url: `/workflow`, method: "GET", signal },
|
|
66
|
+
options,
|
|
67
|
+
);
|
|
68
|
+
};
|
|
74
69
|
|
|
75
70
|
export const getGetWorkflowsQueryKey = () => {
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
export
|
|
103
|
-
|
|
71
|
+
return [`/workflow`] as const;
|
|
72
|
+
};
|
|
73
|
+
|
|
74
|
+
export const useGetWorkflowsQueryOptions = <
|
|
75
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
76
|
+
TError = ErrorType<void>,
|
|
77
|
+
>(options?: {
|
|
78
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
|
|
79
|
+
request?: SecondParameter<typeof customInstance>;
|
|
80
|
+
}) => {
|
|
81
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
82
|
+
|
|
83
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowsQueryKey();
|
|
84
|
+
|
|
85
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflows>>> = ({ signal }) =>
|
|
86
|
+
getWorkflows(requestOptions, signal);
|
|
87
|
+
|
|
88
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
89
|
+
|
|
90
|
+
return customOptions as UseQueryOptions<
|
|
91
|
+
Awaited<ReturnType<typeof getWorkflows>>,
|
|
92
|
+
TError,
|
|
93
|
+
TData
|
|
94
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
95
|
+
};
|
|
96
|
+
|
|
97
|
+
export type GetWorkflowsQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflows>>>;
|
|
98
|
+
export type GetWorkflowsQueryError = ErrorType<void>;
|
|
99
|
+
|
|
100
|
+
export function useGetWorkflows<
|
|
101
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
102
|
+
TError = ErrorType<void>,
|
|
103
|
+
>(
|
|
104
|
+
options: {
|
|
105
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>> &
|
|
106
|
+
Pick<
|
|
104
107
|
DefinedInitialDataOptions<
|
|
105
108
|
Awaited<ReturnType<typeof getWorkflows>>,
|
|
106
109
|
TError,
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
110
|
+
Awaited<ReturnType<typeof getWorkflows>>
|
|
111
|
+
>,
|
|
112
|
+
"initialData"
|
|
113
|
+
>;
|
|
114
|
+
request?: SecondParameter<typeof customInstance>;
|
|
115
|
+
},
|
|
116
|
+
queryClient?: QueryClient,
|
|
117
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
118
|
+
export function useGetWorkflows<
|
|
119
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
120
|
+
TError = ErrorType<void>,
|
|
121
|
+
>(
|
|
122
|
+
options?: {
|
|
123
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>> &
|
|
124
|
+
Pick<
|
|
114
125
|
UndefinedInitialDataOptions<
|
|
115
126
|
Awaited<ReturnType<typeof getWorkflows>>,
|
|
116
127
|
TError,
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
128
|
+
Awaited<ReturnType<typeof getWorkflows>>
|
|
129
|
+
>,
|
|
130
|
+
"initialData"
|
|
131
|
+
>;
|
|
132
|
+
request?: SecondParameter<typeof customInstance>;
|
|
133
|
+
},
|
|
134
|
+
queryClient?: QueryClient,
|
|
135
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
136
|
+
export function useGetWorkflows<
|
|
137
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
138
|
+
TError = ErrorType<void>,
|
|
139
|
+
>(
|
|
140
|
+
options?: {
|
|
141
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
|
|
142
|
+
request?: SecondParameter<typeof customInstance>;
|
|
143
|
+
},
|
|
144
|
+
queryClient?: QueryClient,
|
|
145
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
126
146
|
/**
|
|
127
147
|
* @summary Get all Workflows available to you
|
|
128
148
|
*/
|
|
129
149
|
|
|
130
|
-
export function useGetWorkflows<
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
150
|
+
export function useGetWorkflows<
|
|
151
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
152
|
+
TError = ErrorType<void>,
|
|
153
|
+
>(
|
|
154
|
+
options?: {
|
|
155
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
|
|
156
|
+
request?: SecondParameter<typeof customInstance>;
|
|
157
|
+
},
|
|
158
|
+
queryClient?: QueryClient,
|
|
159
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
160
|
+
const queryOptions = useGetWorkflowsQueryOptions(options);
|
|
136
161
|
|
|
137
|
-
const query = useQuery(queryOptions) as
|
|
162
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
163
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
164
|
+
};
|
|
138
165
|
|
|
139
|
-
query.queryKey = queryOptions.queryKey
|
|
166
|
+
query.queryKey = queryOptions.queryKey;
|
|
140
167
|
|
|
141
168
|
return query;
|
|
142
169
|
}
|
|
143
170
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
const
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
export
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
171
|
+
export const useGetWorkflowsSuspenseQueryOptions = <
|
|
172
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
173
|
+
TError = ErrorType<void>,
|
|
174
|
+
>(options?: {
|
|
175
|
+
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
|
|
176
|
+
request?: SecondParameter<typeof customInstance>;
|
|
177
|
+
}) => {
|
|
178
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
179
|
+
|
|
180
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowsQueryKey();
|
|
181
|
+
|
|
182
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflows>>> = ({ signal }) =>
|
|
183
|
+
getWorkflows(requestOptions, signal);
|
|
184
|
+
|
|
185
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
186
|
+
|
|
187
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
188
|
+
Awaited<ReturnType<typeof getWorkflows>>,
|
|
189
|
+
TError,
|
|
190
|
+
TData
|
|
191
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
192
|
+
};
|
|
193
|
+
|
|
194
|
+
export type GetWorkflowsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflows>>>;
|
|
195
|
+
export type GetWorkflowsSuspenseQueryError = ErrorType<void>;
|
|
196
|
+
|
|
197
|
+
export function useGetWorkflowsSuspense<
|
|
198
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
199
|
+
TError = ErrorType<void>,
|
|
200
|
+
>(
|
|
201
|
+
options: {
|
|
202
|
+
query: Partial<
|
|
203
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>
|
|
204
|
+
>;
|
|
205
|
+
request?: SecondParameter<typeof customInstance>;
|
|
206
|
+
},
|
|
207
|
+
queryClient?: QueryClient,
|
|
208
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
209
|
+
export function useGetWorkflowsSuspense<
|
|
210
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
211
|
+
TError = ErrorType<void>,
|
|
212
|
+
>(
|
|
213
|
+
options?: {
|
|
214
|
+
query?: Partial<
|
|
215
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>
|
|
216
|
+
>;
|
|
217
|
+
request?: SecondParameter<typeof customInstance>;
|
|
218
|
+
},
|
|
219
|
+
queryClient?: QueryClient,
|
|
220
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
221
|
+
export function useGetWorkflowsSuspense<
|
|
222
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
223
|
+
TError = ErrorType<void>,
|
|
224
|
+
>(
|
|
225
|
+
options?: {
|
|
226
|
+
query?: Partial<
|
|
227
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>
|
|
228
|
+
>;
|
|
229
|
+
request?: SecondParameter<typeof customInstance>;
|
|
230
|
+
},
|
|
231
|
+
queryClient?: QueryClient,
|
|
232
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
180
233
|
/**
|
|
181
234
|
* @summary Get all Workflows available to you
|
|
182
235
|
*/
|
|
183
236
|
|
|
184
|
-
export function useGetWorkflowsSuspense<
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
237
|
+
export function useGetWorkflowsSuspense<
|
|
238
|
+
TData = Awaited<ReturnType<typeof getWorkflows>>,
|
|
239
|
+
TError = ErrorType<void>,
|
|
240
|
+
>(
|
|
241
|
+
options?: {
|
|
242
|
+
query?: Partial<
|
|
243
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>
|
|
244
|
+
>;
|
|
245
|
+
request?: SecondParameter<typeof customInstance>;
|
|
246
|
+
},
|
|
247
|
+
queryClient?: QueryClient,
|
|
248
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
249
|
+
const queryOptions = useGetWorkflowsSuspenseQueryOptions(options);
|
|
250
|
+
|
|
251
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
252
|
+
TData,
|
|
253
|
+
TError
|
|
254
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
255
|
+
|
|
256
|
+
query.queryKey = queryOptions.queryKey;
|
|
194
257
|
|
|
195
258
|
return query;
|
|
196
259
|
}
|
|
197
260
|
|
|
198
|
-
|
|
199
|
-
|
|
200
261
|
/**
|
|
201
262
|
* Creates a new workflow record.
|
|
202
263
|
|
|
203
264
|
* @summary Create a new Workflow
|
|
204
265
|
*/
|
|
205
266
|
export const createWorkflow = (
|
|
206
|
-
|
|
207
|
-
|
|
267
|
+
workflowPostBodyBody: WorkflowPostBodyBody,
|
|
268
|
+
options?: SecondParameter<typeof customInstance>,
|
|
269
|
+
signal?: AbortSignal,
|
|
208
270
|
) => {
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
271
|
+
const formData = new FormData();
|
|
272
|
+
formData.append(`name`, workflowPostBodyBody.name);
|
|
273
|
+
if (workflowPostBodyBody.definition !== undefined) {
|
|
274
|
+
formData.append(`definition`, workflowPostBodyBody.definition);
|
|
275
|
+
}
|
|
276
|
+
if (workflowPostBodyBody.definition_file !== undefined) {
|
|
277
|
+
formData.append(`definition_file`, workflowPostBodyBody.definition_file);
|
|
278
|
+
}
|
|
279
|
+
formData.append(`scope`, workflowPostBodyBody.scope);
|
|
280
|
+
if (workflowPostBodyBody.scope_id !== undefined) {
|
|
281
|
+
formData.append(`scope_id`, workflowPostBodyBody.scope_id);
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
return customInstance<WorkflowPostResponse>(
|
|
285
|
+
{
|
|
286
|
+
url: `/workflow`,
|
|
287
|
+
method: "POST",
|
|
288
|
+
headers: { "Content-Type": "multipart/form-data" },
|
|
289
|
+
data: formData,
|
|
290
|
+
signal,
|
|
227
291
|
},
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
292
|
+
options,
|
|
293
|
+
);
|
|
294
|
+
};
|
|
295
|
+
|
|
296
|
+
export const useCreateWorkflowMutationOptions = <
|
|
297
|
+
TError = ErrorType<void>,
|
|
298
|
+
TContext = unknown,
|
|
299
|
+
>(options?: {
|
|
300
|
+
mutation?: UseMutationOptions<
|
|
301
|
+
Awaited<ReturnType<typeof createWorkflow>>,
|
|
302
|
+
TError,
|
|
303
|
+
{ data: WorkflowPostBodyBody },
|
|
304
|
+
TContext
|
|
305
|
+
>;
|
|
306
|
+
request?: SecondParameter<typeof customInstance>;
|
|
307
|
+
}): UseMutationOptions<
|
|
308
|
+
Awaited<ReturnType<typeof createWorkflow>>,
|
|
309
|
+
TError,
|
|
310
|
+
{ data: WorkflowPostBodyBody },
|
|
311
|
+
TContext
|
|
312
|
+
> => {
|
|
313
|
+
const mutationKey = ["createWorkflow"];
|
|
314
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
315
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
316
|
+
? options
|
|
317
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
318
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
319
|
+
|
|
320
|
+
const mutationFn: MutationFunction<
|
|
321
|
+
Awaited<ReturnType<typeof createWorkflow>>,
|
|
322
|
+
{ data: WorkflowPostBodyBody }
|
|
323
|
+
> = (props) => {
|
|
324
|
+
const { data } = props ?? {};
|
|
325
|
+
|
|
326
|
+
return createWorkflow(data, requestOptions);
|
|
327
|
+
};
|
|
328
|
+
|
|
329
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
330
|
+
|
|
331
|
+
return customOptions;
|
|
332
|
+
};
|
|
333
|
+
|
|
334
|
+
export type CreateWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof createWorkflow>>>;
|
|
335
|
+
export type CreateWorkflowMutationBody = WorkflowPostBodyBody;
|
|
336
|
+
export type CreateWorkflowMutationError = ErrorType<void>;
|
|
231
337
|
|
|
232
|
-
|
|
233
|
-
export const getCreateWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof createWorkflow>>, TError = ErrorType<void>,
|
|
234
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: WorkflowPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
235
|
-
) => {
|
|
236
|
-
const mutationKey = ['createWorkflow'];
|
|
237
|
-
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
238
|
-
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
239
|
-
options
|
|
240
|
-
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
241
|
-
: {mutation: { mutationKey, }, request: undefined};
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
const mutationFn: MutationFunction<Awaited<ReturnType<typeof createWorkflow>>, {data: WorkflowPostBodyBody}> = (props) => {
|
|
247
|
-
const {data} = props ?? {};
|
|
248
|
-
|
|
249
|
-
return createWorkflow(data,requestOptions)
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{data: WorkflowPostBodyBody}, TContext>}
|
|
256
|
-
|
|
257
|
-
export type CreateWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof createWorkflow>>>
|
|
258
|
-
export type CreateWorkflowMutationBody = WorkflowPostBodyBody
|
|
259
|
-
export type CreateWorkflowMutationError = ErrorType<void>
|
|
260
|
-
|
|
261
|
-
/**
|
|
338
|
+
/**
|
|
262
339
|
* @summary Create a new Workflow
|
|
263
340
|
*/
|
|
264
|
-
export const useCreateWorkflow = <
|
|
265
|
-
|
|
341
|
+
export const useCreateWorkflow = <TError = ErrorType<void>, TContext = unknown>(
|
|
342
|
+
options?: {
|
|
343
|
+
mutation?: UseMutationOptions<
|
|
344
|
+
Awaited<ReturnType<typeof createWorkflow>>,
|
|
345
|
+
TError,
|
|
346
|
+
{ data: WorkflowPostBodyBody },
|
|
347
|
+
TContext
|
|
348
|
+
>;
|
|
349
|
+
request?: SecondParameter<typeof customInstance>;
|
|
350
|
+
},
|
|
351
|
+
queryClient?: QueryClient,
|
|
266
352
|
): UseMutationResult<
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
/**
|
|
353
|
+
Awaited<ReturnType<typeof createWorkflow>>,
|
|
354
|
+
TError,
|
|
355
|
+
{ data: WorkflowPostBodyBody },
|
|
356
|
+
TContext
|
|
357
|
+
> => {
|
|
358
|
+
const mutationOptions = useCreateWorkflowMutationOptions(options);
|
|
359
|
+
|
|
360
|
+
return useMutation(mutationOptions, queryClient);
|
|
361
|
+
};
|
|
362
|
+
/**
|
|
278
363
|
* Get details of a specific Workflow available to you.
|
|
279
364
|
|
|
280
365
|
* @summary Get details of a specific Workflow
|
|
281
366
|
*/
|
|
282
367
|
export const getWorkflow = (
|
|
283
|
-
|
|
284
|
-
|
|
368
|
+
workflowId: string,
|
|
369
|
+
options?: SecondParameter<typeof customInstance>,
|
|
370
|
+
signal?: AbortSignal,
|
|
285
371
|
) => {
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
372
|
+
return customInstance<WorkflowGetResponse>(
|
|
373
|
+
{ url: `/workflow/${workflowId}`, method: "GET", signal },
|
|
374
|
+
options,
|
|
375
|
+
);
|
|
376
|
+
};
|
|
377
|
+
|
|
378
|
+
export const getGetWorkflowQueryKey = (workflowId: string) => {
|
|
379
|
+
return [`/workflow/${workflowId}`] as const;
|
|
380
|
+
};
|
|
381
|
+
|
|
382
|
+
export const useGetWorkflowQueryOptions = <
|
|
383
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
384
|
+
TError = ErrorType<void | DmError>,
|
|
385
|
+
>(
|
|
386
|
+
workflowId: string,
|
|
387
|
+
options?: {
|
|
388
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
|
|
389
|
+
request?: SecondParameter<typeof customInstance>;
|
|
390
|
+
},
|
|
301
391
|
) => {
|
|
392
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
302
393
|
|
|
303
|
-
const
|
|
304
|
-
|
|
305
|
-
const queryKey = queryOptions?.queryKey ?? getGetWorkflowQueryKey(workflowId);
|
|
394
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowQueryKey(workflowId);
|
|
306
395
|
|
|
307
|
-
|
|
396
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflow>>> = ({ signal }) =>
|
|
397
|
+
getWorkflow(workflowId, requestOptions, signal);
|
|
308
398
|
|
|
309
|
-
|
|
399
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
310
400
|
|
|
311
|
-
|
|
401
|
+
return customOptions as UseQueryOptions<
|
|
402
|
+
Awaited<ReturnType<typeof getWorkflow>>,
|
|
403
|
+
TError,
|
|
404
|
+
TData
|
|
405
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
406
|
+
};
|
|
312
407
|
|
|
313
|
-
|
|
408
|
+
export type GetWorkflowQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflow>>>;
|
|
409
|
+
export type GetWorkflowQueryError = ErrorType<void | DmError>;
|
|
314
410
|
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
workflowId: string, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>> & Pick<
|
|
411
|
+
export function useGetWorkflow<
|
|
412
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
413
|
+
TError = ErrorType<void | DmError>,
|
|
414
|
+
>(
|
|
415
|
+
workflowId: string,
|
|
416
|
+
options: {
|
|
417
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>> &
|
|
418
|
+
Pick<
|
|
324
419
|
DefinedInitialDataOptions<
|
|
325
420
|
Awaited<ReturnType<typeof getWorkflow>>,
|
|
326
421
|
TError,
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
422
|
+
Awaited<ReturnType<typeof getWorkflow>>
|
|
423
|
+
>,
|
|
424
|
+
"initialData"
|
|
425
|
+
>;
|
|
426
|
+
request?: SecondParameter<typeof customInstance>;
|
|
427
|
+
},
|
|
428
|
+
queryClient?: QueryClient,
|
|
429
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
430
|
+
export function useGetWorkflow<
|
|
431
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
432
|
+
TError = ErrorType<void | DmError>,
|
|
433
|
+
>(
|
|
434
|
+
workflowId: string,
|
|
435
|
+
options?: {
|
|
436
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>> &
|
|
437
|
+
Pick<
|
|
334
438
|
UndefinedInitialDataOptions<
|
|
335
439
|
Awaited<ReturnType<typeof getWorkflow>>,
|
|
336
440
|
TError,
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
441
|
+
Awaited<ReturnType<typeof getWorkflow>>
|
|
442
|
+
>,
|
|
443
|
+
"initialData"
|
|
444
|
+
>;
|
|
445
|
+
request?: SecondParameter<typeof customInstance>;
|
|
446
|
+
},
|
|
447
|
+
queryClient?: QueryClient,
|
|
448
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
449
|
+
export function useGetWorkflow<
|
|
450
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
451
|
+
TError = ErrorType<void | DmError>,
|
|
452
|
+
>(
|
|
453
|
+
workflowId: string,
|
|
454
|
+
options?: {
|
|
455
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
|
|
456
|
+
request?: SecondParameter<typeof customInstance>;
|
|
457
|
+
},
|
|
458
|
+
queryClient?: QueryClient,
|
|
459
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
346
460
|
/**
|
|
347
461
|
* @summary Get details of a specific Workflow
|
|
348
462
|
*/
|
|
349
463
|
|
|
350
|
-
export function useGetWorkflow<
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
464
|
+
export function useGetWorkflow<
|
|
465
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
466
|
+
TError = ErrorType<void | DmError>,
|
|
467
|
+
>(
|
|
468
|
+
workflowId: string,
|
|
469
|
+
options?: {
|
|
470
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
|
|
471
|
+
request?: SecondParameter<typeof customInstance>;
|
|
472
|
+
},
|
|
473
|
+
queryClient?: QueryClient,
|
|
474
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
475
|
+
const queryOptions = useGetWorkflowQueryOptions(workflowId, options);
|
|
476
|
+
|
|
477
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
478
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
479
|
+
};
|
|
480
|
+
|
|
481
|
+
query.queryKey = queryOptions.queryKey;
|
|
360
482
|
|
|
361
483
|
return query;
|
|
362
484
|
}
|
|
363
485
|
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
486
|
+
export const useGetWorkflowSuspenseQueryOptions = <
|
|
487
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
488
|
+
TError = ErrorType<void | DmError>,
|
|
489
|
+
>(
|
|
490
|
+
workflowId: string,
|
|
491
|
+
options?: {
|
|
492
|
+
query?: Partial<
|
|
493
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>
|
|
494
|
+
>;
|
|
495
|
+
request?: SecondParameter<typeof customInstance>;
|
|
496
|
+
},
|
|
367
497
|
) => {
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
}
|
|
383
|
-
|
|
384
|
-
export type GetWorkflowSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflow
|
|
385
|
-
export type GetWorkflowSuspenseQueryError = ErrorType<void | DmError
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
498
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
499
|
+
|
|
500
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowQueryKey(workflowId);
|
|
501
|
+
|
|
502
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflow>>> = ({ signal }) =>
|
|
503
|
+
getWorkflow(workflowId, requestOptions, signal);
|
|
504
|
+
|
|
505
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
506
|
+
|
|
507
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
508
|
+
Awaited<ReturnType<typeof getWorkflow>>,
|
|
509
|
+
TError,
|
|
510
|
+
TData
|
|
511
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
512
|
+
};
|
|
513
|
+
|
|
514
|
+
export type GetWorkflowSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflow>>>;
|
|
515
|
+
export type GetWorkflowSuspenseQueryError = ErrorType<void | DmError>;
|
|
516
|
+
|
|
517
|
+
export function useGetWorkflowSuspense<
|
|
518
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
519
|
+
TError = ErrorType<void | DmError>,
|
|
520
|
+
>(
|
|
521
|
+
workflowId: string,
|
|
522
|
+
options: {
|
|
523
|
+
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
|
|
524
|
+
request?: SecondParameter<typeof customInstance>;
|
|
525
|
+
},
|
|
526
|
+
queryClient?: QueryClient,
|
|
527
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
528
|
+
export function useGetWorkflowSuspense<
|
|
529
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
530
|
+
TError = ErrorType<void | DmError>,
|
|
531
|
+
>(
|
|
532
|
+
workflowId: string,
|
|
533
|
+
options?: {
|
|
534
|
+
query?: Partial<
|
|
535
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>
|
|
536
|
+
>;
|
|
537
|
+
request?: SecondParameter<typeof customInstance>;
|
|
538
|
+
},
|
|
539
|
+
queryClient?: QueryClient,
|
|
540
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
541
|
+
export function useGetWorkflowSuspense<
|
|
542
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
543
|
+
TError = ErrorType<void | DmError>,
|
|
544
|
+
>(
|
|
545
|
+
workflowId: string,
|
|
546
|
+
options?: {
|
|
547
|
+
query?: Partial<
|
|
548
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>
|
|
549
|
+
>;
|
|
550
|
+
request?: SecondParameter<typeof customInstance>;
|
|
551
|
+
},
|
|
552
|
+
queryClient?: QueryClient,
|
|
553
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
400
554
|
/**
|
|
401
555
|
* @summary Get details of a specific Workflow
|
|
402
556
|
*/
|
|
403
557
|
|
|
404
|
-
export function useGetWorkflowSuspense<
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
558
|
+
export function useGetWorkflowSuspense<
|
|
559
|
+
TData = Awaited<ReturnType<typeof getWorkflow>>,
|
|
560
|
+
TError = ErrorType<void | DmError>,
|
|
561
|
+
>(
|
|
562
|
+
workflowId: string,
|
|
563
|
+
options?: {
|
|
564
|
+
query?: Partial<
|
|
565
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>
|
|
566
|
+
>;
|
|
567
|
+
request?: SecondParameter<typeof customInstance>;
|
|
568
|
+
},
|
|
569
|
+
queryClient?: QueryClient,
|
|
570
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
571
|
+
const queryOptions = useGetWorkflowSuspenseQueryOptions(workflowId, options);
|
|
572
|
+
|
|
573
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
574
|
+
TData,
|
|
575
|
+
TError
|
|
576
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
577
|
+
|
|
578
|
+
query.queryKey = queryOptions.queryKey;
|
|
414
579
|
|
|
415
580
|
return query;
|
|
416
581
|
}
|
|
417
582
|
|
|
418
|
-
|
|
419
|
-
|
|
420
583
|
/**
|
|
421
584
|
* The Workflow is deleted.
|
|
422
585
|
|
|
@@ -425,63 +588,79 @@ You cannot delete a Workflow if it is the _source_ of a versioned workflow.
|
|
|
425
588
|
* @summary Delete a Workflow
|
|
426
589
|
*/
|
|
427
590
|
export const deleteWorkflow = (
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
return customInstance<void>(
|
|
433
|
-
{url: `/workflow/${workflowId}`, method: 'DELETE'
|
|
434
|
-
},
|
|
435
|
-
options);
|
|
436
|
-
}
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
export const getDeleteWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof deleteWorkflow>>, TError = ErrorType<void | DmError>,
|
|
441
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
591
|
+
workflowId: string,
|
|
592
|
+
options?: SecondParameter<typeof customInstance>,
|
|
442
593
|
) => {
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
594
|
+
return customInstance<void>({ url: `/workflow/${workflowId}`, method: "DELETE" }, options);
|
|
595
|
+
};
|
|
596
|
+
|
|
597
|
+
export const useDeleteWorkflowMutationOptions = <
|
|
598
|
+
TError = ErrorType<void | DmError>,
|
|
599
|
+
TContext = unknown,
|
|
600
|
+
>(options?: {
|
|
601
|
+
mutation?: UseMutationOptions<
|
|
602
|
+
Awaited<ReturnType<typeof deleteWorkflow>>,
|
|
603
|
+
TError,
|
|
604
|
+
{ workflowId: string },
|
|
605
|
+
TContext
|
|
606
|
+
>;
|
|
607
|
+
request?: SecondParameter<typeof customInstance>;
|
|
608
|
+
}): UseMutationOptions<
|
|
609
|
+
Awaited<ReturnType<typeof deleteWorkflow>>,
|
|
610
|
+
TError,
|
|
611
|
+
{ workflowId: string },
|
|
612
|
+
TContext
|
|
613
|
+
> => {
|
|
614
|
+
const mutationKey = ["deleteWorkflow"];
|
|
615
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
616
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
617
|
+
? options
|
|
618
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
619
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
620
|
+
|
|
621
|
+
const mutationFn: MutationFunction<
|
|
622
|
+
Awaited<ReturnType<typeof deleteWorkflow>>,
|
|
623
|
+
{ workflowId: string }
|
|
624
|
+
> = (props) => {
|
|
625
|
+
const { workflowId } = props ?? {};
|
|
626
|
+
|
|
627
|
+
return deleteWorkflow(workflowId, requestOptions);
|
|
628
|
+
};
|
|
629
|
+
|
|
630
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
631
|
+
|
|
632
|
+
return customOptions;
|
|
633
|
+
};
|
|
634
|
+
|
|
635
|
+
export type DeleteWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof deleteWorkflow>>>;
|
|
636
|
+
|
|
637
|
+
export type DeleteWorkflowMutationError = ErrorType<void | DmError>;
|
|
458
638
|
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{workflowId: string}, TContext>}
|
|
463
|
-
|
|
464
|
-
export type DeleteWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof deleteWorkflow>>>
|
|
465
|
-
|
|
466
|
-
export type DeleteWorkflowMutationError = ErrorType<void | DmError>
|
|
467
|
-
|
|
468
|
-
/**
|
|
639
|
+
/**
|
|
469
640
|
* @summary Delete a Workflow
|
|
470
641
|
*/
|
|
471
|
-
export const useDeleteWorkflow = <
|
|
472
|
-
|
|
642
|
+
export const useDeleteWorkflow = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
643
|
+
options?: {
|
|
644
|
+
mutation?: UseMutationOptions<
|
|
645
|
+
Awaited<ReturnType<typeof deleteWorkflow>>,
|
|
646
|
+
TError,
|
|
647
|
+
{ workflowId: string },
|
|
648
|
+
TContext
|
|
649
|
+
>;
|
|
650
|
+
request?: SecondParameter<typeof customInstance>;
|
|
651
|
+
},
|
|
652
|
+
queryClient?: QueryClient,
|
|
473
653
|
): UseMutationResult<
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
/**
|
|
654
|
+
Awaited<ReturnType<typeof deleteWorkflow>>,
|
|
655
|
+
TError,
|
|
656
|
+
{ workflowId: string },
|
|
657
|
+
TContext
|
|
658
|
+
> => {
|
|
659
|
+
const mutationOptions = useDeleteWorkflowMutationOptions(options);
|
|
660
|
+
|
|
661
|
+
return useMutation(mutationOptions, queryClient);
|
|
662
|
+
};
|
|
663
|
+
/**
|
|
485
664
|
* The Workflow is updated according to the patch parameters.
|
|
486
665
|
|
|
487
666
|
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.
|
|
@@ -489,294 +668,435 @@ In **PRODUCTION** mode you cannot alter a Workflow that has been versioned. In *
|
|
|
489
668
|
* @summary Update a Workflow
|
|
490
669
|
*/
|
|
491
670
|
export const updateWorkflow = (
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
const formData = new FormData();
|
|
497
|
-
if(workflowPatchBodyBody.name !== undefined) {
|
|
498
|
-
formData.append('name', workflowPatchBodyBody.name)
|
|
499
|
-
}
|
|
500
|
-
if(workflowPatchBodyBody.definition !== undefined) {
|
|
501
|
-
formData.append('definition', workflowPatchBodyBody.definition)
|
|
502
|
-
}
|
|
503
|
-
if(workflowPatchBodyBody.definition_file !== undefined) {
|
|
504
|
-
formData.append('definition_file', workflowPatchBodyBody.definition_file)
|
|
505
|
-
}
|
|
506
|
-
|
|
507
|
-
return customInstance<WorkflowPatchResponse>(
|
|
508
|
-
{url: `/workflow/${workflowId}`, method: 'PATCH',
|
|
509
|
-
headers: {'Content-Type': 'multipart/form-data', },
|
|
510
|
-
data: formData
|
|
511
|
-
},
|
|
512
|
-
options);
|
|
513
|
-
}
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
export const getUpdateWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof updateWorkflow>>, TError = ErrorType<void | DmError>,
|
|
518
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowPatchBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
671
|
+
workflowId: string,
|
|
672
|
+
workflowPatchBodyBody: WorkflowPatchBodyBody,
|
|
673
|
+
options?: SecondParameter<typeof customInstance>,
|
|
519
674
|
) => {
|
|
520
|
-
const
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
675
|
+
const formData = new FormData();
|
|
676
|
+
if (workflowPatchBodyBody.name !== undefined) {
|
|
677
|
+
formData.append(`name`, workflowPatchBodyBody.name);
|
|
678
|
+
}
|
|
679
|
+
if (workflowPatchBodyBody.definition !== undefined) {
|
|
680
|
+
formData.append(`definition`, workflowPatchBodyBody.definition);
|
|
681
|
+
}
|
|
682
|
+
if (workflowPatchBodyBody.definition_file !== undefined) {
|
|
683
|
+
formData.append(`definition_file`, workflowPatchBodyBody.definition_file);
|
|
684
|
+
}
|
|
685
|
+
|
|
686
|
+
return customInstance<WorkflowPatchResponse>(
|
|
687
|
+
{
|
|
688
|
+
url: `/workflow/${workflowId}`,
|
|
689
|
+
method: "PATCH",
|
|
690
|
+
headers: { "Content-Type": "multipart/form-data" },
|
|
691
|
+
data: formData,
|
|
692
|
+
},
|
|
693
|
+
options,
|
|
694
|
+
);
|
|
695
|
+
};
|
|
696
|
+
|
|
697
|
+
export const useUpdateWorkflowMutationOptions = <
|
|
698
|
+
TError = ErrorType<void | DmError>,
|
|
699
|
+
TContext = unknown,
|
|
700
|
+
>(options?: {
|
|
701
|
+
mutation?: UseMutationOptions<
|
|
702
|
+
Awaited<ReturnType<typeof updateWorkflow>>,
|
|
703
|
+
TError,
|
|
704
|
+
{ workflowId: string; data: WorkflowPatchBodyBody },
|
|
705
|
+
TContext
|
|
706
|
+
>;
|
|
707
|
+
request?: SecondParameter<typeof customInstance>;
|
|
708
|
+
}): UseMutationOptions<
|
|
709
|
+
Awaited<ReturnType<typeof updateWorkflow>>,
|
|
710
|
+
TError,
|
|
711
|
+
{ workflowId: string; data: WorkflowPatchBodyBody },
|
|
712
|
+
TContext
|
|
713
|
+
> => {
|
|
714
|
+
const mutationKey = ["updateWorkflow"];
|
|
715
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
716
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
717
|
+
? options
|
|
718
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
719
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
720
|
+
|
|
721
|
+
const mutationFn: MutationFunction<
|
|
722
|
+
Awaited<ReturnType<typeof updateWorkflow>>,
|
|
723
|
+
{ workflowId: string; data: WorkflowPatchBodyBody }
|
|
724
|
+
> = (props) => {
|
|
725
|
+
const { workflowId, data } = props ?? {};
|
|
726
|
+
|
|
727
|
+
return updateWorkflow(workflowId, data, requestOptions);
|
|
728
|
+
};
|
|
729
|
+
|
|
730
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
731
|
+
|
|
732
|
+
return customOptions;
|
|
733
|
+
};
|
|
734
|
+
|
|
735
|
+
export type UpdateWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof updateWorkflow>>>;
|
|
736
|
+
export type UpdateWorkflowMutationBody = WorkflowPatchBodyBody;
|
|
737
|
+
export type UpdateWorkflowMutationError = ErrorType<void | DmError>;
|
|
544
738
|
|
|
545
|
-
|
|
739
|
+
/**
|
|
546
740
|
* @summary Update a Workflow
|
|
547
741
|
*/
|
|
548
|
-
export const useUpdateWorkflow = <
|
|
549
|
-
|
|
742
|
+
export const useUpdateWorkflow = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
743
|
+
options?: {
|
|
744
|
+
mutation?: UseMutationOptions<
|
|
745
|
+
Awaited<ReturnType<typeof updateWorkflow>>,
|
|
746
|
+
TError,
|
|
747
|
+
{ workflowId: string; data: WorkflowPatchBodyBody },
|
|
748
|
+
TContext
|
|
749
|
+
>;
|
|
750
|
+
request?: SecondParameter<typeof customInstance>;
|
|
751
|
+
},
|
|
752
|
+
queryClient?: QueryClient,
|
|
550
753
|
): UseMutationResult<
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
/**
|
|
754
|
+
Awaited<ReturnType<typeof updateWorkflow>>,
|
|
755
|
+
TError,
|
|
756
|
+
{ workflowId: string; data: WorkflowPatchBodyBody },
|
|
757
|
+
TContext
|
|
758
|
+
> => {
|
|
759
|
+
const mutationOptions = useUpdateWorkflowMutationOptions(options);
|
|
760
|
+
|
|
761
|
+
return useMutation(mutationOptions, queryClient);
|
|
762
|
+
};
|
|
763
|
+
/**
|
|
562
764
|
* 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.
|
|
563
765
|
|
|
564
766
|
* @summary Gets the full definition of a Workflow
|
|
565
767
|
*/
|
|
566
768
|
export const getWorkflowDefinition = (
|
|
567
|
-
|
|
568
|
-
|
|
769
|
+
workflowId: string,
|
|
770
|
+
options?: SecondParameter<typeof customInstance>,
|
|
771
|
+
signal?: AbortSignal,
|
|
569
772
|
) => {
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
773
|
+
return customInstance<WorkflowDefinitionGetResponse>(
|
|
774
|
+
{ url: `/workflow/${workflowId}/definition`, method: "GET", signal },
|
|
775
|
+
options,
|
|
776
|
+
);
|
|
777
|
+
};
|
|
778
|
+
|
|
779
|
+
export const getGetWorkflowDefinitionQueryKey = (workflowId: string) => {
|
|
780
|
+
return [`/workflow/${workflowId}/definition`] as const;
|
|
781
|
+
};
|
|
782
|
+
|
|
783
|
+
export const useGetWorkflowDefinitionQueryOptions = <
|
|
784
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
785
|
+
TError = ErrorType<void | DmError>,
|
|
786
|
+
>(
|
|
787
|
+
workflowId: string,
|
|
788
|
+
options?: {
|
|
789
|
+
query?: Partial<
|
|
790
|
+
UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
791
|
+
>;
|
|
792
|
+
request?: SecondParameter<typeof customInstance>;
|
|
793
|
+
},
|
|
585
794
|
) => {
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
}
|
|
601
|
-
|
|
602
|
-
export type GetWorkflowDefinitionQueryResult = NonNullable<
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
795
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
796
|
+
|
|
797
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowDefinitionQueryKey(workflowId);
|
|
798
|
+
|
|
799
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflowDefinition>>> = ({ signal }) =>
|
|
800
|
+
getWorkflowDefinition(workflowId, requestOptions, signal);
|
|
801
|
+
|
|
802
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
803
|
+
|
|
804
|
+
return customOptions as UseQueryOptions<
|
|
805
|
+
Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
806
|
+
TError,
|
|
807
|
+
TData
|
|
808
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
809
|
+
};
|
|
810
|
+
|
|
811
|
+
export type GetWorkflowDefinitionQueryResult = NonNullable<
|
|
812
|
+
Awaited<ReturnType<typeof getWorkflowDefinition>>
|
|
813
|
+
>;
|
|
814
|
+
export type GetWorkflowDefinitionQueryError = ErrorType<void | DmError>;
|
|
815
|
+
|
|
816
|
+
export function useGetWorkflowDefinition<
|
|
817
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
818
|
+
TError = ErrorType<void | DmError>,
|
|
819
|
+
>(
|
|
820
|
+
workflowId: string,
|
|
821
|
+
options: {
|
|
822
|
+
query: Partial<
|
|
823
|
+
UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
824
|
+
> &
|
|
825
|
+
Pick<
|
|
608
826
|
DefinedInitialDataOptions<
|
|
609
827
|
Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
610
828
|
TError,
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
829
|
+
Awaited<ReturnType<typeof getWorkflowDefinition>>
|
|
830
|
+
>,
|
|
831
|
+
"initialData"
|
|
832
|
+
>;
|
|
833
|
+
request?: SecondParameter<typeof customInstance>;
|
|
834
|
+
},
|
|
835
|
+
queryClient?: QueryClient,
|
|
836
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
837
|
+
export function useGetWorkflowDefinition<
|
|
838
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
839
|
+
TError = ErrorType<void | DmError>,
|
|
840
|
+
>(
|
|
841
|
+
workflowId: string,
|
|
842
|
+
options?: {
|
|
843
|
+
query?: Partial<
|
|
844
|
+
UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
845
|
+
> &
|
|
846
|
+
Pick<
|
|
618
847
|
UndefinedInitialDataOptions<
|
|
619
848
|
Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
620
849
|
TError,
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
850
|
+
Awaited<ReturnType<typeof getWorkflowDefinition>>
|
|
851
|
+
>,
|
|
852
|
+
"initialData"
|
|
853
|
+
>;
|
|
854
|
+
request?: SecondParameter<typeof customInstance>;
|
|
855
|
+
},
|
|
856
|
+
queryClient?: QueryClient,
|
|
857
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
858
|
+
export function useGetWorkflowDefinition<
|
|
859
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
860
|
+
TError = ErrorType<void | DmError>,
|
|
861
|
+
>(
|
|
862
|
+
workflowId: string,
|
|
863
|
+
options?: {
|
|
864
|
+
query?: Partial<
|
|
865
|
+
UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
866
|
+
>;
|
|
867
|
+
request?: SecondParameter<typeof customInstance>;
|
|
868
|
+
},
|
|
869
|
+
queryClient?: QueryClient,
|
|
870
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
630
871
|
/**
|
|
631
872
|
* @summary Gets the full definition of a Workflow
|
|
632
873
|
*/
|
|
633
874
|
|
|
634
|
-
export function useGetWorkflowDefinition<
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
875
|
+
export function useGetWorkflowDefinition<
|
|
876
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
877
|
+
TError = ErrorType<void | DmError>,
|
|
878
|
+
>(
|
|
879
|
+
workflowId: string,
|
|
880
|
+
options?: {
|
|
881
|
+
query?: Partial<
|
|
882
|
+
UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
883
|
+
>;
|
|
884
|
+
request?: SecondParameter<typeof customInstance>;
|
|
885
|
+
},
|
|
886
|
+
queryClient?: QueryClient,
|
|
887
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
888
|
+
const queryOptions = useGetWorkflowDefinitionQueryOptions(workflowId, options);
|
|
889
|
+
|
|
890
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
891
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
892
|
+
};
|
|
893
|
+
|
|
894
|
+
query.queryKey = queryOptions.queryKey;
|
|
644
895
|
|
|
645
896
|
return query;
|
|
646
897
|
}
|
|
647
898
|
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
899
|
+
export const useGetWorkflowDefinitionSuspenseQueryOptions = <
|
|
900
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
901
|
+
TError = ErrorType<void | DmError>,
|
|
902
|
+
>(
|
|
903
|
+
workflowId: string,
|
|
904
|
+
options?: {
|
|
905
|
+
query?: Partial<
|
|
906
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
907
|
+
>;
|
|
908
|
+
request?: SecondParameter<typeof customInstance>;
|
|
909
|
+
},
|
|
651
910
|
) => {
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
}
|
|
667
|
-
|
|
668
|
-
export type GetWorkflowDefinitionSuspenseQueryResult = NonNullable<
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
911
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
912
|
+
|
|
913
|
+
const queryKey = queryOptions?.queryKey ?? getGetWorkflowDefinitionQueryKey(workflowId);
|
|
914
|
+
|
|
915
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getWorkflowDefinition>>> = ({ signal }) =>
|
|
916
|
+
getWorkflowDefinition(workflowId, requestOptions, signal);
|
|
917
|
+
|
|
918
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
919
|
+
|
|
920
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
921
|
+
Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
922
|
+
TError,
|
|
923
|
+
TData
|
|
924
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
925
|
+
};
|
|
926
|
+
|
|
927
|
+
export type GetWorkflowDefinitionSuspenseQueryResult = NonNullable<
|
|
928
|
+
Awaited<ReturnType<typeof getWorkflowDefinition>>
|
|
929
|
+
>;
|
|
930
|
+
export type GetWorkflowDefinitionSuspenseQueryError = ErrorType<void | DmError>;
|
|
931
|
+
|
|
932
|
+
export function useGetWorkflowDefinitionSuspense<
|
|
933
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
934
|
+
TError = ErrorType<void | DmError>,
|
|
935
|
+
>(
|
|
936
|
+
workflowId: string,
|
|
937
|
+
options: {
|
|
938
|
+
query: Partial<
|
|
939
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
940
|
+
>;
|
|
941
|
+
request?: SecondParameter<typeof customInstance>;
|
|
942
|
+
},
|
|
943
|
+
queryClient?: QueryClient,
|
|
944
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
945
|
+
export function useGetWorkflowDefinitionSuspense<
|
|
946
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
947
|
+
TError = ErrorType<void | DmError>,
|
|
948
|
+
>(
|
|
949
|
+
workflowId: string,
|
|
950
|
+
options?: {
|
|
951
|
+
query?: Partial<
|
|
952
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
953
|
+
>;
|
|
954
|
+
request?: SecondParameter<typeof customInstance>;
|
|
955
|
+
},
|
|
956
|
+
queryClient?: QueryClient,
|
|
957
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
958
|
+
export function useGetWorkflowDefinitionSuspense<
|
|
959
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
960
|
+
TError = ErrorType<void | DmError>,
|
|
961
|
+
>(
|
|
962
|
+
workflowId: string,
|
|
963
|
+
options?: {
|
|
964
|
+
query?: Partial<
|
|
965
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
966
|
+
>;
|
|
967
|
+
request?: SecondParameter<typeof customInstance>;
|
|
968
|
+
},
|
|
969
|
+
queryClient?: QueryClient,
|
|
970
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
684
971
|
/**
|
|
685
972
|
* @summary Gets the full definition of a Workflow
|
|
686
973
|
*/
|
|
687
974
|
|
|
688
|
-
export function useGetWorkflowDefinitionSuspense<
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
975
|
+
export function useGetWorkflowDefinitionSuspense<
|
|
976
|
+
TData = Awaited<ReturnType<typeof getWorkflowDefinition>>,
|
|
977
|
+
TError = ErrorType<void | DmError>,
|
|
978
|
+
>(
|
|
979
|
+
workflowId: string,
|
|
980
|
+
options?: {
|
|
981
|
+
query?: Partial<
|
|
982
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>
|
|
983
|
+
>;
|
|
984
|
+
request?: SecondParameter<typeof customInstance>;
|
|
985
|
+
},
|
|
986
|
+
queryClient?: QueryClient,
|
|
987
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
988
|
+
const queryOptions = useGetWorkflowDefinitionSuspenseQueryOptions(workflowId, options);
|
|
989
|
+
|
|
990
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
991
|
+
TData,
|
|
992
|
+
TError
|
|
993
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
994
|
+
|
|
995
|
+
query.queryKey = queryOptions.queryKey;
|
|
698
996
|
|
|
699
997
|
return query;
|
|
700
998
|
}
|
|
701
999
|
|
|
702
|
-
|
|
703
|
-
|
|
704
1000
|
/**
|
|
705
1001
|
* Runs a Workflow.
|
|
706
1002
|
|
|
707
1003
|
* @summary Run a Workflow
|
|
708
1004
|
*/
|
|
709
1005
|
export const runWorkflow = (
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
1006
|
+
workflowId: string,
|
|
1007
|
+
workflowRunPostBodyBody: WorkflowRunPostBodyBody,
|
|
1008
|
+
options?: SecondParameter<typeof customInstance>,
|
|
1009
|
+
signal?: AbortSignal,
|
|
713
1010
|
) => {
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
formUrlEncoded.append(
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
1011
|
+
const formUrlEncoded = new URLSearchParams();
|
|
1012
|
+
formUrlEncoded.append(`project_id`, workflowRunPostBodyBody.project_id);
|
|
1013
|
+
formUrlEncoded.append(`as_name`, workflowRunPostBodyBody.as_name);
|
|
1014
|
+
if (workflowRunPostBodyBody.variables !== undefined) {
|
|
1015
|
+
formUrlEncoded.append(`variables`, workflowRunPostBodyBody.variables);
|
|
1016
|
+
}
|
|
1017
|
+
if (workflowRunPostBodyBody.debug !== undefined) {
|
|
1018
|
+
formUrlEncoded.append(`debug`, workflowRunPostBodyBody.debug);
|
|
1019
|
+
}
|
|
1020
|
+
|
|
1021
|
+
return customInstance<WorkflowRunPostResponse>(
|
|
1022
|
+
{
|
|
1023
|
+
url: `/workflow/${workflowId}/run`,
|
|
1024
|
+
method: "POST",
|
|
1025
|
+
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
|
1026
|
+
data: formUrlEncoded,
|
|
1027
|
+
signal,
|
|
729
1028
|
},
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
1029
|
+
options,
|
|
1030
|
+
);
|
|
1031
|
+
};
|
|
1032
|
+
|
|
1033
|
+
export const useRunWorkflowMutationOptions = <
|
|
1034
|
+
TError = ErrorType<void | DmError>,
|
|
1035
|
+
TContext = unknown,
|
|
1036
|
+
>(options?: {
|
|
1037
|
+
mutation?: UseMutationOptions<
|
|
1038
|
+
Awaited<ReturnType<typeof runWorkflow>>,
|
|
1039
|
+
TError,
|
|
1040
|
+
{ workflowId: string; data: WorkflowRunPostBodyBody },
|
|
1041
|
+
TContext
|
|
1042
|
+
>;
|
|
1043
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1044
|
+
}): UseMutationOptions<
|
|
1045
|
+
Awaited<ReturnType<typeof runWorkflow>>,
|
|
1046
|
+
TError,
|
|
1047
|
+
{ workflowId: string; data: WorkflowRunPostBodyBody },
|
|
1048
|
+
TContext
|
|
1049
|
+
> => {
|
|
1050
|
+
const mutationKey = ["runWorkflow"];
|
|
1051
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
1052
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
1053
|
+
? options
|
|
1054
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
1055
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
1056
|
+
|
|
1057
|
+
const mutationFn: MutationFunction<
|
|
1058
|
+
Awaited<ReturnType<typeof runWorkflow>>,
|
|
1059
|
+
{ workflowId: string; data: WorkflowRunPostBodyBody }
|
|
1060
|
+
> = (props) => {
|
|
1061
|
+
const { workflowId, data } = props ?? {};
|
|
1062
|
+
|
|
1063
|
+
return runWorkflow(workflowId, data, requestOptions);
|
|
1064
|
+
};
|
|
1065
|
+
|
|
1066
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
1067
|
+
|
|
1068
|
+
return customOptions;
|
|
1069
|
+
};
|
|
1070
|
+
|
|
1071
|
+
export type RunWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof runWorkflow>>>;
|
|
1072
|
+
export type RunWorkflowMutationBody = WorkflowRunPostBodyBody;
|
|
1073
|
+
export type RunWorkflowMutationError = ErrorType<void | DmError>;
|
|
762
1074
|
|
|
763
|
-
|
|
1075
|
+
/**
|
|
764
1076
|
* @summary Run a Workflow
|
|
765
1077
|
*/
|
|
766
|
-
export const useRunWorkflow = <
|
|
767
|
-
|
|
1078
|
+
export const useRunWorkflow = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
1079
|
+
options?: {
|
|
1080
|
+
mutation?: UseMutationOptions<
|
|
1081
|
+
Awaited<ReturnType<typeof runWorkflow>>,
|
|
1082
|
+
TError,
|
|
1083
|
+
{ workflowId: string; data: WorkflowRunPostBodyBody },
|
|
1084
|
+
TContext
|
|
1085
|
+
>;
|
|
1086
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1087
|
+
},
|
|
1088
|
+
queryClient?: QueryClient,
|
|
768
1089
|
): UseMutationResult<
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
/**
|
|
1090
|
+
Awaited<ReturnType<typeof runWorkflow>>,
|
|
1091
|
+
TError,
|
|
1092
|
+
{ workflowId: string; data: WorkflowRunPostBodyBody },
|
|
1093
|
+
TContext
|
|
1094
|
+
> => {
|
|
1095
|
+
const mutationOptions = useRunWorkflowMutationOptions(options);
|
|
1096
|
+
|
|
1097
|
+
return useMutation(mutationOptions, queryClient);
|
|
1098
|
+
};
|
|
1099
|
+
/**
|
|
780
1100
|
* 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.
|
|
781
1101
|
|
|
782
1102
|
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.
|
|
@@ -784,68 +1104,93 @@ When you apply a version to a Workflow you are making a commitment not to alter
|
|
|
784
1104
|
* @summary Applied a version to the Workflow
|
|
785
1105
|
*/
|
|
786
1106
|
export const versionWorkflow = (
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
const formUrlEncoded = new URLSearchParams();
|
|
792
|
-
formUrlEncoded.append('version', workflowVersionPutBodyBody.version)
|
|
793
|
-
|
|
794
|
-
return customInstance<WorkflowVersionPutResponse>(
|
|
795
|
-
{url: `/workflow/${workflowId}/version`, method: 'PUT',
|
|
796
|
-
headers: {'Content-Type': 'application/x-www-form-urlencoded', },
|
|
797
|
-
data: formUrlEncoded
|
|
798
|
-
},
|
|
799
|
-
options);
|
|
800
|
-
}
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
export const getVersionWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof versionWorkflow>>, TError = ErrorType<void | DmError>,
|
|
805
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{workflowId: string;data: WorkflowVersionPutBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
1107
|
+
workflowId: string,
|
|
1108
|
+
workflowVersionPutBodyBody: WorkflowVersionPutBodyBody,
|
|
1109
|
+
options?: SecondParameter<typeof customInstance>,
|
|
806
1110
|
) => {
|
|
807
|
-
const
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
: {
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
1111
|
+
const formUrlEncoded = new URLSearchParams();
|
|
1112
|
+
formUrlEncoded.append(`version`, workflowVersionPutBodyBody.version);
|
|
1113
|
+
|
|
1114
|
+
return customInstance<WorkflowVersionPutResponse>(
|
|
1115
|
+
{
|
|
1116
|
+
url: `/workflow/${workflowId}/version`,
|
|
1117
|
+
method: "PUT",
|
|
1118
|
+
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
|
1119
|
+
data: formUrlEncoded,
|
|
1120
|
+
},
|
|
1121
|
+
options,
|
|
1122
|
+
);
|
|
1123
|
+
};
|
|
1124
|
+
|
|
1125
|
+
export const useVersionWorkflowMutationOptions = <
|
|
1126
|
+
TError = ErrorType<void | DmError>,
|
|
1127
|
+
TContext = unknown,
|
|
1128
|
+
>(options?: {
|
|
1129
|
+
mutation?: UseMutationOptions<
|
|
1130
|
+
Awaited<ReturnType<typeof versionWorkflow>>,
|
|
1131
|
+
TError,
|
|
1132
|
+
{ workflowId: string; data: WorkflowVersionPutBodyBody },
|
|
1133
|
+
TContext
|
|
1134
|
+
>;
|
|
1135
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1136
|
+
}): UseMutationOptions<
|
|
1137
|
+
Awaited<ReturnType<typeof versionWorkflow>>,
|
|
1138
|
+
TError,
|
|
1139
|
+
{ workflowId: string; data: WorkflowVersionPutBodyBody },
|
|
1140
|
+
TContext
|
|
1141
|
+
> => {
|
|
1142
|
+
const mutationKey = ["versionWorkflow"];
|
|
1143
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
1144
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
1145
|
+
? options
|
|
1146
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
1147
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
1148
|
+
|
|
1149
|
+
const mutationFn: MutationFunction<
|
|
1150
|
+
Awaited<ReturnType<typeof versionWorkflow>>,
|
|
1151
|
+
{ workflowId: string; data: WorkflowVersionPutBodyBody }
|
|
1152
|
+
> = (props) => {
|
|
1153
|
+
const { workflowId, data } = props ?? {};
|
|
1154
|
+
|
|
1155
|
+
return versionWorkflow(workflowId, data, requestOptions);
|
|
1156
|
+
};
|
|
1157
|
+
|
|
1158
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
1159
|
+
|
|
1160
|
+
return customOptions;
|
|
1161
|
+
};
|
|
1162
|
+
|
|
1163
|
+
export type VersionWorkflowMutationResult = NonNullable<
|
|
1164
|
+
Awaited<ReturnType<typeof versionWorkflow>>
|
|
1165
|
+
>;
|
|
1166
|
+
export type VersionWorkflowMutationBody = WorkflowVersionPutBodyBody;
|
|
1167
|
+
export type VersionWorkflowMutationError = ErrorType<void | DmError>;
|
|
831
1168
|
|
|
832
|
-
|
|
1169
|
+
/**
|
|
833
1170
|
* @summary Applied a version to the Workflow
|
|
834
1171
|
*/
|
|
835
|
-
export const useVersionWorkflow = <
|
|
836
|
-
|
|
1172
|
+
export const useVersionWorkflow = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
1173
|
+
options?: {
|
|
1174
|
+
mutation?: UseMutationOptions<
|
|
1175
|
+
Awaited<ReturnType<typeof versionWorkflow>>,
|
|
1176
|
+
TError,
|
|
1177
|
+
{ workflowId: string; data: WorkflowVersionPutBodyBody },
|
|
1178
|
+
TContext
|
|
1179
|
+
>;
|
|
1180
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1181
|
+
},
|
|
1182
|
+
queryClient?: QueryClient,
|
|
837
1183
|
): UseMutationResult<
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
/**
|
|
1184
|
+
Awaited<ReturnType<typeof versionWorkflow>>,
|
|
1185
|
+
TError,
|
|
1186
|
+
{ workflowId: string; data: WorkflowVersionPutBodyBody },
|
|
1187
|
+
TContext
|
|
1188
|
+
> => {
|
|
1189
|
+
const mutationOptions = useVersionWorkflowMutationOptions(options);
|
|
1190
|
+
|
|
1191
|
+
return useMutation(mutationOptions, queryClient);
|
|
1192
|
+
};
|
|
1193
|
+
/**
|
|
849
1194
|
* 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.
|
|
850
1195
|
|
|
851
1196
|
By providing a workflow ID you will only see Running Workflows for that Workflow.
|
|
@@ -853,551 +1198,867 @@ By providing a workflow ID you will only see Running Workflows for that Workflow
|
|
|
853
1198
|
* @summary Get all Running Workflows available to you
|
|
854
1199
|
*/
|
|
855
1200
|
export const getRunningWorkflows = (
|
|
856
|
-
|
|
857
|
-
|
|
1201
|
+
params?: GetRunningWorkflowsParams,
|
|
1202
|
+
options?: SecondParameter<typeof customInstance>,
|
|
1203
|
+
signal?: AbortSignal,
|
|
858
1204
|
) => {
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
export const
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
1205
|
+
return customInstance<RunningWorkflowGetAllResponse>(
|
|
1206
|
+
{ url: `/running-workflow`, method: "GET", params, signal },
|
|
1207
|
+
options,
|
|
1208
|
+
);
|
|
1209
|
+
};
|
|
1210
|
+
|
|
1211
|
+
export const getGetRunningWorkflowsQueryKey = (params?: GetRunningWorkflowsParams) => {
|
|
1212
|
+
return [`/running-workflow`, ...(params ? [params] : [])] as const;
|
|
1213
|
+
};
|
|
1214
|
+
|
|
1215
|
+
export const useGetRunningWorkflowsQueryOptions = <
|
|
1216
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1217
|
+
TError = ErrorType<void>,
|
|
1218
|
+
>(
|
|
1219
|
+
params?: GetRunningWorkflowsParams,
|
|
1220
|
+
options?: {
|
|
1221
|
+
query?: Partial<
|
|
1222
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1223
|
+
>;
|
|
1224
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1225
|
+
},
|
|
875
1226
|
) => {
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
}
|
|
891
|
-
|
|
892
|
-
export type GetRunningWorkflowsQueryResult = NonNullable<
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
1227
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
1228
|
+
|
|
1229
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowsQueryKey(params);
|
|
1230
|
+
|
|
1231
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflows>>> = ({ signal }) =>
|
|
1232
|
+
getRunningWorkflows(params, requestOptions, signal);
|
|
1233
|
+
|
|
1234
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
1235
|
+
|
|
1236
|
+
return customOptions as UseQueryOptions<
|
|
1237
|
+
Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1238
|
+
TError,
|
|
1239
|
+
TData
|
|
1240
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1241
|
+
};
|
|
1242
|
+
|
|
1243
|
+
export type GetRunningWorkflowsQueryResult = NonNullable<
|
|
1244
|
+
Awaited<ReturnType<typeof getRunningWorkflows>>
|
|
1245
|
+
>;
|
|
1246
|
+
export type GetRunningWorkflowsQueryError = ErrorType<void>;
|
|
1247
|
+
|
|
1248
|
+
export function useGetRunningWorkflows<
|
|
1249
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1250
|
+
TError = ErrorType<void>,
|
|
1251
|
+
>(
|
|
1252
|
+
params: undefined | GetRunningWorkflowsParams,
|
|
1253
|
+
options: {
|
|
1254
|
+
query: Partial<
|
|
1255
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1256
|
+
> &
|
|
1257
|
+
Pick<
|
|
898
1258
|
DefinedInitialDataOptions<
|
|
899
1259
|
Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
900
1260
|
TError,
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
1261
|
+
Awaited<ReturnType<typeof getRunningWorkflows>>
|
|
1262
|
+
>,
|
|
1263
|
+
"initialData"
|
|
1264
|
+
>;
|
|
1265
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1266
|
+
},
|
|
1267
|
+
queryClient?: QueryClient,
|
|
1268
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1269
|
+
export function useGetRunningWorkflows<
|
|
1270
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1271
|
+
TError = ErrorType<void>,
|
|
1272
|
+
>(
|
|
1273
|
+
params?: GetRunningWorkflowsParams,
|
|
1274
|
+
options?: {
|
|
1275
|
+
query?: Partial<
|
|
1276
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1277
|
+
> &
|
|
1278
|
+
Pick<
|
|
908
1279
|
UndefinedInitialDataOptions<
|
|
909
1280
|
Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
910
1281
|
TError,
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
1282
|
+
Awaited<ReturnType<typeof getRunningWorkflows>>
|
|
1283
|
+
>,
|
|
1284
|
+
"initialData"
|
|
1285
|
+
>;
|
|
1286
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1287
|
+
},
|
|
1288
|
+
queryClient?: QueryClient,
|
|
1289
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1290
|
+
export function useGetRunningWorkflows<
|
|
1291
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1292
|
+
TError = ErrorType<void>,
|
|
1293
|
+
>(
|
|
1294
|
+
params?: GetRunningWorkflowsParams,
|
|
1295
|
+
options?: {
|
|
1296
|
+
query?: Partial<
|
|
1297
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1298
|
+
>;
|
|
1299
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1300
|
+
},
|
|
1301
|
+
queryClient?: QueryClient,
|
|
1302
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
920
1303
|
/**
|
|
921
1304
|
* @summary Get all Running Workflows available to you
|
|
922
1305
|
*/
|
|
923
1306
|
|
|
924
|
-
export function useGetRunningWorkflows<
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
1307
|
+
export function useGetRunningWorkflows<
|
|
1308
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1309
|
+
TError = ErrorType<void>,
|
|
1310
|
+
>(
|
|
1311
|
+
params?: GetRunningWorkflowsParams,
|
|
1312
|
+
options?: {
|
|
1313
|
+
query?: Partial<
|
|
1314
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1315
|
+
>;
|
|
1316
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1317
|
+
},
|
|
1318
|
+
queryClient?: QueryClient,
|
|
1319
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1320
|
+
const queryOptions = useGetRunningWorkflowsQueryOptions(params, options);
|
|
1321
|
+
|
|
1322
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
1323
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1324
|
+
};
|
|
1325
|
+
|
|
1326
|
+
query.queryKey = queryOptions.queryKey;
|
|
934
1327
|
|
|
935
1328
|
return query;
|
|
936
1329
|
}
|
|
937
1330
|
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
1331
|
+
export const useGetRunningWorkflowsSuspenseQueryOptions = <
|
|
1332
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1333
|
+
TError = ErrorType<void>,
|
|
1334
|
+
>(
|
|
1335
|
+
params?: GetRunningWorkflowsParams,
|
|
1336
|
+
options?: {
|
|
1337
|
+
query?: Partial<
|
|
1338
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1339
|
+
>;
|
|
1340
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1341
|
+
},
|
|
941
1342
|
) => {
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
}
|
|
957
|
-
|
|
958
|
-
export type GetRunningWorkflowsSuspenseQueryResult = NonNullable<
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
1343
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
1344
|
+
|
|
1345
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowsQueryKey(params);
|
|
1346
|
+
|
|
1347
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflows>>> = ({ signal }) =>
|
|
1348
|
+
getRunningWorkflows(params, requestOptions, signal);
|
|
1349
|
+
|
|
1350
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
1351
|
+
|
|
1352
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
1353
|
+
Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1354
|
+
TError,
|
|
1355
|
+
TData
|
|
1356
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1357
|
+
};
|
|
1358
|
+
|
|
1359
|
+
export type GetRunningWorkflowsSuspenseQueryResult = NonNullable<
|
|
1360
|
+
Awaited<ReturnType<typeof getRunningWorkflows>>
|
|
1361
|
+
>;
|
|
1362
|
+
export type GetRunningWorkflowsSuspenseQueryError = ErrorType<void>;
|
|
1363
|
+
|
|
1364
|
+
export function useGetRunningWorkflowsSuspense<
|
|
1365
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1366
|
+
TError = ErrorType<void>,
|
|
1367
|
+
>(
|
|
1368
|
+
params: undefined | GetRunningWorkflowsParams,
|
|
1369
|
+
options: {
|
|
1370
|
+
query: Partial<
|
|
1371
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1372
|
+
>;
|
|
1373
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1374
|
+
},
|
|
1375
|
+
queryClient?: QueryClient,
|
|
1376
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1377
|
+
export function useGetRunningWorkflowsSuspense<
|
|
1378
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1379
|
+
TError = ErrorType<void>,
|
|
1380
|
+
>(
|
|
1381
|
+
params?: GetRunningWorkflowsParams,
|
|
1382
|
+
options?: {
|
|
1383
|
+
query?: Partial<
|
|
1384
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1385
|
+
>;
|
|
1386
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1387
|
+
},
|
|
1388
|
+
queryClient?: QueryClient,
|
|
1389
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1390
|
+
export function useGetRunningWorkflowsSuspense<
|
|
1391
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1392
|
+
TError = ErrorType<void>,
|
|
1393
|
+
>(
|
|
1394
|
+
params?: GetRunningWorkflowsParams,
|
|
1395
|
+
options?: {
|
|
1396
|
+
query?: Partial<
|
|
1397
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1398
|
+
>;
|
|
1399
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1400
|
+
},
|
|
1401
|
+
queryClient?: QueryClient,
|
|
1402
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
974
1403
|
/**
|
|
975
1404
|
* @summary Get all Running Workflows available to you
|
|
976
1405
|
*/
|
|
977
1406
|
|
|
978
|
-
export function useGetRunningWorkflowsSuspense<
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
1407
|
+
export function useGetRunningWorkflowsSuspense<
|
|
1408
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflows>>,
|
|
1409
|
+
TError = ErrorType<void>,
|
|
1410
|
+
>(
|
|
1411
|
+
params?: GetRunningWorkflowsParams,
|
|
1412
|
+
options?: {
|
|
1413
|
+
query?: Partial<
|
|
1414
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>
|
|
1415
|
+
>;
|
|
1416
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1417
|
+
},
|
|
1418
|
+
queryClient?: QueryClient,
|
|
1419
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1420
|
+
const queryOptions = useGetRunningWorkflowsSuspenseQueryOptions(params, options);
|
|
1421
|
+
|
|
1422
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
1423
|
+
TData,
|
|
1424
|
+
TError
|
|
1425
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1426
|
+
|
|
1427
|
+
query.queryKey = queryOptions.queryKey;
|
|
988
1428
|
|
|
989
1429
|
return query;
|
|
990
1430
|
}
|
|
991
1431
|
|
|
992
|
-
|
|
993
|
-
|
|
994
1432
|
/**
|
|
995
1433
|
* Get details of a specific Running Workflow available to you.
|
|
996
1434
|
|
|
997
1435
|
* @summary Get details of a specific Running Workflow
|
|
998
1436
|
*/
|
|
999
1437
|
export const getRunningWorkflow = (
|
|
1000
|
-
|
|
1001
|
-
|
|
1438
|
+
runningWorkflowId: string,
|
|
1439
|
+
options?: SecondParameter<typeof customInstance>,
|
|
1440
|
+
signal?: AbortSignal,
|
|
1002
1441
|
) => {
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1442
|
+
return customInstance<RunningWorkflowGetResponse>(
|
|
1443
|
+
{ url: `/running-workflow/${runningWorkflowId}`, method: "GET", signal },
|
|
1444
|
+
options,
|
|
1445
|
+
);
|
|
1446
|
+
};
|
|
1447
|
+
|
|
1448
|
+
export const getGetRunningWorkflowQueryKey = (runningWorkflowId: string) => {
|
|
1449
|
+
return [`/running-workflow/${runningWorkflowId}`] as const;
|
|
1450
|
+
};
|
|
1451
|
+
|
|
1452
|
+
export const useGetRunningWorkflowQueryOptions = <
|
|
1453
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1454
|
+
TError = ErrorType<void | DmError>,
|
|
1455
|
+
>(
|
|
1456
|
+
runningWorkflowId: string,
|
|
1457
|
+
options?: {
|
|
1458
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>;
|
|
1459
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1460
|
+
},
|
|
1018
1461
|
) => {
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
}
|
|
1034
|
-
|
|
1035
|
-
export type GetRunningWorkflowQueryResult = NonNullable<
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1462
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
1463
|
+
|
|
1464
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowQueryKey(runningWorkflowId);
|
|
1465
|
+
|
|
1466
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflow>>> = ({ signal }) =>
|
|
1467
|
+
getRunningWorkflow(runningWorkflowId, requestOptions, signal);
|
|
1468
|
+
|
|
1469
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
1470
|
+
|
|
1471
|
+
return customOptions as UseQueryOptions<
|
|
1472
|
+
Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1473
|
+
TError,
|
|
1474
|
+
TData
|
|
1475
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1476
|
+
};
|
|
1477
|
+
|
|
1478
|
+
export type GetRunningWorkflowQueryResult = NonNullable<
|
|
1479
|
+
Awaited<ReturnType<typeof getRunningWorkflow>>
|
|
1480
|
+
>;
|
|
1481
|
+
export type GetRunningWorkflowQueryError = ErrorType<void | DmError>;
|
|
1482
|
+
|
|
1483
|
+
export function useGetRunningWorkflow<
|
|
1484
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1485
|
+
TError = ErrorType<void | DmError>,
|
|
1486
|
+
>(
|
|
1487
|
+
runningWorkflowId: string,
|
|
1488
|
+
options: {
|
|
1489
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>> &
|
|
1490
|
+
Pick<
|
|
1041
1491
|
DefinedInitialDataOptions<
|
|
1042
1492
|
Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1043
1493
|
TError,
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1494
|
+
Awaited<ReturnType<typeof getRunningWorkflow>>
|
|
1495
|
+
>,
|
|
1496
|
+
"initialData"
|
|
1497
|
+
>;
|
|
1498
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1499
|
+
},
|
|
1500
|
+
queryClient?: QueryClient,
|
|
1501
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1502
|
+
export function useGetRunningWorkflow<
|
|
1503
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1504
|
+
TError = ErrorType<void | DmError>,
|
|
1505
|
+
>(
|
|
1506
|
+
runningWorkflowId: string,
|
|
1507
|
+
options?: {
|
|
1508
|
+
query?: Partial<
|
|
1509
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>
|
|
1510
|
+
> &
|
|
1511
|
+
Pick<
|
|
1051
1512
|
UndefinedInitialDataOptions<
|
|
1052
1513
|
Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1053
1514
|
TError,
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1515
|
+
Awaited<ReturnType<typeof getRunningWorkflow>>
|
|
1516
|
+
>,
|
|
1517
|
+
"initialData"
|
|
1518
|
+
>;
|
|
1519
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1520
|
+
},
|
|
1521
|
+
queryClient?: QueryClient,
|
|
1522
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1523
|
+
export function useGetRunningWorkflow<
|
|
1524
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1525
|
+
TError = ErrorType<void | DmError>,
|
|
1526
|
+
>(
|
|
1527
|
+
runningWorkflowId: string,
|
|
1528
|
+
options?: {
|
|
1529
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>;
|
|
1530
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1531
|
+
},
|
|
1532
|
+
queryClient?: QueryClient,
|
|
1533
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1063
1534
|
/**
|
|
1064
1535
|
* @summary Get details of a specific Running Workflow
|
|
1065
1536
|
*/
|
|
1066
1537
|
|
|
1067
|
-
export function useGetRunningWorkflow<
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1538
|
+
export function useGetRunningWorkflow<
|
|
1539
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1540
|
+
TError = ErrorType<void | DmError>,
|
|
1541
|
+
>(
|
|
1542
|
+
runningWorkflowId: string,
|
|
1543
|
+
options?: {
|
|
1544
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>;
|
|
1545
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1546
|
+
},
|
|
1547
|
+
queryClient?: QueryClient,
|
|
1548
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1549
|
+
const queryOptions = useGetRunningWorkflowQueryOptions(runningWorkflowId, options);
|
|
1550
|
+
|
|
1551
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
1552
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1553
|
+
};
|
|
1554
|
+
|
|
1555
|
+
query.queryKey = queryOptions.queryKey;
|
|
1077
1556
|
|
|
1078
1557
|
return query;
|
|
1079
1558
|
}
|
|
1080
1559
|
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1560
|
+
export const useGetRunningWorkflowSuspenseQueryOptions = <
|
|
1561
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1562
|
+
TError = ErrorType<void | DmError>,
|
|
1563
|
+
>(
|
|
1564
|
+
runningWorkflowId: string,
|
|
1565
|
+
options?: {
|
|
1566
|
+
query?: Partial<
|
|
1567
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>
|
|
1568
|
+
>;
|
|
1569
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1570
|
+
},
|
|
1084
1571
|
) => {
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
}
|
|
1100
|
-
|
|
1101
|
-
export type GetRunningWorkflowSuspenseQueryResult = NonNullable<
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1572
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
1573
|
+
|
|
1574
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowQueryKey(runningWorkflowId);
|
|
1575
|
+
|
|
1576
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflow>>> = ({ signal }) =>
|
|
1577
|
+
getRunningWorkflow(runningWorkflowId, requestOptions, signal);
|
|
1578
|
+
|
|
1579
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
1580
|
+
|
|
1581
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
1582
|
+
Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1583
|
+
TError,
|
|
1584
|
+
TData
|
|
1585
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1586
|
+
};
|
|
1587
|
+
|
|
1588
|
+
export type GetRunningWorkflowSuspenseQueryResult = NonNullable<
|
|
1589
|
+
Awaited<ReturnType<typeof getRunningWorkflow>>
|
|
1590
|
+
>;
|
|
1591
|
+
export type GetRunningWorkflowSuspenseQueryError = ErrorType<void | DmError>;
|
|
1592
|
+
|
|
1593
|
+
export function useGetRunningWorkflowSuspense<
|
|
1594
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1595
|
+
TError = ErrorType<void | DmError>,
|
|
1596
|
+
>(
|
|
1597
|
+
runningWorkflowId: string,
|
|
1598
|
+
options: {
|
|
1599
|
+
query: Partial<
|
|
1600
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>
|
|
1601
|
+
>;
|
|
1602
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1603
|
+
},
|
|
1604
|
+
queryClient?: QueryClient,
|
|
1605
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1606
|
+
export function useGetRunningWorkflowSuspense<
|
|
1607
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1608
|
+
TError = ErrorType<void | DmError>,
|
|
1609
|
+
>(
|
|
1610
|
+
runningWorkflowId: string,
|
|
1611
|
+
options?: {
|
|
1612
|
+
query?: Partial<
|
|
1613
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>
|
|
1614
|
+
>;
|
|
1615
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1616
|
+
},
|
|
1617
|
+
queryClient?: QueryClient,
|
|
1618
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1619
|
+
export function useGetRunningWorkflowSuspense<
|
|
1620
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1621
|
+
TError = ErrorType<void | DmError>,
|
|
1622
|
+
>(
|
|
1623
|
+
runningWorkflowId: string,
|
|
1624
|
+
options?: {
|
|
1625
|
+
query?: Partial<
|
|
1626
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>
|
|
1627
|
+
>;
|
|
1628
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1629
|
+
},
|
|
1630
|
+
queryClient?: QueryClient,
|
|
1631
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1117
1632
|
/**
|
|
1118
1633
|
* @summary Get details of a specific Running Workflow
|
|
1119
1634
|
*/
|
|
1120
1635
|
|
|
1121
|
-
export function useGetRunningWorkflowSuspense<
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1636
|
+
export function useGetRunningWorkflowSuspense<
|
|
1637
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflow>>,
|
|
1638
|
+
TError = ErrorType<void | DmError>,
|
|
1639
|
+
>(
|
|
1640
|
+
runningWorkflowId: string,
|
|
1641
|
+
options?: {
|
|
1642
|
+
query?: Partial<
|
|
1643
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>
|
|
1644
|
+
>;
|
|
1645
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1646
|
+
},
|
|
1647
|
+
queryClient?: QueryClient,
|
|
1648
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1649
|
+
const queryOptions = useGetRunningWorkflowSuspenseQueryOptions(runningWorkflowId, options);
|
|
1650
|
+
|
|
1651
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
1652
|
+
TData,
|
|
1653
|
+
TError
|
|
1654
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1655
|
+
|
|
1656
|
+
query.queryKey = queryOptions.queryKey;
|
|
1131
1657
|
|
|
1132
1658
|
return query;
|
|
1133
1659
|
}
|
|
1134
1660
|
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
1661
|
/**
|
|
1138
1662
|
* If the Running Workflow has stopped it is deleted.
|
|
1139
1663
|
|
|
1140
1664
|
* @summary Delete a Running Workflow
|
|
1141
1665
|
*/
|
|
1142
1666
|
export const deleteRunningWorkflow = (
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
return customInstance<void>(
|
|
1148
|
-
{url: `/running-workflow/${runningWorkflowId}`, method: 'DELETE'
|
|
1149
|
-
},
|
|
1150
|
-
options);
|
|
1151
|
-
}
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
export const getDeleteRunningWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof deleteRunningWorkflow>>, TError = ErrorType<void | DmError>,
|
|
1156
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
1667
|
+
runningWorkflowId: string,
|
|
1668
|
+
options?: SecondParameter<typeof customInstance>,
|
|
1157
1669
|
) => {
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1670
|
+
return customInstance<void>(
|
|
1671
|
+
{ url: `/running-workflow/${runningWorkflowId}`, method: "DELETE" },
|
|
1672
|
+
options,
|
|
1673
|
+
);
|
|
1674
|
+
};
|
|
1675
|
+
|
|
1676
|
+
export const useDeleteRunningWorkflowMutationOptions = <
|
|
1677
|
+
TError = ErrorType<void | DmError>,
|
|
1678
|
+
TContext = unknown,
|
|
1679
|
+
>(options?: {
|
|
1680
|
+
mutation?: UseMutationOptions<
|
|
1681
|
+
Awaited<ReturnType<typeof deleteRunningWorkflow>>,
|
|
1682
|
+
TError,
|
|
1683
|
+
{ runningWorkflowId: string },
|
|
1684
|
+
TContext
|
|
1685
|
+
>;
|
|
1686
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1687
|
+
}): UseMutationOptions<
|
|
1688
|
+
Awaited<ReturnType<typeof deleteRunningWorkflow>>,
|
|
1689
|
+
TError,
|
|
1690
|
+
{ runningWorkflowId: string },
|
|
1691
|
+
TContext
|
|
1692
|
+
> => {
|
|
1693
|
+
const mutationKey = ["deleteRunningWorkflow"];
|
|
1694
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
1695
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
1696
|
+
? options
|
|
1697
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
1698
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
1699
|
+
|
|
1700
|
+
const mutationFn: MutationFunction<
|
|
1701
|
+
Awaited<ReturnType<typeof deleteRunningWorkflow>>,
|
|
1702
|
+
{ runningWorkflowId: string }
|
|
1703
|
+
> = (props) => {
|
|
1704
|
+
const { runningWorkflowId } = props ?? {};
|
|
1705
|
+
|
|
1706
|
+
return deleteRunningWorkflow(runningWorkflowId, requestOptions);
|
|
1707
|
+
};
|
|
1708
|
+
|
|
1709
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
1710
|
+
|
|
1711
|
+
return customOptions;
|
|
1712
|
+
};
|
|
1713
|
+
|
|
1714
|
+
export type DeleteRunningWorkflowMutationResult = NonNullable<
|
|
1715
|
+
Awaited<ReturnType<typeof deleteRunningWorkflow>>
|
|
1716
|
+
>;
|
|
1717
|
+
|
|
1718
|
+
export type DeleteRunningWorkflowMutationError = ErrorType<void | DmError>;
|
|
1173
1719
|
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>}
|
|
1178
|
-
|
|
1179
|
-
export type DeleteRunningWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof deleteRunningWorkflow>>>
|
|
1180
|
-
|
|
1181
|
-
export type DeleteRunningWorkflowMutationError = ErrorType<void | DmError>
|
|
1182
|
-
|
|
1183
|
-
/**
|
|
1720
|
+
/**
|
|
1184
1721
|
* @summary Delete a Running Workflow
|
|
1185
1722
|
*/
|
|
1186
|
-
export const useDeleteRunningWorkflow = <
|
|
1187
|
-
|
|
1723
|
+
export const useDeleteRunningWorkflow = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
1724
|
+
options?: {
|
|
1725
|
+
mutation?: UseMutationOptions<
|
|
1726
|
+
Awaited<ReturnType<typeof deleteRunningWorkflow>>,
|
|
1727
|
+
TError,
|
|
1728
|
+
{ runningWorkflowId: string },
|
|
1729
|
+
TContext
|
|
1730
|
+
>;
|
|
1731
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1732
|
+
},
|
|
1733
|
+
queryClient?: QueryClient,
|
|
1188
1734
|
): UseMutationResult<
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
/**
|
|
1735
|
+
Awaited<ReturnType<typeof deleteRunningWorkflow>>,
|
|
1736
|
+
TError,
|
|
1737
|
+
{ runningWorkflowId: string },
|
|
1738
|
+
TContext
|
|
1739
|
+
> => {
|
|
1740
|
+
const mutationOptions = useDeleteRunningWorkflowMutationOptions(options);
|
|
1741
|
+
|
|
1742
|
+
return useMutation(mutationOptions, queryClient);
|
|
1743
|
+
};
|
|
1744
|
+
/**
|
|
1200
1745
|
* Stops a Running Workflow.
|
|
1201
1746
|
|
|
1202
1747
|
* @summary Stop a Running Workflow
|
|
1203
1748
|
*/
|
|
1204
1749
|
export const stopRunningWorkflow = (
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
return customInstance<void>(
|
|
1210
|
-
{url: `/running-workflow/${runningWorkflowId}/stop`, method: 'PUT'
|
|
1211
|
-
},
|
|
1212
|
-
options);
|
|
1213
|
-
}
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
export const getStopRunningWorkflowMutationOptions = <TData = Awaited<ReturnType<typeof stopRunningWorkflow>>, TError = ErrorType<void | DmError>,
|
|
1218
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
1750
|
+
runningWorkflowId: string,
|
|
1751
|
+
options?: SecondParameter<typeof customInstance>,
|
|
1219
1752
|
) => {
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1753
|
+
return customInstance<void>(
|
|
1754
|
+
{ url: `/running-workflow/${runningWorkflowId}/stop`, method: "PUT" },
|
|
1755
|
+
options,
|
|
1756
|
+
);
|
|
1757
|
+
};
|
|
1758
|
+
|
|
1759
|
+
export const useStopRunningWorkflowMutationOptions = <
|
|
1760
|
+
TError = ErrorType<void | DmError>,
|
|
1761
|
+
TContext = unknown,
|
|
1762
|
+
>(options?: {
|
|
1763
|
+
mutation?: UseMutationOptions<
|
|
1764
|
+
Awaited<ReturnType<typeof stopRunningWorkflow>>,
|
|
1765
|
+
TError,
|
|
1766
|
+
{ runningWorkflowId: string },
|
|
1767
|
+
TContext
|
|
1768
|
+
>;
|
|
1769
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1770
|
+
}): UseMutationOptions<
|
|
1771
|
+
Awaited<ReturnType<typeof stopRunningWorkflow>>,
|
|
1772
|
+
TError,
|
|
1773
|
+
{ runningWorkflowId: string },
|
|
1774
|
+
TContext
|
|
1775
|
+
> => {
|
|
1776
|
+
const mutationKey = ["stopRunningWorkflow"];
|
|
1777
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
1778
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
1779
|
+
? options
|
|
1780
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
1781
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
1782
|
+
|
|
1783
|
+
const mutationFn: MutationFunction<
|
|
1784
|
+
Awaited<ReturnType<typeof stopRunningWorkflow>>,
|
|
1785
|
+
{ runningWorkflowId: string }
|
|
1786
|
+
> = (props) => {
|
|
1787
|
+
const { runningWorkflowId } = props ?? {};
|
|
1788
|
+
|
|
1789
|
+
return stopRunningWorkflow(runningWorkflowId, requestOptions);
|
|
1790
|
+
};
|
|
1791
|
+
|
|
1792
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
1793
|
+
|
|
1794
|
+
return customOptions;
|
|
1795
|
+
};
|
|
1796
|
+
|
|
1797
|
+
export type StopRunningWorkflowMutationResult = NonNullable<
|
|
1798
|
+
Awaited<ReturnType<typeof stopRunningWorkflow>>
|
|
1799
|
+
>;
|
|
1800
|
+
|
|
1801
|
+
export type StopRunningWorkflowMutationError = ErrorType<void | DmError>;
|
|
1226
1802
|
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
const mutationFn: MutationFunction<Awaited<ReturnType<typeof stopRunningWorkflow>>, {runningWorkflowId: string}> = (props) => {
|
|
1231
|
-
const {runningWorkflowId} = props ?? {};
|
|
1232
|
-
|
|
1233
|
-
return stopRunningWorkflow(runningWorkflowId,requestOptions)
|
|
1234
|
-
}
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{runningWorkflowId: string}, TContext>}
|
|
1240
|
-
|
|
1241
|
-
export type StopRunningWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof stopRunningWorkflow>>>
|
|
1242
|
-
|
|
1243
|
-
export type StopRunningWorkflowMutationError = ErrorType<void | DmError>
|
|
1244
|
-
|
|
1245
|
-
/**
|
|
1803
|
+
/**
|
|
1246
1804
|
* @summary Stop a Running Workflow
|
|
1247
1805
|
*/
|
|
1248
|
-
export const useStopRunningWorkflow = <
|
|
1249
|
-
|
|
1806
|
+
export const useStopRunningWorkflow = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
1807
|
+
options?: {
|
|
1808
|
+
mutation?: UseMutationOptions<
|
|
1809
|
+
Awaited<ReturnType<typeof stopRunningWorkflow>>,
|
|
1810
|
+
TError,
|
|
1811
|
+
{ runningWorkflowId: string },
|
|
1812
|
+
TContext
|
|
1813
|
+
>;
|
|
1814
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1815
|
+
},
|
|
1816
|
+
queryClient?: QueryClient,
|
|
1250
1817
|
): UseMutationResult<
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
/**
|
|
1818
|
+
Awaited<ReturnType<typeof stopRunningWorkflow>>,
|
|
1819
|
+
TError,
|
|
1820
|
+
{ runningWorkflowId: string },
|
|
1821
|
+
TContext
|
|
1822
|
+
> => {
|
|
1823
|
+
const mutationOptions = useStopRunningWorkflowMutationOptions(options);
|
|
1824
|
+
|
|
1825
|
+
return useMutation(mutationOptions, queryClient);
|
|
1826
|
+
};
|
|
1827
|
+
/**
|
|
1262
1828
|
* 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.
|
|
1263
1829
|
|
|
1264
1830
|
* @summary Get all the Running Workflow Steps
|
|
1265
1831
|
*/
|
|
1266
1832
|
export const getRunningWorkflowSteps = (
|
|
1267
|
-
|
|
1268
|
-
|
|
1833
|
+
runningWorkflowId: string,
|
|
1834
|
+
options?: SecondParameter<typeof customInstance>,
|
|
1835
|
+
signal?: AbortSignal,
|
|
1269
1836
|
) => {
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1837
|
+
return customInstance<RunningWorkflowStepsGetResponse>(
|
|
1838
|
+
{ url: `/running-workflow/${runningWorkflowId}/steps`, method: "GET", signal },
|
|
1839
|
+
options,
|
|
1840
|
+
);
|
|
1841
|
+
};
|
|
1842
|
+
|
|
1843
|
+
export const getGetRunningWorkflowStepsQueryKey = (runningWorkflowId: string) => {
|
|
1844
|
+
return [`/running-workflow/${runningWorkflowId}/steps`] as const;
|
|
1845
|
+
};
|
|
1846
|
+
|
|
1847
|
+
export const useGetRunningWorkflowStepsQueryOptions = <
|
|
1848
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1849
|
+
TError = ErrorType<void | DmError>,
|
|
1850
|
+
>(
|
|
1851
|
+
runningWorkflowId: string,
|
|
1852
|
+
options?: {
|
|
1853
|
+
query?: Partial<
|
|
1854
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
1855
|
+
>;
|
|
1856
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1857
|
+
},
|
|
1285
1858
|
) => {
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
}
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
export type
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
export
|
|
1307
|
-
|
|
1859
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
1860
|
+
|
|
1861
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowStepsQueryKey(runningWorkflowId);
|
|
1862
|
+
|
|
1863
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflowSteps>>> = ({
|
|
1864
|
+
signal,
|
|
1865
|
+
}) => getRunningWorkflowSteps(runningWorkflowId, requestOptions, signal);
|
|
1866
|
+
|
|
1867
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
1868
|
+
|
|
1869
|
+
return customOptions as UseQueryOptions<
|
|
1870
|
+
Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1871
|
+
TError,
|
|
1872
|
+
TData
|
|
1873
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1874
|
+
};
|
|
1875
|
+
|
|
1876
|
+
export type GetRunningWorkflowStepsQueryResult = NonNullable<
|
|
1877
|
+
Awaited<ReturnType<typeof getRunningWorkflowSteps>>
|
|
1878
|
+
>;
|
|
1879
|
+
export type GetRunningWorkflowStepsQueryError = ErrorType<void | DmError>;
|
|
1880
|
+
|
|
1881
|
+
export function useGetRunningWorkflowSteps<
|
|
1882
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1883
|
+
TError = ErrorType<void | DmError>,
|
|
1884
|
+
>(
|
|
1885
|
+
runningWorkflowId: string,
|
|
1886
|
+
options: {
|
|
1887
|
+
query: Partial<
|
|
1888
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
1889
|
+
> &
|
|
1890
|
+
Pick<
|
|
1308
1891
|
DefinedInitialDataOptions<
|
|
1309
1892
|
Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1310
1893
|
TError,
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1894
|
+
Awaited<ReturnType<typeof getRunningWorkflowSteps>>
|
|
1895
|
+
>,
|
|
1896
|
+
"initialData"
|
|
1897
|
+
>;
|
|
1898
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1899
|
+
},
|
|
1900
|
+
queryClient?: QueryClient,
|
|
1901
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1902
|
+
export function useGetRunningWorkflowSteps<
|
|
1903
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1904
|
+
TError = ErrorType<void | DmError>,
|
|
1905
|
+
>(
|
|
1906
|
+
runningWorkflowId: string,
|
|
1907
|
+
options?: {
|
|
1908
|
+
query?: Partial<
|
|
1909
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
1910
|
+
> &
|
|
1911
|
+
Pick<
|
|
1318
1912
|
UndefinedInitialDataOptions<
|
|
1319
1913
|
Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1320
1914
|
TError,
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1915
|
+
Awaited<ReturnType<typeof getRunningWorkflowSteps>>
|
|
1916
|
+
>,
|
|
1917
|
+
"initialData"
|
|
1918
|
+
>;
|
|
1919
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1920
|
+
},
|
|
1921
|
+
queryClient?: QueryClient,
|
|
1922
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1923
|
+
export function useGetRunningWorkflowSteps<
|
|
1924
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1925
|
+
TError = ErrorType<void | DmError>,
|
|
1926
|
+
>(
|
|
1927
|
+
runningWorkflowId: string,
|
|
1928
|
+
options?: {
|
|
1929
|
+
query?: Partial<
|
|
1930
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
1931
|
+
>;
|
|
1932
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1933
|
+
},
|
|
1934
|
+
queryClient?: QueryClient,
|
|
1935
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1330
1936
|
/**
|
|
1331
1937
|
* @summary Get all the Running Workflow Steps
|
|
1332
1938
|
*/
|
|
1333
1939
|
|
|
1334
|
-
export function useGetRunningWorkflowSteps<
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1940
|
+
export function useGetRunningWorkflowSteps<
|
|
1941
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1942
|
+
TError = ErrorType<void | DmError>,
|
|
1943
|
+
>(
|
|
1944
|
+
runningWorkflowId: string,
|
|
1945
|
+
options?: {
|
|
1946
|
+
query?: Partial<
|
|
1947
|
+
UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
1948
|
+
>;
|
|
1949
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1950
|
+
},
|
|
1951
|
+
queryClient?: QueryClient,
|
|
1952
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1953
|
+
const queryOptions = useGetRunningWorkflowStepsQueryOptions(runningWorkflowId, options);
|
|
1954
|
+
|
|
1955
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
1956
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1957
|
+
};
|
|
1958
|
+
|
|
1959
|
+
query.queryKey = queryOptions.queryKey;
|
|
1344
1960
|
|
|
1345
1961
|
return query;
|
|
1346
1962
|
}
|
|
1347
1963
|
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1964
|
+
export const useGetRunningWorkflowStepsSuspenseQueryOptions = <
|
|
1965
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1966
|
+
TError = ErrorType<void | DmError>,
|
|
1967
|
+
>(
|
|
1968
|
+
runningWorkflowId: string,
|
|
1969
|
+
options?: {
|
|
1970
|
+
query?: Partial<
|
|
1971
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
1972
|
+
>;
|
|
1973
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1974
|
+
},
|
|
1351
1975
|
) => {
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
}
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
export type
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
export
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1976
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
1977
|
+
|
|
1978
|
+
const queryKey = queryOptions?.queryKey ?? getGetRunningWorkflowStepsQueryKey(runningWorkflowId);
|
|
1979
|
+
|
|
1980
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getRunningWorkflowSteps>>> = ({
|
|
1981
|
+
signal,
|
|
1982
|
+
}) => getRunningWorkflowSteps(runningWorkflowId, requestOptions, signal);
|
|
1983
|
+
|
|
1984
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
1985
|
+
|
|
1986
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
1987
|
+
Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
1988
|
+
TError,
|
|
1989
|
+
TData
|
|
1990
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1991
|
+
};
|
|
1992
|
+
|
|
1993
|
+
export type GetRunningWorkflowStepsSuspenseQueryResult = NonNullable<
|
|
1994
|
+
Awaited<ReturnType<typeof getRunningWorkflowSteps>>
|
|
1995
|
+
>;
|
|
1996
|
+
export type GetRunningWorkflowStepsSuspenseQueryError = ErrorType<void | DmError>;
|
|
1997
|
+
|
|
1998
|
+
export function useGetRunningWorkflowStepsSuspense<
|
|
1999
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
2000
|
+
TError = ErrorType<void | DmError>,
|
|
2001
|
+
>(
|
|
2002
|
+
runningWorkflowId: string,
|
|
2003
|
+
options: {
|
|
2004
|
+
query: Partial<
|
|
2005
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
2006
|
+
>;
|
|
2007
|
+
request?: SecondParameter<typeof customInstance>;
|
|
2008
|
+
},
|
|
2009
|
+
queryClient?: QueryClient,
|
|
2010
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
2011
|
+
export function useGetRunningWorkflowStepsSuspense<
|
|
2012
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
2013
|
+
TError = ErrorType<void | DmError>,
|
|
2014
|
+
>(
|
|
2015
|
+
runningWorkflowId: string,
|
|
2016
|
+
options?: {
|
|
2017
|
+
query?: Partial<
|
|
2018
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
2019
|
+
>;
|
|
2020
|
+
request?: SecondParameter<typeof customInstance>;
|
|
2021
|
+
},
|
|
2022
|
+
queryClient?: QueryClient,
|
|
2023
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
2024
|
+
export function useGetRunningWorkflowStepsSuspense<
|
|
2025
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
2026
|
+
TError = ErrorType<void | DmError>,
|
|
2027
|
+
>(
|
|
2028
|
+
runningWorkflowId: string,
|
|
2029
|
+
options?: {
|
|
2030
|
+
query?: Partial<
|
|
2031
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
2032
|
+
>;
|
|
2033
|
+
request?: SecondParameter<typeof customInstance>;
|
|
2034
|
+
},
|
|
2035
|
+
queryClient?: QueryClient,
|
|
2036
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1384
2037
|
/**
|
|
1385
2038
|
* @summary Get all the Running Workflow Steps
|
|
1386
2039
|
*/
|
|
1387
2040
|
|
|
1388
|
-
export function useGetRunningWorkflowStepsSuspense<
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
2041
|
+
export function useGetRunningWorkflowStepsSuspense<
|
|
2042
|
+
TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>,
|
|
2043
|
+
TError = ErrorType<void | DmError>,
|
|
2044
|
+
>(
|
|
2045
|
+
runningWorkflowId: string,
|
|
2046
|
+
options?: {
|
|
2047
|
+
query?: Partial<
|
|
2048
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>
|
|
2049
|
+
>;
|
|
2050
|
+
request?: SecondParameter<typeof customInstance>;
|
|
2051
|
+
},
|
|
2052
|
+
queryClient?: QueryClient,
|
|
2053
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
2054
|
+
const queryOptions = useGetRunningWorkflowStepsSuspenseQueryOptions(runningWorkflowId, options);
|
|
2055
|
+
|
|
2056
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
2057
|
+
TData,
|
|
2058
|
+
TError
|
|
2059
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
2060
|
+
|
|
2061
|
+
query.queryKey = queryOptions.queryKey;
|
|
1398
2062
|
|
|
1399
2063
|
return query;
|
|
1400
2064
|
}
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|