@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,9 +1,9 @@
1
- import * as _tanstack_react_query from '@tanstack/react-query';
2
- import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult } from '@tanstack/react-query';
3
- import { ag as DatasetPutBodyBody, bZ as customInstance, bM as DatasetPutPostResponse, b_ as ErrorType, bV as DmError, aj as DatasetPostBodyBody, q as GetDatasetsParams, bF as DatasetsGetResponse, p as GetVersionsParams, b2 as DatasetDetail, o as DeleteDatasetParams, av as TaskIdentity, bL as DatasetDigestGetResponse, bJ as DatasetSchemaGetResponse } from '../custom-instance-37ed2460.js';
1
+ import * as _tanstack_react_query_build_legacy_types from '@tanstack/react-query/build/legacy/types';
2
+ import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
3
+ import { DatasetPutBodyBody, customInstance, DatasetPutPostResponse, ErrorType, DmError, DatasetPostBodyBody, GetDatasetsParams, DatasetsGetResponse, GetVersionsParams, DatasetDetail, DeleteDatasetParams, TaskIdentity, DatasetDigestGetResponse, DatasetSchemaGetResponse } from '../index.cjs';
4
4
  import 'axios';
5
5
 
6
- type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
6
+ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
7
7
  /**
8
8
  * Using an unmanaged file in a Project as a source a Dataset (or new Dataset Version) is created.
9
9
 
@@ -33,7 +33,7 @@ declare const useCreateDatasetFromFile: <TError = ErrorType<void | DmError>, TCo
33
33
  data: DatasetPutBodyBody;
34
34
  }, TContext> | undefined;
35
35
  request?: SecondParameter<typeof customInstance>;
36
- } | undefined) => _tanstack_react_query.UseMutationResult<DatasetPutPostResponse, TError, {
36
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<DatasetPutPostResponse, TError, {
37
37
  data: DatasetPutBodyBody;
38
38
  }, TContext>;
39
39
  /**
@@ -69,7 +69,7 @@ declare const useUploadDataset: <TError = ErrorType<void | DmError>, TContext =
69
69
  data: DatasetPostBodyBody;
70
70
  }, TContext> | undefined;
71
71
  request?: SecondParameter<typeof customInstance>;
72
- } | undefined) => _tanstack_react_query.UseMutationResult<DatasetPutPostResponse, TError, {
72
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<DatasetPutPostResponse, TError, {
73
73
  data: DatasetPostBodyBody;
74
74
  }, TContext>;
75
75
  /**
@@ -86,7 +86,7 @@ Note that if `editors` are combined with `owner username`, then the datasets wil
86
86
  declare const getDatasets: (params?: GetDatasetsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetsGetResponse>;
87
87
  declare const getGetDatasetsQueryKey: (params?: GetDatasetsParams) => readonly ["data-manager-api", "/dataset", ...GetDatasetsParams[]];
88
88
  declare const getGetDatasetsQueryOptions: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
89
- query?: UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> | undefined;
89
+ query?: Partial<UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
90
90
  request?: SecondParameter<typeof customInstance>;
91
91
  } | undefined) => UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> & {
92
92
  queryKey: QueryKey;
@@ -97,11 +97,28 @@ type GetDatasetsQueryError = ErrorType<void | DmError>;
97
97
  * @summary Get Datasets that are available to you
98
98
  */
99
99
  declare const useGetDatasets: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
100
- query?: UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> | undefined;
100
+ query?: Partial<UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
101
101
  request?: SecondParameter<typeof customInstance>;
102
102
  } | undefined) => UseQueryResult<TData, TError> & {
103
103
  queryKey: QueryKey;
104
104
  };
105
+ declare const getGetDatasetsSuspenseQueryOptions: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
106
+ query?: Partial<UseSuspenseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
107
+ request?: SecondParameter<typeof customInstance>;
108
+ } | undefined) => UseSuspenseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> & {
109
+ queryKey: QueryKey;
110
+ };
111
+ type GetDatasetsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
112
+ type GetDatasetsSuspenseQueryError = ErrorType<void | DmError>;
113
+ /**
114
+ * @summary Get Datasets that are available to you
115
+ */
116
+ declare const useGetDatasetsSuspense: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
117
+ query?: Partial<UseSuspenseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
118
+ request?: SecondParameter<typeof customInstance>;
119
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
120
+ queryKey: QueryKey;
121
+ };
105
122
  /**
106
123
  * Returns a list of Dataset Versions.
107
124
 
@@ -112,7 +129,7 @@ You will not see Datasets while their upload is still in progress.
112
129
  declare const getVersions: (datasetId: string, params?: GetVersionsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetDetail>;
113
130
  declare const getGetVersionsQueryKey: (datasetId: string, params?: GetVersionsParams) => readonly ["data-manager-api", `/dataset/${string}/versions`, ...GetVersionsParams[]];
114
131
  declare const getGetVersionsQueryOptions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
115
- query?: UseQueryOptions<DatasetDetail, TError, TData, QueryKey> | undefined;
132
+ query?: Partial<UseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
116
133
  request?: SecondParameter<typeof customInstance>;
117
134
  } | undefined) => UseQueryOptions<DatasetDetail, TError, TData, QueryKey> & {
118
135
  queryKey: QueryKey;
@@ -123,11 +140,28 @@ type GetVersionsQueryError = ErrorType<void | DmError>;
123
140
  * @summary Gets all the Versions of a specific Dataset
124
141
  */
125
142
  declare const useGetVersions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
126
- query?: UseQueryOptions<DatasetDetail, TError, TData, QueryKey> | undefined;
143
+ query?: Partial<UseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
127
144
  request?: SecondParameter<typeof customInstance>;
128
145
  } | undefined) => UseQueryResult<TData, TError> & {
129
146
  queryKey: QueryKey;
130
147
  };
148
+ declare const getGetVersionsSuspenseQueryOptions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
149
+ query?: Partial<UseSuspenseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
150
+ request?: SecondParameter<typeof customInstance>;
151
+ } | undefined) => UseSuspenseQueryOptions<DatasetDetail, TError, TData, QueryKey> & {
152
+ queryKey: QueryKey;
153
+ };
154
+ type GetVersionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
155
+ type GetVersionsSuspenseQueryError = ErrorType<void | DmError>;
156
+ /**
157
+ * @summary Gets all the Versions of a specific Dataset
158
+ */
159
+ declare const useGetVersionsSuspense: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
160
+ query?: Partial<UseSuspenseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
161
+ request?: SecondParameter<typeof customInstance>;
162
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
163
+ queryKey: QueryKey;
164
+ };
131
165
  /**
132
166
  * Given the Dataset `id` and `version` the Dataset will be removed. The API does not prevent you removing a Dataset that's been used in a **Project**. When removed using this endpoint the Dataset is automatically detached from any and all Projects that it was attached to and any corresponding Project Files relating to the Dataset are also removed.
133
167
 
@@ -162,7 +196,7 @@ declare const useDeleteDataset: <TError = ErrorType<void | DmError>, TContext =
162
196
  params?: DeleteDatasetParams | undefined;
163
197
  }, TContext> | undefined;
164
198
  request?: SecondParameter<typeof customInstance>;
165
- } | undefined) => _tanstack_react_query.UseMutationResult<TaskIdentity, TError, {
199
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<TaskIdentity, TError, {
166
200
  datasetId: string;
167
201
  datasetVersion: number;
168
202
  params?: DeleteDatasetParams | undefined;
@@ -177,7 +211,7 @@ You cannot get a Dataset until its upload is complete.
177
211
  declare const downloadDataset: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
178
212
  declare const getDownloadDatasetQueryKey: (datasetId: string, datasetVersion: number) => readonly ["data-manager-api", `/dataset/${string}/${number}`];
179
213
  declare const getDownloadDatasetQueryOptions: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
180
- query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
214
+ query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
181
215
  request?: SecondParameter<typeof customInstance>;
182
216
  } | undefined) => UseQueryOptions<void, TError, TData, QueryKey> & {
183
217
  queryKey: QueryKey;
@@ -188,11 +222,28 @@ type DownloadDatasetQueryError = ErrorType<DmError>;
188
222
  * @summary Download a Dataset
189
223
  */
190
224
  declare const useDownloadDataset: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
191
- query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
225
+ query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
192
226
  request?: SecondParameter<typeof customInstance>;
193
227
  } | undefined) => UseQueryResult<TData, TError> & {
194
228
  queryKey: QueryKey;
195
229
  };
230
+ declare const getDownloadDatasetSuspenseQueryOptions: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
231
+ query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
232
+ request?: SecondParameter<typeof customInstance>;
233
+ } | undefined) => UseSuspenseQueryOptions<void, TError, TData, QueryKey> & {
234
+ queryKey: QueryKey;
235
+ };
236
+ type DownloadDatasetSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
237
+ type DownloadDatasetSuspenseQueryError = ErrorType<DmError>;
238
+ /**
239
+ * @summary Download a Dataset
240
+ */
241
+ declare const useDownloadDatasetSuspense: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
242
+ query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
243
+ request?: SecondParameter<typeof customInstance>;
244
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
245
+ queryKey: QueryKey;
246
+ };
196
247
  /**
197
248
  * The user is removed from the Dataset's `editor` list. The user is removed from all versions of a dataset. You can remove yourself but an `owner` (creator) will always have access to the dataset.
198
249
 
@@ -224,7 +275,7 @@ declare const useRemoveEditorFromDataset: <TError = ErrorType<DmError>, TContext
224
275
  userId: string;
225
276
  }, TContext> | undefined;
226
277
  request?: SecondParameter<typeof customInstance>;
227
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
278
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
228
279
  datasetId: string;
229
280
  userId: string;
230
281
  }, TContext>;
@@ -259,7 +310,7 @@ declare const useAddEditorToDataset: <TError = ErrorType<DmError>, TContext = un
259
310
  userId: string;
260
311
  }, TContext> | undefined;
261
312
  request?: SecondParameter<typeof customInstance>;
262
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
313
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
263
314
  datasetId: string;
264
315
  userId: string;
265
316
  }, TContext>;
@@ -271,7 +322,7 @@ declare const useAddEditorToDataset: <TError = ErrorType<DmError>, TContext = un
271
322
  declare const getDatasetDigest: (datasetDigest: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetDigestGetResponse>;
272
323
  declare const getGetDatasetDigestQueryKey: (datasetDigest: string) => readonly ["data-manager-api", `/dataset/digest/${string}`];
273
324
  declare const getGetDatasetDigestQueryOptions: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
274
- query?: UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> | undefined;
325
+ query?: Partial<UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey>> | undefined;
275
326
  request?: SecondParameter<typeof customInstance>;
276
327
  } | undefined) => UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> & {
277
328
  queryKey: QueryKey;
@@ -282,11 +333,28 @@ type GetDatasetDigestQueryError = ErrorType<void | DmError>;
282
333
  * @summary Gets the first Dataset that matches the provided digest
283
334
  */
284
335
  declare const useGetDatasetDigest: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
285
- query?: UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> | undefined;
336
+ query?: Partial<UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey>> | undefined;
286
337
  request?: SecondParameter<typeof customInstance>;
287
338
  } | undefined) => UseQueryResult<TData, TError> & {
288
339
  queryKey: QueryKey;
289
340
  };
341
+ declare const getGetDatasetDigestSuspenseQueryOptions: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
342
+ query?: Partial<UseSuspenseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey>> | undefined;
343
+ request?: SecondParameter<typeof customInstance>;
344
+ } | undefined) => UseSuspenseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> & {
345
+ queryKey: QueryKey;
346
+ };
347
+ type GetDatasetDigestSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasetDigest>>>;
348
+ type GetDatasetDigestSuspenseQueryError = ErrorType<void | DmError>;
349
+ /**
350
+ * @summary Gets the first Dataset that matches the provided digest
351
+ */
352
+ declare const useGetDatasetDigestSuspense: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
353
+ query?: Partial<UseSuspenseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey>> | undefined;
354
+ request?: SecondParameter<typeof customInstance>;
355
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
356
+ queryKey: QueryKey;
357
+ };
290
358
  /**
291
359
  * Returns the property schema for a Dataset versions in JSON format (if available).
292
360
 
@@ -295,7 +363,7 @@ declare const useGetDatasetDigest: <TData = DatasetDigestGetResponse, TError = E
295
363
  declare const getSchema: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetSchemaGetResponse>;
296
364
  declare const getGetSchemaQueryKey: (datasetId: string, datasetVersion: number) => readonly ["data-manager-api", `/dataset/${string}/schema/${number}`];
297
365
  declare const getGetSchemaQueryOptions: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
298
- query?: UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> | undefined;
366
+ query?: Partial<UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
299
367
  request?: SecondParameter<typeof customInstance>;
300
368
  } | undefined) => UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> & {
301
369
  queryKey: QueryKey;
@@ -306,10 +374,27 @@ type GetSchemaQueryError = ErrorType<void | DmError>;
306
374
  * @summary Gets the property schema for a specific Dataset
307
375
  */
308
376
  declare const useGetSchema: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
309
- query?: UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> | undefined;
377
+ query?: Partial<UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
310
378
  request?: SecondParameter<typeof customInstance>;
311
379
  } | undefined) => UseQueryResult<TData, TError> & {
312
380
  queryKey: QueryKey;
313
381
  };
382
+ declare const getGetSchemaSuspenseQueryOptions: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
383
+ query?: Partial<UseSuspenseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
384
+ request?: SecondParameter<typeof customInstance>;
385
+ } | undefined) => UseSuspenseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> & {
386
+ queryKey: QueryKey;
387
+ };
388
+ type GetSchemaSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
389
+ type GetSchemaSuspenseQueryError = ErrorType<void | DmError>;
390
+ /**
391
+ * @summary Gets the property schema for a specific Dataset
392
+ */
393
+ declare const useGetSchemaSuspense: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
394
+ query?: Partial<UseSuspenseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
395
+ request?: SecondParameter<typeof customInstance>;
396
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
397
+ queryKey: QueryKey;
398
+ };
314
399
 
315
- export { AddEditorToDatasetMutationError, AddEditorToDatasetMutationResult, CreateDatasetFromFileMutationBody, CreateDatasetFromFileMutationError, CreateDatasetFromFileMutationResult, DeleteDatasetMutationError, DeleteDatasetMutationResult, DownloadDatasetQueryError, DownloadDatasetQueryResult, GetDatasetDigestQueryError, GetDatasetDigestQueryResult, GetDatasetsQueryError, GetDatasetsQueryResult, GetSchemaQueryError, GetSchemaQueryResult, GetVersionsQueryError, GetVersionsQueryResult, RemoveEditorFromDatasetMutationError, RemoveEditorFromDatasetMutationResult, UploadDatasetMutationBody, UploadDatasetMutationError, UploadDatasetMutationResult, addEditorToDataset, createDatasetFromFile, deleteDataset, downloadDataset, getAddEditorToDatasetMutationOptions, getCreateDatasetFromFileMutationOptions, getDatasetDigest, getDatasets, getDeleteDatasetMutationOptions, getDownloadDatasetQueryKey, getDownloadDatasetQueryOptions, getGetDatasetDigestQueryKey, getGetDatasetDigestQueryOptions, getGetDatasetsQueryKey, getGetDatasetsQueryOptions, getGetSchemaQueryKey, getGetSchemaQueryOptions, getGetVersionsQueryKey, getGetVersionsQueryOptions, getRemoveEditorFromDatasetMutationOptions, getSchema, getUploadDatasetMutationOptions, getVersions, removeEditorFromDataset, uploadDataset, useAddEditorToDataset, useCreateDatasetFromFile, useDeleteDataset, useDownloadDataset, useGetDatasetDigest, useGetDatasets, useGetSchema, useGetVersions, useRemoveEditorFromDataset, useUploadDataset };
400
+ export { type AddEditorToDatasetMutationError, type AddEditorToDatasetMutationResult, type CreateDatasetFromFileMutationBody, type CreateDatasetFromFileMutationError, type CreateDatasetFromFileMutationResult, type DeleteDatasetMutationError, type DeleteDatasetMutationResult, type DownloadDatasetQueryError, type DownloadDatasetQueryResult, type DownloadDatasetSuspenseQueryError, type DownloadDatasetSuspenseQueryResult, type GetDatasetDigestQueryError, type GetDatasetDigestQueryResult, type GetDatasetDigestSuspenseQueryError, type GetDatasetDigestSuspenseQueryResult, type GetDatasetsQueryError, type GetDatasetsQueryResult, type GetDatasetsSuspenseQueryError, type GetDatasetsSuspenseQueryResult, type GetSchemaQueryError, type GetSchemaQueryResult, type GetSchemaSuspenseQueryError, type GetSchemaSuspenseQueryResult, type GetVersionsQueryError, type GetVersionsQueryResult, type GetVersionsSuspenseQueryError, type GetVersionsSuspenseQueryResult, type RemoveEditorFromDatasetMutationError, type RemoveEditorFromDatasetMutationResult, type UploadDatasetMutationBody, type UploadDatasetMutationError, type UploadDatasetMutationResult, addEditorToDataset, createDatasetFromFile, deleteDataset, downloadDataset, getAddEditorToDatasetMutationOptions, getCreateDatasetFromFileMutationOptions, getDatasetDigest, getDatasets, getDeleteDatasetMutationOptions, getDownloadDatasetQueryKey, getDownloadDatasetQueryOptions, getDownloadDatasetSuspenseQueryOptions, getGetDatasetDigestQueryKey, getGetDatasetDigestQueryOptions, getGetDatasetDigestSuspenseQueryOptions, getGetDatasetsQueryKey, getGetDatasetsQueryOptions, getGetDatasetsSuspenseQueryOptions, getGetSchemaQueryKey, getGetSchemaQueryOptions, getGetSchemaSuspenseQueryOptions, getGetVersionsQueryKey, getGetVersionsQueryOptions, getGetVersionsSuspenseQueryOptions, getRemoveEditorFromDatasetMutationOptions, getSchema, getUploadDatasetMutationOptions, getVersions, removeEditorFromDataset, uploadDataset, useAddEditorToDataset, useCreateDatasetFromFile, useDeleteDataset, useDownloadDataset, useDownloadDatasetSuspense, useGetDatasetDigest, useGetDatasetDigestSuspense, useGetDatasets, useGetDatasetsSuspense, useGetSchema, useGetSchemaSuspense, useGetVersions, useGetVersionsSuspense, useRemoveEditorFromDataset, useUploadDataset };
@@ -1,9 +1,9 @@
1
- import * as _tanstack_react_query from '@tanstack/react-query';
2
- import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult } from '@tanstack/react-query';
3
- import { ag as DatasetPutBodyBody, bZ as customInstance, bM as DatasetPutPostResponse, b_ as ErrorType, bV as DmError, aj as DatasetPostBodyBody, q as GetDatasetsParams, bF as DatasetsGetResponse, p as GetVersionsParams, b2 as DatasetDetail, o as DeleteDatasetParams, av as TaskIdentity, bL as DatasetDigestGetResponse, bJ as DatasetSchemaGetResponse } from '../custom-instance-37ed2460.js';
1
+ import * as _tanstack_react_query_build_legacy_types from '@tanstack/react-query/build/legacy/types';
2
+ import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
3
+ import { DatasetPutBodyBody, customInstance, DatasetPutPostResponse, ErrorType, DmError, DatasetPostBodyBody, GetDatasetsParams, DatasetsGetResponse, GetVersionsParams, DatasetDetail, DeleteDatasetParams, TaskIdentity, DatasetDigestGetResponse, DatasetSchemaGetResponse } from '../index.js';
4
4
  import 'axios';
5
5
 
6
- type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
6
+ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
7
7
  /**
8
8
  * Using an unmanaged file in a Project as a source a Dataset (or new Dataset Version) is created.
9
9
 
@@ -33,7 +33,7 @@ declare const useCreateDatasetFromFile: <TError = ErrorType<void | DmError>, TCo
33
33
  data: DatasetPutBodyBody;
34
34
  }, TContext> | undefined;
35
35
  request?: SecondParameter<typeof customInstance>;
36
- } | undefined) => _tanstack_react_query.UseMutationResult<DatasetPutPostResponse, TError, {
36
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<DatasetPutPostResponse, TError, {
37
37
  data: DatasetPutBodyBody;
38
38
  }, TContext>;
39
39
  /**
@@ -69,7 +69,7 @@ declare const useUploadDataset: <TError = ErrorType<void | DmError>, TContext =
69
69
  data: DatasetPostBodyBody;
70
70
  }, TContext> | undefined;
71
71
  request?: SecondParameter<typeof customInstance>;
72
- } | undefined) => _tanstack_react_query.UseMutationResult<DatasetPutPostResponse, TError, {
72
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<DatasetPutPostResponse, TError, {
73
73
  data: DatasetPostBodyBody;
74
74
  }, TContext>;
75
75
  /**
@@ -86,7 +86,7 @@ Note that if `editors` are combined with `owner username`, then the datasets wil
86
86
  declare const getDatasets: (params?: GetDatasetsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetsGetResponse>;
87
87
  declare const getGetDatasetsQueryKey: (params?: GetDatasetsParams) => readonly ["data-manager-api", "/dataset", ...GetDatasetsParams[]];
88
88
  declare const getGetDatasetsQueryOptions: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
89
- query?: UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> | undefined;
89
+ query?: Partial<UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
90
90
  request?: SecondParameter<typeof customInstance>;
91
91
  } | undefined) => UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> & {
92
92
  queryKey: QueryKey;
@@ -97,11 +97,28 @@ type GetDatasetsQueryError = ErrorType<void | DmError>;
97
97
  * @summary Get Datasets that are available to you
98
98
  */
99
99
  declare const useGetDatasets: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
100
- query?: UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> | undefined;
100
+ query?: Partial<UseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
101
101
  request?: SecondParameter<typeof customInstance>;
102
102
  } | undefined) => UseQueryResult<TData, TError> & {
103
103
  queryKey: QueryKey;
104
104
  };
105
+ declare const getGetDatasetsSuspenseQueryOptions: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
106
+ query?: Partial<UseSuspenseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
107
+ request?: SecondParameter<typeof customInstance>;
108
+ } | undefined) => UseSuspenseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey> & {
109
+ queryKey: QueryKey;
110
+ };
111
+ type GetDatasetsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
112
+ type GetDatasetsSuspenseQueryError = ErrorType<void | DmError>;
113
+ /**
114
+ * @summary Get Datasets that are available to you
115
+ */
116
+ declare const useGetDatasetsSuspense: <TData = DatasetsGetResponse, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
117
+ query?: Partial<UseSuspenseQueryOptions<DatasetsGetResponse, TError, TData, QueryKey>> | undefined;
118
+ request?: SecondParameter<typeof customInstance>;
119
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
120
+ queryKey: QueryKey;
121
+ };
105
122
  /**
106
123
  * Returns a list of Dataset Versions.
107
124
 
@@ -112,7 +129,7 @@ You will not see Datasets while their upload is still in progress.
112
129
  declare const getVersions: (datasetId: string, params?: GetVersionsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetDetail>;
113
130
  declare const getGetVersionsQueryKey: (datasetId: string, params?: GetVersionsParams) => readonly ["data-manager-api", `/dataset/${string}/versions`, ...GetVersionsParams[]];
114
131
  declare const getGetVersionsQueryOptions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
115
- query?: UseQueryOptions<DatasetDetail, TError, TData, QueryKey> | undefined;
132
+ query?: Partial<UseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
116
133
  request?: SecondParameter<typeof customInstance>;
117
134
  } | undefined) => UseQueryOptions<DatasetDetail, TError, TData, QueryKey> & {
118
135
  queryKey: QueryKey;
@@ -123,11 +140,28 @@ type GetVersionsQueryError = ErrorType<void | DmError>;
123
140
  * @summary Gets all the Versions of a specific Dataset
124
141
  */
125
142
  declare const useGetVersions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
126
- query?: UseQueryOptions<DatasetDetail, TError, TData, QueryKey> | undefined;
143
+ query?: Partial<UseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
127
144
  request?: SecondParameter<typeof customInstance>;
128
145
  } | undefined) => UseQueryResult<TData, TError> & {
129
146
  queryKey: QueryKey;
130
147
  };
148
+ declare const getGetVersionsSuspenseQueryOptions: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
149
+ query?: Partial<UseSuspenseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
150
+ request?: SecondParameter<typeof customInstance>;
151
+ } | undefined) => UseSuspenseQueryOptions<DatasetDetail, TError, TData, QueryKey> & {
152
+ queryKey: QueryKey;
153
+ };
154
+ type GetVersionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
155
+ type GetVersionsSuspenseQueryError = ErrorType<void | DmError>;
156
+ /**
157
+ * @summary Gets all the Versions of a specific Dataset
158
+ */
159
+ declare const useGetVersionsSuspense: <TData = DatasetDetail, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
160
+ query?: Partial<UseSuspenseQueryOptions<DatasetDetail, TError, TData, QueryKey>> | undefined;
161
+ request?: SecondParameter<typeof customInstance>;
162
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
163
+ queryKey: QueryKey;
164
+ };
131
165
  /**
132
166
  * Given the Dataset `id` and `version` the Dataset will be removed. The API does not prevent you removing a Dataset that's been used in a **Project**. When removed using this endpoint the Dataset is automatically detached from any and all Projects that it was attached to and any corresponding Project Files relating to the Dataset are also removed.
133
167
 
@@ -162,7 +196,7 @@ declare const useDeleteDataset: <TError = ErrorType<void | DmError>, TContext =
162
196
  params?: DeleteDatasetParams | undefined;
163
197
  }, TContext> | undefined;
164
198
  request?: SecondParameter<typeof customInstance>;
165
- } | undefined) => _tanstack_react_query.UseMutationResult<TaskIdentity, TError, {
199
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<TaskIdentity, TError, {
166
200
  datasetId: string;
167
201
  datasetVersion: number;
168
202
  params?: DeleteDatasetParams | undefined;
@@ -177,7 +211,7 @@ You cannot get a Dataset until its upload is complete.
177
211
  declare const downloadDataset: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
178
212
  declare const getDownloadDatasetQueryKey: (datasetId: string, datasetVersion: number) => readonly ["data-manager-api", `/dataset/${string}/${number}`];
179
213
  declare const getDownloadDatasetQueryOptions: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
180
- query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
214
+ query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
181
215
  request?: SecondParameter<typeof customInstance>;
182
216
  } | undefined) => UseQueryOptions<void, TError, TData, QueryKey> & {
183
217
  queryKey: QueryKey;
@@ -188,11 +222,28 @@ type DownloadDatasetQueryError = ErrorType<DmError>;
188
222
  * @summary Download a Dataset
189
223
  */
190
224
  declare const useDownloadDataset: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
191
- query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
225
+ query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
192
226
  request?: SecondParameter<typeof customInstance>;
193
227
  } | undefined) => UseQueryResult<TData, TError> & {
194
228
  queryKey: QueryKey;
195
229
  };
230
+ declare const getDownloadDatasetSuspenseQueryOptions: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
231
+ query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
232
+ request?: SecondParameter<typeof customInstance>;
233
+ } | undefined) => UseSuspenseQueryOptions<void, TError, TData, QueryKey> & {
234
+ queryKey: QueryKey;
235
+ };
236
+ type DownloadDatasetSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
237
+ type DownloadDatasetSuspenseQueryError = ErrorType<DmError>;
238
+ /**
239
+ * @summary Download a Dataset
240
+ */
241
+ declare const useDownloadDatasetSuspense: <TData = void, TError = ErrorType<DmError>>(datasetId: string, datasetVersion: number, options?: {
242
+ query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
243
+ request?: SecondParameter<typeof customInstance>;
244
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
245
+ queryKey: QueryKey;
246
+ };
196
247
  /**
197
248
  * The user is removed from the Dataset's `editor` list. The user is removed from all versions of a dataset. You can remove yourself but an `owner` (creator) will always have access to the dataset.
198
249
 
@@ -224,7 +275,7 @@ declare const useRemoveEditorFromDataset: <TError = ErrorType<DmError>, TContext
224
275
  userId: string;
225
276
  }, TContext> | undefined;
226
277
  request?: SecondParameter<typeof customInstance>;
227
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
278
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
228
279
  datasetId: string;
229
280
  userId: string;
230
281
  }, TContext>;
@@ -259,7 +310,7 @@ declare const useAddEditorToDataset: <TError = ErrorType<DmError>, TContext = un
259
310
  userId: string;
260
311
  }, TContext> | undefined;
261
312
  request?: SecondParameter<typeof customInstance>;
262
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
313
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
263
314
  datasetId: string;
264
315
  userId: string;
265
316
  }, TContext>;
@@ -271,7 +322,7 @@ declare const useAddEditorToDataset: <TError = ErrorType<DmError>, TContext = un
271
322
  declare const getDatasetDigest: (datasetDigest: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetDigestGetResponse>;
272
323
  declare const getGetDatasetDigestQueryKey: (datasetDigest: string) => readonly ["data-manager-api", `/dataset/digest/${string}`];
273
324
  declare const getGetDatasetDigestQueryOptions: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
274
- query?: UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> | undefined;
325
+ query?: Partial<UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey>> | undefined;
275
326
  request?: SecondParameter<typeof customInstance>;
276
327
  } | undefined) => UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> & {
277
328
  queryKey: QueryKey;
@@ -282,11 +333,28 @@ type GetDatasetDigestQueryError = ErrorType<void | DmError>;
282
333
  * @summary Gets the first Dataset that matches the provided digest
283
334
  */
284
335
  declare const useGetDatasetDigest: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
285
- query?: UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> | undefined;
336
+ query?: Partial<UseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey>> | undefined;
286
337
  request?: SecondParameter<typeof customInstance>;
287
338
  } | undefined) => UseQueryResult<TData, TError> & {
288
339
  queryKey: QueryKey;
289
340
  };
341
+ declare const getGetDatasetDigestSuspenseQueryOptions: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
342
+ query?: Partial<UseSuspenseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey>> | undefined;
343
+ request?: SecondParameter<typeof customInstance>;
344
+ } | undefined) => UseSuspenseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey> & {
345
+ queryKey: QueryKey;
346
+ };
347
+ type GetDatasetDigestSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasetDigest>>>;
348
+ type GetDatasetDigestSuspenseQueryError = ErrorType<void | DmError>;
349
+ /**
350
+ * @summary Gets the first Dataset that matches the provided digest
351
+ */
352
+ declare const useGetDatasetDigestSuspense: <TData = DatasetDigestGetResponse, TError = ErrorType<void | DmError>>(datasetDigest: string, options?: {
353
+ query?: Partial<UseSuspenseQueryOptions<DatasetDigestGetResponse, TError, TData, QueryKey>> | undefined;
354
+ request?: SecondParameter<typeof customInstance>;
355
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
356
+ queryKey: QueryKey;
357
+ };
290
358
  /**
291
359
  * Returns the property schema for a Dataset versions in JSON format (if available).
292
360
 
@@ -295,7 +363,7 @@ declare const useGetDatasetDigest: <TData = DatasetDigestGetResponse, TError = E
295
363
  declare const getSchema: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetSchemaGetResponse>;
296
364
  declare const getGetSchemaQueryKey: (datasetId: string, datasetVersion: number) => readonly ["data-manager-api", `/dataset/${string}/schema/${number}`];
297
365
  declare const getGetSchemaQueryOptions: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
298
- query?: UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> | undefined;
366
+ query?: Partial<UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
299
367
  request?: SecondParameter<typeof customInstance>;
300
368
  } | undefined) => UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> & {
301
369
  queryKey: QueryKey;
@@ -306,10 +374,27 @@ type GetSchemaQueryError = ErrorType<void | DmError>;
306
374
  * @summary Gets the property schema for a specific Dataset
307
375
  */
308
376
  declare const useGetSchema: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
309
- query?: UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> | undefined;
377
+ query?: Partial<UseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
310
378
  request?: SecondParameter<typeof customInstance>;
311
379
  } | undefined) => UseQueryResult<TData, TError> & {
312
380
  queryKey: QueryKey;
313
381
  };
382
+ declare const getGetSchemaSuspenseQueryOptions: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
383
+ query?: Partial<UseSuspenseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
384
+ request?: SecondParameter<typeof customInstance>;
385
+ } | undefined) => UseSuspenseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey> & {
386
+ queryKey: QueryKey;
387
+ };
388
+ type GetSchemaSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
389
+ type GetSchemaSuspenseQueryError = ErrorType<void | DmError>;
390
+ /**
391
+ * @summary Gets the property schema for a specific Dataset
392
+ */
393
+ declare const useGetSchemaSuspense: <TData = DatasetSchemaGetResponse, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
394
+ query?: Partial<UseSuspenseQueryOptions<DatasetSchemaGetResponse, TError, TData, QueryKey>> | undefined;
395
+ request?: SecondParameter<typeof customInstance>;
396
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
397
+ queryKey: QueryKey;
398
+ };
314
399
 
315
- export { AddEditorToDatasetMutationError, AddEditorToDatasetMutationResult, CreateDatasetFromFileMutationBody, CreateDatasetFromFileMutationError, CreateDatasetFromFileMutationResult, DeleteDatasetMutationError, DeleteDatasetMutationResult, DownloadDatasetQueryError, DownloadDatasetQueryResult, GetDatasetDigestQueryError, GetDatasetDigestQueryResult, GetDatasetsQueryError, GetDatasetsQueryResult, GetSchemaQueryError, GetSchemaQueryResult, GetVersionsQueryError, GetVersionsQueryResult, RemoveEditorFromDatasetMutationError, RemoveEditorFromDatasetMutationResult, UploadDatasetMutationBody, UploadDatasetMutationError, UploadDatasetMutationResult, addEditorToDataset, createDatasetFromFile, deleteDataset, downloadDataset, getAddEditorToDatasetMutationOptions, getCreateDatasetFromFileMutationOptions, getDatasetDigest, getDatasets, getDeleteDatasetMutationOptions, getDownloadDatasetQueryKey, getDownloadDatasetQueryOptions, getGetDatasetDigestQueryKey, getGetDatasetDigestQueryOptions, getGetDatasetsQueryKey, getGetDatasetsQueryOptions, getGetSchemaQueryKey, getGetSchemaQueryOptions, getGetVersionsQueryKey, getGetVersionsQueryOptions, getRemoveEditorFromDatasetMutationOptions, getSchema, getUploadDatasetMutationOptions, getVersions, removeEditorFromDataset, uploadDataset, useAddEditorToDataset, useCreateDatasetFromFile, useDeleteDataset, useDownloadDataset, useGetDatasetDigest, useGetDatasets, useGetSchema, useGetVersions, useRemoveEditorFromDataset, useUploadDataset };
400
+ export { type AddEditorToDatasetMutationError, type AddEditorToDatasetMutationResult, type CreateDatasetFromFileMutationBody, type CreateDatasetFromFileMutationError, type CreateDatasetFromFileMutationResult, type DeleteDatasetMutationError, type DeleteDatasetMutationResult, type DownloadDatasetQueryError, type DownloadDatasetQueryResult, type DownloadDatasetSuspenseQueryError, type DownloadDatasetSuspenseQueryResult, type GetDatasetDigestQueryError, type GetDatasetDigestQueryResult, type GetDatasetDigestSuspenseQueryError, type GetDatasetDigestSuspenseQueryResult, type GetDatasetsQueryError, type GetDatasetsQueryResult, type GetDatasetsSuspenseQueryError, type GetDatasetsSuspenseQueryResult, type GetSchemaQueryError, type GetSchemaQueryResult, type GetSchemaSuspenseQueryError, type GetSchemaSuspenseQueryResult, type GetVersionsQueryError, type GetVersionsQueryResult, type GetVersionsSuspenseQueryError, type GetVersionsSuspenseQueryResult, type RemoveEditorFromDatasetMutationError, type RemoveEditorFromDatasetMutationResult, type UploadDatasetMutationBody, type UploadDatasetMutationError, type UploadDatasetMutationResult, addEditorToDataset, createDatasetFromFile, deleteDataset, downloadDataset, getAddEditorToDatasetMutationOptions, getCreateDatasetFromFileMutationOptions, getDatasetDigest, getDatasets, getDeleteDatasetMutationOptions, getDownloadDatasetQueryKey, getDownloadDatasetQueryOptions, getDownloadDatasetSuspenseQueryOptions, getGetDatasetDigestQueryKey, getGetDatasetDigestQueryOptions, getGetDatasetDigestSuspenseQueryOptions, getGetDatasetsQueryKey, getGetDatasetsQueryOptions, getGetDatasetsSuspenseQueryOptions, getGetSchemaQueryKey, getGetSchemaQueryOptions, getGetSchemaSuspenseQueryOptions, getGetVersionsQueryKey, getGetVersionsQueryOptions, getGetVersionsSuspenseQueryOptions, getRemoveEditorFromDatasetMutationOptions, getSchema, getUploadDatasetMutationOptions, getVersions, removeEditorFromDataset, uploadDataset, useAddEditorToDataset, useCreateDatasetFromFile, useDeleteDataset, useDownloadDataset, useDownloadDatasetSuspense, useGetDatasetDigest, useGetDatasetDigestSuspense, useGetDatasets, useGetDatasetsSuspense, useGetSchema, useGetSchemaSuspense, useGetVersions, useGetVersionsSuspense, useRemoveEditorFromDataset, useUploadDataset };