@squonk/account-server-client 4.1.1 → 4.2.0-4-2.1834811920

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

@@ -7,7 +7,7 @@
 
 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.1
+ * OpenAPI spec version: 4.2
  */
 import {
   useMutation,
@@ -31,7 +31,9 @@ import type {
 } from '@tanstack/react-query'
 import type {
   AsError,
-  EventStreamGetPostResponse
+  EventStreamGetPostResponse,
+  EventStreamPostBodyBody,
+  EventStreamVersionGetResponse
 } from '../account-server-api.schemas'
 import { customInstance } from '.././custom-instance';
 import type { ErrorType } from '.././custom-instance';
@@ -41,84 +43,84 @@ type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
 
 
 /**
- * Gets your EventStream ID and read token, if you have created one.
+ * Gets the details of the installed event stream, which includes its **category**, and **name**.
 
- * @summary Gets the details of your EventStream
+ * @summary Gets the details of the installed event stream
  */
-export const getEventStream = (
+export const getEventStreamVersion = (
     
  options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
 ) => {
       
       
-      return customInstance<EventStreamGetPostResponse>(
-      {url: `/event-stream`, method: 'GET', signal
+      return customInstance<EventStreamVersionGetResponse>(
+      {url: `/event-stream/version`, method: 'GET', signal
     },
       options);
     }
   
 
-export const getGetEventStreamQueryKey = () => {
-    return ["account-server-api", `/event-stream`] as const;
+export const getGetEventStreamVersionQueryKey = () => {
+    return ["account-server-api", `/event-stream/version`] as const;
     }
 
     
-export const getGetEventStreamQueryOptions = <TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export const getGetEventStreamVersionQueryOptions = <TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
 
-  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamQueryKey();
+  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamVersionQueryKey();
 
   
 
-    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStream>>> = ({ signal }) => getEventStream(requestOptions, signal);
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStreamVersion>>> = ({ signal }) => getEventStreamVersion(requestOptions, signal);
 
       
 
       
 
-   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
+   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
 }
 
-export type GetEventStreamQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStream>>>
-export type GetEventStreamQueryError = ErrorType<void | AsError>
+export type GetEventStreamVersionQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStreamVersion>>>
+export type GetEventStreamVersionQueryError = ErrorType<void | AsError>
 
 
-export function useGetEventStream<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
-  options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>> & Pick<
+export function useGetEventStreamVersion<TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>(
+  options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>> & Pick<
         DefinedInitialDataOptions<
-          Awaited<ReturnType<typeof getEventStream>>,
+          Awaited<ReturnType<typeof getEventStreamVersion>>,
           TError,
           TData
         > , 'initialData'
       >, request?: SecondParameter<typeof customInstance>}
 
   ):  DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetEventStream<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
-  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>> & Pick<
+export function useGetEventStreamVersion<TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>> & Pick<
         UndefinedInitialDataOptions<
-          Awaited<ReturnType<typeof getEventStream>>,
+          Awaited<ReturnType<typeof getEventStreamVersion>>,
           TError,
           TData
         > , 'initialData'
       >, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetEventStream<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
-  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamVersion<TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 /**
- * @summary Gets the details of your EventStream
+ * @summary Gets the details of the installed event stream
  */
 
-export function useGetEventStream<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
-  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamVersion<TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
 
-  const queryOptions = getGetEventStreamQueryOptions(options)
+  const queryOptions = getGetEventStreamVersionQueryOptions(options)
 
   const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 
@@ -129,50 +131,50 @@ export function useGetEventStream<TData = Awaited<ReturnType<typeof getEventStre
 
 
 
-export const getGetEventStreamSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export const getGetEventStreamVersionSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
 
-  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamQueryKey();
+  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamVersionQueryKey();
 
   
 
-    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStream>>> = ({ signal }) => getEventStream(requestOptions, signal);
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStreamVersion>>> = ({ signal }) => getEventStreamVersion(requestOptions, signal);
 
       
 
       
 
-   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
 }
 
-export type GetEventStreamSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStream>>>
-export type GetEventStreamSuspenseQueryError = ErrorType<void | AsError>
+export type GetEventStreamVersionSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStreamVersion>>>
+export type GetEventStreamVersionSuspenseQueryError = ErrorType<void | AsError>
 
 
-export function useGetEventStreamSuspense<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
-  options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamVersionSuspense<TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>(
+  options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetEventStreamSuspense<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
-  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamVersionSuspense<TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetEventStreamSuspense<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
-  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamVersionSuspense<TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 /**
- * @summary Gets the details of your EventStream
+ * @summary Gets the details of the installed event stream
  */
 
-export function useGetEventStreamSuspense<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
-  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamVersionSuspense<TData = Awaited<ReturnType<typeof getEventStreamVersion>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamVersion>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
 
-  const queryOptions = getGetEventStreamSuspenseQueryOptions(options)
+  const queryOptions = getGetEventStreamVersionSuspenseQueryOptions(options)
 
   const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 
@@ -184,151 +186,84 @@ export function useGetEventStreamSuspense<TData = Awaited<ReturnType<typeof getE
 
 
 /**
- * Creates a new event stream (based on the **Server Sent Events** framework) for the authenticated user.
-
-A user is only permitted one event stream.
+ * 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 Create a new Server-Sent Events EventStream
+ * @summary Gets the details of your event stream
  */
-export const createEventStream = (
+export const getEventStream = (
     
  options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
 ) => {
       
       
       return customInstance<EventStreamGetPostResponse>(
-      {url: `/event-stream`, method: 'POST', signal
-    },
-      options);
-    }
-  
-
-
-export const getCreateEventStreamMutationOptions = <TData = Awaited<ReturnType<typeof createEventStream>>, TError = ErrorType<AsError | void>,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,void, TContext>, request?: SecondParameter<typeof customInstance>}
-) => {
-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>>, void> = () => {
-          
-
-          return  createEventStream(requestOptions)
-        }
-
-        
-
-
-  return  { mutationFn, ...mutationOptions } as UseMutationOptions<TData, TError,void, TContext>}
-
-    export type CreateEventStreamMutationResult = NonNullable<Awaited<ReturnType<typeof createEventStream>>>
-    
-    export type CreateEventStreamMutationError = ErrorType<AsError | void>
-
-    /**
- * @summary Create a new Server-Sent Events EventStream
- */
-export const useCreateEventStream = <TData = Awaited<ReturnType<typeof createEventStream>>, TError = ErrorType<AsError | void>,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,void, TContext>, request?: SecondParameter<typeof customInstance>}
-): UseMutationResult<
-        TData,
-        TError,
-        void,
-        TContext
-      > => {
-
-      const mutationOptions = getCreateEventStreamMutationOptions(options);
-
-      return useMutation(mutationOptions);
-    }
-    /**
- * Gets events that you are entitled to receive. Events are delivered as **Server Sent Events** and you are expected to continuously read form this endpoint or it will be closed.
-
-This is an un-authenticated endpoint. In order to read from the stream the caller must provide either the User access token that belongs to the event stream or the **read token** that was allocated when the stream was created. The **read token** must be provided in the request header property `X-IM-AS-EventStreamReadToken`.
-
- * @summary Subscribe to Server-Sent Events events from an EventStream
- */
-export const getEventStreamEvents = (
-    eventStreamId: number,
- options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
-) => {
-      
-      
-      return customInstance<string>(
-      {url: `/event-stream/${eventStreamId}`, method: 'GET', signal
+      {url: `/event-stream`, method: 'GET', signal
     },
       options);
     }
   
 
-export const getGetEventStreamEventsQueryKey = (eventStreamId: number,) => {
-    return ["account-server-api", `/event-stream/${eventStreamId}`] as const;
+export const getGetEventStreamQueryKey = () => {
+    return ["account-server-api", `/event-stream`] as const;
     }
 
     
-export const getGetEventStreamEventsQueryOptions = <TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(eventStreamId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export const getGetEventStreamQueryOptions = <TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
 
-  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamEventsQueryKey(eventStreamId);
+  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamQueryKey();
 
   
 
-    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStreamEvents>>> = ({ signal }) => getEventStreamEvents(eventStreamId, requestOptions, signal);
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStream>>> = ({ signal }) => getEventStream(requestOptions, signal);
 
       
 
       
 
-   return  { queryKey, queryFn, enabled: !!(eventStreamId), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
+   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
 }
 
-export type GetEventStreamEventsQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStreamEvents>>>
-export type GetEventStreamEventsQueryError = ErrorType<void | AsError>
+export type GetEventStreamQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStream>>>
+export type GetEventStreamQueryError = ErrorType<void | AsError>
 
 
-export function useGetEventStreamEvents<TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
- eventStreamId: number, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>> & Pick<
+export function useGetEventStream<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>> & Pick<
         DefinedInitialDataOptions<
-          Awaited<ReturnType<typeof getEventStreamEvents>>,
+          Awaited<ReturnType<typeof getEventStream>>,
           TError,
           TData
         > , 'initialData'
       >, request?: SecondParameter<typeof customInstance>}
 
   ):  DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetEventStreamEvents<TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
- eventStreamId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>> & Pick<
+export function useGetEventStream<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>> & Pick<
         UndefinedInitialDataOptions<
-          Awaited<ReturnType<typeof getEventStreamEvents>>,
+          Awaited<ReturnType<typeof getEventStream>>,
           TError,
           TData
         > , 'initialData'
       >, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetEventStreamEvents<TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
- eventStreamId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStream<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 /**
- * @summary Subscribe to Server-Sent Events events from an EventStream
+ * @summary Gets the details of your event stream
  */
 
-export function useGetEventStreamEvents<TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
- eventStreamId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStream<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
 
-  const queryOptions = getGetEventStreamEventsQueryOptions(eventStreamId,options)
+  const queryOptions = getGetEventStreamQueryOptions(options)
 
   const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 
@@ -339,50 +274,50 @@ export function useGetEventStreamEvents<TData = Awaited<ReturnType<typeof getEve
 
 
 
-export const getGetEventStreamEventsSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(eventStreamId: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export const getGetEventStreamSuspenseQueryOptions = <TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>( options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 ) => {
 
 const {query: queryOptions, request: requestOptions} = options ?? {};
 
-  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamEventsQueryKey(eventStreamId);
+  const queryKey =  queryOptions?.queryKey ?? getGetEventStreamQueryKey();
 
   
 
-    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStreamEvents>>> = ({ signal }) => getEventStreamEvents(eventStreamId, requestOptions, signal);
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof getEventStream>>> = ({ signal }) => getEventStream(requestOptions, signal);
 
       
 
       
 
-   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
+   return  { queryKey, queryFn, ...queryOptions} as UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }
 }
 
-export type GetEventStreamEventsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStreamEvents>>>
-export type GetEventStreamEventsSuspenseQueryError = ErrorType<void | AsError>
+export type GetEventStreamSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getEventStream>>>
+export type GetEventStreamSuspenseQueryError = ErrorType<void | AsError>
 
 
-export function useGetEventStreamEventsSuspense<TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
- eventStreamId: number, options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamSuspense<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options: { query:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetEventStreamEventsSuspense<TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
- eventStreamId: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamSuspense<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
-export function useGetEventStreamEventsSuspense<TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
- eventStreamId: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamSuspense<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }
 /**
- * @summary Subscribe to Server-Sent Events events from an EventStream
+ * @summary Gets the details of your event stream
  */
 
-export function useGetEventStreamEventsSuspense<TData = Awaited<ReturnType<typeof getEventStreamEvents>>, TError = ErrorType<void | AsError>>(
- eventStreamId: number, options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStreamEvents>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
+export function useGetEventStreamSuspense<TData = Awaited<ReturnType<typeof getEventStream>>, TError = ErrorType<void | AsError>>(
+  options?: { query?:Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getEventStream>>, TError, TData>>, request?: SecondParameter<typeof customInstance>}
 
   ):  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
 
-  const queryOptions = getGetEventStreamEventsSuspenseQueryOptions(eventStreamId,options)
+  const queryOptions = getGetEventStreamSuspenseQueryOptions(options)
 
   const query = useSuspenseQuery(queryOptions) as  UseSuspenseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 
@@ -394,11 +329,82 @@ export function useGetEventStreamEventsSuspense<TData = Awaited<ReturnType<typeo
 
 
 /**
- * Deletes an Event Stream.
+ * 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 const createEventStream = (
+    eventStreamPostBodyBody: EventStreamPostBodyBody,
+ options?: SecondParameter<typeof customInstance>,signal?: AbortSignal
+) => {
+      
+      
+      return customInstance<EventStreamGetPostResponse>(
+      {url: `/event-stream`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: eventStreamPostBodyBody, signal
+    },
+      options);
+    }
+  
+
 
-You must be the user who created the event stream.
+export const getCreateEventStreamMutationOptions = <TData = Awaited<ReturnType<typeof createEventStream>>, TError = ErrorType<AsError | void>,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: EventStreamPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
+) => {
+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 } as UseMutationOptions<TData, TError,{data: EventStreamPostBodyBody}, TContext>}
+
+    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 = <TData = Awaited<ReturnType<typeof createEventStream>>, TError = ErrorType<AsError | void>,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{data: EventStreamPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}
+): UseMutationResult<
+        TData,
+        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 EventStream (that you created)
+ * @summary Deletes an existing event stream (that you created)
  */
 export const deleteEventStream = (
     eventStreamId: number,
@@ -442,7 +448,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
     export type DeleteEventStreamMutationError = ErrorType<void | AsError>
 
     /**
- * @summary Deletes an existing EventStream (that you created)
+ * @summary Deletes an existing event stream (that you created)
  */
 export const useDeleteEventStream = <TData = Awaited<ReturnType<typeof deleteEventStream>>, TError = ErrorType<void | AsError>,
     TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{eventStreamId: number}, TContext>, request?: SecondParameter<typeof customInstance>}

package/src/merchant/merchant.ts

@@ -7,7 +7,7 @@
 
 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.1
+ * OpenAPI spec version: 4.2
  */
 import {
   useQuery,

package/src/organisation/organisation.ts

@@ -7,7 +7,7 @@
 
 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.1
+ * OpenAPI spec version: 4.2
  */
 import {
   useMutation,

package/src/product/product.ts

@@ -7,7 +7,7 @@
 
 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.1
+ * OpenAPI spec version: 4.2
  */
 import {
   useMutation,
@@ -619,15 +619,17 @@ export function useGetProductsForOrganisationSuspense<TData = Awaited<ReturnType
 
 
 /**
- * Products are **Subscriptions** that you create in a Unit and use **Merchant** services like the `DATA_MANAGER`.
+ * 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**.
 
-Typical subscriptions include `DATA_MANAGER_STORAGE_SUBSCRIPTION` and `DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION`.
+Supported subscription **types** include `DATA_MANAGER_STORAGE_SUBSCRIPTION`, and `DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION`.
 
-Some subscriptions, like the `DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION` are available in various **flavours** that influence their capabilities. Flavours are typically referred to using the names `BRONZE`, `SILVER` and `GOLD`
+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.
 
-To do this you need to be a member of the **Unit** or the **Organisation**.
+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`.
 
- * @summary Creates a Product for an Organisational Unit
+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
  */
 export const createUnitProduct = (
     unitId: string,
@@ -675,7 +677,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
     export type CreateUnitProductMutationError = ErrorType<AsError | void>
 
     /**
- * @summary Creates a Product for an Organisational Unit
+ * @summary Creates a Product for a Unit
  */
 export const useCreateUnitProduct = <TData = Awaited<ReturnType<typeof createUnitProduct>>, TError = ErrorType<AsError | void>,
     TContext = unknown>(options?: { mutation?:UseMutationOptions<TData, TError,{unitId: string;data: UnitProductPostBodyBody}, TContext>, request?: SecondParameter<typeof customInstance>}

package/src/state/state.ts

@@ -7,7 +7,7 @@
 
 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.1
+ * OpenAPI spec version: 4.2
  */
 import {
   useQuery,

package/src/unit/unit.ts

@@ -7,7 +7,7 @@
 
 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.1
+ * OpenAPI spec version: 4.2
  */
 import {
   useMutation,

package/src/user/user.ts

@@ -7,7 +7,7 @@
 
 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.1
+ * OpenAPI spec version: 4.2
  */
 import {
   useMutation,