@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
62 lines • 2.58 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../../types/enums.js";
/**
* Filter workflows by their status. If provided, only workflows with the specified status will be returned.
*
* @remarks
* - `active`: Returns only active workflows.
* - `inactive`: Returns only inactive workflows.
* - `publishing`: Returns workflows currently being published.
* - `unpublishing`: Returns workflows currently being unpublished.
* - `archived`: Returns workflows that have been archived.
* - `archiving`: Returns workflows currently being archived.
*/
export declare const Status: {
readonly Active: "active";
readonly Inactive: "inactive";
readonly Publishing: "publishing";
readonly Unpublishing: "unpublishing";
readonly Archived: "archived";
readonly Archiving: "archiving";
};
/**
* Filter workflows by their status. If provided, only workflows with the specified status will be returned.
*
* @remarks
* - `active`: Returns only active workflows.
* - `inactive`: Returns only inactive workflows.
* - `publishing`: Returns workflows currently being published.
* - `unpublishing`: Returns workflows currently being unpublished.
* - `archived`: Returns workflows that have been archived.
* - `archiving`: Returns workflows currently being archived.
*/
export type Status = ClosedEnum<typeof Status>;
export type GetWorkflowsListRequest = {
/**
* The unique identifier of the account.
*/
accountId?: string | undefined;
/**
* Filter workflows by their status. If provided, only workflows with the specified status will be returned.
*
* @remarks
* - `active`: Returns only active workflows.
* - `inactive`: Returns only inactive workflows.
* - `publishing`: Returns workflows currently being published.
* - `unpublishing`: Returns workflows currently being unpublished.
* - `archived`: Returns workflows that have been archived.
* - `archiving`: Returns workflows currently being archived.
*/
status?: Status | undefined;
};
/** @internal */
export declare const Status$outboundSchema: z.ZodNativeEnum<typeof Status>;
/** @internal */
export type GetWorkflowsListRequest$Outbound = {
accountId: string;
status?: string | undefined;
};
/** @internal */
export declare const GetWorkflowsListRequest$outboundSchema: z.ZodType<GetWorkflowsListRequest$Outbound, z.ZodTypeDef, GetWorkflowsListRequest>;
export declare function getWorkflowsListRequestToJSON(getWorkflowsListRequest: GetWorkflowsListRequest): string;
//# sourceMappingURL=getworkflowslist.d.ts.map