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

package/src/inventory/inventory.ts

@@ -1,41 +1,39 @@
-// @ts-nocheck
 /**
- * Generated by orval v7.4.1 🍺
+ * Generated by orval v7.10.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
 
 A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications**, **Jobs**, and **Workflows** using **Projects** and **Files**.
 
- * OpenAPI spec version: 4.1
+ * OpenAPI spec version: 5.0
  */
-import {
-  useQuery,
-  useSuspenseQuery
-} from '@tanstack/react-query'
+import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
   DataTag,
   DefinedInitialDataOptions,
   DefinedUseQueryResult,
+  QueryClient,
   QueryFunction,
   QueryKey,
   UndefinedInitialDataOptions,
   UseQueryOptions,
   UseQueryResult,
   UseSuspenseQueryOptions,
-  UseSuspenseQueryResult
-} from '@tanstack/react-query'
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+
 import type {
   DmError,
   GetUserInventoryParams,
-  InventoryUserGetResponse
-} from '../data-manager-api.schemas'
-import { customInstance } from '.././custom-instance';
-import type { ErrorType } from '.././custom-instance';
-
+  InventoryUserGetResponse,
+} from "../API_TARGET_NAME.schemas";
 
-type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
+import { customInstance } from ".././custom-instance";
+import type { ErrorType } from ".././custom-instance";
+import { queryMutator } from ".././options-mutator";
 
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
 /**
  * Returns an inventory of users, which includes Projects membership and Datasets they own. An Account Server **Unit** or **Organisation** must be provided (but not both).
@@ -45,141 +43,221 @@ The caller must also be a member of the provided Unit or Organisation, i.e. you
  * @summary Get User Inventory
  */
 export const getUserInventory = (
-    params?: GetUserInventoryParams,
- options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
+  params?: GetUserInventoryParams,
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal,
 ) => {
-      
-      
-      return customInstance<InventoryUserGetResponse>(
-      {url: `/inventory/user`, method: 'GET',
-        params, signal
-    },
-      options);
-    }
-  
-
-export const getGetUserInventoryQueryKey = (params?: GetUserInventoryParams,) => {
-    return ["data-manager-api", `/inventory/user`, ...(params ? [params]: [])] as const;
-    }
-
-    
-export const getGetUserInventoryQueryOptions = <TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(params?: GetUserInventoryParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+  return customInstance<InventoryUserGetResponse>(
+    { url: `/inventory/user`, method: "GET", params, signal },
+    options,
+  );
+};
+
+export const getGetUserInventoryQueryKey = (params?: GetUserInventoryParams) => {
+  return [`/inventory/user`, ...(params ? [params] : [])] as const;
+};
+
+export const useGetUserInventoryQueryOptions = <
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params?: GetUserInventoryParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
 ) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
 
-const {query: queryOptions, request: requestOptions} = options ?? {};
-
-  const queryKey =  queryOptions?.queryKey ?? getGetUserInventoryQueryKey(params);
-
-  
-
-    const queryFn: QueryFunction<Awaited<ReturnType<typeof getUserInventory>>> = ({ signal }) => getUserInventory(params, requestOptions, signal);
+  const queryKey = queryOptions?.queryKey ?? getGetUserInventoryQueryKey(params);
 
-      
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getUserInventory>>> = ({ signal }) =>
+    getUserInventory(params, requestOptions, signal);
 
-      
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
 
-   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
-}
-
-export type GetUserInventoryQueryResult = NonNullable<Awaited<ReturnType<typeof getUserInventory>>>
-export type GetUserInventoryQueryError = ErrorType<void | DmError>
+  return customOptions as UseQueryOptions<
+    Awaited<ReturnType<typeof getUserInventory>>,
+    TError,
+    TData
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+};
 
+export type GetUserInventoryQueryResult = NonNullable<Awaited<ReturnType<typeof getUserInventory>>>;
+export type GetUserInventoryQueryError = ErrorType<void | DmError>;
 
-export function useGetUserInventory<TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
- params: undefined |  GetUserInventoryParams, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>> & Pick<
+export function useGetUserInventory<
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params: undefined | GetUserInventoryParams,
+  options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>> &
+      Pick<
         DefinedInitialDataOptions<
           Awaited<ReturnType<typeof getUserInventory>>,
           TError,
-          TData
-        > , 'initialData'
-      >, request?: SecondParameter<typeof customInstance>}
-
-  ):  DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetUserInventory<TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
- params?: GetUserInventoryParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>> & Pick<
+          Awaited<ReturnType<typeof getUserInventory>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetUserInventory<
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params?: GetUserInventoryParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>> &
+      Pick<
         UndefinedInitialDataOptions<
           Awaited<ReturnType<typeof getUserInventory>>,
           TError,
-          TData
-        > , 'initialData'
-      >, request?: SecondParameter<typeof customInstance>}
-
-  ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetUserInventory<TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
- params?: GetUserInventoryParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
-
-  ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
+          Awaited<ReturnType<typeof getUserInventory>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetUserInventory<
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params?: GetUserInventoryParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Get User Inventory
  */
 
-export function useGetUserInventory<TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
- params?: GetUserInventoryParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
-
-  ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
-
-  const queryOptions = getGetUserInventoryQueryOptions(params,options)
-
-  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-
-  query.queryKey = queryOptions.queryKey ;
+export function useGetUserInventory<
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params?: GetUserInventoryParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = useGetUserInventoryQueryOptions(params, options);
+
+  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+  };
+
+  query.queryKey = queryOptions.queryKey;
 
   return query;
 }
 
-
-
-export const getGetUserInventorySuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(params?: GetUserInventoryParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export const useGetUserInventorySuspenseQueryOptions = <
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params?: GetUserInventoryParams,
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
 ) => {
-
-const {query: queryOptions, request: requestOptions} = options ?? {};
-
-  const queryKey =  queryOptions?.queryKey ?? getGetUserInventoryQueryKey(params);
-
-  
-
-    const queryFn: QueryFunction<Awaited<ReturnType<typeof getUserInventory>>> = ({ signal }) => getUserInventory(params, requestOptions, signal);
-
-      
-
-      
-
-   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
-}
-
-export type GetUserInventorySuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getUserInventory>>>
-export type GetUserInventorySuspenseQueryError = ErrorType<void | DmError>
-
-
-export function useGetUserInventorySuspense<TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
- params: undefined |  GetUserInventoryParams, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
-
-  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetUserInventorySuspense<TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
- params?: GetUserInventoryParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
-
-  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetUserInventorySuspense<TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
- params?: GetUserInventoryParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
-
-  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetUserInventoryQueryKey(params);
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getUserInventory>>> = ({ signal }) =>
+    getUserInventory(params, requestOptions, signal);
+
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
+  return customOptions as UseSuspenseQueryOptions<
+    Awaited<ReturnType<typeof getUserInventory>>,
+    TError,
+    TData
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+};
+
+export type GetUserInventorySuspenseQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getUserInventory>>
+>;
+export type GetUserInventorySuspenseQueryError = ErrorType<void | DmError>;
+
+export function useGetUserInventorySuspense<
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params: undefined | GetUserInventoryParams,
+  options: {
+    query: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetUserInventorySuspense<
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params?: GetUserInventoryParams,
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetUserInventorySuspense<
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params?: GetUserInventoryParams,
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Get User Inventory
  */
 
-export function useGetUserInventorySuspense<TData = Awaited<ReturnType<typeof getUserInventory>>, TError = ErrorType<void | DmError>>(
- params?: GetUserInventoryParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
-
-  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
-
-  const queryOptions = getGetUserInventorySuspenseQueryOptions(params,options)
-
-  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-
-  query.queryKey = queryOptions.queryKey ;
+export function useGetUserInventorySuspense<
+  TData = Awaited<ReturnType<typeof getUserInventory>>,
+  TError = ErrorType<void | DmError>,
+>(
+  params?: GetUserInventoryParams,
+  options?: {
+    query?: Partial<
+      UseSuspenseQueryOptions<Awaited<ReturnType<typeof getUserInventory>>, TError, TData>
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = useGetUserInventorySuspenseQueryOptions(params, options);
+
+  const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
+    TData,
+    TError
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+
+  query.queryKey = queryOptions.queryKey;
 
   return query;
 }
-
-
-