@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
134 lines • 6.11 kB
JavaScript
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import { encodeJSON, encodeSimple } from "../lib/encodings.js";
import * as M from "../lib/matchers.js";
import { compactMap } from "../lib/primitives.js";
import { safeParse } from "../lib/schemas.js";
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
import { pathToFunc } from "../lib/url.js";
import * as components from "../models/components/index.js";
import * as errors from "../models/errors/index.js";
import * as operations from "../models/operations/index.js";
import { APIPromise } from "../types/async.js";
/**
* Trigger a new instance of a Maestro workflow
*
* @remarks
* This operation triggers a new instance of a specified Maestro workflow. When invoked,
* the workflow is started based on the provided input data, and the workflow instance
* begins executing according to its defined logic and configuration.
*
* The request requires an `instance_name` and any input data necessary to start the workflow,
* as described by the workflow's `trigger_input_schema`. The `instance_name` is a user-defined
* label for tracking the workflow run, while the input data fields should match the schema defined
* in the workflow.
*
* The operation is event-driven and typically triggered by an external HTTP event or system call,
* allowing for the automatic execution of complex processes that span multiple systems or components.
*
* Upon successful execution, the response returns the unique identifier (`id`) for the newly
* created workflow instance, along with a URL (`workflow_instance_url`) that can be used to
* interact with or track the running instance.
*
* ### Use Cases:
* - Automating user registration workflows where input fields like `name` and `email` are provided.
* - Processing financial transactions where details such as `amount` and `currency` are required.
* - Sending notifications based on user interactions in other systems.
*
* ### Key Features:
* - **Automated Execution**: Once triggered, the workflow runs until a step requires manual intervention.
* - **Input-Driven**: Workflow execution is based on the provided input data, which is validated
*
* against the workflow's input schema.
* - **Real-Time Triggering**: Designed to be invoked as part of an event-driven architecture,
*
* allowing for workflows to respond to external events.
* - **Tracking and Interaction**: The response includes a URL that allows users to check the status
*
* of the workflow instance or take further actions while it runs.
*/
export function maestroWorkflowsTriggerWorkflow(client, request, options) {
return new APIPromise($do(client, request, options));
}
async function $do(client, request, options) {
const parsed = safeParse(request, (value) => operations.TriggerWorkflowRequest$outboundSchema.parse(value), "Input validation failed");
if (!parsed.ok) {
return [parsed, { status: "invalid" }];
}
const payload = parsed.value;
const body = encodeJSON("body", payload.TriggerWorkflow, { explode: true });
const pathParams = {
accountId: encodeSimple("accountId", payload.accountId, {
explode: false,
charEncoding: "percent",
}),
workflowId: encodeSimple("workflowId", payload.workflowId, {
explode: false,
charEncoding: "percent",
}),
};
const path = pathToFunc("/v1/accounts/{accountId}/workflows/{workflowId}/actions/trigger")(pathParams);
const headers = new Headers(compactMap({
"Content-Type": "application/json",
Accept: "application/json",
}));
const secConfig = await extractSecurity(client._options.accessToken);
const securityInput = secConfig == null ? {} : { accessToken: secConfig };
const requestSecurity = resolveGlobalSecurity(securityInput);
const context = {
options: client._options,
baseURL: options?.serverURL ?? client._baseURL ?? "",
operationID: "TriggerWorkflow",
oAuth2Scopes: [],
resolvedSecurity: requestSecurity,
securitySource: client._options.accessToken,
retryConfig: options?.retries
|| client._options.retryConfig
|| {
strategy: "backoff",
backoff: {
initialInterval: 500,
maxInterval: 5000,
exponent: 1.5,
maxElapsedTime: 30000,
},
retryConnectionErrors: true,
}
|| { strategy: "none" },
retryCodes: options?.retryCodes || ["5XX", "429"],
};
const requestRes = client._createRequest(context, {
security: requestSecurity,
method: "POST",
baseURL: options?.serverURL,
path: path,
headers: headers,
body: body,
userAgent: client._options.userAgent,
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
}, options);
if (!requestRes.ok) {
return [requestRes, { status: "invalid" }];
}
const req = requestRes.value;
const doResult = await client._do(req, {
context,
errorCodes: ["400", "401", "403", "404", "4XX", "500", "5XX"],
retryConfig: context.retryConfig,
retryCodes: context.retryCodes,
});
if (!doResult.ok) {
return [doResult, { status: "request-error", request: req }];
}
const response = doResult.value;
const responseFields = {
HttpMeta: { Response: response, Request: req },
};
const [result] = await M.match(M.json(200, components.TriggerWorkflowSuccess$inboundSchema), M.jsonErr([400, 403, 404], errors.ErrorT$inboundSchema), M.jsonErr(500, errors.ErrorT$inboundSchema), M.fail([401, "4XX"]), M.fail("5XX"))(response, req, { extraFields: responseFields });
if (!result.ok) {
return [result, { status: "complete", request: req, response }];
}
return [result, { status: "complete", request: req, response }];
}
//# sourceMappingURL=maestroWorkflowsTriggerWorkflow.js.map