@squonk/account-server-client 4.2.5 → 4.4.0-4-4.2174353771

package/src/actions/actions.ts

@@ -0,0 +1,249 @@
+/**
+ * Generated by orval v7.10.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**.
+
+ * OpenAPI spec version: 4.4
+ */
+import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
+import type {
+  DataTag,
+  DefinedInitialDataOptions,
+  DefinedUseQueryResult,
+  QueryClient,
+  QueryFunction,
+  QueryKey,
+  UndefinedInitialDataOptions,
+  UseQueryOptions,
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+
+import type { ActionGetResponse, GetActionsParams } from "../API_TARGET_NAME.schemas";
+
+import { customInstance } from ".././custom-instance";
+import type { ErrorType } from ".././custom-instance";
+import { queryMutator } from ".././options-mutator";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * This endpoint delivers Action records (protocol buffers) that can be selected based on a date and time range and limited to merchants, organisations, Units, or Products. You can receive Action content as a `PROTOCOL_STRING` (the default), or `JSON_STRING`. If you do not provide a `format` `PROTOCOL_STRING` will be assumed.
+
+You can provide a `m_id`, `org_id`, `unit_id`, `product_id`, but only one.
+
+You can also provide `from` and `until` dates to limit the response to Actions that occur on the days you select. Actions are returned that are not before the `from` data but are before the `until` date. If neither `from` or `until` is provided `from` is assumed to be from _today_ until _tomorrow_.
+
+You need admin privilege to use this endpoint.
+
+ * @summary Gets Actions held on the Account Server
+ */
+export const getActions = (
+  params?: GetActionsParams,
+  options?: SecondParameter<typeof customInstance>,
+  signal?: AbortSignal,
+) => {
+  return customInstance<ActionGetResponse>(
+    { url: `/action`, method: "GET", params, signal },
+    options,
+  );
+};
+
+export const getGetActionsQueryKey = (params?: GetActionsParams) => {
+  return [`/action`, ...(params ? [params] : [])] as const;
+};
+
+export const useGetActionsQueryOptions = <
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>
+    getActions(params, requestOptions, signal);
+
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
+  return customOptions as UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+  };
+};
+
+export type GetActionsQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
+export type GetActionsQueryError = ErrorType<void>;
+
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params: undefined | GetActionsParams,
+  options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &
+      Pick<
+        DefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getActions>>,
+          TError,
+          Awaited<ReturnType<typeof getActions>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>> &
+      Pick<
+        UndefinedInitialDataOptions<
+          Awaited<ReturnType<typeof getActions>>,
+          TError,
+          Awaited<ReturnType<typeof getActions>>
+        >,
+        "initialData"
+      >;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+/**
+ * @summary Gets Actions held on the Account Server
+ */
+
+export function useGetActions<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = useGetActionsQueryOptions(params, options);
+
+  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+  };
+
+  query.queryKey = queryOptions.queryKey;
+
+  return query;
+}
+
+export const useGetActionsSuspenseQueryOptions = <
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetActionsQueryKey(params);
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getActions>>> = ({ signal }) =>
+    getActions(params, requestOptions, signal);
+
+  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
+
+  return customOptions as UseSuspenseQueryOptions<
+    Awaited<ReturnType<typeof getActions>>,
+    TError,
+    TData
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+};
+
+export type GetActionsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getActions>>>;
+export type GetActionsSuspenseQueryError = ErrorType<void>;
+
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params: undefined | GetActionsParams,
+  options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
+/**
+ * @summary Gets Actions held on the Account Server
+ */
+
+export function useGetActionsSuspense<
+  TData = Awaited<ReturnType<typeof getActions>>,
+  TError = ErrorType<void>,
+>(
+  params?: GetActionsParams,
+  options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getActions>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+  },
+  queryClient?: QueryClient,
+): UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
+  const queryOptions = useGetActionsSuspenseQueryOptions(params, options);
+
+  const query = useSuspenseQuery(queryOptions, queryClient) as UseSuspenseQueryResult<
+    TData,
+    TError
+  > & { queryKey: DataTag<QueryKey, TData, TError> };
+
+  query.queryKey = queryOptions.queryKey;
+
+  return query;
+}