@squonk/data-manager-client 1.2.8 → 2.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. package/README.md +1 -1
  2. package/accounting/accounting.cjs +51 -8
  3. package/accounting/accounting.cjs.map +1 -1
  4. package/accounting/accounting.d.cts +61 -10
  5. package/accounting/accounting.d.ts +61 -10
  6. package/accounting/accounting.js +49 -6
  7. package/accounting/accounting.js.map +1 -1
  8. package/admin/admin.cjs +67 -24
  9. package/admin/admin.cjs.map +1 -1
  10. package/admin/admin.d.cts +75 -24
  11. package/admin/admin.d.ts +75 -24
  12. package/admin/admin.js +56 -13
  13. package/admin/admin.js.map +1 -1
  14. package/application/application.cjs +35 -6
  15. package/application/application.cjs.map +1 -1
  16. package/application/application.d.cts +42 -8
  17. package/application/application.d.ts +42 -8
  18. package/application/application.js +34 -5
  19. package/application/application.js.map +1 -1
  20. package/{chunk-UKA7G3OB.js → chunk-EBOQPVLG.js} +2 -2
  21. package/{chunk-UKA7G3OB.js.map → chunk-EBOQPVLG.js.map} +1 -1
  22. package/{chunk-J22A7LHX.cjs → chunk-TKLTUR4R.cjs} +2 -2
  23. package/chunk-TKLTUR4R.cjs.map +1 -0
  24. package/configuration/configuration.cjs +19 -4
  25. package/configuration/configuration.cjs.map +1 -1
  26. package/configuration/configuration.d.cts +23 -6
  27. package/configuration/configuration.d.ts +23 -6
  28. package/configuration/configuration.js +19 -4
  29. package/configuration/configuration.js.map +1 -1
  30. package/dataset/dataset.cjs +93 -22
  31. package/dataset/dataset.cjs.map +1 -1
  32. package/dataset/dataset.d.cts +105 -20
  33. package/dataset/dataset.d.ts +105 -20
  34. package/dataset/dataset.js +83 -12
  35. package/dataset/dataset.js.map +1 -1
  36. package/exchange-rate/exchange-rate.cjs +71 -14
  37. package/exchange-rate/exchange-rate.cjs.map +1 -1
  38. package/exchange-rate/exchange-rate.d.cts +83 -15
  39. package/exchange-rate/exchange-rate.d.ts +83 -15
  40. package/exchange-rate/exchange-rate.js +65 -8
  41. package/exchange-rate/exchange-rate.js.map +1 -1
  42. package/file-and-path/file-and-path.cjs +45 -16
  43. package/file-and-path/file-and-path.cjs.map +1 -1
  44. package/file-and-path/file-and-path.d.cts +53 -19
  45. package/file-and-path/file-and-path.d.ts +53 -19
  46. package/file-and-path/file-and-path.js +39 -10
  47. package/file-and-path/file-and-path.js.map +1 -1
  48. package/index.cjs +2 -2
  49. package/index.cjs.map +1 -1
  50. package/index.d.cts +2102 -2
  51. package/index.d.ts +2102 -2
  52. package/index.js +1 -1
  53. package/index.js.map +1 -1
  54. package/instance/instance.cjs +45 -16
  55. package/instance/instance.cjs.map +1 -1
  56. package/instance/instance.d.cts +48 -14
  57. package/instance/instance.d.ts +48 -14
  58. package/instance/instance.js +38 -9
  59. package/instance/instance.js.map +1 -1
  60. package/inventory/inventory.cjs +56 -0
  61. package/inventory/inventory.cjs.map +1 -0
  62. package/inventory/inventory.d.cts +50 -0
  63. package/inventory/inventory.d.ts +50 -0
  64. package/inventory/inventory.js +56 -0
  65. package/inventory/inventory.js.map +1 -0
  66. package/inventory/package.json +7 -0
  67. package/job/job.cjs +51 -8
  68. package/job/job.cjs.map +1 -1
  69. package/job/job.d.cts +61 -10
  70. package/job/job.d.ts +61 -10
  71. package/job/job.js +49 -6
  72. package/job/job.js.map +1 -1
  73. package/metadata/metadata.cjs +39 -10
  74. package/metadata/metadata.cjs.map +1 -1
  75. package/metadata/metadata.d.cts +45 -11
  76. package/metadata/metadata.d.ts +45 -11
  77. package/metadata/metadata.js +36 -7
  78. package/metadata/metadata.js.map +1 -1
  79. package/package.json +11 -11
  80. package/project/project.cjs +131 -26
  81. package/project/project.cjs.map +1 -1
  82. package/project/project.d.cts +166 -30
  83. package/project/project.d.ts +166 -30
  84. package/project/project.js +119 -14
  85. package/project/project.js.map +1 -1
  86. package/src/accounting/accounting.ts +137 -23
  87. package/src/admin/admin.ts +149 -51
  88. package/src/application/application.ts +94 -19
  89. package/src/configuration/configuration.ts +51 -15
  90. package/src/custom-instance.ts +3 -4
  91. package/src/data-manager-api.schemas.ts +115 -13
  92. package/src/dataset/dataset.ts +234 -46
  93. package/src/exchange-rate/exchange-rate.ts +186 -33
  94. package/src/file-and-path/file-and-path.ts +104 -39
  95. package/src/instance/instance.ts +99 -34
  96. package/src/inventory/inventory.ts +140 -0
  97. package/src/job/job.ts +139 -23
  98. package/src/metadata/metadata.ts +98 -25
  99. package/src/project/project.ts +313 -60
  100. package/src/task/task.ts +97 -22
  101. package/src/type/type.ts +51 -15
  102. package/src/user/user.ts +138 -26
  103. package/task/task.cjs +37 -8
  104. package/task/task.cjs.map +1 -1
  105. package/task/task.d.cts +44 -10
  106. package/task/task.d.ts +44 -10
  107. package/task/task.js +35 -6
  108. package/task/task.js.map +1 -1
  109. package/type/type.cjs +19 -4
  110. package/type/type.cjs.map +1 -1
  111. package/type/type.d.cts +23 -6
  112. package/type/type.d.ts +23 -6
  113. package/type/type.js +19 -4
  114. package/type/type.js.map +1 -1
  115. package/user/user.cjs +53 -10
  116. package/user/user.cjs.map +1 -1
  117. package/user/user.d.cts +63 -12
  118. package/user/user.d.ts +63 -12
  119. package/user/user.js +49 -6
  120. package/user/user.js.map +1 -1
  121. package/chunk-J22A7LHX.cjs.map +0 -1
  122. package/custom-instance-37ed2460.d.ts +0 -2014
@@ -1,16 +1,16 @@
1
- import * as _tanstack_react_query from '@tanstack/react-query';
2
- import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from '@tanstack/react-query';
3
- import { t as GetProjectsParams, bZ as customInstance, bi as ProjectsGetResponse, b_ as ErrorType, bV as DmError, a9 as ProjectPostBodyBody, bj as ProjectPostResponse, aB as ProjectDetail, aa as ProjectPatchBodyBody, av as TaskIdentity, s as GetProjectFileParams, ab as ProjectFilePutBodyBody, r as GetProjectFileWithTokenParams } from '../custom-instance-37ed2460.js';
1
+ import * as _tanstack_react_query_build_legacy_types from '@tanstack/react-query/build/legacy/types';
2
+ import { UseQueryOptions, QueryKey, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseMutationOptions } from '@tanstack/react-query';
3
+ import { GetProjectsParams, customInstance, ProjectsGetResponse, ErrorType, DmError, ProjectPostBodyBody, ProjectPostResponse, ProjectDetail, ProjectPatchBodyBody, TaskIdentity, GetProjectFileParams, ProjectFilePutBodyBody, GetProjectFileWithTokenParams } from '../index.cjs';
4
4
  import 'axios';
5
5
 
6
- type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
6
+ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
7
7
  /**
8
8
  * @summary Get all Projects available to you
9
9
  */
10
10
  declare const getProjects: (params?: GetProjectsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ProjectsGetResponse>;
11
11
  declare const getGetProjectsQueryKey: (params?: GetProjectsParams) => readonly ["data-manager-api", "/project", ...GetProjectsParams[]];
12
12
  declare const getGetProjectsQueryOptions: <TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
13
- query?: UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey> | undefined;
13
+ query?: Partial<UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey>> | undefined;
14
14
  request?: SecondParameter<typeof customInstance>;
15
15
  } | undefined) => UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey> & {
16
16
  queryKey: QueryKey;
@@ -21,19 +21,36 @@ type GetProjectsQueryError = ErrorType<void | DmError>;
21
21
  * @summary Get all Projects available to you
22
22
  */
23
23
  declare const useGetProjects: <TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
24
- query?: UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey> | undefined;
24
+ query?: Partial<UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey>> | undefined;
25
25
  request?: SecondParameter<typeof customInstance>;
26
26
  } | undefined) => UseQueryResult<TData, TError> & {
27
27
  queryKey: QueryKey;
28
28
  };
29
+ declare const getGetProjectsSuspenseQueryOptions: <TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
30
+ query?: Partial<UseSuspenseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey>> | undefined;
31
+ request?: SecondParameter<typeof customInstance>;
32
+ } | undefined) => UseSuspenseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey> & {
33
+ queryKey: QueryKey;
34
+ };
35
+ type GetProjectsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getProjects>>>;
36
+ type GetProjectsSuspenseQueryError = ErrorType<void | DmError>;
37
+ /**
38
+ * @summary Get all Projects available to you
39
+ */
40
+ declare const useGetProjectsSuspense: <TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
41
+ query?: Partial<UseSuspenseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey>> | undefined;
42
+ request?: SecondParameter<typeof customInstance>;
43
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
44
+ queryKey: QueryKey;
45
+ };
29
46
  /**
30
47
  * Creates a new Project, assigning and returning a unique **ID**. A persistent volume is created in the cluster and assigned to your Project. It's here you can add **Datasets** as **Files** and run **Applications** and **Jobs**.
31
48
 
32
49
  To create a Project when an **Account Server** is configured you will need a **Product**.
33
50
 
34
- As the Project `owner` (creator) you are also automatically an `editor` of the Project and can add other users as **Editors** so that they can also manipulate the project. An **Editor** of a project can also delete it.
51
+ As the Project creator you are also automatically an `administrator` of the Project and can add other users so that they can also see or manipulate data in the Project.
35
52
 
36
- The name you give the Project is free-form text (can contain spaces etc.) but the name you use must be unique amongst all the Projects you create.
53
+ The name you give the Project is free-form text (can contain spaces etc.) but the name you use must be unique amongst all the Projects within the same Organisational Unit.
37
54
 
38
55
  * @summary Create a new Project
39
56
  */
@@ -57,7 +74,7 @@ declare const useCreateProject: <TError = ErrorType<void | DmError>, TContext =
57
74
  data: ProjectPostBodyBody;
58
75
  }, TContext> | undefined;
59
76
  request?: SecondParameter<typeof customInstance>;
60
- } | undefined) => _tanstack_react_query.UseMutationResult<ProjectPostResponse, TError, {
77
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<ProjectPostResponse, TError, {
61
78
  data: ProjectPostBodyBody;
62
79
  }, TContext>;
63
80
  /**
@@ -68,7 +85,7 @@ declare const useCreateProject: <TError = ErrorType<void | DmError>, TContext =
68
85
  declare const getProject: (projectId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ProjectDetail>;
69
86
  declare const getGetProjectQueryKey: (projectId: string) => readonly ["data-manager-api", `/project/${string}`];
70
87
  declare const getGetProjectQueryOptions: <TData = ProjectDetail, TError = ErrorType<void | DmError>>(projectId: string, options?: {
71
- query?: UseQueryOptions<ProjectDetail, TError, TData, QueryKey> | undefined;
88
+ query?: Partial<UseQueryOptions<ProjectDetail, TError, TData, QueryKey>> | undefined;
72
89
  request?: SecondParameter<typeof customInstance>;
73
90
  } | undefined) => UseQueryOptions<ProjectDetail, TError, TData, QueryKey> & {
74
91
  queryKey: QueryKey;
@@ -79,11 +96,28 @@ type GetProjectQueryError = ErrorType<void | DmError>;
79
96
  * @summary Get a Project
80
97
  */
81
98
  declare const useGetProject: <TData = ProjectDetail, TError = ErrorType<void | DmError>>(projectId: string, options?: {
82
- query?: UseQueryOptions<ProjectDetail, TError, TData, QueryKey> | undefined;
99
+ query?: Partial<UseQueryOptions<ProjectDetail, TError, TData, QueryKey>> | undefined;
83
100
  request?: SecondParameter<typeof customInstance>;
84
101
  } | undefined) => UseQueryResult<TData, TError> & {
85
102
  queryKey: QueryKey;
86
103
  };
104
+ declare const getGetProjectSuspenseQueryOptions: <TData = ProjectDetail, TError = ErrorType<void | DmError>>(projectId: string, options?: {
105
+ query?: Partial<UseSuspenseQueryOptions<ProjectDetail, TError, TData, QueryKey>> | undefined;
106
+ request?: SecondParameter<typeof customInstance>;
107
+ } | undefined) => UseSuspenseQueryOptions<ProjectDetail, TError, TData, QueryKey> & {
108
+ queryKey: QueryKey;
109
+ };
110
+ type GetProjectSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getProject>>>;
111
+ type GetProjectSuspenseQueryError = ErrorType<void | DmError>;
112
+ /**
113
+ * @summary Get a Project
114
+ */
115
+ declare const useGetProjectSuspense: <TData = ProjectDetail, TError = ErrorType<void | DmError>>(projectId: string, options?: {
116
+ query?: Partial<UseSuspenseQueryOptions<ProjectDetail, TError, TData, QueryKey>> | undefined;
117
+ request?: SecondParameter<typeof customInstance>;
118
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
119
+ queryKey: QueryKey;
120
+ };
87
121
  /**
88
122
  * Used to update some adjustable parameters of a Project, i.e. to make it `private` or make it `public``. What can be adjusted will depend on the purchased **Product**
89
123
 
@@ -112,14 +146,14 @@ declare const usePatchProject: <TError = ErrorType<DmError>, TContext = unknown>
112
146
  data: ProjectPatchBodyBody;
113
147
  }, TContext> | undefined;
114
148
  request?: SecondParameter<typeof customInstance>;
115
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
149
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
116
150
  projectId: string;
117
151
  data: ProjectPatchBodyBody;
118
152
  }, TContext>;
119
153
  /**
120
154
  * Deletes an existing Project.
121
155
 
122
- You must be an `editor` or the `owner` of the project.
156
+ You must be an `administrator` of the project.
123
157
 
124
158
  Once deleted all **Files**, working directories and material in the Project will also be removed
125
159
 
@@ -144,15 +178,83 @@ declare const useDeleteProject: <TError = ErrorType<void | DmError>, TContext =
144
178
  projectId: string;
145
179
  }, TContext> | undefined;
146
180
  request?: SecondParameter<typeof customInstance>;
147
- } | undefined) => _tanstack_react_query.UseMutationResult<TaskIdentity, TError, {
181
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<TaskIdentity, TError, {
182
+ projectId: string;
183
+ }, TContext>;
184
+ /**
185
+ * 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.
186
+
187
+ You must be an `administrator` of the project
188
+
189
+ * @summary Add a Project Administrator
190
+ */
191
+ declare const addAdministratorToProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
192
+ declare const getAddAdministratorToProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
193
+ mutation?: UseMutationOptions<void, TError, {
194
+ projectId: string;
195
+ userId: string;
196
+ }, TContext> | undefined;
197
+ request?: SecondParameter<typeof customInstance>;
198
+ } | undefined) => UseMutationOptions<void, TError, {
148
199
  projectId: string;
200
+ userId: string;
201
+ }, TContext>;
202
+ type AddAdministratorToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addAdministratorToProject>>>;
203
+ type AddAdministratorToProjectMutationError = ErrorType<DmError>;
204
+ /**
205
+ * @summary Add a Project Administrator
206
+ */
207
+ declare const useAddAdministratorToProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
208
+ mutation?: UseMutationOptions<void, TError, {
209
+ projectId: string;
210
+ userId: string;
211
+ }, TContext> | undefined;
212
+ request?: SecondParameter<typeof customInstance>;
213
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
214
+ projectId: string;
215
+ userId: string;
216
+ }, TContext>;
217
+ /**
218
+ * Deletes a project `administrator`. The administrator can be you.
219
+
220
+ A project must always have one `administrator` so you will not be able to delete the last administrator of a project.
221
+
222
+ You must be an `administrator` of the project
223
+
224
+ * @summary Delete a Project Administrator
225
+ */
226
+ declare const removeAdministratorFromProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
227
+ declare const getRemoveAdministratorFromProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
228
+ mutation?: UseMutationOptions<void, TError, {
229
+ projectId: string;
230
+ userId: string;
231
+ }, TContext> | undefined;
232
+ request?: SecondParameter<typeof customInstance>;
233
+ } | undefined) => UseMutationOptions<void, TError, {
234
+ projectId: string;
235
+ userId: string;
236
+ }, TContext>;
237
+ type RemoveAdministratorFromProjectMutationResult = NonNullable<Awaited<ReturnType<typeof removeAdministratorFromProject>>>;
238
+ type RemoveAdministratorFromProjectMutationError = ErrorType<DmError>;
239
+ /**
240
+ * @summary Delete a Project Administrator
241
+ */
242
+ declare const useRemoveAdministratorFromProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
243
+ mutation?: UseMutationOptions<void, TError, {
244
+ projectId: string;
245
+ userId: string;
246
+ }, TContext> | undefined;
247
+ request?: SecondParameter<typeof customInstance>;
248
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
249
+ projectId: string;
250
+ userId: string;
149
251
  }, TContext>;
150
252
  /**
151
253
  * Adds a user to a Project as an `editor`. Editors can add and remove datasets in a project and delete the project.
152
254
 
153
255
  An `editor` of a project is not automatically an `editor` of any datasets the project contains.
154
256
 
155
- You must be an `editor` or the `owner` of the project
257
+ You must be an `administrator` of the project
156
258
 
157
259
  * @summary Add a Project Editor
158
260
  */
@@ -178,7 +280,7 @@ declare const useAddEditorToProject: <TError = ErrorType<DmError>, TContext = un
178
280
  userId: string;
179
281
  }, TContext> | undefined;
180
282
  request?: SecondParameter<typeof customInstance>;
181
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
283
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
182
284
  projectId: string;
183
285
  userId: string;
184
286
  }, TContext>;
@@ -187,7 +289,7 @@ declare const useAddEditorToProject: <TError = ErrorType<DmError>, TContext = un
187
289
 
188
290
  A project must always have one `editor` so you will not be able to delete the last editor of a project.
189
291
 
190
- You must be an `editor` or the `owner` of the project
292
+ You must be an `administrator` of the project
191
293
 
192
294
  * @summary Delete a Project Editor
193
295
  */
@@ -213,14 +315,14 @@ declare const useRemoveEditorFromProject: <TError = ErrorType<DmError>, TContext
213
315
  userId: string;
214
316
  }, TContext> | undefined;
215
317
  request?: SecondParameter<typeof customInstance>;
216
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
318
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
217
319
  projectId: string;
218
320
  userId: string;
219
321
  }, TContext>;
220
322
  /**
221
323
  * 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**.
222
324
 
223
- You must be an `editor` or the `owner` of the Project to add Observers
325
+ You must be an `administrator` of the Project to add Observers
224
326
 
225
327
  * @summary Add a Project Observer
226
328
  */
@@ -246,14 +348,14 @@ declare const useAddObserverToProject: <TError = ErrorType<DmError>, TContext =
246
348
  userId: string;
247
349
  }, TContext> | undefined;
248
350
  request?: SecondParameter<typeof customInstance>;
249
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
351
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
250
352
  projectId: string;
251
353
  userId: string;
252
354
  }, TContext>;
253
355
  /**
254
356
  * Deletes a project `observer`.
255
357
 
256
- You must be an `editor` or the `owner` of the Project to remove Observers
358
+ You must be an `administrator` of the Project to remove Observers
257
359
 
258
360
  * @summary Delete a Project Observer
259
361
  */
@@ -279,7 +381,7 @@ declare const useRemoveObserverFromProject: <TError = ErrorType<DmError>, TConte
279
381
  userId: string;
280
382
  }, TContext> | undefined;
281
383
  request?: SecondParameter<typeof customInstance>;
282
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
384
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
283
385
  projectId: string;
284
386
  userId: string;
285
387
  }, TContext>;
@@ -288,14 +390,14 @@ declare const useRemoveObserverFromProject: <TError = ErrorType<DmError>, TConte
288
390
 
289
391
  For **managed** files you should consider using the `/file/{file_id}` endpoint.
290
392
 
291
- You must be an `editor` or the `owner` of the Project if the Project is `private`
393
+ You must be an `editor` of the Project if the Project is `private`
292
394
 
293
395
  * @summary Download a Project file
294
396
  */
295
397
  declare const getProjectFile: (projectId: string, params: GetProjectFileParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
296
398
  declare const getGetProjectFileQueryKey: (projectId: string, params: GetProjectFileParams) => readonly ["data-manager-api", `/project/${string}/file`, ...GetProjectFileParams[]];
297
399
  declare const getGetProjectFileQueryOptions: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileParams, options?: {
298
- query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
400
+ query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
299
401
  request?: SecondParameter<typeof customInstance>;
300
402
  } | undefined) => UseQueryOptions<void, TError, TData, QueryKey> & {
301
403
  queryKey: QueryKey;
@@ -306,15 +408,32 @@ type GetProjectFileQueryError = ErrorType<DmError>;
306
408
  * @summary Download a Project file
307
409
  */
308
410
  declare const useGetProjectFile: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileParams, options?: {
309
- query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
411
+ query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
310
412
  request?: SecondParameter<typeof customInstance>;
311
413
  } | undefined) => UseQueryResult<TData, TError> & {
312
414
  queryKey: QueryKey;
313
415
  };
416
+ declare const getGetProjectFileSuspenseQueryOptions: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileParams, options?: {
417
+ query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
418
+ request?: SecondParameter<typeof customInstance>;
419
+ } | undefined) => UseSuspenseQueryOptions<void, TError, TData, QueryKey> & {
420
+ queryKey: QueryKey;
421
+ };
422
+ type GetProjectFileSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFile>>>;
423
+ type GetProjectFileSuspenseQueryError = ErrorType<DmError>;
424
+ /**
425
+ * @summary Download a Project file
426
+ */
427
+ declare const useGetProjectFileSuspense: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileParams, options?: {
428
+ query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
429
+ request?: SecondParameter<typeof customInstance>;
430
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
431
+ queryKey: QueryKey;
432
+ };
314
433
  /**
315
434
  * The user provides an external file for upload to the Project using an optional Path. The path is created if it does not exist.
316
435
 
317
- You must be an `editor` or the `owner` of the project
436
+ You must be an `editor` of the project
318
437
 
319
438
  * @summary Upload a file into a Project
320
439
  */
@@ -341,7 +460,7 @@ declare const useAddFileToProject: <TError = ErrorType<DmError>, TContext = unkn
341
460
  data: ProjectFilePutBodyBody;
342
461
  }, TContext> | undefined;
343
462
  request?: SecondParameter<typeof customInstance>;
344
- } | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
463
+ } | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
345
464
  projectId: string;
346
465
  data: ProjectFilePutBodyBody;
347
466
  }, TContext>;
@@ -357,7 +476,7 @@ As there is no authentication for this endpoint you must provide a valid token.
357
476
  declare const getProjectFileWithToken: (projectId: string, params: GetProjectFileWithTokenParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
358
477
  declare const getGetProjectFileWithTokenQueryKey: (projectId: string, params: GetProjectFileWithTokenParams) => readonly ["data-manager-api", `/project/${string}/file-with-token`, ...GetProjectFileWithTokenParams[]];
359
478
  declare const getGetProjectFileWithTokenQueryOptions: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
360
- query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
479
+ query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
361
480
  request?: SecondParameter<typeof customInstance>;
362
481
  } | undefined) => UseQueryOptions<void, TError, TData, QueryKey> & {
363
482
  queryKey: QueryKey;
@@ -368,10 +487,27 @@ type GetProjectFileWithTokenQueryError = ErrorType<DmError>;
368
487
  * @summary Download a Project file using a Token
369
488
  */
370
489
  declare const useGetProjectFileWithToken: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
371
- query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
490
+ query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
372
491
  request?: SecondParameter<typeof customInstance>;
373
492
  } | undefined) => UseQueryResult<TData, TError> & {
374
493
  queryKey: QueryKey;
375
494
  };
495
+ declare const getGetProjectFileWithTokenSuspenseQueryOptions: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
496
+ query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
497
+ request?: SecondParameter<typeof customInstance>;
498
+ } | undefined) => UseSuspenseQueryOptions<void, TError, TData, QueryKey> & {
499
+ queryKey: QueryKey;
500
+ };
501
+ type GetProjectFileWithTokenSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFileWithToken>>>;
502
+ type GetProjectFileWithTokenSuspenseQueryError = ErrorType<DmError>;
503
+ /**
504
+ * @summary Download a Project file using a Token
505
+ */
506
+ declare const useGetProjectFileWithTokenSuspense: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
507
+ query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
508
+ request?: SecondParameter<typeof customInstance>;
509
+ } | undefined) => UseSuspenseQueryResult<TData, TError> & {
510
+ queryKey: QueryKey;
511
+ };
376
512
 
377
- export { AddEditorToProjectMutationError, AddEditorToProjectMutationResult, AddFileToProjectMutationBody, AddFileToProjectMutationError, AddFileToProjectMutationResult, AddObserverToProjectMutationError, AddObserverToProjectMutationResult, CreateProjectMutationBody, CreateProjectMutationError, CreateProjectMutationResult, DeleteProjectMutationError, DeleteProjectMutationResult, GetProjectFileQueryError, GetProjectFileQueryResult, GetProjectFileWithTokenQueryError, GetProjectFileWithTokenQueryResult, GetProjectQueryError, GetProjectQueryResult, GetProjectsQueryError, GetProjectsQueryResult, PatchProjectMutationBody, PatchProjectMutationError, PatchProjectMutationResult, RemoveEditorFromProjectMutationError, RemoveEditorFromProjectMutationResult, RemoveObserverFromProjectMutationError, RemoveObserverFromProjectMutationResult, addEditorToProject, addFileToProject, addObserverToProject, createProject, deleteProject, getAddEditorToProjectMutationOptions, getAddFileToProjectMutationOptions, getAddObserverToProjectMutationOptions, getCreateProjectMutationOptions, getDeleteProjectMutationOptions, getGetProjectFileQueryKey, getGetProjectFileQueryOptions, getGetProjectFileWithTokenQueryKey, getGetProjectFileWithTokenQueryOptions, getGetProjectQueryKey, getGetProjectQueryOptions, getGetProjectsQueryKey, getGetProjectsQueryOptions, getPatchProjectMutationOptions, getProject, getProjectFile, getProjectFileWithToken, getProjects, getRemoveEditorFromProjectMutationOptions, getRemoveObserverFromProjectMutationOptions, patchProject, removeEditorFromProject, removeObserverFromProject, useAddEditorToProject, useAddFileToProject, useAddObserverToProject, useCreateProject, useDeleteProject, useGetProject, useGetProjectFile, useGetProjectFileWithToken, useGetProjects, usePatchProject, useRemoveEditorFromProject, useRemoveObserverFromProject };
513
+ 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, getAddAdministratorToProjectMutationOptions, getAddEditorToProjectMutationOptions, getAddFileToProjectMutationOptions, getAddObserverToProjectMutationOptions, getCreateProjectMutationOptions, getDeleteProjectMutationOptions, getGetProjectFileQueryKey, getGetProjectFileQueryOptions, getGetProjectFileSuspenseQueryOptions, getGetProjectFileWithTokenQueryKey, getGetProjectFileWithTokenQueryOptions, getGetProjectFileWithTokenSuspenseQueryOptions, getGetProjectQueryKey, getGetProjectQueryOptions, getGetProjectSuspenseQueryOptions, getGetProjectsQueryKey, getGetProjectsQueryOptions, getGetProjectsSuspenseQueryOptions, getPatchProjectMutationOptions, getProject, getProjectFile, getProjectFileWithToken, getProjects, getRemoveAdministratorFromProjectMutationOptions, getRemoveEditorFromProjectMutationOptions, getRemoveObserverFromProjectMutationOptions, patchProject, removeAdministratorFromProject, removeEditorFromProject, removeObserverFromProject, useAddAdministratorToProject, useAddEditorToProject, useAddFileToProject, useAddObserverToProject, useCreateProject, useDeleteProject, useGetProject, useGetProjectFile, useGetProjectFileSuspense, useGetProjectFileWithToken, useGetProjectFileWithTokenSuspense, useGetProjectSuspense, useGetProjects, useGetProjectsSuspense, usePatchProject, useRemoveAdministratorFromProject, useRemoveEditorFromProject, useRemoveObserverFromProject };