@squonk/data-manager-client 4.2.0 → 5.0.0-5-0.2173777171

package/file-and-path/file-and-path.d.ts

@@ -1,8 +1,8 @@
-import { UseMutationOptions, UseMutationResult, UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
-import { CreatePathParams, customInstance, ErrorType, DmError, DeletePathParams, MovePathParams, GetFilesParams, FilesGetResponse, FilePostBodyBody, FilePostResponse, DeleteUnmanagedFileParams, MoveFileInProjectParams } from '../index.js';
+import { UseMutationOptions, QueryClient, UseMutationResult, UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
+import { CreatePathParams, customInstance, ErrorType, DmError, DeletePathParams, MovePathParams, GetProjectFileParams, ProjectFilePutBodyBody, GetProjectFileWithTokenParams, GetFilesParams, FilesGetResponse, FilePostBodyBody, FilePostResponse, DeleteUnmanagedFileParams, MoveFileInProjectParams } from '../index.js';
 import 'axios';
 
-type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 /**
  * Creates a new Path within a Project. Every directory in the Path will be created. The path will belong to the User and Project.
 
@@ -11,93 +11,253 @@ Only Project editors can create Paths.
  * @summary Create a new Project Path
  */
 declare const createPath: (params: CreatePathParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getCreatePathMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+declare const useCreatePathMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError, {
         params: CreatePathParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<TData, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError, {
     params: CreatePathParams;
 }, TContext>;
 type CreatePathMutationResult = NonNullable<Awaited<ReturnType<typeof createPath>>>;
 type CreatePathMutationError = ErrorType<void | DmError>;
 /**
-* @summary Create a new Project Path
-*/
-declare const useCreatePath: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+ * @summary Create a new Project Path
+ */
+declare const useCreatePath: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError, {
         params: CreatePathParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<TData, TError, {
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createPath>>, TError, {
     params: CreatePathParams;
 }, TContext>;
 /**
-* Deletes a Path within the Project. Be aware that the deletion of a Path will result in the contents of the Path also being deleted. If there are files in Path or sub-directories, they will all be deleted.
+ * Deletes a Path within the Project. Be aware that the deletion of a Path will result in the contents of the Path also being deleted. If there are files in Path or sub-directories, they will all be deleted.
 
 Only Project editors can delete Paths.
 
-* @summary Delete a Project Path
-*/
+ * @summary Delete a Project Path
+ */
 declare const deletePath: (params: DeletePathParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getDeletePathMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+declare const useDeletePathMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError, {
         params: DeletePathParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<TData, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError, {
     params: DeletePathParams;
 }, TContext>;
 type DeletePathMutationResult = NonNullable<Awaited<ReturnType<typeof deletePath>>>;
 type DeletePathMutationError = ErrorType<void | DmError>;
 /**
-* @summary Delete a Project Path
-*/
-declare const useDeletePath: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+ * @summary Delete a Project Path
+ */
+declare const useDeletePath: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError, {
         params: DeletePathParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<TData, TError, {
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deletePath>>, TError, {
     params: DeletePathParams;
 }, TContext>;
 /**
-* Moves and existing Path within a Project. The path will belong to the User and Project. Any ProjectFile instances on the path will be moved to the new path.
+ * Moves and existing Path within a Project. The path will belong to the User and Project. Any ProjectFile instances on the path will be moved to the new path.
 
 Only Project editors can move Paths.
 
-* @summary Move a Project Path
-*/
+ * @summary Move a Project Path
+ */
 declare const movePath: (params: MovePathParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getMovePathMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+declare const useMovePathMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof movePath>>, TError, {
         params: MovePathParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<TData, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof movePath>>, TError, {
     params: MovePathParams;
 }, TContext>;
 type MovePathMutationResult = NonNullable<Awaited<ReturnType<typeof movePath>>>;
 type MovePathMutationError = ErrorType<void | DmError>;
 /**
-* @summary Move a Project Path
-*/
-declare const useMovePath: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+ * @summary Move a Project Path
+ */
+declare const useMovePath: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof movePath>>, TError, {
         params: MovePathParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<TData, TError, {
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof movePath>>, TError, {
     params: MovePathParams;
 }, TContext>;
 /**
-* Given a Project and Path the files available to you on that path will be returned along with any additional paths (sub-directories).
+ * 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` 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 [`/project/${string}/file`, ...GetProjectFileParams[]];
+declare const useGetProjectFileQueryOptions: <TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetProjectFileQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFile>>>;
+type GetProjectFileQueryError = ErrorType<void | DmError>;
+declare function useGetProjectFile<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, Awaited<ReturnType<typeof getProjectFile>>>, "initialData">;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetProjectFile<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, Awaited<ReturnType<typeof getProjectFile>>>, "initialData">;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetProjectFile<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare const useGetProjectFileSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetProjectFileSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFile>>>;
+type GetProjectFileSuspenseQueryError = ErrorType<void | DmError>;
+declare function useGetProjectFileSuspense<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetProjectFileSuspense<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetProjectFileSuspense<TData = Awaited<ReturnType<typeof getProjectFile>>, TError = ErrorType<void | DmError>>(projectId: string, params: GetProjectFileParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFile>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * 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` of the project
 
-* @summary Gets the Files on a Project Path
-*/
+ * @summary Upload a file into a Project
+ */
+declare const addFileToProject: (projectId: string, projectFilePutBodyBody: ProjectFilePutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const useAddFileToProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof addFileToProject>>, TError, {
+        projectId: string;
+        data: ProjectFilePutBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof addFileToProject>>, TError, {
+    projectId: string;
+    data: ProjectFilePutBodyBody;
+}, TContext>;
+type AddFileToProjectMutationResult = NonNullable<Awaited<ReturnType<typeof addFileToProject>>>;
+type AddFileToProjectMutationBody = ProjectFilePutBodyBody;
+type AddFileToProjectMutationError = ErrorType<void | DmError>;
+/**
+ * @summary Upload a file into a Project
+ */
+declare const useAddFileToProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof addFileToProject>>, TError, {
+        projectId: string;
+        data: ProjectFilePutBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof addFileToProject>>, 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 [`/project/${string}/file-with-token`, ...GetProjectFileWithTokenParams[]];
+declare const useGetProjectFileWithTokenQueryOptions: <TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetProjectFileWithTokenQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFileWithToken>>>;
+type GetProjectFileWithTokenQueryError = ErrorType<DmError>;
+declare function useGetProjectFileWithToken<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, Awaited<ReturnType<typeof getProjectFileWithToken>>>, "initialData">;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetProjectFileWithToken<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, Awaited<ReturnType<typeof getProjectFileWithToken>>>, "initialData">;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetProjectFileWithToken<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare const useGetProjectFileWithTokenSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetProjectFileWithTokenSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getProjectFileWithToken>>>;
+type GetProjectFileWithTokenSuspenseQueryError = ErrorType<DmError>;
+declare function useGetProjectFileWithTokenSuspense<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetProjectFileWithTokenSuspense<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetProjectFileWithTokenSuspense<TData = Awaited<ReturnType<typeof getProjectFileWithToken>>, TError = ErrorType<DmError>>(projectId: string, params: GetProjectFileWithTokenParams, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getProjectFileWithToken>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * Given a Project and Path the files available to you on that path will be returned along with any additional paths (sub-directories).
+
+ * @summary Gets the Files on a Project Path
+ */
 declare const getFiles: (params: GetFilesParams, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<FilesGetResponse>;
-declare const getGetFilesQueryKey: (params: GetFilesParams) => readonly ["data-manager-api", "/file", ...GetFilesParams[]];
-declare const getGetFilesQueryOptions: <TData = FilesGetResponse, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
+declare const getGetFilesQueryKey: (params: GetFilesParams) => readonly ["/file", ...GetFilesParams[]];
+declare const useGetFilesQueryOptions: <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }) => UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData> & {
@@ -106,24 +266,24 @@ declare const getGetFilesQueryOptions: <TData = FilesGetResponse, TError = Error
 type GetFilesQueryResult = NonNullable<Awaited<ReturnType<typeof getFiles>>>;
 type GetFilesQueryError = ErrorType<void | DmError>;
 declare function useGetFiles<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options: {
-    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>, 'initialData'>;
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getFiles>>, TError, Awaited<ReturnType<typeof getFiles>>>, "initialData">;
     request?: SecondParameter<typeof customInstance>;
-}): DefinedUseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetFiles<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>, 'initialData'>;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getFiles>>, TError, Awaited<ReturnType<typeof getFiles>>>, "initialData">;
     request?: SecondParameter<typeof customInstance>;
-}): UseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetFiles<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-}): UseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
-declare const getGetFilesSuspenseQueryOptions: <TData = FilesGetResponse, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
+declare const useGetFilesSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData> & {
@@ -134,19 +294,19 @@ type GetFilesSuspenseQueryError = ErrorType<void | DmError>;
 declare function useGetFilesSuspense<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options: {
     query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-}): UseSuspenseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetFilesSuspense<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-}): UseSuspenseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useGetFilesSuspense<TData = Awaited<ReturnType<typeof getFiles>>, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-}): UseSuspenseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 /**
@@ -163,127 +323,127 @@ You cannot add a Dataset to a Project until its upload is complete.
  * @summary Attach a Dataset, as a File, to a Project
  */
 declare const attachFile: (filePostBodyBody: FilePostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<FilePostResponse>;
-declare const getAttachFileMutationOptions: <TData = FilePostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+declare const useAttachFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError, {
         data: FilePostBodyBody;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<TData, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError, {
     data: FilePostBodyBody;
 }, TContext>;
 type AttachFileMutationResult = NonNullable<Awaited<ReturnType<typeof attachFile>>>;
 type AttachFileMutationBody = FilePostBodyBody;
 type AttachFileMutationError = ErrorType<void | DmError>;
 /**
-* @summary Attach a Dataset, as a File, to a Project
-*/
-declare const useAttachFile: <TData = FilePostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+ * @summary Attach a Dataset, as a File, to a Project
+ */
+declare const useAttachFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError, {
         data: FilePostBodyBody;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<TData, TError, {
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof attachFile>>, TError, {
     data: FilePostBodyBody;
 }, TContext>;
 /**
-* Removes an unmanaged file from a Project. You cannot use this endpoint to delete managed project files.
+ * Removes an unmanaged file from a Project. You cannot use this endpoint to delete managed project files.
 
 You must be an `editor` of the Project to delete a file from a Project.
 
-* @summary Delete an unmanaged Project File
-*/
+ * @summary Delete an unmanaged Project File
+ */
 declare const deleteUnmanagedFile: (params: DeleteUnmanagedFileParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getDeleteUnmanagedFileMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+declare const useDeleteUnmanagedFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
         params: DeleteUnmanagedFileParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<TData, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
     params: DeleteUnmanagedFileParams;
 }, TContext>;
 type DeleteUnmanagedFileMutationResult = NonNullable<Awaited<ReturnType<typeof deleteUnmanagedFile>>>;
 type DeleteUnmanagedFileMutationError = ErrorType<void | DmError>;
 /**
-* @summary Delete an unmanaged Project File
-*/
-declare const useDeleteUnmanagedFile: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+ * @summary Delete an unmanaged Project File
+ */
+declare const useDeleteUnmanagedFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
         params: DeleteUnmanagedFileParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<TData, TError, {
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
     params: DeleteUnmanagedFileParams;
 }, TContext>;
 /**
-* Move an **Unmanaged** file, optionally renaming it, to a new path.
+ * Move an **Unmanaged** file, optionally renaming it, to a new path.
 
 You must be an `editor` of the project
 
-* @summary Move an unmanaged file in a Project
-*/
+ * @summary Move an unmanaged file in a Project
+ */
 declare const moveFileInProject: (params: MoveFileInProjectParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getMoveFileInProjectMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+declare const useMoveFileInProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
         params: MoveFileInProjectParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<TData, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
     params: MoveFileInProjectParams;
 }, TContext>;
 type MoveFileInProjectMutationResult = NonNullable<Awaited<ReturnType<typeof moveFileInProject>>>;
 type MoveFileInProjectMutationError = ErrorType<void | DmError>;
 /**
-* @summary Move an unmanaged file in a Project
-*/
-declare const useMoveFileInProject: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+ * @summary Move an unmanaged file in a Project
+ */
+declare const useMoveFileInProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
         params: MoveFileInProjectParams;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<TData, TError, {
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
     params: MoveFileInProjectParams;
 }, TContext>;
 /**
-* Given a `file_id` the file will be removed from the Project it's attached to.
+ * Given a `file_id` the file will be removed from the Project it's attached to.
 
 You must be an `editor` of the project to delete a file from a Project. Being an `editor` of the original Dataset does not give you the ability to detach it from the Project.
 
 You cannot delete a Project File until the attach is complete.
 
-* @summary Delete/detach a File (from a Project)
-*/
+ * @summary Delete/detach a File (from a Project)
+ */
 declare const deleteFile: (fileId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getDeleteFileMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+declare const useDeleteFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError, {
         fileId: string;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationOptions<TData, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError, {
     fileId: string;
 }, TContext>;
 type DeleteFileMutationResult = NonNullable<Awaited<ReturnType<typeof deleteFile>>>;
 type DeleteFileMutationError = ErrorType<void | DmError>;
 /**
-* @summary Delete/detach a File (from a Project)
-*/
-declare const useDeleteFile: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<TData, TError, {
+ * @summary Delete/detach a File (from a Project)
+ */
+declare const useDeleteFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError, {
         fileId: string;
     }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-}) => UseMutationResult<TData, TError, {
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteFile>>, TError, {
     fileId: string;
 }, TContext>;
 /**
-* Given a `file_id` the file will be returned if available.
+ * Given a `file_id` the file will be returned if available.
 
 You cannot get a Project File until the attach is complete.
 
-* @summary Download a File (from a project)
-*/
+ * @summary Download a File (from a project)
+ */
 declare const downloadFile: (fileId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<void>;
-declare const getDownloadFileQueryKey: (fileId: string) => readonly ["data-manager-api", `/file/${string}`];
-declare const getDownloadFileQueryOptions: <TData = void, TError = ErrorType<void | DmError>>(fileId: string, options?: {
+declare const getDownloadFileQueryKey: (fileId: string) => readonly [`/file/${string}`];
+declare const useDownloadFileQueryOptions: <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }) => UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData> & {
@@ -292,24 +452,24 @@ declare const getDownloadFileQueryOptions: <TData = void, TError = ErrorType<voi
 type DownloadFileQueryResult = NonNullable<Awaited<ReturnType<typeof downloadFile>>>;
 type DownloadFileQueryError = ErrorType<void | DmError>;
 declare function useDownloadFile<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options: {
-    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>, 'initialData'>;
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof downloadFile>>, TError, Awaited<ReturnType<typeof downloadFile>>>, "initialData">;
     request?: SecondParameter<typeof customInstance>;
-}): DefinedUseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useDownloadFile<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>, 'initialData'>;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof downloadFile>>, TError, Awaited<ReturnType<typeof downloadFile>>>, "initialData">;
     request?: SecondParameter<typeof customInstance>;
-}): UseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useDownloadFile<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
     query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-}): UseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
-declare const getDownloadFileSuspenseQueryOptions: <TData = void, TError = ErrorType<void | DmError>>(fileId: string, options?: {
+declare const useDownloadFileSuspenseQueryOptions: <TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
 }) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData> & {
@@ -320,20 +480,20 @@ type DownloadFileSuspenseQueryError = ErrorType<void | DmError>;
 declare function useDownloadFileSuspense<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options: {
     query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-}): UseSuspenseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useDownloadFileSuspense<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-}): UseSuspenseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 declare function useDownloadFileSuspense<TData = Awaited<ReturnType<typeof downloadFile>>, TError = ErrorType<void | DmError>>(fileId: string, options?: {
     query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-}): UseSuspenseQueryResult<TData, TError> & {
+}, queryClient?: QueryClient): UseSuspenseQueryResult<TData, TError> & {
     queryKey: DataTag<QueryKey, TData, TError>;
 };
 
-export { type AttachFileMutationBody, type AttachFileMutationError, type AttachFileMutationResult, type CreatePathMutationError, type CreatePathMutationResult, type DeleteFileMutationError, type DeleteFileMutationResult, type DeletePathMutationError, type DeletePathMutationResult, type DeleteUnmanagedFileMutationError, type DeleteUnmanagedFileMutationResult, type DownloadFileQueryError, type DownloadFileQueryResult, type DownloadFileSuspenseQueryError, type DownloadFileSuspenseQueryResult, type GetFilesQueryError, type GetFilesQueryResult, type GetFilesSuspenseQueryError, type GetFilesSuspenseQueryResult, type MoveFileInProjectMutationError, type MoveFileInProjectMutationResult, type MovePathMutationError, type MovePathMutationResult, attachFile, createPath, deleteFile, deletePath, deleteUnmanagedFile, downloadFile, getAttachFileMutationOptions, getCreatePathMutationOptions, getDeleteFileMutationOptions, getDeletePathMutationOptions, getDeleteUnmanagedFileMutationOptions, getDownloadFileQueryKey, getDownloadFileQueryOptions, getDownloadFileSuspenseQueryOptions, getFiles, getGetFilesQueryKey, getGetFilesQueryOptions, getGetFilesSuspenseQueryOptions, getMoveFileInProjectMutationOptions, getMovePathMutationOptions, moveFileInProject, movePath, useAttachFile, useCreatePath, useDeleteFile, useDeletePath, useDeleteUnmanagedFile, useDownloadFile, useDownloadFileSuspense, useGetFiles, useGetFilesSuspense, useMoveFileInProject, useMovePath };
+export { type AddFileToProjectMutationBody, type AddFileToProjectMutationError, type AddFileToProjectMutationResult, type AttachFileMutationBody, type AttachFileMutationError, type AttachFileMutationResult, type CreatePathMutationError, type CreatePathMutationResult, type DeleteFileMutationError, type DeleteFileMutationResult, type DeletePathMutationError, type DeletePathMutationResult, type DeleteUnmanagedFileMutationError, type DeleteUnmanagedFileMutationResult, type DownloadFileQueryError, type DownloadFileQueryResult, type DownloadFileSuspenseQueryError, type DownloadFileSuspenseQueryResult, type GetFilesQueryError, type GetFilesQueryResult, type GetFilesSuspenseQueryError, type GetFilesSuspenseQueryResult, type GetProjectFileQueryError, type GetProjectFileQueryResult, type GetProjectFileSuspenseQueryError, type GetProjectFileSuspenseQueryResult, type GetProjectFileWithTokenQueryError, type GetProjectFileWithTokenQueryResult, type GetProjectFileWithTokenSuspenseQueryError, type GetProjectFileWithTokenSuspenseQueryResult, type MoveFileInProjectMutationError, type MoveFileInProjectMutationResult, type MovePathMutationError, type MovePathMutationResult, addFileToProject, attachFile, createPath, deleteFile, deletePath, deleteUnmanagedFile, downloadFile, getDownloadFileQueryKey, getFiles, getGetFilesQueryKey, getGetProjectFileQueryKey, getGetProjectFileWithTokenQueryKey, getProjectFile, getProjectFileWithToken, moveFileInProject, movePath, useAddFileToProject, useAddFileToProjectMutationOptions, useAttachFile, useAttachFileMutationOptions, useCreatePath, useCreatePathMutationOptions, useDeleteFile, useDeleteFileMutationOptions, useDeletePath, useDeletePathMutationOptions, useDeleteUnmanagedFile, useDeleteUnmanagedFileMutationOptions, useDownloadFile, useDownloadFileQueryOptions, useDownloadFileSuspense, useDownloadFileSuspenseQueryOptions, useGetFiles, useGetFilesQueryOptions, useGetFilesSuspense, useGetFilesSuspenseQueryOptions, useGetProjectFile, useGetProjectFileQueryOptions, useGetProjectFileSuspense, useGetProjectFileSuspenseQueryOptions, useGetProjectFileWithToken, useGetProjectFileWithTokenQueryOptions, useGetProjectFileWithTokenSuspense, useGetProjectFileWithTokenSuspenseQueryOptions, useMoveFileInProject, useMoveFileInProjectMutationOptions, useMovePath, useMovePathMutationOptions };