@squonk/data-manager-client 1.2.8 → 1.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (114) hide show
  1. package/README.md +1 -1
  2. package/accounting/accounting.cjs +51 -8
  3. package/accounting/accounting.cjs.map +1 -1
  4. package/accounting/accounting.d.cts +61 -10
  5. package/accounting/accounting.d.ts +61 -10
  6. package/accounting/accounting.js +49 -6
  7. package/accounting/accounting.js.map +1 -1
  8. package/admin/admin.cjs +67 -24
  9. package/admin/admin.cjs.map +1 -1
  10. package/admin/admin.d.cts +75 -24
  11. package/admin/admin.d.ts +75 -24
  12. package/admin/admin.js +56 -13
  13. package/admin/admin.js.map +1 -1
  14. package/application/application.cjs +35 -6
  15. package/application/application.cjs.map +1 -1
  16. package/application/application.d.cts +42 -8
  17. package/application/application.d.ts +42 -8
  18. package/application/application.js +34 -5
  19. package/application/application.js.map +1 -1
  20. package/{chunk-UKA7G3OB.js → chunk-EBOQPVLG.js} +2 -2
  21. package/{chunk-UKA7G3OB.js.map → chunk-EBOQPVLG.js.map} +1 -1
  22. package/{chunk-J22A7LHX.cjs → chunk-TKLTUR4R.cjs} +2 -2
  23. package/chunk-TKLTUR4R.cjs.map +1 -0
  24. package/configuration/configuration.cjs +19 -4
  25. package/configuration/configuration.cjs.map +1 -1
  26. package/configuration/configuration.d.cts +23 -6
  27. package/configuration/configuration.d.ts +23 -6
  28. package/configuration/configuration.js +19 -4
  29. package/configuration/configuration.js.map +1 -1
  30. package/dataset/dataset.cjs +93 -22
  31. package/dataset/dataset.cjs.map +1 -1
  32. package/dataset/dataset.d.cts +105 -20
  33. package/dataset/dataset.d.ts +105 -20
  34. package/dataset/dataset.js +83 -12
  35. package/dataset/dataset.js.map +1 -1
  36. package/exchange-rate/exchange-rate.cjs +71 -14
  37. package/exchange-rate/exchange-rate.cjs.map +1 -1
  38. package/exchange-rate/exchange-rate.d.cts +83 -15
  39. package/exchange-rate/exchange-rate.d.ts +83 -15
  40. package/exchange-rate/exchange-rate.js +65 -8
  41. package/exchange-rate/exchange-rate.js.map +1 -1
  42. package/file-and-path/file-and-path.cjs +45 -16
  43. package/file-and-path/file-and-path.cjs.map +1 -1
  44. package/file-and-path/file-and-path.d.cts +48 -14
  45. package/file-and-path/file-and-path.d.ts +48 -14
  46. package/file-and-path/file-and-path.js +39 -10
  47. package/file-and-path/file-and-path.js.map +1 -1
  48. package/index.cjs +9 -2
  49. package/index.cjs.map +1 -1
  50. package/index.d.cts +2033 -2
  51. package/index.d.ts +2033 -2
  52. package/index.js +8 -1
  53. package/index.js.map +1 -1
  54. package/instance/instance.cjs +45 -16
  55. package/instance/instance.cjs.map +1 -1
  56. package/instance/instance.d.cts +48 -14
  57. package/instance/instance.d.ts +48 -14
  58. package/instance/instance.js +38 -9
  59. package/instance/instance.js.map +1 -1
  60. package/job/job.cjs +51 -8
  61. package/job/job.cjs.map +1 -1
  62. package/job/job.d.cts +61 -10
  63. package/job/job.d.ts +61 -10
  64. package/job/job.js +49 -6
  65. package/job/job.js.map +1 -1
  66. package/metadata/metadata.cjs +39 -10
  67. package/metadata/metadata.cjs.map +1 -1
  68. package/metadata/metadata.d.cts +45 -11
  69. package/metadata/metadata.d.ts +45 -11
  70. package/metadata/metadata.js +36 -7
  71. package/metadata/metadata.js.map +1 -1
  72. package/package.json +11 -11
  73. package/project/project.cjs +83 -26
  74. package/project/project.cjs.map +1 -1
  75. package/project/project.d.cts +89 -21
  76. package/project/project.d.ts +89 -21
  77. package/project/project.js +71 -14
  78. package/project/project.js.map +1 -1
  79. package/src/accounting/accounting.ts +136 -22
  80. package/src/admin/admin.ts +148 -50
  81. package/src/application/application.ts +93 -18
  82. package/src/configuration/configuration.ts +50 -14
  83. package/src/custom-instance.ts +3 -4
  84. package/src/data-manager-api.schemas.ts +59 -33
  85. package/src/dataset/dataset.ts +233 -45
  86. package/src/exchange-rate/exchange-rate.ts +185 -32
  87. package/src/file-and-path/file-and-path.ts +98 -33
  88. package/src/instance/instance.ts +98 -33
  89. package/src/job/job.ts +138 -22
  90. package/src/metadata/metadata.ts +97 -24
  91. package/src/project/project.ts +191 -50
  92. package/src/task/task.ts +96 -21
  93. package/src/type/type.ts +50 -14
  94. package/src/user/user.ts +137 -25
  95. package/task/task.cjs +37 -8
  96. package/task/task.cjs.map +1 -1
  97. package/task/task.d.cts +44 -10
  98. package/task/task.d.ts +44 -10
  99. package/task/task.js +35 -6
  100. package/task/task.js.map +1 -1
  101. package/type/type.cjs +19 -4
  102. package/type/type.cjs.map +1 -1
  103. package/type/type.d.cts +23 -6
  104. package/type/type.d.ts +23 -6
  105. package/type/type.js +19 -4
  106. package/type/type.js.map +1 -1
  107. package/user/user.cjs +53 -10
  108. package/user/user.cjs.map +1 -1
  109. package/user/user.d.cts +63 -12
  110. package/user/user.d.ts +63 -12
  111. package/user/user.js +49 -6
  112. package/user/user.js.map +1 -1
  113. package/chunk-J22A7LHX.cjs.map +0 -1
  114. package/custom-instance-37ed2460.d.ts +0 -2014
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v6.20.0 🍺
2
+ * Generated by orval v6.25.0 🍺
3
3
  * Do not edit manually.
4
4
  * Dataset Manager API
5
5
  * The Dataset Manager API service.
@@ -10,7 +10,8 @@ A service that allows *registered* users to make **Datasets** and associated **M
10
10
  */
11
11
  import {
12
12
  useMutation,
13
- useQuery
13
+ useQuery,
14
+ useSuspenseQuery
14
15
  } from '@tanstack/react-query'
15
16
  import type {
16
17
  MutationFunction,
@@ -18,7 +19,9 @@ import type {
18
19
  QueryKey,
19
20
  UseMutationOptions,
20
21
  UseQueryOptions,
21
- UseQueryResult
22
+ UseQueryResult,
23
+ UseSuspenseQueryOptions,
24
+ UseSuspenseQueryResult
22
25
  } from '@tanstack/react-query'
23
26
  import type {
24
27
  AdminDeleteJobManifestParams,
@@ -37,13 +40,7 @@ import { customInstance } from '.././custom-instance';
37
40
  import type { ErrorType } from '.././custom-instance';
38
41
 
39
42
 
40
- // eslint-disable-next-line
41
- type SecondParameter<T extends (...args: any) => any> = T extends (
42
- config: any,
43
- args: infer P,
44
- ) => any
45
- ? P
46
- : never;
43
+ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
47
44
 
48
45
 
49
46
  /**
@@ -60,7 +57,7 @@ export const adminGetServiceErrors = (
60
57
 
61
58
 
62
59
  return customInstance<ServiceErrorsGetResponse>(
63
- {url: `/admin/service-error`, method: 'get',
60
+ {url: `/admin/service-error`, method: 'GET',
64
61
  params, signal
65
62
  },
66
63
  options);
@@ -68,12 +65,11 @@ export const adminGetServiceErrors = (
68
65
 
69
66
 
70
67
  export const getAdminGetServiceErrorsQueryKey = (params?: AdminGetServiceErrorsParams,) => {
71
-
72
68
  return ["data-manager-api", `/admin/service-error`, ...(params ? [params]: [])] as const;
73
69
  }
74
70
 
75
71
 
76
- export const getAdminGetServiceErrorsQueryOptions = <TData = Awaited<ReturnType<typeof adminGetServiceErrors>>, TError = ErrorType<void | DmError>>(params?: AdminGetServiceErrorsParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
72
+ export const getAdminGetServiceErrorsQueryOptions = <TData = Awaited<ReturnType<typeof adminGetServiceErrors>>, TError = ErrorType<void | DmError>>(params?: AdminGetServiceErrorsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
77
73
  ) => {
78
74
 
79
75
  const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -98,7 +94,7 @@ export type AdminGetServiceErrorsQueryError = ErrorType<void | DmError>
98
94
  * @summary Gets Service Errors
99
95
  */
100
96
  export const useAdminGetServiceErrors = <TData = Awaited<ReturnType<typeof adminGetServiceErrors>>, TError = ErrorType<void | DmError>>(
101
- params?: AdminGetServiceErrorsParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
97
+ params?: AdminGetServiceErrorsParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
102
98
 
103
99
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
104
100
 
@@ -113,6 +109,46 @@ export const useAdminGetServiceErrors = <TData = Awaited<ReturnType<typeof admin
113
109
 
114
110
 
115
111
 
112
+ export const getAdminGetServiceErrorsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof adminGetServiceErrors>>, TError = ErrorType<void | DmError>>(params?: AdminGetServiceErrorsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
113
+ ) => {
114
+
115
+ const {query: queryOptions, request: requestOptions} = options ?? {};
116
+
117
+ const queryKey = queryOptions?.queryKey ?? getAdminGetServiceErrorsQueryKey(params);
118
+
119
+
120
+
121
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof adminGetServiceErrors>>> = ({ signal }) => adminGetServiceErrors(params, requestOptions, signal);
122
+
123
+
124
+
125
+
126
+
127
+ return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData> & { queryKey: QueryKey }
128
+ }
129
+
130
+ export type AdminGetServiceErrorsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof adminGetServiceErrors>>>
131
+ export type AdminGetServiceErrorsSuspenseQueryError = ErrorType<void | DmError>
132
+
133
+ /**
134
+ * @summary Gets Service Errors
135
+ */
136
+ export const useAdminGetServiceErrorsSuspense = <TData = Awaited<ReturnType<typeof adminGetServiceErrors>>, TError = ErrorType<void | DmError>>(
137
+ params?: AdminGetServiceErrorsParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetServiceErrors>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
138
+
139
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
140
+
141
+ const queryOptions = getAdminGetServiceErrorsSuspenseQueryOptions(params,options)
142
+
143
+ const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
144
+
145
+ query.queryKey = queryOptions.queryKey ;
146
+
147
+ return query;
148
+ }
149
+
150
+
151
+
116
152
  /**
117
153
  * Used primarily to 'Acknowledge' but not delete a Service Error.
118
154
 
@@ -126,7 +162,7 @@ export const adminPatchServiceError = (
126
162
 
127
163
 
128
164
  return customInstance<void>(
129
- {url: `/admin/service-error/${errorId}`, method: 'patch'
165
+ {url: `/admin/service-error/${errorId}`, method: 'PATCH'
130
166
  },
131
167
  options);
132
168
  }
@@ -134,7 +170,6 @@ export const adminPatchServiceError = (
134
170
 
135
171
 
136
172
  export const getAdminPatchServiceErrorMutationOptions = <TError = ErrorType<DmError>,
137
-
138
173
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminPatchServiceError>>, TError,{errorId: number}, TContext>, request?: SecondParameter<typeof customInstance>}
139
174
  ): UseMutationOptions<Awaited<ReturnType<typeof adminPatchServiceError>>, TError,{errorId: number}, TContext> => {
140
175
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -161,7 +196,6 @@ export const getAdminPatchServiceErrorMutationOptions = <TError = ErrorType<DmEr
161
196
  * @summary Patches a Service Error
162
197
  */
163
198
  export const useAdminPatchServiceError = <TError = ErrorType<DmError>,
164
-
165
199
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminPatchServiceError>>, TError,{errorId: number}, TContext>, request?: SecondParameter<typeof customInstance>}
166
200
  ) => {
167
201
 
@@ -182,7 +216,7 @@ export const adminDeleteServiceError = (
182
216
 
183
217
 
184
218
  return customInstance<void>(
185
- {url: `/admin/service-error/${errorId}`, method: 'delete'
219
+ {url: `/admin/service-error/${errorId}`, method: 'DELETE'
186
220
  },
187
221
  options);
188
222
  }
@@ -190,7 +224,6 @@ export const adminDeleteServiceError = (
190
224
 
191
225
 
192
226
  export const getAdminDeleteServiceErrorMutationOptions = <TError = ErrorType<DmError>,
193
-
194
227
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminDeleteServiceError>>, TError,{errorId: number}, TContext>, request?: SecondParameter<typeof customInstance>}
195
228
  ): UseMutationOptions<Awaited<ReturnType<typeof adminDeleteServiceError>>, TError,{errorId: number}, TContext> => {
196
229
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -217,7 +250,6 @@ export const getAdminDeleteServiceErrorMutationOptions = <TError = ErrorType<DmE
217
250
  * @summary Deletes a Service Error
218
251
  */
219
252
  export const useAdminDeleteServiceError = <TError = ErrorType<DmError>,
220
-
221
253
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminDeleteServiceError>>, TError,{errorId: number}, TContext>, request?: SecondParameter<typeof customInstance>}
222
254
  ) => {
223
255
 
@@ -237,7 +269,7 @@ export const adminGetUsers = (
237
269
 
238
270
 
239
271
  return customInstance<AdminUsersGetResponse>(
240
- {url: `/admin/user`, method: 'get',
272
+ {url: `/admin/user`, method: 'GET',
241
273
  params, signal
242
274
  },
243
275
  options);
@@ -245,12 +277,11 @@ export const adminGetUsers = (
245
277
 
246
278
 
247
279
  export const getAdminGetUsersQueryKey = (params?: AdminGetUsersParams,) => {
248
-
249
280
  return ["data-manager-api", `/admin/user`, ...(params ? [params]: [])] as const;
250
281
  }
251
282
 
252
283
 
253
- export const getAdminGetUsersQueryOptions = <TData = Awaited<ReturnType<typeof adminGetUsers>>, TError = ErrorType<void | DmError>>(params?: AdminGetUsersParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
284
+ export const getAdminGetUsersQueryOptions = <TData = Awaited<ReturnType<typeof adminGetUsers>>, TError = ErrorType<void | DmError>>(params?: AdminGetUsersParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
254
285
  ) => {
255
286
 
256
287
  const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -275,7 +306,7 @@ export type AdminGetUsersQueryError = ErrorType<void | DmError>
275
306
  * @summary Get detailed information about all known Users
276
307
  */
277
308
  export const useAdminGetUsers = <TData = Awaited<ReturnType<typeof adminGetUsers>>, TError = ErrorType<void | DmError>>(
278
- params?: AdminGetUsersParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
309
+ params?: AdminGetUsersParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
279
310
 
280
311
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
281
312
 
@@ -290,6 +321,46 @@ export const useAdminGetUsers = <TData = Awaited<ReturnType<typeof adminGetUsers
290
321
 
291
322
 
292
323
 
324
+ export const getAdminGetUsersSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof adminGetUsers>>, TError = ErrorType<void | DmError>>(params?: AdminGetUsersParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
325
+ ) => {
326
+
327
+ const {query: queryOptions, request: requestOptions} = options ?? {};
328
+
329
+ const queryKey = queryOptions?.queryKey ?? getAdminGetUsersQueryKey(params);
330
+
331
+
332
+
333
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof adminGetUsers>>> = ({ signal }) => adminGetUsers(params, requestOptions, signal);
334
+
335
+
336
+
337
+
338
+
339
+ return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData> & { queryKey: QueryKey }
340
+ }
341
+
342
+ export type AdminGetUsersSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof adminGetUsers>>>
343
+ export type AdminGetUsersSuspenseQueryError = ErrorType<void | DmError>
344
+
345
+ /**
346
+ * @summary Get detailed information about all known Users
347
+ */
348
+ export const useAdminGetUsersSuspense = <TData = Awaited<ReturnType<typeof adminGetUsers>>, TError = ErrorType<void | DmError>>(
349
+ params?: AdminGetUsersParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetUsers>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
350
+
351
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
352
+
353
+ const queryOptions = getAdminGetUsersSuspenseQueryOptions(params,options)
354
+
355
+ const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
356
+
357
+ query.queryKey = queryOptions.queryKey ;
358
+
359
+ return query;
360
+ }
361
+
362
+
363
+
293
364
  /**
294
365
  * 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.
295
366
 
@@ -303,7 +374,7 @@ export const adminPutUser = (
303
374
 
304
375
 
305
376
  return customInstance<UserAccountDetail>(
306
- {url: `/admin/user/${userId}`, method: 'put'
377
+ {url: `/admin/user/${userId}`, method: 'PUT'
307
378
  },
308
379
  options);
309
380
  }
@@ -311,7 +382,6 @@ export const adminPutUser = (
311
382
 
312
383
 
313
384
  export const getAdminPutUserMutationOptions = <TError = ErrorType<void | DmError>,
314
-
315
385
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminPutUser>>, TError,{userId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
316
386
  ): UseMutationOptions<Awaited<ReturnType<typeof adminPutUser>>, TError,{userId: string}, TContext> => {
317
387
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -338,7 +408,6 @@ export const getAdminPutUserMutationOptions = <TError = ErrorType<void | DmError
338
408
  * @summary Prepares a user account in the Data Manager service
339
409
  */
340
410
  export const useAdminPutUser = <TError = ErrorType<void | DmError>,
341
-
342
411
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminPutUser>>, TError,{userId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
343
412
  ) => {
344
413
 
@@ -359,7 +428,7 @@ export const adminDeleteUser = (
359
428
 
360
429
 
361
430
  return customInstance<void>(
362
- {url: `/admin/user/${userId}`, method: 'delete'
431
+ {url: `/admin/user/${userId}`, method: 'DELETE'
363
432
  },
364
433
  options);
365
434
  }
@@ -367,7 +436,6 @@ export const adminDeleteUser = (
367
436
 
368
437
 
369
438
  export const getAdminDeleteUserMutationOptions = <TError = ErrorType<DmError>,
370
-
371
439
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminDeleteUser>>, TError,{userId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
372
440
  ): UseMutationOptions<Awaited<ReturnType<typeof adminDeleteUser>>, TError,{userId: string}, TContext> => {
373
441
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -394,7 +462,6 @@ export const getAdminDeleteUserMutationOptions = <TError = ErrorType<DmError>,
394
462
  * @summary Deletes a user account
395
463
  */
396
464
  export const useAdminDeleteUser = <TError = ErrorType<DmError>,
397
-
398
465
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminDeleteUser>>, TError,{userId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
399
466
  ) => {
400
467
 
@@ -420,7 +487,7 @@ if(userPatchBodyBody.suspend_message !== undefined) {
420
487
  }
421
488
 
422
489
  return customInstance<void>(
423
- {url: `/admin/user/${userId}`, method: 'patch',
490
+ {url: `/admin/user/${userId}`, method: 'PATCH',
424
491
  headers: {'Content-Type': 'multipart/form-data', },
425
492
  data: formData
426
493
  },
@@ -430,7 +497,6 @@ if(userPatchBodyBody.suspend_message !== undefined) {
430
497
 
431
498
 
432
499
  export const getAdminPatchUserMutationOptions = <TError = ErrorType<DmError>,
433
-
434
500
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminPatchUser>>, TError,{userId: string;data: UserPatchBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
435
501
  ): UseMutationOptions<Awaited<ReturnType<typeof adminPatchUser>>, TError,{userId: string;data: UserPatchBodyBody}, TContext> => {
436
502
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -457,7 +523,6 @@ export const getAdminPatchUserMutationOptions = <TError = ErrorType<DmError>,
457
523
  * @summary Patch a given user
458
524
  */
459
525
  export const useAdminPatchUser = <TError = ErrorType<DmError>,
460
-
461
526
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminPatchUser>>, TError,{userId: string;data: UserPatchBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
462
527
  ) => {
463
528
 
@@ -479,19 +544,18 @@ export const adminGetJobManifests = (
479
544
 
480
545
 
481
546
  return customInstance<AdminJobManifestGetResponse>(
482
- {url: `/admin/job-manifest`, method: 'get', signal
547
+ {url: `/admin/job-manifest`, method: 'GET', signal
483
548
  },
484
549
  options);
485
550
  }
486
551
 
487
552
 
488
553
  export const getAdminGetJobManifestsQueryKey = () => {
489
-
490
554
  return ["data-manager-api", `/admin/job-manifest`] as const;
491
555
  }
492
556
 
493
557
 
494
- export const getAdminGetJobManifestsQueryOptions = <TData = Awaited<ReturnType<typeof adminGetJobManifests>>, TError = ErrorType<void | DmError>>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
558
+ export const getAdminGetJobManifestsQueryOptions = <TData = Awaited<ReturnType<typeof adminGetJobManifests>>, TError = ErrorType<void | DmError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
495
559
  ) => {
496
560
 
497
561
  const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -516,7 +580,7 @@ export type AdminGetJobManifestsQueryError = ErrorType<void | DmError>
516
580
  * @summary Get Job Manifests
517
581
  */
518
582
  export const useAdminGetJobManifests = <TData = Awaited<ReturnType<typeof adminGetJobManifests>>, TError = ErrorType<void | DmError>>(
519
- options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
583
+ options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
520
584
 
521
585
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
522
586
 
@@ -531,6 +595,46 @@ export const useAdminGetJobManifests = <TData = Awaited<ReturnType<typeof adminG
531
595
 
532
596
 
533
597
 
598
+ export const getAdminGetJobManifestsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof adminGetJobManifests>>, TError = ErrorType<void | DmError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
599
+ ) => {
600
+
601
+ const {query: queryOptions, request: requestOptions} = options ?? {};
602
+
603
+ const queryKey = queryOptions?.queryKey ?? getAdminGetJobManifestsQueryKey();
604
+
605
+
606
+
607
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof adminGetJobManifests>>> = ({ signal }) => adminGetJobManifests(requestOptions, signal);
608
+
609
+
610
+
611
+
612
+
613
+ return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData> & { queryKey: QueryKey }
614
+ }
615
+
616
+ export type AdminGetJobManifestsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof adminGetJobManifests>>>
617
+ export type AdminGetJobManifestsSuspenseQueryError = ErrorType<void | DmError>
618
+
619
+ /**
620
+ * @summary Get Job Manifests
621
+ */
622
+ export const useAdminGetJobManifestsSuspense = <TData = Awaited<ReturnType<typeof adminGetJobManifests>>, TError = ErrorType<void | DmError>>(
623
+ options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof adminGetJobManifests>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
624
+
625
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
626
+
627
+ const queryOptions = getAdminGetJobManifestsSuspenseQueryOptions(options)
628
+
629
+ const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
630
+
631
+ query.queryKey = queryOptions.queryKey ;
632
+
633
+ return query;
634
+ }
635
+
636
+
637
+
534
638
  /**
535
639
  * 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.
536
640
 
@@ -554,7 +658,7 @@ if(jobManifestPutBodyBody.params !== undefined) {
554
658
  }
555
659
 
556
660
  return customInstance<AdminJobManifestLoadPutResponse>(
557
- {url: `/admin/job-manifest`, method: 'put',
661
+ {url: `/admin/job-manifest`, method: 'PUT',
558
662
  headers: {'Content-Type': 'multipart/form-data', },
559
663
  data: formData
560
664
  },
@@ -564,7 +668,6 @@ if(jobManifestPutBodyBody.params !== undefined) {
564
668
 
565
669
 
566
670
  export const getAdminJobManifestPutMutationOptions = <TError = ErrorType<void | DmError>,
567
-
568
671
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminJobManifestPut>>, TError,{data: JobManifestPutBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
569
672
  ): UseMutationOptions<Awaited<ReturnType<typeof adminJobManifestPut>>, TError,{data: JobManifestPutBodyBody}, TContext> => {
570
673
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -591,7 +694,6 @@ export const getAdminJobManifestPutMutationOptions = <TError = ErrorType<void |
591
694
  * @summary Adds a Job Manifest and triggers the download of its Job Definitions
592
695
  */
593
696
  export const useAdminJobManifestPut = <TError = ErrorType<void | DmError>,
594
-
595
697
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminJobManifestPut>>, TError,{data: JobManifestPutBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
596
698
  ) => {
597
699
 
@@ -615,7 +717,7 @@ export const adminDeleteJobManifest = (
615
717
 
616
718
 
617
719
  return customInstance<void>(
618
- {url: `/admin/job-manifest/${jobManifestId}`, method: 'delete',
720
+ {url: `/admin/job-manifest/${jobManifestId}`, method: 'DELETE',
619
721
  params
620
722
  },
621
723
  options);
@@ -624,7 +726,6 @@ export const adminDeleteJobManifest = (
624
726
 
625
727
 
626
728
  export const getAdminDeleteJobManifestMutationOptions = <TError = ErrorType<DmError>,
627
-
628
729
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminDeleteJobManifest>>, TError,{jobManifestId: number;params?: AdminDeleteJobManifestParams}, TContext>, request?: SecondParameter<typeof customInstance>}
629
730
  ): UseMutationOptions<Awaited<ReturnType<typeof adminDeleteJobManifest>>, TError,{jobManifestId: number;params?: AdminDeleteJobManifestParams}, TContext> => {
630
731
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -651,7 +752,6 @@ export const getAdminDeleteJobManifestMutationOptions = <TError = ErrorType<DmEr
651
752
  * @summary Deletes a Job Manifest
652
753
  */
653
754
  export const useAdminDeleteJobManifest = <TError = ErrorType<DmError>,
654
-
655
755
  TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminDeleteJobManifest>>, TError,{jobManifestId: number;params?: AdminDeleteJobManifestParams}, TContext>, request?: SecondParameter<typeof customInstance>}
656
756
  ) => {
657
757
 
@@ -674,7 +774,7 @@ export const adminJobManifestLoad = (
674
774
 
675
775
 
676
776
  return customInstance<AdminJobManifestLoadPutResponse>(
677
- {url: `/admin/job-manifest/load`, method: 'put'
777
+ {url: `/admin/job-manifest/load`, method: 'PUT'
678
778
  },
679
779
  options);
680
780
  }
@@ -682,15 +782,14 @@ export const adminJobManifestLoad = (
682
782
 
683
783
 
684
784
  export const getAdminJobManifestLoadMutationOptions = <TError = ErrorType<void | DmError>,
685
- TVariables = void,
686
- TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminJobManifestLoad>>, TError,TVariables, TContext>, request?: SecondParameter<typeof customInstance>}
687
- ): UseMutationOptions<Awaited<ReturnType<typeof adminJobManifestLoad>>, TError,TVariables, TContext> => {
785
+ TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminJobManifestLoad>>, TError,void, TContext>, request?: SecondParameter<typeof customInstance>}
786
+ ): UseMutationOptions<Awaited<ReturnType<typeof adminJobManifestLoad>>, TError,void, TContext> => {
688
787
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
689
788
 
690
789
 
691
790
 
692
791
 
693
- const mutationFn: MutationFunction<Awaited<ReturnType<typeof adminJobManifestLoad>>, TVariables> = () => {
792
+ const mutationFn: MutationFunction<Awaited<ReturnType<typeof adminJobManifestLoad>>, void> = () => {
694
793
 
695
794
 
696
795
  return adminJobManifestLoad(requestOptions)
@@ -709,8 +808,7 @@ export const getAdminJobManifestLoadMutationOptions = <TError = ErrorType<void |
709
808
  * @summary Trigger a download of Job Definitions using existing Job Manifests
710
809
  */
711
810
  export const useAdminJobManifestLoad = <TError = ErrorType<void | DmError>,
712
- TVariables = void,
713
- TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminJobManifestLoad>>, TError,TVariables, TContext>, request?: SecondParameter<typeof customInstance>}
811
+ TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof adminJobManifestLoad>>, TError,void, TContext>, request?: SecondParameter<typeof customInstance>}
714
812
  ) => {
715
813
 
716
814
  const mutationOptions = getAdminJobManifestLoadMutationOptions(options);
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Generated by orval v6.20.0 🍺
2
+ * Generated by orval v6.25.0 🍺
3
3
  * Do not edit manually.
4
4
  * Dataset Manager API
5
5
  * The Dataset Manager API service.
@@ -9,13 +9,16 @@ A service that allows *registered* users to make **Datasets** and associated **M
9
9
  * OpenAPI spec version: 1.2
10
10
  */
11
11
  import {
12
- useQuery
12
+ useQuery,
13
+ useSuspenseQuery
13
14
  } from '@tanstack/react-query'
14
15
  import type {
15
16
  QueryFunction,
16
17
  QueryKey,
17
18
  UseQueryOptions,
18
- UseQueryResult
19
+ UseQueryResult,
20
+ UseSuspenseQueryOptions,
21
+ UseSuspenseQueryResult
19
22
  } from '@tanstack/react-query'
20
23
  import type {
21
24
  ApplicationGetResponse,
@@ -26,13 +29,7 @@ import { customInstance } from '.././custom-instance';
26
29
  import type { ErrorType } from '.././custom-instance';
27
30
 
28
31
 
29
- // eslint-disable-next-line
30
- type SecondParameter<T extends (...args: any) => any> = T extends (
31
- config: any,
32
- args: infer P,
33
- ) => any
34
- ? P
35
- : never;
32
+ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
36
33
 
37
34
 
38
35
  /**
@@ -49,19 +46,18 @@ export const getApplications = (
49
46
 
50
47
 
51
48
  return customInstance<ApplicationsGetResponse>(
52
- {url: `/application`, method: 'get', signal
49
+ {url: `/application`, method: 'GET', signal
53
50
  },
54
51
  options);
55
52
  }
56
53
 
57
54
 
58
55
  export const getGetApplicationsQueryKey = () => {
59
-
60
56
  return ["data-manager-api", `/application`] as const;
61
57
  }
62
58
 
63
59
 
64
- export const getGetApplicationsQueryOptions = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
60
+ export const getGetApplicationsQueryOptions = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
65
61
  ) => {
66
62
 
67
63
  const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -86,7 +82,7 @@ export type GetApplicationsQueryError = ErrorType<DmError>
86
82
  * @summary Get all Applications available to you
87
83
  */
88
84
  export const useGetApplications = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
89
- options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
85
+ options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
90
86
 
91
87
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
92
88
 
@@ -101,6 +97,46 @@ export const useGetApplications = <TData = Awaited<ReturnType<typeof getApplicat
101
97
 
102
98
 
103
99
 
100
+ export const getGetApplicationsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
101
+ ) => {
102
+
103
+ const {query: queryOptions, request: requestOptions} = options ?? {};
104
+
105
+ const queryKey = queryOptions?.queryKey ?? getGetApplicationsQueryKey();
106
+
107
+
108
+
109
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplications>>> = ({ signal }) => getApplications(requestOptions, signal);
110
+
111
+
112
+
113
+
114
+
115
+ return { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData> & { queryKey: QueryKey }
116
+ }
117
+
118
+ export type GetApplicationsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getApplications>>>
119
+ export type GetApplicationsSuspenseQueryError = ErrorType<DmError>
120
+
121
+ /**
122
+ * @summary Get all Applications available to you
123
+ */
124
+ export const useGetApplicationsSuspense = <TData = Awaited<ReturnType<typeof getApplications>>, TError = ErrorType<DmError>>(
125
+ options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplications>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
126
+
127
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
128
+
129
+ const queryOptions = getGetApplicationsSuspenseQueryOptions(options)
130
+
131
+ const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
132
+
133
+ query.queryKey = queryOptions.queryKey ;
134
+
135
+ return query;
136
+ }
137
+
138
+
139
+
104
140
  /**
105
141
  * Get details of a specific Application available to you that can be instantiated.
106
142
 
@@ -113,19 +149,18 @@ export const getApplication = (
113
149
 
114
150
 
115
151
  return customInstance<ApplicationGetResponse>(
116
- {url: `/application/${applicationId}`, method: 'get', signal
152
+ {url: `/application/${applicationId}`, method: 'GET', signal
117
153
  },
118
154
  options);
119
155
  }
120
156
 
121
157
 
122
158
  export const getGetApplicationQueryKey = (applicationId: string,) => {
123
-
124
159
  return ["data-manager-api", `/application/${applicationId}`] as const;
125
160
  }
126
161
 
127
162
 
128
- export const getGetApplicationQueryOptions = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(applicationId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
163
+ export const getGetApplicationQueryOptions = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(applicationId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
129
164
  ) => {
130
165
 
131
166
  const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -150,7 +185,7 @@ export type GetApplicationQueryError = ErrorType<void | DmError>
150
185
  * @summary Get details of a specific Application
151
186
  */
152
187
  export const useGetApplication = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
153
- applicationId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
188
+ applicationId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
154
189
 
155
190
  ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
156
191
 
@@ -165,3 +200,43 @@ export const useGetApplication = <TData = Awaited<ReturnType<typeof getApplicati
165
200
 
166
201
 
167
202
 
203
+ export const getGetApplicationSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(applicationId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
204
+ ) => {
205
+
206
+ const {query: queryOptions, request: requestOptions} = options ?? {};
207
+
208
+ const queryKey = queryOptions?.queryKey ?? getGetApplicationQueryKey(applicationId);
209
+
210
+
211
+
212
+ const queryFn: QueryFunction<Awaited<ReturnType<typeof getApplication>>> = ({ signal }) => getApplication(applicationId, requestOptions, signal);
213
+
214
+
215
+
216
+
217
+
218
+ return { queryKey, queryFn, enabled: !!(applicationId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData> & { queryKey: QueryKey }
219
+ }
220
+
221
+ export type GetApplicationSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getApplication>>>
222
+ export type GetApplicationSuspenseQueryError = ErrorType<void | DmError>
223
+
224
+ /**
225
+ * @summary Get details of a specific Application
226
+ */
227
+ export const useGetApplicationSuspense = <TData = Awaited<ReturnType<typeof getApplication>>, TError = ErrorType<void | DmError>>(
228
+ applicationId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getApplication>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
229
+
230
+ ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
231
+
232
+ const queryOptions = getGetApplicationSuspenseQueryOptions(applicationId,options)
233
+
234
+ const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
235
+
236
+ query.queryKey = queryOptions.queryKey ;
237
+
238
+ return query;
239
+ }
240
+
241
+
242
+