@squonk/account-server-client 2.1.0-rc.8 → 2.1.0

package/src/organisation/organisation.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v6.20.0 🍺
+ * Generated by orval v6.25.0 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
@@ -10,7 +10,8 @@ A service that provides access to the Account Server, which gives *registered* u
  */
 import {
   useMutation,
-  useQuery
+  useQuery,
+  useSuspenseQuery
 } from '@tanstack/react-query'
 import type {
   MutationFunction,
@@ -18,7 +19,9 @@ import type {
   QueryKey,
   UseMutationOptions,
   UseQueryOptions,
-  UseQueryResult
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult
 } from '@tanstack/react-query'
 import type {
   AsError,
@@ -35,13 +38,7 @@ import { customInstance } from '.././custom-instance';
 import type { ErrorType } from '.././custom-instance';
 
 
-// eslint-disable-next-line
-  type SecondParameter<T extends (...args: any) => any> = T extends (
-  config: any,
-  args: infer P,
-) => any
-  ? P
-  : never;
+type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
 
 
 /**
@@ -56,19 +53,18 @@ export const getOrganisations = (
       
       
       return customInstance<OrganisationsGetResponse>(
-      {url: `/organisation`, method: 'get', signal
+      {url: `/organisation`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getGetOrganisationsQueryKey = () => {
-    
     return ["account-server-api", `/organisation`] as const;
     }
 
     
-export const getGetOrganisationsQueryOptions = <TData = Awaited<ReturnType<typeof getOrganisations>>, TError = ErrorType<void | AsError>>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getOrganisations>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetOrganisationsQueryOptions = <TData = Awaited<ReturnType<typeof getOrganisations>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getOrganisations>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -93,7 +89,7 @@ export type GetOrganisationsQueryError = ErrorType<void | AsError>
  * @summary Gets Organisations
  */
 export const useGetOrganisations = <TData = Awaited<ReturnType<typeof getOrganisations>>, TError = ErrorType<void | AsError>>(
-  options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getOrganisations>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getOrganisations>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -108,6 +104,46 @@ export const useGetOrganisations = <TData = Awaited<ReturnType<typeof getOrganis
 
 
 
+export const getGetOrganisationsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getOrganisations>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getOrganisations>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetOrganisationsQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisations>>> = ({ signal }) => getOrganisations(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getOrganisations>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetOrganisationsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisations>>>
+export type GetOrganisationsSuspenseQueryError = ErrorType<void | AsError>
+
+/**
+ * @summary Gets Organisations
+ */
+export const useGetOrganisationsSuspense = <TData = Awaited<ReturnType<typeof getOrganisations>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getOrganisations>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetOrganisationsSuspenseQueryOptions(options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
 /**
  * Creates a new Organisation
 
@@ -121,7 +157,7 @@ export const createOrganisation = (
       
       
       return customInstance<OrganisationPostResponse>(
-      {url: `/organisation`, method: 'post',
+      {url: `/organisation`, method: 'POST',
       headers: {'Content-Type': 'application/json', },
       data: organisationPostBodyBody
     },
@@ -131,7 +167,6 @@ export const createOrganisation = (
 
 
 export const getCreateOrganisationMutationOptions = <TError = ErrorType<AsError | void>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createOrganisation>>, TError,{data: OrganisationPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof createOrganisation>>, TError,{data: OrganisationPostBodyBody}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -158,7 +193,6 @@ export const getCreateOrganisationMutationOptions = <TError = ErrorType<AsError
  * @summary Create a new organisation
  */
 export const useCreateOrganisation = <TError = ErrorType<AsError | void>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof createOrganisation>>, TError,{data: OrganisationPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -180,19 +214,18 @@ export const getOrganisation = (
       
       
       return customInstance<OrganisationDetail>(
-      {url: `/organisation/${orgId}`, method: 'get', signal
+      {url: `/organisation/${orgId}`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getGetOrganisationQueryKey = (orgId: string,) => {
-    
     return ["account-server-api", `/organisation/${orgId}`] as const;
     }
 
     
-export const getGetOrganisationQueryOptions = <TData = Awaited<ReturnType<typeof getOrganisation>>, TError = ErrorType<void | AsError>>(orgId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getOrganisation>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetOrganisationQueryOptions = <TData = Awaited<ReturnType<typeof getOrganisation>>, TError = ErrorType<void | AsError>>(orgId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getOrganisation>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -217,7 +250,7 @@ export type GetOrganisationQueryError = ErrorType<void | AsError>
  * @summary Gets an Organisation
  */
 export const useGetOrganisation = <TData = Awaited<ReturnType<typeof getOrganisation>>, TError = ErrorType<void | AsError>>(
- orgId: string, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getOrganisation>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+ orgId: string, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getOrganisation>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -232,6 +265,46 @@ export const useGetOrganisation = <TData = Awaited<ReturnType<typeof getOrganisa
 
 
 
+export const getGetOrganisationSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getOrganisation>>, TError = ErrorType<void | AsError>>(orgId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getOrganisation>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetOrganisationQueryKey(orgId);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisation>>> = ({ signal }) => getOrganisation(orgId, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(orgId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getOrganisation>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetOrganisationSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisation>>>
+export type GetOrganisationSuspenseQueryError = ErrorType<void | AsError>
+
+/**
+ * @summary Gets an Organisation
+ */
+export const useGetOrganisationSuspense = <TData = Awaited<ReturnType<typeof getOrganisation>>, TError = ErrorType<void | AsError>>(
+ orgId: string, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getOrganisation>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetOrganisationSuspenseQueryOptions(orgId,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
 /**
  * Used to update existing Organisation.
 
@@ -246,7 +319,7 @@ export const patchOrganisation = (
       
       
       return customInstance<void>(
-      {url: `/organisation/${orgId}`, method: 'patch',
+      {url: `/organisation/${orgId}`, method: 'PATCH',
       headers: {'Content-Type': 'application/json', },
       data: organisationPatchBodyBody
     },
@@ -256,7 +329,6 @@ export const patchOrganisation = (
 
 
 export const getPatchOrganisationMutationOptions = <TError = ErrorType<AsError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof patchOrganisation>>, TError,{orgId: string;data: OrganisationPatchBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof patchOrganisation>>, TError,{orgId: string;data: OrganisationPatchBodyBody}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -283,7 +355,6 @@ export const getPatchOrganisationMutationOptions = <TError = ErrorType<AsError>,
  * @summary Adjust an existing Organisation
  */
 export const usePatchOrganisation = <TError = ErrorType<AsError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof patchOrganisation>>, TError,{orgId: string;data: OrganisationPatchBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -304,7 +375,7 @@ export const deleteOrganisation = (
       
       
       return customInstance<void>(
-      {url: `/organisation/${orgId}`, method: 'delete'
+      {url: `/organisation/${orgId}`, method: 'DELETE'
     },
       options);
     }
@@ -312,7 +383,6 @@ export const deleteOrganisation = (
 
 
 export const getDeleteOrganisationMutationOptions = <TError = ErrorType<AsError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteOrganisation>>, TError,{orgId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
 ): UseMutationOptions<Awaited<ReturnType<typeof deleteOrganisation>>, TError,{orgId: string}, TContext> => {
  const {mutation: mutationOptions, request: requestOptions} = options ?? {};
@@ -339,7 +409,6 @@ export const getDeleteOrganisationMutationOptions = <TError = ErrorType<AsError>
  * @summary Deletes an Organisation
  */
 export const useDeleteOrganisation = <TError = ErrorType<AsError>,
-    
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof deleteOrganisation>>, TError,{orgId: string}, TContext>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
@@ -362,7 +431,7 @@ export const getOrganisationCharges = (
       
       
       return customInstance<OrganisationChargesGetResponse>(
-      {url: `/organisation/${orgId}/charges`, method: 'get',
+      {url: `/organisation/${orgId}/charges`, method: 'GET',
         params, signal
     },
       options);
@@ -371,13 +440,12 @@ export const getOrganisationCharges = (
 
 export const getGetOrganisationChargesQueryKey = (orgId: string,
     params?: GetOrganisationChargesParams,) => {
-    
     return ["account-server-api", `/organisation/${orgId}/charges`, ...(params ? [params]: [])] as const;
     }
 
     
 export const getGetOrganisationChargesQueryOptions = <TData = Awaited<ReturnType<typeof getOrganisationCharges>>, TError = ErrorType<void | AsError>>(orgId: string,
-    params?: GetOrganisationChargesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getOrganisationCharges>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+    params?: GetOrganisationChargesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getOrganisationCharges>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -403,7 +471,7 @@ export type GetOrganisationChargesQueryError = ErrorType<void | AsError>
  */
 export const useGetOrganisationCharges = <TData = Awaited<ReturnType<typeof getOrganisationCharges>>, TError = ErrorType<void | AsError>>(
  orgId: string,
-    params?: GetOrganisationChargesParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getOrganisationCharges>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+    params?: GetOrganisationChargesParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getOrganisationCharges>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -418,6 +486,48 @@ export const useGetOrganisationCharges = <TData = Awaited<ReturnType<typeof getO
 
 
 
+export const getGetOrganisationChargesSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getOrganisationCharges>>, TError = ErrorType<void | AsError>>(orgId: string,
+    params?: GetOrganisationChargesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getOrganisationCharges>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetOrganisationChargesQueryKey(orgId,params);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisationCharges>>> = ({ signal }) => getOrganisationCharges(orgId,params, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(orgId), ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getOrganisationCharges>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetOrganisationChargesSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getOrganisationCharges>>>
+export type GetOrganisationChargesSuspenseQueryError = ErrorType<void | AsError>
+
+/**
+ * @summary Gets charges for all Units in an Organisation
+ */
+export const useGetOrganisationChargesSuspense = <TData = Awaited<ReturnType<typeof getOrganisationCharges>>, TError = ErrorType<void | AsError>>(
+ orgId: string,
+    params?: GetOrganisationChargesParams, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getOrganisationCharges>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetOrganisationChargesSuspenseQueryOptions(orgId,params,options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
 /**
  * Gets the Default Organisation, a built-in Organisation used exclusively for **Personal Units**.
 
@@ -432,19 +542,18 @@ export const getDefaultOrganisation = (
       
       
       return customInstance<OrganisationGetDefaultResponse>(
-      {url: `/organisation/default`, method: 'get', signal
+      {url: `/organisation/default`, method: 'GET', signal
     },
       options);
     }
   
 
 export const getGetDefaultOrganisationQueryKey = () => {
-    
     return ["account-server-api", `/organisation/default`] as const;
     }
 
     
-export const getGetDefaultOrganisationQueryOptions = <TData = Awaited<ReturnType<typeof getDefaultOrganisation>>, TError = ErrorType<void | AsError>>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getDefaultOrganisation>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+export const getGetDefaultOrganisationQueryOptions = <TData = Awaited<ReturnType<typeof getDefaultOrganisation>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getDefaultOrganisation>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
@@ -469,7 +578,7 @@ export type GetDefaultOrganisationQueryError = ErrorType<void | AsError>
  * @summary Gets the Default Organisation
  */
 export const useGetDefaultOrganisation = <TData = Awaited<ReturnType<typeof getDefaultOrganisation>>, TError = ErrorType<void | AsError>>(
-  options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof getDefaultOrganisation>>, TError, TData>, request?: SecondParameter<typeof customInstance>}
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getDefaultOrganisation>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
 
@@ -484,3 +593,43 @@ export const useGetDefaultOrganisation = <TData = Awaited<ReturnType<typeof getD
 
 
 
+export const getGetDefaultOrganisationSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getDefaultOrganisation>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDefaultOrganisation>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getGetDefaultOrganisationQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getDefaultOrganisation>>> = ({ signal }) => getDefaultOrganisation(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDefaultOrganisation>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type GetDefaultOrganisationSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getDefaultOrganisation>>>
+export type GetDefaultOrganisationSuspenseQueryError = ErrorType<void | AsError>
+
+/**
+ * @summary Gets the Default Organisation
+ */
+export const useGetDefaultOrganisationSuspense = <TData = Awaited<ReturnType<typeof getDefaultOrganisation>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getDefaultOrganisation>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+
+  ):  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const queryOptions = getGetDefaultOrganisationSuspenseQueryOptions(options)
+
+  const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+