@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/admin/admin.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
|
AdminDeleteJobManifestParams,
|
|
34
31
|
AdminGetServiceErrorsParams,
|
|
@@ -40,14 +37,15 @@ import type {
|
|
|
40
37
|
JobManifestPutBodyBody,
|
|
41
38
|
ServiceErrorsGetResponse,
|
|
42
39
|
UserAccountDetail,
|
|
43
|
-
UserPatchBodyBody
|
|
44
|
-
} from
|
|
45
|
-
import { customInstance } from '.././custom-instance';
|
|
46
|
-
import type { ErrorType } from '.././custom-instance';
|
|
47
|
-
|
|
40
|
+
UserPatchBodyBody,
|
|
41
|
+
} from "../data-manager-api.schemas";
|
|
48
42
|
|
|
49
|
-
|
|
43
|
+
import { customInstance } from ".././custom-instance";
|
|
44
|
+
import type { ErrorType } from ".././custom-instance";
|
|
45
|
+
import { queryMutator } from ".././options-mutator";
|
|
46
|
+
import { mutationMutator } from ".././options-mutator";
|
|
50
47
|
|
|
48
|
+
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
51
49
|
|
|
52
50
|
/**
|
|
53
51
|
* Displays the existing Service Errors, which can also include acknowledged errors, normally excluded from the list.
|
|
@@ -57,144 +55,237 @@ You will need `admin` rights to use this endpoint
|
|
|
57
55
|
* @summary Gets Service Errors
|
|
58
56
|
*/
|
|
59
57
|
export const adminGetServiceErrors = (
|
|
60
|
-
|
|
61
|
-
|
|
58
|
+
params?: AdminGetServiceErrorsParams,
|
|
59
|
+
options?: SecondParameter<typeof customInstance>,
|
|
60
|
+
signal?: AbortSignal,
|
|
62
61
|
) => {
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
export const
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
62
|
+
return customInstance<ServiceErrorsGetResponse>(
|
|
63
|
+
{ url: `/admin/service-error`, method: "GET", params, signal },
|
|
64
|
+
options,
|
|
65
|
+
);
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
export const getAdminGetServiceErrorsQueryKey = (params?: AdminGetServiceErrorsParams) => {
|
|
69
|
+
return [`/admin/service-error`, ...(params ? [params] : [])] as const;
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
export const useAdminGetServiceErrorsQueryOptions = <
|
|
73
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
74
|
+
TError = ErrorType<void | DmError>,
|
|
75
|
+
>(
|
|
76
|
+
params?: AdminGetServiceErrorsParams,
|
|
77
|
+
options?: {
|
|
78
|
+
query?: Partial<
|
|
79
|
+
UseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
80
|
+
>;
|
|
81
|
+
request?: SecondParameter<typeof customInstance>;
|
|
82
|
+
},
|
|
79
83
|
) => {
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
export type AdminGetServiceErrorsQueryResult = NonNullable<
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
84
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
85
|
+
|
|
86
|
+
const queryKey = queryOptions?.queryKey ?? getAdminGetServiceErrorsQueryKey(params);
|
|
87
|
+
|
|
88
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof adminGetServiceErrors>>> = ({ signal }) =>
|
|
89
|
+
adminGetServiceErrors(params, requestOptions, signal);
|
|
90
|
+
|
|
91
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
92
|
+
|
|
93
|
+
return customOptions as UseQueryOptions<
|
|
94
|
+
Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
95
|
+
TError,
|
|
96
|
+
TData
|
|
97
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
98
|
+
};
|
|
99
|
+
|
|
100
|
+
export type AdminGetServiceErrorsQueryResult = NonNullable<
|
|
101
|
+
Awaited<ReturnType<typeof adminGetServiceErrors>>
|
|
102
|
+
>;
|
|
103
|
+
export type AdminGetServiceErrorsQueryError = ErrorType<void | DmError>;
|
|
104
|
+
|
|
105
|
+
export function useAdminGetServiceErrors<
|
|
106
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
107
|
+
TError = ErrorType<void | DmError>,
|
|
108
|
+
>(
|
|
109
|
+
params: undefined | AdminGetServiceErrorsParams,
|
|
110
|
+
options: {
|
|
111
|
+
query: Partial<
|
|
112
|
+
UseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
113
|
+
> &
|
|
114
|
+
Pick<
|
|
102
115
|
DefinedInitialDataOptions<
|
|
103
116
|
Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
104
117
|
TError,
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
118
|
+
Awaited<ReturnType<typeof adminGetServiceErrors>>
|
|
119
|
+
>,
|
|
120
|
+
"initialData"
|
|
121
|
+
>;
|
|
122
|
+
request?: SecondParameter<typeof customInstance>;
|
|
123
|
+
},
|
|
124
|
+
queryClient?: QueryClient,
|
|
125
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
126
|
+
export function useAdminGetServiceErrors<
|
|
127
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
128
|
+
TError = ErrorType<void | DmError>,
|
|
129
|
+
>(
|
|
130
|
+
params?: AdminGetServiceErrorsParams,
|
|
131
|
+
options?: {
|
|
132
|
+
query?: Partial<
|
|
133
|
+
UseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
134
|
+
> &
|
|
135
|
+
Pick<
|
|
112
136
|
UndefinedInitialDataOptions<
|
|
113
137
|
Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
114
138
|
TError,
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
139
|
+
Awaited<ReturnType<typeof adminGetServiceErrors>>
|
|
140
|
+
>,
|
|
141
|
+
"initialData"
|
|
142
|
+
>;
|
|
143
|
+
request?: SecondParameter<typeof customInstance>;
|
|
144
|
+
},
|
|
145
|
+
queryClient?: QueryClient,
|
|
146
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
147
|
+
export function useAdminGetServiceErrors<
|
|
148
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
149
|
+
TError = ErrorType<void | DmError>,
|
|
150
|
+
>(
|
|
151
|
+
params?: AdminGetServiceErrorsParams,
|
|
152
|
+
options?: {
|
|
153
|
+
query?: Partial<
|
|
154
|
+
UseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
155
|
+
>;
|
|
156
|
+
request?: SecondParameter<typeof customInstance>;
|
|
157
|
+
},
|
|
158
|
+
queryClient?: QueryClient,
|
|
159
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
124
160
|
/**
|
|
125
161
|
* @summary Gets Service Errors
|
|
126
162
|
*/
|
|
127
163
|
|
|
128
|
-
export function useAdminGetServiceErrors<
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
164
|
+
export function useAdminGetServiceErrors<
|
|
165
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
166
|
+
TError = ErrorType<void | DmError>,
|
|
167
|
+
>(
|
|
168
|
+
params?: AdminGetServiceErrorsParams,
|
|
169
|
+
options?: {
|
|
170
|
+
query?: Partial<
|
|
171
|
+
UseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
172
|
+
>;
|
|
173
|
+
request?: SecondParameter<typeof customInstance>;
|
|
174
|
+
},
|
|
175
|
+
queryClient?: QueryClient,
|
|
176
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
177
|
+
const queryOptions = useAdminGetServiceErrorsQueryOptions(params, options);
|
|
178
|
+
|
|
179
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
180
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
181
|
+
};
|
|
182
|
+
|
|
183
|
+
query.queryKey = queryOptions.queryKey;
|
|
138
184
|
|
|
139
185
|
return query;
|
|
140
186
|
}
|
|
141
187
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
188
|
+
export const useAdminGetServiceErrorsSuspenseQueryOptions = <
|
|
189
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
190
|
+
TError = ErrorType<void | DmError>,
|
|
191
|
+
>(
|
|
192
|
+
params?: AdminGetServiceErrorsParams,
|
|
193
|
+
options?: {
|
|
194
|
+
query?: Partial<
|
|
195
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
196
|
+
>;
|
|
197
|
+
request?: SecondParameter<typeof customInstance>;
|
|
198
|
+
},
|
|
145
199
|
) => {
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
export type AdminGetServiceErrorsSuspenseQueryResult = NonNullable<
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
200
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
201
|
+
|
|
202
|
+
const queryKey = queryOptions?.queryKey ?? getAdminGetServiceErrorsQueryKey(params);
|
|
203
|
+
|
|
204
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof adminGetServiceErrors>>> = ({ signal }) =>
|
|
205
|
+
adminGetServiceErrors(params, requestOptions, signal);
|
|
206
|
+
|
|
207
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
208
|
+
|
|
209
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
210
|
+
Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
211
|
+
TError,
|
|
212
|
+
TData
|
|
213
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
214
|
+
};
|
|
215
|
+
|
|
216
|
+
export type AdminGetServiceErrorsSuspenseQueryResult = NonNullable<
|
|
217
|
+
Awaited<ReturnType<typeof adminGetServiceErrors>>
|
|
218
|
+
>;
|
|
219
|
+
export type AdminGetServiceErrorsSuspenseQueryError = ErrorType<void | DmError>;
|
|
220
|
+
|
|
221
|
+
export function useAdminGetServiceErrorsSuspense<
|
|
222
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
223
|
+
TError = ErrorType<void | DmError>,
|
|
224
|
+
>(
|
|
225
|
+
params: undefined | AdminGetServiceErrorsParams,
|
|
226
|
+
options: {
|
|
227
|
+
query: Partial<
|
|
228
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
229
|
+
>;
|
|
230
|
+
request?: SecondParameter<typeof customInstance>;
|
|
231
|
+
},
|
|
232
|
+
queryClient?: QueryClient,
|
|
233
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
234
|
+
export function useAdminGetServiceErrorsSuspense<
|
|
235
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
236
|
+
TError = ErrorType<void | DmError>,
|
|
237
|
+
>(
|
|
238
|
+
params?: AdminGetServiceErrorsParams,
|
|
239
|
+
options?: {
|
|
240
|
+
query?: Partial<
|
|
241
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
242
|
+
>;
|
|
243
|
+
request?: SecondParameter<typeof customInstance>;
|
|
244
|
+
},
|
|
245
|
+
queryClient?: QueryClient,
|
|
246
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
247
|
+
export function useAdminGetServiceErrorsSuspense<
|
|
248
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
249
|
+
TError = ErrorType<void | DmError>,
|
|
250
|
+
>(
|
|
251
|
+
params?: AdminGetServiceErrorsParams,
|
|
252
|
+
options?: {
|
|
253
|
+
query?: Partial<
|
|
254
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
255
|
+
>;
|
|
256
|
+
request?: SecondParameter<typeof customInstance>;
|
|
257
|
+
},
|
|
258
|
+
queryClient?: QueryClient,
|
|
259
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
178
260
|
/**
|
|
179
261
|
* @summary Gets Service Errors
|
|
180
262
|
*/
|
|
181
263
|
|
|
182
|
-
export function useAdminGetServiceErrorsSuspense<
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
264
|
+
export function useAdminGetServiceErrorsSuspense<
|
|
265
|
+
TData = Awaited<ReturnType<typeof adminGetServiceErrors>>,
|
|
266
|
+
TError = ErrorType<void | DmError>,
|
|
267
|
+
>(
|
|
268
|
+
params?: AdminGetServiceErrorsParams,
|
|
269
|
+
options?: {
|
|
270
|
+
query?: Partial<
|
|
271
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>
|
|
272
|
+
>;
|
|
273
|
+
request?: SecondParameter<typeof customInstance>;
|
|
274
|
+
},
|
|
275
|
+
queryClient?: QueryClient,
|
|
276
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
277
|
+
const queryOptions = useAdminGetServiceErrorsSuspenseQueryOptions(params, options);
|
|
278
|
+
|
|
279
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
280
|
+
TData,
|
|
281
|
+
TError
|
|
282
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
283
|
+
|
|
284
|
+
query.queryKey = queryOptions.queryKey;
|
|
192
285
|
|
|
193
286
|
return query;
|
|
194
287
|
}
|
|
195
288
|
|
|
196
|
-
|
|
197
|
-
|
|
198
289
|
/**
|
|
199
290
|
* Used primarily to 'Acknowledge' but not delete a Service Error.
|
|
200
291
|
|
|
@@ -203,63 +294,81 @@ You will need `admin` rights to use this endpoint
|
|
|
203
294
|
* @summary Patches a Service Error
|
|
204
295
|
*/
|
|
205
296
|
export const adminPatchServiceError = (
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
return customInstance<void>(
|
|
211
|
-
{url: `/admin/service-error/${errorId}`, method: 'PATCH'
|
|
212
|
-
},
|
|
213
|
-
options);
|
|
214
|
-
}
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
export const getAdminPatchServiceErrorMutationOptions = <TData = Awaited<ReturnType<typeof adminPatchServiceError>>, TError = ErrorType<void | DmError>,
|
|
219
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{errorId: number}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
297
|
+
errorId: number,
|
|
298
|
+
options?: SecondParameter<typeof customInstance>,
|
|
220
299
|
) => {
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
300
|
+
return customInstance<void>({ url: `/admin/service-error/${errorId}`, method: "PATCH" }, options);
|
|
301
|
+
};
|
|
302
|
+
|
|
303
|
+
export const useAdminPatchServiceErrorMutationOptions = <
|
|
304
|
+
TError = ErrorType<void | DmError>,
|
|
305
|
+
TContext = unknown,
|
|
306
|
+
>(options?: {
|
|
307
|
+
mutation?: UseMutationOptions<
|
|
308
|
+
Awaited<ReturnType<typeof adminPatchServiceError>>,
|
|
309
|
+
TError,
|
|
310
|
+
{ errorId: number },
|
|
311
|
+
TContext
|
|
312
|
+
>;
|
|
313
|
+
request?: SecondParameter<typeof customInstance>;
|
|
314
|
+
}): UseMutationOptions<
|
|
315
|
+
Awaited<ReturnType<typeof adminPatchServiceError>>,
|
|
316
|
+
TError,
|
|
317
|
+
{ errorId: number },
|
|
318
|
+
TContext
|
|
319
|
+
> => {
|
|
320
|
+
const mutationKey = ["adminPatchServiceError"];
|
|
321
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
322
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
323
|
+
? options
|
|
324
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
325
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
326
|
+
|
|
327
|
+
const mutationFn: MutationFunction<
|
|
328
|
+
Awaited<ReturnType<typeof adminPatchServiceError>>,
|
|
329
|
+
{ errorId: number }
|
|
330
|
+
> = (props) => {
|
|
331
|
+
const { errorId } = props ?? {};
|
|
332
|
+
|
|
333
|
+
return adminPatchServiceError(errorId, requestOptions);
|
|
334
|
+
};
|
|
335
|
+
|
|
336
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
337
|
+
|
|
338
|
+
return customOptions;
|
|
339
|
+
};
|
|
340
|
+
|
|
341
|
+
export type AdminPatchServiceErrorMutationResult = NonNullable<
|
|
342
|
+
Awaited<ReturnType<typeof adminPatchServiceError>>
|
|
343
|
+
>;
|
|
344
|
+
|
|
345
|
+
export type AdminPatchServiceErrorMutationError = ErrorType<void | DmError>;
|
|
227
346
|
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
const mutationFn: MutationFunction<Awaited<ReturnType<typeof adminPatchServiceError>>, {errorId: number}> = (props) => {
|
|
232
|
-
const {errorId} = props ?? {};
|
|
233
|
-
|
|
234
|
-
return adminPatchServiceError(errorId,requestOptions)
|
|
235
|
-
}
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{errorId: number}, TContext>}
|
|
241
|
-
|
|
242
|
-
export type AdminPatchServiceErrorMutationResult = NonNullable<Awaited<ReturnType<typeof adminPatchServiceError>>>
|
|
243
|
-
|
|
244
|
-
export type AdminPatchServiceErrorMutationError = ErrorType<void | DmError>
|
|
245
|
-
|
|
246
|
-
/**
|
|
347
|
+
/**
|
|
247
348
|
* @summary Patches a Service Error
|
|
248
349
|
*/
|
|
249
|
-
export const useAdminPatchServiceError = <
|
|
250
|
-
|
|
350
|
+
export const useAdminPatchServiceError = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
351
|
+
options?: {
|
|
352
|
+
mutation?: UseMutationOptions<
|
|
353
|
+
Awaited<ReturnType<typeof adminPatchServiceError>>,
|
|
354
|
+
TError,
|
|
355
|
+
{ errorId: number },
|
|
356
|
+
TContext
|
|
357
|
+
>;
|
|
358
|
+
request?: SecondParameter<typeof customInstance>;
|
|
359
|
+
},
|
|
360
|
+
queryClient?: QueryClient,
|
|
251
361
|
): UseMutationResult<
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
/**
|
|
362
|
+
Awaited<ReturnType<typeof adminPatchServiceError>>,
|
|
363
|
+
TError,
|
|
364
|
+
{ errorId: number },
|
|
365
|
+
TContext
|
|
366
|
+
> => {
|
|
367
|
+
const mutationOptions = useAdminPatchServiceErrorMutationOptions(options);
|
|
368
|
+
|
|
369
|
+
return useMutation(mutationOptions, queryClient);
|
|
370
|
+
};
|
|
371
|
+
/**
|
|
263
372
|
* Deletes an existing Service Error.
|
|
264
373
|
|
|
265
374
|
You will need `admin` rights to use this endpoint
|
|
@@ -267,206 +376,308 @@ You will need `admin` rights to use this endpoint
|
|
|
267
376
|
* @summary Deletes a Service Error
|
|
268
377
|
*/
|
|
269
378
|
export const adminDeleteServiceError = (
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
return customInstance<void>(
|
|
275
|
-
{url: `/admin/service-error/${errorId}`, method: 'DELETE'
|
|
276
|
-
},
|
|
277
|
-
options);
|
|
278
|
-
}
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
export const getAdminDeleteServiceErrorMutationOptions = <TData = Awaited<ReturnType<typeof adminDeleteServiceError>>, TError = ErrorType<void | DmError>,
|
|
283
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{errorId: number}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
379
|
+
errorId: number,
|
|
380
|
+
options?: SecondParameter<typeof customInstance>,
|
|
284
381
|
) => {
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
382
|
+
return customInstance<void>(
|
|
383
|
+
{ url: `/admin/service-error/${errorId}`, method: "DELETE" },
|
|
384
|
+
options,
|
|
385
|
+
);
|
|
386
|
+
};
|
|
387
|
+
|
|
388
|
+
export const useAdminDeleteServiceErrorMutationOptions = <
|
|
389
|
+
TError = ErrorType<void | DmError>,
|
|
390
|
+
TContext = unknown,
|
|
391
|
+
>(options?: {
|
|
392
|
+
mutation?: UseMutationOptions<
|
|
393
|
+
Awaited<ReturnType<typeof adminDeleteServiceError>>,
|
|
394
|
+
TError,
|
|
395
|
+
{ errorId: number },
|
|
396
|
+
TContext
|
|
397
|
+
>;
|
|
398
|
+
request?: SecondParameter<typeof customInstance>;
|
|
399
|
+
}): UseMutationOptions<
|
|
400
|
+
Awaited<ReturnType<typeof adminDeleteServiceError>>,
|
|
401
|
+
TError,
|
|
402
|
+
{ errorId: number },
|
|
403
|
+
TContext
|
|
404
|
+
> => {
|
|
405
|
+
const mutationKey = ["adminDeleteServiceError"];
|
|
406
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
407
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
408
|
+
? options
|
|
409
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
410
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
411
|
+
|
|
412
|
+
const mutationFn: MutationFunction<
|
|
413
|
+
Awaited<ReturnType<typeof adminDeleteServiceError>>,
|
|
414
|
+
{ errorId: number }
|
|
415
|
+
> = (props) => {
|
|
416
|
+
const { errorId } = props ?? {};
|
|
417
|
+
|
|
418
|
+
return adminDeleteServiceError(errorId, requestOptions);
|
|
419
|
+
};
|
|
420
|
+
|
|
421
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
422
|
+
|
|
423
|
+
return customOptions;
|
|
424
|
+
};
|
|
425
|
+
|
|
426
|
+
export type AdminDeleteServiceErrorMutationResult = NonNullable<
|
|
427
|
+
Awaited<ReturnType<typeof adminDeleteServiceError>>
|
|
428
|
+
>;
|
|
429
|
+
|
|
430
|
+
export type AdminDeleteServiceErrorMutationError = ErrorType<void | DmError>;
|
|
291
431
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
const mutationFn: MutationFunction<Awaited<ReturnType<typeof adminDeleteServiceError>>, {errorId: number}> = (props) => {
|
|
296
|
-
const {errorId} = props ?? {};
|
|
297
|
-
|
|
298
|
-
return adminDeleteServiceError(errorId,requestOptions)
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{errorId: number}, TContext>}
|
|
305
|
-
|
|
306
|
-
export type AdminDeleteServiceErrorMutationResult = NonNullable<Awaited<ReturnType<typeof adminDeleteServiceError>>>
|
|
307
|
-
|
|
308
|
-
export type AdminDeleteServiceErrorMutationError = ErrorType<void | DmError>
|
|
309
|
-
|
|
310
|
-
/**
|
|
432
|
+
/**
|
|
311
433
|
* @summary Deletes a Service Error
|
|
312
434
|
*/
|
|
313
|
-
export const useAdminDeleteServiceError = <
|
|
314
|
-
|
|
435
|
+
export const useAdminDeleteServiceError = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
436
|
+
options?: {
|
|
437
|
+
mutation?: UseMutationOptions<
|
|
438
|
+
Awaited<ReturnType<typeof adminDeleteServiceError>>,
|
|
439
|
+
TError,
|
|
440
|
+
{ errorId: number },
|
|
441
|
+
TContext
|
|
442
|
+
>;
|
|
443
|
+
request?: SecondParameter<typeof customInstance>;
|
|
444
|
+
},
|
|
445
|
+
queryClient?: QueryClient,
|
|
315
446
|
): UseMutationResult<
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
/**
|
|
447
|
+
Awaited<ReturnType<typeof adminDeleteServiceError>>,
|
|
448
|
+
TError,
|
|
449
|
+
{ errorId: number },
|
|
450
|
+
TContext
|
|
451
|
+
> => {
|
|
452
|
+
const mutationOptions = useAdminDeleteServiceErrorMutationOptions(options);
|
|
453
|
+
|
|
454
|
+
return useMutation(mutationOptions, queryClient);
|
|
455
|
+
};
|
|
456
|
+
/**
|
|
327
457
|
* You need admin privileges to use this endpoint and you are excluded from the returned list of users
|
|
328
458
|
|
|
329
459
|
* @summary Get detailed information about all known Users
|
|
330
460
|
*/
|
|
331
461
|
export const adminGetUsers = (
|
|
332
|
-
|
|
333
|
-
|
|
462
|
+
params?: AdminGetUsersParams,
|
|
463
|
+
options?: SecondParameter<typeof customInstance>,
|
|
464
|
+
signal?: AbortSignal,
|
|
334
465
|
) => {
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
export const
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
466
|
+
return customInstance<AdminUsersGetResponse>(
|
|
467
|
+
{ url: `/admin/user`, method: "GET", params, signal },
|
|
468
|
+
options,
|
|
469
|
+
);
|
|
470
|
+
};
|
|
471
|
+
|
|
472
|
+
export const getAdminGetUsersQueryKey = (params?: AdminGetUsersParams) => {
|
|
473
|
+
return [`/admin/user`, ...(params ? [params] : [])] as const;
|
|
474
|
+
};
|
|
475
|
+
|
|
476
|
+
export const useAdminGetUsersQueryOptions = <
|
|
477
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
478
|
+
TError = ErrorType<void | DmError>,
|
|
479
|
+
>(
|
|
480
|
+
params?: AdminGetUsersParams,
|
|
481
|
+
options?: {
|
|
482
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>>;
|
|
483
|
+
request?: SecondParameter<typeof customInstance>;
|
|
484
|
+
},
|
|
351
485
|
) => {
|
|
486
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
352
487
|
|
|
353
|
-
const
|
|
354
|
-
|
|
355
|
-
const queryKey = queryOptions?.queryKey ?? getAdminGetUsersQueryKey(params);
|
|
488
|
+
const queryKey = queryOptions?.queryKey ?? getAdminGetUsersQueryKey(params);
|
|
356
489
|
|
|
357
|
-
|
|
490
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof adminGetUsers>>> = ({ signal }) =>
|
|
491
|
+
adminGetUsers(params, requestOptions, signal);
|
|
358
492
|
|
|
359
|
-
|
|
493
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
360
494
|
|
|
361
|
-
|
|
495
|
+
return customOptions as UseQueryOptions<
|
|
496
|
+
Awaited<ReturnType<typeof adminGetUsers>>,
|
|
497
|
+
TError,
|
|
498
|
+
TData
|
|
499
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
500
|
+
};
|
|
362
501
|
|
|
363
|
-
|
|
502
|
+
export type AdminGetUsersQueryResult = NonNullable<Awaited<ReturnType<typeof adminGetUsers>>>;
|
|
503
|
+
export type AdminGetUsersQueryError = ErrorType<void | DmError>;
|
|
364
504
|
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
params: undefined | AdminGetUsersParams, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>> & Pick<
|
|
505
|
+
export function useAdminGetUsers<
|
|
506
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
507
|
+
TError = ErrorType<void | DmError>,
|
|
508
|
+
>(
|
|
509
|
+
params: undefined | AdminGetUsersParams,
|
|
510
|
+
options: {
|
|
511
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>> &
|
|
512
|
+
Pick<
|
|
374
513
|
DefinedInitialDataOptions<
|
|
375
514
|
Awaited<ReturnType<typeof adminGetUsers>>,
|
|
376
515
|
TError,
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
516
|
+
Awaited<ReturnType<typeof adminGetUsers>>
|
|
517
|
+
>,
|
|
518
|
+
"initialData"
|
|
519
|
+
>;
|
|
520
|
+
request?: SecondParameter<typeof customInstance>;
|
|
521
|
+
},
|
|
522
|
+
queryClient?: QueryClient,
|
|
523
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
524
|
+
export function useAdminGetUsers<
|
|
525
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
526
|
+
TError = ErrorType<void | DmError>,
|
|
527
|
+
>(
|
|
528
|
+
params?: AdminGetUsersParams,
|
|
529
|
+
options?: {
|
|
530
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>> &
|
|
531
|
+
Pick<
|
|
384
532
|
UndefinedInitialDataOptions<
|
|
385
533
|
Awaited<ReturnType<typeof adminGetUsers>>,
|
|
386
534
|
TError,
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
535
|
+
Awaited<ReturnType<typeof adminGetUsers>>
|
|
536
|
+
>,
|
|
537
|
+
"initialData"
|
|
538
|
+
>;
|
|
539
|
+
request?: SecondParameter<typeof customInstance>;
|
|
540
|
+
},
|
|
541
|
+
queryClient?: QueryClient,
|
|
542
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
543
|
+
export function useAdminGetUsers<
|
|
544
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
545
|
+
TError = ErrorType<void | DmError>,
|
|
546
|
+
>(
|
|
547
|
+
params?: AdminGetUsersParams,
|
|
548
|
+
options?: {
|
|
549
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>>;
|
|
550
|
+
request?: SecondParameter<typeof customInstance>;
|
|
551
|
+
},
|
|
552
|
+
queryClient?: QueryClient,
|
|
553
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
396
554
|
/**
|
|
397
555
|
* @summary Get detailed information about all known Users
|
|
398
556
|
*/
|
|
399
557
|
|
|
400
|
-
export function useAdminGetUsers<
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
558
|
+
export function useAdminGetUsers<
|
|
559
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
560
|
+
TError = ErrorType<void | DmError>,
|
|
561
|
+
>(
|
|
562
|
+
params?: AdminGetUsersParams,
|
|
563
|
+
options?: {
|
|
564
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>>;
|
|
565
|
+
request?: SecondParameter<typeof customInstance>;
|
|
566
|
+
},
|
|
567
|
+
queryClient?: QueryClient,
|
|
568
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
569
|
+
const queryOptions = useAdminGetUsersQueryOptions(params, options);
|
|
570
|
+
|
|
571
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
572
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
573
|
+
};
|
|
574
|
+
|
|
575
|
+
query.queryKey = queryOptions.queryKey;
|
|
410
576
|
|
|
411
577
|
return query;
|
|
412
578
|
}
|
|
413
579
|
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
580
|
+
export const useAdminGetUsersSuspenseQueryOptions = <
|
|
581
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
582
|
+
TError = ErrorType<void | DmError>,
|
|
583
|
+
>(
|
|
584
|
+
params?: AdminGetUsersParams,
|
|
585
|
+
options?: {
|
|
586
|
+
query?: Partial<
|
|
587
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>
|
|
588
|
+
>;
|
|
589
|
+
request?: SecondParameter<typeof customInstance>;
|
|
590
|
+
},
|
|
417
591
|
) => {
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
}
|
|
433
|
-
|
|
434
|
-
export type AdminGetUsersSuspenseQueryResult = NonNullable<
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
592
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
593
|
+
|
|
594
|
+
const queryKey = queryOptions?.queryKey ?? getAdminGetUsersQueryKey(params);
|
|
595
|
+
|
|
596
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof adminGetUsers>>> = ({ signal }) =>
|
|
597
|
+
adminGetUsers(params, requestOptions, signal);
|
|
598
|
+
|
|
599
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
600
|
+
|
|
601
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
602
|
+
Awaited<ReturnType<typeof adminGetUsers>>,
|
|
603
|
+
TError,
|
|
604
|
+
TData
|
|
605
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
606
|
+
};
|
|
607
|
+
|
|
608
|
+
export type AdminGetUsersSuspenseQueryResult = NonNullable<
|
|
609
|
+
Awaited<ReturnType<typeof adminGetUsers>>
|
|
610
|
+
>;
|
|
611
|
+
export type AdminGetUsersSuspenseQueryError = ErrorType<void | DmError>;
|
|
612
|
+
|
|
613
|
+
export function useAdminGetUsersSuspense<
|
|
614
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
615
|
+
TError = ErrorType<void | DmError>,
|
|
616
|
+
>(
|
|
617
|
+
params: undefined | AdminGetUsersParams,
|
|
618
|
+
options: {
|
|
619
|
+
query: Partial<
|
|
620
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>
|
|
621
|
+
>;
|
|
622
|
+
request?: SecondParameter<typeof customInstance>;
|
|
623
|
+
},
|
|
624
|
+
queryClient?: QueryClient,
|
|
625
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
626
|
+
export function useAdminGetUsersSuspense<
|
|
627
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
628
|
+
TError = ErrorType<void | DmError>,
|
|
629
|
+
>(
|
|
630
|
+
params?: AdminGetUsersParams,
|
|
631
|
+
options?: {
|
|
632
|
+
query?: Partial<
|
|
633
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>
|
|
634
|
+
>;
|
|
635
|
+
request?: SecondParameter<typeof customInstance>;
|
|
636
|
+
},
|
|
637
|
+
queryClient?: QueryClient,
|
|
638
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
639
|
+
export function useAdminGetUsersSuspense<
|
|
640
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
641
|
+
TError = ErrorType<void | DmError>,
|
|
642
|
+
>(
|
|
643
|
+
params?: AdminGetUsersParams,
|
|
644
|
+
options?: {
|
|
645
|
+
query?: Partial<
|
|
646
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>
|
|
647
|
+
>;
|
|
648
|
+
request?: SecondParameter<typeof customInstance>;
|
|
649
|
+
},
|
|
650
|
+
queryClient?: QueryClient,
|
|
651
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
450
652
|
/**
|
|
451
653
|
* @summary Get detailed information about all known Users
|
|
452
654
|
*/
|
|
453
655
|
|
|
454
|
-
export function useAdminGetUsersSuspense<
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
656
|
+
export function useAdminGetUsersSuspense<
|
|
657
|
+
TData = Awaited<ReturnType<typeof adminGetUsers>>,
|
|
658
|
+
TError = ErrorType<void | DmError>,
|
|
659
|
+
>(
|
|
660
|
+
params?: AdminGetUsersParams,
|
|
661
|
+
options?: {
|
|
662
|
+
query?: Partial<
|
|
663
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>
|
|
664
|
+
>;
|
|
665
|
+
request?: SecondParameter<typeof customInstance>;
|
|
666
|
+
},
|
|
667
|
+
queryClient?: QueryClient,
|
|
668
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
669
|
+
const queryOptions = useAdminGetUsersSuspenseQueryOptions(params, options);
|
|
670
|
+
|
|
671
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
672
|
+
TData,
|
|
673
|
+
TError
|
|
674
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
675
|
+
|
|
676
|
+
query.queryKey = queryOptions.queryKey;
|
|
464
677
|
|
|
465
678
|
return query;
|
|
466
679
|
}
|
|
467
680
|
|
|
468
|
-
|
|
469
|
-
|
|
470
681
|
/**
|
|
471
682
|
* This method adds a user to the Data Manager service. The user is authenticated via a keycloak server but will need an initialised account before they can create Datasets or Projects.
|
|
472
683
|
|
|
@@ -474,64 +685,80 @@ You will need `admin` rights to use this endpoint
|
|
|
474
685
|
|
|
475
686
|
* @summary Prepares a user account in the Data Manager service
|
|
476
687
|
*/
|
|
477
|
-
export const adminPutUser = (
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
688
|
+
export const adminPutUser = (userId: string, options?: SecondParameter<typeof customInstance>) => {
|
|
689
|
+
return customInstance<UserAccountDetail>(
|
|
690
|
+
{ url: `/admin/user/${userId}`, method: "PUT" },
|
|
691
|
+
options,
|
|
692
|
+
);
|
|
693
|
+
};
|
|
694
|
+
|
|
695
|
+
export const useAdminPutUserMutationOptions = <
|
|
696
|
+
TError = ErrorType<void | DmError>,
|
|
697
|
+
TContext = unknown,
|
|
698
|
+
>(options?: {
|
|
699
|
+
mutation?: UseMutationOptions<
|
|
700
|
+
Awaited<ReturnType<typeof adminPutUser>>,
|
|
701
|
+
TError,
|
|
702
|
+
{ userId: string },
|
|
703
|
+
TContext
|
|
704
|
+
>;
|
|
705
|
+
request?: SecondParameter<typeof customInstance>;
|
|
706
|
+
}): UseMutationOptions<
|
|
707
|
+
Awaited<ReturnType<typeof adminPutUser>>,
|
|
708
|
+
TError,
|
|
709
|
+
{ userId: string },
|
|
710
|
+
TContext
|
|
711
|
+
> => {
|
|
712
|
+
const mutationKey = ["adminPutUser"];
|
|
713
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
714
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
715
|
+
? options
|
|
716
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
717
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
718
|
+
|
|
719
|
+
const mutationFn: MutationFunction<
|
|
720
|
+
Awaited<ReturnType<typeof adminPutUser>>,
|
|
721
|
+
{ userId: string }
|
|
722
|
+
> = (props) => {
|
|
723
|
+
const { userId } = props ?? {};
|
|
724
|
+
|
|
725
|
+
return adminPutUser(userId, requestOptions);
|
|
726
|
+
};
|
|
727
|
+
|
|
728
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
729
|
+
|
|
730
|
+
return customOptions;
|
|
731
|
+
};
|
|
732
|
+
|
|
733
|
+
export type AdminPutUserMutationResult = NonNullable<Awaited<ReturnType<typeof adminPutUser>>>;
|
|
734
|
+
|
|
735
|
+
export type AdminPutUserMutationError = ErrorType<void | DmError>;
|
|
502
736
|
|
|
503
|
-
|
|
504
|
-
const {userId} = props ?? {};
|
|
505
|
-
|
|
506
|
-
return adminPutUser(userId,requestOptions)
|
|
507
|
-
}
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{userId: string}, TContext>}
|
|
513
|
-
|
|
514
|
-
export type AdminPutUserMutationResult = NonNullable<Awaited<ReturnType<typeof adminPutUser>>>
|
|
515
|
-
|
|
516
|
-
export type AdminPutUserMutationError = ErrorType<void | DmError>
|
|
517
|
-
|
|
518
|
-
/**
|
|
737
|
+
/**
|
|
519
738
|
* @summary Prepares a user account in the Data Manager service
|
|
520
739
|
*/
|
|
521
|
-
export const useAdminPutUser = <
|
|
522
|
-
|
|
740
|
+
export const useAdminPutUser = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
741
|
+
options?: {
|
|
742
|
+
mutation?: UseMutationOptions<
|
|
743
|
+
Awaited<ReturnType<typeof adminPutUser>>,
|
|
744
|
+
TError,
|
|
745
|
+
{ userId: string },
|
|
746
|
+
TContext
|
|
747
|
+
>;
|
|
748
|
+
request?: SecondParameter<typeof customInstance>;
|
|
749
|
+
},
|
|
750
|
+
queryClient?: QueryClient,
|
|
523
751
|
): UseMutationResult<
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
/**
|
|
752
|
+
Awaited<ReturnType<typeof adminPutUser>>,
|
|
753
|
+
TError,
|
|
754
|
+
{ userId: string },
|
|
755
|
+
TContext
|
|
756
|
+
> => {
|
|
757
|
+
const mutationOptions = useAdminPutUserMutationOptions(options);
|
|
758
|
+
|
|
759
|
+
return useMutation(mutationOptions, queryClient);
|
|
760
|
+
};
|
|
761
|
+
/**
|
|
535
762
|
* Deletes a user account, along with all the user's Datasets
|
|
536
763
|
|
|
537
764
|
You will need `admin` rights to use this endpoint
|
|
@@ -539,63 +766,81 @@ You will need `admin` rights to use this endpoint
|
|
|
539
766
|
* @summary Deletes a user account
|
|
540
767
|
*/
|
|
541
768
|
export const adminDeleteUser = (
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
return customInstance<void>(
|
|
547
|
-
{url: `/admin/user/${userId}`, method: 'DELETE'
|
|
548
|
-
},
|
|
549
|
-
options);
|
|
550
|
-
}
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
export const getAdminDeleteUserMutationOptions = <TData = Awaited<ReturnType<typeof adminDeleteUser>>, TError = ErrorType<void | DmError>,
|
|
555
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{userId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
769
|
+
userId: string,
|
|
770
|
+
options?: SecondParameter<typeof customInstance>,
|
|
556
771
|
) => {
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
772
|
+
return customInstance<void>({ url: `/admin/user/${userId}`, method: "DELETE" }, options);
|
|
773
|
+
};
|
|
774
|
+
|
|
775
|
+
export const useAdminDeleteUserMutationOptions = <
|
|
776
|
+
TError = ErrorType<void | DmError>,
|
|
777
|
+
TContext = unknown,
|
|
778
|
+
>(options?: {
|
|
779
|
+
mutation?: UseMutationOptions<
|
|
780
|
+
Awaited<ReturnType<typeof adminDeleteUser>>,
|
|
781
|
+
TError,
|
|
782
|
+
{ userId: string },
|
|
783
|
+
TContext
|
|
784
|
+
>;
|
|
785
|
+
request?: SecondParameter<typeof customInstance>;
|
|
786
|
+
}): UseMutationOptions<
|
|
787
|
+
Awaited<ReturnType<typeof adminDeleteUser>>,
|
|
788
|
+
TError,
|
|
789
|
+
{ userId: string },
|
|
790
|
+
TContext
|
|
791
|
+
> => {
|
|
792
|
+
const mutationKey = ["adminDeleteUser"];
|
|
793
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
794
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
795
|
+
? options
|
|
796
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
797
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
798
|
+
|
|
799
|
+
const mutationFn: MutationFunction<
|
|
800
|
+
Awaited<ReturnType<typeof adminDeleteUser>>,
|
|
801
|
+
{ userId: string }
|
|
802
|
+
> = (props) => {
|
|
803
|
+
const { userId } = props ?? {};
|
|
804
|
+
|
|
805
|
+
return adminDeleteUser(userId, requestOptions);
|
|
806
|
+
};
|
|
807
|
+
|
|
808
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
809
|
+
|
|
810
|
+
return customOptions;
|
|
811
|
+
};
|
|
812
|
+
|
|
813
|
+
export type AdminDeleteUserMutationResult = NonNullable<
|
|
814
|
+
Awaited<ReturnType<typeof adminDeleteUser>>
|
|
815
|
+
>;
|
|
816
|
+
|
|
817
|
+
export type AdminDeleteUserMutationError = ErrorType<void | DmError>;
|
|
566
818
|
|
|
567
|
-
|
|
568
|
-
const {userId} = props ?? {};
|
|
569
|
-
|
|
570
|
-
return adminDeleteUser(userId,requestOptions)
|
|
571
|
-
}
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{userId: string}, TContext>}
|
|
577
|
-
|
|
578
|
-
export type AdminDeleteUserMutationResult = NonNullable<Awaited<ReturnType<typeof adminDeleteUser>>>
|
|
579
|
-
|
|
580
|
-
export type AdminDeleteUserMutationError = ErrorType<void | DmError>
|
|
581
|
-
|
|
582
|
-
/**
|
|
819
|
+
/**
|
|
583
820
|
* @summary Deletes a user account
|
|
584
821
|
*/
|
|
585
|
-
export const useAdminDeleteUser = <
|
|
586
|
-
|
|
822
|
+
export const useAdminDeleteUser = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
823
|
+
options?: {
|
|
824
|
+
mutation?: UseMutationOptions<
|
|
825
|
+
Awaited<ReturnType<typeof adminDeleteUser>>,
|
|
826
|
+
TError,
|
|
827
|
+
{ userId: string },
|
|
828
|
+
TContext
|
|
829
|
+
>;
|
|
830
|
+
request?: SecondParameter<typeof customInstance>;
|
|
831
|
+
},
|
|
832
|
+
queryClient?: QueryClient,
|
|
587
833
|
): UseMutationResult<
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
/**
|
|
834
|
+
Awaited<ReturnType<typeof adminDeleteUser>>,
|
|
835
|
+
TError,
|
|
836
|
+
{ userId: string },
|
|
837
|
+
TContext
|
|
838
|
+
> => {
|
|
839
|
+
const mutationOptions = useAdminDeleteUserMutationOptions(options);
|
|
840
|
+
|
|
841
|
+
return useMutation(mutationOptions, queryClient);
|
|
842
|
+
};
|
|
843
|
+
/**
|
|
599
844
|
* Patches a user record, typically to suspend or re-enable a user account
|
|
600
845
|
|
|
601
846
|
You will need `admin` rights to use this endpoint
|
|
@@ -603,70 +848,93 @@ You will need `admin` rights to use this endpoint
|
|
|
603
848
|
* @summary Patch a given user
|
|
604
849
|
*/
|
|
605
850
|
export const adminPatchUser = (
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
const formUrlEncoded = new URLSearchParams();
|
|
611
|
-
if(userPatchBodyBody.suspend_message !== undefined) {
|
|
612
|
-
formUrlEncoded.append('suspend_message', userPatchBodyBody.suspend_message)
|
|
613
|
-
}
|
|
614
|
-
|
|
615
|
-
return customInstance<void>(
|
|
616
|
-
{url: `/admin/user/${userId}`, method: 'PATCH',
|
|
617
|
-
headers: {'Content-Type': 'application/x-www-form-urlencoded', },
|
|
618
|
-
data: formUrlEncoded
|
|
619
|
-
},
|
|
620
|
-
options);
|
|
621
|
-
}
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
export const getAdminPatchUserMutationOptions = <TData = Awaited<ReturnType<typeof adminPatchUser>>, TError = ErrorType<void | DmError>,
|
|
626
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{userId: string;data: UserPatchBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
851
|
+
userId: string,
|
|
852
|
+
userPatchBodyBody: UserPatchBodyBody,
|
|
853
|
+
options?: SecondParameter<typeof customInstance>,
|
|
627
854
|
) => {
|
|
628
|
-
const
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
855
|
+
const formUrlEncoded = new URLSearchParams();
|
|
856
|
+
if (userPatchBodyBody.suspend_message !== undefined) {
|
|
857
|
+
formUrlEncoded.append(`suspend_message`, userPatchBodyBody.suspend_message);
|
|
858
|
+
}
|
|
859
|
+
|
|
860
|
+
return customInstance<void>(
|
|
861
|
+
{
|
|
862
|
+
url: `/admin/user/${userId}`,
|
|
863
|
+
method: "PATCH",
|
|
864
|
+
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
|
865
|
+
data: formUrlEncoded,
|
|
866
|
+
},
|
|
867
|
+
options,
|
|
868
|
+
);
|
|
869
|
+
};
|
|
870
|
+
|
|
871
|
+
export const useAdminPatchUserMutationOptions = <
|
|
872
|
+
TError = ErrorType<void | DmError>,
|
|
873
|
+
TContext = unknown,
|
|
874
|
+
>(options?: {
|
|
875
|
+
mutation?: UseMutationOptions<
|
|
876
|
+
Awaited<ReturnType<typeof adminPatchUser>>,
|
|
877
|
+
TError,
|
|
878
|
+
{ userId: string; data: UserPatchBodyBody },
|
|
879
|
+
TContext
|
|
880
|
+
>;
|
|
881
|
+
request?: SecondParameter<typeof customInstance>;
|
|
882
|
+
}): UseMutationOptions<
|
|
883
|
+
Awaited<ReturnType<typeof adminPatchUser>>,
|
|
884
|
+
TError,
|
|
885
|
+
{ userId: string; data: UserPatchBodyBody },
|
|
886
|
+
TContext
|
|
887
|
+
> => {
|
|
888
|
+
const mutationKey = ["adminPatchUser"];
|
|
889
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
890
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
891
|
+
? options
|
|
892
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
893
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
894
|
+
|
|
895
|
+
const mutationFn: MutationFunction<
|
|
896
|
+
Awaited<ReturnType<typeof adminPatchUser>>,
|
|
897
|
+
{ userId: string; data: UserPatchBodyBody }
|
|
898
|
+
> = (props) => {
|
|
899
|
+
const { userId, data } = props ?? {};
|
|
900
|
+
|
|
901
|
+
return adminPatchUser(userId, data, requestOptions);
|
|
902
|
+
};
|
|
903
|
+
|
|
904
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
905
|
+
|
|
906
|
+
return customOptions;
|
|
907
|
+
};
|
|
908
|
+
|
|
909
|
+
export type AdminPatchUserMutationResult = NonNullable<Awaited<ReturnType<typeof adminPatchUser>>>;
|
|
910
|
+
export type AdminPatchUserMutationBody = UserPatchBodyBody;
|
|
911
|
+
export type AdminPatchUserMutationError = ErrorType<void | DmError>;
|
|
652
912
|
|
|
653
|
-
|
|
913
|
+
/**
|
|
654
914
|
* @summary Patch a given user
|
|
655
915
|
*/
|
|
656
|
-
export const useAdminPatchUser = <
|
|
657
|
-
|
|
916
|
+
export const useAdminPatchUser = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
917
|
+
options?: {
|
|
918
|
+
mutation?: UseMutationOptions<
|
|
919
|
+
Awaited<ReturnType<typeof adminPatchUser>>,
|
|
920
|
+
TError,
|
|
921
|
+
{ userId: string; data: UserPatchBodyBody },
|
|
922
|
+
TContext
|
|
923
|
+
>;
|
|
924
|
+
request?: SecondParameter<typeof customInstance>;
|
|
925
|
+
},
|
|
926
|
+
queryClient?: QueryClient,
|
|
658
927
|
): UseMutationResult<
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
/**
|
|
928
|
+
Awaited<ReturnType<typeof adminPatchUser>>,
|
|
929
|
+
TError,
|
|
930
|
+
{ userId: string; data: UserPatchBodyBody },
|
|
931
|
+
TContext
|
|
932
|
+
> => {
|
|
933
|
+
const mutationOptions = useAdminPatchUserMutationOptions(options);
|
|
934
|
+
|
|
935
|
+
return useMutation(mutationOptions, queryClient);
|
|
936
|
+
};
|
|
937
|
+
/**
|
|
670
938
|
* Returns the list of known **Job Manifests** including the time the manifest was last loaded and its load status, a message indicating success or failure.
|
|
671
939
|
|
|
672
940
|
You will need `admin` rights to use this endpoint
|
|
@@ -674,143 +942,220 @@ You will need `admin` rights to use this endpoint
|
|
|
674
942
|
* @summary Get Job Manifests
|
|
675
943
|
*/
|
|
676
944
|
export const adminGetJobManifests = (
|
|
677
|
-
|
|
678
|
-
|
|
945
|
+
options?: SecondParameter<typeof customInstance>,
|
|
946
|
+
signal?: AbortSignal,
|
|
679
947
|
) => {
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
options);
|
|
686
|
-
}
|
|
687
|
-
|
|
948
|
+
return customInstance<AdminJobManifestGetResponse>(
|
|
949
|
+
{ url: `/admin/job-manifest`, method: "GET", signal },
|
|
950
|
+
options,
|
|
951
|
+
);
|
|
952
|
+
};
|
|
688
953
|
|
|
689
954
|
export const getAdminGetJobManifestsQueryKey = () => {
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
export
|
|
717
|
-
|
|
955
|
+
return [`/admin/job-manifest`] as const;
|
|
956
|
+
};
|
|
957
|
+
|
|
958
|
+
export const useAdminGetJobManifestsQueryOptions = <
|
|
959
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
960
|
+
TError = ErrorType<void | DmError>,
|
|
961
|
+
>(options?: {
|
|
962
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>>;
|
|
963
|
+
request?: SecondParameter<typeof customInstance>;
|
|
964
|
+
}) => {
|
|
965
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
966
|
+
|
|
967
|
+
const queryKey = queryOptions?.queryKey ?? getAdminGetJobManifestsQueryKey();
|
|
968
|
+
|
|
969
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof adminGetJobManifests>>> = ({ signal }) =>
|
|
970
|
+
adminGetJobManifests(requestOptions, signal);
|
|
971
|
+
|
|
972
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
973
|
+
|
|
974
|
+
return customOptions as UseQueryOptions<
|
|
975
|
+
Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
976
|
+
TError,
|
|
977
|
+
TData
|
|
978
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
979
|
+
};
|
|
980
|
+
|
|
981
|
+
export type AdminGetJobManifestsQueryResult = NonNullable<
|
|
982
|
+
Awaited<ReturnType<typeof adminGetJobManifests>>
|
|
983
|
+
>;
|
|
984
|
+
export type AdminGetJobManifestsQueryError = ErrorType<void | DmError>;
|
|
985
|
+
|
|
986
|
+
export function useAdminGetJobManifests<
|
|
987
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
988
|
+
TError = ErrorType<void | DmError>,
|
|
989
|
+
>(
|
|
990
|
+
options: {
|
|
991
|
+
query: Partial<
|
|
992
|
+
UseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>
|
|
993
|
+
> &
|
|
994
|
+
Pick<
|
|
718
995
|
DefinedInitialDataOptions<
|
|
719
996
|
Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
720
997
|
TError,
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
998
|
+
Awaited<ReturnType<typeof adminGetJobManifests>>
|
|
999
|
+
>,
|
|
1000
|
+
"initialData"
|
|
1001
|
+
>;
|
|
1002
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1003
|
+
},
|
|
1004
|
+
queryClient?: QueryClient,
|
|
1005
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1006
|
+
export function useAdminGetJobManifests<
|
|
1007
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
1008
|
+
TError = ErrorType<void | DmError>,
|
|
1009
|
+
>(
|
|
1010
|
+
options?: {
|
|
1011
|
+
query?: Partial<
|
|
1012
|
+
UseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>
|
|
1013
|
+
> &
|
|
1014
|
+
Pick<
|
|
728
1015
|
UndefinedInitialDataOptions<
|
|
729
1016
|
Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
730
1017
|
TError,
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
1018
|
+
Awaited<ReturnType<typeof adminGetJobManifests>>
|
|
1019
|
+
>,
|
|
1020
|
+
"initialData"
|
|
1021
|
+
>;
|
|
1022
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1023
|
+
},
|
|
1024
|
+
queryClient?: QueryClient,
|
|
1025
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1026
|
+
export function useAdminGetJobManifests<
|
|
1027
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
1028
|
+
TError = ErrorType<void | DmError>,
|
|
1029
|
+
>(
|
|
1030
|
+
options?: {
|
|
1031
|
+
query?: Partial<
|
|
1032
|
+
UseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>
|
|
1033
|
+
>;
|
|
1034
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1035
|
+
},
|
|
1036
|
+
queryClient?: QueryClient,
|
|
1037
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
740
1038
|
/**
|
|
741
1039
|
* @summary Get Job Manifests
|
|
742
1040
|
*/
|
|
743
1041
|
|
|
744
|
-
export function useAdminGetJobManifests<
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
1042
|
+
export function useAdminGetJobManifests<
|
|
1043
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
1044
|
+
TError = ErrorType<void | DmError>,
|
|
1045
|
+
>(
|
|
1046
|
+
options?: {
|
|
1047
|
+
query?: Partial<
|
|
1048
|
+
UseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>
|
|
1049
|
+
>;
|
|
1050
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1051
|
+
},
|
|
1052
|
+
queryClient?: QueryClient,
|
|
1053
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1054
|
+
const queryOptions = useAdminGetJobManifestsQueryOptions(options);
|
|
1055
|
+
|
|
1056
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
1057
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1058
|
+
};
|
|
1059
|
+
|
|
1060
|
+
query.queryKey = queryOptions.queryKey;
|
|
754
1061
|
|
|
755
1062
|
return query;
|
|
756
1063
|
}
|
|
757
1064
|
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
export
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
1065
|
+
export const useAdminGetJobManifestsSuspenseQueryOptions = <
|
|
1066
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
1067
|
+
TError = ErrorType<void | DmError>,
|
|
1068
|
+
>(options?: {
|
|
1069
|
+
query?: Partial<
|
|
1070
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>
|
|
1071
|
+
>;
|
|
1072
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1073
|
+
}) => {
|
|
1074
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
1075
|
+
|
|
1076
|
+
const queryKey = queryOptions?.queryKey ?? getAdminGetJobManifestsQueryKey();
|
|
1077
|
+
|
|
1078
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof adminGetJobManifests>>> = ({ signal }) =>
|
|
1079
|
+
adminGetJobManifests(requestOptions, signal);
|
|
1080
|
+
|
|
1081
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
1082
|
+
|
|
1083
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
1084
|
+
Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
1085
|
+
TError,
|
|
1086
|
+
TData
|
|
1087
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1088
|
+
};
|
|
1089
|
+
|
|
1090
|
+
export type AdminGetJobManifestsSuspenseQueryResult = NonNullable<
|
|
1091
|
+
Awaited<ReturnType<typeof adminGetJobManifests>>
|
|
1092
|
+
>;
|
|
1093
|
+
export type AdminGetJobManifestsSuspenseQueryError = ErrorType<void | DmError>;
|
|
1094
|
+
|
|
1095
|
+
export function useAdminGetJobManifestsSuspense<
|
|
1096
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
1097
|
+
TError = ErrorType<void | DmError>,
|
|
1098
|
+
>(
|
|
1099
|
+
options: {
|
|
1100
|
+
query: Partial<
|
|
1101
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>
|
|
1102
|
+
>;
|
|
1103
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1104
|
+
},
|
|
1105
|
+
queryClient?: QueryClient,
|
|
1106
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1107
|
+
export function useAdminGetJobManifestsSuspense<
|
|
1108
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
1109
|
+
TError = ErrorType<void | DmError>,
|
|
1110
|
+
>(
|
|
1111
|
+
options?: {
|
|
1112
|
+
query?: Partial<
|
|
1113
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>
|
|
1114
|
+
>;
|
|
1115
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1116
|
+
},
|
|
1117
|
+
queryClient?: QueryClient,
|
|
1118
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1119
|
+
export function useAdminGetJobManifestsSuspense<
|
|
1120
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
1121
|
+
TError = ErrorType<void | DmError>,
|
|
1122
|
+
>(
|
|
1123
|
+
options?: {
|
|
1124
|
+
query?: Partial<
|
|
1125
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>
|
|
1126
|
+
>;
|
|
1127
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1128
|
+
},
|
|
1129
|
+
queryClient?: QueryClient,
|
|
1130
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
794
1131
|
/**
|
|
795
1132
|
* @summary Get Job Manifests
|
|
796
1133
|
*/
|
|
797
1134
|
|
|
798
|
-
export function useAdminGetJobManifestsSuspense<
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
1135
|
+
export function useAdminGetJobManifestsSuspense<
|
|
1136
|
+
TData = Awaited<ReturnType<typeof adminGetJobManifests>>,
|
|
1137
|
+
TError = ErrorType<void | DmError>,
|
|
1138
|
+
>(
|
|
1139
|
+
options?: {
|
|
1140
|
+
query?: Partial<
|
|
1141
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>
|
|
1142
|
+
>;
|
|
1143
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1144
|
+
},
|
|
1145
|
+
queryClient?: QueryClient,
|
|
1146
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
1147
|
+
const queryOptions = useAdminGetJobManifestsSuspenseQueryOptions(options);
|
|
1148
|
+
|
|
1149
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
1150
|
+
TData,
|
|
1151
|
+
TError
|
|
1152
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
1153
|
+
|
|
1154
|
+
query.queryKey = queryOptions.queryKey;
|
|
808
1155
|
|
|
809
1156
|
return query;
|
|
810
1157
|
}
|
|
811
1158
|
|
|
812
|
-
|
|
813
|
-
|
|
814
1159
|
/**
|
|
815
1160
|
* This endpoint is used to add (or update an existing **Job Manifest**). Manifests are the source of Job definitions. Once added the manifest is inspected and any Jobs it refers to are loaded.
|
|
816
1161
|
|
|
@@ -821,73 +1166,98 @@ You will need `admin` rights to use this endpoint
|
|
|
821
1166
|
* @summary Adds a Job Manifest and triggers the download of its Job Definitions
|
|
822
1167
|
*/
|
|
823
1168
|
export const adminJobManifestPut = (
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
const formUrlEncoded = new URLSearchParams();
|
|
828
|
-
formUrlEncoded.append('url', jobManifestPutBodyBody.url)
|
|
829
|
-
if(jobManifestPutBodyBody.header !== undefined) {
|
|
830
|
-
formUrlEncoded.append('header', jobManifestPutBodyBody.header)
|
|
831
|
-
}
|
|
832
|
-
if(jobManifestPutBodyBody.params !== undefined) {
|
|
833
|
-
formUrlEncoded.append('params', jobManifestPutBodyBody.params)
|
|
834
|
-
}
|
|
835
|
-
|
|
836
|
-
return customInstance<AdminJobManifestLoadPutResponse>(
|
|
837
|
-
{url: `/admin/job-manifest`, method: 'PUT',
|
|
838
|
-
headers: {'Content-Type': 'application/x-www-form-urlencoded', },
|
|
839
|
-
data: formUrlEncoded
|
|
840
|
-
},
|
|
841
|
-
options);
|
|
842
|
-
}
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
export const getAdminJobManifestPutMutationOptions = <TData = Awaited<ReturnType<typeof adminJobManifestPut>>, TError = ErrorType<void | DmError>,
|
|
847
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: JobManifestPutBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
1169
|
+
jobManifestPutBodyBody: JobManifestPutBodyBody,
|
|
1170
|
+
options?: SecondParameter<typeof customInstance>,
|
|
848
1171
|
) => {
|
|
849
|
-
const
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
1172
|
+
const formUrlEncoded = new URLSearchParams();
|
|
1173
|
+
formUrlEncoded.append(`url`, jobManifestPutBodyBody.url);
|
|
1174
|
+
if (jobManifestPutBodyBody.header !== undefined) {
|
|
1175
|
+
formUrlEncoded.append(`header`, jobManifestPutBodyBody.header);
|
|
1176
|
+
}
|
|
1177
|
+
if (jobManifestPutBodyBody.params !== undefined) {
|
|
1178
|
+
formUrlEncoded.append(`params`, jobManifestPutBodyBody.params);
|
|
1179
|
+
}
|
|
1180
|
+
|
|
1181
|
+
return customInstance<AdminJobManifestLoadPutResponse>(
|
|
1182
|
+
{
|
|
1183
|
+
url: `/admin/job-manifest`,
|
|
1184
|
+
method: "PUT",
|
|
1185
|
+
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
|
1186
|
+
data: formUrlEncoded,
|
|
1187
|
+
},
|
|
1188
|
+
options,
|
|
1189
|
+
);
|
|
1190
|
+
};
|
|
1191
|
+
|
|
1192
|
+
export const useAdminJobManifestPutMutationOptions = <
|
|
1193
|
+
TError = ErrorType<void | DmError>,
|
|
1194
|
+
TContext = unknown,
|
|
1195
|
+
>(options?: {
|
|
1196
|
+
mutation?: UseMutationOptions<
|
|
1197
|
+
Awaited<ReturnType<typeof adminJobManifestPut>>,
|
|
1198
|
+
TError,
|
|
1199
|
+
{ data: JobManifestPutBodyBody },
|
|
1200
|
+
TContext
|
|
1201
|
+
>;
|
|
1202
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1203
|
+
}): UseMutationOptions<
|
|
1204
|
+
Awaited<ReturnType<typeof adminJobManifestPut>>,
|
|
1205
|
+
TError,
|
|
1206
|
+
{ data: JobManifestPutBodyBody },
|
|
1207
|
+
TContext
|
|
1208
|
+
> => {
|
|
1209
|
+
const mutationKey = ["adminJobManifestPut"];
|
|
1210
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
1211
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
1212
|
+
? options
|
|
1213
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
1214
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
1215
|
+
|
|
1216
|
+
const mutationFn: MutationFunction<
|
|
1217
|
+
Awaited<ReturnType<typeof adminJobManifestPut>>,
|
|
1218
|
+
{ data: JobManifestPutBodyBody }
|
|
1219
|
+
> = (props) => {
|
|
1220
|
+
const { data } = props ?? {};
|
|
1221
|
+
|
|
1222
|
+
return adminJobManifestPut(data, requestOptions);
|
|
1223
|
+
};
|
|
1224
|
+
|
|
1225
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
1226
|
+
|
|
1227
|
+
return customOptions;
|
|
1228
|
+
};
|
|
1229
|
+
|
|
1230
|
+
export type AdminJobManifestPutMutationResult = NonNullable<
|
|
1231
|
+
Awaited<ReturnType<typeof adminJobManifestPut>>
|
|
1232
|
+
>;
|
|
1233
|
+
export type AdminJobManifestPutMutationBody = JobManifestPutBodyBody;
|
|
1234
|
+
export type AdminJobManifestPutMutationError = ErrorType<void | DmError>;
|
|
873
1235
|
|
|
874
|
-
|
|
1236
|
+
/**
|
|
875
1237
|
* @summary Adds a Job Manifest and triggers the download of its Job Definitions
|
|
876
1238
|
*/
|
|
877
|
-
export const useAdminJobManifestPut = <
|
|
878
|
-
|
|
1239
|
+
export const useAdminJobManifestPut = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
1240
|
+
options?: {
|
|
1241
|
+
mutation?: UseMutationOptions<
|
|
1242
|
+
Awaited<ReturnType<typeof adminJobManifestPut>>,
|
|
1243
|
+
TError,
|
|
1244
|
+
{ data: JobManifestPutBodyBody },
|
|
1245
|
+
TContext
|
|
1246
|
+
>;
|
|
1247
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1248
|
+
},
|
|
1249
|
+
queryClient?: QueryClient,
|
|
879
1250
|
): UseMutationResult<
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
/**
|
|
1251
|
+
Awaited<ReturnType<typeof adminJobManifestPut>>,
|
|
1252
|
+
TError,
|
|
1253
|
+
{ data: JobManifestPutBodyBody },
|
|
1254
|
+
TContext
|
|
1255
|
+
> => {
|
|
1256
|
+
const mutationOptions = useAdminJobManifestPutMutationOptions(options);
|
|
1257
|
+
|
|
1258
|
+
return useMutation(mutationOptions, queryClient);
|
|
1259
|
+
};
|
|
1260
|
+
/**
|
|
891
1261
|
* Deletes a Job Manifest record
|
|
892
1262
|
|
|
893
1263
|
You need to exercise caution using this endpoint. You can disrupt the Data Manager **Instance** execution if you delete and purge Jobs while instances of any affected job may be running.
|
|
@@ -897,65 +1267,85 @@ You will need `admin` rights to use this endpoint and the Data Manager needs to
|
|
|
897
1267
|
* @summary Deletes a Job Manifest
|
|
898
1268
|
*/
|
|
899
1269
|
export const adminDeleteJobManifest = (
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
return customInstance<void>(
|
|
906
|
-
{url: `/admin/job-manifest/${jobManifestId}`, method: 'DELETE',
|
|
907
|
-
params
|
|
908
|
-
},
|
|
909
|
-
options);
|
|
910
|
-
}
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
export const getAdminDeleteJobManifestMutationOptions = <TData = Awaited<ReturnType<typeof adminDeleteJobManifest>>, TError = ErrorType<void | DmError>,
|
|
915
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{jobManifestId: number;params?: AdminDeleteJobManifestParams}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
1270
|
+
jobManifestId: number,
|
|
1271
|
+
params?: AdminDeleteJobManifestParams,
|
|
1272
|
+
options?: SecondParameter<typeof customInstance>,
|
|
916
1273
|
) => {
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
1274
|
+
return customInstance<void>(
|
|
1275
|
+
{ url: `/admin/job-manifest/${jobManifestId}`, method: "DELETE", params },
|
|
1276
|
+
options,
|
|
1277
|
+
);
|
|
1278
|
+
};
|
|
1279
|
+
|
|
1280
|
+
export const useAdminDeleteJobManifestMutationOptions = <
|
|
1281
|
+
TError = ErrorType<void | DmError>,
|
|
1282
|
+
TContext = unknown,
|
|
1283
|
+
>(options?: {
|
|
1284
|
+
mutation?: UseMutationOptions<
|
|
1285
|
+
Awaited<ReturnType<typeof adminDeleteJobManifest>>,
|
|
1286
|
+
TError,
|
|
1287
|
+
{ jobManifestId: number; params?: AdminDeleteJobManifestParams },
|
|
1288
|
+
TContext
|
|
1289
|
+
>;
|
|
1290
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1291
|
+
}): UseMutationOptions<
|
|
1292
|
+
Awaited<ReturnType<typeof adminDeleteJobManifest>>,
|
|
1293
|
+
TError,
|
|
1294
|
+
{ jobManifestId: number; params?: AdminDeleteJobManifestParams },
|
|
1295
|
+
TContext
|
|
1296
|
+
> => {
|
|
1297
|
+
const mutationKey = ["adminDeleteJobManifest"];
|
|
1298
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
1299
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
1300
|
+
? options
|
|
1301
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
1302
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
1303
|
+
|
|
1304
|
+
const mutationFn: MutationFunction<
|
|
1305
|
+
Awaited<ReturnType<typeof adminDeleteJobManifest>>,
|
|
1306
|
+
{ jobManifestId: number; params?: AdminDeleteJobManifestParams }
|
|
1307
|
+
> = (props) => {
|
|
1308
|
+
const { jobManifestId, params } = props ?? {};
|
|
1309
|
+
|
|
1310
|
+
return adminDeleteJobManifest(jobManifestId, params, requestOptions);
|
|
1311
|
+
};
|
|
1312
|
+
|
|
1313
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
1314
|
+
|
|
1315
|
+
return customOptions;
|
|
1316
|
+
};
|
|
1317
|
+
|
|
1318
|
+
export type AdminDeleteJobManifestMutationResult = NonNullable<
|
|
1319
|
+
Awaited<ReturnType<typeof adminDeleteJobManifest>>
|
|
1320
|
+
>;
|
|
1321
|
+
|
|
1322
|
+
export type AdminDeleteJobManifestMutationError = ErrorType<void | DmError>;
|
|
934
1323
|
|
|
935
|
-
|
|
936
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{jobManifestId: number;params?: AdminDeleteJobManifestParams}, TContext>}
|
|
937
|
-
|
|
938
|
-
export type AdminDeleteJobManifestMutationResult = NonNullable<Awaited<ReturnType<typeof adminDeleteJobManifest>>>
|
|
939
|
-
|
|
940
|
-
export type AdminDeleteJobManifestMutationError = ErrorType<void | DmError>
|
|
941
|
-
|
|
942
|
-
/**
|
|
1324
|
+
/**
|
|
943
1325
|
* @summary Deletes a Job Manifest
|
|
944
1326
|
*/
|
|
945
|
-
export const useAdminDeleteJobManifest = <
|
|
946
|
-
|
|
1327
|
+
export const useAdminDeleteJobManifest = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
1328
|
+
options?: {
|
|
1329
|
+
mutation?: UseMutationOptions<
|
|
1330
|
+
Awaited<ReturnType<typeof adminDeleteJobManifest>>,
|
|
1331
|
+
TError,
|
|
1332
|
+
{ jobManifestId: number; params?: AdminDeleteJobManifestParams },
|
|
1333
|
+
TContext
|
|
1334
|
+
>;
|
|
1335
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1336
|
+
},
|
|
1337
|
+
queryClient?: QueryClient,
|
|
947
1338
|
): UseMutationResult<
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
/**
|
|
1339
|
+
Awaited<ReturnType<typeof adminDeleteJobManifest>>,
|
|
1340
|
+
TError,
|
|
1341
|
+
{ jobManifestId: number; params?: AdminDeleteJobManifestParams },
|
|
1342
|
+
TContext
|
|
1343
|
+
> => {
|
|
1344
|
+
const mutationOptions = useAdminDeleteJobManifestMutationOptions(options);
|
|
1345
|
+
|
|
1346
|
+
return useMutation(mutationOptions, queryClient);
|
|
1347
|
+
};
|
|
1348
|
+
/**
|
|
959
1349
|
* This endpoint is used to trigger the Data Manager to re-inspect the internal **Job Manifest** table and download the manifests and reprocess the related job definitions. This is normally done by an administrator when the Manifest table has been modified or if external job definitions are known to have changed in the referenced repositories.
|
|
960
1350
|
|
|
961
1351
|
You need to exercise caution using this endpoint. You can disrupt the Data Manager **Instance** execution if you re-load Jobs while instances of any affected job may be running.
|
|
@@ -964,61 +1354,71 @@ You will need `admin` rights to use this endpoint and the Data Manager needs to
|
|
|
964
1354
|
|
|
965
1355
|
* @summary Trigger a download of Job Definitions using existing Job Manifests
|
|
966
1356
|
*/
|
|
967
|
-
export const adminJobManifestLoad = (
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
1357
|
+
export const adminJobManifestLoad = (options?: SecondParameter<typeof customInstance>) => {
|
|
1358
|
+
return customInstance<AdminJobManifestLoadPutResponse>(
|
|
1359
|
+
{ url: `/admin/job-manifest/load`, method: "PUT" },
|
|
1360
|
+
options,
|
|
1361
|
+
);
|
|
1362
|
+
};
|
|
1363
|
+
|
|
1364
|
+
export const useAdminJobManifestLoadMutationOptions = <
|
|
1365
|
+
TError = ErrorType<void | DmError>,
|
|
1366
|
+
TContext = unknown,
|
|
1367
|
+
>(options?: {
|
|
1368
|
+
mutation?: UseMutationOptions<
|
|
1369
|
+
Awaited<ReturnType<typeof adminJobManifestLoad>>,
|
|
1370
|
+
TError,
|
|
1371
|
+
void,
|
|
1372
|
+
TContext
|
|
1373
|
+
>;
|
|
1374
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1375
|
+
}): UseMutationOptions<
|
|
1376
|
+
Awaited<ReturnType<typeof adminJobManifestLoad>>,
|
|
1377
|
+
TError,
|
|
1378
|
+
void,
|
|
1379
|
+
TContext
|
|
1380
|
+
> => {
|
|
1381
|
+
const mutationKey = ["adminJobManifestLoad"];
|
|
1382
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
1383
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
1384
|
+
? options
|
|
1385
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
1386
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
1387
|
+
|
|
1388
|
+
const mutationFn: MutationFunction<
|
|
1389
|
+
Awaited<ReturnType<typeof adminJobManifestLoad>>,
|
|
1390
|
+
void
|
|
1391
|
+
> = () => {
|
|
1392
|
+
return adminJobManifestLoad(requestOptions);
|
|
1393
|
+
};
|
|
1394
|
+
|
|
1395
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
1396
|
+
|
|
1397
|
+
return customOptions;
|
|
1398
|
+
};
|
|
1399
|
+
|
|
1400
|
+
export type AdminJobManifestLoadMutationResult = NonNullable<
|
|
1401
|
+
Awaited<ReturnType<typeof adminJobManifestLoad>>
|
|
1402
|
+
>;
|
|
1403
|
+
|
|
1404
|
+
export type AdminJobManifestLoadMutationError = ErrorType<void | DmError>;
|
|
978
1405
|
|
|
979
|
-
|
|
980
|
-
export const getAdminJobManifestLoadMutationOptions = <TData = Awaited<ReturnType<typeof adminJobManifestLoad>>, TError = ErrorType<void | DmError>,
|
|
981
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,void, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
982
|
-
) => {
|
|
983
|
-
const mutationKey = ['adminJobManifestLoad'];
|
|
984
|
-
const {mutation: mutationOptions, request: requestOptions} = options ?
|
|
985
|
-
options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
|
|
986
|
-
options
|
|
987
|
-
: {...options, mutation: {...options.mutation, mutationKey}}
|
|
988
|
-
: {mutation: { mutationKey, }, request: undefined};
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
const mutationFn: MutationFunction<Awaited<ReturnType<typeof adminJobManifestLoad>>, void> = () => {
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
return adminJobManifestLoad(requestOptions)
|
|
997
|
-
}
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,void, TContext>}
|
|
1003
|
-
|
|
1004
|
-
export type AdminJobManifestLoadMutationResult = NonNullable<Awaited<ReturnType<typeof adminJobManifestLoad>>>
|
|
1005
|
-
|
|
1006
|
-
export type AdminJobManifestLoadMutationError = ErrorType<void | DmError>
|
|
1007
|
-
|
|
1008
|
-
/**
|
|
1406
|
+
/**
|
|
1009
1407
|
* @summary Trigger a download of Job Definitions using existing Job Manifests
|
|
1010
1408
|
*/
|
|
1011
|
-
export const useAdminJobManifestLoad = <
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1409
|
+
export const useAdminJobManifestLoad = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
1410
|
+
options?: {
|
|
1411
|
+
mutation?: UseMutationOptions<
|
|
1412
|
+
Awaited<ReturnType<typeof adminJobManifestLoad>>,
|
|
1413
|
+
TError,
|
|
1414
|
+
void,
|
|
1415
|
+
TContext
|
|
1416
|
+
>;
|
|
1417
|
+
request?: SecondParameter<typeof customInstance>;
|
|
1418
|
+
},
|
|
1419
|
+
queryClient?: QueryClient,
|
|
1420
|
+
): UseMutationResult<Awaited<ReturnType<typeof adminJobManifestLoad>>, TError, void, TContext> => {
|
|
1421
|
+
const mutationOptions = useAdminJobManifestLoadMutationOptions(options);
|
|
1422
|
+
|
|
1423
|
+
return useMutation(mutationOptions, queryClient);
|
|
1424
|
+
};
|