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

package/src/instance/instance.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.
@@ -82,11 +82,22 @@ export const createInstance = (
   }
 
   return customInstance<InstancePostResponse>(
-    { url: `/instance`, method: "post", data: formData },
+    {
+      url: `/instance`,
+      method: "post",
+      headers: { "Content-Type": "multipart/form-data" },
+      data: formData,
+    },
     options
   );
 };
 
+export type CreateInstanceMutationResult = NonNullable<
+  AsyncReturnType<typeof createInstance>
+>;
+export type CreateInstanceMutationBody = InstancePostBodyBody;
+export type CreateInstanceMutationError = ErrorType<void | DmError>;
+
 export const useCreateInstance = <
   TError = ErrorType<void | DmError>,
   TContext = unknown
@@ -137,6 +148,11 @@ export const getGetInstancesQueryKey = (params?: GetInstancesParams) => [
   ...(params ? [params] : []),
 ];
 
+export type GetInstancesQueryResult = NonNullable<
+  AsyncReturnType<typeof getInstances>
+>;
+export type GetInstancesQueryError = ErrorType<void | DmError>;
+
 export const useGetInstances = <
   TData = AsyncReturnType<typeof getInstances>,
   TError = ErrorType<void | DmError>
@@ -176,24 +192,29 @@ export const useGetInstances = <
  * @summary Get detailed information about a specific instance
  */
 export const getInstance = (
-  instanceid: string,
+  instanceId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<InstanceGetResponse>(
-    { url: `/instance/${instanceid}`, method: "get" },
+    { url: `/instance/${instanceId}`, method: "get" },
     options
   );
 };
 
-export const getGetInstanceQueryKey = (instanceid: string) => [
-  `/instance/${instanceid}`,
+export const getGetInstanceQueryKey = (instanceId: string) => [
+  `/instance/${instanceId}`,
 ];
 
+export type GetInstanceQueryResult = NonNullable<
+  AsyncReturnType<typeof getInstance>
+>;
+export type GetInstanceQueryError = ErrorType<void | DmError>;
+
 export const useGetInstance = <
   TData = AsyncReturnType<typeof getInstance>,
   TError = ErrorType<void | DmError>
 >(
-  instanceid: string,
+  instanceId: string,
   options?: {
     query?: UseQueryOptions<AsyncReturnType<typeof getInstance>, TError, TData>;
     request?: SecondParameter<typeof customInstance>;
@@ -201,15 +222,15 @@ export const useGetInstance = <
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
   const { query: queryOptions, request: requestOptions } = options || {};
 
-  const queryKey = queryOptions?.queryKey ?? getGetInstanceQueryKey(instanceid);
+  const queryKey = queryOptions?.queryKey ?? getGetInstanceQueryKey(instanceId);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof getInstance>> = () =>
-    getInstance(instanceid, requestOptions);
+    getInstance(instanceId, requestOptions);
 
   const query = useQuery<AsyncReturnType<typeof getInstance>, TError, TData>(
     queryKey,
     queryFn,
-    { enabled: !!instanceid, ...queryOptions }
+    { enabled: !!instanceId, ...queryOptions }
   );
 
   return {
@@ -226,15 +247,21 @@ You must be the `owner` or an `editor` of the instance to delete it
  * @summary Delete an application instance
  */
 export const terminateInstance = (
-  instanceid: string,
+  instanceId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<InstanceDeleteResponse>(
-    { url: `/instance/${instanceid}`, method: "delete" },
+    { url: `/instance/${instanceId}`, method: "delete" },
     options
   );
 };
 
+export type TerminateInstanceMutationResult = NonNullable<
+  AsyncReturnType<typeof terminateInstance>
+>;
+
+export type TerminateInstanceMutationError = ErrorType<void | DmError>;
+
 export const useTerminateInstance = <
   TError = ErrorType<void | DmError>,
   TContext = unknown
@@ -242,7 +269,7 @@ export const useTerminateInstance = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof terminateInstance>,
     TError,
-    { instanceid: string },
+    { instanceId: string },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -251,17 +278,17 @@ export const useTerminateInstance = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof terminateInstance>,
-    { instanceid: string }
+    { instanceId: string }
   > = (props) => {
-    const { instanceid } = props || {};
+    const { instanceId } = props || {};
 
-    return terminateInstance(instanceid, requestOptions);
+    return terminateInstance(instanceId, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof terminateInstance>,
     TError,
-    { instanceid: string },
+    { instanceId: string },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -273,16 +300,22 @@ You must be the `owner` or an `editor` of the instance to patch it
  * @summary Update an application instance
  */
 export const patchInstance = (
-  instanceid: string,
+  instanceId: string,
   params?: PatchInstanceParams,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<void>(
-    { url: `/instance/${instanceid}`, method: "patch", params },
+    { url: `/instance/${instanceId}`, method: "patch", params },
     options
   );
 };
 
+export type PatchInstanceMutationResult = NonNullable<
+  AsyncReturnType<typeof patchInstance>
+>;
+
+export type PatchInstanceMutationError = ErrorType<DmError>;
+
 export const usePatchInstance = <
   TError = ErrorType<DmError>,
   TContext = unknown
@@ -290,7 +323,7 @@ export const usePatchInstance = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof patchInstance>,
     TError,
-    { instanceid: string; params?: PatchInstanceParams },
+    { instanceId: string; params?: PatchInstanceParams },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -299,17 +332,17 @@ export const usePatchInstance = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof patchInstance>,
-    { instanceid: string; params?: PatchInstanceParams }
+    { instanceId: string; params?: PatchInstanceParams }
   > = (props) => {
-    const { instanceid, params } = props || {};
+    const { instanceId, params } = props || {};
 
-    return patchInstance(instanceid, params, requestOptions);
+    return patchInstance(instanceId, params, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof patchInstance>,
     TError,
-    { instanceid: string; params?: PatchInstanceParams },
+    { instanceId: string; params?: PatchInstanceParams },
     TContext
   >(mutationFn, mutationOptions);
 };

package/src/job/job.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.
@@ -53,6 +53,9 @@ export const getJobs = (options?: SecondParameter<typeof customInstance>) => {
 
 export const getGetJobsQueryKey = () => [`/job`];
 
+export type GetJobsQueryResult = NonNullable<AsyncReturnType<typeof getJobs>>;
+export type GetJobsQueryError = ErrorType<DmError>;
+
 export const useGetJobs = <
   TData = AsyncReturnType<typeof getJobs>,
   TError = ErrorType<DmError>
@@ -87,22 +90,25 @@ To run a job you need to use the `/instance` endpoint. The Job is controlled thr
  * @summary Get details of a specific Job
  */
 export const getJob = (
-  jobid: number,
+  jobId: number,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<JobGetResponse>(
-    { url: `/job/${jobid}`, method: "get" },
+    { url: `/job/${jobId}`, method: "get" },
     options
   );
 };
 
-export const getGetJobQueryKey = (jobid: number) => [`/job/${jobid}`];
+export const getGetJobQueryKey = (jobId: number) => [`/job/${jobId}`];
+
+export type GetJobQueryResult = NonNullable<AsyncReturnType<typeof getJob>>;
+export type GetJobQueryError = ErrorType<void | DmError>;
 
 export const useGetJob = <
   TData = AsyncReturnType<typeof getJob>,
   TError = ErrorType<void | DmError>
 >(
-  jobid: number,
+  jobId: number,
   options?: {
     query?: UseQueryOptions<AsyncReturnType<typeof getJob>, TError, TData>;
     request?: SecondParameter<typeof customInstance>;
@@ -110,15 +116,15 @@ export const useGetJob = <
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
   const { query: queryOptions, request: requestOptions } = options || {};
 
-  const queryKey = queryOptions?.queryKey ?? getGetJobQueryKey(jobid);
+  const queryKey = queryOptions?.queryKey ?? getGetJobQueryKey(jobId);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof getJob>> = () =>
-    getJob(jobid, requestOptions);
+    getJob(jobId, requestOptions);
 
   const query = useQuery<AsyncReturnType<typeof getJob>, TError, TData>(
     queryKey,
     queryFn,
-    { enabled: !!jobid, ...queryOptions }
+    { enabled: !!jobId, ...queryOptions }
   );
 
   return {

package/src/metadata/metadata.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,8 +49,8 @@ The annotations are provided in a list in JSON format. For details of the annota
  * @summary Update Metadata for the Dataset version
  */
 export const addMetadataVersion = (
-  datasetid: string,
-  datasetversion: number,
+  datasetId: string,
+  datasetVersion: number,
   datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody,
   options?: SecondParameter<typeof customInstance>
 ) => {
@@ -67,14 +67,21 @@ export const addMetadataVersion = (
 
   return customInstance<DatasetMetaGetResponse>(
     {
-      url: `/dataset/${datasetid}/meta/${datasetversion}`,
+      url: `/dataset/${datasetId}/meta/${datasetVersion}`,
       method: "post",
+      headers: { "Content-Type": "multipart/form-data" },
       data: formData,
     },
     options
   );
 };
 
+export type AddMetadataVersionMutationResult = NonNullable<
+  AsyncReturnType<typeof addMetadataVersion>
+>;
+export type AddMetadataVersionMutationBody = DatasetVersionMetaPostBodyBody;
+export type AddMetadataVersionMutationError = ErrorType<DmError | void>;
+
 export const useAddMetadataVersion = <
   TError = ErrorType<DmError | void>,
   TContext = unknown
@@ -83,8 +90,8 @@ export const useAddMetadataVersion = <
     AsyncReturnType<typeof addMetadataVersion>,
     TError,
     {
-      datasetid: string;
-      datasetversion: number;
+      datasetId: string;
+      datasetVersion: number;
       data: DatasetVersionMetaPostBodyBody;
     },
     TContext
@@ -96,22 +103,22 @@ export const useAddMetadataVersion = <
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof addMetadataVersion>,
     {
-      datasetid: string;
-      datasetversion: number;
+      datasetId: string;
+      datasetVersion: number;
       data: DatasetVersionMetaPostBodyBody;
     }
   > = (props) => {
-    const { datasetid, datasetversion, data } = props || {};
+    const { datasetId, datasetVersion, data } = props || {};
 
-    return addMetadataVersion(datasetid, datasetversion, data, requestOptions);
+    return addMetadataVersion(datasetId, datasetVersion, data, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof addMetadataVersion>,
     TError,
     {
-      datasetid: string;
-      datasetversion: number;
+      datasetId: string;
+      datasetVersion: number;
       data: DatasetVersionMetaPostBodyBody;
     },
     TContext
@@ -123,27 +130,32 @@ export const useAddMetadataVersion = <
  * @summary Gets the metadata for a specific Dataset version
  */
 export const getMetadataVersion = (
-  datasetid: string,
-  datasetversion: number,
+  datasetId: string,
+  datasetVersion: number,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<DatasetMetaGetResponse>(
-    { url: `/dataset/${datasetid}/meta/${datasetversion}`, method: "get" },
+    { url: `/dataset/${datasetId}/meta/${datasetVersion}`, method: "get" },
     options
   );
 };
 
 export const getGetMetadataVersionQueryKey = (
-  datasetid: string,
-  datasetversion: number
-) => [`/dataset/${datasetid}/meta/${datasetversion}`];
+  datasetId: string,
+  datasetVersion: number
+) => [`/dataset/${datasetId}/meta/${datasetVersion}`];
+
+export type GetMetadataVersionQueryResult = NonNullable<
+  AsyncReturnType<typeof getMetadataVersion>
+>;
+export type GetMetadataVersionQueryError = ErrorType<void | DmError>;
 
 export const useGetMetadataVersion = <
   TData = AsyncReturnType<typeof getMetadataVersion>,
   TError = ErrorType<void | DmError>
 >(
-  datasetid: string,
-  datasetversion: number,
+  datasetId: string,
+  datasetVersion: number,
   options?: {
     query?: UseQueryOptions<
       AsyncReturnType<typeof getMetadataVersion>,
@@ -157,18 +169,18 @@ export const useGetMetadataVersion = <
 
   const queryKey =
     queryOptions?.queryKey ??
-    getGetMetadataVersionQueryKey(datasetid, datasetversion);
+    getGetMetadataVersionQueryKey(datasetId, datasetVersion);
 
   const queryFn: QueryFunction<
     AsyncReturnType<typeof getMetadataVersion>
-  > = () => getMetadataVersion(datasetid, datasetversion, requestOptions);
+  > = () => getMetadataVersion(datasetId, datasetVersion, requestOptions);
 
   const query = useQuery<
     AsyncReturnType<typeof getMetadataVersion>,
     TError,
     TData
   >(queryKey, queryFn, {
-    enabled: !!(datasetid && datasetversion),
+    enabled: !!(datasetId && datasetVersion),
     ...queryOptions,
   });
 
@@ -186,7 +198,7 @@ The labels are provided in a list in JSON format. For details of the label forma
  * @summary Update Metadata for the Dataset
  */
 export const addMetadata = (
-  datasetid: string,
+  datasetId: string,
   datasetMetaPostBodyBody: DatasetMetaPostBodyBody,
   options?: SecondParameter<typeof customInstance>
 ) => {
@@ -199,11 +211,22 @@ export const addMetadata = (
   }
 
   return customInstance<DatasetMetaGetResponse>(
-    { url: `/dataset/${datasetid}/meta`, method: "post", data: formData },
+    {
+      url: `/dataset/${datasetId}/meta`,
+      method: "post",
+      headers: { "Content-Type": "multipart/form-data" },
+      data: formData,
+    },
     options
   );
 };
 
+export type AddMetadataMutationResult = NonNullable<
+  AsyncReturnType<typeof addMetadata>
+>;
+export type AddMetadataMutationBody = DatasetMetaPostBodyBody;
+export type AddMetadataMutationError = ErrorType<DmError | void>;
+
 export const useAddMetadata = <
   TError = ErrorType<DmError | void>,
   TContext = unknown
@@ -211,7 +234,7 @@ export const useAddMetadata = <
   mutation?: UseMutationOptions<
     AsyncReturnType<typeof addMetadata>,
     TError,
-    { datasetid: string; data: DatasetMetaPostBodyBody },
+    { datasetId: string; data: DatasetMetaPostBodyBody },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
@@ -220,17 +243,17 @@ export const useAddMetadata = <
 
   const mutationFn: MutationFunction<
     AsyncReturnType<typeof addMetadata>,
-    { datasetid: string; data: DatasetMetaPostBodyBody }
+    { datasetId: string; data: DatasetMetaPostBodyBody }
   > = (props) => {
-    const { datasetid, data } = props || {};
+    const { datasetId, data } = props || {};
 
-    return addMetadata(datasetid, data, requestOptions);
+    return addMetadata(datasetId, data, requestOptions);
   };
 
   return useMutation<
     AsyncReturnType<typeof addMetadata>,
     TError,
-    { datasetid: string; data: DatasetMetaPostBodyBody },
+    { datasetId: string; data: DatasetMetaPostBodyBody },
     TContext
   >(mutationFn, mutationOptions);
 };
@@ -240,24 +263,29 @@ export const useAddMetadata = <
  * @summary Gets the metadata for a specific Dataset
  */
 export const getMetadata = (
-  datasetid: string,
+  datasetId: string,
   options?: SecondParameter<typeof customInstance>
 ) => {
   return customInstance<DatasetMetaGetResponse>(
-    { url: `/dataset/${datasetid}/meta`, method: "get" },
+    { url: `/dataset/${datasetId}/meta`, method: "get" },
     options
   );
 };
 
-export const getGetMetadataQueryKey = (datasetid: string) => [
-  `/dataset/${datasetid}/meta`,
+export const getGetMetadataQueryKey = (datasetId: string) => [
+  `/dataset/${datasetId}/meta`,
 ];
 
+export type GetMetadataQueryResult = NonNullable<
+  AsyncReturnType<typeof getMetadata>
+>;
+export type GetMetadataQueryError = ErrorType<void | DmError>;
+
 export const useGetMetadata = <
   TData = AsyncReturnType<typeof getMetadata>,
   TError = ErrorType<void | DmError>
 >(
-  datasetid: string,
+  datasetId: string,
   options?: {
     query?: UseQueryOptions<AsyncReturnType<typeof getMetadata>, TError, TData>;
     request?: SecondParameter<typeof customInstance>;
@@ -265,15 +293,15 @@ export const useGetMetadata = <
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
   const { query: queryOptions, request: requestOptions } = options || {};
 
-  const queryKey = queryOptions?.queryKey ?? getGetMetadataQueryKey(datasetid);
+  const queryKey = queryOptions?.queryKey ?? getGetMetadataQueryKey(datasetId);
 
   const queryFn: QueryFunction<AsyncReturnType<typeof getMetadata>> = () =>
-    getMetadata(datasetid, requestOptions);
+    getMetadata(datasetId, requestOptions);
 
   const query = useQuery<AsyncReturnType<typeof getMetadata>, TError, TData>(
     queryKey,
     queryFn,
-    { enabled: !!datasetid, ...queryOptions }
+    { enabled: !!datasetId, ...queryOptions }
   );
 
   return {