@squonk/account-server-client 4.11.0 → 4.12.0

package/src/api/capabilities/capabilities.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -34,6 +34,8 @@ import type {
   CapabilityPostBodyBody,
   CapabilityPostResponse,
   DefaultCapabilitiesGetResponse,
+  DeleteCapabilityParams,
+  DeleteDefaultCapabilityParams,
   GetAllCapabilitiesParams,
 } from "../api-schemas";
 
@@ -622,7 +624,7 @@ export function useGetCapabilitiesSuspense<
 }
 
 /**
- * Deletes a Capability from an Organisation. What else happens depends on the Capability (see the Capability catalogue). A Default Capability cannot be deleted from one Organisation (it can be disabled).
+ * Deletes a Capability from an Organisation. What else happens depends on the Capability (see the Capability catalogue). If the Capability cannot be deleted, set `force` to delete it anyway. A Default Capability cannot be deleted from one Organisation (it can be disabled).
  *
  * You need admin rights to use this path.
  * @summary Deletes a Capability
@@ -630,11 +632,12 @@ export function useGetCapabilitiesSuspense<
 export const deleteCapability = (
   orgId: string,
   capabilityName: string,
+  params?: DeleteCapabilityParams,
   options?: SecondParameter<typeof customInstance>,
   signal?: AbortSignal,
 ) => {
   return customInstance<void>(
-    { url: `/capability/${orgId}/${capabilityName}`, method: "DELETE", signal },
+    { url: `/capability/${orgId}/${capabilityName}`, method: "DELETE", params, signal },
     options,
   );
 };
@@ -646,14 +649,14 @@ export const getDeleteCapabilityMutationOptions = <
   mutation?: UseMutationOptions<
     Awaited<ReturnType<typeof deleteCapability>>,
     TError,
-    { orgId: string; capabilityName: string },
+    { orgId: string; capabilityName: string; params?: DeleteCapabilityParams },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
 }): UseMutationOptions<
   Awaited<ReturnType<typeof deleteCapability>>,
   TError,
-  { orgId: string; capabilityName: string },
+  { orgId: string; capabilityName: string; params?: DeleteCapabilityParams },
   TContext
 > => {
   const mutationKey = ["deleteCapability"];
@@ -665,11 +668,11 @@ export const getDeleteCapabilityMutationOptions = <
 
   const mutationFn: MutationFunction<
     Awaited<ReturnType<typeof deleteCapability>>,
-    { orgId: string; capabilityName: string }
+    { orgId: string; capabilityName: string; params?: DeleteCapabilityParams }
   > = (props) => {
-    const { orgId, capabilityName } = props ?? {};
+    const { orgId, capabilityName, params } = props ?? {};
 
-    return deleteCapability(orgId, capabilityName, requestOptions);
+    return deleteCapability(orgId, capabilityName, params, requestOptions);
   };
 
   return { mutationFn, ...mutationOptions };
@@ -689,7 +692,7 @@ export const useDeleteCapability = <TError = ErrorType<void | AsError>, TContext
     mutation?: UseMutationOptions<
       Awaited<ReturnType<typeof deleteCapability>>,
       TError,
-      { orgId: string; capabilityName: string },
+      { orgId: string; capabilityName: string; params?: DeleteCapabilityParams },
       TContext
     >;
     request?: SecondParameter<typeof customInstance>;
@@ -698,7 +701,7 @@ export const useDeleteCapability = <TError = ErrorType<void | AsError>, TContext
 ): UseMutationResult<
   Awaited<ReturnType<typeof deleteCapability>>,
   TError,
-  { orgId: string; capabilityName: string },
+  { orgId: string; capabilityName: string; params?: DeleteCapabilityParams },
   TContext
 > => {
   return useMutation(getDeleteCapabilityMutationOptions(options), queryClient);
@@ -1023,18 +1026,19 @@ export function useGetDefaultCapabilitiesSuspense<
 }
 
 /**
- * Deletes a Default Capability, deleting it from every Organisation. What else happens depends on the Capability (see the Capability catalogue). If it cannot be deleted from an Organisation the Default Capability is not deleted, but it stays deleted from the Organisations it was deleted from, and the deletion can be tried again.
+ * Deletes a Default Capability, deleting it from every Organisation. What else happens depends on the Capability (see the Capability catalogue). If it cannot be deleted from an Organisation the Default Capability is not deleted, but it stays deleted from the Organisations it was deleted from, and the deletion can be tried again. Set `force` to delete the Capabilities (and the Default Capability) anyway.
  *
  * You need admin rights to use this path.
  * @summary Deletes a Default Capability
  */
 export const deleteDefaultCapability = (
   capabilityName: string,
+  params?: DeleteDefaultCapabilityParams,
   options?: SecondParameter<typeof customInstance>,
   signal?: AbortSignal,
 ) => {
   return customInstance<void>(
-    { url: `/default-capability/${capabilityName}`, method: "DELETE", signal },
+    { url: `/default-capability/${capabilityName}`, method: "DELETE", params, signal },
     options,
   );
 };
@@ -1046,14 +1050,14 @@ export const getDeleteDefaultCapabilityMutationOptions = <
   mutation?: UseMutationOptions<
     Awaited<ReturnType<typeof deleteDefaultCapability>>,
     TError,
-    { capabilityName: string },
+    { capabilityName: string; params?: DeleteDefaultCapabilityParams },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
 }): UseMutationOptions<
   Awaited<ReturnType<typeof deleteDefaultCapability>>,
   TError,
-  { capabilityName: string },
+  { capabilityName: string; params?: DeleteDefaultCapabilityParams },
   TContext
 > => {
   const mutationKey = ["deleteDefaultCapability"];
@@ -1065,11 +1069,11 @@ export const getDeleteDefaultCapabilityMutationOptions = <
 
   const mutationFn: MutationFunction<
     Awaited<ReturnType<typeof deleteDefaultCapability>>,
-    { capabilityName: string }
+    { capabilityName: string; params?: DeleteDefaultCapabilityParams }
   > = (props) => {
-    const { capabilityName } = props ?? {};
+    const { capabilityName, params } = props ?? {};
 
-    return deleteDefaultCapability(capabilityName, requestOptions);
+    return deleteDefaultCapability(capabilityName, params, requestOptions);
   };
 
   return { mutationFn, ...mutationOptions };
@@ -1089,7 +1093,7 @@ export const useDeleteDefaultCapability = <TError = ErrorType<void | AsError>, T
     mutation?: UseMutationOptions<
       Awaited<ReturnType<typeof deleteDefaultCapability>>,
       TError,
-      { capabilityName: string },
+      { capabilityName: string; params?: DeleteDefaultCapabilityParams },
       TContext
     >;
     request?: SecondParameter<typeof customInstance>;
@@ -1098,7 +1102,7 @@ export const useDeleteDefaultCapability = <TError = ErrorType<void | AsError>, T
 ): UseMutationResult<
   Awaited<ReturnType<typeof deleteDefaultCapability>>,
   TError,
-  { capabilityName: string },
+  { capabilityName: string; params?: DeleteDefaultCapabilityParams },
   TContext
 > => {
   return useMutation(getDeleteDefaultCapabilityMutationOptions(options), queryClient);

package/src/api/charges/charges.fetch.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/charges/charges.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/event-stream/event-stream.fetch.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/event-stream/event-stream.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/merchant/merchant.fetch.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/merchant/merchant.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/notifications/notifications.fetch.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/notifications/notifications.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/organisation/organisation.fetch.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -29,6 +29,7 @@ import type {
 
 import type {
   AsError,
+  DeleteOrganisationParams,
   GetOrganisationsParams,
   OrganisationAllDetail,
   OrganisationGetDefaultResponse,
@@ -816,23 +817,36 @@ export type deleteOrganisationResponse =
   | deleteOrganisationResponseSuccess
   | deleteOrganisationResponseError;
 
-export const getDeleteOrganisationUrl = (orgId: string) => {
-  return `/organisation/${orgId}`;
+export const getDeleteOrganisationUrl = (orgId: string, params?: DeleteOrganisationParams) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? "null" : String(value));
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0
+    ? `/organisation/${orgId}?${stringifiedParams}`
+    : `/organisation/${orgId}`;
 };
 
 /**
  * Before an Organisation can be deleted all its underlying **Units** must also be deleted, remembering that **Units** that have undeleted **Products** cannot be deleted.
  *
- * The Organisation's **Capabilities** are deleted with it, each doing what it does when it's deleted (for example, the `viz` Capability drops the Organisation's database). If a Capability cannot be deleted the Organisation is not deleted, and the Capabilities that were deleted remain deleted. Only an admin can delete an Organisation that has Capabilities.
+ * The Organisation's **Capabilities** are deleted with it, each doing what it does when it's deleted (for example, the `viz` Capability drops the Organisation's database). If a Capability cannot be deleted the Organisation is not deleted, and the Capabilities that were deleted remain deleted. An admin can set `force` to delete the Capabilities (and the Organisation) anyway. Only an admin can delete an Organisation that has Capabilities.
  *
  * You need admin rights to use this method
  * @summary Deletes an Organisation
  */
 export const deleteOrganisation = async (
   orgId: string,
+  params?: DeleteOrganisationParams,
   options?: RequestInit,
 ): Promise<deleteOrganisationResponse> => {
-  return customFetch<deleteOrganisationResponse>(getDeleteOrganisationUrl(orgId), {
+  return customFetch<deleteOrganisationResponse>(getDeleteOrganisationUrl(orgId, params), {
     ...options,
     method: "DELETE",
   });
@@ -845,14 +859,14 @@ export const getDeleteOrganisationMutationOptions = <
   mutation?: UseMutationOptions<
     Awaited<ReturnType<typeof deleteOrganisation>>,
     TError,
-    { orgId: string },
+    { orgId: string; params?: DeleteOrganisationParams },
     TContext
   >;
   request?: SecondParameter<typeof customFetch>;
 }): UseMutationOptions<
   Awaited<ReturnType<typeof deleteOrganisation>>,
   TError,
-  { orgId: string },
+  { orgId: string; params?: DeleteOrganisationParams },
   TContext
 > => {
   const mutationKey = ["deleteOrganisation"];
@@ -864,11 +878,11 @@ export const getDeleteOrganisationMutationOptions = <
 
   const mutationFn: MutationFunction<
     Awaited<ReturnType<typeof deleteOrganisation>>,
-    { orgId: string }
+    { orgId: string; params?: DeleteOrganisationParams }
   > = (props) => {
-    const { orgId } = props ?? {};
+    const { orgId, params } = props ?? {};
 
-    return deleteOrganisation(orgId, requestOptions);
+    return deleteOrganisation(orgId, params, requestOptions);
   };
 
   return { mutationFn, ...mutationOptions };
@@ -888,7 +902,7 @@ export const useDeleteOrganisation = <TError = ErrorType<AsError | void>, TConte
     mutation?: UseMutationOptions<
       Awaited<ReturnType<typeof deleteOrganisation>>,
       TError,
-      { orgId: string },
+      { orgId: string; params?: DeleteOrganisationParams },
       TContext
     >;
     request?: SecondParameter<typeof customFetch>;
@@ -897,7 +911,7 @@ export const useDeleteOrganisation = <TError = ErrorType<AsError | void>, TConte
 ): UseMutationResult<
   Awaited<ReturnType<typeof deleteOrganisation>>,
   TError,
-  { orgId: string },
+  { orgId: string; params?: DeleteOrganisationParams },
   TContext
 > => {
   return useMutation(getDeleteOrganisationMutationOptions(options), queryClient);

package/src/api/organisation/organisation.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
@@ -29,6 +29,7 @@ import type {
 
 import type {
   AsError,
+  DeleteOrganisationParams,
   GetOrganisationsParams,
   OrganisationAllDetail,
   OrganisationGetDefaultResponse,
@@ -705,17 +706,21 @@ export const usePatchOrganisation = <TError = ErrorType<void | AsError>, TContex
 /**
  * Before an Organisation can be deleted all its underlying **Units** must also be deleted, remembering that **Units** that have undeleted **Products** cannot be deleted.
  *
- * The Organisation's **Capabilities** are deleted with it, each doing what it does when it's deleted (for example, the `viz` Capability drops the Organisation's database). If a Capability cannot be deleted the Organisation is not deleted, and the Capabilities that were deleted remain deleted. Only an admin can delete an Organisation that has Capabilities.
+ * The Organisation's **Capabilities** are deleted with it, each doing what it does when it's deleted (for example, the `viz` Capability drops the Organisation's database). If a Capability cannot be deleted the Organisation is not deleted, and the Capabilities that were deleted remain deleted. An admin can set `force` to delete the Capabilities (and the Organisation) anyway. Only an admin can delete an Organisation that has Capabilities.
  *
  * You need admin rights to use this method
  * @summary Deletes an Organisation
  */
 export const deleteOrganisation = (
   orgId: string,
+  params?: DeleteOrganisationParams,
   options?: SecondParameter<typeof customInstance>,
   signal?: AbortSignal,
 ) => {
-  return customInstance<void>({ url: `/organisation/${orgId}`, method: "DELETE", signal }, options);
+  return customInstance<void>(
+    { url: `/organisation/${orgId}`, method: "DELETE", params, signal },
+    options,
+  );
 };
 
 export const getDeleteOrganisationMutationOptions = <
@@ -725,14 +730,14 @@ export const getDeleteOrganisationMutationOptions = <
   mutation?: UseMutationOptions<
     Awaited<ReturnType<typeof deleteOrganisation>>,
     TError,
-    { orgId: string },
+    { orgId: string; params?: DeleteOrganisationParams },
     TContext
   >;
   request?: SecondParameter<typeof customInstance>;
 }): UseMutationOptions<
   Awaited<ReturnType<typeof deleteOrganisation>>,
   TError,
-  { orgId: string },
+  { orgId: string; params?: DeleteOrganisationParams },
   TContext
 > => {
   const mutationKey = ["deleteOrganisation"];
@@ -744,11 +749,11 @@ export const getDeleteOrganisationMutationOptions = <
 
   const mutationFn: MutationFunction<
     Awaited<ReturnType<typeof deleteOrganisation>>,
-    { orgId: string }
+    { orgId: string; params?: DeleteOrganisationParams }
   > = (props) => {
-    const { orgId } = props ?? {};
+    const { orgId, params } = props ?? {};
 
-    return deleteOrganisation(orgId, requestOptions);
+    return deleteOrganisation(orgId, params, requestOptions);
   };
 
   return { mutationFn, ...mutationOptions };
@@ -768,7 +773,7 @@ export const useDeleteOrganisation = <TError = ErrorType<AsError | void>, TConte
     mutation?: UseMutationOptions<
       Awaited<ReturnType<typeof deleteOrganisation>>,
       TError,
-      { orgId: string },
+      { orgId: string; params?: DeleteOrganisationParams },
       TContext
     >;
     request?: SecondParameter<typeof customInstance>;
@@ -777,7 +782,7 @@ export const useDeleteOrganisation = <TError = ErrorType<AsError | void>, TConte
 ): UseMutationResult<
   Awaited<ReturnType<typeof deleteOrganisation>>,
   TError,
-  { orgId: string },
+  { orgId: string; params?: DeleteOrganisationParams },
   TContext
 > => {
   return useMutation(getDeleteOrganisationMutationOptions(options), queryClient);

package/src/api/product/product.fetch.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/product/product.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/state/state.fetch.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/state/state.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/unit/unit.fetch.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/unit/unit.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/user/user.fetch.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {

package/src/api/user/user.ts

@@ -6,7 +6,7 @@
  *
  * 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.11
+ * OpenAPI spec version: 4.12
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {