@squonk/account-server-client 0.1.7-rc.1 → 0.1.8-rc.1

package/src/product/product.ts

@@ -0,0 +1,289 @@
+/**
+ * Generated by orval v6.4.2 🍺
+ * 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 **Products**, **Organisations**, **Units** and **Users**.
+
+ * OpenAPI spec version: 0.1
+ */
+import {
+  useQuery,
+  useMutation,
+  UseQueryOptions,
+  UseMutationOptions,
+  QueryFunction,
+  MutationFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
+import type {
+  ProductsGetResponse,
+  AsError,
+  UnitProductPostResponse,
+  UnitProductPostBodyBody,
+  ProductUnitGetResponse,
+  ProductPatchBodyBody,
+} from "../account-server-api.schemas";
+import { customInstance, ErrorType } from ".././custom-instance";
+
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
+  ...args: any
+) => Promise<infer R>
+  ? R
+  : any;
+
+type SecondParameter<T extends (...args: any) => any> = T extends (
+  config: any,
+  args: infer P
+) => any
+  ? P
+  : never;
+
+/**
+ * Gets products you have access to, across all Units and Organisations
+
+ * @summary Gets all Products
+ */
+export const getProducts = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ProductsGetResponse>(
+    { url: `/product`, method: "get" },
+    options
+  );
+};
+
+export const getGetProductsQueryKey = () => [`/product`];
+
+export const useGetProducts = <
+  TData = AsyncReturnType<typeof getProducts>,
+  TError = ErrorType<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<AsyncReturnType<typeof getProducts>, TError, TData>;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetProductsQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getProducts>> = () =>
+    getProducts(requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getProducts>, TError, TData>(
+    queryKey,
+    queryFn,
+    queryOptions
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * @summary Creates a Product for an Organisational Unit
+ */
+export const createUnitProduct = (
+  unitid: string,
+  unitProductPostBodyBody: UnitProductPostBodyBody,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<UnitProductPostResponse>(
+    {
+      url: `/product/unit/${unitid}`,
+      method: "post",
+      data: unitProductPostBodyBody,
+    },
+    options
+  );
+};
+
+export const useCreateUnitProduct = <
+  TError = ErrorType<AsError | void>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof createUnitProduct>,
+    TError,
+    { unitid: string; data: UnitProductPostBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof createUnitProduct>,
+    { unitid: string; data: UnitProductPostBodyBody }
+  > = (props) => {
+    const { unitid, data } = props || {};
+
+    return createUnitProduct(unitid, data, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof createUnitProduct>,
+    TError,
+    { unitid: string; data: UnitProductPostBodyBody },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Gets products you have access to based on an Organisational Unit
+
+ * @summary Gets Products for an Organisational Unit
+ */
+export const getProductsForUnit = (
+  unitid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ProductsGetResponse>(
+    { url: `/product/unit/${unitid}`, method: "get" },
+    options
+  );
+};
+
+export const getGetProductsForUnitQueryKey = (unitid: string) => [
+  `/product/unit/${unitid}`,
+];
+
+export const useGetProductsForUnit = <
+  TData = AsyncReturnType<typeof getProductsForUnit>,
+  TError = ErrorType<void | AsError>
+>(
+  unitid: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof getProductsForUnit>,
+      TError,
+      TData
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getGetProductsForUnitQueryKey(unitid);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof getProductsForUnit>
+  > = () => getProductsForUnit(unitid, requestOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof getProductsForUnit>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!unitid, ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Gets a Unit's Product
+
+ * @summary Gets a Unit's Product
+ */
+export const getProduct = (
+  unitid: string,
+  productid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ProductUnitGetResponse>(
+    { url: `/product/unit/${unitid}/product/${productid}`, method: "get" },
+    options
+  );
+};
+
+export const getGetProductQueryKey = (unitid: string, productid: string) => [
+  `/product/unit/${unitid}/product/${productid}`,
+];
+
+export const useGetProduct = <
+  TData = AsyncReturnType<typeof getProduct>,
+  TError = ErrorType<AsError | void>
+>(
+  unitid: string,
+  productid: string,
+  options?: {
+    query?: UseQueryOptions<AsyncReturnType<typeof getProduct>, TError, TData>;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getGetProductQueryKey(unitid, productid);
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getProduct>> = () =>
+    getProduct(unitid, productid, requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getProduct>, TError, TData>(
+    queryKey,
+    queryFn,
+    { enabled: !!(unitid && productid), ...queryOptions }
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Used to update some adjustable parameters of a Product, i.e. to extend the Allowance or Limit. Curently you can only patch storage Products
+
+ * @summary Adjust an existing Product
+ */
+export const patchProduct = (
+  unitid: string,
+  productid: string,
+  productPatchBodyBody: ProductPatchBodyBody,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    {
+      url: `/product/unit/${unitid}/product/${productid}`,
+      method: "patch",
+      data: productPatchBodyBody,
+    },
+    options
+  );
+};
+
+export const usePatchProduct = <
+  TError = ErrorType<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof patchProduct>,
+    TError,
+    { unitid: string; productid: string; data: ProductPatchBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof patchProduct>,
+    { unitid: string; productid: string; data: ProductPatchBodyBody }
+  > = (props) => {
+    const { unitid, productid, data } = props || {};
+
+    return patchProduct(unitid, productid, data, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof patchProduct>,
+    TError,
+    { unitid: string; productid: string; data: ProductPatchBodyBody },
+    TContext
+  >(mutationFn, mutationOptions);
+};

package/src/unit/unit.ts

@@ -0,0 +1,322 @@
+/**
+ * Generated by orval v6.4.2 🍺
+ * 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 **Products**, **Organisations**, **Units** and **Users**.
+
+ * OpenAPI spec version: 0.1
+ */
+import {
+  useQuery,
+  useMutation,
+  UseQueryOptions,
+  UseMutationOptions,
+  QueryFunction,
+  MutationFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
+import type {
+  OrganisationUnitsGetResponse,
+  AsError,
+  OrganisationUnitPostResponse,
+  OrganisationUnitPostBodyBody,
+  UnitsGetResponse,
+} from "../account-server-api.schemas";
+import { customInstance, ErrorType } from ".././custom-instance";
+
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
+  ...args: any
+) => Promise<infer R>
+  ? R
+  : any;
+
+type SecondParameter<T extends (...args: any) => any> = T extends (
+  config: any,
+  args: infer P
+) => any
+  ? P
+  : never;
+
+/**
+ * Gets Organisational Units you have access to
+
+ * @summary Gets Organisational Units
+ */
+export const getOrganisationUnits = (
+  orgid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationUnitsGetResponse>(
+    { url: `/organisation/${orgid}/unit`, method: "get" },
+    options
+  );
+};
+
+export const getGetOrganisationUnitsQueryKey = (orgid: string) => [
+  `/organisation/${orgid}/unit`,
+];
+
+export const useGetOrganisationUnits = <
+  TData = AsyncReturnType<typeof getOrganisationUnits>,
+  TError = ErrorType<void | AsError>
+>(
+  orgid: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof getOrganisationUnits>,
+      TError,
+      TData
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getGetOrganisationUnitsQueryKey(orgid);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof getOrganisationUnits>
+  > = () => getOrganisationUnits(orgid, requestOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof getOrganisationUnits>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!orgid, ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Creates a new organisation unit. You need to be inthe Organisation or an Admin user to use this endpoint
+
+ * @summary Create a new Organisational Unit
+ */
+export const createOrganisationUnit = (
+  orgid: string,
+  organisationUnitPostBodyBody: OrganisationUnitPostBodyBody,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationUnitPostResponse>(
+    {
+      url: `/organisation/${orgid}/unit`,
+      method: "post",
+      data: organisationUnitPostBodyBody,
+    },
+    options
+  );
+};
+
+export const useCreateOrganisationUnit = <
+  TError = ErrorType<AsError | void>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof createOrganisationUnit>,
+    TError,
+    { orgid: string; data: OrganisationUnitPostBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof createOrganisationUnit>,
+    { orgid: string; data: OrganisationUnitPostBodyBody }
+  > = (props) => {
+    const { orgid, data } = props || {};
+
+    return createOrganisationUnit(orgid, data, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof createOrganisationUnit>,
+    TError,
+    { orgid: string; data: OrganisationUnitPostBodyBody },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Deletes an Organisational Unit you have access to. Units can only be deleted by Organisation users or Admin users. You cannot delete a Unit that contains Products
+
+ * @summary Deletes an Organisational Unit
+ */
+export const deleteOrganisationUnit = (
+  orgid: string,
+  unitid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    {
+      url: `/organisation/${orgid}/unit/${unitid}`,
+      method: "delete",
+      data: undefined,
+    },
+    options
+  );
+};
+
+export const useDeleteOrganisationUnit = <
+  TError = ErrorType<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof deleteOrganisationUnit>,
+    TError,
+    { orgid: string; unitid: string },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof deleteOrganisationUnit>,
+    { orgid: string; unitid: string }
+  > = (props) => {
+    const { orgid, unitid } = props || {};
+
+    return deleteOrganisationUnit(orgid, unitid, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof deleteOrganisationUnit>,
+    TError,
+    { orgid: string; unitid: string },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Gets all the Units you are a member of. Admin users can see all Units
+
+ * @summary Gets Units a User has access to
+ */
+export const getUnits = (options?: SecondParameter<typeof customInstance>) => {
+  return customInstance<UnitsGetResponse>(
+    { url: `/unit`, method: "get" },
+    options
+  );
+};
+
+export const getGetUnitsQueryKey = () => [`/unit`];
+
+export const useGetUnits = <
+  TData = AsyncReturnType<typeof getUnits>,
+  TError = ErrorType<void | AsError>
+>(options?: {
+  query?: UseQueryOptions<AsyncReturnType<typeof getUnits>, TError, TData>;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetUnitsQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getUnits>> = () =>
+    getUnits(requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getUnits>, TError, TData>(
+    queryKey,
+    queryFn,
+    queryOptions
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Creates a Unit for an independent User. The unit will belong to the built-in **Default** Organisation. Users can only have one Independent Unit and Independent Units cannot have other Users
+
+ * @summary Create a new Independent User Unit
+ */
+export const createDefaultUnit = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<OrganisationUnitPostResponse>(
+    { url: `/unit`, method: "put", data: undefined },
+    options
+  );
+};
+
+export const useCreateDefaultUnit = <
+  TError = ErrorType<AsError | void>,
+  TVariables = void,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof createDefaultUnit>,
+    TError,
+    TVariables,
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof createDefaultUnit>,
+    TVariables
+  > = () => {
+    return createDefaultUnit(requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof createDefaultUnit>,
+    TError,
+    TVariables,
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Deletes an Independent Unit. It must be your Unit, which belongs to the Default Organisation
+
+ * @summary Deletes an Independent Unit
+ */
+export const deleteDefaultUnit = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    { url: `/unit`, method: "delete", data: undefined },
+    options
+  );
+};
+
+export const useDeleteDefaultUnit = <
+  TError = ErrorType<AsError>,
+  TVariables = void,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof deleteDefaultUnit>,
+    TError,
+    TVariables,
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof deleteDefaultUnit>,
+    TVariables
+  > = () => {
+    return deleteDefaultUnit(requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof deleteDefaultUnit>,
+    TError,
+    TVariables,
+    TContext
+  >(mutationFn, mutationOptions);
+};