@openfilz-sdk/typescript-ee 1.9.9 → 1.9.11

package/dist/api/workflows-api.d.ts

@@ -0,0 +1,565 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { CancelInstanceRequest } from '../models';
+import type { CompleteTaskRequest } from '../models';
+import type { MyTasksCountDTO } from '../models';
+import type { ReassignTaskRequest } from '../models';
+import type { SaveWorkflowDefinitionRequest } from '../models';
+import type { StartWorkflowRequest } from '../models';
+import type { WorkflowDefinitionDTO } from '../models';
+import type { WorkflowInstanceDTO } from '../models';
+import type { WorkflowInstanceDetailDTO } from '../models';
+import type { WorkflowInstancePage } from '../models';
+import type { WorkflowSummaryDTO } from '../models';
+import type { WorkflowTaskDTO } from '../models';
+import type { WorkflowValidationResult } from '../models';
+/**
+ * WorkflowsApi - axios parameter creator
+ */
+export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Cancel a running instance (initiator)
+     * @param {string} id
+     * @param {CancelInstanceRequest} [cancelInstanceRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancel: (id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Take a transition on a task I am a candidate of
+     * @param {string} id
+     * @param {CompleteTaskRequest} completeTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    complete: (id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Create a workflow definition (400 with the problem list when invalid)
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDefinition: (saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete a workflow definition (409 while instances are running)
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDefinition: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a workflow definition
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDefinition: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary One instance with its snapshot spec, open task and history
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstance: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List workflow definitions
+     * @param {boolean} [active]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDefinitions: (active?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List instances (monitor), newest first
+     * @param {string} [documentId]
+     * @param {string} [definitionId]
+     * @param {ListInstancesStatusEnum} [status]
+     * @param {string} [state]
+     * @param {boolean} [mine]
+     * @param {number} [page]
+     * @param {number} [size]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInstances: (documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Open tasks I can act on (by e-mail or role)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTasks: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Number of open tasks I can act on (sidebar badge)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTasksCount: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Hand a task to other people (initiator or current candidate)
+     * @param {string} id
+     * @param {ReassignTaskRequest} reassignTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reassign: (id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Start a workflow on a document (409 when one is already running)
+     * @param {StartWorkflowRequest} startWorkflowRequest
+     * @param {string} [acceptLanguage]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    start: (startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Counts for the monitor header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    summary: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update a workflow definition (running instances keep their snapshot)
+     * @param {string} id
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDefinition: (id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Validate a definition without saving it
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateDefinition: (saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * WorkflowsApi - functional programming interface
+ */
+export declare const WorkflowsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Cancel a running instance (initiator)
+     * @param {string} id
+     * @param {CancelInstanceRequest} [cancelInstanceRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancel(id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>>;
+    /**
+     *
+     * @summary Take a transition on a task I am a candidate of
+     * @param {string} id
+     * @param {CompleteTaskRequest} completeTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    complete(id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>>;
+    /**
+     *
+     * @summary Create a workflow definition (400 with the problem list when invalid)
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionDTO>>;
+    /**
+     *
+     * @summary Delete a workflow definition (409 while instances are running)
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDefinition(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Get a workflow definition
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDefinition(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionDTO>>;
+    /**
+     *
+     * @summary One instance with its snapshot spec, open task and history
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstance(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDetailDTO>>;
+    /**
+     *
+     * @summary List workflow definitions
+     * @param {boolean} [active]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDefinitions(active?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowDefinitionDTO>>>;
+    /**
+     *
+     * @summary List instances (monitor), newest first
+     * @param {string} [documentId]
+     * @param {string} [definitionId]
+     * @param {ListInstancesStatusEnum} [status]
+     * @param {string} [state]
+     * @param {boolean} [mine]
+     * @param {number} [page]
+     * @param {number} [size]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInstances(documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstancePage>>;
+    /**
+     *
+     * @summary Open tasks I can act on (by e-mail or role)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTasks(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowTaskDTO>>>;
+    /**
+     *
+     * @summary Number of open tasks I can act on (sidebar badge)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTasksCount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MyTasksCountDTO>>;
+    /**
+     *
+     * @summary Hand a task to other people (initiator or current candidate)
+     * @param {string} id
+     * @param {ReassignTaskRequest} reassignTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reassign(id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>>;
+    /**
+     *
+     * @summary Start a workflow on a document (409 when one is already running)
+     * @param {StartWorkflowRequest} startWorkflowRequest
+     * @param {string} [acceptLanguage]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    start(startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowInstanceDTO>>;
+    /**
+     *
+     * @summary Counts for the monitor header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    summary(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowSummaryDTO>>;
+    /**
+     *
+     * @summary Update a workflow definition (running instances keep their snapshot)
+     * @param {string} id
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDefinition(id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowDefinitionDTO>>;
+    /**
+     *
+     * @summary Validate a definition without saving it
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowValidationResult>>;
+};
+/**
+ * WorkflowsApi - factory interface
+ */
+export declare const WorkflowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Cancel a running instance (initiator)
+     * @param {string} id
+     * @param {CancelInstanceRequest} [cancelInstanceRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancel(id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO>;
+    /**
+     *
+     * @summary Take a transition on a task I am a candidate of
+     * @param {string} id
+     * @param {CompleteTaskRequest} completeTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    complete(id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO>;
+    /**
+     *
+     * @summary Create a workflow definition (400 with the problem list when invalid)
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionDTO>;
+    /**
+     *
+     * @summary Delete a workflow definition (409 while instances are running)
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDefinition(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Get a workflow definition
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDefinition(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionDTO>;
+    /**
+     *
+     * @summary One instance with its snapshot spec, open task and history
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstance(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDetailDTO>;
+    /**
+     *
+     * @summary List workflow definitions
+     * @param {boolean} [active]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDefinitions(active?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowDefinitionDTO>>;
+    /**
+     *
+     * @summary List instances (monitor), newest first
+     * @param {string} [documentId]
+     * @param {string} [definitionId]
+     * @param {ListInstancesStatusEnum} [status]
+     * @param {string} [state]
+     * @param {boolean} [mine]
+     * @param {number} [page]
+     * @param {number} [size]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInstances(documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstancePage>;
+    /**
+     *
+     * @summary Open tasks I can act on (by e-mail or role)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTasks(options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowTaskDTO>>;
+    /**
+     *
+     * @summary Number of open tasks I can act on (sidebar badge)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTasksCount(options?: RawAxiosRequestConfig): AxiosPromise<MyTasksCountDTO>;
+    /**
+     *
+     * @summary Hand a task to other people (initiator or current candidate)
+     * @param {string} id
+     * @param {ReassignTaskRequest} reassignTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reassign(id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO>;
+    /**
+     *
+     * @summary Start a workflow on a document (409 when one is already running)
+     * @param {StartWorkflowRequest} startWorkflowRequest
+     * @param {string} [acceptLanguage]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    start(startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowInstanceDTO>;
+    /**
+     *
+     * @summary Counts for the monitor header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    summary(options?: RawAxiosRequestConfig): AxiosPromise<WorkflowSummaryDTO>;
+    /**
+     *
+     * @summary Update a workflow definition (running instances keep their snapshot)
+     * @param {string} id
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDefinition(id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowDefinitionDTO>;
+    /**
+     *
+     * @summary Validate a definition without saving it
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowValidationResult>;
+};
+/**
+ * WorkflowsApi - object-oriented interface
+ */
+export declare class WorkflowsApi extends BaseAPI {
+    /**
+     *
+     * @summary Cancel a running instance (initiator)
+     * @param {string} id
+     * @param {CancelInstanceRequest} [cancelInstanceRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancel(id: string, cancelInstanceRequest?: CancelInstanceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDTO, any, {}, any>>;
+    /**
+     *
+     * @summary Take a transition on a task I am a candidate of
+     * @param {string} id
+     * @param {CompleteTaskRequest} completeTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    complete(id: string, completeTaskRequest: CompleteTaskRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDTO, any, {}, any>>;
+    /**
+     *
+     * @summary Create a workflow definition (400 with the problem list when invalid)
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowDefinitionDTO, any, {}, any>>;
+    /**
+     *
+     * @summary Delete a workflow definition (409 while instances are running)
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDefinition(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     *
+     * @summary Get a workflow definition
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDefinition(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowDefinitionDTO, any, {}, any>>;
+    /**
+     *
+     * @summary One instance with its snapshot spec, open task and history
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstance(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDetailDTO, any, {}, any>>;
+    /**
+     *
+     * @summary List workflow definitions
+     * @param {boolean} [active]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDefinitions(active?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowDefinitionDTO[], any, {}, any>>;
+    /**
+     *
+     * @summary List instances (monitor), newest first
+     * @param {string} [documentId]
+     * @param {string} [definitionId]
+     * @param {ListInstancesStatusEnum} [status]
+     * @param {string} [state]
+     * @param {boolean} [mine]
+     * @param {number} [page]
+     * @param {number} [size]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listInstances(documentId?: string, definitionId?: string, status?: ListInstancesStatusEnum, state?: string, mine?: boolean, page?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstancePage, any, {}, any>>;
+    /**
+     *
+     * @summary Open tasks I can act on (by e-mail or role)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTasks(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowTaskDTO[], any, {}, any>>;
+    /**
+     *
+     * @summary Number of open tasks I can act on (sidebar badge)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    myTasksCount(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MyTasksCountDTO, any, {}, any>>;
+    /**
+     *
+     * @summary Hand a task to other people (initiator or current candidate)
+     * @param {string} id
+     * @param {ReassignTaskRequest} reassignTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reassign(id: string, reassignTaskRequest: ReassignTaskRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDTO, any, {}, any>>;
+    /**
+     *
+     * @summary Start a workflow on a document (409 when one is already running)
+     * @param {StartWorkflowRequest} startWorkflowRequest
+     * @param {string} [acceptLanguage]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    start(startWorkflowRequest: StartWorkflowRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowInstanceDTO, any, {}, any>>;
+    /**
+     *
+     * @summary Counts for the monitor header
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    summary(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowSummaryDTO, any, {}, any>>;
+    /**
+     *
+     * @summary Update a workflow definition (running instances keep their snapshot)
+     * @param {string} id
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDefinition(id: string, saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowDefinitionDTO, any, {}, any>>;
+    /**
+     *
+     * @summary Validate a definition without saving it
+     * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowValidationResult, any, {}, any>>;
+}
+export declare const ListInstancesStatusEnum: {
+    readonly Running: "RUNNING";
+    readonly Completed: "COMPLETED";
+    readonly Cancelled: "CANCELLED";
+};
+export type ListInstancesStatusEnum = typeof ListInstancesStatusEnum[keyof typeof ListInstancesStatusEnum];