@squonk/data-manager-client 0.7.3-rc.4 → 0.7.7

package/src/dataset/dataset.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.
@@ -90,11 +90,22 @@ export const createDatasetFromFile = (
   }
 
   return customInstance<DatasetPutPostResponse>(
-    { url: `/dataset`, method: "put", data: formData },
+    {
+      url: `/dataset`,
+      method: "put",
+      headers: { "Content-Type": "multipart/form-data" },
+      data: formData,
+    },
     options
   );
 };
 
+export type CreateDatasetFromFileMutationResult = NonNullable<
+  AsyncReturnType<typeof createDatasetFromFile>
+>;
+export type CreateDatasetFromFileMutationBody = DatasetPutBodyBody;
+export type CreateDatasetFromFileMutationError = ErrorType<void | DmError>;
+
 export const useCreateDatasetFromFile = <
   TError = ErrorType<void | DmError>,
   TContext = unknown
@@ -167,11 +178,22 @@ export const uploadDataset = (
   formData.append("unit_id", datasetPostBodyBody.unit_id);
 
   return customInstance<DatasetPutPostResponse>(
-    { url: `/dataset`, method: "post", data: formData },
+    {
+      url: `/dataset`,
+      method: "post",
+      headers: { "Content-Type": "multipart/form-data" },
+      data: formData,
+    },
     options
   );
 };
 
+export type UploadDatasetMutationResult = NonNullable<
+  AsyncReturnType<typeof uploadDataset>
+>;
+export type UploadDatasetMutationBody = DatasetPostBodyBody;
+export type UploadDatasetMutationError = ErrorType<void | DmError>;
+
 export const useUploadDataset = <
   TError = ErrorType<void | DmError>,
   TContext = unknown
@@ -228,6 +250,11 @@ export const getGetDatasetsQueryKey = (params?: GetDatasetsParams) => [
   ...(params ? [params] : []),
 ];
 
+export type GetDatasetsQueryResult = NonNullable<
+  AsyncReturnType<typeof getDatasets>
+>;
+export type GetDatasetsQueryError = ErrorType<void | DmError>;
+
 export const useGetDatasets = <
   TData = AsyncReturnType<typeof getDatasets>,
   TError = ErrorType<void | DmError>
@@ -265,26 +292,31 @@ You will not see Datasets while their upload is still in progress.
  * @summary Gets all the versions of a specific Dataset
  */
 export const getVersions = (
-  datasetid: string,
+  datasetId: string,
   params?: GetVersionsParams,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<DatasetVersionsGetResponse>(
-    { url: `/dataset/${datasetid}/versions`, method: "get", params },
+    { url: `/dataset/${datasetId}/versions`, method: "get", params },
     options
   );
 };
 
 export const getGetVersionsQueryKey = (
-  datasetid: string,
+  datasetId: string,
   params?: GetVersionsParams
-) => [`/dataset/${datasetid}/versions`, ...(params ? [params] : [])];
+) => [`/dataset/${datasetId}/versions`, ...(params ? [params] : [])];
+
+export type GetVersionsQueryResult = NonNullable<
+  AsyncReturnType<typeof getVersions>
+>;
+export type GetVersionsQueryError = ErrorType<void | DmError>;
 
 export const useGetVersions = <
   TData = AsyncReturnType<typeof getVersions>,
   TError = ErrorType<void | DmError>
 >(
-  datasetid: string,
+  datasetId: string,
   params?: GetVersionsParams,
   options?: {
     query?: UseQueryOptions<AsyncReturnType<typeof getVersions>, TError, TData>;
@@ -294,15 +326,15 @@ export const useGetVersions = <
   const { query: queryOptions, request: requestOptions } = options || {};
 
   const queryKey =
-    queryOptions?.queryKey ?? getGetVersionsQueryKey(datasetid, params);
+    queryOptions?.queryKey ?? getGetVersionsQueryKey(datasetId, params);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof getVersions>> = () =>
-    getVersions(datasetid, params, requestOptions);
+    getVersions(datasetId, params, requestOptions);
 
   const query = useQuery<AsyncReturnType<typeof getVersions>, TError, TData>(
     queryKey,
     queryFn,
-    { enabled: !!datasetid, ...queryOptions }
+    { enabled: !!datasetId, ...queryOptions }
   );
 
   return {
@@ -321,14 +353,14 @@ You cannot delete a Dataset until its upload is complete.
  * @summary Delete a dataset
  */
 export const deleteDataset = (
-  datasetid: string,
-  datasetversion: number,
+  datasetId: string,
+  datasetVersion: number,
   params?: DeleteDatasetParams,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<DatasetVersionDeleteResponse>(
     {
-      url: `/dataset/${datasetid}/${datasetversion}`,
+      url: `/dataset/${datasetId}/${datasetVersion}`,
       method: "delete",
       params,
     },
@@ -336,6 +368,12 @@ export const deleteDataset = (
   );
 };
 
+export type DeleteDatasetMutationResult = NonNullable<
+  AsyncReturnType<typeof deleteDataset>
+>;
+
+export type DeleteDatasetMutationError = ErrorType<void | DmError>;
+
 export const useDeleteDataset = <
   TError = ErrorType<void | DmError>,
   TContext = unknown
@@ -343,7 +381,7 @@ export const useDeleteDataset = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof deleteDataset>,
     TError,
-    { datasetid: string; datasetversion: number; params?: DeleteDatasetParams },
+    { datasetId: string; datasetVersion: number; params?: DeleteDatasetParams },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -352,17 +390,17 @@ export const useDeleteDataset = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof deleteDataset>,
-    { datasetid: string; datasetversion: number; params?: DeleteDatasetParams }
+    { datasetId: string; datasetVersion: number; params?: DeleteDatasetParams }
   > = (props) => {
-    const { datasetid, datasetversion, params } = props || {};
+    const { datasetId, datasetVersion, params } = props || {};
 
-    return deleteDataset(datasetid, datasetversion, params, requestOptions);
+    return deleteDataset(datasetId, datasetVersion, params, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof deleteDataset>,
     TError,
-    { datasetid: string; datasetversion: number; params?: DeleteDatasetParams },
+    { datasetId: string; datasetVersion: number; params?: DeleteDatasetParams },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -374,27 +412,32 @@ You cannot get a Dataset until its upload is complete.
  * @summary Download a dataset
  */
 export const downloadDataset = (
-  datasetid: string,
-  datasetversion: number,
+  datasetId: string,
+  datasetVersion: number,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/dataset/${datasetid}/${datasetversion}`, method: "get" },
+    { url: `/dataset/${datasetId}/${datasetVersion}`, method: "get" },
     options
   );
 };
 
 export const getDownloadDatasetQueryKey = (
-  datasetid: string,
-  datasetversion: number
-) => [`/dataset/${datasetid}/${datasetversion}`];
+  datasetId: string,
+  datasetVersion: number
+) => [`/dataset/${datasetId}/${datasetVersion}`];
+
+export type DownloadDatasetQueryResult = NonNullable<
+  AsyncReturnType<typeof downloadDataset>
+>;
+export type DownloadDatasetQueryError = ErrorType<DmError>;
 
 export const useDownloadDataset = <
   TData = AsyncReturnType<typeof downloadDataset>,
   TError = ErrorType<DmError>
 >(
-  datasetid: string,
-  datasetversion: number,
+  datasetId: string,
+  datasetVersion: number,
   options?: {
     query?: UseQueryOptions<
       AsyncReturnType<typeof downloadDataset>,
@@ -408,17 +451,17 @@ export const useDownloadDataset = <
 
   const queryKey =
     queryOptions?.queryKey ??
-    getDownloadDatasetQueryKey(datasetid, datasetversion);
+    getDownloadDatasetQueryKey(datasetId, datasetVersion);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof downloadDataset>> = () =>
-    downloadDataset(datasetid, datasetversion, requestOptions);
+    downloadDataset(datasetId, datasetVersion, requestOptions);
 
   const query = useQuery<
     AsyncReturnType<typeof downloadDataset>,
     TError,
     TData
   >(queryKey, queryFn, {
-    enabled: !!(datasetid && datasetversion),
+    enabled: !!(datasetId && datasetVersion),
     ...queryOptions,
   });
 
@@ -438,16 +481,22 @@ You cannot modify Dataset editors until its upload is complete.
  * @summary Remove a user's edit permission for a Dataset
  */
 export const removeEditorFromDataset = (
-  datasetid: string,
-  userid: string,
+  datasetId: string,
+  userId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/dataset/${datasetid}/editor/${userid}`, method: "delete" },
+    { url: `/dataset/${datasetId}/editor/${userId}`, method: "delete" },
     options
   );
 };
 
+export type RemoveEditorFromDatasetMutationResult = NonNullable<
+  AsyncReturnType<typeof removeEditorFromDataset>
+>;
+
+export type RemoveEditorFromDatasetMutationError = ErrorType<DmError>;
+
 export const useRemoveEditorFromDataset = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -455,7 +504,7 @@ export const useRemoveEditorFromDataset = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof removeEditorFromDataset>,
     TError,
-    { datasetid: string; userid: string },
+    { datasetId: string; userId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -464,17 +513,17 @@ export const useRemoveEditorFromDataset = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof removeEditorFromDataset>,
-    { datasetid: string; userid: string }
+    { datasetId: string; userId: string }
   > = (props) => {
-    const { datasetid, userid } = props || {};
+    const { datasetId, userId } = props || {};
 
-    return removeEditorFromDataset(datasetid, userid, requestOptions);
+    return removeEditorFromDataset(datasetId, userId, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof removeEditorFromDataset>,
     TError,
-    { datasetid: string; userid: string },
+    { datasetId: string; userId: string },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -488,16 +537,22 @@ You cannot modify Dataset editors until its upload is complete.
  * @summary Give a user edit permission for a dataset
  */
 export const addEditorToDataset = (
-  datasetid: string,
-  userid: string,
+  datasetId: string,
+  userId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/dataset/${datasetid}/editor/${userid}`, method: "put" },
+    { url: `/dataset/${datasetId}/editor/${userId}`, method: "put" },
     options
   );
 };
 
+export type AddEditorToDatasetMutationResult = NonNullable<
+  AsyncReturnType<typeof addEditorToDataset>
+>;
+
+export type AddEditorToDatasetMutationError = ErrorType<DmError>;
+
 export const useAddEditorToDataset = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -505,7 +560,7 @@ export const useAddEditorToDataset = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof addEditorToDataset>,
     TError,
-    { datasetid: string; userid: string },
+    { datasetId: string; userId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -514,17 +569,17 @@ export const useAddEditorToDataset = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof addEditorToDataset>,
-    { datasetid: string; userid: string }
+    { datasetId: string; userId: string }
   > = (props) => {
-    const { datasetid, userid } = props || {};
+    const { datasetId, userId } = props || {};
 
-    return addEditorToDataset(datasetid, userid, requestOptions);
+    return addEditorToDataset(datasetId, userId, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof addEditorToDataset>,
     TError,
-    { datasetid: string; userid: string },
+    { datasetId: string; userId: string },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -534,24 +589,29 @@ export const useAddEditorToDataset = <
  * @summary Gets the first Dataset that matches the provided digest
  */
 export const getDatasetDigest = (
-  datasetdigest: string,
+  datasetDigest: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<DatasetDigestGetResponse>(
-    { url: `/dataset/digest/${datasetdigest}`, method: "get" },
+    { url: `/dataset/digest/${datasetDigest}`, method: "get" },
     options
   );
 };
 
-export const getGetDatasetDigestQueryKey = (datasetdigest: string) => [
-  `/dataset/digest/${datasetdigest}`,
+export const getGetDatasetDigestQueryKey = (datasetDigest: string) => [
+  `/dataset/digest/${datasetDigest}`,
 ];
 
+export type GetDatasetDigestQueryResult = NonNullable<
+  AsyncReturnType<typeof getDatasetDigest>
+>;
+export type GetDatasetDigestQueryError = ErrorType<void | DmError>;
+
 export const useGetDatasetDigest = <
   TData = AsyncReturnType<typeof getDatasetDigest>,
   TError = ErrorType<void | DmError>
 >(
-  datasetdigest: string,
+  datasetDigest: string,
   options?: {
     query?: UseQueryOptions<
       AsyncReturnType<typeof getDatasetDigest>,
@@ -564,16 +624,16 @@ export const useGetDatasetDigest = <
   const { query: queryOptions, request: requestOptions } = options || {};
 
   const queryKey =
-    queryOptions?.queryKey ?? getGetDatasetDigestQueryKey(datasetdigest);
+    queryOptions?.queryKey ?? getGetDatasetDigestQueryKey(datasetDigest);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof getDatasetDigest>> = () =>
-    getDatasetDigest(datasetdigest, requestOptions);
+    getDatasetDigest(datasetDigest, requestOptions);
 
   const query = useQuery<
     AsyncReturnType<typeof getDatasetDigest>,
     TError,
     TData
-  >(queryKey, queryFn, { enabled: !!datasetdigest, ...queryOptions });
+  >(queryKey, queryFn, { enabled: !!datasetDigest, ...queryOptions });
 
   return {
     queryKey,
@@ -587,27 +647,32 @@ export const useGetDatasetDigest = <
  * @summary Gets the property schema for a specific Dataset
  */
 export const getSchema = (
-  datasetid: string,
-  datasetversion: number,
+  datasetId: string,
+  datasetVersion: number,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<DatasetSchemaGetResponse>(
-    { url: `/dataset/${datasetid}/schema/${datasetversion}`, method: "get" },
+    { url: `/dataset/${datasetId}/schema/${datasetVersion}`, method: "get" },
     options
   );
 };
 
 export const getGetSchemaQueryKey = (
-  datasetid: string,
-  datasetversion: number
-) => [`/dataset/${datasetid}/schema/${datasetversion}`];
+  datasetId: string,
+  datasetVersion: number
+) => [`/dataset/${datasetId}/schema/${datasetVersion}`];
+
+export type GetSchemaQueryResult = NonNullable<
+  AsyncReturnType<typeof getSchema>
+>;
+export type GetSchemaQueryError = ErrorType<void | DmError>;
 
 export const useGetSchema = <
   TData = AsyncReturnType<typeof getSchema>,
   TError = ErrorType<void | DmError>
 >(
-  datasetid: string,
-  datasetversion: number,
+  datasetId: string,
+  datasetVersion: number,
   options?: {
     query?: UseQueryOptions<AsyncReturnType<typeof getSchema>, TError, TData>;
     request?: SecondParameter<typeof customInstance>;
@@ -616,15 +681,15 @@ export const useGetSchema = <
   const { query: queryOptions, request: requestOptions } = options || {};
 
   const queryKey =
-    queryOptions?.queryKey ?? getGetSchemaQueryKey(datasetid, datasetversion);
+    queryOptions?.queryKey ?? getGetSchemaQueryKey(datasetId, datasetVersion);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof getSchema>> = () =>
-    getSchema(datasetid, datasetversion, requestOptions);
+    getSchema(datasetId, datasetVersion, requestOptions);
 
   const query = useQuery<AsyncReturnType<typeof getSchema>, TError, TData>(
     queryKey,
     queryFn,
-    { enabled: !!(datasetid && datasetversion), ...queryOptions }
+    { enabled: !!(datasetId && datasetVersion), ...queryOptions }
   );
 
   return {

package/src/file/file.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.
@@ -63,6 +63,9 @@ export const getGetFilesQueryKey = (params?: GetFilesParams) => [
   ...(params ? [params] : []),
 ];
 
+export type GetFilesQueryResult = NonNullable<AsyncReturnType<typeof getFiles>>;
+export type GetFilesQueryError = ErrorType<void | DmError>;
+
 export const useGetFiles = <
   TData = AsyncReturnType<typeof getFiles>,
   TError = ErrorType<void | DmError>
@@ -128,11 +131,22 @@ export const attachFile = (
   }
 
   return customInstance<FilePostResponse>(
-    { url: `/file`, method: "post", data: formData },
+    {
+      url: `/file`,
+      method: "post",
+      headers: { "Content-Type": "multipart/form-data" },
+      data: formData,
+    },
     options
   );
 };
 
+export type AttachFileMutationResult = NonNullable<
+  AsyncReturnType<typeof attachFile>
+>;
+export type AttachFileMutationBody = FilePostBodyBody;
+export type AttachFileMutationError = ErrorType<void | DmError>;
+
 export const useAttachFile = <
   TError = ErrorType<void | DmError>,
   TContext = unknown
@@ -180,6 +194,12 @@ export const deleteUnmanagedFile = (
   );
 };
 
+export type DeleteUnmanagedFileMutationResult = NonNullable<
+  AsyncReturnType<typeof deleteUnmanagedFile>
+>;
+
+export type DeleteUnmanagedFileMutationError = ErrorType<DmError>;
+
 export const useDeleteUnmanagedFile = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -220,15 +240,21 @@ You cannot delete a Project File until the attach is complete.
  * @summary Delete/detach a File (from a project)
  */
 export const deleteFile = (
-  fileid: string,
+  fileId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/file/${fileid}`, method: "delete" },
+    { url: `/file/${fileId}`, method: "delete" },
     options
   );
 };
 
+export type DeleteFileMutationResult = NonNullable<
+  AsyncReturnType<typeof deleteFile>
+>;
+
+export type DeleteFileMutationError = ErrorType<DmError>;
+
 export const useDeleteFile = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -236,7 +262,7 @@ export const useDeleteFile = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof deleteFile>,
     TError,
-    { fileid: string },
+    { fileId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -245,17 +271,17 @@ export const useDeleteFile = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof deleteFile>,
-    { fileid: string }
+    { fileId: string }
   > = (props) => {
-    const { fileid } = props || {};
+    const { fileId } = props || {};
 
-    return deleteFile(fileid, requestOptions);
+    return deleteFile(fileId, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof deleteFile>,
     TError,
-    { fileid: string },
+    { fileId: string },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -267,22 +293,27 @@ You cannot get a Project File until the attach is complete.
  * @summary Download a File (from a project)
  */
 export const downloadFile = (
-  fileid: string,
+  fileId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/file/${fileid}`, method: "get" },
+    { url: `/file/${fileId}`, method: "get" },
     options
   );
 };
 
-export const getDownloadFileQueryKey = (fileid: string) => [`/file/${fileid}`];
+export const getDownloadFileQueryKey = (fileId: string) => [`/file/${fileId}`];
+
+export type DownloadFileQueryResult = NonNullable<
+  AsyncReturnType<typeof downloadFile>
+>;
+export type DownloadFileQueryError = ErrorType<DmError>;
 
 export const useDownloadFile = <
   TData = AsyncReturnType<typeof downloadFile>,
   TError = ErrorType<DmError>
 >(
-  fileid: string,
+  fileId: string,
   options?: {
     query?: UseQueryOptions<
       AsyncReturnType<typeof downloadFile>,
@@ -294,15 +325,15 @@ export const useDownloadFile = <
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
   const { query: queryOptions, request: requestOptions } = options || {};
 
-  const queryKey = queryOptions?.queryKey ?? getDownloadFileQueryKey(fileid);
+  const queryKey = queryOptions?.queryKey ?? getDownloadFileQueryKey(fileId);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof downloadFile>> = () =>
-    downloadFile(fileid, requestOptions);
+    downloadFile(fileId, requestOptions);
 
   const query = useQuery<AsyncReturnType<typeof downloadFile>, TError, TData>(
     queryKey,
     queryFn,
-    { enabled: !!fileid, ...queryOptions }
+    { enabled: !!fileId, ...queryOptions }
   );
 
   return {