/** * 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; /** * * @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; /** * * @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; /** * * @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; /** * * @summary Get a workflow definition * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefinition: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * * @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; /** * * @summary List the workflow definitions the caller may see (mine = created by the caller) * @param {boolean} [active] * @param {boolean} [mine] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDefinitions: (active?: boolean, mine?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * * @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; /** * * @summary Open tasks I can act on (by e-mail or role) * @param {*} [options] Override http request option. * @throws {RequiredError} */ myTasks: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Number of open tasks I can act on (sidebar badge) * @param {*} [options] Override http request option. * @throws {RequiredError} */ myTasksCount: (options?: RawAxiosRequestConfig) => Promise; /** * * @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; /** * * @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; /** * * @summary Counts for the monitor header * @param {*} [options] Override http request option. * @throws {RequiredError} */ summary: (options?: RawAxiosRequestConfig) => Promise; /** * * @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; /** * * @summary Validate a definition without saving it * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateDefinition: (saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * 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>; /** * * @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>; /** * * @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>; /** * * @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>; /** * * @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>; /** * * @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>; /** * * @summary List the workflow definitions the caller may see (mine = created by the caller) * @param {boolean} [active] * @param {boolean} [mine] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDefinitions(active?: boolean, mine?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @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>; /** * * @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>>; /** * * @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>; /** * * @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>; /** * * @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>; /** * * @summary Counts for the monitor header * @param {*} [options] Override http request option. * @throws {RequiredError} */ summary(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @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>; /** * * @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>; }; /** * 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; /** * * @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; /** * * @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; /** * * @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; /** * * @summary Get a workflow definition * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefinition(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @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; /** * * @summary List the workflow definitions the caller may see (mine = created by the caller) * @param {boolean} [active] * @param {boolean} [mine] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDefinitions(active?: boolean, mine?: boolean, options?: RawAxiosRequestConfig): AxiosPromise>; /** * * @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; /** * * @summary Open tasks I can act on (by e-mail or role) * @param {*} [options] Override http request option. * @throws {RequiredError} */ myTasks(options?: RawAxiosRequestConfig): AxiosPromise>; /** * * @summary Number of open tasks I can act on (sidebar badge) * @param {*} [options] Override http request option. * @throws {RequiredError} */ myTasksCount(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @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; /** * * @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; /** * * @summary Counts for the monitor header * @param {*} [options] Override http request option. * @throws {RequiredError} */ summary(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @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; /** * * @summary Validate a definition without saving it * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * 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>; /** * * @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>; /** * * @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>; /** * * @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>; /** * * @summary Get a workflow definition * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDefinition(id: string, options?: RawAxiosRequestConfig): Promise>; /** * * @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>; /** * * @summary List the workflow definitions the caller may see (mine = created by the caller) * @param {boolean} [active] * @param {boolean} [mine] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDefinitions(active?: boolean, mine?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * * @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>; /** * * @summary Open tasks I can act on (by e-mail or role) * @param {*} [options] Override http request option. * @throws {RequiredError} */ myTasks(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Number of open tasks I can act on (sidebar badge) * @param {*} [options] Override http request option. * @throws {RequiredError} */ myTasksCount(options?: RawAxiosRequestConfig): Promise>; /** * * @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>; /** * * @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>; /** * * @summary Counts for the monitor header * @param {*} [options] Override http request option. * @throws {RequiredError} */ summary(options?: RawAxiosRequestConfig): Promise>; /** * * @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>; /** * * @summary Validate a definition without saving it * @param {SaveWorkflowDefinitionRequest} saveWorkflowDefinitionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateDefinition(saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest, options?: RawAxiosRequestConfig): Promise>; } export declare const ListInstancesStatusEnum: { readonly Running: "RUNNING"; readonly Completed: "COMPLETED"; readonly Cancelled: "CANCELLED"; }; export type ListInstancesStatusEnum = typeof ListInstancesStatusEnum[keyof typeof ListInstancesStatusEnum];