@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
48 lines • 3.01 kB
TypeScript
import { IamClientCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import { IamClientError } from "../models/errors/iamclienterror.js";
import * as errors from "../models/errors/index.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import * as operations from "../models/operations/index.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
* Retrieve a list of available Maestro workflows
*
* @remarks
* This operation retrieves a list of all available Maestro workflows. It returns basic information
* about each workflow, including its unique identifier (`id`), name, description, and the input
* schema required to trigger the workflow.
*
* The response provides key details that help users identify which workflows are available
* and understand the input requirements for triggering each one. Each workflow entry also includes
* metadata, such as when it was created, last modified, and by whom.
*
* This operation is useful for obtaining an overview of all workflows within the system, helping
* users and systems know what workflows are defined, what inputs they require, and how they can
* be triggered.
*
* ### Use Cases:
* - Listing all available workflows in a system for manual or automated workflow initiation.
* - Reviewing the input requirements for a workflow before triggering it programmatically.
* - Gathering basic metadata about workflows for auditing, logging, or reporting purposes.
*
* ### Key Features:
* - **Comprehensive Workflow Overview**: Provides a full list of workflows, giving visibility
*
* into all the automated processes available within the Maestro platform.
* - **Input Schema Information**: Each workflow includes its trigger input schema, showing
*
* what data must be provided when triggering the workflow.
* - **Metadata for Tracking**: Useful metadata like creation time, last modification date,
*
* and user details are included to support tracking and auditing workflows.
* - **Future-Proof**: The operation is designed to be expandable as more workflows are added
*
* or the platform grows, ensuring scalability in the workflow management process.
*/
export declare function maestroWorkflowsGetWorkflowsList(client: IamClientCore, request: operations.GetWorkflowsListRequest, options?: RequestOptions): APIPromise<Result<components.WorkflowsListSuccess, errors.ErrorT | IamClientError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=maestroWorkflowsGetWorkflowsList.d.ts.map