@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
42 lines • 2.89 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 trigger requirements for a specific Maestro workflow
*
* @remarks
* This operation retrieves the configuration and input requirements necessary to trigger a specific
* Maestro workflow. It provides detailed information about the `trigger_event_type`, such as HTTP
* or other supported types, and specifies the required input schema, including field names, data types,
* and any default values.
*
* This information is essential for understanding the data and parameters required to initiate the
* workflow. It enables developers to prepare the necessary inputs and configuration before triggering
* the workflow instance, ensuring seamless execution and compliance with workflow requirements.
*
* ### Use Cases:
* - Identifying the required input fields and their data types to successfully trigger the workflow.
* - Reviewing the trigger configuration for validation and compliance with expected input.
* - Preparing and validating data in advance of triggering the workflow, minimizing runtime errors.
*
* ### Key Features:
* - **Detailed Trigger Input Requirements**: Provides an exhaustive schema of required fields,
*
* their data types, and optional default values for easy reference and data validation.
* - **Trigger Event Type Information**: Specifies the type of event required to initiate the workflow
*
* (e.g., HTTP), helping developers configure their systems to invoke the workflow appropriately.
* - **Configurable for Custom Triggers**: Suitable for custom configurations, enabling flexibility
*
* in how workflows can be triggered according to system needs.
*/
export declare function maestroWorkflowsGetWorkflowTriggerRequirements(client: IamClientCore, request: operations.GetWorkflowTriggerRequirementsRequest, options?: RequestOptions): APIPromise<Result<components.WorkflowTriggerRequirementsSuccess, errors.ErrorT | IamClientError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=maestroWorkflowsGetWorkflowTriggerRequirements.d.ts.map