@squonk/data-manager-client 1.2.3 → 1.2.4-rc.2

package/project/project.d.cts

@@ -0,0 +1,377 @@
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from '@tanstack/react-query';
+import { t as GetProjectsParams, bX as customInstance, bg as ProjectsGetResponse, bY as ErrorType, bT as DmError, a7 as ProjectPostBodyBody, bh as ProjectPostResponse, az as ProjectDetail, a8 as ProjectPatchBodyBody, at as TaskIdentity, s as GetProjectFileParams, a9 as ProjectFilePutBodyBody, r as GetProjectFileWithTokenParams } from '../custom-instance-3d66fe97.js';
+import 'axios';
+
+type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
+/**
+ * @summary Get all Projects available to you
+ */
+declare const getProjects: (params?: GetProjectsParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ProjectsGetResponse>;
+declare const getGetProjectsQueryKey: (params?: GetProjectsParams) => readonly ["data-manager-api", "/project", ...GetProjectsParams[]];
+declare const getGetProjectsQueryOptions: <TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
+    query?: UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+type GetProjectsQueryResult = NonNullable<Awaited<ReturnType<typeof getProjects>>>;
+type GetProjectsQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Get all Projects available to you
+ */
+declare const useGetProjects: <TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
+    query?: UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * 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**.
+
+To create a Project when an **Account Server** is configured you will need a **Product**.
+
+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.
+
+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.
+
+ * @summary Create a new Project
+ */
+declare const createProject: (projectPostBodyBody: ProjectPostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<ProjectPostResponse>;
+declare const getCreateProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<ProjectPostResponse, TError, {
+        data: ProjectPostBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<ProjectPostResponse, TError, {
+    data: ProjectPostBodyBody;
+}, TContext>;
+type CreateProjectMutationResult = NonNullable<Awaited<ReturnType<typeof createProject>>>;
+type CreateProjectMutationBody = ProjectPostBodyBody;
+type CreateProjectMutationError = ErrorType<DmError | void>;
+/**
+* @summary Create a new Project
+*/
+declare const useCreateProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<ProjectPostResponse, TError, {
+        data: ProjectPostBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<ProjectPostResponse, TError, {
+    data: ProjectPostBodyBody;
+}, TContext>;
+/**
+* Gets the details of a Project that is available to you.
+
+* @summary Get a Project
+*/
+declare const getProject: (projectId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ProjectDetail>;
+declare const getGetProjectQueryKey: (projectId: string) => readonly ["data-manager-api", `/project/${string}`];
+declare const getGetProjectQueryOptions: <TData = ProjectDetail, TError = ErrorType<void | DmError>>(projectId: string, options?: {
+    query?: UseQueryOptions<ProjectDetail, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryOptions<ProjectDetail, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+type GetProjectQueryResult = NonNullable<Awaited<ReturnType<typeof getProject>>>;
+type GetProjectQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Get a Project
+ */
+declare const useGetProject: <TData = ProjectDetail, TError = ErrorType<void | DmError>>(projectId: string, options?: {
+    query?: UseQueryOptions<ProjectDetail, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * 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**
+
+ * @summary Adjust an existing Project
+ */
+declare const patchProject: (projectId: string, projectPatchBodyBody: ProjectPatchBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getPatchProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        data: ProjectPatchBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<void, TError, {
+    projectId: string;
+    data: ProjectPatchBodyBody;
+}, TContext>;
+type PatchProjectMutationResult = NonNullable<Awaited<ReturnType<typeof patchProject>>>;
+type PatchProjectMutationBody = ProjectPatchBodyBody;
+type PatchProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Adjust an existing Project
+*/
+declare const usePatchProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        data: ProjectPatchBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
+    projectId: string;
+    data: ProjectPatchBodyBody;
+}, TContext>;
+/**
+* Deletes an existing Project.
+
+You must be an `editor` or the `owner` of the project.
+
+Once deleted all **Files**, working directories and material in the Project will also be removed
+
+* @summary Delete a Project
+*/
+declare const deleteProject: (projectId: string, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
+declare const getDeleteProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TaskIdentity, TError, {
+        projectId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<TaskIdentity, TError, {
+    projectId: string;
+}, TContext>;
+type DeleteProjectMutationResult = NonNullable<Awaited<ReturnType<typeof deleteProject>>>;
+type DeleteProjectMutationError = ErrorType<void | DmError>;
+/**
+* @summary Delete a Project
+*/
+declare const useDeleteProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TaskIdentity, TError, {
+        projectId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<TaskIdentity, TError, {
+    projectId: string;
+}, TContext>;
+/**
+* Adds a user to a Project as an `editor`. Editors can add and remove datasets in a project and delete the project.
+
+An `editor` of a project is not automatically an `editor` of any datasets the project contains.
+
+You must be an `editor` or the `owner` of the project
+
+* @summary Add a Project Editor
+*/
+declare const addEditorToProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getAddEditorToProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<void, TError, {
+    projectId: string;
+    userId: string;
+}, TContext>;
+type AddEditorToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addEditorToProject>>>;
+type AddEditorToProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Add a Project Editor
+*/
+declare const useAddEditorToProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
+    projectId: string;
+    userId: string;
+}, TContext>;
+/**
+* Deletes a project `editor`. The editor can be you.
+
+A project must always have one `editor` so you will not be able to delete the last editor of a project.
+
+You must be an `editor` or the `owner` of the project
+
+* @summary Delete a Project Editor
+*/
+declare const removeEditorFromProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getRemoveEditorFromProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<void, TError, {
+    projectId: string;
+    userId: string;
+}, TContext>;
+type RemoveEditorFromProjectMutationResult = NonNullable<Awaited<ReturnType<typeof removeEditorFromProject>>>;
+type RemoveEditorFromProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Delete a Project Editor
+*/
+declare const useRemoveEditorFromProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
+    projectId: string;
+    userId: string;
+}, TContext>;
+/**
+* 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**.
+
+You must be an `editor` or the `owner` of the Project to add Observers
+
+* @summary Add a Project Observer
+*/
+declare const addObserverToProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getAddObserverToProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<void, TError, {
+    projectId: string;
+    userId: string;
+}, TContext>;
+type AddObserverToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addObserverToProject>>>;
+type AddObserverToProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Add a Project Observer
+*/
+declare const useAddObserverToProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
+    projectId: string;
+    userId: string;
+}, TContext>;
+/**
+* Deletes a project `observer`.
+
+You must be an `editor` or the `owner` of the Project to remove Observers
+
+* @summary Delete a Project Observer
+*/
+declare const removeObserverFromProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getRemoveObserverFromProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<void, TError, {
+    projectId: string;
+    userId: string;
+}, TContext>;
+type RemoveObserverFromProjectMutationResult = NonNullable<Awaited<ReturnType<typeof removeObserverFromProject>>>;
+type RemoveObserverFromProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Delete a Project Observer
+*/
+declare const useRemoveObserverFromProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        userId: string;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
+    projectId: string;
+    userId: string;
+}, TContext>;
+/**
+* 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).
+
+For **managed** files you should consider using the `/file/{file_id}` endpoint.
+
+You must be an `editor` or the `owner` of the Project if the Project is `private`
+
+* @summary Download a Project file
+*/
+declare const getProjectFile: (projectId: string, params: GetProjectFileParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
+declare const getGetProjectFileQueryKey: (projectId: string, params: GetProjectFileParams) => readonly ["data-manager-api", `/project/${string}/file`, ...GetProjectFileParams[]];
+declare const getGetProjectFileQueryOptions: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileParams, options?: {
+    query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryOptions<void, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+type GetProjectFileQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFile>>>;
+type GetProjectFileQueryError = ErrorType<DmError>;
+/**
+ * @summary Download a Project file
+ */
+declare const useGetProjectFile: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileParams, options?: {
+    query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * The user provides an external file for upload to the Project using an optional Path. The path is created if it does not exist.
+
+You must be an `editor` or the `owner` of the project
+
+ * @summary Upload a file into a Project
+ */
+declare const addFileToProject: (projectId: string, projectFilePutBodyBody: ProjectFilePutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getAddFileToProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        data: ProjectFilePutBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseMutationOptions<void, TError, {
+    projectId: string;
+    data: ProjectFilePutBodyBody;
+}, TContext>;
+type AddFileToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addFileToProject>>>;
+type AddFileToProjectMutationBody = ProjectFilePutBodyBody;
+type AddFileToProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Upload a file into a Project
+*/
+declare const useAddFileToProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<void, TError, {
+        projectId: string;
+        data: ProjectFilePutBodyBody;
+    }, TContext> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => _tanstack_react_query.UseMutationResult<void, TError, {
+    projectId: string;
+    data: ProjectFilePutBodyBody;
+}, TContext>;
+/**
+* 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).
+
+For **managed** files you should consider using the `/file/{file_id}` endpoint.
+
+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.
+
+* @summary Download a Project file using a Token
+*/
+declare const getProjectFileWithToken: (projectId: string, params: GetProjectFileWithTokenParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
+declare const getGetProjectFileWithTokenQueryKey: (projectId: string, params: GetProjectFileWithTokenParams) => readonly ["data-manager-api", `/project/${string}/file-with-token`, ...GetProjectFileWithTokenParams[]];
+declare const getGetProjectFileWithTokenQueryOptions: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
+    query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryOptions<void, TError, TData, QueryKey> & {
+    queryKey: QueryKey;
+};
+type GetProjectFileWithTokenQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFileWithToken>>>;
+type GetProjectFileWithTokenQueryError = ErrorType<DmError>;
+/**
+ * @summary Download a Project file using a Token
+ */
+declare const useGetProjectFileWithToken: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
+    query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+
+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 };

package/project/project.d.ts

@@ -1,6 +1,6 @@
-import { t as GetProjectsParams, bX as customInstance, bg as ProjectsGetResponse, bY as ErrorType, bT as DmError, a7 as ProjectPostBodyBody, bh as ProjectPostResponse, az as ProjectDetail, a8 as ProjectPatchBodyBody, at as TaskIdentity, s as GetProjectFileParams, a9 as ProjectFilePutBodyBody, r as GetProjectFileWithTokenParams } from '../custom-instance-50c9dd5d.js';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from '@tanstack/react-query';
+import { t as GetProjectsParams, bX as customInstance, bg as ProjectsGetResponse, bY as ErrorType, bT as DmError, a7 as ProjectPostBodyBody, bh as ProjectPostResponse, az as ProjectDetail, a8 as ProjectPatchBodyBody, at as TaskIdentity, s as GetProjectFileParams, a9 as ProjectFilePutBodyBody, r as GetProjectFileWithTokenParams } from '../custom-instance-3d66fe97.js';
 import 'axios';
 
 type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
@@ -17,6 +17,9 @@ declare const getGetProjectsQueryOptions: <TData = ProjectsGetResponse, TError =
 };
 type GetProjectsQueryResult = NonNullable<Awaited<ReturnType<typeof getProjects>>>;
 type GetProjectsQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Get all Projects available to you
+ */
 declare const useGetProjects: <TData = ProjectsGetResponse, TError = ErrorType<void | DmError>>(params?: GetProjectsParams, options?: {
     query?: UseQueryOptions<ProjectsGetResponse, TError, TData, QueryKey> | undefined;
     request?: SecondParameter<typeof customInstance>;
@@ -46,6 +49,9 @@ declare const getCreateProjectMutationOptions: <TError = ErrorType<void | DmErro
 type CreateProjectMutationResult = NonNullable<Awaited<ReturnType<typeof createProject>>>;
 type CreateProjectMutationBody = ProjectPostBodyBody;
 type CreateProjectMutationError = ErrorType<DmError | void>;
+/**
+* @summary Create a new Project
+*/
 declare const useCreateProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<ProjectPostResponse, TError, {
         data: ProjectPostBodyBody;
@@ -55,10 +61,10 @@ declare const useCreateProject: <TError = ErrorType<void | DmError>, TContext =
     data: ProjectPostBodyBody;
 }, TContext>;
 /**
- * Gets the details of a Project that is available to you.
+* Gets the details of a Project that is available to you.
 
- * @summary Get a Project
- */
+* @summary Get a Project
+*/
 declare const getProject: (projectId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<ProjectDetail>;
 declare const getGetProjectQueryKey: (projectId: string) => readonly ["data-manager-api", `/project/${string}`];
 declare const getGetProjectQueryOptions: <TData = ProjectDetail, TError = ErrorType<void | DmError>>(projectId: string, options?: {
@@ -69,6 +75,9 @@ declare const getGetProjectQueryOptions: <TData = ProjectDetail, TError = ErrorT
 };
 type GetProjectQueryResult = NonNullable<Awaited<ReturnType<typeof getProject>>>;
 type GetProjectQueryError = ErrorType<void | DmError>;
+/**
+ * @summary Get a Project
+ */
 declare const useGetProject: <TData = ProjectDetail, TError = ErrorType<void | DmError>>(projectId: string, options?: {
     query?: UseQueryOptions<ProjectDetail, TError, TData, QueryKey> | undefined;
     request?: SecondParameter<typeof customInstance>;
@@ -94,6 +103,9 @@ declare const getPatchProjectMutationOptions: <TError = ErrorType<DmError>, TCon
 type PatchProjectMutationResult = NonNullable<Awaited<ReturnType<typeof patchProject>>>;
 type PatchProjectMutationBody = ProjectPatchBodyBody;
 type PatchProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Adjust an existing Project
+*/
 declare const usePatchProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
         projectId: string;
@@ -105,14 +117,14 @@ declare const usePatchProject: <TError = ErrorType<DmError>, TContext = unknown>
     data: ProjectPatchBodyBody;
 }, TContext>;
 /**
- * Deletes an existing Project.
+* Deletes an existing Project.
 
 You must be an `editor` or the `owner` of the project.
 
 Once deleted all **Files**, working directories and material in the Project will also be removed
 
- * @summary Delete a Project
- */
+* @summary Delete a Project
+*/
 declare const deleteProject: (projectId: string, options?: SecondParameter<typeof customInstance>) => Promise<TaskIdentity>;
 declare const getDeleteProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<TaskIdentity, TError, {
@@ -124,6 +136,9 @@ declare const getDeleteProjectMutationOptions: <TError = ErrorType<void | DmErro
 }, TContext>;
 type DeleteProjectMutationResult = NonNullable<Awaited<ReturnType<typeof deleteProject>>>;
 type DeleteProjectMutationError = ErrorType<void | DmError>;
+/**
+* @summary Delete a Project
+*/
 declare const useDeleteProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<TaskIdentity, TError, {
         projectId: string;
@@ -133,14 +148,14 @@ declare const useDeleteProject: <TError = ErrorType<void | DmError>, TContext =
     projectId: string;
 }, TContext>;
 /**
- * Adds a user to a Project as an `editor`. Editors can add and remove datasets in a project and delete the project.
+* Adds a user to a Project as an `editor`. Editors can add and remove datasets in a project and delete the project.
 
 An `editor` of a project is not automatically an `editor` of any datasets the project contains.
 
 You must be an `editor` or the `owner` of the project
 
- * @summary Add a Project Editor
- */
+* @summary Add a Project Editor
+*/
 declare const addEditorToProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
 declare const getAddEditorToProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
@@ -154,6 +169,9 @@ declare const getAddEditorToProjectMutationOptions: <TError = ErrorType<DmError>
 }, TContext>;
 type AddEditorToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addEditorToProject>>>;
 type AddEditorToProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Add a Project Editor
+*/
 declare const useAddEditorToProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
         projectId: string;
@@ -165,14 +183,14 @@ declare const useAddEditorToProject: <TError = ErrorType<DmError>, TContext = un
     userId: string;
 }, TContext>;
 /**
- * Deletes a project `editor`. The editor can be you.
+* Deletes a project `editor`. The editor can be you.
 
 A project must always have one `editor` so you will not be able to delete the last editor of a project.
 
 You must be an `editor` or the `owner` of the project
 
- * @summary Delete a Project Editor
- */
+* @summary Delete a Project Editor
+*/
 declare const removeEditorFromProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
 declare const getRemoveEditorFromProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
@@ -186,6 +204,9 @@ declare const getRemoveEditorFromProjectMutationOptions: <TError = ErrorType<DmE
 }, TContext>;
 type RemoveEditorFromProjectMutationResult = NonNullable<Awaited<ReturnType<typeof removeEditorFromProject>>>;
 type RemoveEditorFromProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Delete a Project Editor
+*/
 declare const useRemoveEditorFromProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
         projectId: string;
@@ -197,12 +218,12 @@ declare const useRemoveEditorFromProject: <TError = ErrorType<DmError>, TContext
     userId: string;
 }, TContext>;
 /**
- * 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**.
+* 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**.
 
 You must be an `editor` or the `owner` of the Project to add Observers
 
- * @summary Add a Project Observer
- */
+* @summary Add a Project Observer
+*/
 declare const addObserverToProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
 declare const getAddObserverToProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
@@ -216,6 +237,9 @@ declare const getAddObserverToProjectMutationOptions: <TError = ErrorType<DmErro
 }, TContext>;
 type AddObserverToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addObserverToProject>>>;
 type AddObserverToProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Add a Project Observer
+*/
 declare const useAddObserverToProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
         projectId: string;
@@ -227,12 +251,12 @@ declare const useAddObserverToProject: <TError = ErrorType<DmError>, TContext =
     userId: string;
 }, TContext>;
 /**
- * Deletes a project `observer`.
+* Deletes a project `observer`.
 
 You must be an `editor` or the `owner` of the Project to remove Observers
 
- * @summary Delete a Project Observer
- */
+* @summary Delete a Project Observer
+*/
 declare const removeObserverFromProject: (projectId: string, userId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
 declare const getRemoveObserverFromProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
@@ -246,6 +270,9 @@ declare const getRemoveObserverFromProjectMutationOptions: <TError = ErrorType<D
 }, TContext>;
 type RemoveObserverFromProjectMutationResult = NonNullable<Awaited<ReturnType<typeof removeObserverFromProject>>>;
 type RemoveObserverFromProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Delete a Project Observer
+*/
 declare const useRemoveObserverFromProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
         projectId: string;
@@ -257,14 +284,14 @@ declare const useRemoveObserverFromProject: <TError = ErrorType<DmError>, TConte
     userId: string;
 }, TContext>;
 /**
- * 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).
+* 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).
 
 For **managed** files you should consider using the `/file/{file_id}` endpoint.
 
 You must be an `editor` or the `owner` of the Project if the Project is `private`
 
- * @summary Download a Project file
- */
+* @summary Download a Project file
+*/
 declare const getProjectFile: (projectId: string, params: GetProjectFileParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
 declare const getGetProjectFileQueryKey: (projectId: string, params: GetProjectFileParams) => readonly ["data-manager-api", `/project/${string}/file`, ...GetProjectFileParams[]];
 declare const getGetProjectFileQueryOptions: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileParams, options?: {
@@ -275,6 +302,9 @@ declare const getGetProjectFileQueryOptions: <TData = void, TError = ErrorType<D
 };
 type GetProjectFileQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFile>>>;
 type GetProjectFileQueryError = ErrorType<DmError>;
+/**
+ * @summary Download a Project file
+ */
 declare const useGetProjectFile: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileParams, options?: {
     query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
     request?: SecondParameter<typeof customInstance>;
@@ -302,6 +332,9 @@ declare const getAddFileToProjectMutationOptions: <TError = ErrorType<DmError>,
 type AddFileToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addFileToProject>>>;
 type AddFileToProjectMutationBody = ProjectFilePutBodyBody;
 type AddFileToProjectMutationError = ErrorType<DmError>;
+/**
+* @summary Upload a file into a Project
+*/
 declare const useAddFileToProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
     mutation?: UseMutationOptions<void, TError, {
         projectId: string;
@@ -313,14 +346,14 @@ declare const useAddFileToProject: <TError = ErrorType<DmError>, TContext = unkn
     data: ProjectFilePutBodyBody;
 }, TContext>;
 /**
- * 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).
+* 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).
 
 For **managed** files you should consider using the `/file/{file_id}` endpoint.
 
 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.
 
- * @summary Download a Project file using a Token
- */
+* @summary Download a Project file using a Token
+*/
 declare const getProjectFileWithToken: (projectId: string, params: GetProjectFileWithTokenParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
 declare const getGetProjectFileWithTokenQueryKey: (projectId: string, params: GetProjectFileWithTokenParams) => readonly ["data-manager-api", `/project/${string}/file-with-token`, ...GetProjectFileWithTokenParams[]];
 declare const getGetProjectFileWithTokenQueryOptions: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
@@ -331,6 +364,9 @@ declare const getGetProjectFileWithTokenQueryOptions: <TData = void, TError = Er
 };
 type GetProjectFileWithTokenQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFileWithToken>>>;
 type GetProjectFileWithTokenQueryError = ErrorType<DmError>;
+/**
+ * @summary Download a Project file using a Token
+ */
 declare const useGetProjectFileWithToken: <TData = void, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
     query?: UseQueryOptions<void, TError, TData, QueryKey> | undefined;
     request?: SecondParameter<typeof customInstance>;