@squonk/data-manager-client 1.2.9 → 2.0.0-alpha.2
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.map +1 -1
- package/accounting/accounting.js.map +1 -1
- package/admin/admin.cjs.map +1 -1
- package/admin/admin.js.map +1 -1
- package/application/application.cjs.map +1 -1
- package/application/application.js.map +1 -1
- package/configuration/configuration.cjs.map +1 -1
- package/configuration/configuration.js.map +1 -1
- package/dataset/dataset.cjs.map +1 -1
- package/dataset/dataset.js.map +1 -1
- package/exchange-rate/exchange-rate.cjs.map +1 -1
- package/exchange-rate/exchange-rate.js.map +1 -1
- package/file-and-path/file-and-path.cjs.map +1 -1
- package/file-and-path/file-and-path.d.cts +5 -5
- package/file-and-path/file-and-path.d.ts +5 -5
- package/file-and-path/file-and-path.js.map +1 -1
- package/index.cjs.map +1 -1
- package/index.d.cts +118 -37
- package/index.d.ts +118 -37
- package/index.js.map +1 -1
- package/instance/instance.cjs.map +1 -1
- package/instance/instance.js.map +1 -1
- package/inventory/inventory.cjs +56 -0
- package/inventory/inventory.cjs.map +1 -0
- package/inventory/inventory.d.cts +50 -0
- package/inventory/inventory.d.ts +50 -0
- package/inventory/inventory.js +56 -0
- package/inventory/inventory.js.map +1 -0
- package/inventory/package.json +7 -0
- package/job/job.cjs.map +1 -1
- package/job/job.js.map +1 -1
- package/metadata/metadata.cjs.map +1 -1
- package/metadata/metadata.js.map +1 -1
- package/package.json +1 -1
- package/project/project.cjs +49 -1
- package/project/project.cjs.map +1 -1
- package/project/project.d.cts +78 -10
- package/project/project.d.ts +78 -10
- package/project/project.js +48 -0
- package/project/project.js.map +1 -1
- package/src/accounting/accounting.ts +1 -1
- package/src/admin/admin.ts +1 -1
- package/src/application/application.ts +1 -1
- package/src/configuration/configuration.ts +1 -1
- package/src/data-manager-api.schemas.ts +133 -41
- package/src/dataset/dataset.ts +1 -1
- package/src/exchange-rate/exchange-rate.ts +1 -1
- package/src/file-and-path/file-and-path.ts +6 -6
- package/src/instance/instance.ts +1 -1
- package/src/inventory/inventory.ts +140 -0
- package/src/job/job.ts +1 -1
- package/src/metadata/metadata.ts +1 -1
- package/src/project/project.ts +122 -10
- package/src/task/task.ts +1 -1
- package/src/type/type.ts +1 -1
- package/src/user/user.ts +1 -1
- package/task/task.cjs.map +1 -1
- package/task/task.js.map +1 -1
- package/type/type.cjs.map +1 -1
- package/type/type.js.map +1 -1
- package/user/user.cjs.map +1 -1
- package/user/user.js.map +1 -1
package/project/project.d.cts
CHANGED
|
@@ -48,9 +48,9 @@ declare const useGetProjectsSuspense: <TData = ProjectsGetResponse, TError = Err
|
|
|
48
48
|
|
|
49
49
|
To create a Project when an **Account Server** is configured you will need a **Product**.
|
|
50
50
|
|
|
51
|
-
As the Project
|
|
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.
|
|
52
52
|
|
|
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
|
|
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.
|
|
54
54
|
|
|
55
55
|
* @summary Create a new Project
|
|
56
56
|
*/
|
|
@@ -153,7 +153,7 @@ declare const usePatchProject: <TError = ErrorType<DmError>, TContext = unknown>
|
|
|
153
153
|
/**
|
|
154
154
|
* Deletes an existing Project.
|
|
155
155
|
|
|
156
|
-
You must be an `
|
|
156
|
+
You must be an `administrator` of the project.
|
|
157
157
|
|
|
158
158
|
Once deleted all **Files**, working directories and material in the Project will also be removed
|
|
159
159
|
|
|
@@ -182,11 +182,79 @@ declare const useDeleteProject: <TError = ErrorType<void | DmError>, TContext =
|
|
|
182
182
|
projectId: string;
|
|
183
183
|
}, TContext>;
|
|
184
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, {
|
|
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;
|
|
251
|
+
}, TContext>;
|
|
252
|
+
/**
|
|
185
253
|
* Adds a user to a Project as an `editor`. Editors can add and remove datasets in a project and delete the project.
|
|
186
254
|
|
|
187
255
|
An `editor` of a project is not automatically an `editor` of any datasets the project contains.
|
|
188
256
|
|
|
189
|
-
You must be an `
|
|
257
|
+
You must be an `administrator` of the project
|
|
190
258
|
|
|
191
259
|
* @summary Add a Project Editor
|
|
192
260
|
*/
|
|
@@ -221,7 +289,7 @@ declare const useAddEditorToProject: <TError = ErrorType<DmError>, TContext = un
|
|
|
221
289
|
|
|
222
290
|
A project must always have one `editor` so you will not be able to delete the last editor of a project.
|
|
223
291
|
|
|
224
|
-
You must be an `
|
|
292
|
+
You must be an `administrator` of the project
|
|
225
293
|
|
|
226
294
|
* @summary Delete a Project Editor
|
|
227
295
|
*/
|
|
@@ -254,7 +322,7 @@ declare const useRemoveEditorFromProject: <TError = ErrorType<DmError>, TContext
|
|
|
254
322
|
/**
|
|
255
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**.
|
|
256
324
|
|
|
257
|
-
You must be an `
|
|
325
|
+
You must be an `administrator` of the Project to add Observers
|
|
258
326
|
|
|
259
327
|
* @summary Add a Project Observer
|
|
260
328
|
*/
|
|
@@ -287,7 +355,7 @@ declare const useAddObserverToProject: <TError = ErrorType<DmError>, TContext =
|
|
|
287
355
|
/**
|
|
288
356
|
* Deletes a project `observer`.
|
|
289
357
|
|
|
290
|
-
You must be an `
|
|
358
|
+
You must be an `administrator` of the Project to remove Observers
|
|
291
359
|
|
|
292
360
|
* @summary Delete a Project Observer
|
|
293
361
|
*/
|
|
@@ -322,7 +390,7 @@ declare const useRemoveObserverFromProject: <TError = ErrorType<DmError>, TConte
|
|
|
322
390
|
|
|
323
391
|
For **managed** files you should consider using the `/file/{file_id}` endpoint.
|
|
324
392
|
|
|
325
|
-
You must be an `editor`
|
|
393
|
+
You must be an `editor` of the Project if the Project is `private`
|
|
326
394
|
|
|
327
395
|
* @summary Download a Project file
|
|
328
396
|
*/
|
|
@@ -365,7 +433,7 @@ declare const useGetProjectFileSuspense: <TData = void, TError = ErrorType<DmErr
|
|
|
365
433
|
/**
|
|
366
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.
|
|
367
435
|
|
|
368
|
-
You must be an `editor`
|
|
436
|
+
You must be an `editor` of the project
|
|
369
437
|
|
|
370
438
|
* @summary Upload a file into a Project
|
|
371
439
|
*/
|
|
@@ -442,4 +510,4 @@ declare const useGetProjectFileWithTokenSuspense: <TData = void, TError = ErrorT
|
|
|
442
510
|
queryKey: QueryKey;
|
|
443
511
|
};
|
|
444
512
|
|
|
445
|
-
export { 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 RemoveEditorFromProjectMutationError, type RemoveEditorFromProjectMutationResult, type RemoveObserverFromProjectMutationError, type RemoveObserverFromProjectMutationResult, addEditorToProject, addFileToProject, addObserverToProject, createProject, deleteProject, getAddEditorToProjectMutationOptions, getAddFileToProjectMutationOptions, getAddObserverToProjectMutationOptions, getCreateProjectMutationOptions, getDeleteProjectMutationOptions, getGetProjectFileQueryKey, getGetProjectFileQueryOptions, getGetProjectFileSuspenseQueryOptions, getGetProjectFileWithTokenQueryKey, getGetProjectFileWithTokenQueryOptions, getGetProjectFileWithTokenSuspenseQueryOptions, getGetProjectQueryKey, getGetProjectQueryOptions, getGetProjectSuspenseQueryOptions, getGetProjectsQueryKey, getGetProjectsQueryOptions, getGetProjectsSuspenseQueryOptions, getPatchProjectMutationOptions, getProject, getProjectFile, getProjectFileWithToken, getProjects, getRemoveEditorFromProjectMutationOptions, getRemoveObserverFromProjectMutationOptions, patchProject, removeEditorFromProject, removeObserverFromProject, useAddEditorToProject, useAddFileToProject, useAddObserverToProject, useCreateProject, useDeleteProject, useGetProject, useGetProjectFile, useGetProjectFileSuspense, useGetProjectFileWithToken, useGetProjectFileWithTokenSuspense, useGetProjectSuspense, useGetProjects, useGetProjectsSuspense, 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 };
|
package/project/project.d.ts
CHANGED
|
@@ -48,9 +48,9 @@ declare const useGetProjectsSuspense: <TData = ProjectsGetResponse, TError = Err
|
|
|
48
48
|
|
|
49
49
|
To create a Project when an **Account Server** is configured you will need a **Product**.
|
|
50
50
|
|
|
51
|
-
As the Project
|
|
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.
|
|
52
52
|
|
|
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
|
|
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.
|
|
54
54
|
|
|
55
55
|
* @summary Create a new Project
|
|
56
56
|
*/
|
|
@@ -153,7 +153,7 @@ declare const usePatchProject: <TError = ErrorType<DmError>, TContext = unknown>
|
|
|
153
153
|
/**
|
|
154
154
|
* Deletes an existing Project.
|
|
155
155
|
|
|
156
|
-
You must be an `
|
|
156
|
+
You must be an `administrator` of the project.
|
|
157
157
|
|
|
158
158
|
Once deleted all **Files**, working directories and material in the Project will also be removed
|
|
159
159
|
|
|
@@ -182,11 +182,79 @@ declare const useDeleteProject: <TError = ErrorType<void | DmError>, TContext =
|
|
|
182
182
|
projectId: string;
|
|
183
183
|
}, TContext>;
|
|
184
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, {
|
|
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;
|
|
251
|
+
}, TContext>;
|
|
252
|
+
/**
|
|
185
253
|
* Adds a user to a Project as an `editor`. Editors can add and remove datasets in a project and delete the project.
|
|
186
254
|
|
|
187
255
|
An `editor` of a project is not automatically an `editor` of any datasets the project contains.
|
|
188
256
|
|
|
189
|
-
You must be an `
|
|
257
|
+
You must be an `administrator` of the project
|
|
190
258
|
|
|
191
259
|
* @summary Add a Project Editor
|
|
192
260
|
*/
|
|
@@ -221,7 +289,7 @@ declare const useAddEditorToProject: <TError = ErrorType<DmError>, TContext = un
|
|
|
221
289
|
|
|
222
290
|
A project must always have one `editor` so you will not be able to delete the last editor of a project.
|
|
223
291
|
|
|
224
|
-
You must be an `
|
|
292
|
+
You must be an `administrator` of the project
|
|
225
293
|
|
|
226
294
|
* @summary Delete a Project Editor
|
|
227
295
|
*/
|
|
@@ -254,7 +322,7 @@ declare const useRemoveEditorFromProject: <TError = ErrorType<DmError>, TContext
|
|
|
254
322
|
/**
|
|
255
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**.
|
|
256
324
|
|
|
257
|
-
You must be an `
|
|
325
|
+
You must be an `administrator` of the Project to add Observers
|
|
258
326
|
|
|
259
327
|
* @summary Add a Project Observer
|
|
260
328
|
*/
|
|
@@ -287,7 +355,7 @@ declare const useAddObserverToProject: <TError = ErrorType<DmError>, TContext =
|
|
|
287
355
|
/**
|
|
288
356
|
* Deletes a project `observer`.
|
|
289
357
|
|
|
290
|
-
You must be an `
|
|
358
|
+
You must be an `administrator` of the Project to remove Observers
|
|
291
359
|
|
|
292
360
|
* @summary Delete a Project Observer
|
|
293
361
|
*/
|
|
@@ -322,7 +390,7 @@ declare const useRemoveObserverFromProject: <TError = ErrorType<DmError>, TConte
|
|
|
322
390
|
|
|
323
391
|
For **managed** files you should consider using the `/file/{file_id}` endpoint.
|
|
324
392
|
|
|
325
|
-
You must be an `editor`
|
|
393
|
+
You must be an `editor` of the Project if the Project is `private`
|
|
326
394
|
|
|
327
395
|
* @summary Download a Project file
|
|
328
396
|
*/
|
|
@@ -365,7 +433,7 @@ declare const useGetProjectFileSuspense: <TData = void, TError = ErrorType<DmErr
|
|
|
365
433
|
/**
|
|
366
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.
|
|
367
435
|
|
|
368
|
-
You must be an `editor`
|
|
436
|
+
You must be an `editor` of the project
|
|
369
437
|
|
|
370
438
|
* @summary Upload a file into a Project
|
|
371
439
|
*/
|
|
@@ -442,4 +510,4 @@ declare const useGetProjectFileWithTokenSuspense: <TData = void, TError = ErrorT
|
|
|
442
510
|
queryKey: QueryKey;
|
|
443
511
|
};
|
|
444
512
|
|
|
445
|
-
export { 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 RemoveEditorFromProjectMutationError, type RemoveEditorFromProjectMutationResult, type RemoveObserverFromProjectMutationError, type RemoveObserverFromProjectMutationResult, addEditorToProject, addFileToProject, addObserverToProject, createProject, deleteProject, getAddEditorToProjectMutationOptions, getAddFileToProjectMutationOptions, getAddObserverToProjectMutationOptions, getCreateProjectMutationOptions, getDeleteProjectMutationOptions, getGetProjectFileQueryKey, getGetProjectFileQueryOptions, getGetProjectFileSuspenseQueryOptions, getGetProjectFileWithTokenQueryKey, getGetProjectFileWithTokenQueryOptions, getGetProjectFileWithTokenSuspenseQueryOptions, getGetProjectQueryKey, getGetProjectQueryOptions, getGetProjectSuspenseQueryOptions, getGetProjectsQueryKey, getGetProjectsQueryOptions, getGetProjectsSuspenseQueryOptions, getPatchProjectMutationOptions, getProject, getProjectFile, getProjectFileWithToken, getProjects, getRemoveEditorFromProjectMutationOptions, getRemoveObserverFromProjectMutationOptions, patchProject, removeEditorFromProject, removeObserverFromProject, useAddEditorToProject, useAddFileToProject, useAddObserverToProject, useCreateProject, useDeleteProject, useGetProject, useGetProjectFile, useGetProjectFileSuspense, useGetProjectFileWithToken, useGetProjectFileWithTokenSuspense, useGetProjectSuspense, useGetProjects, useGetProjectsSuspense, 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 };
|
package/project/project.js
CHANGED
|
@@ -163,6 +163,48 @@ var useDeleteProject = (options) => {
|
|
|
163
163
|
const mutationOptions = getDeleteProjectMutationOptions(options);
|
|
164
164
|
return useMutation(mutationOptions);
|
|
165
165
|
};
|
|
166
|
+
var addAdministratorToProject = (projectId, userId, options) => {
|
|
167
|
+
return customInstance(
|
|
168
|
+
{
|
|
169
|
+
url: `/project/${projectId}/administrator/${userId}`,
|
|
170
|
+
method: "PUT"
|
|
171
|
+
},
|
|
172
|
+
options
|
|
173
|
+
);
|
|
174
|
+
};
|
|
175
|
+
var getAddAdministratorToProjectMutationOptions = (options) => {
|
|
176
|
+
const { mutation: mutationOptions, request: requestOptions } = options ?? {};
|
|
177
|
+
const mutationFn = (props) => {
|
|
178
|
+
const { projectId, userId } = props ?? {};
|
|
179
|
+
return addAdministratorToProject(projectId, userId, requestOptions);
|
|
180
|
+
};
|
|
181
|
+
return { mutationFn, ...mutationOptions };
|
|
182
|
+
};
|
|
183
|
+
var useAddAdministratorToProject = (options) => {
|
|
184
|
+
const mutationOptions = getAddAdministratorToProjectMutationOptions(options);
|
|
185
|
+
return useMutation(mutationOptions);
|
|
186
|
+
};
|
|
187
|
+
var removeAdministratorFromProject = (projectId, userId, options) => {
|
|
188
|
+
return customInstance(
|
|
189
|
+
{
|
|
190
|
+
url: `/project/${projectId}/administrator/${userId}`,
|
|
191
|
+
method: "DELETE"
|
|
192
|
+
},
|
|
193
|
+
options
|
|
194
|
+
);
|
|
195
|
+
};
|
|
196
|
+
var getRemoveAdministratorFromProjectMutationOptions = (options) => {
|
|
197
|
+
const { mutation: mutationOptions, request: requestOptions } = options ?? {};
|
|
198
|
+
const mutationFn = (props) => {
|
|
199
|
+
const { projectId, userId } = props ?? {};
|
|
200
|
+
return removeAdministratorFromProject(projectId, userId, requestOptions);
|
|
201
|
+
};
|
|
202
|
+
return { mutationFn, ...mutationOptions };
|
|
203
|
+
};
|
|
204
|
+
var useRemoveAdministratorFromProject = (options) => {
|
|
205
|
+
const mutationOptions = getRemoveAdministratorFromProjectMutationOptions(options);
|
|
206
|
+
return useMutation(mutationOptions);
|
|
207
|
+
};
|
|
166
208
|
var addEditorToProject = (projectId, userId, options) => {
|
|
167
209
|
return customInstance(
|
|
168
210
|
{
|
|
@@ -355,11 +397,13 @@ var useGetProjectFileWithTokenSuspense = (projectId, params, options) => {
|
|
|
355
397
|
return query;
|
|
356
398
|
};
|
|
357
399
|
export {
|
|
400
|
+
addAdministratorToProject,
|
|
358
401
|
addEditorToProject,
|
|
359
402
|
addFileToProject,
|
|
360
403
|
addObserverToProject,
|
|
361
404
|
createProject,
|
|
362
405
|
deleteProject,
|
|
406
|
+
getAddAdministratorToProjectMutationOptions,
|
|
363
407
|
getAddEditorToProjectMutationOptions,
|
|
364
408
|
getAddFileToProjectMutationOptions,
|
|
365
409
|
getAddObserverToProjectMutationOptions,
|
|
@@ -382,11 +426,14 @@ export {
|
|
|
382
426
|
getProjectFile,
|
|
383
427
|
getProjectFileWithToken,
|
|
384
428
|
getProjects,
|
|
429
|
+
getRemoveAdministratorFromProjectMutationOptions,
|
|
385
430
|
getRemoveEditorFromProjectMutationOptions,
|
|
386
431
|
getRemoveObserverFromProjectMutationOptions,
|
|
387
432
|
patchProject,
|
|
433
|
+
removeAdministratorFromProject,
|
|
388
434
|
removeEditorFromProject,
|
|
389
435
|
removeObserverFromProject,
|
|
436
|
+
useAddAdministratorToProject,
|
|
390
437
|
useAddEditorToProject,
|
|
391
438
|
useAddFileToProject,
|
|
392
439
|
useAddObserverToProject,
|
|
@@ -401,6 +448,7 @@ export {
|
|
|
401
448
|
useGetProjects,
|
|
402
449
|
useGetProjectsSuspense,
|
|
403
450
|
usePatchProject,
|
|
451
|
+
useRemoveAdministratorFromProject,
|
|
404
452
|
useRemoveEditorFromProject,
|
|
405
453
|
useRemoveObserverFromProject
|
|
406
454
|
};
|