@squonk/data-manager-client 4.1.5 → 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 +112 -68
- package/accounting/accounting.cjs.map +1 -1
- package/accounting/accounting.d.cts +93 -36
- package/accounting/accounting.d.ts +93 -36
- package/accounting/accounting.js +117 -73
- 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 +87 -100
- package/index.cjs.map +1 -1
- package/index.d.cts +2426 -2311
- package/index.d.ts +2426 -2311
- package/index.js +86 -99
- package/index.js.map +1 -1
- package/instance/instance.cjs +100 -107
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.d.cts +78 -76
- package/instance/instance.d.ts +78 -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 +790 -343
- 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 +2529 -2439
- 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 +806 -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/instance/instance.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
|
GetInstancesParams,
|
|
@@ -38,14 +35,15 @@ import type {
|
|
|
38
35
|
InstancePostResponse,
|
|
39
36
|
InstancesGetResponse,
|
|
40
37
|
PatchInstanceParams,
|
|
41
|
-
TaskIdentity
|
|
42
|
-
} from
|
|
43
|
-
import { customInstance } from '.././custom-instance';
|
|
44
|
-
import type { ErrorType } from '.././custom-instance';
|
|
45
|
-
|
|
38
|
+
TaskIdentity,
|
|
39
|
+
} from "../data-manager-api.schemas";
|
|
46
40
|
|
|
47
|
-
|
|
41
|
+
import { customInstance } from ".././custom-instance";
|
|
42
|
+
import type { ErrorType } from ".././custom-instance";
|
|
43
|
+
import { mutationMutator } from ".././options-mutator";
|
|
44
|
+
import { queryMutator } from ".././options-mutator";
|
|
48
45
|
|
|
46
|
+
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
49
47
|
|
|
50
48
|
/**
|
|
51
49
|
* Launches a new Application or Job instance, returning an Instance and Task ID. The Task ID should be used against the `/task` endpoint to determine the availability of the the running instance.
|
|
@@ -59,231 +57,339 @@ A Job instance typically runs to completion, reaching the **TaskState** _SUCCESS
|
|
|
59
57
|
* @summary Creates a new Job or Application instance
|
|
60
58
|
*/
|
|
61
59
|
export const createInstance = (
|
|
62
|
-
|
|
63
|
-
|
|
60
|
+
instancePostBodyBody: InstancePostBodyBody,
|
|
61
|
+
options?: SecondParameter<typeof customInstance>,
|
|
62
|
+
signal?: AbortSignal,
|
|
64
63
|
) => {
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
formUrlEncoded.append(
|
|
68
|
-
formUrlEncoded.append(
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
64
|
+
const formUrlEncoded = new URLSearchParams();
|
|
65
|
+
formUrlEncoded.append(`application_id`, instancePostBodyBody.application_id);
|
|
66
|
+
formUrlEncoded.append(`project_id`, instancePostBodyBody.project_id);
|
|
67
|
+
formUrlEncoded.append(`as_name`, instancePostBodyBody.as_name);
|
|
68
|
+
if (instancePostBodyBody.callback_url !== undefined) {
|
|
69
|
+
formUrlEncoded.append(`callback_url`, instancePostBodyBody.callback_url);
|
|
70
|
+
}
|
|
71
|
+
if (instancePostBodyBody.callback_context !== undefined) {
|
|
72
|
+
formUrlEncoded.append(`callback_context`, instancePostBodyBody.callback_context);
|
|
73
|
+
}
|
|
74
|
+
if (instancePostBodyBody.generate_callback_token !== undefined) {
|
|
75
|
+
formUrlEncoded.append(
|
|
76
|
+
`generate_callback_token`,
|
|
77
|
+
instancePostBodyBody.generate_callback_token.toString(),
|
|
78
|
+
);
|
|
79
|
+
}
|
|
80
|
+
if (instancePostBodyBody.callback_token !== undefined) {
|
|
81
|
+
formUrlEncoded.append(`callback_token`, instancePostBodyBody.callback_token);
|
|
82
|
+
}
|
|
83
|
+
if (instancePostBodyBody.debug !== undefined) {
|
|
84
|
+
formUrlEncoded.append(`debug`, instancePostBodyBody.debug);
|
|
85
|
+
}
|
|
86
|
+
if (instancePostBodyBody.specification !== undefined) {
|
|
87
|
+
formUrlEncoded.append(`specification`, instancePostBodyBody.specification);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
return customInstance<InstancePostResponse>(
|
|
91
|
+
{
|
|
92
|
+
url: `/instance`,
|
|
93
|
+
method: "POST",
|
|
94
|
+
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
|
95
|
+
data: formUrlEncoded,
|
|
96
|
+
signal,
|
|
93
97
|
},
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
98
|
+
options,
|
|
99
|
+
);
|
|
100
|
+
};
|
|
101
|
+
|
|
102
|
+
export const useCreateInstanceMutationOptions = <
|
|
103
|
+
TError = ErrorType<void | DmError>,
|
|
104
|
+
TContext = unknown,
|
|
105
|
+
>(options?: {
|
|
106
|
+
mutation?: UseMutationOptions<
|
|
107
|
+
Awaited<ReturnType<typeof createInstance>>,
|
|
108
|
+
TError,
|
|
109
|
+
{ data: InstancePostBodyBody },
|
|
110
|
+
TContext
|
|
111
|
+
>;
|
|
112
|
+
request?: SecondParameter<typeof customInstance>;
|
|
113
|
+
}): UseMutationOptions<
|
|
114
|
+
Awaited<ReturnType<typeof createInstance>>,
|
|
115
|
+
TError,
|
|
116
|
+
{ data: InstancePostBodyBody },
|
|
117
|
+
TContext
|
|
118
|
+
> => {
|
|
119
|
+
const mutationKey = ["createInstance"];
|
|
120
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
121
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
122
|
+
? options
|
|
123
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
124
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
125
|
+
|
|
126
|
+
const mutationFn: MutationFunction<
|
|
127
|
+
Awaited<ReturnType<typeof createInstance>>,
|
|
128
|
+
{ data: InstancePostBodyBody }
|
|
129
|
+
> = (props) => {
|
|
130
|
+
const { data } = props ?? {};
|
|
131
|
+
|
|
132
|
+
return createInstance(data, requestOptions);
|
|
133
|
+
};
|
|
134
|
+
|
|
135
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
136
|
+
|
|
137
|
+
return customOptions;
|
|
138
|
+
};
|
|
139
|
+
|
|
140
|
+
export type CreateInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof createInstance>>>;
|
|
141
|
+
export type CreateInstanceMutationBody = InstancePostBodyBody;
|
|
142
|
+
export type CreateInstanceMutationError = ErrorType<void | DmError>;
|
|
119
143
|
|
|
120
|
-
|
|
121
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{data: InstancePostBodyBody}, TContext>}
|
|
122
|
-
|
|
123
|
-
export type CreateInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof createInstance>>>
|
|
124
|
-
export type CreateInstanceMutationBody = InstancePostBodyBody
|
|
125
|
-
export type CreateInstanceMutationError = ErrorType<void | DmError>
|
|
126
|
-
|
|
127
|
-
/**
|
|
144
|
+
/**
|
|
128
145
|
* @summary Creates a new Job or Application instance
|
|
129
146
|
*/
|
|
130
|
-
export const useCreateInstance = <
|
|
131
|
-
|
|
147
|
+
export const useCreateInstance = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
148
|
+
options?: {
|
|
149
|
+
mutation?: UseMutationOptions<
|
|
150
|
+
Awaited<ReturnType<typeof createInstance>>,
|
|
151
|
+
TError,
|
|
152
|
+
{ data: InstancePostBodyBody },
|
|
153
|
+
TContext
|
|
154
|
+
>;
|
|
155
|
+
request?: SecondParameter<typeof customInstance>;
|
|
156
|
+
},
|
|
157
|
+
queryClient?: QueryClient,
|
|
132
158
|
): UseMutationResult<
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
/**
|
|
159
|
+
Awaited<ReturnType<typeof createInstance>>,
|
|
160
|
+
TError,
|
|
161
|
+
{ data: InstancePostBodyBody },
|
|
162
|
+
TContext
|
|
163
|
+
> => {
|
|
164
|
+
const mutationOptions = useCreateInstanceMutationOptions(options);
|
|
165
|
+
|
|
166
|
+
return useMutation(mutationOptions, queryClient);
|
|
167
|
+
};
|
|
168
|
+
/**
|
|
144
169
|
* Returns a summary of all running instances. Instances can be running as an Application or as a Job. The response will contain an `application_type` field that is either `job` or `application`
|
|
145
170
|
|
|
171
|
+
Results can be filtered by **Project**, **Unit** or **Organisation**.
|
|
172
|
+
|
|
146
173
|
* @summary Get summary information about all Job and Application instances
|
|
147
174
|
*/
|
|
148
175
|
export const getInstances = (
|
|
149
|
-
|
|
150
|
-
|
|
176
|
+
params?: GetInstancesParams,
|
|
177
|
+
options?: SecondParameter<typeof customInstance>,
|
|
178
|
+
signal?: AbortSignal,
|
|
151
179
|
) => {
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
export const
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
180
|
+
return customInstance<InstancesGetResponse>(
|
|
181
|
+
{ url: `/instance`, method: "GET", params, signal },
|
|
182
|
+
options,
|
|
183
|
+
);
|
|
184
|
+
};
|
|
185
|
+
|
|
186
|
+
export const getGetInstancesQueryKey = (params?: GetInstancesParams) => {
|
|
187
|
+
return [`/instance`, ...(params ? [params] : [])] as const;
|
|
188
|
+
};
|
|
189
|
+
|
|
190
|
+
export const useGetInstancesQueryOptions = <
|
|
191
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
192
|
+
TError = ErrorType<void | DmError>,
|
|
193
|
+
>(
|
|
194
|
+
params?: GetInstancesParams,
|
|
195
|
+
options?: {
|
|
196
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
|
|
197
|
+
request?: SecondParameter<typeof customInstance>;
|
|
198
|
+
},
|
|
168
199
|
) => {
|
|
200
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
169
201
|
|
|
170
|
-
const
|
|
171
|
-
|
|
172
|
-
const queryKey = queryOptions?.queryKey ?? getGetInstancesQueryKey(params);
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
const queryFn: QueryFunction<Awaited<ReturnType<typeof getInstances>>> = ({ signal }) => getInstances(params, requestOptions, signal);
|
|
202
|
+
const queryKey = queryOptions?.queryKey ?? getGetInstancesQueryKey(params);
|
|
177
203
|
|
|
178
|
-
|
|
204
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getInstances>>> = ({ signal }) =>
|
|
205
|
+
getInstances(params, requestOptions, signal);
|
|
179
206
|
|
|
180
|
-
|
|
207
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
181
208
|
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
209
|
+
return customOptions as UseQueryOptions<
|
|
210
|
+
Awaited<ReturnType<typeof getInstances>>,
|
|
211
|
+
TError,
|
|
212
|
+
TData
|
|
213
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
214
|
+
};
|
|
187
215
|
|
|
216
|
+
export type GetInstancesQueryResult = NonNullable<Awaited<ReturnType<typeof getInstances>>>;
|
|
217
|
+
export type GetInstancesQueryError = ErrorType<void | DmError>;
|
|
188
218
|
|
|
189
|
-
export function useGetInstances<
|
|
190
|
-
|
|
219
|
+
export function useGetInstances<
|
|
220
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
221
|
+
TError = ErrorType<void | DmError>,
|
|
222
|
+
>(
|
|
223
|
+
params: undefined | GetInstancesParams,
|
|
224
|
+
options: {
|
|
225
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>> &
|
|
226
|
+
Pick<
|
|
191
227
|
DefinedInitialDataOptions<
|
|
192
228
|
Awaited<ReturnType<typeof getInstances>>,
|
|
193
229
|
TError,
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
230
|
+
Awaited<ReturnType<typeof getInstances>>
|
|
231
|
+
>,
|
|
232
|
+
"initialData"
|
|
233
|
+
>;
|
|
234
|
+
request?: SecondParameter<typeof customInstance>;
|
|
235
|
+
},
|
|
236
|
+
queryClient?: QueryClient,
|
|
237
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
238
|
+
export function useGetInstances<
|
|
239
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
240
|
+
TError = ErrorType<void | DmError>,
|
|
241
|
+
>(
|
|
242
|
+
params?: GetInstancesParams,
|
|
243
|
+
options?: {
|
|
244
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>> &
|
|
245
|
+
Pick<
|
|
201
246
|
UndefinedInitialDataOptions<
|
|
202
247
|
Awaited<ReturnType<typeof getInstances>>,
|
|
203
248
|
TError,
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
249
|
+
Awaited<ReturnType<typeof getInstances>>
|
|
250
|
+
>,
|
|
251
|
+
"initialData"
|
|
252
|
+
>;
|
|
253
|
+
request?: SecondParameter<typeof customInstance>;
|
|
254
|
+
},
|
|
255
|
+
queryClient?: QueryClient,
|
|
256
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
257
|
+
export function useGetInstances<
|
|
258
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
259
|
+
TError = ErrorType<void | DmError>,
|
|
260
|
+
>(
|
|
261
|
+
params?: GetInstancesParams,
|
|
262
|
+
options?: {
|
|
263
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
|
|
264
|
+
request?: SecondParameter<typeof customInstance>;
|
|
265
|
+
},
|
|
266
|
+
queryClient?: QueryClient,
|
|
267
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
213
268
|
/**
|
|
214
269
|
* @summary Get summary information about all Job and Application instances
|
|
215
270
|
*/
|
|
216
271
|
|
|
217
|
-
export function useGetInstances<
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
272
|
+
export function useGetInstances<
|
|
273
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
274
|
+
TError = ErrorType<void | DmError>,
|
|
275
|
+
>(
|
|
276
|
+
params?: GetInstancesParams,
|
|
277
|
+
options?: {
|
|
278
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>>;
|
|
279
|
+
request?: SecondParameter<typeof customInstance>;
|
|
280
|
+
},
|
|
281
|
+
queryClient?: QueryClient,
|
|
282
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
283
|
+
const queryOptions = useGetInstancesQueryOptions(params, options);
|
|
284
|
+
|
|
285
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
286
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
287
|
+
};
|
|
288
|
+
|
|
289
|
+
query.queryKey = queryOptions.queryKey;
|
|
227
290
|
|
|
228
291
|
return query;
|
|
229
292
|
}
|
|
230
293
|
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
294
|
+
export const useGetInstancesSuspenseQueryOptions = <
|
|
295
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
296
|
+
TError = ErrorType<void | DmError>,
|
|
297
|
+
>(
|
|
298
|
+
params?: GetInstancesParams,
|
|
299
|
+
options?: {
|
|
300
|
+
query?: Partial<
|
|
301
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>
|
|
302
|
+
>;
|
|
303
|
+
request?: SecondParameter<typeof customInstance>;
|
|
304
|
+
},
|
|
234
305
|
) => {
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
}
|
|
250
|
-
|
|
251
|
-
export type GetInstancesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getInstances
|
|
252
|
-
export type GetInstancesSuspenseQueryError = ErrorType<void | DmError
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
306
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
307
|
+
|
|
308
|
+
const queryKey = queryOptions?.queryKey ?? getGetInstancesQueryKey(params);
|
|
309
|
+
|
|
310
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getInstances>>> = ({ signal }) =>
|
|
311
|
+
getInstances(params, requestOptions, signal);
|
|
312
|
+
|
|
313
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
314
|
+
|
|
315
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
316
|
+
Awaited<ReturnType<typeof getInstances>>,
|
|
317
|
+
TError,
|
|
318
|
+
TData
|
|
319
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
320
|
+
};
|
|
321
|
+
|
|
322
|
+
export type GetInstancesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getInstances>>>;
|
|
323
|
+
export type GetInstancesSuspenseQueryError = ErrorType<void | DmError>;
|
|
324
|
+
|
|
325
|
+
export function useGetInstancesSuspense<
|
|
326
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
327
|
+
TError = ErrorType<void | DmError>,
|
|
328
|
+
>(
|
|
329
|
+
params: undefined | GetInstancesParams,
|
|
330
|
+
options: {
|
|
331
|
+
query: Partial<
|
|
332
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>
|
|
333
|
+
>;
|
|
334
|
+
request?: SecondParameter<typeof customInstance>;
|
|
335
|
+
},
|
|
336
|
+
queryClient?: QueryClient,
|
|
337
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
338
|
+
export function useGetInstancesSuspense<
|
|
339
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
340
|
+
TError = ErrorType<void | DmError>,
|
|
341
|
+
>(
|
|
342
|
+
params?: GetInstancesParams,
|
|
343
|
+
options?: {
|
|
344
|
+
query?: Partial<
|
|
345
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>
|
|
346
|
+
>;
|
|
347
|
+
request?: SecondParameter<typeof customInstance>;
|
|
348
|
+
},
|
|
349
|
+
queryClient?: QueryClient,
|
|
350
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
351
|
+
export function useGetInstancesSuspense<
|
|
352
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
353
|
+
TError = ErrorType<void | DmError>,
|
|
354
|
+
>(
|
|
355
|
+
params?: GetInstancesParams,
|
|
356
|
+
options?: {
|
|
357
|
+
query?: Partial<
|
|
358
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>
|
|
359
|
+
>;
|
|
360
|
+
request?: SecondParameter<typeof customInstance>;
|
|
361
|
+
},
|
|
362
|
+
queryClient?: QueryClient,
|
|
363
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
267
364
|
/**
|
|
268
365
|
* @summary Get summary information about all Job and Application instances
|
|
269
366
|
*/
|
|
270
367
|
|
|
271
|
-
export function useGetInstancesSuspense<
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
368
|
+
export function useGetInstancesSuspense<
|
|
369
|
+
TData = Awaited<ReturnType<typeof getInstances>>,
|
|
370
|
+
TError = ErrorType<void | DmError>,
|
|
371
|
+
>(
|
|
372
|
+
params?: GetInstancesParams,
|
|
373
|
+
options?: {
|
|
374
|
+
query?: Partial<
|
|
375
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstances>>, TError, TData>
|
|
376
|
+
>;
|
|
377
|
+
request?: SecondParameter<typeof customInstance>;
|
|
378
|
+
},
|
|
379
|
+
queryClient?: QueryClient,
|
|
380
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
381
|
+
const queryOptions = useGetInstancesSuspenseQueryOptions(params, options);
|
|
382
|
+
|
|
383
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
384
|
+
TData,
|
|
385
|
+
TError
|
|
386
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
387
|
+
|
|
388
|
+
query.queryKey = queryOptions.queryKey;
|
|
281
389
|
|
|
282
390
|
return query;
|
|
283
391
|
}
|
|
284
392
|
|
|
285
|
-
|
|
286
|
-
|
|
287
393
|
/**
|
|
288
394
|
* Similar to the `/instance [POST]` endpoint this one is used to check whether a new **Application** or **Job** instance can be launched. Rather than returning an **Instance** (or **Task**) ID this endpoint is simply used to ensure that the Job/Application is runnable while also returning the compiled `command` (if the Instance is a Job).
|
|
289
395
|
|
|
@@ -292,228 +398,333 @@ The test result is only valid at the time of the call, whether an actual instanc
|
|
|
292
398
|
* @summary Used to check the execution of new Job or Application instance
|
|
293
399
|
*/
|
|
294
400
|
export const dryRunInstance = (
|
|
295
|
-
|
|
296
|
-
|
|
401
|
+
instancePostBodyBody: InstancePostBodyBody,
|
|
402
|
+
options?: SecondParameter<typeof customInstance>,
|
|
403
|
+
signal?: AbortSignal,
|
|
297
404
|
) => {
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
formUrlEncoded.append(
|
|
301
|
-
formUrlEncoded.append(
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
405
|
+
const formUrlEncoded = new URLSearchParams();
|
|
406
|
+
formUrlEncoded.append(`application_id`, instancePostBodyBody.application_id);
|
|
407
|
+
formUrlEncoded.append(`project_id`, instancePostBodyBody.project_id);
|
|
408
|
+
formUrlEncoded.append(`as_name`, instancePostBodyBody.as_name);
|
|
409
|
+
if (instancePostBodyBody.callback_url !== undefined) {
|
|
410
|
+
formUrlEncoded.append(`callback_url`, instancePostBodyBody.callback_url);
|
|
411
|
+
}
|
|
412
|
+
if (instancePostBodyBody.callback_context !== undefined) {
|
|
413
|
+
formUrlEncoded.append(`callback_context`, instancePostBodyBody.callback_context);
|
|
414
|
+
}
|
|
415
|
+
if (instancePostBodyBody.generate_callback_token !== undefined) {
|
|
416
|
+
formUrlEncoded.append(
|
|
417
|
+
`generate_callback_token`,
|
|
418
|
+
instancePostBodyBody.generate_callback_token.toString(),
|
|
419
|
+
);
|
|
420
|
+
}
|
|
421
|
+
if (instancePostBodyBody.callback_token !== undefined) {
|
|
422
|
+
formUrlEncoded.append(`callback_token`, instancePostBodyBody.callback_token);
|
|
423
|
+
}
|
|
424
|
+
if (instancePostBodyBody.debug !== undefined) {
|
|
425
|
+
formUrlEncoded.append(`debug`, instancePostBodyBody.debug);
|
|
426
|
+
}
|
|
427
|
+
if (instancePostBodyBody.specification !== undefined) {
|
|
428
|
+
formUrlEncoded.append(`specification`, instancePostBodyBody.specification);
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
return customInstance<InstanceDryRunPostResponse>(
|
|
432
|
+
{
|
|
433
|
+
url: `/instance/dry-run`,
|
|
434
|
+
method: "POST",
|
|
435
|
+
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
|
436
|
+
data: formUrlEncoded,
|
|
437
|
+
signal,
|
|
326
438
|
},
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
439
|
+
options,
|
|
440
|
+
);
|
|
441
|
+
};
|
|
442
|
+
|
|
443
|
+
export const useDryRunInstanceMutationOptions = <
|
|
444
|
+
TError = ErrorType<void | DmError>,
|
|
445
|
+
TContext = unknown,
|
|
446
|
+
>(options?: {
|
|
447
|
+
mutation?: UseMutationOptions<
|
|
448
|
+
Awaited<ReturnType<typeof dryRunInstance>>,
|
|
449
|
+
TError,
|
|
450
|
+
{ data: InstancePostBodyBody },
|
|
451
|
+
TContext
|
|
452
|
+
>;
|
|
453
|
+
request?: SecondParameter<typeof customInstance>;
|
|
454
|
+
}): UseMutationOptions<
|
|
455
|
+
Awaited<ReturnType<typeof dryRunInstance>>,
|
|
456
|
+
TError,
|
|
457
|
+
{ data: InstancePostBodyBody },
|
|
458
|
+
TContext
|
|
459
|
+
> => {
|
|
460
|
+
const mutationKey = ["dryRunInstance"];
|
|
461
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
462
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
463
|
+
? options
|
|
464
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
465
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
466
|
+
|
|
467
|
+
const mutationFn: MutationFunction<
|
|
468
|
+
Awaited<ReturnType<typeof dryRunInstance>>,
|
|
469
|
+
{ data: InstancePostBodyBody }
|
|
470
|
+
> = (props) => {
|
|
471
|
+
const { data } = props ?? {};
|
|
472
|
+
|
|
473
|
+
return dryRunInstance(data, requestOptions);
|
|
474
|
+
};
|
|
475
|
+
|
|
476
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
477
|
+
|
|
478
|
+
return customOptions;
|
|
479
|
+
};
|
|
480
|
+
|
|
481
|
+
export type DryRunInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof dryRunInstance>>>;
|
|
482
|
+
export type DryRunInstanceMutationBody = InstancePostBodyBody;
|
|
483
|
+
export type DryRunInstanceMutationError = ErrorType<void | DmError>;
|
|
350
484
|
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{data: InstancePostBodyBody}, TContext>}
|
|
355
|
-
|
|
356
|
-
export type DryRunInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof dryRunInstance>>>
|
|
357
|
-
export type DryRunInstanceMutationBody = InstancePostBodyBody
|
|
358
|
-
export type DryRunInstanceMutationError = ErrorType<void | DmError>
|
|
359
|
-
|
|
360
|
-
/**
|
|
485
|
+
/**
|
|
361
486
|
* @summary Used to check the execution of new Job or Application instance
|
|
362
487
|
*/
|
|
363
|
-
export const useDryRunInstance = <
|
|
364
|
-
|
|
488
|
+
export const useDryRunInstance = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
489
|
+
options?: {
|
|
490
|
+
mutation?: UseMutationOptions<
|
|
491
|
+
Awaited<ReturnType<typeof dryRunInstance>>,
|
|
492
|
+
TError,
|
|
493
|
+
{ data: InstancePostBodyBody },
|
|
494
|
+
TContext
|
|
495
|
+
>;
|
|
496
|
+
request?: SecondParameter<typeof customInstance>;
|
|
497
|
+
},
|
|
498
|
+
queryClient?: QueryClient,
|
|
365
499
|
): UseMutationResult<
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
/**
|
|
500
|
+
Awaited<ReturnType<typeof dryRunInstance>>,
|
|
501
|
+
TError,
|
|
502
|
+
{ data: InstancePostBodyBody },
|
|
503
|
+
TContext
|
|
504
|
+
> => {
|
|
505
|
+
const mutationOptions = useDryRunInstanceMutationOptions(options);
|
|
506
|
+
|
|
507
|
+
return useMutation(mutationOptions, queryClient);
|
|
508
|
+
};
|
|
509
|
+
/**
|
|
377
510
|
* @summary Get detailed information about an Instance
|
|
378
511
|
*/
|
|
379
512
|
export const getInstance = (
|
|
380
|
-
|
|
381
|
-
|
|
513
|
+
instanceId: string,
|
|
514
|
+
options?: SecondParameter<typeof customInstance>,
|
|
515
|
+
signal?: AbortSignal,
|
|
382
516
|
) => {
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
517
|
+
return customInstance<InstanceGetResponse>(
|
|
518
|
+
{ url: `/instance/${instanceId}`, method: "GET", signal },
|
|
519
|
+
options,
|
|
520
|
+
);
|
|
521
|
+
};
|
|
522
|
+
|
|
523
|
+
export const getGetInstanceQueryKey = (instanceId: string) => {
|
|
524
|
+
return [`/instance/${instanceId}`] as const;
|
|
525
|
+
};
|
|
526
|
+
|
|
527
|
+
export const useGetInstanceQueryOptions = <
|
|
528
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
529
|
+
TError = ErrorType<void | DmError>,
|
|
530
|
+
>(
|
|
531
|
+
instanceId: string,
|
|
532
|
+
options?: {
|
|
533
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
|
|
534
|
+
request?: SecondParameter<typeof customInstance>;
|
|
535
|
+
},
|
|
398
536
|
) => {
|
|
537
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
399
538
|
|
|
400
|
-
const
|
|
401
|
-
|
|
402
|
-
const queryKey = queryOptions?.queryKey ?? getGetInstanceQueryKey(instanceId);
|
|
539
|
+
const queryKey = queryOptions?.queryKey ?? getGetInstanceQueryKey(instanceId);
|
|
403
540
|
|
|
404
|
-
|
|
541
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getInstance>>> = ({ signal }) =>
|
|
542
|
+
getInstance(instanceId, requestOptions, signal);
|
|
405
543
|
|
|
406
|
-
|
|
544
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
407
545
|
|
|
408
|
-
|
|
546
|
+
return customOptions as UseQueryOptions<
|
|
547
|
+
Awaited<ReturnType<typeof getInstance>>,
|
|
548
|
+
TError,
|
|
549
|
+
TData
|
|
550
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
551
|
+
};
|
|
409
552
|
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
return { queryKey, queryFn, enabled: !!(instanceId), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
|
|
413
|
-
}
|
|
553
|
+
export type GetInstanceQueryResult = NonNullable<Awaited<ReturnType<typeof getInstance>>>;
|
|
554
|
+
export type GetInstanceQueryError = ErrorType<void | DmError>;
|
|
414
555
|
|
|
415
|
-
export
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
556
|
+
export function useGetInstance<
|
|
557
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
558
|
+
TError = ErrorType<void | DmError>,
|
|
559
|
+
>(
|
|
560
|
+
instanceId: string,
|
|
561
|
+
options: {
|
|
562
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>> &
|
|
563
|
+
Pick<
|
|
421
564
|
DefinedInitialDataOptions<
|
|
422
565
|
Awaited<ReturnType<typeof getInstance>>,
|
|
423
566
|
TError,
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
567
|
+
Awaited<ReturnType<typeof getInstance>>
|
|
568
|
+
>,
|
|
569
|
+
"initialData"
|
|
570
|
+
>;
|
|
571
|
+
request?: SecondParameter<typeof customInstance>;
|
|
572
|
+
},
|
|
573
|
+
queryClient?: QueryClient,
|
|
574
|
+
): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
575
|
+
export function useGetInstance<
|
|
576
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
577
|
+
TError = ErrorType<void | DmError>,
|
|
578
|
+
>(
|
|
579
|
+
instanceId: string,
|
|
580
|
+
options?: {
|
|
581
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>> &
|
|
582
|
+
Pick<
|
|
431
583
|
UndefinedInitialDataOptions<
|
|
432
584
|
Awaited<ReturnType<typeof getInstance>>,
|
|
433
585
|
TError,
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
586
|
+
Awaited<ReturnType<typeof getInstance>>
|
|
587
|
+
>,
|
|
588
|
+
"initialData"
|
|
589
|
+
>;
|
|
590
|
+
request?: SecondParameter<typeof customInstance>;
|
|
591
|
+
},
|
|
592
|
+
queryClient?: QueryClient,
|
|
593
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
594
|
+
export function useGetInstance<
|
|
595
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
596
|
+
TError = ErrorType<void | DmError>,
|
|
597
|
+
>(
|
|
598
|
+
instanceId: string,
|
|
599
|
+
options?: {
|
|
600
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
|
|
601
|
+
request?: SecondParameter<typeof customInstance>;
|
|
602
|
+
},
|
|
603
|
+
queryClient?: QueryClient,
|
|
604
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
443
605
|
/**
|
|
444
606
|
* @summary Get detailed information about an Instance
|
|
445
607
|
*/
|
|
446
608
|
|
|
447
|
-
export function useGetInstance<
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
609
|
+
export function useGetInstance<
|
|
610
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
611
|
+
TError = ErrorType<void | DmError>,
|
|
612
|
+
>(
|
|
613
|
+
instanceId: string,
|
|
614
|
+
options?: {
|
|
615
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
|
|
616
|
+
request?: SecondParameter<typeof customInstance>;
|
|
617
|
+
},
|
|
618
|
+
queryClient?: QueryClient,
|
|
619
|
+
): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
620
|
+
const queryOptions = useGetInstanceQueryOptions(instanceId, options);
|
|
621
|
+
|
|
622
|
+
const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
|
|
623
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
624
|
+
};
|
|
625
|
+
|
|
626
|
+
query.queryKey = queryOptions.queryKey;
|
|
457
627
|
|
|
458
628
|
return query;
|
|
459
629
|
}
|
|
460
630
|
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
631
|
+
export const useGetInstanceSuspenseQueryOptions = <
|
|
632
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
633
|
+
TError = ErrorType<void | DmError>,
|
|
634
|
+
>(
|
|
635
|
+
instanceId: string,
|
|
636
|
+
options?: {
|
|
637
|
+
query?: Partial<
|
|
638
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>
|
|
639
|
+
>;
|
|
640
|
+
request?: SecondParameter<typeof customInstance>;
|
|
641
|
+
},
|
|
464
642
|
) => {
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
}
|
|
480
|
-
|
|
481
|
-
export type GetInstanceSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getInstance
|
|
482
|
-
export type GetInstanceSuspenseQueryError = ErrorType<void | DmError
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
643
|
+
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
644
|
+
|
|
645
|
+
const queryKey = queryOptions?.queryKey ?? getGetInstanceQueryKey(instanceId);
|
|
646
|
+
|
|
647
|
+
const queryFn: QueryFunction<Awaited<ReturnType<typeof getInstance>>> = ({ signal }) =>
|
|
648
|
+
getInstance(instanceId, requestOptions, signal);
|
|
649
|
+
|
|
650
|
+
const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
|
|
651
|
+
|
|
652
|
+
return customOptions as UseSuspenseQueryOptions<
|
|
653
|
+
Awaited<ReturnType<typeof getInstance>>,
|
|
654
|
+
TError,
|
|
655
|
+
TData
|
|
656
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
657
|
+
};
|
|
658
|
+
|
|
659
|
+
export type GetInstanceSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getInstance>>>;
|
|
660
|
+
export type GetInstanceSuspenseQueryError = ErrorType<void | DmError>;
|
|
661
|
+
|
|
662
|
+
export function useGetInstanceSuspense<
|
|
663
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
664
|
+
TError = ErrorType<void | DmError>,
|
|
665
|
+
>(
|
|
666
|
+
instanceId: string,
|
|
667
|
+
options: {
|
|
668
|
+
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>>;
|
|
669
|
+
request?: SecondParameter<typeof customInstance>;
|
|
670
|
+
},
|
|
671
|
+
queryClient?: QueryClient,
|
|
672
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
673
|
+
export function useGetInstanceSuspense<
|
|
674
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
675
|
+
TError = ErrorType<void | DmError>,
|
|
676
|
+
>(
|
|
677
|
+
instanceId: string,
|
|
678
|
+
options?: {
|
|
679
|
+
query?: Partial<
|
|
680
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>
|
|
681
|
+
>;
|
|
682
|
+
request?: SecondParameter<typeof customInstance>;
|
|
683
|
+
},
|
|
684
|
+
queryClient?: QueryClient,
|
|
685
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
686
|
+
export function useGetInstanceSuspense<
|
|
687
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
688
|
+
TError = ErrorType<void | DmError>,
|
|
689
|
+
>(
|
|
690
|
+
instanceId: string,
|
|
691
|
+
options?: {
|
|
692
|
+
query?: Partial<
|
|
693
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>
|
|
694
|
+
>;
|
|
695
|
+
request?: SecondParameter<typeof customInstance>;
|
|
696
|
+
},
|
|
697
|
+
queryClient?: QueryClient,
|
|
698
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
497
699
|
/**
|
|
498
700
|
* @summary Get detailed information about an Instance
|
|
499
701
|
*/
|
|
500
702
|
|
|
501
|
-
export function useGetInstanceSuspense<
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
703
|
+
export function useGetInstanceSuspense<
|
|
704
|
+
TData = Awaited<ReturnType<typeof getInstance>>,
|
|
705
|
+
TError = ErrorType<void | DmError>,
|
|
706
|
+
>(
|
|
707
|
+
instanceId: string,
|
|
708
|
+
options?: {
|
|
709
|
+
query?: Partial<
|
|
710
|
+
UseSuspenseQueryOptions<Awaited<ReturnType<typeof getInstance>>, TError, TData>
|
|
711
|
+
>;
|
|
712
|
+
request?: SecondParameter<typeof customInstance>;
|
|
713
|
+
},
|
|
714
|
+
queryClient?: QueryClient,
|
|
715
|
+
): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
|
|
716
|
+
const queryOptions = useGetInstanceSuspenseQueryOptions(instanceId, options);
|
|
717
|
+
|
|
718
|
+
const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
|
|
719
|
+
TData,
|
|
720
|
+
TError
|
|
721
|
+
> & { queryKey: DataTag<QueryKey, TData, TError> };
|
|
722
|
+
|
|
723
|
+
query.queryKey = queryOptions.queryKey;
|
|
511
724
|
|
|
512
725
|
return query;
|
|
513
726
|
}
|
|
514
727
|
|
|
515
|
-
|
|
516
|
-
|
|
517
728
|
/**
|
|
518
729
|
* The Application or Job Instance is terminated.
|
|
519
730
|
|
|
@@ -522,63 +733,84 @@ You must be the `owner` or an `editor` of the Instance to delete it
|
|
|
522
733
|
* @summary Delete a Job or Application Instance
|
|
523
734
|
*/
|
|
524
735
|
export const terminateInstance = (
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
return customInstance<TaskIdentity>(
|
|
530
|
-
{url: `/instance/${instanceId}`, method: 'DELETE'
|
|
531
|
-
},
|
|
532
|
-
options);
|
|
533
|
-
}
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
export const getTerminateInstanceMutationOptions = <TData = Awaited<ReturnType<typeof terminateInstance>>, TError = ErrorType<void | DmError>,
|
|
538
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{instanceId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
736
|
+
instanceId: string,
|
|
737
|
+
options?: SecondParameter<typeof customInstance>,
|
|
539
738
|
) => {
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
739
|
+
return customInstance<TaskIdentity>(
|
|
740
|
+
{ url: `/instance/${instanceId}`, method: "DELETE" },
|
|
741
|
+
options,
|
|
742
|
+
);
|
|
743
|
+
};
|
|
744
|
+
|
|
745
|
+
export const useTerminateInstanceMutationOptions = <
|
|
746
|
+
TError = ErrorType<void | DmError>,
|
|
747
|
+
TContext = unknown,
|
|
748
|
+
>(options?: {
|
|
749
|
+
mutation?: UseMutationOptions<
|
|
750
|
+
Awaited<ReturnType<typeof terminateInstance>>,
|
|
751
|
+
TError,
|
|
752
|
+
{ instanceId: string },
|
|
753
|
+
TContext
|
|
754
|
+
>;
|
|
755
|
+
request?: SecondParameter<typeof customInstance>;
|
|
756
|
+
}): UseMutationOptions<
|
|
757
|
+
Awaited<ReturnType<typeof terminateInstance>>,
|
|
758
|
+
TError,
|
|
759
|
+
{ instanceId: string },
|
|
760
|
+
TContext
|
|
761
|
+
> => {
|
|
762
|
+
const mutationKey = ["terminateInstance"];
|
|
763
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
764
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
765
|
+
? options
|
|
766
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
767
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
768
|
+
|
|
769
|
+
const mutationFn: MutationFunction<
|
|
770
|
+
Awaited<ReturnType<typeof terminateInstance>>,
|
|
771
|
+
{ instanceId: string }
|
|
772
|
+
> = (props) => {
|
|
773
|
+
const { instanceId } = props ?? {};
|
|
774
|
+
|
|
775
|
+
return terminateInstance(instanceId, requestOptions);
|
|
776
|
+
};
|
|
777
|
+
|
|
778
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
779
|
+
|
|
780
|
+
return customOptions;
|
|
781
|
+
};
|
|
782
|
+
|
|
783
|
+
export type TerminateInstanceMutationResult = NonNullable<
|
|
784
|
+
Awaited<ReturnType<typeof terminateInstance>>
|
|
785
|
+
>;
|
|
786
|
+
|
|
787
|
+
export type TerminateInstanceMutationError = ErrorType<void | DmError>;
|
|
555
788
|
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{instanceId: string}, TContext>}
|
|
560
|
-
|
|
561
|
-
export type TerminateInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof terminateInstance>>>
|
|
562
|
-
|
|
563
|
-
export type TerminateInstanceMutationError = ErrorType<void | DmError>
|
|
564
|
-
|
|
565
|
-
/**
|
|
789
|
+
/**
|
|
566
790
|
* @summary Delete a Job or Application Instance
|
|
567
791
|
*/
|
|
568
|
-
export const useTerminateInstance = <
|
|
569
|
-
|
|
792
|
+
export const useTerminateInstance = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
793
|
+
options?: {
|
|
794
|
+
mutation?: UseMutationOptions<
|
|
795
|
+
Awaited<ReturnType<typeof terminateInstance>>,
|
|
796
|
+
TError,
|
|
797
|
+
{ instanceId: string },
|
|
798
|
+
TContext
|
|
799
|
+
>;
|
|
800
|
+
request?: SecondParameter<typeof customInstance>;
|
|
801
|
+
},
|
|
802
|
+
queryClient?: QueryClient,
|
|
570
803
|
): UseMutationResult<
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
/**
|
|
804
|
+
Awaited<ReturnType<typeof terminateInstance>>,
|
|
805
|
+
TError,
|
|
806
|
+
{ instanceId: string },
|
|
807
|
+
TContext
|
|
808
|
+
> => {
|
|
809
|
+
const mutationOptions = useTerminateInstanceMutationOptions(options);
|
|
810
|
+
|
|
811
|
+
return useMutation(mutationOptions, queryClient);
|
|
812
|
+
};
|
|
813
|
+
/**
|
|
582
814
|
* The Application or Job Instance is updated according to the patch parameters.
|
|
583
815
|
|
|
584
816
|
You must be the `owner` or an `editor` of the Instance to patch it
|
|
@@ -586,65 +818,80 @@ You must be the `owner` or an `editor` of the Instance to patch it
|
|
|
586
818
|
* @summary Update a Job or Application Instance
|
|
587
819
|
*/
|
|
588
820
|
export const patchInstance = (
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
return customInstance<void>(
|
|
595
|
-
{url: `/instance/${instanceId}`, method: 'PATCH',
|
|
596
|
-
params
|
|
597
|
-
},
|
|
598
|
-
options);
|
|
599
|
-
}
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
export const getPatchInstanceMutationOptions = <TData = Awaited<ReturnType<typeof patchInstance>>, TError = ErrorType<void | DmError>,
|
|
604
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{instanceId: string;params?: PatchInstanceParams}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
821
|
+
instanceId: string,
|
|
822
|
+
params?: PatchInstanceParams,
|
|
823
|
+
options?: SecondParameter<typeof customInstance>,
|
|
605
824
|
) => {
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
825
|
+
return customInstance<void>({ url: `/instance/${instanceId}`, method: "PATCH", params }, options);
|
|
826
|
+
};
|
|
827
|
+
|
|
828
|
+
export const usePatchInstanceMutationOptions = <
|
|
829
|
+
TError = ErrorType<void | DmError>,
|
|
830
|
+
TContext = unknown,
|
|
831
|
+
>(options?: {
|
|
832
|
+
mutation?: UseMutationOptions<
|
|
833
|
+
Awaited<ReturnType<typeof patchInstance>>,
|
|
834
|
+
TError,
|
|
835
|
+
{ instanceId: string; params?: PatchInstanceParams },
|
|
836
|
+
TContext
|
|
837
|
+
>;
|
|
838
|
+
request?: SecondParameter<typeof customInstance>;
|
|
839
|
+
}): UseMutationOptions<
|
|
840
|
+
Awaited<ReturnType<typeof patchInstance>>,
|
|
841
|
+
TError,
|
|
842
|
+
{ instanceId: string; params?: PatchInstanceParams },
|
|
843
|
+
TContext
|
|
844
|
+
> => {
|
|
845
|
+
const mutationKey = ["patchInstance"];
|
|
846
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
847
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
848
|
+
? options
|
|
849
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
850
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
851
|
+
|
|
852
|
+
const mutationFn: MutationFunction<
|
|
853
|
+
Awaited<ReturnType<typeof patchInstance>>,
|
|
854
|
+
{ instanceId: string; params?: PatchInstanceParams }
|
|
855
|
+
> = (props) => {
|
|
856
|
+
const { instanceId, params } = props ?? {};
|
|
857
|
+
|
|
858
|
+
return patchInstance(instanceId, params, requestOptions);
|
|
859
|
+
};
|
|
860
|
+
|
|
861
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
862
|
+
|
|
863
|
+
return customOptions;
|
|
864
|
+
};
|
|
865
|
+
|
|
866
|
+
export type PatchInstanceMutationResult = NonNullable<Awaited<ReturnType<typeof patchInstance>>>;
|
|
867
|
+
|
|
868
|
+
export type PatchInstanceMutationError = ErrorType<void | DmError>;
|
|
630
869
|
|
|
631
|
-
|
|
870
|
+
/**
|
|
632
871
|
* @summary Update a Job or Application Instance
|
|
633
872
|
*/
|
|
634
|
-
export const usePatchInstance = <
|
|
635
|
-
|
|
873
|
+
export const usePatchInstance = <TError = ErrorType<void | DmError>, TContext = unknown>(
|
|
874
|
+
options?: {
|
|
875
|
+
mutation?: UseMutationOptions<
|
|
876
|
+
Awaited<ReturnType<typeof patchInstance>>,
|
|
877
|
+
TError,
|
|
878
|
+
{ instanceId: string; params?: PatchInstanceParams },
|
|
879
|
+
TContext
|
|
880
|
+
>;
|
|
881
|
+
request?: SecondParameter<typeof customInstance>;
|
|
882
|
+
},
|
|
883
|
+
queryClient?: QueryClient,
|
|
636
884
|
): UseMutationResult<
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
/**
|
|
885
|
+
Awaited<ReturnType<typeof patchInstance>>,
|
|
886
|
+
TError,
|
|
887
|
+
{ instanceId: string; params?: PatchInstanceParams },
|
|
888
|
+
TContext
|
|
889
|
+
> => {
|
|
890
|
+
const mutationOptions = usePatchInstanceMutationOptions(options);
|
|
891
|
+
|
|
892
|
+
return useMutation(mutationOptions, queryClient);
|
|
893
|
+
};
|
|
894
|
+
/**
|
|
648
895
|
* This revokes the instance **Token**, which was optionally generated when the instance was launched. No authentication is required to use this endpoint, which is typically used by a remote system driven by instance callbacks.
|
|
649
896
|
|
|
650
897
|
Tokens automatically expire after a period of time but can be revoked instantly with this endpoint.
|
|
@@ -654,61 +901,81 @@ The remote system will revoke the token when it's finished with it
|
|
|
654
901
|
* @summary Delete (revoke) the Instance Token
|
|
655
902
|
*/
|
|
656
903
|
export const deleteInstanceToken = (
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
return customInstance<void>(
|
|
663
|
-
{url: `/instance/${instanceId}/token/${token}`, method: 'DELETE'
|
|
664
|
-
},
|
|
665
|
-
options);
|
|
666
|
-
}
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
export const getDeleteInstanceTokenMutationOptions = <TData = Awaited<ReturnType<typeof deleteInstanceToken>>, TError = ErrorType<DmError>,
|
|
671
|
-
TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{instanceId: string;token: string}, TContext>, request?: SecondParameter<typeof customInstance>}
|
|
904
|
+
instanceId: string,
|
|
905
|
+
token: string,
|
|
906
|
+
options?: SecondParameter<typeof customInstance>,
|
|
672
907
|
) => {
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
908
|
+
return customInstance<void>(
|
|
909
|
+
{ url: `/instance/${instanceId}/token/${token}`, method: "DELETE" },
|
|
910
|
+
options,
|
|
911
|
+
);
|
|
912
|
+
};
|
|
913
|
+
|
|
914
|
+
export const useDeleteInstanceTokenMutationOptions = <
|
|
915
|
+
TError = ErrorType<DmError>,
|
|
916
|
+
TContext = unknown,
|
|
917
|
+
>(options?: {
|
|
918
|
+
mutation?: UseMutationOptions<
|
|
919
|
+
Awaited<ReturnType<typeof deleteInstanceToken>>,
|
|
920
|
+
TError,
|
|
921
|
+
{ instanceId: string; token: string },
|
|
922
|
+
TContext
|
|
923
|
+
>;
|
|
924
|
+
request?: SecondParameter<typeof customInstance>;
|
|
925
|
+
}): UseMutationOptions<
|
|
926
|
+
Awaited<ReturnType<typeof deleteInstanceToken>>,
|
|
927
|
+
TError,
|
|
928
|
+
{ instanceId: string; token: string },
|
|
929
|
+
TContext
|
|
930
|
+
> => {
|
|
931
|
+
const mutationKey = ["deleteInstanceToken"];
|
|
932
|
+
const { mutation: mutationOptions, request: requestOptions } = options
|
|
933
|
+
? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
|
|
934
|
+
? options
|
|
935
|
+
: { ...options, mutation: { ...options.mutation, mutationKey } }
|
|
936
|
+
: { mutation: { mutationKey }, request: undefined };
|
|
937
|
+
|
|
938
|
+
const mutationFn: MutationFunction<
|
|
939
|
+
Awaited<ReturnType<typeof deleteInstanceToken>>,
|
|
940
|
+
{ instanceId: string; token: string }
|
|
941
|
+
> = (props) => {
|
|
942
|
+
const { instanceId, token } = props ?? {};
|
|
943
|
+
|
|
944
|
+
return deleteInstanceToken(instanceId, token, requestOptions);
|
|
945
|
+
};
|
|
946
|
+
|
|
947
|
+
const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
|
|
948
|
+
|
|
949
|
+
return customOptions;
|
|
950
|
+
};
|
|
951
|
+
|
|
952
|
+
export type DeleteInstanceTokenMutationResult = NonNullable<
|
|
953
|
+
Awaited<ReturnType<typeof deleteInstanceToken>>
|
|
954
|
+
>;
|
|
955
|
+
|
|
956
|
+
export type DeleteInstanceTokenMutationError = ErrorType<DmError>;
|
|
682
957
|
|
|
683
|
-
|
|
684
|
-
const {instanceId,token} = props ?? {};
|
|
685
|
-
|
|
686
|
-
return deleteInstanceToken(instanceId,token,requestOptions)
|
|
687
|
-
}
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
return { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,{instanceId: string;token: string}, TContext>}
|
|
693
|
-
|
|
694
|
-
export type DeleteInstanceTokenMutationResult = NonNullable<Awaited<ReturnType<typeof deleteInstanceToken>>>
|
|
695
|
-
|
|
696
|
-
export type DeleteInstanceTokenMutationError = ErrorType<DmError>
|
|
697
|
-
|
|
698
|
-
/**
|
|
958
|
+
/**
|
|
699
959
|
* @summary Delete (revoke) the Instance Token
|
|
700
960
|
*/
|
|
701
|
-
export const useDeleteInstanceToken = <
|
|
702
|
-
|
|
961
|
+
export const useDeleteInstanceToken = <TError = ErrorType<DmError>, TContext = unknown>(
|
|
962
|
+
options?: {
|
|
963
|
+
mutation?: UseMutationOptions<
|
|
964
|
+
Awaited<ReturnType<typeof deleteInstanceToken>>,
|
|
965
|
+
TError,
|
|
966
|
+
{ instanceId: string; token: string },
|
|
967
|
+
TContext
|
|
968
|
+
>;
|
|
969
|
+
request?: SecondParameter<typeof customInstance>;
|
|
970
|
+
},
|
|
971
|
+
queryClient?: QueryClient,
|
|
703
972
|
): UseMutationResult<
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
}
|
|
714
|
-
|
|
973
|
+
Awaited<ReturnType<typeof deleteInstanceToken>>,
|
|
974
|
+
TError,
|
|
975
|
+
{ instanceId: string; token: string },
|
|
976
|
+
TContext
|
|
977
|
+
> => {
|
|
978
|
+
const mutationOptions = useDeleteInstanceTokenMutationOptions(options);
|
|
979
|
+
|
|
980
|
+
return useMutation(mutationOptions, queryClient);
|
|
981
|
+
};
|