import { WorkflowModel, WorkflowModelDetails, WorkflowModelWithPermissions } from 'src/models/interfaces/workflow/model'; import { WorkflowVariable } from 'src/models/interfaces/workflow/variable'; import { WorkflowInstance } from 'src/models/interfaces/workflow/instance'; declare function getAllModels(): Promise; declare function getAllModels(includePermissions: boolean): Promise; /** @namespace * * ## Utilities for helping your app interact with Workflows. * * @example * ```typescript * import { WorkflowClient } from @domoinc/toolkit; * * const WORKFLOW_ALIAS = 'testWorkflow'; * const MODEL_INSTANCE_ID = 'dc8fa95d-746f-226f-98a9-4693da393a22'; * * /** * * Get all models in the instance * * @param includePermissions Define is the permissions for the current user should be attached * *\/ * await WorkflowClient.getAllModels(true); * * /** * * Get details for single workflow model. Includes information about instances of the model. * * @param workflowAlias Defined in the manifest, under `mappings` * *\/ * await WorkflowClient.getModelDetails(WORKFLOW_ALIAS); * * /** * * Get details for single instance (i.e. an execution) of a workflow model * * @param workflowAlias Defined in the manifest, under `mappings` * * @param instanceId Unique UUID that identifies a single instance of the workflow * *\/ * await WorkflowClient.getInstance(WORKFLOW_ALIAS, MODEL_INSTANCE_ID); * * /** * * Trigger a manual instance of the workflow model (i.e. execute it once, manually) * * @param workflowAlias Defined in the manifest, under `mappings` * * @param variables Key-pair set of inputs for the start node of the workflow * *\/ * await WorkflowClient.startModel(WORKFLOW_ALIAS, { exampleInput: 1000 }); * ``` */ export declare const WorkflowClient: { getAllModels: typeof getAllModels; getModelDetails: (workflowAlias: string) => Promise; getInstance: (workflowAlias: string, instanceId: string) => Promise; startModel: (workflowAlias: string, variables: WorkflowVariable) => Promise; }; export {};