@squonk/account-server-client 0.1.6-rc.1 → 0.1.9-rc.1

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);
+};

package/src/user/user.ts

@@ -0,0 +1,340 @@
+/**
+ * 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 { UsersGetResponse, AsError } 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 users in an Organisation. You have to be in the Organisation or an Admin user to use this endpoint
+
+ * @summary Gets users in an organisation
+ */
+export const getOrganisationUsers = (
+  orgid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<UsersGetResponse>(
+    { url: `/organisation/${orgid}/user`, method: "get" },
+    options
+  );
+};
+
+export const getGetOrganisationUsersQueryKey = (orgid: string) => [
+  `/organisation/${orgid}/user`,
+];
+
+export const useGetOrganisationUsers = <
+  TData = AsyncReturnType<typeof getOrganisationUsers>,
+  TError = ErrorType<AsError | void>
+>(
+  orgid: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof getOrganisationUsers>,
+      TError,
+      TData
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getGetOrganisationUsersQueryKey(orgid);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof getOrganisationUsers>
+  > = () => getOrganisationUsers(orgid, requestOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof getOrganisationUsers>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!orgid, ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Adds a user to an organisation. You have to be in the Organisation or an Admin user to use this endpoint
+
+ * @summary Adds a user to an organisation
+ */
+export const addOrganisationUser = (
+  orgid: string,
+  userid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    {
+      url: `/organisation/${orgid}/user/${userid}`,
+      method: "put",
+      data: undefined,
+    },
+    options
+  );
+};
+
+export const useAddOrganisationUser = <
+  TError = ErrorType<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof addOrganisationUser>,
+    TError,
+    { orgid: string; userid: string },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof addOrganisationUser>,
+    { orgid: string; userid: string }
+  > = (props) => {
+    const { orgid, userid } = props || {};
+
+    return addOrganisationUser(orgid, userid, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof addOrganisationUser>,
+    TError,
+    { orgid: string; userid: string },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Removes a user from an organisation. You have to be in the Organisation or an Admin user to use this endpoint
+
+ * @summary Deletes a user from an organisation
+ */
+export const deleteOrganisationUser = (
+  orgid: string,
+  userid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    {
+      url: `/organisation/${orgid}/user/${userid}`,
+      method: "delete",
+      data: undefined,
+    },
+    options
+  );
+};
+
+export const useDeleteOrganisationUser = <
+  TError = ErrorType<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof deleteOrganisationUser>,
+    TError,
+    { orgid: string; userid: string },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof deleteOrganisationUser>,
+    { orgid: string; userid: string }
+  > = (props) => {
+    const { orgid, userid } = props || {};
+
+    return deleteOrganisationUser(orgid, userid, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof deleteOrganisationUser>,
+    TError,
+    { orgid: string; userid: string },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Gets users in an Organisational Unit. You have to be in the Organisation or Unit or an Admin user to use this endpoint
+
+ * @summary Gets users in an Organisational Unit
+ */
+export const getOrganisationUnitUsers = (
+  unitid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<UsersGetResponse>(
+    { url: `/unit/${unitid}/user`, method: "get" },
+    options
+  );
+};
+
+export const getGetOrganisationUnitUsersQueryKey = (unitid: string) => [
+  `/unit/${unitid}/user`,
+];
+
+export const useGetOrganisationUnitUsers = <
+  TData = AsyncReturnType<typeof getOrganisationUnitUsers>,
+  TError = ErrorType<AsError | void>
+>(
+  unitid: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof getOrganisationUnitUsers>,
+      TError,
+      TData
+    >;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getGetOrganisationUnitUsersQueryKey(unitid);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof getOrganisationUnitUsers>
+  > = () => getOrganisationUnitUsers(unitid, requestOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof getOrganisationUnitUsers>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!unitid, ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Adds a user to an Organisationall Unit. You have to be in the Organisation or Unit or an Admin user to use this endpoint
+
+ * @summary Adds a user to an Organisational Unit
+ */
+export const addOrganisationUnitUser = (
+  unitid: string,
+  userid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    { url: `/unit/${unitid}/user/${userid}`, method: "put", data: undefined },
+    options
+  );
+};
+
+export const useAddOrganisationUnitUser = <
+  TError = ErrorType<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof addOrganisationUnitUser>,
+    TError,
+    { unitid: string; userid: string },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof addOrganisationUnitUser>,
+    { unitid: string; userid: string }
+  > = (props) => {
+    const { unitid, userid } = props || {};
+
+    return addOrganisationUnitUser(unitid, userid, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof addOrganisationUnitUser>,
+    TError,
+    { unitid: string; userid: string },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
+ * Removes a user from an Organisational Unit. You have to be in the Organisation or Unit or an Admin user to use this endpoint
+
+ * @summary Deletes a user from an Organisational Unit
+ */
+export const deleteOrganisationUnitUser = (
+  unitid: string,
+  userid: string,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<void>(
+    {
+      url: `/unit/${unitid}/user/${userid}`,
+      method: "delete",
+      data: undefined,
+    },
+    options
+  );
+};
+
+export const useDeleteOrganisationUnitUser = <
+  TError = ErrorType<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof deleteOrganisationUnitUser>,
+    TError,
+    { unitid: string; userid: string },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}) => {
+  const { mutation: mutationOptions, request: requestOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof deleteOrganisationUnitUser>,
+    { unitid: string; userid: string }
+  > = (props) => {
+    const { unitid, userid } = props || {};
+
+    return deleteOrganisationUnitUser(unitid, userid, requestOptions);
+  };
+
+  return useMutation<
+    AsyncReturnType<typeof deleteOrganisationUnitUser>,
+    TError,
+    { unitid: string; userid: string },
+    TContext
+  >(mutationFn, mutationOptions);
+};

package/unit/package.json

@@ -2,5 +2,6 @@
   "module": "./unit.js",
   "main": "./unit.cjs",
   "types": "./unit.d.ts",
-  "sideEffects": false
+  "sideEffects": false,
+  "type": "module"
 }