@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/project/project.d.cts
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import { UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
|
|
1
|
+
import { UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, QueryClient, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
|
|
2
2
|
import { GetProjectsParams, customInstance, ProjectsGetResponse, ErrorType, DmError, ProjectPostBodyBody, ProjectPostResponse, ProjectDetail, ProjectPatchBodyBody, TaskIdentity, GetProjectFileParams, ProjectFilePutBodyBody, GetProjectFileWithTokenParams } from '../index.cjs';
|
|
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
|
* @summary Get all Projects available to you
|
|
8
8
|
*/
|
|
9
9
|
declare const getProjects: (params?: GetProjectsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ProjectsGetResponse>;
|
|
10
|
-
declare const getGetProjectsQueryKey: (params?: GetProjectsParams) => readonly ["
|
|
11
|
-
declare const
|
|
10
|
+
declare const getGetProjectsQueryKey: (params?: GetProjectsParams) => readonly ["/project", ...GetProjectsParams[]];
|
|
11
|
+
declare const useGetProjectsQueryOptions: <TData = Awaited<ReturnType<typeof getProjects>>, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
|
|
12
12
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>>;
|
|
13
13
|
request?: SecondParameter<typeof customInstance>;
|
|
14
14
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData> & {
|
|
@@ -17,24 +17,24 @@ declare const getGetProjectsQueryOptions: <TData = ProjectsGetResponse, TError =
|
|
|
17
17
|
type GetProjectsQueryResult = NonNullable<Awaited<ReturnType<typeof getProjects>>>;
|
|
18
18
|
type GetProjectsQueryError = ErrorType<void | DmError>;
|
|
19
19
|
declare function useGetProjects<TData = Awaited<ReturnType<typeof getProjects>>, TError = ErrorType<void | DmError>>(params: undefined | GetProjectsParams, options: {
|
|
20
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProjects>>, TError,
|
|
20
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProjects>>, TError, Awaited<ReturnType<typeof getProjects>>>, "initialData">;
|
|
21
21
|
request?: SecondParameter<typeof customInstance>;
|
|
22
|
-
}): DefinedUseQueryResult<TData, TError> & {
|
|
22
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
23
23
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
24
24
|
};
|
|
25
25
|
declare function useGetProjects<TData = Awaited<ReturnType<typeof getProjects>>, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
|
|
26
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProjects>>, TError,
|
|
26
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProjects>>, TError, Awaited<ReturnType<typeof getProjects>>>, "initialData">;
|
|
27
27
|
request?: SecondParameter<typeof customInstance>;
|
|
28
|
-
}): UseQueryResult<TData, TError> & {
|
|
28
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
29
29
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
30
30
|
};
|
|
31
31
|
declare function useGetProjects<TData = Awaited<ReturnType<typeof getProjects>>, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
|
|
32
32
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>>;
|
|
33
33
|
request?: SecondParameter<typeof customInstance>;
|
|
34
|
-
}): UseQueryResult<TData, TError> & {
|
|
34
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
35
35
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
36
36
|
};
|
|
37
|
-
declare const
|
|
37
|
+
declare const useGetProjectsSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getProjects>>, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
|
|
38
38
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>>;
|
|
39
39
|
request?: SecondParameter<typeof customInstance>;
|
|
40
40
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData> & {
|
|
@@ -45,19 +45,19 @@ type GetProjectsSuspenseQueryError = ErrorType<void | DmError>;
|
|
|
45
45
|
declare function useGetProjectsSuspense<TData = Awaited<ReturnType<typeof getProjects>>, TError = ErrorType<void | DmError>>(params: undefined | GetProjectsParams, options: {
|
|
46
46
|
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>>;
|
|
47
47
|
request?: SecondParameter<typeof customInstance>;
|
|
48
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
48
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
49
49
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
50
50
|
};
|
|
51
51
|
declare function useGetProjectsSuspense<TData = Awaited<ReturnType<typeof getProjects>>, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
|
|
52
52
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>>;
|
|
53
53
|
request?: SecondParameter<typeof customInstance>;
|
|
54
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
54
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
55
55
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
56
56
|
};
|
|
57
57
|
declare function useGetProjectsSuspense<TData = Awaited<ReturnType<typeof getProjects>>, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
|
|
58
58
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjects>>, TError, TData>>;
|
|
59
59
|
request?: SecondParameter<typeof customInstance>;
|
|
60
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
60
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
61
61
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
62
62
|
};
|
|
63
63
|
/**
|
|
@@ -72,36 +72,36 @@ The name you give the Project is free-form text (can contain spaces etc.) but th
|
|
|
72
72
|
* @summary Create a new Project
|
|
73
73
|
*/
|
|
74
74
|
declare const createProject: (projectPostBodyBody: ProjectPostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ProjectPostResponse>;
|
|
75
|
-
declare const
|
|
76
|
-
mutation?: UseMutationOptions<
|
|
75
|
+
declare const useCreateProjectMutationOptions: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
76
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createProject>>, TError, {
|
|
77
77
|
data: ProjectPostBodyBody;
|
|
78
78
|
}, TContext>;
|
|
79
79
|
request?: SecondParameter<typeof customInstance>;
|
|
80
|
-
}) => UseMutationOptions<
|
|
80
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof createProject>>, TError, {
|
|
81
81
|
data: ProjectPostBodyBody;
|
|
82
82
|
}, TContext>;
|
|
83
83
|
type CreateProjectMutationResult = NonNullable<Awaited<ReturnType<typeof createProject>>>;
|
|
84
84
|
type CreateProjectMutationBody = ProjectPostBodyBody;
|
|
85
85
|
type CreateProjectMutationError = ErrorType<DmError | void>;
|
|
86
86
|
/**
|
|
87
|
-
* @summary Create a new Project
|
|
88
|
-
*/
|
|
89
|
-
declare const useCreateProject: <
|
|
90
|
-
mutation?: UseMutationOptions<
|
|
87
|
+
* @summary Create a new Project
|
|
88
|
+
*/
|
|
89
|
+
declare const useCreateProject: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
90
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createProject>>, TError, {
|
|
91
91
|
data: ProjectPostBodyBody;
|
|
92
92
|
}, TContext>;
|
|
93
93
|
request?: SecondParameter<typeof customInstance>;
|
|
94
|
-
}) => UseMutationResult<
|
|
94
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createProject>>, TError, {
|
|
95
95
|
data: ProjectPostBodyBody;
|
|
96
96
|
}, TContext>;
|
|
97
97
|
/**
|
|
98
|
-
* Gets the details of a Project that is available to you.
|
|
98
|
+
* Gets the details of a Project that is available to you.
|
|
99
99
|
|
|
100
|
-
* @summary Get a Project
|
|
101
|
-
*/
|
|
100
|
+
* @summary Get a Project
|
|
101
|
+
*/
|
|
102
102
|
declare const getProject: (projectId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ProjectDetail>;
|
|
103
|
-
declare const getGetProjectQueryKey: (projectId: string) => readonly [
|
|
104
|
-
declare const
|
|
103
|
+
declare const getGetProjectQueryKey: (projectId: string) => readonly [`/project/${string}`];
|
|
104
|
+
declare const useGetProjectQueryOptions: <TData = Awaited<ReturnType<typeof getProject>>, TError = ErrorType<void | DmError>>(projectId: string, options?: {
|
|
105
105
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>>;
|
|
106
106
|
request?: SecondParameter<typeof customInstance>;
|
|
107
107
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData> & {
|
|
@@ -110,24 +110,24 @@ declare const getGetProjectQueryOptions: <TData = ProjectDetail, TError = ErrorT
|
|
|
110
110
|
type GetProjectQueryResult = NonNullable<Awaited<ReturnType<typeof getProject>>>;
|
|
111
111
|
type GetProjectQueryError = ErrorType<void | DmError>;
|
|
112
112
|
declare function useGetProject<TData = Awaited<ReturnType<typeof getProject>>, TError = ErrorType<void | DmError>>(projectId: string, options: {
|
|
113
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProject>>, TError,
|
|
113
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProject>>, TError, Awaited<ReturnType<typeof getProject>>>, "initialData">;
|
|
114
114
|
request?: SecondParameter<typeof customInstance>;
|
|
115
|
-
}): DefinedUseQueryResult<TData, TError> & {
|
|
115
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
116
116
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
117
117
|
};
|
|
118
118
|
declare function useGetProject<TData = Awaited<ReturnType<typeof getProject>>, TError = ErrorType<void | DmError>>(projectId: string, options?: {
|
|
119
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProject>>, TError,
|
|
119
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProject>>, TError, Awaited<ReturnType<typeof getProject>>>, "initialData">;
|
|
120
120
|
request?: SecondParameter<typeof customInstance>;
|
|
121
|
-
}): UseQueryResult<TData, TError> & {
|
|
121
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
122
122
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
123
123
|
};
|
|
124
124
|
declare function useGetProject<TData = Awaited<ReturnType<typeof getProject>>, TError = ErrorType<void | DmError>>(projectId: string, options?: {
|
|
125
125
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>>;
|
|
126
126
|
request?: SecondParameter<typeof customInstance>;
|
|
127
|
-
}): UseQueryResult<TData, TError> & {
|
|
127
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
128
128
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
129
129
|
};
|
|
130
|
-
declare const
|
|
130
|
+
declare const useGetProjectSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getProject>>, TError = ErrorType<void | DmError>>(projectId: string, options?: {
|
|
131
131
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>>;
|
|
132
132
|
request?: SecondParameter<typeof customInstance>;
|
|
133
133
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData> & {
|
|
@@ -138,19 +138,19 @@ type GetProjectSuspenseQueryError = ErrorType<void | DmError>;
|
|
|
138
138
|
declare function useGetProjectSuspense<TData = Awaited<ReturnType<typeof getProject>>, TError = ErrorType<void | DmError>>(projectId: string, options: {
|
|
139
139
|
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>>;
|
|
140
140
|
request?: SecondParameter<typeof customInstance>;
|
|
141
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
141
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
142
142
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
143
143
|
};
|
|
144
144
|
declare function useGetProjectSuspense<TData = Awaited<ReturnType<typeof getProject>>, TError = ErrorType<void | DmError>>(projectId: string, options?: {
|
|
145
145
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>>;
|
|
146
146
|
request?: SecondParameter<typeof customInstance>;
|
|
147
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
147
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
148
148
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
149
149
|
};
|
|
150
150
|
declare function useGetProjectSuspense<TData = Awaited<ReturnType<typeof getProject>>, TError = ErrorType<void | DmError>>(projectId: string, options?: {
|
|
151
151
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProject>>, TError, TData>>;
|
|
152
152
|
request?: SecondParameter<typeof customInstance>;
|
|
153
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
153
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
154
154
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
155
155
|
};
|
|
156
156
|
/**
|
|
@@ -159,13 +159,13 @@ declare function useGetProjectSuspense<TData = Awaited<ReturnType<typeof getProj
|
|
|
159
159
|
* @summary Adjust an existing Project
|
|
160
160
|
*/
|
|
161
161
|
declare const patchProject: (projectId: string, projectPatchBodyBody: ProjectPatchBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
162
|
-
declare const
|
|
163
|
-
mutation?: UseMutationOptions<
|
|
162
|
+
declare const usePatchProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
163
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof patchProject>>, TError, {
|
|
164
164
|
projectId: string;
|
|
165
165
|
data: ProjectPatchBodyBody;
|
|
166
166
|
}, TContext>;
|
|
167
167
|
request?: SecondParameter<typeof customInstance>;
|
|
168
|
-
}) => UseMutationOptions<
|
|
168
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof patchProject>>, TError, {
|
|
169
169
|
projectId: string;
|
|
170
170
|
data: ProjectPatchBodyBody;
|
|
171
171
|
}, TContext>;
|
|
@@ -173,265 +173,265 @@ type PatchProjectMutationResult = NonNullable<Awaited<ReturnType<typeof patchPro
|
|
|
173
173
|
type PatchProjectMutationBody = ProjectPatchBodyBody;
|
|
174
174
|
type PatchProjectMutationError = ErrorType<void | DmError>;
|
|
175
175
|
/**
|
|
176
|
-
* @summary Adjust an existing Project
|
|
177
|
-
*/
|
|
178
|
-
declare const usePatchProject: <
|
|
179
|
-
mutation?: UseMutationOptions<
|
|
176
|
+
* @summary Adjust an existing Project
|
|
177
|
+
*/
|
|
178
|
+
declare const usePatchProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
179
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof patchProject>>, TError, {
|
|
180
180
|
projectId: string;
|
|
181
181
|
data: ProjectPatchBodyBody;
|
|
182
182
|
}, TContext>;
|
|
183
183
|
request?: SecondParameter<typeof customInstance>;
|
|
184
|
-
}) => UseMutationResult<
|
|
184
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof patchProject>>, TError, {
|
|
185
185
|
projectId: string;
|
|
186
186
|
data: ProjectPatchBodyBody;
|
|
187
187
|
}, TContext>;
|
|
188
188
|
/**
|
|
189
|
-
* Deletes an existing Project.
|
|
189
|
+
* Deletes an existing Project.
|
|
190
190
|
|
|
191
191
|
You must be an `administrator` of the project.
|
|
192
192
|
|
|
193
193
|
Once deleted all **Files**, working directories and material in the Project will also be removed
|
|
194
194
|
|
|
195
|
-
* @summary Delete a Project
|
|
196
|
-
*/
|
|
195
|
+
* @summary Delete a Project
|
|
196
|
+
*/
|
|
197
197
|
declare const deleteProject: (projectId: string, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
|
|
198
|
-
declare const
|
|
199
|
-
mutation?: UseMutationOptions<
|
|
198
|
+
declare const useDeleteProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
199
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteProject>>, TError, {
|
|
200
200
|
projectId: string;
|
|
201
201
|
}, TContext>;
|
|
202
202
|
request?: SecondParameter<typeof customInstance>;
|
|
203
|
-
}) => UseMutationOptions<
|
|
203
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteProject>>, TError, {
|
|
204
204
|
projectId: string;
|
|
205
205
|
}, TContext>;
|
|
206
206
|
type DeleteProjectMutationResult = NonNullable<Awaited<ReturnType<typeof deleteProject>>>;
|
|
207
207
|
type DeleteProjectMutationError = ErrorType<void | DmError>;
|
|
208
208
|
/**
|
|
209
|
-
* @summary Delete a Project
|
|
210
|
-
*/
|
|
211
|
-
declare const useDeleteProject: <
|
|
212
|
-
mutation?: UseMutationOptions<
|
|
209
|
+
* @summary Delete a Project
|
|
210
|
+
*/
|
|
211
|
+
declare const useDeleteProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
212
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteProject>>, TError, {
|
|
213
213
|
projectId: string;
|
|
214
214
|
}, TContext>;
|
|
215
215
|
request?: SecondParameter<typeof customInstance>;
|
|
216
|
-
}) => UseMutationResult<
|
|
216
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteProject>>, TError, {
|
|
217
217
|
projectId: string;
|
|
218
218
|
}, TContext>;
|
|
219
219
|
/**
|
|
220
|
-
* Adds a user to a Project as an `administrator`. As well as the ability to edit the project administrators can add and remove other users.
|
|
220
|
+
* Adds a user to a Project as an `administrator`. As well as the ability to edit the project administrators can add and remove other users.
|
|
221
221
|
|
|
222
222
|
You must be an `administrator` of the project
|
|
223
223
|
|
|
224
|
-
* @summary Add a Project Administrator
|
|
225
|
-
*/
|
|
224
|
+
* @summary Add a Project Administrator
|
|
225
|
+
*/
|
|
226
226
|
declare const addAdministratorToProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
227
|
-
declare const
|
|
228
|
-
mutation?: UseMutationOptions<
|
|
227
|
+
declare const useAddAdministratorToProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
228
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addAdministratorToProject>>, TError, {
|
|
229
229
|
projectId: string;
|
|
230
230
|
userId: string;
|
|
231
231
|
}, TContext>;
|
|
232
232
|
request?: SecondParameter<typeof customInstance>;
|
|
233
|
-
}) => UseMutationOptions<
|
|
233
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof addAdministratorToProject>>, TError, {
|
|
234
234
|
projectId: string;
|
|
235
235
|
userId: string;
|
|
236
236
|
}, TContext>;
|
|
237
237
|
type AddAdministratorToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addAdministratorToProject>>>;
|
|
238
238
|
type AddAdministratorToProjectMutationError = ErrorType<void | DmError>;
|
|
239
239
|
/**
|
|
240
|
-
* @summary Add a Project Administrator
|
|
241
|
-
*/
|
|
242
|
-
declare const useAddAdministratorToProject: <
|
|
243
|
-
mutation?: UseMutationOptions<
|
|
240
|
+
* @summary Add a Project Administrator
|
|
241
|
+
*/
|
|
242
|
+
declare const useAddAdministratorToProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
243
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addAdministratorToProject>>, TError, {
|
|
244
244
|
projectId: string;
|
|
245
245
|
userId: string;
|
|
246
246
|
}, TContext>;
|
|
247
247
|
request?: SecondParameter<typeof customInstance>;
|
|
248
|
-
}) => UseMutationResult<
|
|
248
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof addAdministratorToProject>>, TError, {
|
|
249
249
|
projectId: string;
|
|
250
250
|
userId: string;
|
|
251
251
|
}, TContext>;
|
|
252
252
|
/**
|
|
253
|
-
* Deletes a project `administrator`. The administrator can be you.
|
|
253
|
+
* Deletes a project `administrator`. The administrator can be you.
|
|
254
254
|
|
|
255
255
|
A project must always have one `administrator` so you will not be able to delete the last administrator of a project.
|
|
256
256
|
|
|
257
257
|
You must be an `administrator` of the project
|
|
258
258
|
|
|
259
|
-
* @summary Delete a Project Administrator
|
|
260
|
-
*/
|
|
259
|
+
* @summary Delete a Project Administrator
|
|
260
|
+
*/
|
|
261
261
|
declare const removeAdministratorFromProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
262
|
-
declare const
|
|
263
|
-
mutation?: UseMutationOptions<
|
|
262
|
+
declare const useRemoveAdministratorFromProjectMutationOptions: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
263
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeAdministratorFromProject>>, TError, {
|
|
264
264
|
projectId: string;
|
|
265
265
|
userId: string;
|
|
266
266
|
}, TContext>;
|
|
267
267
|
request?: SecondParameter<typeof customInstance>;
|
|
268
|
-
}) => UseMutationOptions<
|
|
268
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof removeAdministratorFromProject>>, TError, {
|
|
269
269
|
projectId: string;
|
|
270
270
|
userId: string;
|
|
271
271
|
}, TContext>;
|
|
272
272
|
type RemoveAdministratorFromProjectMutationResult = NonNullable<Awaited<ReturnType<typeof removeAdministratorFromProject>>>;
|
|
273
273
|
type RemoveAdministratorFromProjectMutationError = ErrorType<DmError | void>;
|
|
274
274
|
/**
|
|
275
|
-
* @summary Delete a Project Administrator
|
|
276
|
-
*/
|
|
277
|
-
declare const useRemoveAdministratorFromProject: <
|
|
278
|
-
mutation?: UseMutationOptions<
|
|
275
|
+
* @summary Delete a Project Administrator
|
|
276
|
+
*/
|
|
277
|
+
declare const useRemoveAdministratorFromProject: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
278
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeAdministratorFromProject>>, TError, {
|
|
279
279
|
projectId: string;
|
|
280
280
|
userId: string;
|
|
281
281
|
}, TContext>;
|
|
282
282
|
request?: SecondParameter<typeof customInstance>;
|
|
283
|
-
}) => UseMutationResult<
|
|
283
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof removeAdministratorFromProject>>, TError, {
|
|
284
284
|
projectId: string;
|
|
285
285
|
userId: string;
|
|
286
286
|
}, TContext>;
|
|
287
287
|
/**
|
|
288
|
-
* Adds a user to a Project as an `editor`. Editors can add and remove datasets in a project and delete the project.
|
|
288
|
+
* Adds a user to a Project as an `editor`. Editors can add and remove datasets in a project and delete the project.
|
|
289
289
|
|
|
290
290
|
An `editor` of a project is not automatically an `editor` of any datasets the project contains.
|
|
291
291
|
|
|
292
292
|
You must be an `administrator` of the project
|
|
293
293
|
|
|
294
|
-
* @summary Add a Project Editor
|
|
295
|
-
*/
|
|
294
|
+
* @summary Add a Project Editor
|
|
295
|
+
*/
|
|
296
296
|
declare const addEditorToProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
297
|
-
declare const
|
|
298
|
-
mutation?: UseMutationOptions<
|
|
297
|
+
declare const useAddEditorToProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
298
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addEditorToProject>>, TError, {
|
|
299
299
|
projectId: string;
|
|
300
300
|
userId: string;
|
|
301
301
|
}, TContext>;
|
|
302
302
|
request?: SecondParameter<typeof customInstance>;
|
|
303
|
-
}) => UseMutationOptions<
|
|
303
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof addEditorToProject>>, TError, {
|
|
304
304
|
projectId: string;
|
|
305
305
|
userId: string;
|
|
306
306
|
}, TContext>;
|
|
307
307
|
type AddEditorToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addEditorToProject>>>;
|
|
308
308
|
type AddEditorToProjectMutationError = ErrorType<void | DmError>;
|
|
309
309
|
/**
|
|
310
|
-
* @summary Add a Project Editor
|
|
311
|
-
*/
|
|
312
|
-
declare const useAddEditorToProject: <
|
|
313
|
-
mutation?: UseMutationOptions<
|
|
310
|
+
* @summary Add a Project Editor
|
|
311
|
+
*/
|
|
312
|
+
declare const useAddEditorToProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
313
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addEditorToProject>>, TError, {
|
|
314
314
|
projectId: string;
|
|
315
315
|
userId: string;
|
|
316
316
|
}, TContext>;
|
|
317
317
|
request?: SecondParameter<typeof customInstance>;
|
|
318
|
-
}) => UseMutationResult<
|
|
318
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof addEditorToProject>>, TError, {
|
|
319
319
|
projectId: string;
|
|
320
320
|
userId: string;
|
|
321
321
|
}, TContext>;
|
|
322
322
|
/**
|
|
323
|
-
* Deletes a project `editor`. The editor can be you.
|
|
323
|
+
* Deletes a project `editor`. The editor can be you.
|
|
324
324
|
|
|
325
325
|
A project must always have one `editor` so you will not be able to delete the last editor of a project.
|
|
326
326
|
|
|
327
327
|
You must be an `administrator` of the project
|
|
328
328
|
|
|
329
|
-
* @summary Delete a Project Editor
|
|
330
|
-
*/
|
|
329
|
+
* @summary Delete a Project Editor
|
|
330
|
+
*/
|
|
331
331
|
declare const removeEditorFromProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
332
|
-
declare const
|
|
333
|
-
mutation?: UseMutationOptions<
|
|
332
|
+
declare const useRemoveEditorFromProjectMutationOptions: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
333
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromProject>>, TError, {
|
|
334
334
|
projectId: string;
|
|
335
335
|
userId: string;
|
|
336
336
|
}, TContext>;
|
|
337
337
|
request?: SecondParameter<typeof customInstance>;
|
|
338
|
-
}) => UseMutationOptions<
|
|
338
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromProject>>, TError, {
|
|
339
339
|
projectId: string;
|
|
340
340
|
userId: string;
|
|
341
341
|
}, TContext>;
|
|
342
342
|
type RemoveEditorFromProjectMutationResult = NonNullable<Awaited<ReturnType<typeof removeEditorFromProject>>>;
|
|
343
343
|
type RemoveEditorFromProjectMutationError = ErrorType<DmError | void>;
|
|
344
344
|
/**
|
|
345
|
-
* @summary Delete a Project Editor
|
|
346
|
-
*/
|
|
347
|
-
declare const useRemoveEditorFromProject: <
|
|
348
|
-
mutation?: UseMutationOptions<
|
|
345
|
+
* @summary Delete a Project Editor
|
|
346
|
+
*/
|
|
347
|
+
declare const useRemoveEditorFromProject: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
348
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeEditorFromProject>>, TError, {
|
|
349
349
|
projectId: string;
|
|
350
350
|
userId: string;
|
|
351
351
|
}, TContext>;
|
|
352
352
|
request?: SecondParameter<typeof customInstance>;
|
|
353
|
-
}) => UseMutationResult<
|
|
353
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof removeEditorFromProject>>, TError, {
|
|
354
354
|
projectId: string;
|
|
355
355
|
userId: string;
|
|
356
356
|
}, TContext>;
|
|
357
357
|
/**
|
|
358
|
-
* Adds a user to a project as an `observer`. Observers can view Projects and download files but they cannot modify Project data or run **Applications** or **Jobs**.
|
|
358
|
+
* Adds a user to a project as an `observer`. Observers can view Projects and download files but they cannot modify Project data or run **Applications** or **Jobs**.
|
|
359
359
|
|
|
360
360
|
You must be an `administrator` of the Project to add Observers
|
|
361
361
|
|
|
362
|
-
* @summary Add a Project Observer
|
|
363
|
-
*/
|
|
362
|
+
* @summary Add a Project Observer
|
|
363
|
+
*/
|
|
364
364
|
declare const addObserverToProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
365
|
-
declare const
|
|
366
|
-
mutation?: UseMutationOptions<
|
|
365
|
+
declare const useAddObserverToProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
366
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addObserverToProject>>, TError, {
|
|
367
367
|
projectId: string;
|
|
368
368
|
userId: string;
|
|
369
369
|
}, TContext>;
|
|
370
370
|
request?: SecondParameter<typeof customInstance>;
|
|
371
|
-
}) => UseMutationOptions<
|
|
371
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof addObserverToProject>>, TError, {
|
|
372
372
|
projectId: string;
|
|
373
373
|
userId: string;
|
|
374
374
|
}, TContext>;
|
|
375
375
|
type AddObserverToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addObserverToProject>>>;
|
|
376
376
|
type AddObserverToProjectMutationError = ErrorType<void | DmError>;
|
|
377
377
|
/**
|
|
378
|
-
* @summary Add a Project Observer
|
|
379
|
-
*/
|
|
380
|
-
declare const useAddObserverToProject: <
|
|
381
|
-
mutation?: UseMutationOptions<
|
|
378
|
+
* @summary Add a Project Observer
|
|
379
|
+
*/
|
|
380
|
+
declare const useAddObserverToProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
381
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addObserverToProject>>, TError, {
|
|
382
382
|
projectId: string;
|
|
383
383
|
userId: string;
|
|
384
384
|
}, TContext>;
|
|
385
385
|
request?: SecondParameter<typeof customInstance>;
|
|
386
|
-
}) => UseMutationResult<
|
|
386
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof addObserverToProject>>, TError, {
|
|
387
387
|
projectId: string;
|
|
388
388
|
userId: string;
|
|
389
389
|
}, TContext>;
|
|
390
390
|
/**
|
|
391
|
-
* Deletes a project `observer`.
|
|
391
|
+
* Deletes a project `observer`.
|
|
392
392
|
|
|
393
393
|
You must be an `administrator` of the Project to remove Observers
|
|
394
394
|
|
|
395
|
-
* @summary Delete a Project Observer
|
|
396
|
-
*/
|
|
395
|
+
* @summary Delete a Project Observer
|
|
396
|
+
*/
|
|
397
397
|
declare const removeObserverFromProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
398
|
-
declare const
|
|
399
|
-
mutation?: UseMutationOptions<
|
|
398
|
+
declare const useRemoveObserverFromProjectMutationOptions: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
399
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeObserverFromProject>>, TError, {
|
|
400
400
|
projectId: string;
|
|
401
401
|
userId: string;
|
|
402
402
|
}, TContext>;
|
|
403
403
|
request?: SecondParameter<typeof customInstance>;
|
|
404
|
-
}) => UseMutationOptions<
|
|
404
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof removeObserverFromProject>>, TError, {
|
|
405
405
|
projectId: string;
|
|
406
406
|
userId: string;
|
|
407
407
|
}, TContext>;
|
|
408
408
|
type RemoveObserverFromProjectMutationResult = NonNullable<Awaited<ReturnType<typeof removeObserverFromProject>>>;
|
|
409
409
|
type RemoveObserverFromProjectMutationError = ErrorType<DmError | void>;
|
|
410
410
|
/**
|
|
411
|
-
* @summary Delete a Project Observer
|
|
412
|
-
*/
|
|
413
|
-
declare const useRemoveObserverFromProject: <
|
|
414
|
-
mutation?: UseMutationOptions<
|
|
411
|
+
* @summary Delete a Project Observer
|
|
412
|
+
*/
|
|
413
|
+
declare const useRemoveObserverFromProject: <TError = ErrorType<DmError | void>, TContext = unknown>(options?: {
|
|
414
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof removeObserverFromProject>>, TError, {
|
|
415
415
|
projectId: string;
|
|
416
416
|
userId: string;
|
|
417
417
|
}, TContext>;
|
|
418
418
|
request?: SecondParameter<typeof customInstance>;
|
|
419
|
-
}) => UseMutationResult<
|
|
419
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof removeObserverFromProject>>, TError, {
|
|
420
420
|
projectId: string;
|
|
421
421
|
userId: string;
|
|
422
422
|
}, TContext>;
|
|
423
423
|
/**
|
|
424
|
-
* Gets a file from the project, with an optional path. This method should be used to get arbitrary files from the Project's file system (typically **unmanaged** files).
|
|
424
|
+
* Gets a file from the project, with an optional path. This method should be used to get arbitrary files from the Project's file system (typically **unmanaged** files).
|
|
425
425
|
|
|
426
426
|
For **managed** files you should consider using the `/file/{file_id}` endpoint.
|
|
427
427
|
|
|
428
428
|
You must be an `editor` of the Project if the Project is `private`
|
|
429
429
|
|
|
430
|
-
* @summary Download a Project file
|
|
431
|
-
*/
|
|
430
|
+
* @summary Download a Project file
|
|
431
|
+
*/
|
|
432
432
|
declare const getProjectFile: (projectId: string, params: GetProjectFileParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
|
|
433
|
-
declare const getGetProjectFileQueryKey: (projectId: string, params: GetProjectFileParams) => readonly [
|
|
434
|
-
declare const
|
|
433
|
+
declare const getGetProjectFileQueryKey: (projectId: string, params: GetProjectFileParams) => readonly [`/project/${string}/file`, ...GetProjectFileParams[]];
|
|
434
|
+
declare const useGetProjectFileQueryOptions: <TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
|
|
435
435
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
|
|
436
436
|
request?: SecondParameter<typeof customInstance>;
|
|
437
437
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData> & {
|
|
@@ -440,24 +440,24 @@ declare const getGetProjectFileQueryOptions: <TData = void, TError = ErrorType<v
|
|
|
440
440
|
type GetProjectFileQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFile>>>;
|
|
441
441
|
type GetProjectFileQueryError = ErrorType<void | DmError>;
|
|
442
442
|
declare function useGetProjectFile<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options: {
|
|
443
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFile>>, TError,
|
|
443
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, Awaited<ReturnType<typeof getProjectFile>>>, "initialData">;
|
|
444
444
|
request?: SecondParameter<typeof customInstance>;
|
|
445
|
-
}): DefinedUseQueryResult<TData, TError> & {
|
|
445
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
446
446
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
447
447
|
};
|
|
448
448
|
declare function useGetProjectFile<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
|
|
449
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFile>>, TError,
|
|
449
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, Awaited<ReturnType<typeof getProjectFile>>>, "initialData">;
|
|
450
450
|
request?: SecondParameter<typeof customInstance>;
|
|
451
|
-
}): UseQueryResult<TData, TError> & {
|
|
451
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
452
452
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
453
453
|
};
|
|
454
454
|
declare function useGetProjectFile<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
|
|
455
455
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
|
|
456
456
|
request?: SecondParameter<typeof customInstance>;
|
|
457
|
-
}): UseQueryResult<TData, TError> & {
|
|
457
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
458
458
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
459
459
|
};
|
|
460
|
-
declare const
|
|
460
|
+
declare const useGetProjectFileSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
|
|
461
461
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
|
|
462
462
|
request?: SecondParameter<typeof customInstance>;
|
|
463
463
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData> & {
|
|
@@ -468,19 +468,19 @@ type GetProjectFileSuspenseQueryError = ErrorType<void | DmError>;
|
|
|
468
468
|
declare function useGetProjectFileSuspense<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options: {
|
|
469
469
|
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
|
|
470
470
|
request?: SecondParameter<typeof customInstance>;
|
|
471
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
471
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
472
472
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
473
473
|
};
|
|
474
474
|
declare function useGetProjectFileSuspense<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
|
|
475
475
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
|
|
476
476
|
request?: SecondParameter<typeof customInstance>;
|
|
477
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
477
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
478
478
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
479
479
|
};
|
|
480
480
|
declare function useGetProjectFileSuspense<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
|
|
481
481
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
|
|
482
482
|
request?: SecondParameter<typeof customInstance>;
|
|
483
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
483
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
484
484
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
485
485
|
};
|
|
486
486
|
/**
|
|
@@ -491,13 +491,13 @@ You must be an `editor` of the project
|
|
|
491
491
|
* @summary Upload a file into a Project
|
|
492
492
|
*/
|
|
493
493
|
declare const addFileToProject: (projectId: string, projectFilePutBodyBody: ProjectFilePutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
|
|
494
|
-
declare const
|
|
495
|
-
mutation?: UseMutationOptions<
|
|
494
|
+
declare const useAddFileToProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
495
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addFileToProject>>, TError, {
|
|
496
496
|
projectId: string;
|
|
497
497
|
data: ProjectFilePutBodyBody;
|
|
498
498
|
}, TContext>;
|
|
499
499
|
request?: SecondParameter<typeof customInstance>;
|
|
500
|
-
}) => UseMutationOptions<
|
|
500
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof addFileToProject>>, TError, {
|
|
501
501
|
projectId: string;
|
|
502
502
|
data: ProjectFilePutBodyBody;
|
|
503
503
|
}, TContext>;
|
|
@@ -505,30 +505,30 @@ type AddFileToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addF
|
|
|
505
505
|
type AddFileToProjectMutationBody = ProjectFilePutBodyBody;
|
|
506
506
|
type AddFileToProjectMutationError = ErrorType<void | DmError>;
|
|
507
507
|
/**
|
|
508
|
-
* @summary Upload a file into a Project
|
|
509
|
-
*/
|
|
510
|
-
declare const useAddFileToProject: <
|
|
511
|
-
mutation?: UseMutationOptions<
|
|
508
|
+
* @summary Upload a file into a Project
|
|
509
|
+
*/
|
|
510
|
+
declare const useAddFileToProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
|
|
511
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof addFileToProject>>, TError, {
|
|
512
512
|
projectId: string;
|
|
513
513
|
data: ProjectFilePutBodyBody;
|
|
514
514
|
}, TContext>;
|
|
515
515
|
request?: SecondParameter<typeof customInstance>;
|
|
516
|
-
}) => UseMutationResult<
|
|
516
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof addFileToProject>>, TError, {
|
|
517
517
|
projectId: string;
|
|
518
518
|
data: ProjectFilePutBodyBody;
|
|
519
519
|
}, TContext>;
|
|
520
520
|
/**
|
|
521
|
-
* Gets a file from the project, with an optional path. This method should be used to get arbitrary files from the Project's file system (typically **unmanaged** files).
|
|
521
|
+
* Gets a file from the project, with an optional path. This method should be used to get arbitrary files from the Project's file system (typically **unmanaged** files).
|
|
522
522
|
|
|
523
523
|
For **managed** files you should consider using the `/file/{file_id}` endpoint.
|
|
524
524
|
|
|
525
525
|
As there is no authentication for this endpoint you must provide a valid token. The token must be a token valid for the project, usually generated when an **Instance** has been launched in the Project.
|
|
526
526
|
|
|
527
|
-
* @summary Download a Project file using a Token
|
|
528
|
-
*/
|
|
527
|
+
* @summary Download a Project file using a Token
|
|
528
|
+
*/
|
|
529
529
|
declare const getProjectFileWithToken: (projectId: string, params: GetProjectFileWithTokenParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
|
|
530
|
-
declare const getGetProjectFileWithTokenQueryKey: (projectId: string, params: GetProjectFileWithTokenParams) => readonly [
|
|
531
|
-
declare const
|
|
530
|
+
declare const getGetProjectFileWithTokenQueryKey: (projectId: string, params: GetProjectFileWithTokenParams) => readonly [`/project/${string}/file-with-token`, ...GetProjectFileWithTokenParams[]];
|
|
531
|
+
declare const useGetProjectFileWithTokenQueryOptions: <TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
|
|
532
532
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
|
|
533
533
|
request?: SecondParameter<typeof customInstance>;
|
|
534
534
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData> & {
|
|
@@ -537,24 +537,24 @@ declare const getGetProjectFileWithTokenQueryOptions: <TData = void, TError = Er
|
|
|
537
537
|
type GetProjectFileWithTokenQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFileWithToken>>>;
|
|
538
538
|
type GetProjectFileWithTokenQueryError = ErrorType<DmError>;
|
|
539
539
|
declare function useGetProjectFileWithToken<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options: {
|
|
540
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError,
|
|
540
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, Awaited<ReturnType<typeof getProjectFileWithToken>>>, "initialData">;
|
|
541
541
|
request?: SecondParameter<typeof customInstance>;
|
|
542
|
-
}): DefinedUseQueryResult<TData, TError> & {
|
|
542
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
543
543
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
544
544
|
};
|
|
545
545
|
declare function useGetProjectFileWithToken<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
|
|
546
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError,
|
|
546
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, Awaited<ReturnType<typeof getProjectFileWithToken>>>, "initialData">;
|
|
547
547
|
request?: SecondParameter<typeof customInstance>;
|
|
548
|
-
}): UseQueryResult<TData, TError> & {
|
|
548
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
549
549
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
550
550
|
};
|
|
551
551
|
declare function useGetProjectFileWithToken<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
|
|
552
552
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
|
|
553
553
|
request?: SecondParameter<typeof customInstance>;
|
|
554
|
-
}): UseQueryResult<TData, TError> & {
|
|
554
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
555
555
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
556
556
|
};
|
|
557
|
-
declare const
|
|
557
|
+
declare const useGetProjectFileWithTokenSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
|
|
558
558
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
|
|
559
559
|
request?: SecondParameter<typeof customInstance>;
|
|
560
560
|
}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData> & {
|
|
@@ -565,20 +565,20 @@ type GetProjectFileWithTokenSuspenseQueryError = ErrorType<DmError>;
|
|
|
565
565
|
declare function useGetProjectFileWithTokenSuspense<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options: {
|
|
566
566
|
query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
|
|
567
567
|
request?: SecondParameter<typeof customInstance>;
|
|
568
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
568
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
569
569
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
570
570
|
};
|
|
571
571
|
declare function useGetProjectFileWithTokenSuspense<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
|
|
572
572
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
|
|
573
573
|
request?: SecondParameter<typeof customInstance>;
|
|
574
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
574
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
575
575
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
576
576
|
};
|
|
577
577
|
declare function useGetProjectFileWithTokenSuspense<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
|
|
578
578
|
query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
|
|
579
579
|
request?: SecondParameter<typeof customInstance>;
|
|
580
|
-
}): UseSuspenseQueryResult<TData, TError> & {
|
|
580
|
+
}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
|
|
581
581
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
582
582
|
};
|
|
583
583
|
|
|
584
|
-
export { type AddAdministratorToProjectMutationError, type AddAdministratorToProjectMutationResult, type AddEditorToProjectMutationError, type AddEditorToProjectMutationResult, type AddFileToProjectMutationBody, type AddFileToProjectMutationError, type AddFileToProjectMutationResult, type AddObserverToProjectMutationError, type AddObserverToProjectMutationResult, type CreateProjectMutationBody, type CreateProjectMutationError, type CreateProjectMutationResult, type DeleteProjectMutationError, type DeleteProjectMutationResult, type GetProjectFileQueryError, type GetProjectFileQueryResult, type GetProjectFileSuspenseQueryError, type GetProjectFileSuspenseQueryResult, type GetProjectFileWithTokenQueryError, type GetProjectFileWithTokenQueryResult, type GetProjectFileWithTokenSuspenseQueryError, type GetProjectFileWithTokenSuspenseQueryResult, type GetProjectQueryError, type GetProjectQueryResult, type GetProjectSuspenseQueryError, type GetProjectSuspenseQueryResult, type GetProjectsQueryError, type GetProjectsQueryResult, type GetProjectsSuspenseQueryError, type GetProjectsSuspenseQueryResult, type PatchProjectMutationBody, type PatchProjectMutationError, type PatchProjectMutationResult, type RemoveAdministratorFromProjectMutationError, type RemoveAdministratorFromProjectMutationResult, type RemoveEditorFromProjectMutationError, type RemoveEditorFromProjectMutationResult, type RemoveObserverFromProjectMutationError, type RemoveObserverFromProjectMutationResult, addAdministratorToProject, addEditorToProject, addFileToProject, addObserverToProject, createProject, deleteProject,
|
|
584
|
+
export { type AddAdministratorToProjectMutationError, type AddAdministratorToProjectMutationResult, type AddEditorToProjectMutationError, type AddEditorToProjectMutationResult, type AddFileToProjectMutationBody, type AddFileToProjectMutationError, type AddFileToProjectMutationResult, type AddObserverToProjectMutationError, type AddObserverToProjectMutationResult, type CreateProjectMutationBody, type CreateProjectMutationError, type CreateProjectMutationResult, type DeleteProjectMutationError, type DeleteProjectMutationResult, type GetProjectFileQueryError, type GetProjectFileQueryResult, type GetProjectFileSuspenseQueryError, type GetProjectFileSuspenseQueryResult, type GetProjectFileWithTokenQueryError, type GetProjectFileWithTokenQueryResult, type GetProjectFileWithTokenSuspenseQueryError, type GetProjectFileWithTokenSuspenseQueryResult, type GetProjectQueryError, type GetProjectQueryResult, type GetProjectSuspenseQueryError, type GetProjectSuspenseQueryResult, type GetProjectsQueryError, type GetProjectsQueryResult, type GetProjectsSuspenseQueryError, type GetProjectsSuspenseQueryResult, type PatchProjectMutationBody, type PatchProjectMutationError, type PatchProjectMutationResult, type RemoveAdministratorFromProjectMutationError, type RemoveAdministratorFromProjectMutationResult, type RemoveEditorFromProjectMutationError, type RemoveEditorFromProjectMutationResult, type RemoveObserverFromProjectMutationError, type RemoveObserverFromProjectMutationResult, addAdministratorToProject, addEditorToProject, addFileToProject, addObserverToProject, createProject, deleteProject, getGetProjectFileQueryKey, getGetProjectFileWithTokenQueryKey, getGetProjectQueryKey, getGetProjectsQueryKey, getProject, getProjectFile, getProjectFileWithToken, getProjects, patchProject, removeAdministratorFromProject, removeEditorFromProject, removeObserverFromProject, useAddAdministratorToProject, useAddAdministratorToProjectMutationOptions, useAddEditorToProject, useAddEditorToProjectMutationOptions, useAddFileToProject, useAddFileToProjectMutationOptions, useAddObserverToProject, useAddObserverToProjectMutationOptions, useCreateProject, useCreateProjectMutationOptions, useDeleteProject, useDeleteProjectMutationOptions, useGetProject, useGetProjectFile, useGetProjectFileQueryOptions, useGetProjectFileSuspense, useGetProjectFileSuspenseQueryOptions, useGetProjectFileWithToken, useGetProjectFileWithTokenQueryOptions, useGetProjectFileWithTokenSuspense, useGetProjectFileWithTokenSuspenseQueryOptions, useGetProjectQueryOptions, useGetProjectSuspense, useGetProjectSuspenseQueryOptions, useGetProjects, useGetProjectsQueryOptions, useGetProjectsSuspense, useGetProjectsSuspenseQueryOptions, usePatchProject, usePatchProjectMutationOptions, useRemoveAdministratorFromProject, useRemoveAdministratorFromProjectMutationOptions, useRemoveEditorFromProject, useRemoveEditorFromProjectMutationOptions, useRemoveObserverFromProject, useRemoveObserverFromProjectMutationOptions };
|