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

package/dist/api/product/product.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/product/product.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 getGetProductTypesUrl = () => {
 	return `/product-type`;
 };
+/**
+* Gets Product Types you can purchase (subscribe to)
+* @summary Gets all Product Types
+*/
 const getProductTypes = async (options) => {
 	return require_custom_fetch.customFetch(getGetProductTypesUrl(), {
 		...options,
@@ -43,9 +58,7 @@ const getGetProductTypesQueryOptions = (options) => {
 */
 function useGetProductTypes(options, queryClient) {
 	const queryOptions = getGetProductTypesQueryOptions(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 all Product Types
@@ -72,13 +85,15 @@ const getGetProductTypesSuspenseQueryOptions = (options) => {
 */
 function useGetProductTypesSuspense(options, queryClient) {
 	const queryOptions = getGetProductTypesSuspenseQueryOptions(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 getGetProductDefaultStorageCostUrl = () => {
 	return `/product-default-storage-cost`;
 };
+/**
+* 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 = async (options) => {
 	return require_custom_fetch.customFetch(getGetProductDefaultStorageCostUrl(), {
 		...options,
@@ -106,9 +121,7 @@ const getGetProductDefaultStorageCostQueryOptions = (options) => {
 */
 function useGetProductDefaultStorageCost(options, queryClient) {
 	const queryOptions = getGetProductDefaultStorageCostQueryOptions(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 the default cross-product storage cost
@@ -135,13 +148,15 @@ const getGetProductDefaultStorageCostSuspenseQueryOptions = (options) => {
 */
 function useGetProductDefaultStorageCostSuspense(options, queryClient) {
 	const queryOptions = getGetProductDefaultStorageCostSuspenseQueryOptions(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 getGetProductsUrl = () => {
 	return `/product`;
 };
+/**
+* Gets Products you have access to, across all **Units** and **Organisations**
+* @summary Gets all Products
+*/
 const getProducts = async (options) => {
 	return require_custom_fetch.customFetch(getGetProductsUrl(), {
 		...options,
@@ -169,9 +184,7 @@ const getGetProductsQueryOptions = (options) => {
 */
 function useGetProducts(options, queryClient) {
 	const queryOptions = getGetProductsQueryOptions(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 all Products
@@ -198,13 +211,15 @@ const getGetProductsSuspenseQueryOptions = (options) => {
 */
 function useGetProductsSuspense(options, queryClient) {
 	const queryOptions = getGetProductsSuspenseQueryOptions(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 getGetProductsForOrganisationUrl = (orgId) => {
 	return `/product/organisation/${orgId}`;
 };
+/**
+* Gets Products you have access to based on an **Organisation**
+* @summary Gets Products for an Organisation
+*/
 const getProductsForOrganisation = async (orgId, options) => {
 	return require_custom_fetch.customFetch(getGetProductsForOrganisationUrl(orgId), {
 		...options,
@@ -229,7 +244,7 @@ const getGetProductsForOrganisationQueryOptions = (orgId, options) => {
 	return {
 		queryKey,
 		queryFn,
-		enabled: !!orgId,
+		enabled: orgId !== null && orgId !== void 0,
 		...queryOptions
 	};
 };
@@ -238,9 +253,7 @@ const getGetProductsForOrganisationQueryOptions = (orgId, options) => {
 */
 function useGetProductsForOrganisation(orgId, options, queryClient) {
 	const queryOptions = getGetProductsForOrganisationQueryOptions(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 Products for an Organisation
@@ -267,13 +280,23 @@ const getGetProductsForOrganisationSuspenseQueryOptions = (orgId, options) => {
 */
 function useGetProductsForOrganisationSuspense(orgId, options, queryClient) {
 	const queryOptions = getGetProductsForOrganisationSuspenseQueryOptions(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 getCreateUnitProductUrl = (unitId) => {
 	return `/product/unit/${unitId}`;
 };
+/**
+* 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 = async (unitId, unitProductPostBodyBody, options) => {
 	return require_custom_fetch.customFetch(getCreateUnitProductUrl(unitId), {
 		...options,
@@ -310,11 +333,15 @@ const getCreateUnitProductMutationOptions = (options) => {
 * @summary Creates a Product for a Unit
 */
 const useCreateUnitProduct = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getCreateUnitProductMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getCreateUnitProductMutationOptions(options), queryClient);
 };
 const getGetProductsForUnitUrl = (unitId) => {
 	return `/product/unit/${unitId}`;
 };
+/**
+* Gets products you have access to based on an Organisational **Unit**
+* @summary Gets Products for an Organisational Unit
+*/
 const getProductsForUnit = async (unitId, options) => {
 	return require_custom_fetch.customFetch(getGetProductsForUnitUrl(unitId), {
 		...options,
@@ -339,7 +366,7 @@ const getGetProductsForUnitQueryOptions = (unitId, options) => {
 	return {
 		queryKey,
 		queryFn,
-		enabled: !!unitId,
+		enabled: unitId !== null && unitId !== void 0,
 		...queryOptions
 	};
 };
@@ -348,9 +375,7 @@ const getGetProductsForUnitQueryOptions = (unitId, options) => {
 */
 function useGetProductsForUnit(unitId, options, queryClient) {
 	const queryOptions = getGetProductsForUnitQueryOptions(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 Products for an Organisational Unit
@@ -377,13 +402,15 @@ const getGetProductsForUnitSuspenseQueryOptions = (unitId, options) => {
 */
 function useGetProductsForUnitSuspense(unitId, options, queryClient) {
 	const queryOptions = getGetProductsForUnitSuspenseQueryOptions(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 getGetProductUrl = (productId) => {
 	return `/product/${productId}`;
 };
+/**
+* Gets details of a specific Product that you have access to.
+* @summary Gets a Product
+*/
 const getProduct = async (productId, options) => {
 	return require_custom_fetch.customFetch(getGetProductUrl(productId), {
 		...options,
@@ -407,7 +434,7 @@ const getGetProductQueryOptions = (productId, options) => {
 	return {
 		queryKey,
 		queryFn,
-		enabled: !!productId,
+		enabled: productId !== null && productId !== void 0,
 		...queryOptions
 	};
 };
@@ -416,9 +443,7 @@ const getGetProductQueryOptions = (productId, options) => {
 */
 function useGetProduct(productId, options, queryClient) {
 	const queryOptions = getGetProductQueryOptions(productId, 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 a Product
@@ -445,13 +470,15 @@ const getGetProductSuspenseQueryOptions = (productId, options) => {
 */
 function useGetProductSuspense(productId, options, queryClient) {
 	const queryOptions = getGetProductSuspenseQueryOptions(productId, 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 getDeleteProductUrl = (productId) => {
 	return `/product/${productId}`;
 };
+/**
+* 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 = async (productId, options) => {
 	return require_custom_fetch.customFetch(getDeleteProductUrl(productId), {
 		...options,
@@ -483,11 +510,19 @@ const getDeleteProductMutationOptions = (options) => {
 * @summary Deletes an existing Product
 */
 const useDeleteProduct = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getDeleteProductMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getDeleteProductMutationOptions(options), queryClient);
 };
 const getPatchProductUrl = (productId) => {
 	return `/product/${productId}`;
 };
+/**
+* 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 = async (productId, productPatchBodyBody, options) => {
 	return require_custom_fetch.customFetch(getPatchProductUrl(productId), {
 		...options,
@@ -524,9 +559,8 @@ const getPatchProductMutationOptions = (options) => {
 * @summary Adjust an existing Product
 */
 const usePatchProduct = (options, queryClient) => {
-	return (0, __tanstack_react_query.useMutation)(getPatchProductMutationOptions(options), queryClient);
+	return (0, _tanstack_react_query.useMutation)(getPatchProductMutationOptions(options), queryClient);
 };
-
 //#endregion
 exports.createUnitProduct = createUnitProduct;
 exports.deleteProduct = deleteProduct;
@@ -588,4 +622,5 @@ exports.useGetProductsForUnit = useGetProductsForUnit;
 exports.useGetProductsForUnitSuspense = useGetProductsForUnitSuspense;
 exports.useGetProductsSuspense = useGetProductsSuspense;
 exports.usePatchProduct = usePatchProduct;
+
 //# sourceMappingURL=product.fetch.cjs.map