@squonk/data-manager-client 4.2.0 → 4.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/accounting/accounting.cjs +96 -95
- package/accounting/accounting.cjs.map +1 -1
- package/accounting/accounting.d.cts +47 -47
- package/accounting/accounting.d.ts +47 -47
- package/accounting/accounting.js +102 -101
- package/accounting/accounting.js.map +1 -1
- package/admin/admin.cjs +120 -145
- package/admin/admin.cjs.map +1 -1
- package/admin/admin.d.cts +121 -121
- package/admin/admin.d.ts +121 -121
- package/admin/admin.js +127 -152
- package/admin/admin.js.map +1 -1
- package/application/application.cjs +39 -43
- package/application/application.cjs.map +1 -1
- package/application/application.d.cts +25 -25
- package/application/application.d.ts +25 -25
- package/application/application.js +42 -46
- package/application/application.js.map +1 -1
- package/chunk-OYRETEBZ.js +25 -0
- package/chunk-OYRETEBZ.js.map +1 -0
- package/{chunk-TKLTUR4R.cjs → chunk-RB2KVIEK.cjs} +1 -1
- package/chunk-RB2KVIEK.cjs.map +1 -0
- package/{chunk-EBOQPVLG.js → chunk-XYDLYMQ2.js} +1 -1
- package/chunk-XYDLYMQ2.js.map +1 -0
- package/chunk-ZLY5XEOQ.cjs +25 -0
- package/chunk-ZLY5XEOQ.cjs.map +1 -0
- package/configuration/configuration.cjs +38 -45
- package/configuration/configuration.cjs.map +1 -1
- package/configuration/configuration.d.cts +25 -25
- package/configuration/configuration.d.ts +25 -25
- package/configuration/configuration.js +42 -49
- package/configuration/configuration.js.map +1 -1
- package/dataset/dataset.cjs +126 -141
- package/dataset/dataset.cjs.map +1 -1
- package/dataset/dataset.d.cts +102 -102
- package/dataset/dataset.d.ts +102 -102
- package/dataset/dataset.js +132 -147
- package/dataset/dataset.js.map +1 -1
- package/digest/digest.cjs +22 -24
- package/digest/digest.cjs.map +1 -1
- package/digest/digest.d.cts +14 -14
- package/digest/digest.d.ts +14 -14
- package/digest/digest.js +24 -26
- package/digest/digest.js.map +1 -1
- package/exchange-rate/exchange-rate.cjs +111 -109
- package/exchange-rate/exchange-rate.cjs.map +1 -1
- package/exchange-rate/exchange-rate.d.cts +69 -69
- package/exchange-rate/exchange-rate.d.ts +69 -69
- package/exchange-rate/exchange-rate.js +117 -115
- package/exchange-rate/exchange-rate.js.map +1 -1
- package/file-and-path/file-and-path.cjs +93 -138
- package/file-and-path/file-and-path.cjs.map +1 -1
- package/file-and-path/file-and-path.d.cts +102 -102
- package/file-and-path/file-and-path.d.ts +102 -102
- package/file-and-path/file-and-path.js +105 -150
- package/file-and-path/file-and-path.js.map +1 -1
- package/index.cjs +80 -102
- package/index.cjs.map +1 -1
- package/index.d.cts +2401 -2326
- package/index.d.ts +2401 -2326
- package/index.js +79 -101
- package/index.js.map +1 -1
- package/instance/instance.cjs +100 -107
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.d.cts +76 -76
- package/instance/instance.d.ts +76 -76
- package/instance/instance.js +105 -112
- package/instance/instance.js.map +1 -1
- package/inventory/inventory.cjs +22 -25
- package/inventory/inventory.cjs.map +1 -1
- package/inventory/inventory.d.cts +14 -14
- package/inventory/inventory.d.ts +14 -14
- package/inventory/inventory.js +24 -27
- package/inventory/inventory.js.map +1 -1
- package/job/job.cjs +55 -67
- package/job/job.cjs.map +1 -1
- package/job/job.d.cts +36 -36
- package/job/job.d.ts +36 -36
- package/job/job.js +60 -72
- package/job/job.js.map +1 -1
- package/metadata/metadata.cjs +61 -59
- package/metadata/metadata.cjs.map +1 -1
- package/metadata/metadata.d.cts +47 -47
- package/metadata/metadata.d.ts +47 -47
- package/metadata/metadata.js +65 -63
- package/metadata/metadata.js.map +1 -1
- package/package.json +13 -16
- package/project/project.cjs +165 -186
- package/project/project.cjs.map +1 -1
- package/project/project.d.cts +157 -157
- package/project/project.d.ts +157 -157
- package/project/project.js +172 -193
- package/project/project.js.map +1 -1
- package/src/accounting/accounting.ts +767 -461
- package/src/admin/admin.ts +1187 -787
- package/src/application/application.ts +377 -231
- package/src/configuration/configuration.ts +348 -237
- package/src/custom-instance.ts +3 -3
- package/src/data-manager-api.schemas.ts +2538 -2492
- package/src/dataset/dataset.ts +1199 -792
- package/src/digest/digest.ts +198 -122
- package/src/exchange-rate/exchange-rate.ts +1088 -612
- package/src/file-and-path/file-and-path.ts +869 -616
- package/src/index.ts +2 -2
- package/src/instance/instance.ts +804 -539
- package/src/inventory/inventory.ts +200 -122
- package/src/job/job.ts +556 -348
- package/src/metadata/metadata.ts +587 -371
- package/src/options-mutator.ts +27 -0
- package/src/project/project.ts +1576 -1034
- package/src/task/task.ts +434 -295
- package/src/type/type.ts +180 -126
- package/src/user/user.ts +846 -398
- package/src/workflow/workflow.ts +1750 -1089
- package/task/task.cjs +45 -59
- package/task/task.cjs.map +1 -1
- package/task/task.d.cts +33 -33
- package/task/task.d.ts +33 -33
- package/task/task.js +51 -65
- package/task/task.js.map +1 -1
- package/type/type.cjs +21 -26
- package/type/type.cjs.map +1 -1
- package/type/type.d.cts +14 -14
- package/type/type.d.ts +14 -14
- package/type/type.js +24 -29
- package/type/type.js.map +1 -1
- package/user/user.cjs +114 -80
- package/user/user.cjs.map +1 -1
- package/user/user.d.cts +107 -48
- package/user/user.d.ts +107 -48
- package/user/user.js +120 -86
- package/user/user.js.map +1 -1
- package/workflow/workflow.cjs +179 -193
- package/workflow/workflow.cjs.map +1 -1
- package/workflow/workflow.d.cts +146 -146
- package/workflow/workflow.d.ts +146 -146
- package/workflow/workflow.js +187 -201
- package/workflow/workflow.js.map +1 -1
- package/chunk-EBOQPVLG.js.map +0 -1
- package/chunk-TKLTUR4R.cjs.map +0 -1
package/dataset/dataset.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { UseMutationOptions, UseMutationResult, UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
|
|
1
|
+
import { UseMutationOptions, QueryClient, UseMutationResult, UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
|
|
2
2
|
import { DatasetPutBodyBody, customInstance, DatasetPutPostResponse, ErrorType, DmError, DatasetPostBodyBody, GetDatasetsParams, DatasetsGetResponse, GetVersionsParams, DatasetDetail, DeleteDatasetParams, TaskIdentity, DatasetSchemaGetResponse } from '../index.js';
|
|
3
3
|
import 'axios';
|
|
4
4
|
|
|
5
|
-
type SecondParameter<T extends (...args:
|
|
5
|
+
type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
|
|
6
6
|
/**
|
|
7
7
|
* Using an unmanaged file in a Project as a source a Dataset (or new Dataset Version) is created.
|
|
8
8
|
|
|
@@ -13,30 +13,30 @@ Behaves like the corresponding **POST** method except the file is expected to ex
|
|
|
13
13
|
* @summary Create a Dataset from a file in a Project
|
|
14
14
|
*/
|
|
15
15
|
declare const createDatasetFromFile: (datasetPutBodyBody: DatasetPutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<DatasetPutPostResponse>;
|
|
16
|
-
declare const
|
|
17
|
-
mutation?: UseMutationOptions<
|
|
16
|
+
declare const useCreateDatasetFromFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
17
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
|
|
18
18
|
data: DatasetPutBodyBody;
|
|
19
19
|
}, TContext>;
|
|
20
20
|
request?: SecondParameter<typeof customInstance>;
|
|
21
|
-
}) => UseMutationOptions<
|
|
21
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
|
|
22
22
|
data: DatasetPutBodyBody;
|
|
23
23
|
}, TContext>;
|
|
24
24
|
type CreateDatasetFromFileMutationResult = NonNullable<Awaited<ReturnType<typeof createDatasetFromFile>>>;
|
|
25
25
|
type CreateDatasetFromFileMutationBody = DatasetPutBodyBody;
|
|
26
26
|
type CreateDatasetFromFileMutationError = ErrorType<void | DmError>;
|
|
27
27
|
/**
|
|
28
|
-
* @summary Create a Dataset from a file in a Project
|
|
29
|
-
*/
|
|
30
|
-
declare const useCreateDatasetFromFile: <
|
|
31
|
-
mutation?: UseMutationOptions<
|
|
28
|
+
* @summary Create a Dataset from a file in a Project
|
|
29
|
+
*/
|
|
30
|
+
declare const useCreateDatasetFromFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
31
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
|
|
32
32
|
data: DatasetPutBodyBody;
|
|
33
33
|
}, TContext>;
|
|
34
34
|
request?: SecondParameter<typeof customInstance>;
|
|
35
|
-
}) => UseMutationResult<
|
|
35
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createDatasetFromFile>>, TError, {
|
|
36
36
|
data: DatasetPutBodyBody;
|
|
37
37
|
}, TContext>;
|
|
38
38
|
/**
|
|
39
|
-
* Uploads a dataset.
|
|
39
|
+
* Uploads a dataset.
|
|
40
40
|
|
|
41
41
|
Dataset file-naming is strictly limited to a fixed set of extensions based on the Dataset **Type**. You can obtain the supported types (and their extensions) via the `/type` endpoint. Filenames that do not comply with the supported filename extensions will be rejected.
|
|
42
42
|
|
|
@@ -46,33 +46,33 @@ The Dataset is assigned a unique identity if it has no **Parent**. If a Parent d
|
|
|
46
46
|
|
|
47
47
|
Datasets undergo some processing in an asynchronous **Task** after control returns to you. The unique identity of the assigned task (the `task id`) is presented to you in this endpoint's response. Before you can use an uploaded dataset, and before the dataset can be added to any pre-assigned projects, you must wait until the task is complete by making regular calls to the `/task/{task-id}` endpoint. A Dataset upload is complete when the corresponding `task.done` is **true** along with a `task.exit_code` of **0**. If the Dataset upload fails `task.done` will be **true** but the `task.exit_code` will be non-zero.
|
|
48
48
|
|
|
49
|
-
* @summary Upload an external file as a Dataset
|
|
50
|
-
*/
|
|
49
|
+
* @summary Upload an external file as a Dataset
|
|
50
|
+
*/
|
|
51
51
|
declare const uploadDataset: (datasetPostBodyBody: DatasetPostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetPutPostResponse>;
|
|
52
|
-
declare const
|
|
53
|
-
mutation?: UseMutationOptions<
|
|
52
|
+
declare const useUploadDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
53
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof uploadDataset>>, TError, {
|
|
54
54
|
data: DatasetPostBodyBody;
|
|
55
55
|
}, TContext>;
|
|
56
56
|
request?: SecondParameter<typeof customInstance>;
|
|
57
|
-
}) => UseMutationOptions<
|
|
57
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof uploadDataset>>, TError, {
|
|
58
58
|
data: DatasetPostBodyBody;
|
|
59
59
|
}, TContext>;
|
|
60
60
|
type UploadDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof uploadDataset>>>;
|
|
61
61
|
type UploadDatasetMutationBody = DatasetPostBodyBody;
|
|
62
62
|
type UploadDatasetMutationError = ErrorType<void | DmError>;
|
|
63
63
|
/**
|
|
64
|
-
* @summary Upload an external file as a Dataset
|
|
65
|
-
*/
|
|
66
|
-
declare const useUploadDataset: <
|
|
67
|
-
mutation?: UseMutationOptions<
|
|
64
|
+
* @summary Upload an external file as a Dataset
|
|
65
|
+
*/
|
|
66
|
+
declare const useUploadDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
67
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof uploadDataset>>, TError, {
|
|
68
68
|
data: DatasetPostBodyBody;
|
|
69
69
|
}, TContext>;
|
|
70
70
|
request?: SecondParameter<typeof customInstance>;
|
|
71
|
-
}) => UseMutationResult<
|
|
71
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof uploadDataset>>, TError, {
|
|
72
72
|
data: DatasetPostBodyBody;
|
|
73
73
|
}, TContext>;
|
|
74
74
|
/**
|
|
75
|
-
* Returns datasets that you have access to, whether attached to a project or not.
|
|
75
|
+
* Returns datasets that you have access to, whether attached to a project or not.
|
|
76
76
|
|
|
77
77
|
You will not see Datasets while their upload is still in progress.
|
|
78
78
|
|
|
@@ -80,11 +80,11 @@ Datasets can be filtered by the `owner username`, `mime_type`, a list of `owners
|
|
|
80
80
|
|
|
81
81
|
Note that if `editors` are combined with `owner username`, then the datasets will be filtered by owner username first followed by editors (so it's an AND). If `editors` are combined with `owners`, then the result will be datasets filtered by a combination of owners OR editors.
|
|
82
82
|
|
|
83
|
-
* @summary Get Datasets that are available to you
|
|
84
|
-
*/
|
|
83
|
+
* @summary Get Datasets that are available to you
|
|
84
|
+
*/
|
|
85
85
|
declare const getDatasets: (params?: GetDatasetsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetsGetResponse>;
|
|
86
|
-
declare const getGetDatasetsQueryKey: (params?: GetDatasetsParams) => readonly ["
|
|
87
|
-
declare const
|
|
86
|
+
declare const getGetDatasetsQueryKey: (params?: GetDatasetsParams) => readonly ["/dataset", ...GetDatasetsParams[]];
|
|
87
|
+
declare const useGetDatasetsQueryOptions: <TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
|
|
88
88
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
|
|
89
89
|
request?: SecondParameter<typeof customInstance>;
|
|
90
90
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData> & {
|
|
@@ -93,24 +93,24 @@ declare const getGetDatasetsQueryOptions: <TData = DatasetsGetResponse, TError =
|
|
|
93
93
|
type GetDatasetsQueryResult = NonNullable<Awaited<ReturnType<typeof getDatasets>>>;
|
|
94
94
|
type GetDatasetsQueryError = ErrorType<void | DmError>;
|
|
95
95
|
declare function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params: undefined | GetDatasetsParams, options: {
|
|
96
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getDatasets>>, TError,
|
|
96
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getDatasets>>, TError, Awaited<ReturnType<typeof getDatasets>>>, "initialData">;
|
|
97
97
|
request?: SecondParameter<typeof customInstance>;
|
|
98
|
-
}): DefinedUseQueryResult<TData, TError> & {
|
|
98
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
99
99
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
100
100
|
};
|
|
101
101
|
declare function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
|
|
102
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getDatasets>>, TError,
|
|
102
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getDatasets>>, TError, Awaited<ReturnType<typeof getDatasets>>>, "initialData">;
|
|
103
103
|
request?: SecondParameter<typeof customInstance>;
|
|
104
|
-
}): UseQueryResult<TData, TError> & {
|
|
104
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
105
105
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
106
106
|
};
|
|
107
107
|
declare function useGetDatasets<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
|
|
108
108
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
|
|
109
109
|
request?: SecondParameter<typeof customInstance>;
|
|
110
|
-
}): UseQueryResult<TData, TError> & {
|
|
110
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
111
111
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
112
112
|
};
|
|
113
|
-
declare const
|
|
113
|
+
declare const useGetDatasetsSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
|
|
114
114
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
|
|
115
115
|
request?: SecondParameter<typeof customInstance>;
|
|
116
116
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData> & {
|
|
@@ -121,19 +121,19 @@ type GetDatasetsSuspenseQueryError = ErrorType<void | DmError>;
|
|
|
121
121
|
declare function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params: undefined | GetDatasetsParams, options: {
|
|
122
122
|
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
|
|
123
123
|
request?: SecondParameter<typeof customInstance>;
|
|
124
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
124
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
125
125
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
126
126
|
};
|
|
127
127
|
declare function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
|
|
128
128
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
|
|
129
129
|
request?: SecondParameter<typeof customInstance>;
|
|
130
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
130
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
131
131
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
132
132
|
};
|
|
133
133
|
declare function useGetDatasetsSuspense<TData = Awaited<ReturnType<typeof getDatasets>>, TError = ErrorType<void | DmError>>(params?: GetDatasetsParams, options?: {
|
|
134
134
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDatasets>>, TError, TData>>;
|
|
135
135
|
request?: SecondParameter<typeof customInstance>;
|
|
136
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
136
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
137
137
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
138
138
|
};
|
|
139
139
|
/**
|
|
@@ -144,8 +144,8 @@ You will not see Datasets while their upload is still in progress.
|
|
|
144
144
|
* @summary Gets all the Versions of a specific Dataset
|
|
145
145
|
*/
|
|
146
146
|
declare const getVersions: (datasetId: string, params?: GetVersionsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetDetail>;
|
|
147
|
-
declare const getGetVersionsQueryKey: (datasetId: string, params?: GetVersionsParams) => readonly [
|
|
148
|
-
declare const
|
|
147
|
+
declare const getGetVersionsQueryKey: (datasetId: string, params?: GetVersionsParams) => readonly [`/dataset/${string}/versions`, ...GetVersionsParams[]];
|
|
148
|
+
declare const useGetVersionsQueryOptions: <TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
|
|
149
149
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
|
|
150
150
|
request?: SecondParameter<typeof customInstance>;
|
|
151
151
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData> & {
|
|
@@ -154,24 +154,24 @@ declare const getGetVersionsQueryOptions: <TData = DatasetDetail, TError = Error
|
|
|
154
154
|
type GetVersionsQueryResult = NonNullable<Awaited<ReturnType<typeof getVersions>>>;
|
|
155
155
|
type GetVersionsQueryError = ErrorType<void | DmError>;
|
|
156
156
|
declare function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params: undefined | GetVersionsParams, options: {
|
|
157
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getVersions>>, TError,
|
|
157
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getVersions>>, TError, Awaited<ReturnType<typeof getVersions>>>, "initialData">;
|
|
158
158
|
request?: SecondParameter<typeof customInstance>;
|
|
159
|
-
}): DefinedUseQueryResult<TData, TError> & {
|
|
159
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
160
160
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
161
161
|
};
|
|
162
162
|
declare function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
|
|
163
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getVersions>>, TError,
|
|
163
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getVersions>>, TError, Awaited<ReturnType<typeof getVersions>>>, "initialData">;
|
|
164
164
|
request?: SecondParameter<typeof customInstance>;
|
|
165
|
-
}): UseQueryResult<TData, TError> & {
|
|
165
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
166
166
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
167
167
|
};
|
|
168
168
|
declare function useGetVersions<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
|
|
169
169
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
|
|
170
170
|
request?: SecondParameter<typeof customInstance>;
|
|
171
|
-
}): UseQueryResult<TData, TError> & {
|
|
171
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
172
172
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
173
173
|
};
|
|
174
|
-
declare const
|
|
174
|
+
declare const useGetVersionsSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
|
|
175
175
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
|
|
176
176
|
request?: SecondParameter<typeof customInstance>;
|
|
177
177
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData> & {
|
|
@@ -182,19 +182,19 @@ type GetVersionsSuspenseQueryError = ErrorType<void | DmError>;
|
|
|
182
182
|
declare function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params: undefined | GetVersionsParams, options: {
|
|
183
183
|
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
|
|
184
184
|
request?: SecondParameter<typeof customInstance>;
|
|
185
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
185
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
186
186
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
187
187
|
};
|
|
188
188
|
declare function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
|
|
189
189
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
|
|
190
190
|
request?: SecondParameter<typeof customInstance>;
|
|
191
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
191
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
192
192
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
193
193
|
};
|
|
194
194
|
declare function useGetVersionsSuspense<TData = Awaited<ReturnType<typeof getVersions>>, TError = ErrorType<void | DmError>>(datasetId: string, params?: GetVersionsParams, options?: {
|
|
195
195
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getVersions>>, TError, TData>>;
|
|
196
196
|
request?: SecondParameter<typeof customInstance>;
|
|
197
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
197
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
198
198
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
199
199
|
};
|
|
200
200
|
/**
|
|
@@ -207,14 +207,14 @@ You cannot delete a Dataset until its upload is complete.
|
|
|
207
207
|
* @summary Delete a Dataset
|
|
208
208
|
*/
|
|
209
209
|
declare const deleteDataset: (datasetId: string, datasetVersion: number, params?: DeleteDatasetParams, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
|
|
210
|
-
declare const
|
|
211
|
-
mutation?: UseMutationOptions<
|
|
210
|
+
declare const useDeleteDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
211
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteDataset>>, TError, {
|
|
212
212
|
datasetId: string;
|
|
213
213
|
datasetVersion: number;
|
|
214
214
|
params?: DeleteDatasetParams;
|
|
215
215
|
}, TContext>;
|
|
216
216
|
request?: SecondParameter<typeof customInstance>;
|
|
217
|
-
}) => UseMutationOptions<
|
|
217
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteDataset>>, TError, {
|
|
218
218
|
datasetId: string;
|
|
219
219
|
datasetVersion: number;
|
|
220
220
|
params?: DeleteDatasetParams;
|
|
@@ -222,30 +222,30 @@ declare const getDeleteDatasetMutationOptions: <TData = TaskIdentity, TError = E
|
|
|
222
222
|
type DeleteDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof deleteDataset>>>;
|
|
223
223
|
type DeleteDatasetMutationError = ErrorType<void | DmError>;
|
|
224
224
|
/**
|
|
225
|
-
* @summary Delete a Dataset
|
|
226
|
-
*/
|
|
227
|
-
declare const useDeleteDataset: <
|
|
228
|
-
mutation?: UseMutationOptions<
|
|
225
|
+
* @summary Delete a Dataset
|
|
226
|
+
*/
|
|
227
|
+
declare const useDeleteDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
228
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteDataset>>, TError, {
|
|
229
229
|
datasetId: string;
|
|
230
230
|
datasetVersion: number;
|
|
231
231
|
params?: DeleteDatasetParams;
|
|
232
232
|
}, TContext>;
|
|
233
233
|
request?: SecondParameter<typeof customInstance>;
|
|
234
|
-
}) => UseMutationResult<
|
|
234
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteDataset>>, TError, {
|
|
235
235
|
datasetId: string;
|
|
236
236
|
datasetVersion: number;
|
|
237
237
|
params?: DeleteDatasetParams;
|
|
238
238
|
}, TContext>;
|
|
239
239
|
/**
|
|
240
|
-
* Given a `dataset_id` the dataset will be returned if available.
|
|
240
|
+
* Given a `dataset_id` the dataset will be returned if available.
|
|
241
241
|
|
|
242
242
|
You cannot get a Dataset until its upload is complete.
|
|
243
243
|
|
|
244
|
-
* @summary Download a Dataset
|
|
245
|
-
*/
|
|
244
|
+
* @summary Download a Dataset
|
|
245
|
+
*/
|
|
246
246
|
declare const downloadDataset: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
|
|
247
|
-
declare const getDownloadDatasetQueryKey: (datasetId: string, datasetVersion: number) => readonly [
|
|
248
|
-
declare const
|
|
247
|
+
declare const getDownloadDatasetQueryKey: (datasetId: string, datasetVersion: number) => readonly [`/dataset/${string}/${number}`];
|
|
248
|
+
declare const useDownloadDatasetQueryOptions: <TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
249
249
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
|
|
250
250
|
request?: SecondParameter<typeof customInstance>;
|
|
251
251
|
}) => UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData> & {
|
|
@@ -254,24 +254,24 @@ declare const getDownloadDatasetQueryOptions: <TData = void, TError = ErrorType<
|
|
|
254
254
|
type DownloadDatasetQueryResult = NonNullable<Awaited<ReturnType<typeof downloadDataset>>>;
|
|
255
255
|
type DownloadDatasetQueryError = ErrorType<void | DmError>;
|
|
256
256
|
declare function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options: {
|
|
257
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof downloadDataset>>, TError,
|
|
257
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, Awaited<ReturnType<typeof downloadDataset>>>, "initialData">;
|
|
258
258
|
request?: SecondParameter<typeof customInstance>;
|
|
259
|
-
}): DefinedUseQueryResult<TData, TError> & {
|
|
259
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
260
260
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
261
261
|
};
|
|
262
262
|
declare function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
263
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof downloadDataset>>, TError,
|
|
263
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, Awaited<ReturnType<typeof downloadDataset>>>, "initialData">;
|
|
264
264
|
request?: SecondParameter<typeof customInstance>;
|
|
265
|
-
}): UseQueryResult<TData, TError> & {
|
|
265
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
266
266
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
267
267
|
};
|
|
268
268
|
declare function useDownloadDataset<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
269
269
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
|
|
270
270
|
request?: SecondParameter<typeof customInstance>;
|
|
271
|
-
}): UseQueryResult<TData, TError> & {
|
|
271
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
272
272
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
273
273
|
};
|
|
274
|
-
declare const
|
|
274
|
+
declare const useDownloadDatasetSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
275
275
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
|
|
276
276
|
request?: SecondParameter<typeof customInstance>;
|
|
277
277
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData> & {
|
|
@@ -282,19 +282,19 @@ type DownloadDatasetSuspenseQueryError = ErrorType<void | DmError>;
|
|
|
282
282
|
declare function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options: {
|
|
283
283
|
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
|
|
284
284
|
request?: SecondParameter<typeof customInstance>;
|
|
285
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
285
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
286
286
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
287
287
|
};
|
|
288
288
|
declare function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
289
289
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
|
|
290
290
|
request?: SecondParameter<typeof customInstance>;
|
|
291
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
291
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
292
292
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
293
293
|
};
|
|
294
294
|
declare function useDownloadDatasetSuspense<TData = Awaited<ReturnType<typeof downloadDataset>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
295
295
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadDataset>>, TError, TData>>;
|
|
296
296
|
request?: SecondParameter<typeof customInstance>;
|
|
297
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
297
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
298
298
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
299
299
|
};
|
|
300
300
|
/**
|
|
@@ -307,74 +307,74 @@ You cannot modify Dataset editors until its upload is complete.
|
|
|
307
307
|
* @summary Remove a user's edit permission for a Dataset
|
|
308
308
|
*/
|
|
309
309
|
declare const removeEditorFromDataset: (datasetId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
310
|
-
declare const
|
|
311
|
-
mutation?: UseMutationOptions<
|
|
310
|
+
declare const useRemoveEditorFromDatasetMutationOptions: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
311
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
|
|
312
312
|
datasetId: string;
|
|
313
313
|
userId: string;
|
|
314
314
|
}, TContext>;
|
|
315
315
|
request?: SecondParameter<typeof customInstance>;
|
|
316
|
-
}) => UseMutationOptions<
|
|
316
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
|
|
317
317
|
datasetId: string;
|
|
318
318
|
userId: string;
|
|
319
319
|
}, TContext>;
|
|
320
320
|
type RemoveEditorFromDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof removeEditorFromDataset>>>;
|
|
321
321
|
type RemoveEditorFromDatasetMutationError = ErrorType<DmError | void>;
|
|
322
322
|
/**
|
|
323
|
-
* @summary Remove a user's edit permission for a Dataset
|
|
324
|
-
*/
|
|
325
|
-
declare const useRemoveEditorFromDataset: <
|
|
326
|
-
mutation?: UseMutationOptions<
|
|
323
|
+
* @summary Remove a user's edit permission for a Dataset
|
|
324
|
+
*/
|
|
325
|
+
declare const useRemoveEditorFromDataset: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
326
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
|
|
327
327
|
datasetId: string;
|
|
328
328
|
userId: string;
|
|
329
329
|
}, TContext>;
|
|
330
330
|
request?: SecondParameter<typeof customInstance>;
|
|
331
|
-
}) => UseMutationResult<
|
|
331
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof removeEditorFromDataset>>, TError, {
|
|
332
332
|
datasetId: string;
|
|
333
333
|
userId: string;
|
|
334
334
|
}, TContext>;
|
|
335
335
|
/**
|
|
336
|
-
* The user is added to the dataset's `editor`` list. The dataset `owner` is automatically an editor and so does not need to be added as an `editor`.
|
|
336
|
+
* The user is added to the dataset's `editor`` list. The dataset `owner` is automatically an editor and so does not need to be added as an `editor`.
|
|
337
337
|
|
|
338
338
|
You must be an `editor` or `owner` of the dataset.
|
|
339
339
|
|
|
340
340
|
You cannot modify Dataset editors until its upload is complete.
|
|
341
341
|
|
|
342
|
-
* @summary Give a user edit permission for a Dataset
|
|
343
|
-
*/
|
|
342
|
+
* @summary Give a user edit permission for a Dataset
|
|
343
|
+
*/
|
|
344
344
|
declare const addEditorToDataset: (datasetId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
345
|
-
declare const
|
|
346
|
-
mutation?: UseMutationOptions<
|
|
345
|
+
declare const useAddEditorToDatasetMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
346
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
|
|
347
347
|
datasetId: string;
|
|
348
348
|
userId: string;
|
|
349
349
|
}, TContext>;
|
|
350
350
|
request?: SecondParameter<typeof customInstance>;
|
|
351
|
-
}) => UseMutationOptions<
|
|
351
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
|
|
352
352
|
datasetId: string;
|
|
353
353
|
userId: string;
|
|
354
354
|
}, TContext>;
|
|
355
355
|
type AddEditorToDatasetMutationResult = NonNullable<Awaited<ReturnType<typeof addEditorToDataset>>>;
|
|
356
356
|
type AddEditorToDatasetMutationError = ErrorType<void | DmError>;
|
|
357
357
|
/**
|
|
358
|
-
* @summary Give a user edit permission for a Dataset
|
|
359
|
-
*/
|
|
360
|
-
declare const useAddEditorToDataset: <
|
|
361
|
-
mutation?: UseMutationOptions<
|
|
358
|
+
* @summary Give a user edit permission for a Dataset
|
|
359
|
+
*/
|
|
360
|
+
declare const useAddEditorToDataset: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
361
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
|
|
362
362
|
datasetId: string;
|
|
363
363
|
userId: string;
|
|
364
364
|
}, TContext>;
|
|
365
365
|
request?: SecondParameter<typeof customInstance>;
|
|
366
|
-
}) => UseMutationResult<
|
|
366
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof addEditorToDataset>>, TError, {
|
|
367
367
|
datasetId: string;
|
|
368
368
|
userId: string;
|
|
369
369
|
}, TContext>;
|
|
370
370
|
/**
|
|
371
|
-
* Returns the property schema for a Dataset versions in JSON format (if available).
|
|
371
|
+
* Returns the property schema for a Dataset versions in JSON format (if available).
|
|
372
372
|
|
|
373
|
-
* @summary Gets the property schema for a specific Dataset
|
|
374
|
-
*/
|
|
373
|
+
* @summary Gets the property schema for a specific Dataset
|
|
374
|
+
*/
|
|
375
375
|
declare const getSchema: (datasetId: string, datasetVersion: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<DatasetSchemaGetResponse>;
|
|
376
|
-
declare const getGetSchemaQueryKey: (datasetId: string, datasetVersion: number) => readonly [
|
|
377
|
-
declare const
|
|
376
|
+
declare const getGetSchemaQueryKey: (datasetId: string, datasetVersion: number) => readonly [`/dataset/${string}/schema/${number}`];
|
|
377
|
+
declare const useGetSchemaQueryOptions: <TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
378
378
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
|
|
379
379
|
request?: SecondParameter<typeof customInstance>;
|
|
380
380
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData> & {
|
|
@@ -383,24 +383,24 @@ declare const getGetSchemaQueryOptions: <TData = DatasetSchemaGetResponse, TErro
|
|
|
383
383
|
type GetSchemaQueryResult = NonNullable<Awaited<ReturnType<typeof getSchema>>>;
|
|
384
384
|
type GetSchemaQueryError = ErrorType<void | DmError>;
|
|
385
385
|
declare function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options: {
|
|
386
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getSchema>>, TError,
|
|
386
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getSchema>>, TError, Awaited<ReturnType<typeof getSchema>>>, "initialData">;
|
|
387
387
|
request?: SecondParameter<typeof customInstance>;
|
|
388
|
-
}): DefinedUseQueryResult<TData, TError> & {
|
|
388
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
389
389
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
390
390
|
};
|
|
391
391
|
declare function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
392
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getSchema>>, TError,
|
|
392
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getSchema>>, TError, Awaited<ReturnType<typeof getSchema>>>, "initialData">;
|
|
393
393
|
request?: SecondParameter<typeof customInstance>;
|
|
394
|
-
}): UseQueryResult<TData, TError> & {
|
|
394
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
395
395
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
396
396
|
};
|
|
397
397
|
declare function useGetSchema<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
398
398
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
|
|
399
399
|
request?: SecondParameter<typeof customInstance>;
|
|
400
|
-
}): UseQueryResult<TData, TError> & {
|
|
400
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
401
401
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
402
402
|
};
|
|
403
|
-
declare const
|
|
403
|
+
declare const useGetSchemaSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
404
404
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
|
|
405
405
|
request?: SecondParameter<typeof customInstance>;
|
|
406
406
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData> & {
|
|
@@ -411,20 +411,20 @@ type GetSchemaSuspenseQueryError = ErrorType<void | DmError>;
|
|
|
411
411
|
declare function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options: {
|
|
412
412
|
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
|
|
413
413
|
request?: SecondParameter<typeof customInstance>;
|
|
414
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
414
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
415
415
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
416
416
|
};
|
|
417
417
|
declare function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
418
418
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
|
|
419
419
|
request?: SecondParameter<typeof customInstance>;
|
|
420
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
420
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
421
421
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
422
422
|
};
|
|
423
423
|
declare function useGetSchemaSuspense<TData = Awaited<ReturnType<typeof getSchema>>, TError = ErrorType<void | DmError>>(datasetId: string, datasetVersion: number, options?: {
|
|
424
424
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getSchema>>, TError, TData>>;
|
|
425
425
|
request?: SecondParameter<typeof customInstance>;
|
|
426
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
426
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
427
427
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
428
428
|
};
|
|
429
429
|
|
|
430
|
-
export { type AddEditorToDatasetMutationError, type AddEditorToDatasetMutationResult, type CreateDatasetFromFileMutationBody, type CreateDatasetFromFileMutationError, type CreateDatasetFromFileMutationResult, type DeleteDatasetMutationError, type DeleteDatasetMutationResult, type DownloadDatasetQueryError, type DownloadDatasetQueryResult, type DownloadDatasetSuspenseQueryError, type DownloadDatasetSuspenseQueryResult, 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,
|
|
430
|
+
export { type AddEditorToDatasetMutationError, type AddEditorToDatasetMutationResult, type CreateDatasetFromFileMutationBody, type CreateDatasetFromFileMutationError, type CreateDatasetFromFileMutationResult, type DeleteDatasetMutationError, type DeleteDatasetMutationResult, type DownloadDatasetQueryError, type DownloadDatasetQueryResult, type DownloadDatasetSuspenseQueryError, type DownloadDatasetSuspenseQueryResult, 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, getDatasets, getDownloadDatasetQueryKey, getGetDatasetsQueryKey, getGetSchemaQueryKey, getGetVersionsQueryKey, getSchema, getVersions, removeEditorFromDataset, uploadDataset, useAddEditorToDataset, useAddEditorToDatasetMutationOptions, useCreateDatasetFromFile, useCreateDatasetFromFileMutationOptions, useDeleteDataset, useDeleteDatasetMutationOptions, useDownloadDataset, useDownloadDatasetQueryOptions, useDownloadDatasetSuspense, useDownloadDatasetSuspenseQueryOptions, useGetDatasets, useGetDatasetsQueryOptions, useGetDatasetsSuspense, useGetDatasetsSuspenseQueryOptions, useGetSchema, useGetSchemaQueryOptions, useGetSchemaSuspense, useGetSchemaSuspenseQueryOptions, useGetVersions, useGetVersionsQueryOptions, useGetVersionsSuspense, useGetVersionsSuspenseQueryOptions, useRemoveEditorFromDataset, useRemoveEditorFromDatasetMutationOptions, useUploadDataset, useUploadDatasetMutationOptions };
|