@squonk/data-manager-client 0.7.3 → 0.7.8-rc.1

package/src/project/project.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.6.0 🍺
+ * Generated by orval v6.7.1 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -62,6 +62,11 @@ export const getProjects = (
 
 export const getGetProjectsQueryKey = () => [`/project`];
 
+export type GetProjectsQueryResult = NonNullable<
+  AsyncReturnType<typeof getProjects>
+>;
+export type GetProjectsQueryError = ErrorType<void | DmError>;
+
 export const useGetProjects = <
   TData = AsyncReturnType<typeof getProjects>,
   TError = ErrorType<void | DmError>
@@ -113,11 +118,22 @@ export const createProject = (
   formData.append("tier_product_id", projectPostBodyBody.tier_product_id);
 
   return customInstance<ProjectPostResponse>(
-    { url: `/project`, method: "post", data: formData },
+    {
+      url: `/project`,
+      method: "post",
+      headers: { "Content-Type": "multipart/form-data" },
+      data: formData,
+    },
     options
   );
 };
 
+export type CreateProjectMutationResult = NonNullable<
+  AsyncReturnType<typeof createProject>
+>;
+export type CreateProjectMutationBody = ProjectPostBodyBody;
+export type CreateProjectMutationError = ErrorType<DmError | void>;
+
 export const useCreateProject = <
   TError = ErrorType<DmError | void>,
   TContext = unknown
@@ -154,24 +170,29 @@ export const useCreateProject = <
  * @summary Get a project
  */
 export const getProject = (
-  projectid: string,
+  projectId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<ProjectGetResponse>(
-    { url: `/project/${projectid}`, method: "get" },
+    { url: `/project/${projectId}`, method: "get" },
     options
   );
 };
 
-export const getGetProjectQueryKey = (projectid: string) => [
-  `/project/${projectid}`,
+export const getGetProjectQueryKey = (projectId: string) => [
+  `/project/${projectId}`,
 ];
 
+export type GetProjectQueryResult = NonNullable<
+  AsyncReturnType<typeof getProject>
+>;
+export type GetProjectQueryError = ErrorType<void | DmError>;
+
 export const useGetProject = <
   TData = AsyncReturnType<typeof getProject>,
   TError = ErrorType<void | DmError>
 >(
-  projectid: string,
+  projectId: string,
   options?: {
     query?: UseQueryOptions<AsyncReturnType<typeof getProject>, TError, TData>;
     request?: SecondParameter<typeof customInstance>;
@@ -179,15 +200,15 @@ export const useGetProject = <
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
   const { query: queryOptions, request: requestOptions } = options || {};
 
-  const queryKey = queryOptions?.queryKey ?? getGetProjectQueryKey(projectid);
+  const queryKey = queryOptions?.queryKey ?? getGetProjectQueryKey(projectId);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof getProject>> = () =>
-    getProject(projectid, requestOptions);
+    getProject(projectId, requestOptions);
 
   const query = useQuery<AsyncReturnType<typeof getProject>, TError, TData>(
     queryKey,
     queryFn,
-    { enabled: !!projectid, ...queryOptions }
+    { enabled: !!projectId, ...queryOptions }
   );
 
   return {
@@ -202,7 +223,7 @@ export const useGetProject = <
  * @summary Adjust an existing project
  */
 export const patchProject = (
-  projectid: string,
+  projectId: string,
   projectPatchBodyBody: ProjectPatchBodyBody,
   options?: SecondParameter<typeof customInstance>
 ) => {
@@ -215,11 +236,22 @@ export const patchProject = (
   }
 
   return customInstance<void>(
-    { url: `/project/${projectid}`, method: "patch", data: formData },
+    {
+      url: `/project/${projectId}`,
+      method: "patch",
+      headers: { "Content-Type": "multipart/form-data" },
+      data: formData,
+    },
     options
   );
 };
 
+export type PatchProjectMutationResult = NonNullable<
+  AsyncReturnType<typeof patchProject>
+>;
+export type PatchProjectMutationBody = ProjectPatchBodyBody;
+export type PatchProjectMutationError = ErrorType<DmError>;
+
 export const usePatchProject = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -227,7 +259,7 @@ export const usePatchProject = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof patchProject>,
     TError,
-    { projectid: string; data: ProjectPatchBodyBody },
+    { projectId: string; data: ProjectPatchBodyBody },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -236,17 +268,17 @@ export const usePatchProject = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof patchProject>,
-    { projectid: string; data: ProjectPatchBodyBody }
+    { projectId: string; data: ProjectPatchBodyBody }
   > = (props) => {
-    const { projectid, data } = props || {};
+    const { projectId, data } = props || {};
 
-    return patchProject(projectid, data, requestOptions);
+    return patchProject(projectId, data, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof patchProject>,
     TError,
-    { projectid: string; data: ProjectPatchBodyBody },
+    { projectId: string; data: ProjectPatchBodyBody },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -260,15 +292,21 @@ Once deleted all **Files**, working directories and material in the project will
  * @summary Delete a project
  */
 export const deleteProject = (
-  projectid: string,
+  projectId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<ProjectDeleteResponse>(
-    { url: `/project/${projectid}`, method: "delete" },
+    { url: `/project/${projectId}`, method: "delete" },
     options
   );
 };
 
+export type DeleteProjectMutationResult = NonNullable<
+  AsyncReturnType<typeof deleteProject>
+>;
+
+export type DeleteProjectMutationError = ErrorType<void | DmError>;
+
 export const useDeleteProject = <
   TError = ErrorType<void | DmError>,
   TContext = unknown
@@ -276,7 +314,7 @@ export const useDeleteProject = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof deleteProject>,
     TError,
-    { projectid: string },
+    { projectId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -285,17 +323,17 @@ export const useDeleteProject = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof deleteProject>,
-    { projectid: string }
+    { projectId: string }
   > = (props) => {
-    const { projectid } = props || {};
+    const { projectId } = props || {};
 
-    return deleteProject(projectid, requestOptions);
+    return deleteProject(projectId, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof deleteProject>,
     TError,
-    { projectid: string },
+    { projectId: string },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -309,16 +347,22 @@ You must be an `editor` or the `owner` of the project
  * @summary Add a project editor
  */
 export const addEditorToProject = (
-  projectid: string,
-  userid: string,
+  projectId: string,
+  userId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/project/${projectid}/editor/${userid}`, method: "put" },
+    { url: `/project/${projectId}/editor/${userId}`, method: "put" },
     options
   );
 };
 
+export type AddEditorToProjectMutationResult = NonNullable<
+  AsyncReturnType<typeof addEditorToProject>
+>;
+
+export type AddEditorToProjectMutationError = ErrorType<DmError>;
+
 export const useAddEditorToProject = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -326,7 +370,7 @@ export const useAddEditorToProject = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof addEditorToProject>,
     TError,
-    { projectid: string; userid: string },
+    { projectId: string; userId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -335,17 +379,17 @@ export const useAddEditorToProject = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof addEditorToProject>,
-    { projectid: string; userid: string }
+    { projectId: string; userId: string }
   > = (props) => {
-    const { projectid, userid } = props || {};
+    const { projectId, userId } = props || {};
 
-    return addEditorToProject(projectid, userid, requestOptions);
+    return addEditorToProject(projectId, userId, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof addEditorToProject>,
     TError,
-    { projectid: string; userid: string },
+    { projectId: string; userId: string },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -359,16 +403,22 @@ You must be an `editor` or the `owner` of the project
  * @summary Delete a project editor
  */
 export const removeEditorFromProject = (
-  projectid: string,
-  userid: string,
+  projectId: string,
+  userId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/project/${projectid}/editor/${userid}`, method: "delete" },
+    { url: `/project/${projectId}/editor/${userId}`, method: "delete" },
     options
   );
 };
 
+export type RemoveEditorFromProjectMutationResult = NonNullable<
+  AsyncReturnType<typeof removeEditorFromProject>
+>;
+
+export type RemoveEditorFromProjectMutationError = ErrorType<DmError>;
+
 export const useRemoveEditorFromProject = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -376,7 +426,7 @@ export const useRemoveEditorFromProject = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof removeEditorFromProject>,
     TError,
-    { projectid: string; userid: string },
+    { projectId: string; userId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -385,17 +435,17 @@ export const useRemoveEditorFromProject = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof removeEditorFromProject>,
-    { projectid: string; userid: string }
+    { projectId: string; userId: string }
   > = (props) => {
-    const { projectid, userid } = props || {};
+    const { projectId, userId } = props || {};
 
-    return removeEditorFromProject(projectid, userid, requestOptions);
+    return removeEditorFromProject(projectId, userId, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof removeEditorFromProject>,
     TError,
-    { projectid: string; userid: string },
+    { projectId: string; userId: string },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -409,26 +459,31 @@ You must be an `editor` or the `owner` of the project if the project is private
  * @summary Download a project file
  */
 export const getProjectFile = (
-  projectid: string,
+  projectId: string,
   params?: GetProjectFileParams,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/project/${projectid}/file`, method: "get", params },
+    { url: `/project/${projectId}/file`, method: "get", params },
     options
   );
 };
 
 export const getGetProjectFileQueryKey = (
-  projectid: string,
+  projectId: string,
   params?: GetProjectFileParams
-) => [`/project/${projectid}/file`, ...(params ? [params] : [])];
+) => [`/project/${projectId}/file`, ...(params ? [params] : [])];
+
+export type GetProjectFileQueryResult = NonNullable<
+  AsyncReturnType<typeof getProjectFile>
+>;
+export type GetProjectFileQueryError = ErrorType<DmError>;
 
 export const useGetProjectFile = <
   TData = AsyncReturnType<typeof getProjectFile>,
   TError = ErrorType<DmError>
 >(
-  projectid: string,
+  projectId: string,
   params?: GetProjectFileParams,
   options?: {
     query?: UseQueryOptions<
@@ -442,15 +497,15 @@ export const useGetProjectFile = <
   const { query: queryOptions, request: requestOptions } = options || {};
 
   const queryKey =
-    queryOptions?.queryKey ?? getGetProjectFileQueryKey(projectid, params);
+    queryOptions?.queryKey ?? getGetProjectFileQueryKey(projectId, params);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof getProjectFile>> = () =>
-    getProjectFile(projectid, params, requestOptions);
+    getProjectFile(projectId, params, requestOptions);
 
   const query = useQuery<AsyncReturnType<typeof getProjectFile>, TError, TData>(
     queryKey,
     queryFn,
-    { enabled: !!projectid, ...queryOptions }
+    { enabled: !!projectId, ...queryOptions }
   );
 
   return {
@@ -467,7 +522,7 @@ You must be an `editor` or the `owner` of the project
  * @summary Upload a file into a Project
  */
 export const addFileToProject = (
-  projectid: string,
+  projectId: string,
   projectFilePutBodyBody: ProjectFilePutBodyBody,
   options?: SecondParameter<typeof customInstance>
 ) => {
@@ -481,11 +536,22 @@ export const addFileToProject = (
   }
 
   return customInstance<void>(
-    { url: `/project/${projectid}/file`, method: "put", data: formData },
+    {
+      url: `/project/${projectId}/file`,
+      method: "put",
+      headers: { "Content-Type": "multipart/form-data" },
+      data: formData,
+    },
     options
   );
 };
 
+export type AddFileToProjectMutationResult = NonNullable<
+  AsyncReturnType<typeof addFileToProject>
+>;
+export type AddFileToProjectMutationBody = ProjectFilePutBodyBody;
+export type AddFileToProjectMutationError = ErrorType<DmError>;
+
 export const useAddFileToProject = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -493,7 +559,7 @@ export const useAddFileToProject = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof addFileToProject>,
     TError,
-    { projectid: string; data: ProjectFilePutBodyBody },
+    { projectId: string; data: ProjectFilePutBodyBody },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -502,17 +568,17 @@ export const useAddFileToProject = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof addFileToProject>,
-    { projectid: string; data: ProjectFilePutBodyBody }
+    { projectId: string; data: ProjectFilePutBodyBody }
   > = (props) => {
-    const { projectid, data } = props || {};
+    const { projectId, data } = props || {};
 
-    return addFileToProject(projectid, data, requestOptions);
+    return addFileToProject(projectId, data, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof addFileToProject>,
     TError,
-    { projectid: string; data: ProjectFilePutBodyBody },
+    { projectId: string; data: ProjectFilePutBodyBody },
     TContext
   >(mutationFn, mutationOptions);
 };

package/src/task/task.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.6.0 🍺
+ * Generated by orval v6.7.1 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -62,6 +62,9 @@ export const getGetTasksQueryKey = (params?: GetTasksParams) => [
   ...(params ? [params] : []),
 ];
 
+export type GetTasksQueryResult = NonNullable<AsyncReturnType<typeof getTasks>>;
+export type GetTasksQueryError = ErrorType<void | DmError>;
+
 export const useGetTasks = <
   TData = AsyncReturnType<typeof getTasks>,
   TError = ErrorType<void | DmError>
@@ -113,26 +116,29 @@ For Application **Instance** tasks, where the task `purpose` is `INSTANCE`, you
  * @summary Returns task information
  */
 export const getTask = (
-  taskid: string,
+  taskId: string,
   params?: GetTaskParams,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<TaskGetResponse>(
-    { url: `/task/${taskid}`, method: "get", params },
+    { url: `/task/${taskId}`, method: "get", params },
     options
   );
 };
 
-export const getGetTaskQueryKey = (taskid: string, params?: GetTaskParams) => [
-  `/task/${taskid}`,
+export const getGetTaskQueryKey = (taskId: string, params?: GetTaskParams) => [
+  `/task/${taskId}`,
   ...(params ? [params] : []),
 ];
 
+export type GetTaskQueryResult = NonNullable<AsyncReturnType<typeof getTask>>;
+export type GetTaskQueryError = ErrorType<void | DmError>;
+
 export const useGetTask = <
   TData = AsyncReturnType<typeof getTask>,
   TError = ErrorType<void | DmError>
 >(
-  taskid: string,
+  taskId: string,
   params?: GetTaskParams,
   options?: {
     query?: UseQueryOptions<AsyncReturnType<typeof getTask>, TError, TData>;
@@ -141,15 +147,15 @@ export const useGetTask = <
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
   const { query: queryOptions, request: requestOptions } = options || {};
 
-  const queryKey = queryOptions?.queryKey ?? getGetTaskQueryKey(taskid, params);
+  const queryKey = queryOptions?.queryKey ?? getGetTaskQueryKey(taskId, params);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof getTask>> = () =>
-    getTask(taskid, params, requestOptions);
+    getTask(taskId, params, requestOptions);
 
   const query = useQuery<AsyncReturnType<typeof getTask>, TError, TData>(
     queryKey,
     queryFn,
-    { enabled: !!taskid, ...queryOptions }
+    { enabled: !!taskId, ...queryOptions }
   );
 
   return {
@@ -168,15 +174,21 @@ You must be an **owner** of the Task action to delete it. For example you must b
  * @summary Delete a Task entry
  */
 export const deleteTask = (
-  taskid: string,
+  taskId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/task/${taskid}`, method: "delete" },
+    { url: `/task/${taskId}`, method: "delete" },
     options
   );
 };
 
+export type DeleteTaskMutationResult = NonNullable<
+  AsyncReturnType<typeof deleteTask>
+>;
+
+export type DeleteTaskMutationError = ErrorType<DmError>;
+
 export const useDeleteTask = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -184,7 +196,7 @@ export const useDeleteTask = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof deleteTask>,
     TError,
-    { taskid: string },
+    { taskId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -193,17 +205,17 @@ export const useDeleteTask = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof deleteTask>,
-    { taskid: string }
+    { taskId: string }
   > = (props) => {
-    const { taskid } = props || {};
+    const { taskId } = props || {};
 
-    return deleteTask(taskid, requestOptions);
+    return deleteTask(taskId, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof deleteTask>,
     TError,
-    { taskid: string },
+    { taskId: string },
     TContext
   >(mutationFn, mutationOptions);
 };

package/src/type/type.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.6.0 🍺
+ * Generated by orval v6.7.1 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -49,6 +49,11 @@ export const getFileTypes = (
 
 export const getGetFileTypesQueryKey = () => [`/type`];
 
+export type GetFileTypesQueryResult = NonNullable<
+  AsyncReturnType<typeof getFileTypes>
+>;
+export type GetFileTypesQueryError = ErrorType<void | DmError>;
+
 export const useGetFileTypes = <
   TData = AsyncReturnType<typeof getFileTypes>,
   TError = ErrorType<void | DmError>

package/src/user/user.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.6.0 🍺
+ * Generated by orval v6.7.1 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -58,6 +58,9 @@ export const getUsers = (options?: SecondParameter<typeof customInstance>) => {
 
 export const getGetUsersQueryKey = () => [`/user`];
 
+export type GetUsersQueryResult = NonNullable<AsyncReturnType<typeof getUsers>>;
+export type GetUsersQueryError = ErrorType<void | DmError>;
+
 export const useGetUsers = <
   TData = AsyncReturnType<typeof getUsers>,
   TError = ErrorType<void | DmError>
@@ -104,6 +107,11 @@ export const getGetUserAccountQueryKey = (params?: GetUserAccountParams) => [
   ...(params ? [params] : []),
 ];
 
+export type GetUserAccountQueryResult = NonNullable<
+  AsyncReturnType<typeof getUserAccount>
+>;
+export type GetUserAccountQueryError = ErrorType<void | DmError>;
+
 export const useGetUserAccount = <
   TData = AsyncReturnType<typeof getUserAccount>,
   TError = ErrorType<void | DmError>
@@ -167,11 +175,22 @@ export const patchUserAccount = (
   }
 
   return customInstance<void>(
-    { url: `/user/account`, method: "patch", data: formData },
+    {
+      url: `/user/account`,
+      method: "patch",
+      headers: { "Content-Type": "multipart/form-data" },
+      data: formData,
+    },
     options
   );
 };
 
+export type PatchUserAccountMutationResult = NonNullable<
+  AsyncReturnType<typeof patchUserAccount>
+>;
+export type PatchUserAccountMutationBody = UserAccountPatchBodyBody;
+export type PatchUserAccountMutationError = ErrorType<DmError>;
+
 export const usePatchUserAccount = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -222,6 +241,11 @@ export const getGetUserApiLogQueryKey = (params?: GetUserApiLogParams) => [
   ...(params ? [params] : []),
 ];
 
+export type GetUserApiLogQueryResult = NonNullable<
+  AsyncReturnType<typeof getUserApiLog>
+>;
+export type GetUserApiLogQueryError = ErrorType<void>;
+
 export const useGetUserApiLog = <
   TData = AsyncReturnType<typeof getUserApiLog>,
   TError = ErrorType<void>