import type * as client from '@botpress/client';
import { AsyncCollection } from '../../utils/api-paging-utils';
import type * as typeUtils from '../../utils/type-utils';
import type * as commonTypes from '../common';
export type WorkflowProxy<TBot extends commonTypes.BaseBot = commonTypes.BaseBot> = Readonly<{
    [TWorkflowName in typeUtils.StringKeys<TBot['workflows']>]: Readonly<{
        startNewInstance: (x: Pick<client.ClientInputs['createWorkflow'], 'conversationId' | 'userId' | 'timeoutAt'> & {
            tags?: typeUtils.AtLeastOneProperty<TBot['workflows'][TWorkflowName]['tags']>;
            input: TBot['workflows'][TWorkflowName]['input'];
        }) => Promise<Readonly<Omit<client.ClientOutputs['createWorkflow'], 'workflow'> & {
            workflow: ActionableWorkflow<TBot, TWorkflowName>;
        }>>;
        listInstances: (x?: Pick<client.ClientInputs['listWorkflows'], 'conversationId' | 'userId'> & {
            tags?: typeUtils.AtLeastOneProperty<TBot['workflows'][TWorkflowName]['tags']>;
            /**
             * Filter by statuses:
             *
             * - `pending` - Workflow is created but not started yet
             * - `in_progress` - Workflow is currently running
             * - `failed` - Workflow finished with errors
             * - `completed` - Workflow finished successfully
             * - `cancelled` - Workflow finished due to cancellation through the API
             * - `timedout` - Workflow finished due to timeout
             * - `listening` - Workflow is waiting for an event to continue
             * - `paused` - Workflow was paused through the API
             */
            statuses?: client.Workflow['status'][];
        }) => AsyncCollection<ActionableWorkflow<TBot, TWorkflowName>>;
    }>;
}>;
export type ActionableWorkflow<TBot extends commonTypes.BaseBot, TWorkflowName extends typeUtils.StringKeys<TBot['workflows']>> = Readonly<client.Workflow & {
    name: TWorkflowName;
    input: typeUtils.Cast<TBot['workflows'][TWorkflowName], commonTypes.IntegrationInstanceActionDefinition>['input'];
    output: Partial<typeUtils.Cast<TBot['workflows'][TWorkflowName], commonTypes.IntegrationInstanceActionDefinition>['output']>;
    tags: Partial<TBot['workflows'][TWorkflowName]['tags']>;
    /**
     * Updates the current workflow instance
     */
    update(x: typeUtils.AtLeastOneProperty<Pick<client.ClientInputs['updateWorkflow'], 'userId' | 'timeoutAt'> & {
        tags?: typeUtils.AtLeastOneProperty<TBot['workflows'][TWorkflowName]['tags']>;
        output?: typeUtils.Cast<TBot['workflows'][TWorkflowName], commonTypes.IntegrationInstanceActionDefinition>['output'];
    }>): Promise<{
        workflow: ActionableWorkflow<TBot, TWorkflowName>;
    }>;
    /**
     * Acknowledges the start of processing for a pending workflow instance.
     * If the workflow is not in pending status or has already been
     * acknowledged, this is a no-op.
     *
     * This method **should be called in every workflow handler** as soon as the
     * workflow **starts doing work**. If no work needs to be done, setCompleted
     * or setFailed should be called instead.
     *
     * Should a workflow not be acknowledged **in a timely fashion**, it will be
     * retriggered 3 times before being marked as failed.
     */
    acknowledgeStartOfProcessing(): Promise<{
        workflow: ActionableWorkflow<TBot, TWorkflowName>;
    }>;
    /**
     * Marks the current workflow instance as failed and stops execution
     */
    setFailed(x: Required<Pick<client.ClientInputs['updateWorkflow'], 'failureReason'>>): Promise<{
        workflow: ActionableWorkflow<TBot, TWorkflowName>;
    }>;
    /**
     * Marks the current workflow instance as completed and stops execution
     */
    setCompleted(x?: {
        output?: typeUtils.Cast<TBot['workflows'][TWorkflowName], commonTypes.IntegrationInstanceActionDefinition>['output'];
    }): Promise<{
        workflow: ActionableWorkflow<TBot, TWorkflowName>;
    }>;
    /**
     * Discards all output data and cancels the current workflow instance
     */
    cancel(): Promise<{
        workflow: ActionableWorkflow<TBot, TWorkflowName>;
    }>;
}>;