@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
61 lines • 2.82 kB
TypeScript
import * as z from "zod";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import { TriggerInputs, TriggerInputs$Outbound } from "./triggerinputs.js";
/**
* The input information needed to trigger a new instance of a Maestro workflow.
*
* @remarks
* This request body contains the metadata to describe the instance being created,
* along with the input data required to trigger the workflow.
*
* - `instance_name` provides a user-defined name for the workflow instance.
* - `trigger_inputs` contains the key-value pairs corresponding to the inputs required by the workflow, as described in the `trigger_input_schema` from the workflow definition.
*/
export type TriggerWorkflow = {
/**
* A descriptive name for the specific instance of the workflow being triggered.
*
* @remarks
* This is typically used for identification and tracking purposes.
* Example: "User Registration Workflow Instance"
*/
instanceName: string;
/**
* Key-value pairs representing the input data required to trigger the workflow.
*
* @remarks
* The keys correspond to the `field_name` values defined in the `trigger_input_schema` of the workflow definition.
* The values should match the specified `field_data_type` (e.g., string, number, boolean).
* Example: {"name": "John Doe", "email": "johndoe@example.com"}
*/
triggerInputs: {
[k: string]: TriggerInputs;
};
};
/** @internal */
export declare const TriggerWorkflow$inboundSchema: z.ZodType<TriggerWorkflow, z.ZodTypeDef, unknown>;
/** @internal */
export type TriggerWorkflow$Outbound = {
instance_name: string;
trigger_inputs: {
[k: string]: TriggerInputs$Outbound;
};
};
/** @internal */
export declare const TriggerWorkflow$outboundSchema: z.ZodType<TriggerWorkflow$Outbound, z.ZodTypeDef, TriggerWorkflow>;
/**
* @internal
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
*/
export declare namespace TriggerWorkflow$ {
/** @deprecated use `TriggerWorkflow$inboundSchema` instead. */
const inboundSchema: z.ZodType<TriggerWorkflow, z.ZodTypeDef, unknown>;
/** @deprecated use `TriggerWorkflow$outboundSchema` instead. */
const outboundSchema: z.ZodType<TriggerWorkflow$Outbound, z.ZodTypeDef, TriggerWorkflow>;
/** @deprecated use `TriggerWorkflow$Outbound` instead. */
type Outbound = TriggerWorkflow$Outbound;
}
export declare function triggerWorkflowToJSON(triggerWorkflow: TriggerWorkflow): string;
export declare function triggerWorkflowFromJSON(jsonString: string): SafeParseResult<TriggerWorkflow, SDKValidationError>;
//# sourceMappingURL=triggerworkflow.d.ts.map