@squonk/account-server-client 4.3.1 → 4.4.0-4-4.2174798239

package/dist/api/unit/unit.cjs

@@ -0,0 +1,568 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_custom_instance = require('../../custom-instance.cjs');
+const require_options_mutator = require('../../options-mutator.cjs');
+let __tanstack_react_query = require("@tanstack/react-query");
+
+//#region src/api/unit/unit.ts
+/**
+* Generated by orval v7.16.1 🍺
+* 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**.
+
+* OpenAPI spec version: 4.4
+*/
+/**
+* Gets Organisational Units you have access to or that are public
+
+* @summary Gets Organisational Units
+*/
+const getOrganisationUnits = (orgId, options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/organisation/${orgId}/unit`,
+		method: "GET",
+		signal
+	}, options);
+};
+const getGetOrganisationUnitsQueryKey = (orgId) => {
+	return [`/organisation/${orgId}/unit`];
+};
+const useGetOrganisationUnitsQueryOptions = (orgId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetOrganisationUnitsQueryKey(orgId);
+	const queryFn = ({ signal }) => getOrganisationUnits(orgId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets Organisational Units
+*/
+function useGetOrganisationUnits(orgId, options, queryClient) {
+	const queryOptions = useGetOrganisationUnitsQueryOptions(orgId, options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetOrganisationUnitsSuspenseQueryOptions = (orgId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetOrganisationUnitsQueryKey(orgId);
+	const queryFn = ({ signal }) => getOrganisationUnits(orgId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets Organisational Units
+*/
+function useGetOrganisationUnitsSuspense(orgId, options, queryClient) {
+	const queryOptions = useGetOrganisationUnitsSuspenseQueryOptions(orgId, options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* 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 = (orgId, organisationUnitPostBodyBody, options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/organisation/${orgId}/unit`,
+		method: "POST",
+		headers: { "Content-Type": "application/json" },
+		data: organisationUnitPostBodyBody,
+		signal
+	}, options);
+};
+const useCreateOrganisationUnitMutationOptions = (options) => {
+	const mutationKey = ["createOrganisationUnit"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { orgId, data } = props ?? {};
+		return createOrganisationUnit(orgId, data, requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Create a new Organisational Unit
+*/
+const useCreateOrganisationUnit = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(useCreateOrganisationUnitMutationOptions(options), queryClient);
+};
+/**
+* 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 = (unitId, options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/unit/${unitId}`,
+		method: "GET",
+		signal
+	}, options);
+};
+const getGetUnitQueryKey = (unitId) => {
+	return [`/unit/${unitId}`];
+};
+const useGetUnitQueryOptions = (unitId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetUnitQueryKey(unitId);
+	const queryFn = ({ signal }) => getUnit(unitId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets an Organisational Unit
+*/
+function useGetUnit(unitId, options, queryClient) {
+	const queryOptions = useGetUnitQueryOptions(unitId, options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetUnitSuspenseQueryOptions = (unitId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetUnitQueryKey(unitId);
+	const queryFn = ({ signal }) => getUnit(unitId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets an Organisational Unit
+*/
+function useGetUnitSuspense(unitId, options, queryClient) {
+	const queryOptions = useGetUnitSuspenseQueryOptions(unitId, options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* 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 = (unitId, unitPatchBodyBody, options) => {
+	return require_custom_instance.customInstance({
+		url: `/unit/${unitId}`,
+		method: "PATCH",
+		headers: { "Content-Type": "application/json" },
+		data: unitPatchBodyBody
+	}, options);
+};
+const usePatchUnitMutationOptions = (options) => {
+	const mutationKey = ["patchUnit"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { unitId, data } = props ?? {};
+		return patchUnit(unitId, data, requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Adjust an existing Unit
+*/
+const usePatchUnit = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(usePatchUnitMutationOptions(options), queryClient);
+};
+/**
+* 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 = (unitId, options) => {
+	return require_custom_instance.customInstance({
+		url: `/unit/${unitId}`,
+		method: "DELETE"
+	}, options);
+};
+const useDeleteOrganisationUnitMutationOptions = (options) => {
+	const mutationKey = ["deleteOrganisationUnit"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { unitId } = props ?? {};
+		return deleteOrganisationUnit(unitId, requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Deletes an Organisational Unit
+*/
+const useDeleteOrganisationUnit = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(useDeleteOrganisationUnitMutationOptions(options), queryClient);
+};
+/**
+* @summary Gets your Personal Unit (if you have one)
+*/
+const getPersonalUnit = (options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/personal-unit`,
+		method: "GET",
+		signal
+	}, options);
+};
+const getGetPersonalUnitQueryKey = () => {
+	return [`/personal-unit`];
+};
+const useGetPersonalUnitQueryOptions = (options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetPersonalUnitQueryKey();
+	const queryFn = ({ signal }) => getPersonalUnit(requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets your Personal Unit (if you have one)
+*/
+function useGetPersonalUnit(options, queryClient) {
+	const queryOptions = useGetPersonalUnitQueryOptions(options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetPersonalUnitSuspenseQueryOptions = (options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetPersonalUnitQueryKey();
+	const queryFn = ({ signal }) => getPersonalUnit(requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets your Personal Unit (if you have one)
+*/
+function useGetPersonalUnitSuspense(options, queryClient) {
+	const queryOptions = useGetPersonalUnitSuspenseQueryOptions(options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* 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 = (personalUnitPutBodyBody, options) => {
+	return require_custom_instance.customInstance({
+		url: `/personal-unit`,
+		method: "PUT",
+		headers: { "Content-Type": "application/json" },
+		data: personalUnitPutBodyBody
+	}, options);
+};
+const useCreatePersonalUnitMutationOptions = (options) => {
+	const mutationKey = ["createPersonalUnit"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { data } = props ?? {};
+		return createPersonalUnit(data, requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Create a new Personal Unit
+*/
+const useCreatePersonalUnit = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(useCreatePersonalUnitMutationOptions(options), queryClient);
+};
+/**
+* Deletes a Personal Unit. The Unit is *your* Unit, and belongs to the **Default Organisation**
+
+* @summary Deletes a Personal Unit
+*/
+const deletePersonalUnit = (options) => {
+	return require_custom_instance.customInstance({
+		url: `/personal-unit`,
+		method: "DELETE"
+	}, options);
+};
+const useDeletePersonalUnitMutationOptions = (options) => {
+	const mutationKey = ["deletePersonalUnit"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = () => {
+		return deletePersonalUnit(requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Deletes a Personal Unit
+*/
+const useDeletePersonalUnit = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(useDeletePersonalUnitMutationOptions(options), queryClient);
+};
+/**
+* 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 = (params, options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/unit`,
+		method: "GET",
+		params,
+		signal
+	}, options);
+};
+const getGetUnitsQueryKey = (params) => {
+	return [`/unit`, ...params ? [params] : []];
+};
+const useGetUnitsQueryOptions = (params, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetUnitsQueryKey(params);
+	const queryFn = ({ signal }) => getUnits(params, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets Units
+*/
+function useGetUnits(params, options, queryClient) {
+	const queryOptions = useGetUnitsQueryOptions(params, options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetUnitsSuspenseQueryOptions = (params, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetUnitsQueryKey(params);
+	const queryFn = ({ signal }) => getUnits(params, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets Units
+*/
+function useGetUnitsSuspense(params, options, queryClient) {
+	const queryOptions = useGetUnitsSuspenseQueryOptions(params, options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* 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 = (personalUnitPutBodyBody, options) => {
+	return require_custom_instance.customInstance({
+		url: `/unit`,
+		method: "PUT",
+		headers: { "Content-Type": "application/json" },
+		data: personalUnitPutBodyBody
+	}, options);
+};
+const useCreateDefaultUnitMutationOptions = (options) => {
+	const mutationKey = ["createDefaultUnit"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { data } = props ?? {};
+		return createDefaultUnit(data, requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Create a new Personal Unit
+*/
+const useCreateDefaultUnit = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(useCreateDefaultUnitMutationOptions(options), queryClient);
+};
+/**
+* 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 = (options) => {
+	return require_custom_instance.customInstance({
+		url: `/unit`,
+		method: "DELETE"
+	}, options);
+};
+const useDeleteDefaultUnitMutationOptions = (options) => {
+	const mutationKey = ["deleteDefaultUnit"];
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = () => {
+		return deleteDefaultUnit(requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Deletes a Personal Unit
+*/
+const useDeleteDefaultUnit = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(useDeleteDefaultUnitMutationOptions(options), queryClient);
+};
+
+//#endregion
+exports.createDefaultUnit = createDefaultUnit;
+exports.createOrganisationUnit = createOrganisationUnit;
+exports.createPersonalUnit = createPersonalUnit;
+exports.deleteDefaultUnit = deleteDefaultUnit;
+exports.deleteOrganisationUnit = deleteOrganisationUnit;
+exports.deletePersonalUnit = deletePersonalUnit;
+exports.getGetOrganisationUnitsQueryKey = getGetOrganisationUnitsQueryKey;
+exports.getGetPersonalUnitQueryKey = getGetPersonalUnitQueryKey;
+exports.getGetUnitQueryKey = getGetUnitQueryKey;
+exports.getGetUnitsQueryKey = getGetUnitsQueryKey;
+exports.getOrganisationUnits = getOrganisationUnits;
+exports.getPersonalUnit = getPersonalUnit;
+exports.getUnit = getUnit;
+exports.getUnits = getUnits;
+exports.patchUnit = patchUnit;
+exports.useCreateDefaultUnit = useCreateDefaultUnit;
+exports.useCreateDefaultUnitMutationOptions = useCreateDefaultUnitMutationOptions;
+exports.useCreateOrganisationUnit = useCreateOrganisationUnit;
+exports.useCreateOrganisationUnitMutationOptions = useCreateOrganisationUnitMutationOptions;
+exports.useCreatePersonalUnit = useCreatePersonalUnit;
+exports.useCreatePersonalUnitMutationOptions = useCreatePersonalUnitMutationOptions;
+exports.useDeleteDefaultUnit = useDeleteDefaultUnit;
+exports.useDeleteDefaultUnitMutationOptions = useDeleteDefaultUnitMutationOptions;
+exports.useDeleteOrganisationUnit = useDeleteOrganisationUnit;
+exports.useDeleteOrganisationUnitMutationOptions = useDeleteOrganisationUnitMutationOptions;
+exports.useDeletePersonalUnit = useDeletePersonalUnit;
+exports.useDeletePersonalUnitMutationOptions = useDeletePersonalUnitMutationOptions;
+exports.useGetOrganisationUnits = useGetOrganisationUnits;
+exports.useGetOrganisationUnitsQueryOptions = useGetOrganisationUnitsQueryOptions;
+exports.useGetOrganisationUnitsSuspense = useGetOrganisationUnitsSuspense;
+exports.useGetOrganisationUnitsSuspenseQueryOptions = useGetOrganisationUnitsSuspenseQueryOptions;
+exports.useGetPersonalUnit = useGetPersonalUnit;
+exports.useGetPersonalUnitQueryOptions = useGetPersonalUnitQueryOptions;
+exports.useGetPersonalUnitSuspense = useGetPersonalUnitSuspense;
+exports.useGetPersonalUnitSuspenseQueryOptions = useGetPersonalUnitSuspenseQueryOptions;
+exports.useGetUnit = useGetUnit;
+exports.useGetUnitQueryOptions = useGetUnitQueryOptions;
+exports.useGetUnitSuspense = useGetUnitSuspense;
+exports.useGetUnitSuspenseQueryOptions = useGetUnitSuspenseQueryOptions;
+exports.useGetUnits = useGetUnits;
+exports.useGetUnitsQueryOptions = useGetUnitsQueryOptions;
+exports.useGetUnitsSuspense = useGetUnitsSuspense;
+exports.useGetUnitsSuspenseQueryOptions = useGetUnitsSuspenseQueryOptions;
+exports.usePatchUnit = usePatchUnit;
+exports.usePatchUnitMutationOptions = usePatchUnitMutationOptions;
+//# sourceMappingURL=unit.cjs.map