@squonk/account-server-client 4.4.0-4-4.2195235454 → 4.4.0-4-4.2197467763

package/src/api/event-stream/event-stream.fetch.ts

@@ -0,0 +1,539 @@
+/**
+ * Generated by orval v7.17.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 { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
+import type {
+  InvalidateOptions,
+  MutationFunction,
+  QueryClient,
+  QueryFunction,
+  QueryKey,
+  UseMutationOptions,
+  UseMutationResult,
+  UseQueryOptions,
+  UseQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+
+import type {
+  AsError,
+  EventStreamGetPostResponse,
+  EventStreamPostBodyBody,
+  EventStreamVersionGetResponse,
+} from ".././api-schemas";
+
+import { customFetch } from "../../custom-fetch";
+import type { ErrorType } from "../../custom-fetch";
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+/**
+ * Gets the details of the installed event stream, which includes its **protocol**, and **name**.
+
+ * @summary Gets the details of the installed event stream
+ */
+export type getEventStreamVersionResponse200 = { data: EventStreamVersionGetResponse; status: 200 };
+
+export type getEventStreamVersionResponse401 = { data: void; status: 401 };
+
+export type getEventStreamVersionResponse404 = { data: AsError; status: 404 };
+
+export type getEventStreamVersionResponseSuccess = getEventStreamVersionResponse200 & {
+  headers: Headers;
+};
+export type getEventStreamVersionResponseError = (
+  | getEventStreamVersionResponse401
+  | getEventStreamVersionResponse404
+) & { headers: Headers };
+
+export type getEventStreamVersionResponse =
+  | getEventStreamVersionResponseSuccess
+  | getEventStreamVersionResponseError;
+
+export const getGetEventStreamVersionUrl = () => {
+  return `/event-stream/version`;
+};
+
+export const getEventStreamVersion = async (
+  options?: RequestInit,
+): Promise<getEventStreamVersionResponse> => {
+  return customFetch<getEventStreamVersionResponse>(getGetEventStreamVersionUrl(), {
+    ...options,
+    method: "GET",
+  });
+};
+
+export const getGetEventStreamVersionQueryKey = () => {
+  return ["account-server", "event-stream", "version"] as const;
+};
+
+export const getGetEventStreamVersionQueryOptions = <
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>;
+  request?: SecondParameter<typeof customFetch>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetEventStreamVersionQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStreamVersion>>> = ({ signal }) =>
+    getEventStreamVersion({ signal, ...requestOptions });
+
+  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
+    Awaited<ReturnType<typeof getEventStreamVersion>>,
+    TError,
+    TData
+  > & { queryKey: QueryKey };
+};
+
+export type GetEventStreamVersionQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getEventStreamVersion>>
+>;
+export type GetEventStreamVersionQueryError = ErrorType<void | AsError>;
+
+/**
+ * @summary Gets the details of the installed event stream
+ */
+
+export function useGetEventStreamVersion<
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>;
+  request?: SecondParameter<typeof customFetch>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+  const queryOptions = getGetEventStreamVersionQueryOptions(options);
+
+  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey;
+
+  return query;
+}
+
+/**
+ * @summary Gets the details of the installed event stream
+ */
+export const invalidateGetEventStreamVersion = async (
+  queryClient: QueryClient,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetEventStreamVersionQueryKey() }, options);
+
+  return queryClient;
+};
+
+export const getGetEventStreamVersionSuspenseQueryOptions = <
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>;
+  request?: SecondParameter<typeof customFetch>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetEventStreamVersionQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStreamVersion>>> = ({ signal }) =>
+    getEventStreamVersion({ signal, ...requestOptions });
+
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
+    Awaited<ReturnType<typeof getEventStreamVersion>>,
+    TError,
+    TData
+  > & { queryKey: QueryKey };
+};
+
+export type GetEventStreamVersionSuspenseQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getEventStreamVersion>>
+>;
+export type GetEventStreamVersionSuspenseQueryError = ErrorType<void | AsError>;
+
+/**
+ * @summary Gets the details of the installed event stream
+ */
+
+export function useGetEventStreamVersionSuspense<
+  TData = Awaited<ReturnType<typeof getEventStreamVersion>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>;
+  request?: SecondParameter<typeof customFetch>;
+}): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
+  const queryOptions = getGetEventStreamVersionSuspenseQueryOptions(options);
+
+  const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+  };
+
+  query.queryKey = queryOptions.queryKey;
+
+  return query;
+}
+
+/**
+ * Gets the details of your event stream, if you have created one. The response includes the event stream **id** and the **location** where events can be accessed.
+
+ * @summary Gets the details of your event stream
+ */
+export type getEventStreamResponse200 = { data: EventStreamGetPostResponse; status: 200 };
+
+export type getEventStreamResponse401 = { data: void; status: 401 };
+
+export type getEventStreamResponse404 = { data: AsError; status: 404 };
+
+export type getEventStreamResponseSuccess = getEventStreamResponse200 & { headers: Headers };
+export type getEventStreamResponseError = (
+  | getEventStreamResponse401
+  | getEventStreamResponse404
+) & { headers: Headers };
+
+export type getEventStreamResponse = getEventStreamResponseSuccess | getEventStreamResponseError;
+
+export const getGetEventStreamUrl = () => {
+  return `/event-stream`;
+};
+
+export const getEventStream = async (options?: RequestInit): Promise<getEventStreamResponse> => {
+  return customFetch<getEventStreamResponse>(getGetEventStreamUrl(), { ...options, method: "GET" });
+};
+
+export const getGetEventStreamQueryKey = () => {
+  return ["account-server", "event-stream"] as const;
+};
+
+export const getGetEventStreamQueryOptions = <
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>;
+  request?: SecondParameter<typeof customFetch>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetEventStreamQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStream>>> = ({ signal }) =>
+    getEventStream({ signal, ...requestOptions });
+
+  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
+    Awaited<ReturnType<typeof getEventStream>>,
+    TError,
+    TData
+  > & { queryKey: QueryKey };
+};
+
+export type GetEventStreamQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStream>>>;
+export type GetEventStreamQueryError = ErrorType<void | AsError>;
+
+/**
+ * @summary Gets the details of your event stream
+ */
+
+export function useGetEventStream<
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>;
+  request?: SecondParameter<typeof customFetch>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+  const queryOptions = getGetEventStreamQueryOptions(options);
+
+  const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey;
+
+  return query;
+}
+
+/**
+ * @summary Gets the details of your event stream
+ */
+export const invalidateGetEventStream = async (
+  queryClient: QueryClient,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetEventStreamQueryKey() }, options);
+
+  return queryClient;
+};
+
+export const getGetEventStreamSuspenseQueryOptions = <
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>;
+  request?: SecondParameter<typeof customFetch>;
+}) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetEventStreamQueryKey();
+
+  const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStream>>> = ({ signal }) =>
+    getEventStream({ signal, ...requestOptions });
+
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
+    Awaited<ReturnType<typeof getEventStream>>,
+    TError,
+    TData
+  > & { queryKey: QueryKey };
+};
+
+export type GetEventStreamSuspenseQueryResult = NonNullable<
+  Awaited<ReturnType<typeof getEventStream>>
+>;
+export type GetEventStreamSuspenseQueryError = ErrorType<void | AsError>;
+
+/**
+ * @summary Gets the details of your event stream
+ */
+
+export function useGetEventStreamSuspense<
+  TData = Awaited<ReturnType<typeof getEventStream>>,
+  TError = ErrorType<void | AsError>,
+>(options?: {
+  query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>;
+  request?: SecondParameter<typeof customFetch>;
+}): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
+  const queryOptions = getGetEventStreamSuspenseQueryOptions(options);
+
+  const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+  };
+
+  query.queryKey = queryOptions.queryKey;
+
+  return query;
+}
+
+/**
+ * Creates a new event stream for the authenticated user. Event streams deliver near-real-time events to the user, typically through a long-running *Socket*. The protocol is dependent on the Event Stream Service that has been installed. Our **Python FastAPI WebSocket** service is one such service.
+
+Events are delivered to the client using the a `format` chosen here. Internally, events are **Protocol Buffer** objects that are delivered, by default as a single-line string using `MessageToString`. This is the `PROTOCOL_STRING` format. Clients can choose to receive messages as a JSON string using the format `JSON_STRING`. Using JSON strings will incur a small processing penalty but they are useful if the client does not have access to a library that can decode protocol buffer strings.
+
+The response will include the event stream **id** and the **location** where events can be accessed.
+
+The event streaming service is an optional component of the Account Server. If a service is not installed you will receive a corresponding **404** error response.
+
+A user is only permitted one event stream.
+
+ * @summary Create a new event stream
+ */
+export type createEventStreamResponse201 = { data: EventStreamGetPostResponse; status: 201 };
+
+export type createEventStreamResponse400 = { data: AsError; status: 400 };
+
+export type createEventStreamResponse401 = { data: void; status: 401 };
+
+export type createEventStreamResponse403 = { data: AsError; status: 403 };
+
+export type createEventStreamResponse404 = { data: AsError; status: 404 };
+
+export type createEventStreamResponseSuccess = createEventStreamResponse201 & { headers: Headers };
+export type createEventStreamResponseError = (
+  | createEventStreamResponse400
+  | createEventStreamResponse401
+  | createEventStreamResponse403
+  | createEventStreamResponse404
+) & { headers: Headers };
+
+export type createEventStreamResponse =
+  | createEventStreamResponseSuccess
+  | createEventStreamResponseError;
+
+export const getCreateEventStreamUrl = () => {
+  return `/event-stream`;
+};
+
+export const createEventStream = async (
+  eventStreamPostBodyBody: EventStreamPostBodyBody,
+  options?: RequestInit,
+): Promise<createEventStreamResponse> => {
+  return customFetch<createEventStreamResponse>(getCreateEventStreamUrl(), {
+    ...options,
+    method: "POST",
+    headers: { "Content-Type": "application/json", ...options?.headers },
+    body: JSON.stringify(eventStreamPostBodyBody),
+  });
+};
+
+export const getCreateEventStreamMutationOptions = <
+  TError = ErrorType<AsError | void>,
+  TContext = unknown,
+>(options?: {
+  mutation?: UseMutationOptions<
+    Awaited<ReturnType<typeof createEventStream>>,
+    TError,
+    { data: EventStreamPostBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customFetch>;
+}): UseMutationOptions<
+  Awaited<ReturnType<typeof createEventStream>>,
+  TError,
+  { data: EventStreamPostBodyBody },
+  TContext
+> => {
+  const mutationKey = ["createEventStream"];
+  const { mutation: mutationOptions, request: requestOptions } = options
+    ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
+      ? options
+      : { ...options, mutation: { ...options.mutation, mutationKey } }
+    : { mutation: { mutationKey }, request: undefined };
+
+  const mutationFn: MutationFunction<
+    Awaited<ReturnType<typeof createEventStream>>,
+    { data: EventStreamPostBodyBody }
+  > = (props) => {
+    const { data } = props ?? {};
+
+    return createEventStream(data, requestOptions);
+  };
+
+  return { mutationFn, ...mutationOptions };
+};
+
+export type CreateEventStreamMutationResult = NonNullable<
+  Awaited<ReturnType<typeof createEventStream>>
+>;
+export type CreateEventStreamMutationBody = EventStreamPostBodyBody;
+export type CreateEventStreamMutationError = ErrorType<AsError | void>;
+
+/**
+ * @summary Create a new event stream
+ */
+export const useCreateEventStream = <
+  TError = ErrorType<AsError | void>,
+  TContext = unknown,
+>(options?: {
+  mutation?: UseMutationOptions<
+    Awaited<ReturnType<typeof createEventStream>>,
+    TError,
+    { data: EventStreamPostBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customFetch>;
+}): UseMutationResult<
+  Awaited<ReturnType<typeof createEventStream>>,
+  TError,
+  { data: EventStreamPostBodyBody },
+  TContext
+> => {
+  const mutationOptions = getCreateEventStreamMutationOptions(options);
+
+  return useMutation(mutationOptions);
+};
+/**
+ * You must be the user who created the event stream.
+
+ * @summary Deletes an existing event stream (that you created)
+ */
+export type deleteEventStreamResponse204 = { data: void; status: 204 };
+
+export type deleteEventStreamResponse401 = { data: void; status: 401 };
+
+export type deleteEventStreamResponse403 = { data: AsError; status: 403 };
+
+export type deleteEventStreamResponse404 = { data: AsError; status: 404 };
+
+export type deleteEventStreamResponseSuccess = deleteEventStreamResponse204 & { headers: Headers };
+export type deleteEventStreamResponseError = (
+  | deleteEventStreamResponse401
+  | deleteEventStreamResponse403
+  | deleteEventStreamResponse404
+) & { headers: Headers };
+
+export type deleteEventStreamResponse =
+  | deleteEventStreamResponseSuccess
+  | deleteEventStreamResponseError;
+
+export const getDeleteEventStreamUrl = (eventStreamId: number) => {
+  return `/event-stream/${eventStreamId}`;
+};
+
+export const deleteEventStream = async (
+  eventStreamId: number,
+  options?: RequestInit,
+): Promise<deleteEventStreamResponse> => {
+  return customFetch<deleteEventStreamResponse>(getDeleteEventStreamUrl(eventStreamId), {
+    ...options,
+    method: "DELETE",
+  });
+};
+
+export const getDeleteEventStreamMutationOptions = <
+  TError = ErrorType<void | AsError>,
+  TContext = unknown,
+>(options?: {
+  mutation?: UseMutationOptions<
+    Awaited<ReturnType<typeof deleteEventStream>>,
+    TError,
+    { eventStreamId: number },
+    TContext
+  >;
+  request?: SecondParameter<typeof customFetch>;
+}): UseMutationOptions<
+  Awaited<ReturnType<typeof deleteEventStream>>,
+  TError,
+  { eventStreamId: number },
+  TContext
+> => {
+  const mutationKey = ["deleteEventStream"];
+  const { mutation: mutationOptions, request: requestOptions } = options
+    ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
+      ? options
+      : { ...options, mutation: { ...options.mutation, mutationKey } }
+    : { mutation: { mutationKey }, request: undefined };
+
+  const mutationFn: MutationFunction<
+    Awaited<ReturnType<typeof deleteEventStream>>,
+    { eventStreamId: number }
+  > = (props) => {
+    const { eventStreamId } = props ?? {};
+
+    return deleteEventStream(eventStreamId, requestOptions);
+  };
+
+  return { mutationFn, ...mutationOptions };
+};
+
+export type DeleteEventStreamMutationResult = NonNullable<
+  Awaited<ReturnType<typeof deleteEventStream>>
+>;
+
+export type DeleteEventStreamMutationError = ErrorType<void | AsError>;
+
+/**
+ * @summary Deletes an existing event stream (that you created)
+ */
+export const useDeleteEventStream = <
+  TError = ErrorType<void | AsError>,
+  TContext = unknown,
+>(options?: {
+  mutation?: UseMutationOptions<
+    Awaited<ReturnType<typeof deleteEventStream>>,
+    TError,
+    { eventStreamId: number },
+    TContext
+  >;
+  request?: SecondParameter<typeof customFetch>;
+}): UseMutationResult<
+  Awaited<ReturnType<typeof deleteEventStream>>,
+  TError,
+  { eventStreamId: number },
+  TContext
+> => {
+  const mutationOptions = getDeleteEventStreamMutationOptions(options);
+
+  return useMutation(mutationOptions);
+};