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

package/dist/api/product/product.cjs

@@ -0,0 +1,513 @@
+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/product/product.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 Product Types you can purchase (subscribe to)
+
+* @summary Gets all Product Types
+*/
+const getProductTypes = (options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/product-type`,
+		method: "GET",
+		signal
+	}, options);
+};
+const getGetProductTypesQueryKey = () => {
+	return [`/product-type`];
+};
+const useGetProductTypesQueryOptions = (options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductTypesQueryKey();
+	const queryFn = ({ signal }) => getProductTypes(requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets all Product Types
+*/
+function useGetProductTypes(options, queryClient) {
+	const queryOptions = useGetProductTypesQueryOptions(options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetProductTypesSuspenseQueryOptions = (options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductTypesQueryKey();
+	const queryFn = ({ signal }) => getProductTypes(requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets all Product Types
+*/
+function useGetProductTypesSuspense(options, queryClient) {
+	const queryOptions = useGetProductTypesSuspenseQueryOptions(options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* The storage cost is returned along with its measurement units, typically a Coin value based on the the peak storage that was measured on each billable day.
+
+* @summary Gets the default cross-product storage cost
+*/
+const getProductDefaultStorageCost = (options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/product-default-storage-cost`,
+		method: "GET",
+		signal
+	}, options);
+};
+const getGetProductDefaultStorageCostQueryKey = () => {
+	return [`/product-default-storage-cost`];
+};
+const useGetProductDefaultStorageCostQueryOptions = (options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductDefaultStorageCostQueryKey();
+	const queryFn = ({ signal }) => getProductDefaultStorageCost(requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets the default cross-product storage cost
+*/
+function useGetProductDefaultStorageCost(options, queryClient) {
+	const queryOptions = useGetProductDefaultStorageCostQueryOptions(options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetProductDefaultStorageCostSuspenseQueryOptions = (options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductDefaultStorageCostQueryKey();
+	const queryFn = ({ signal }) => getProductDefaultStorageCost(requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets the default cross-product storage cost
+*/
+function useGetProductDefaultStorageCostSuspense(options, queryClient) {
+	const queryOptions = useGetProductDefaultStorageCostSuspenseQueryOptions(options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* Gets Products you have access to, across all **Units** and **Organisations**
+
+* @summary Gets all Products
+*/
+const getProducts = (options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/product`,
+		method: "GET",
+		signal
+	}, options);
+};
+const getGetProductsQueryKey = () => {
+	return [`/product`];
+};
+const useGetProductsQueryOptions = (options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductsQueryKey();
+	const queryFn = ({ signal }) => getProducts(requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets all Products
+*/
+function useGetProducts(options, queryClient) {
+	const queryOptions = useGetProductsQueryOptions(options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetProductsSuspenseQueryOptions = (options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductsQueryKey();
+	const queryFn = ({ signal }) => getProducts(requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets all Products
+*/
+function useGetProductsSuspense(options, queryClient) {
+	const queryOptions = useGetProductsSuspenseQueryOptions(options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* Gets Products you have access to based on an **Organisation**
+
+* @summary Gets Products for an Organisation
+*/
+const getProductsForOrganisation = (orgId, options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/product/organisation/${orgId}`,
+		method: "GET",
+		signal
+	}, options);
+};
+const getGetProductsForOrganisationQueryKey = (orgId) => {
+	return [`/product/organisation/${orgId}`];
+};
+const useGetProductsForOrganisationQueryOptions = (orgId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductsForOrganisationQueryKey(orgId);
+	const queryFn = ({ signal }) => getProductsForOrganisation(orgId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets Products for an Organisation
+*/
+function useGetProductsForOrganisation(orgId, options, queryClient) {
+	const queryOptions = useGetProductsForOrganisationQueryOptions(orgId, options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetProductsForOrganisationSuspenseQueryOptions = (orgId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductsForOrganisationQueryKey(orgId);
+	const queryFn = ({ signal }) => getProductsForOrganisation(orgId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets Products for an Organisation
+*/
+function useGetProductsForOrganisationSuspense(orgId, options, queryClient) {
+	const queryOptions = useGetProductsForOrganisationSuspenseQueryOptions(orgId, options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* Products are **Subscriptions** that you create in a **Unit** that allow you to use services provided by a **Merchant**. To create products you need to be a member of the **Unit** or the Unit's **Organisation**.
+
+Supported subscription **types** include `DATA_MANAGER_STORAGE_SUBSCRIPTION`, and `DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION`.
+
+The `DATA_MANAGER_STORAGE_SUBSCRIPTION` **type** needs a **name**, an **allowance**, and an optional **limit** (that cannot be less than the **allowance**). If no **limit** is provided the **allowance** is used.
+
+The `DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION` **type** needs a **name**, and a **flavour**. The **flavour**, a string, should typically be one of `EVALUATION`, `BRONZE`, `SILVER` or `GOLD`.
+
+Users who are **Evaluators** can only create products in their Personal Unit, and where products support flavours, are restricted to `EVALUATION` flavours .
+
+* @summary Creates a Product for a Unit
+*/
+const createUnitProduct = (unitId, unitProductPostBodyBody, options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/product/unit/${unitId}`,
+		method: "POST",
+		headers: { "Content-Type": "application/json" },
+		data: unitProductPostBodyBody,
+		signal
+	}, options);
+};
+const useCreateUnitProductMutationOptions = (options) => {
+	const mutationKey = ["createUnitProduct"];
+	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 createUnitProduct(unitId, data, requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Creates a Product for a Unit
+*/
+const useCreateUnitProduct = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(useCreateUnitProductMutationOptions(options), queryClient);
+};
+/**
+* Gets products you have access to based on an Organisational **Unit**
+
+* @summary Gets Products for an Organisational Unit
+*/
+const getProductsForUnit = (unitId, options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/product/unit/${unitId}`,
+		method: "GET",
+		signal
+	}, options);
+};
+const getGetProductsForUnitQueryKey = (unitId) => {
+	return [`/product/unit/${unitId}`];
+};
+const useGetProductsForUnitQueryOptions = (unitId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductsForUnitQueryKey(unitId);
+	const queryFn = ({ signal }) => getProductsForUnit(unitId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets Products for an Organisational Unit
+*/
+function useGetProductsForUnit(unitId, options, queryClient) {
+	const queryOptions = useGetProductsForUnitQueryOptions(unitId, options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetProductsForUnitSuspenseQueryOptions = (unitId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductsForUnitQueryKey(unitId);
+	const queryFn = ({ signal }) => getProductsForUnit(unitId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets Products for an Organisational Unit
+*/
+function useGetProductsForUnitSuspense(unitId, options, queryClient) {
+	const queryOptions = useGetProductsForUnitSuspenseQueryOptions(unitId, options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* Gets details of a specific Product that you have access to.
+
+* @summary Gets a Product
+*/
+const getProduct = (productId, options, signal) => {
+	return require_custom_instance.customInstance({
+		url: `/product/${productId}`,
+		method: "GET",
+		signal
+	}, options);
+};
+const getGetProductQueryKey = (productId) => {
+	return [`/product/${productId}`];
+};
+const useGetProductQueryOptions = (productId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductQueryKey(productId);
+	const queryFn = ({ signal }) => getProduct(productId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets a Product
+*/
+function useGetProduct(productId, options, queryClient) {
+	const queryOptions = useGetProductQueryOptions(productId, options);
+	const query = (0, __tanstack_react_query.useQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+const useGetProductSuspenseQueryOptions = (productId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getGetProductQueryKey(productId);
+	const queryFn = ({ signal }) => getProduct(productId, requestOptions, signal);
+	return require_options_mutator.queryMutator({
+		...queryOptions,
+		queryKey,
+		queryFn
+	});
+};
+/**
+* @summary Gets a Product
+*/
+function useGetProductSuspense(productId, options, queryClient) {
+	const queryOptions = useGetProductSuspenseQueryOptions(productId, options);
+	const query = (0, __tanstack_react_query.useSuspenseQuery)(queryOptions, queryClient);
+	query.queryKey = queryOptions.queryKey;
+	return query;
+}
+/**
+* You need access to the Product and, if the Product is *claimable* the claim must be removed before the Product can be removed. An example claimable Product is a `DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION` where the *claimable* commodity is a Data Manager **Project**. In this case you will need to delete the Data Manager **Project** before you can delete the Account Server **Product**.
+
+* @summary Deletes an existing Product
+*/
+const deleteProduct = (productId, options) => {
+	return require_custom_instance.customInstance({
+		url: `/product/${productId}`,
+		method: "DELETE"
+	}, options);
+};
+const useDeleteProductMutationOptions = (options) => {
+	const mutationKey = ["deleteProduct"];
+	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 { productId } = props ?? {};
+		return deleteProduct(productId, requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Deletes an existing Product
+*/
+const useDeleteProduct = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(useDeleteProductMutationOptions(options), queryClient);
+};
+/**
+* Used to update some adjustable parameters of a Product, i.e. to extend its **Allowance** or **Limit**.
+
+You must be a member of the **Unit**, or its **Organisation**, or an administrator to use this method.
+
+At the moment we only support Products associated with the Data Manager, and these can be patched by changing the `name`, its coin `allowance` or `limit`
+
+* @summary Adjust an existing Product
+*/
+const patchProduct = (productId, productPatchBodyBody, options) => {
+	return require_custom_instance.customInstance({
+		url: `/product/${productId}`,
+		method: "PATCH",
+		headers: { "Content-Type": "application/json" },
+		data: productPatchBodyBody
+	}, options);
+};
+const usePatchProductMutationOptions = (options) => {
+	const mutationKey = ["patchProduct"];
+	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 { productId, data } = props ?? {};
+		return patchProduct(productId, data, requestOptions);
+	};
+	return require_options_mutator.mutationMutator({
+		...mutationOptions,
+		mutationFn
+	});
+};
+/**
+* @summary Adjust an existing Product
+*/
+const usePatchProduct = (options, queryClient) => {
+	return (0, __tanstack_react_query.useMutation)(usePatchProductMutationOptions(options), queryClient);
+};
+
+//#endregion
+exports.createUnitProduct = createUnitProduct;
+exports.deleteProduct = deleteProduct;
+exports.getGetProductDefaultStorageCostQueryKey = getGetProductDefaultStorageCostQueryKey;
+exports.getGetProductQueryKey = getGetProductQueryKey;
+exports.getGetProductTypesQueryKey = getGetProductTypesQueryKey;
+exports.getGetProductsForOrganisationQueryKey = getGetProductsForOrganisationQueryKey;
+exports.getGetProductsForUnitQueryKey = getGetProductsForUnitQueryKey;
+exports.getGetProductsQueryKey = getGetProductsQueryKey;
+exports.getProduct = getProduct;
+exports.getProductDefaultStorageCost = getProductDefaultStorageCost;
+exports.getProductTypes = getProductTypes;
+exports.getProducts = getProducts;
+exports.getProductsForOrganisation = getProductsForOrganisation;
+exports.getProductsForUnit = getProductsForUnit;
+exports.patchProduct = patchProduct;
+exports.useCreateUnitProduct = useCreateUnitProduct;
+exports.useCreateUnitProductMutationOptions = useCreateUnitProductMutationOptions;
+exports.useDeleteProduct = useDeleteProduct;
+exports.useDeleteProductMutationOptions = useDeleteProductMutationOptions;
+exports.useGetProduct = useGetProduct;
+exports.useGetProductDefaultStorageCost = useGetProductDefaultStorageCost;
+exports.useGetProductDefaultStorageCostQueryOptions = useGetProductDefaultStorageCostQueryOptions;
+exports.useGetProductDefaultStorageCostSuspense = useGetProductDefaultStorageCostSuspense;
+exports.useGetProductDefaultStorageCostSuspenseQueryOptions = useGetProductDefaultStorageCostSuspenseQueryOptions;
+exports.useGetProductQueryOptions = useGetProductQueryOptions;
+exports.useGetProductSuspense = useGetProductSuspense;
+exports.useGetProductSuspenseQueryOptions = useGetProductSuspenseQueryOptions;
+exports.useGetProductTypes = useGetProductTypes;
+exports.useGetProductTypesQueryOptions = useGetProductTypesQueryOptions;
+exports.useGetProductTypesSuspense = useGetProductTypesSuspense;
+exports.useGetProductTypesSuspenseQueryOptions = useGetProductTypesSuspenseQueryOptions;
+exports.useGetProducts = useGetProducts;
+exports.useGetProductsForOrganisation = useGetProductsForOrganisation;
+exports.useGetProductsForOrganisationQueryOptions = useGetProductsForOrganisationQueryOptions;
+exports.useGetProductsForOrganisationSuspense = useGetProductsForOrganisationSuspense;
+exports.useGetProductsForOrganisationSuspenseQueryOptions = useGetProductsForOrganisationSuspenseQueryOptions;
+exports.useGetProductsForUnit = useGetProductsForUnit;
+exports.useGetProductsForUnitQueryOptions = useGetProductsForUnitQueryOptions;
+exports.useGetProductsForUnitSuspense = useGetProductsForUnitSuspense;
+exports.useGetProductsForUnitSuspenseQueryOptions = useGetProductsForUnitSuspenseQueryOptions;
+exports.useGetProductsQueryOptions = useGetProductsQueryOptions;
+exports.useGetProductsSuspense = useGetProductsSuspense;
+exports.useGetProductsSuspenseQueryOptions = useGetProductsSuspenseQueryOptions;
+exports.usePatchProduct = usePatchProduct;
+exports.usePatchProductMutationOptions = usePatchProductMutationOptions;
+//# sourceMappingURL=product.cjs.map