@squonk/account-server-client 4.7.0-trunk.2383504127 → 4.7.2

package/src/api/organisation/organisation.ts

@@ -1,11 +1,11 @@
 /**
- * Generated by orval v7.17.0 🍺
+ * Generated by orval v8.22.0 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
-
-A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
-
+ *
+ * A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
+ *
  * OpenAPI spec version: 4.7
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
@@ -36,18 +36,32 @@ import type {
   OrganisationPostBodyBody,
   OrganisationPostResponse,
   OrganisationsGetResponse,
-} from ".././api-schemas";
+} from "../api-schemas";
 
 import { customInstance } from "../../custom-axios";
 import type { ErrorType } from "../../custom-axios";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
+const withQueryKey = <T extends object, K>(query: T, queryKey: K): T & { queryKey: K } => {
+  const result = { queryKey } as T & { queryKey: K };
+  for (const key of Object.keys(query)) {
+    // The explicit queryKey always wins, matching the previous
+    // `{ ...query, queryKey }` spread where it was set last.
+    if (key === "queryKey") continue;
+    Object.defineProperty(result, key, {
+      enumerable: true,
+      configurable: true,
+      get: () => (query as Record<string, unknown>)[key],
+    });
+  }
+  return result;
+};
+
 /**
  * Gets all the Organisations that you are a member of, or a specific Organisation by name.
-
-You can see an Organisation if you are a member of it, the owner (creator) of it, or if you are an admin user.
-
+ *
+ * You can see an Organisation if you are a member of it, the owner (creator) of it, or if you are an admin user.
  * @summary Gets Organisations
  */
 export const getOrganisations = (
@@ -86,7 +100,7 @@ export const getGetOrganisationsQueryOptions = <
     Awaited<ReturnType<typeof getOrganisations>>,
     TError,
     TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 };
 
 export type GetOrganisationsQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisations>>>;
@@ -110,7 +124,7 @@ export function useGetOrganisations<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetOrganisations<
   TData = Awaited<ReturnType<typeof getOrganisations>>,
   TError = ErrorType<void | AsError>,
@@ -129,7 +143,7 @@ export function useGetOrganisations<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetOrganisations<
   TData = Awaited<ReturnType<typeof getOrganisations>>,
   TError = ErrorType<void | AsError>,
@@ -140,7 +154,7 @@ export function useGetOrganisations<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets Organisations
  */
@@ -155,16 +169,14 @@ export function useGetOrganisations<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetOrganisationsQueryOptions(params, options);
 
   const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
-    queryKey: DataTag<QueryKey, TData>;
+    queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  query.queryKey = queryOptions.queryKey;
-
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -203,7 +215,7 @@ export const getGetOrganisationsSuspenseQueryOptions = <
     Awaited<ReturnType<typeof getOrganisations>>,
     TError,
     TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 };
 
 export type GetOrganisationsSuspenseQueryResult = NonNullable<
@@ -223,7 +235,7 @@ export function useGetOrganisationsSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetOrganisationsSuspense<
   TData = Awaited<ReturnType<typeof getOrganisations>>,
   TError = ErrorType<void | AsError>,
@@ -236,7 +248,7 @@ export function useGetOrganisationsSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetOrganisationsSuspense<
   TData = Awaited<ReturnType<typeof getOrganisations>>,
   TError = ErrorType<void | AsError>,
@@ -249,7 +261,7 @@ export function useGetOrganisationsSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets Organisations
  */
@@ -266,26 +278,23 @@ export function useGetOrganisationsSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetOrganisationsSuspenseQueryOptions(params, options);
 
   const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
     TData,
     TError
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  query.queryKey = queryOptions.queryKey;
-
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
  * Creates a new Organisation.
-
-The **User** who creates the Organisation becomes the **Owner** of the Organisation. They are considered a *Member* (**User**) of the Organisation but are not present in the list of users, which a separate list of users explicitly added to the Organisation by the Owner or another Organisation User.
-
-You need admin rights to use this method
-
+ *
+ * The **User** who creates the Organisation becomes the **Owner** of the Organisation. They are considered a *Member* (**User**) of the Organisation but are not present in the list of users, which a separate list of users explicitly added to the Organisation by the Owner or another Organisation User.
+ *
+ * You need admin rights to use this method
  * @summary Create a new organisation
  */
 export const createOrganisation = (
@@ -367,15 +376,12 @@ export const useCreateOrganisation = <TError = ErrorType<AsError | void>, TConte
   { data: OrganisationPostBodyBody },
   TContext
 > => {
-  const mutationOptions = getCreateOrganisationMutationOptions(options);
-
-  return useMutation(mutationOptions, queryClient);
+  return useMutation(getCreateOrganisationMutationOptions(options), queryClient);
 };
 /**
  * Gets an Organisation. To see the Organisation you need admin rights or need to be a member of the Organisation or are its *creator*.
-
-Members of an Organisation's **Unit** do not have access to the Organisation.
-
+ *
+ * Members of an Organisation's **Unit** do not have access to the Organisation.
  * @summary Gets an Organisation
  */
 export const getOrganisation = (
@@ -389,7 +395,7 @@ export const getOrganisation = (
   );
 };
 
-export const getGetOrganisationQueryKey = (orgId?: string) => {
+export const getGetOrganisationQueryKey = (orgId: string) => {
   return ["account-server", "organisation", orgId] as const;
 };
 
@@ -410,11 +416,14 @@ export const getGetOrganisationQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisation>>> = ({ signal }) =>
     getOrganisation(orgId, requestOptions, signal);
 
-  return { queryKey, queryFn, enabled: !!orgId, ...queryOptions } as UseQueryOptions<
-    Awaited<ReturnType<typeof getOrganisation>>,
-    TError,
-    TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  return {
+    queryKey,
+    queryFn,
+    enabled: orgId !== null && orgId !== undefined,
+    ...queryOptions,
+  } as UseQueryOptions<Awaited<ReturnType<typeof getOrganisation>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+  };
 };
 
 export type GetOrganisationQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisation>>>;
@@ -438,7 +447,7 @@ export function useGetOrganisation<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetOrganisation<
   TData = Awaited<ReturnType<typeof getOrganisation>>,
   TError = ErrorType<void | AsError>,
@@ -457,7 +466,7 @@ export function useGetOrganisation<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetOrganisation<
   TData = Awaited<ReturnType<typeof getOrganisation>>,
   TError = ErrorType<void | AsError>,
@@ -468,7 +477,7 @@ export function useGetOrganisation<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets an Organisation
  */
@@ -483,16 +492,14 @@ export function useGetOrganisation<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetOrganisationQueryOptions(orgId, options);
 
   const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
-    queryKey: DataTag<QueryKey, TData>;
+    queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  query.queryKey = queryOptions.queryKey;
-
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -531,7 +538,7 @@ export const getGetOrganisationSuspenseQueryOptions = <
     Awaited<ReturnType<typeof getOrganisation>>,
     TError,
     TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 };
 
 export type GetOrganisationSuspenseQueryResult = NonNullable<
@@ -551,7 +558,7 @@ export function useGetOrganisationSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetOrganisationSuspense<
   TData = Awaited<ReturnType<typeof getOrganisation>>,
   TError = ErrorType<void | AsError>,
@@ -564,7 +571,7 @@ export function useGetOrganisationSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetOrganisationSuspense<
   TData = Awaited<ReturnType<typeof getOrganisation>>,
   TError = ErrorType<void | AsError>,
@@ -577,7 +584,7 @@ export function useGetOrganisationSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets an Organisation
  */
@@ -594,32 +601,30 @@ export function useGetOrganisationSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetOrganisationSuspenseQueryOptions(orgId, options);
 
   const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
     TData,
     TError
-  > & { queryKey: DataTag<QueryKey, TData> };
-
-  query.queryKey = queryOptions.queryKey;
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
  * Used to update existing Organisation. You can change an Organisation's **name** or its **default_product_privacy**.
-
-Changes to the default product privacy may conflict with those settings in any existing Units where the default product privacy of those existing units will be honoured. Any new Organisation value will only apply to new Units.
-
-You have to be a member of the **Organisation**, its creator, or an administrator to patch an Organisation.
-
+ *
+ * Changes to the default product privacy may conflict with those settings in any existing Units where the default product privacy of those existing units will be honoured. Any new Organisation value will only apply to new Units.
+ *
+ * You have to be a member of the **Organisation**, its creator, or an administrator to patch an Organisation.
  * @summary Adjust an existing Organisation
  */
 export const patchOrganisation = (
   orgId: string,
   organisationPatchBodyBody: OrganisationPatchBodyBody,
   options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal,
 ) => {
   return customInstance<void>(
     {
@@ -627,6 +632,7 @@ export const patchOrganisation = (
       method: "PATCH",
       headers: { "Content-Type": "application/json" },
       data: organisationPatchBodyBody,
+      signal,
     },
     options,
   );
@@ -694,22 +700,20 @@ export const usePatchOrganisation = <TError = ErrorType<void | AsError>, TContex
   { orgId: string; data: OrganisationPatchBodyBody },
   TContext
 > => {
-  const mutationOptions = getPatchOrganisationMutationOptions(options);
-
-  return useMutation(mutationOptions, queryClient);
+  return useMutation(getPatchOrganisationMutationOptions(options), queryClient);
 };
 /**
  * Before an Organisation can be deleted all its underlying **Units** must also be deleted, remembering that **Units** that have undeleted **Products** cannot be deleted.
-
-You need admin rights to use this method
-
+ *
+ * You need admin rights to use this method
  * @summary Deletes an Organisation
  */
 export const deleteOrganisation = (
   orgId: string,
   options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal,
 ) => {
-  return customInstance<void>({ url: `/organisation/${orgId}`, method: "DELETE" }, options);
+  return customInstance<void>({ url: `/organisation/${orgId}`, method: "DELETE", signal }, options);
 };
 
 export const getDeleteOrganisationMutationOptions = <
@@ -774,15 +778,12 @@ export const useDeleteOrganisation = <TError = ErrorType<AsError | void>, TConte
   { orgId: string },
   TContext
 > => {
-  const mutationOptions = getDeleteOrganisationMutationOptions(options);
-
-  return useMutation(mutationOptions, queryClient);
+  return useMutation(getDeleteOrganisationMutationOptions(options), queryClient);
 };
 /**
  * Gets the Default Organisation, a built-in Organisation used exclusively for **Personal Units**.
-
-Any authorised user can see the Default Organisation.
-
+ *
+ * Any authorised user can see the Default Organisation.
  * @summary Gets the Default Organisation
  */
 export const getDefaultOrganisation = (
@@ -819,7 +820,7 @@ export const getGetDefaultOrganisationQueryOptions = <
     Awaited<ReturnType<typeof getDefaultOrganisation>>,
     TError,
     TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 };
 
 export type GetDefaultOrganisationQueryResult = NonNullable<
@@ -846,7 +847,7 @@ export function useGetDefaultOrganisation<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetDefaultOrganisation<
   TData = Awaited<ReturnType<typeof getDefaultOrganisation>>,
   TError = ErrorType<void | AsError>,
@@ -866,7 +867,7 @@ export function useGetDefaultOrganisation<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetDefaultOrganisation<
   TData = Awaited<ReturnType<typeof getDefaultOrganisation>>,
   TError = ErrorType<void | AsError>,
@@ -878,7 +879,7 @@ export function useGetDefaultOrganisation<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets the Default Organisation
  */
@@ -894,16 +895,14 @@ export function useGetDefaultOrganisation<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetDefaultOrganisationQueryOptions(options);
 
   const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
-    queryKey: DataTag<QueryKey, TData>;
+    queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  query.queryKey = queryOptions.queryKey;
-
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -938,7 +937,7 @@ export const getGetDefaultOrganisationSuspenseQueryOptions = <
     Awaited<ReturnType<typeof getDefaultOrganisation>>,
     TError,
     TData
-  > & { queryKey: DataTag<QueryKey, TData> };
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 };
 
 export type GetDefaultOrganisationSuspenseQueryResult = NonNullable<
@@ -957,7 +956,7 @@ export function useGetDefaultOrganisationSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetDefaultOrganisationSuspense<
   TData = Awaited<ReturnType<typeof getDefaultOrganisation>>,
   TError = ErrorType<void | AsError>,
@@ -969,7 +968,7 @@ export function useGetDefaultOrganisationSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 export function useGetDefaultOrganisationSuspense<
   TData = Awaited<ReturnType<typeof getDefaultOrganisation>>,
   TError = ErrorType<void | AsError>,
@@ -981,7 +980,7 @@ export function useGetDefaultOrganisationSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> };
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Gets the Default Organisation
  */
@@ -997,15 +996,13 @@ export function useGetDefaultOrganisationSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData> } {
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
   const queryOptions = getGetDefaultOrganisationSuspenseQueryOptions(options);
 
   const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
     TData,
     TError
-  > & { queryKey: DataTag<QueryKey, TData> };
-
-  query.queryKey = queryOptions.queryKey;
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return query;
+  return withQueryKey(query, queryOptions.queryKey);
 }