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

package/dist/api/unit/unit.fetch.cjs

@@ -1,21 +1,36 @@
-const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
-const require_custom_fetch = require('../../custom-fetch.cjs');
-let __tanstack_react_query = require("@tanstack/react-query");
-
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_custom_fetch = require("../../custom-fetch.cjs");
+let _tanstack_react_query = require("@tanstack/react-query");
 //#region src/api/unit/unit.fetch.ts
 /**
-* 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
 */
+const withQueryKey = (query, queryKey) => {
+	const result = { queryKey };
+	for (const key of Object.keys(query)) {
+		if (key === "queryKey") continue;
+		Object.defineProperty(result, key, {
+			enumerable: true,
+			configurable: true,
+			get: () => query[key]
+		});
+	}
+	return result;
+};
 const getGetOrganisationUnitsUrl = (orgId) => {
 	return `/organisation/${orgId}/unit`;
 };
+/**
+* Gets Organisational Units you have access to or that are public
+* @summary Gets Organisational Units
+*/
 const getOrganisationUnits = async (orgId, options) => {
 	return require_custom_fetch.customFetch(getGetOrganisationUnitsUrl(orgId), {
 		...options,
@@ -40,7 +55,7 @@ const getGetOrganisationUnitsQueryOptions = (orgId, options) => {
 	return {
 		queryKey,
 		queryFn,
-		enabled: !!orgId,
+		enabled: orgId !== null && orgId !== void 0,
 		...queryOptions
 	};
 };
@@ -49,9 +64,7 @@ const getGetOrganisationUnitsQueryOptions = (orgId, options) => {
 */
 function useGetOrganisationUnits(orgId, options, queryClient) {
 	const queryOptions = getGetOrganisationUnitsQueryOptions(orgId, options);
-	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return withQueryKey((0, _tanstack_react_query.useQuery)(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * @summary Gets Organisational Units
@@ -78,13 +91,19 @@ const getGetOrganisationUnitsSuspenseQueryOptions = (orgId, options) => {
 */
 function useGetOrganisationUnitsSuspense(orgId, options, queryClient) {
 	const queryOptions = getGetOrganisationUnitsSuspenseQueryOptions(orgId, options);
-	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return withQueryKey((0, _tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient), queryOptions.queryKey);
 }
 const getCreateOrganisationUnitUrl = (orgId) => {
 	return `/organisation/${orgId}/unit`;
 };
+/**
+* Creates a new Organisation Unit.
+*
+* The **User** who creates the Unit becomes the **Owner** of the Unit. They are considered a *Member* (**User**) of the Unit but are not present in the list of users, which a separate list of users explicitly added to the Unit by a member of the Organisation or another member of the Unit.
+*
+* You need to be  a member of the **Organisation** or have administration rights to use this endpoint
+* @summary Create a new Organisational Unit
+*/
 const createOrganisationUnit = async (orgId, organisationUnitPostBodyBody, options) => {
 	return require_custom_fetch.customFetch(getCreateOrganisationUnitUrl(orgId), {
 		...options,
@@ -121,11 +140,15 @@ const getCreateOrganisationUnitMutationOptions = (options) => {
 * @summary Create a new Organisational Unit
 */
 const useCreateOrganisationUnit = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getCreateOrganisationUnitMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getCreateOrganisationUnitMutationOptions(options), queryClient);
 };
 const getGetUnitUrl = (unitId) => {
 	return `/unit/${unitId}`;
 };
+/**
+* Gets a Unit. You can get a Unit if you are a member of it or are its creator. You can also get a Unit if you are a member of its **Organisation**, or its creator or an admin user.
+* @summary Gets an Organisational Unit
+*/
 const getUnit = async (unitId, options) => {
 	return require_custom_fetch.customFetch(getGetUnitUrl(unitId), {
 		...options,
@@ -149,7 +172,7 @@ const getGetUnitQueryOptions = (unitId, options) => {
 	return {
 		queryKey,
 		queryFn,
-		enabled: !!unitId,
+		enabled: unitId !== null && unitId !== void 0,
 		...queryOptions
 	};
 };
@@ -158,9 +181,7 @@ const getGetUnitQueryOptions = (unitId, options) => {
 */
 function useGetUnit(unitId, options, queryClient) {
 	const queryOptions = getGetUnitQueryOptions(unitId, options);
-	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return withQueryKey((0, _tanstack_react_query.useQuery)(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * @summary Gets an Organisational Unit
@@ -187,13 +208,17 @@ const getGetUnitSuspenseQueryOptions = (unitId, options) => {
 */
 function useGetUnitSuspense(unitId, options, queryClient) {
 	const queryOptions = getGetUnitSuspenseQueryOptions(unitId, options);
-	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return withQueryKey((0, _tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient), queryOptions.queryKey);
 }
 const getPatchUnitUrl = (unitId) => {
 	return `/unit/${unitId}`;
 };
+/**
+* Used to update existing Unit. You can change a Unit's **name** or its **default_product_privacy** (as long as the new privacy does not conflict with the Organisation's value).
+*
+* You have to be a member of the **Unit**, a member of its **Organisation**, or an administrator to patch a Unit.
+* @summary Adjust an existing Unit
+*/
 const patchUnit = async (unitId, unitPatchBodyBody, options) => {
 	return require_custom_fetch.customFetch(getPatchUnitUrl(unitId), {
 		...options,
@@ -230,11 +255,19 @@ const getPatchUnitMutationOptions = (options) => {
 * @summary Adjust an existing Unit
 */
 const usePatchUnit = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getPatchUnitMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getPatchUnitMutationOptions(options), queryClient);
 };
 const getDeleteOrganisationUnitUrl = (unitId) => {
 	return `/unit/${unitId}`;
 };
+/**
+* Deletes an Organisational Unit you have access to. Units can only be deleted by members of the Unit, its Organisation users or admin users.
+*
+* You cannot delete Units in the **Default Organisation**. These Units are **Personal Units** and need to be deleted using the `DELETE /unit` endpoint.
+*
+* You cannot delete a Unit that contains undeleted **Products**
+* @summary Deletes an Organisational Unit
+*/
 const deleteOrganisationUnit = async (unitId, options) => {
 	return require_custom_fetch.customFetch(getDeleteOrganisationUnitUrl(unitId), {
 		...options,
@@ -266,11 +299,14 @@ const getDeleteOrganisationUnitMutationOptions = (options) => {
 * @summary Deletes an Organisational Unit
 */
 const useDeleteOrganisationUnit = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getDeleteOrganisationUnitMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getDeleteOrganisationUnitMutationOptions(options), queryClient);
 };
 const getGetPersonalUnitUrl = () => {
 	return `/personal-unit`;
 };
+/**
+* @summary Gets your Personal Unit (if you have one)
+*/
 const getPersonalUnit = async (options) => {
 	return require_custom_fetch.customFetch(getGetPersonalUnitUrl(), {
 		...options,
@@ -298,9 +334,7 @@ const getGetPersonalUnitQueryOptions = (options) => {
 */
 function useGetPersonalUnit(options, queryClient) {
 	const queryOptions = getGetPersonalUnitQueryOptions(options);
-	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return withQueryKey((0, _tanstack_react_query.useQuery)(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * @summary Gets your Personal Unit (if you have one)
@@ -327,13 +361,17 @@ const getGetPersonalUnitSuspenseQueryOptions = (options) => {
 */
 function useGetPersonalUnitSuspense(options, queryClient) {
 	const queryOptions = getGetPersonalUnitSuspenseQueryOptions(options);
-	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return withQueryKey((0, _tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient), queryOptions.queryKey);
 }
 const getCreatePersonalUnitUrl = () => {
 	return `/personal-unit`;
 };
+/**
+* Creates a Personal Unit for a User. The unit will belong to the built-in **Default Organisation**.
+*
+* Users can only create one Personal unit and you cannot add other Users to a Personal Unit.
+* @summary Create a new Personal Unit
+*/
 const createPersonalUnit = async (personalUnitPutBodyBody, options) => {
 	return require_custom_fetch.customFetch(getCreatePersonalUnitUrl(), {
 		...options,
@@ -370,11 +408,15 @@ const getCreatePersonalUnitMutationOptions = (options) => {
 * @summary Create a new Personal Unit
 */
 const useCreatePersonalUnit = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getCreatePersonalUnitMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getCreatePersonalUnitMutationOptions(options), queryClient);
 };
 const getDeletePersonalUnitUrl = () => {
 	return `/personal-unit`;
 };
+/**
+* Deletes a Personal Unit. The Unit is *your* Unit, and belongs to the **Default Organisation**
+* @summary Deletes a Personal Unit
+*/
 const deletePersonalUnit = async (options) => {
 	return require_custom_fetch.customFetch(getDeletePersonalUnitUrl(), {
 		...options,
@@ -405,16 +447,22 @@ const getDeletePersonalUnitMutationOptions = (options) => {
 * @summary Deletes a Personal Unit
 */
 const useDeletePersonalUnit = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getDeletePersonalUnitMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getDeletePersonalUnitMutationOptions(options), queryClient);
 };
 const getGetUnitsUrl = (params) => {
 	const normalizedParams = new URLSearchParams();
 	Object.entries(params || {}).forEach(([key, value]) => {
-		if (value !== void 0) normalizedParams.append(key, value === null ? "null" : value.toString());
+		if (value !== void 0) normalizedParams.append(key, value === null ? "null" : String(value));
 	});
 	const stringifiedParams = normalizedParams.toString();
 	return stringifiedParams.length > 0 ? `/unit?${stringifiedParams}` : `/unit`;
 };
+/**
+* Gets all the Units that you are a member of, or a specific Unit by name.
+*
+* You can see a Unit if you are a member of it, the owner (creator) of it, or a member or creator of the Unit's Organisation, or if you are an admin user.
+* @summary Gets Units
+*/
 const getUnits = async (params, options) => {
 	return require_custom_fetch.customFetch(getGetUnitsUrl(params), {
 		...options,
@@ -446,9 +494,7 @@ const getGetUnitsQueryOptions = (params, options) => {
 */
 function useGetUnits(params, options, queryClient) {
 	const queryOptions = getGetUnitsQueryOptions(params, options);
-	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return withQueryKey((0, _tanstack_react_query.useQuery)(queryOptions, queryClient), queryOptions.queryKey);
 }
 /**
 * @summary Gets Units
@@ -475,13 +521,19 @@ const getGetUnitsSuspenseQueryOptions = (params, options) => {
 */
 function useGetUnitsSuspense(params, options, queryClient) {
 	const queryOptions = getGetUnitsSuspenseQueryOptions(params, options);
-	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
-	query.queryKey = queryOptions.queryKey;
-	return query;
+	return withQueryKey((0, _tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient), queryOptions.queryKey);
 }
 const getCreateDefaultUnitUrl = () => {
 	return `/unit`;
 };
+/**
+* Creates a Personal Unit for a User. The unit will belong to the built-in **Default Organisation**.
+*
+* Users can only create one Personal unit and you cannot add other Users to a Personal Unit.
+*
+* This endpoint is DECREMENTED and will be removed in a future release. Please use **PUT** at `/personal-unit`.
+* @summary Create a new Personal Unit
+*/
 const createDefaultUnit = async (personalUnitPutBodyBody, options) => {
 	return require_custom_fetch.customFetch(getCreateDefaultUnitUrl(), {
 		...options,
@@ -518,11 +570,17 @@ const getCreateDefaultUnitMutationOptions = (options) => {
 * @summary Create a new Personal Unit
 */
 const useCreateDefaultUnit = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getCreateDefaultUnitMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getCreateDefaultUnitMutationOptions(options), queryClient);
 };
 const getDeleteDefaultUnitUrl = () => {
 	return `/unit`;
 };
+/**
+* Deletes a Personal Unit. The Unit is *your* Unit, and belongs to the **Default Organisation**
+*
+* This endpoint is DECREMENTED and will be removed in a future release. Please use **DELETE** at `/personal-unit`.
+* @summary Deletes a Personal Unit
+*/
 const deleteDefaultUnit = async (options) => {
 	return require_custom_fetch.customFetch(getDeleteDefaultUnitUrl(), {
 		...options,
@@ -553,9 +611,8 @@ const getDeleteDefaultUnitMutationOptions = (options) => {
 * @summary Deletes a Personal Unit
 */
 const useDeleteDefaultUnit = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getDeleteDefaultUnitMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getDeleteDefaultUnitMutationOptions(options), queryClient);
 };
-
 //#endregion
 exports.createDefaultUnit = createDefaultUnit;
 exports.createOrganisationUnit = createOrganisationUnit;
@@ -617,4 +674,5 @@ exports.useGetUnitSuspense = useGetUnitSuspense;
 exports.useGetUnits = useGetUnits;
 exports.useGetUnitsSuspense = useGetUnitsSuspense;
 exports.usePatchUnit = usePatchUnit;
+
 //# sourceMappingURL=unit.fetch.cjs.map