@squonk/data-manager-client 3.1.0-beta.2 → 3.1.0

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

@@ -1,5 +1,4 @@
-import * as _tanstack_react_query_build_legacy_types from '@tanstack/react-query/build/legacy/types';
-import { UseMutationOptions, UseQueryOptions, QueryKey, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult } from '@tanstack/react-query';
+import { UseMutationOptions, UseMutationResult, UseQueryOptions, 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.cjs';
 import 'axios';
 
@@ -12,25 +11,25 @@ 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: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const getCreatePathMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError, {
         params: CreatePathParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<void, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError, {
     params: CreatePathParams;
 }, TContext>;
 type CreatePathMutationResult = NonNullable<Awaited<ReturnType<typeof createPath>>>;
-type CreatePathMutationError = ErrorType<DmError>;
+type CreatePathMutationError = ErrorType<void | DmError>;
 /**
 * @summary Create a new Project Path
 */
-declare const useCreatePath: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const useCreatePath: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createPath>>, TError, {
         params: CreatePathParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof createPath>>, TError, {
     params: CreatePathParams;
 }, TContext>;
 /**
@@ -41,25 +40,25 @@ Only Project editors can delete Paths.
 * @summary Delete a Project Path
 */
 declare const deletePath: (params: DeletePathParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getDeletePathMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const getDeletePathMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError, {
         params: DeletePathParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<void, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError, {
     params: DeletePathParams;
 }, TContext>;
 type DeletePathMutationResult = NonNullable<Awaited<ReturnType<typeof deletePath>>>;
-type DeletePathMutationError = ErrorType<DmError>;
+type DeletePathMutationError = ErrorType<void | DmError>;
 /**
 * @summary Delete a Project Path
 */
-declare const useDeletePath: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const useDeletePath: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deletePath>>, TError, {
         params: DeletePathParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof deletePath>>, TError, {
     params: DeletePathParams;
 }, TContext>;
 /**
@@ -70,25 +69,25 @@ Only Project editors can move Paths.
 * @summary Move a Project Path
 */
 declare const movePath: (params: MovePathParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getMovePathMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const getMovePathMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof movePath>>, TError, {
         params: MovePathParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<void, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof movePath>>, TError, {
     params: MovePathParams;
 }, TContext>;
 type MovePathMutationResult = NonNullable<Awaited<ReturnType<typeof movePath>>>;
-type MovePathMutationError = ErrorType<DmError>;
+type MovePathMutationError = ErrorType<void | DmError>;
 /**
 * @summary Move a Project Path
 */
-declare const useMovePath: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const useMovePath: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof movePath>>, TError, {
         params: MovePathParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof movePath>>, TError, {
     params: MovePathParams;
 }, TContext>;
 /**
@@ -99,37 +98,55 @@ declare const useMovePath: <TError = ErrorType<DmError>, TContext = unknown>(opt
 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?: {
-    query?: Partial<UseQueryOptions<FilesGetResponse, TError, TData, QueryKey>> | undefined;
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryOptions<FilesGetResponse, TError, TData, QueryKey> & {
+}) => UseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type GetFilesQueryResult = NonNullable<Awaited<ReturnType<typeof getFiles>>>;
 type GetFilesQueryError = ErrorType<void | DmError>;
-/**
- * @summary Gets the Files on a Project Path
- */
-declare const useGetFiles: <TData = FilesGetResponse, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
-    query?: Partial<UseQueryOptions<FilesGetResponse, TError, TData, QueryKey>> | undefined;
+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'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+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'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+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>;
-} | undefined) => UseQueryResult<TData, TError> & {
+}): UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 declare const getGetFilesSuspenseQueryOptions: <TData = FilesGetResponse, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
-    query?: Partial<UseSuspenseQueryOptions<FilesGetResponse, TError, TData, QueryKey>> | undefined;
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryOptions<FilesGetResponse, TError, TData, QueryKey> & {
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getFiles>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type GetFilesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getFiles>>>;
 type GetFilesSuspenseQueryError = ErrorType<void | DmError>;
-/**
- * @summary Gets the Files on a Project Path
- */
-declare const useGetFilesSuspense: <TData = FilesGetResponse, TError = ErrorType<void | DmError>>(params: GetFilesParams, options?: {
-    query?: Partial<UseSuspenseQueryOptions<FilesGetResponse, TError, TData, QueryKey>> | undefined;
+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> & {
+    queryKey: QueryKey;
+};
+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> & {
+    queryKey: QueryKey;
+};
+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>;
-} | undefined) => UseSuspenseQueryResult<TData, TError> & {
+}): UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 /**
@@ -147,11 +164,11 @@ You cannot add a Dataset to a Project until its upload is complete.
  */
 declare const attachFile: (filePostBodyBody: FilePostBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<FilePostResponse>;
 declare const getAttachFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<FilePostResponse, TError, {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError, {
         data: FilePostBodyBody;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<FilePostResponse, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError, {
     data: FilePostBodyBody;
 }, TContext>;
 type AttachFileMutationResult = NonNullable<Awaited<ReturnType<typeof attachFile>>>;
@@ -161,11 +178,11 @@ type AttachFileMutationError = ErrorType<void | DmError>;
 * @summary Attach a Dataset, as a File, to a Project
 */
 declare const useAttachFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<FilePostResponse, TError, {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof attachFile>>, TError, {
         data: FilePostBodyBody;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<FilePostResponse, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof attachFile>>, TError, {
     data: FilePostBodyBody;
 }, TContext>;
 /**
@@ -176,25 +193,25 @@ You must be an `editor` of the Project to delete a file from a Project.
 * @summary Delete an unmanaged Project File
 */
 declare const deleteUnmanagedFile: (params: DeleteUnmanagedFileParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getDeleteUnmanagedFileMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const getDeleteUnmanagedFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
         params: DeleteUnmanagedFileParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<void, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
     params: DeleteUnmanagedFileParams;
 }, TContext>;
 type DeleteUnmanagedFileMutationResult = NonNullable<Awaited<ReturnType<typeof deleteUnmanagedFile>>>;
-type DeleteUnmanagedFileMutationError = ErrorType<DmError>;
+type DeleteUnmanagedFileMutationError = ErrorType<void | DmError>;
 /**
 * @summary Delete an unmanaged Project File
 */
-declare const useDeleteUnmanagedFile: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const useDeleteUnmanagedFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
         params: DeleteUnmanagedFileParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof deleteUnmanagedFile>>, TError, {
     params: DeleteUnmanagedFileParams;
 }, TContext>;
 /**
@@ -205,25 +222,25 @@ You must be an `editor` of the project
 * @summary Move an unmanaged file in a Project
 */
 declare const moveFileInProject: (params: MoveFileInProjectParams, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getMoveFileInProjectMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const getMoveFileInProjectMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
         params: MoveFileInProjectParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<void, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
     params: MoveFileInProjectParams;
 }, TContext>;
 type MoveFileInProjectMutationResult = NonNullable<Awaited<ReturnType<typeof moveFileInProject>>>;
-type MoveFileInProjectMutationError = ErrorType<DmError>;
+type MoveFileInProjectMutationError = ErrorType<void | DmError>;
 /**
 * @summary Move an unmanaged file in a Project
 */
-declare const useMoveFileInProject: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const useMoveFileInProject: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
         params: MoveFileInProjectParams;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof moveFileInProject>>, TError, {
     params: MoveFileInProjectParams;
 }, TContext>;
 /**
@@ -236,25 +253,25 @@ You cannot delete a Project File until the attach is complete.
 * @summary Delete/detach a File (from a Project)
 */
 declare const deleteFile: (fileId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
-declare const getDeleteFileMutationOptions: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const getDeleteFileMutationOptions: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError, {
         fileId: string;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseMutationOptions<void, TError, {
+}) => UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError, {
     fileId: string;
 }, TContext>;
 type DeleteFileMutationResult = NonNullable<Awaited<ReturnType<typeof deleteFile>>>;
-type DeleteFileMutationError = ErrorType<DmError>;
+type DeleteFileMutationError = ErrorType<void | DmError>;
 /**
 * @summary Delete/detach a File (from a Project)
 */
-declare const useDeleteFile: <TError = ErrorType<DmError>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<void, TError, {
+declare const useDeleteFile: <TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteFile>>, TError, {
         fileId: string;
-    }, TContext> | undefined;
+    }, TContext>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => _tanstack_react_query_build_legacy_types.UseMutationResult<void, TError, {
+}) => UseMutationResult<Awaited<ReturnType<typeof deleteFile>>, TError, {
     fileId: string;
 }, TContext>;
 /**
@@ -266,38 +283,56 @@ You cannot get a Project File until the attach is complete.
 */
 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<DmError>>(fileId: string, options?: {
-    query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
+declare const getDownloadFileQueryOptions: <TData = void, TError = ErrorType<void | DmError>>(fileId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseQueryOptions<void, TError, TData, QueryKey> & {
+}) => UseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type DownloadFileQueryResult = NonNullable<Awaited<ReturnType<typeof downloadFile>>>;
-type DownloadFileQueryError = ErrorType<DmError>;
-/**
- * @summary Download a File (from a project)
- */
-declare const useDownloadFile: <TData = void, TError = ErrorType<DmError>>(fileId: string, options?: {
-    query?: Partial<UseQueryOptions<void, TError, TData, QueryKey>> | undefined;
+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'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+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'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+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>;
-} | undefined) => UseQueryResult<TData, TError> & {
+}): UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
-declare const getDownloadFileSuspenseQueryOptions: <TData = void, TError = ErrorType<DmError>>(fileId: string, options?: {
-    query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
+declare const getDownloadFileSuspenseQueryOptions: <TData = void, TError = ErrorType<void | DmError>>(fileId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData>>;
     request?: SecondParameter<typeof customInstance>;
-} | undefined) => UseSuspenseQueryOptions<void, TError, TData, QueryKey> & {
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof downloadFile>>, TError, TData> & {
     queryKey: QueryKey;
 };
 type DownloadFileSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof downloadFile>>>;
-type DownloadFileSuspenseQueryError = ErrorType<DmError>;
-/**
- * @summary Download a File (from a project)
- */
-declare const useDownloadFileSuspense: <TData = void, TError = ErrorType<DmError>>(fileId: string, options?: {
-    query?: Partial<UseSuspenseQueryOptions<void, TError, TData, QueryKey>> | undefined;
+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> & {
+    queryKey: QueryKey;
+};
+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> & {
+    queryKey: QueryKey;
+};
+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>;
-} | undefined) => UseSuspenseQueryResult<TData, TError> & {
+}): UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };