@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
120 lines • 5.13 kB
JavaScript
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import { 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 operations from "../models/operations/index.js";
import { APIPromise } from "../types/async.js";
/**
* Retrieve All Workflow Instances
*
* @remarks
* This operation retrieves a list of all available Maestro workflow instances. It returns basic information
* about each workflow instance, including its unique identifier (`id`), name, status, timestamps, and
* additional metadata.
*
* The response provides key details that help users understand what workflow instances are in progress
* or completed, and the relevant data for each. Each workflow instance entry also includes metadata, such
* as who started it, when it was last modified, and how many steps have been completed.
*
* ### Use Cases:
* - Listing all available workflow instances for manual or automated review
* - Monitoring which workflow instances are currently running or have finished
* - Gathering basic metadata about workflow instances for auditing, logging, or reporting purposes
*
* ### Key Features:
* - **Comprehensive Instance Overview**: Provides a full list of workflow instances, giving visibility
*
* into all ongoing and completed workflows within the Maestro platform
* - **Metadata for Tracking**: Includes helpful metadata like creation time, last modification date,
*
* and user details to support audit trails
* - **Scalable and Future-Proof**: Designed to handle growing numbers of workflow instances as the
*
* platform scales
*/
export function maestroWorkflowInstanceManagementGetWorkflowInstancesList(client, request, options) {
return new APIPromise($do(client, request, options));
}
async function $do(client, request, options) {
const parsed = safeParse(request, (value) => operations.GetWorkflowInstancesListRequest$outboundSchema.parse(value), "Input validation failed");
if (!parsed.ok) {
return [parsed, { status: "invalid" }];
}
const payload = parsed.value;
const body = null;
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}/instances")(pathParams);
const headers = new Headers(compactMap({
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: "getWorkflowInstancesList",
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: "GET",
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: ["4XX", "5XX"],
retryConfig: context.retryConfig,
retryCodes: context.retryCodes,
});
if (!doResult.ok) {
return [doResult, { status: "request-error", request: req }];
}
const response = doResult.value;
const [result] = await M.match(M.json(200, components.WorkflowInstanceCollection$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req);
if (!result.ok) {
return [result, { status: "complete", request: req, response }];
}
return [result, { status: "complete", request: req, response }];
}
//# sourceMappingURL=maestroWorkflowInstanceManagementGetWorkflowInstancesList.js.map