@squonk/data-manager-client 3.3.2 → 4.0.0-rc.2

package/workflow/workflow.d.cts

@@ -0,0 +1,572 @@
+import { UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult, UseSuspenseQueryOptions, UseSuspenseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
+import { customInstance, WorkflowGetAllResponse, ErrorType, WorkflowPostBodyBody, WorkflowPostResponse, WorkflowGetResponse, DmError, WorkflowPatchBodyBody, WorkflowPatchResponse, WorkflowDefinitionGetResponse, WorkflowRunPostBodyBody, WorkflowRunPostResponse, WorkflowVersionPutBodyBody, WorkflowVersionPutResponse, RunningWorkflowGetAllResponse, RunningWorkflowGetResponse, RunningWorkflowStepsGetResponse } from '../index.cjs';
+import 'axios';
+
+type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
+/**
+ * Get a list of all Workflows available to you. The Workflows are listed in reverse chronological order of creation, where the most recent that was created is first in the list.
+
+ * @summary Get all Workflows available to you
+ */
+declare const getWorkflows: (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<WorkflowGetAllResponse>;
+declare const getGetWorkflowsQueryKey: () => readonly ["data-manager-api", "/workflow"];
+declare const getGetWorkflowsQueryOptions: <TData = WorkflowGetAllResponse, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetWorkflowsQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflows>>>;
+type GetWorkflowsQueryError = ErrorType<void>;
+declare function useGetWorkflows<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflows<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflows<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare const getGetWorkflowsSuspenseQueryOptions: <TData = WorkflowGetAllResponse, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetWorkflowsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflows>>>;
+type GetWorkflowsSuspenseQueryError = ErrorType<void>;
+declare function useGetWorkflowsSuspense<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflowsSuspense<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflowsSuspense<TData = Awaited<ReturnType<typeof getWorkflows>>, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * Creates a new workflow record.
+
+ * @summary Create a new Workflow
+ */
+declare const createWorkflow: (workflowPostBodyBody: WorkflowPostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<WorkflowPostResponse>;
+declare const getCreateWorkflowMutationOptions: <TData = WorkflowPostResponse, TError = ErrorType<void>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        data: WorkflowPostBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationOptions<TData, TError, {
+    data: WorkflowPostBodyBody;
+}, TContext>;
+type CreateWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof createWorkflow>>>;
+type CreateWorkflowMutationBody = WorkflowPostBodyBody;
+type CreateWorkflowMutationError = ErrorType<void>;
+/**
+* @summary Create a new Workflow
+*/
+declare const useCreateWorkflow: <TData = WorkflowPostResponse, TError = ErrorType<void>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        data: WorkflowPostBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationResult<TData, TError, {
+    data: WorkflowPostBodyBody;
+}, TContext>;
+/**
+* Get details of a specific Workflow available to you.
+
+* @summary Get details of a specific Workflow
+*/
+declare const getWorkflow: (workflowId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<WorkflowGetResponse>;
+declare const getGetWorkflowQueryKey: (workflowId: string) => readonly ["data-manager-api", `/workflow/${string}`];
+declare const getGetWorkflowQueryOptions: <TData = WorkflowGetResponse, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetWorkflowQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflow>>>;
+type GetWorkflowQueryError = ErrorType<void | DmError>;
+declare function useGetWorkflow<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(workflowId: string, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflow<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflow<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare const getGetWorkflowSuspenseQueryOptions: <TData = WorkflowGetResponse, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetWorkflowSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflow>>>;
+type GetWorkflowSuspenseQueryError = ErrorType<void | DmError>;
+declare function useGetWorkflowSuspense<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(workflowId: string, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflowSuspense<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflowSuspense<TData = Awaited<ReturnType<typeof getWorkflow>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * The Workflow is deleted.
+
+You cannot delete a Workflow if it is the _source_ of a versioned workflow.
+
+ * @summary Delete a Workflow
+ */
+declare const deleteWorkflow: (workflowId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getDeleteWorkflowMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        workflowId: string;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationOptions<TData, TError, {
+    workflowId: string;
+}, TContext>;
+type DeleteWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof deleteWorkflow>>>;
+type DeleteWorkflowMutationError = ErrorType<void | DmError>;
+/**
+* @summary Delete a Workflow
+*/
+declare const useDeleteWorkflow: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        workflowId: string;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationResult<TData, TError, {
+    workflowId: string;
+}, TContext>;
+/**
+* The Workflow is updated according to the patch parameters.
+
+In **PRODUCTION** mode you cannot alter a Workflow that has been versioned. In **DEVELOPMENT** mode you cannot alter a Workflow that is the source of Running Workflow that is running.
+
+* @summary Update a Workflow
+*/
+declare const updateWorkflow: (workflowId: string, workflowPatchBodyBody: WorkflowPatchBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<WorkflowPatchResponse>;
+declare const getUpdateWorkflowMutationOptions: <TData = WorkflowPatchResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        workflowId: string;
+        data: WorkflowPatchBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationOptions<TData, TError, {
+    workflowId: string;
+    data: WorkflowPatchBodyBody;
+}, TContext>;
+type UpdateWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof updateWorkflow>>>;
+type UpdateWorkflowMutationBody = WorkflowPatchBodyBody;
+type UpdateWorkflowMutationError = ErrorType<void | DmError>;
+/**
+* @summary Update a Workflow
+*/
+declare const useUpdateWorkflow: <TData = WorkflowPatchResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        workflowId: string;
+        data: WorkflowPatchBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationResult<TData, TError, {
+    workflowId: string;
+    data: WorkflowPatchBodyBody;
+}, TContext>;
+/**
+* Due to its potential size and complexity the definition is not returned with the Workflow. Instead, to retrieve the definition you need to call this endpoint. A string-encoded YAML document is returned.
+
+* @summary Gets the full definition of a Workflow
+*/
+declare const getWorkflowDefinition: (workflowId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<WorkflowDefinitionGetResponse>;
+declare const getGetWorkflowDefinitionQueryKey: (workflowId: string) => readonly ["data-manager-api", `/workflow/${string}/definition`];
+declare const getGetWorkflowDefinitionQueryOptions: <TData = WorkflowDefinitionGetResponse, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetWorkflowDefinitionQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflowDefinition>>>;
+type GetWorkflowDefinitionQueryError = ErrorType<void | DmError>;
+declare function useGetWorkflowDefinition<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(workflowId: string, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflowDefinition<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflowDefinition<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare const getGetWorkflowDefinitionSuspenseQueryOptions: <TData = WorkflowDefinitionGetResponse, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetWorkflowDefinitionSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getWorkflowDefinition>>>;
+type GetWorkflowDefinitionSuspenseQueryError = ErrorType<void | DmError>;
+declare function useGetWorkflowDefinitionSuspense<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(workflowId: string, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflowDefinitionSuspense<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetWorkflowDefinitionSuspense<TData = Awaited<ReturnType<typeof getWorkflowDefinition>>, TError = ErrorType<void | DmError>>(workflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getWorkflowDefinition>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * Runs a Workflow.
+
+ * @summary Run a Workflow
+ */
+declare const runWorkflow: (workflowId: string, workflowRunPostBodyBody: WorkflowRunPostBodyBody, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<WorkflowRunPostResponse>;
+declare const getRunWorkflowMutationOptions: <TData = WorkflowRunPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        workflowId: string;
+        data: WorkflowRunPostBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationOptions<TData, TError, {
+    workflowId: string;
+    data: WorkflowRunPostBodyBody;
+}, TContext>;
+type RunWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof runWorkflow>>>;
+type RunWorkflowMutationBody = WorkflowRunPostBodyBody;
+type RunWorkflowMutationError = ErrorType<void | DmError>;
+/**
+* @summary Run a Workflow
+*/
+declare const useRunWorkflow: <TData = WorkflowRunPostResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        workflowId: string;
+        data: WorkflowRunPostBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationResult<TData, TError, {
+    workflowId: string;
+    data: WorkflowRunPostBodyBody;
+}, TContext>;
+/**
+* The Workflow is first copied, leaving the original. The version (a string) is then applied to the copy of the Workflow, the `source_id` of the copy is set to the Workflow being copied, and the new Workflow ID is returned.
+
+When you apply a version to a Workflow you are making a commitment not to alter it. If you want to change the workflow you will need to return to the `source`, Workflow, modify that and then version it again.
+
+* @summary Applied a version to the Workflow
+*/
+declare const versionWorkflow: (workflowId: string, workflowVersionPutBodyBody: WorkflowVersionPutBodyBody, options?: SecondParameter<typeof customInstance>) => Promise<WorkflowVersionPutResponse>;
+declare const getVersionWorkflowMutationOptions: <TData = WorkflowVersionPutResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        workflowId: string;
+        data: WorkflowVersionPutBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationOptions<TData, TError, {
+    workflowId: string;
+    data: WorkflowVersionPutBodyBody;
+}, TContext>;
+type VersionWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof versionWorkflow>>>;
+type VersionWorkflowMutationBody = WorkflowVersionPutBodyBody;
+type VersionWorkflowMutationError = ErrorType<void | DmError>;
+/**
+* @summary Applied a version to the Workflow
+*/
+declare const useVersionWorkflow: <TData = WorkflowVersionPutResponse, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        workflowId: string;
+        data: WorkflowVersionPutBodyBody;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationResult<TData, TError, {
+    workflowId: string;
+    data: WorkflowVersionPutBodyBody;
+}, TContext>;
+/**
+* Get a list of all Running Workflows available to you. The Running Workflows are listed in chronological order of the start time, where the first that was executed is the first in the list.
+
+* @summary Get all Running Workflows available to you
+*/
+declare const getRunningWorkflows: (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<RunningWorkflowGetAllResponse>;
+declare const getGetRunningWorkflowsQueryKey: () => readonly ["data-manager-api", "/running-workflow"];
+declare const getGetRunningWorkflowsQueryOptions: <TData = RunningWorkflowGetAllResponse, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetRunningWorkflowsQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflows>>>;
+type GetRunningWorkflowsQueryError = ErrorType<void>;
+declare function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflows<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare const getGetRunningWorkflowsSuspenseQueryOptions: <TData = RunningWorkflowGetAllResponse, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetRunningWorkflowsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflows>>>;
+type GetRunningWorkflowsSuspenseQueryError = ErrorType<void>;
+declare function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflowsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflows>>, TError = ErrorType<void>>(options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflows>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * Get details of a specific Running Workflow available to you.
+
+ * @summary Get details of a specific Running Workflow
+ */
+declare const getRunningWorkflow: (runningWorkflowId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<RunningWorkflowGetResponse>;
+declare const getGetRunningWorkflowQueryKey: (runningWorkflowId: string) => readonly ["data-manager-api", `/running-workflow/${string}`];
+declare const getGetRunningWorkflowQueryOptions: <TData = RunningWorkflowGetResponse, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetRunningWorkflowQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflow>>>;
+type GetRunningWorkflowQueryError = ErrorType<void | DmError>;
+declare function useGetRunningWorkflow<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflow<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflow<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare const getGetRunningWorkflowSuspenseQueryOptions: <TData = RunningWorkflowGetResponse, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetRunningWorkflowSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflow>>>;
+type GetRunningWorkflowSuspenseQueryError = ErrorType<void | DmError>;
+declare function useGetRunningWorkflowSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflowSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflowSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflow>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflow>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+/**
+ * If the Running Workflow has stopped it is deleted.
+
+ * @summary Delete a Running Workflow
+ */
+declare const deleteRunningWorkflow: (runningWorkflowId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getDeleteRunningWorkflowMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        runningWorkflowId: string;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationOptions<TData, TError, {
+    runningWorkflowId: string;
+}, TContext>;
+type DeleteRunningWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof deleteRunningWorkflow>>>;
+type DeleteRunningWorkflowMutationError = ErrorType<void | DmError>;
+/**
+* @summary Delete a Running Workflow
+*/
+declare const useDeleteRunningWorkflow: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        runningWorkflowId: string;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationResult<TData, TError, {
+    runningWorkflowId: string;
+}, TContext>;
+/**
+* Stops a Running Workflow.
+
+* @summary Stop a Running Workflow
+*/
+declare const stopRunningWorkflow: (runningWorkflowId: string, options?: SecondParameter<typeof customInstance>) => Promise<void>;
+declare const getStopRunningWorkflowMutationOptions: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        runningWorkflowId: string;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationOptions<TData, TError, {
+    runningWorkflowId: string;
+}, TContext>;
+type StopRunningWorkflowMutationResult = NonNullable<Awaited<ReturnType<typeof stopRunningWorkflow>>>;
+type StopRunningWorkflowMutationError = ErrorType<void | DmError>;
+/**
+* @summary Stop a Running Workflow
+*/
+declare const useStopRunningWorkflow: <TData = void, TError = ErrorType<void | DmError>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        runningWorkflowId: string;
+    }, TContext>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseMutationResult<TData, TError, {
+    runningWorkflowId: string;
+}, TContext>;
+/**
+* Gets the Running Workflow step results for WWorkflow steps that are running (or have run). The steps are listed in chronological order of start time, where the first executed step is the first in the list.
+
+* @summary Get all the Running Workflow Steps
+*/
+declare const getRunningWorkflowSteps: (runningWorkflowId: string, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal) => Promise<RunningWorkflowStepsGetResponse>;
+declare const getGetRunningWorkflowStepsQueryKey: (runningWorkflowId: string) => readonly ["data-manager-api", `/running-workflow/${string}/steps`];
+declare const getGetRunningWorkflowStepsQueryOptions: <TData = RunningWorkflowStepsGetResponse, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetRunningWorkflowStepsQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflowSteps>>>;
+type GetRunningWorkflowStepsQueryError = ErrorType<void | DmError>;
+declare function useGetRunningWorkflowSteps<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options: {
+    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): DefinedUseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflowSteps<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>, 'initialData'>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflowSteps<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare const getGetRunningWorkflowStepsSuspenseQueryOptions: <TData = RunningWorkflowStepsGetResponse, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}) => UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+type GetRunningWorkflowStepsSuspenseQueryResult = NonNullable<Awaited<ReturnType<typeof getRunningWorkflowSteps>>>;
+type GetRunningWorkflowStepsSuspenseQueryError = ErrorType<void | DmError>;
+declare function useGetRunningWorkflowStepsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options: {
+    query: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflowStepsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+declare function useGetRunningWorkflowStepsSuspense<TData = Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError = ErrorType<void | DmError>>(runningWorkflowId: string, options?: {
+    query?: Partial<UseSuspenseQueryOptions<Awaited<ReturnType<typeof getRunningWorkflowSteps>>, TError, TData>>;
+    request?: SecondParameter<typeof customInstance>;
+}): UseSuspenseQueryResult<TData, TError> & {
+    queryKey: DataTag<QueryKey, TData, TError>;
+};
+
+export { type CreateWorkflowMutationBody, type CreateWorkflowMutationError, type CreateWorkflowMutationResult, type DeleteRunningWorkflowMutationError, type DeleteRunningWorkflowMutationResult, type DeleteWorkflowMutationError, type DeleteWorkflowMutationResult, type GetRunningWorkflowQueryError, type GetRunningWorkflowQueryResult, type GetRunningWorkflowStepsQueryError, type GetRunningWorkflowStepsQueryResult, type GetRunningWorkflowStepsSuspenseQueryError, type GetRunningWorkflowStepsSuspenseQueryResult, type GetRunningWorkflowSuspenseQueryError, type GetRunningWorkflowSuspenseQueryResult, type GetRunningWorkflowsQueryError, type GetRunningWorkflowsQueryResult, type GetRunningWorkflowsSuspenseQueryError, type GetRunningWorkflowsSuspenseQueryResult, type GetWorkflowDefinitionQueryError, type GetWorkflowDefinitionQueryResult, type GetWorkflowDefinitionSuspenseQueryError, type GetWorkflowDefinitionSuspenseQueryResult, type GetWorkflowQueryError, type GetWorkflowQueryResult, type GetWorkflowSuspenseQueryError, type GetWorkflowSuspenseQueryResult, type GetWorkflowsQueryError, type GetWorkflowsQueryResult, type GetWorkflowsSuspenseQueryError, type GetWorkflowsSuspenseQueryResult, type RunWorkflowMutationBody, type RunWorkflowMutationError, type RunWorkflowMutationResult, type StopRunningWorkflowMutationError, type StopRunningWorkflowMutationResult, type UpdateWorkflowMutationBody, type UpdateWorkflowMutationError, type UpdateWorkflowMutationResult, type VersionWorkflowMutationBody, type VersionWorkflowMutationError, type VersionWorkflowMutationResult, createWorkflow, deleteRunningWorkflow, deleteWorkflow, getCreateWorkflowMutationOptions, getDeleteRunningWorkflowMutationOptions, getDeleteWorkflowMutationOptions, getGetRunningWorkflowQueryKey, getGetRunningWorkflowQueryOptions, getGetRunningWorkflowStepsQueryKey, getGetRunningWorkflowStepsQueryOptions, getGetRunningWorkflowStepsSuspenseQueryOptions, getGetRunningWorkflowSuspenseQueryOptions, getGetRunningWorkflowsQueryKey, getGetRunningWorkflowsQueryOptions, getGetRunningWorkflowsSuspenseQueryOptions, getGetWorkflowDefinitionQueryKey, getGetWorkflowDefinitionQueryOptions, getGetWorkflowDefinitionSuspenseQueryOptions, getGetWorkflowQueryKey, getGetWorkflowQueryOptions, getGetWorkflowSuspenseQueryOptions, getGetWorkflowsQueryKey, getGetWorkflowsQueryOptions, getGetWorkflowsSuspenseQueryOptions, getRunWorkflowMutationOptions, getRunningWorkflow, getRunningWorkflowSteps, getRunningWorkflows, getStopRunningWorkflowMutationOptions, getUpdateWorkflowMutationOptions, getVersionWorkflowMutationOptions, getWorkflow, getWorkflowDefinition, getWorkflows, runWorkflow, stopRunningWorkflow, updateWorkflow, useCreateWorkflow, useDeleteRunningWorkflow, useDeleteWorkflow, useGetRunningWorkflow, useGetRunningWorkflowSteps, useGetRunningWorkflowStepsSuspense, useGetRunningWorkflowSuspense, useGetRunningWorkflows, useGetRunningWorkflowsSuspense, useGetWorkflow, useGetWorkflowDefinition, useGetWorkflowDefinitionSuspense, useGetWorkflowSuspense, useGetWorkflows, useGetWorkflowsSuspense, useRunWorkflow, useStopRunningWorkflow, useUpdateWorkflow, useVersionWorkflow, versionWorkflow };