@docusign/iam-sdk/dist/commonjs/models/operations/getworkflowslist.d.ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.

import * as z from "zod";
import { ClosedEnum } from "../../types/enums.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.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;
    /**
     * 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$inboundSchema: z.ZodNativeEnum<typeof Status>;
/** @internal */
export declare const Status$outboundSchema: z.ZodNativeEnum<typeof Status>;
/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export declare namespace Status$ {
    /** @deprecated use `Status$inboundSchema` instead. */
    const inboundSchema: z.ZodNativeEnum<{
        readonly Active: "active";
        readonly Inactive: "inactive";
        readonly Publishing: "publishing";
        readonly Unpublishing: "unpublishing";
        readonly Archived: "archived";
        readonly Archiving: "archiving";
    }>;
    /** @deprecated use `Status$outboundSchema` instead. */
    const outboundSchema: z.ZodNativeEnum<{
        readonly Active: "active";
        readonly Inactive: "inactive";
        readonly Publishing: "publishing";
        readonly Unpublishing: "unpublishing";
        readonly Archived: "archived";
        readonly Archiving: "archiving";
    }>;
}
/** @internal */
export declare const GetWorkflowsListRequest$inboundSchema: z.ZodType<GetWorkflowsListRequest, z.ZodTypeDef, unknown>;
/** @internal */
export type GetWorkflowsListRequest$Outbound = {
    accountId: string;
    status?: string | undefined;
};
/** @internal */
export declare const GetWorkflowsListRequest$outboundSchema: z.ZodType<GetWorkflowsListRequest$Outbound, z.ZodTypeDef, GetWorkflowsListRequest>;
/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export declare namespace GetWorkflowsListRequest$ {
    /** @deprecated use `GetWorkflowsListRequest$inboundSchema` instead. */
    const inboundSchema: z.ZodType<GetWorkflowsListRequest, z.ZodTypeDef, unknown>;
    /** @deprecated use `GetWorkflowsListRequest$outboundSchema` instead. */
    const outboundSchema: z.ZodType<GetWorkflowsListRequest$Outbound, z.ZodTypeDef, GetWorkflowsListRequest>;
    /** @deprecated use `GetWorkflowsListRequest$Outbound` instead. */
    type Outbound = GetWorkflowsListRequest$Outbound;
}
export declare function getWorkflowsListRequestToJSON(getWorkflowsListRequest: GetWorkflowsListRequest): string;
export declare function getWorkflowsListRequestFromJSON(jsonString: string): SafeParseResult<GetWorkflowsListRequest, SDKValidationError>;
//# sourceMappingURL=getworkflowslist.d.ts.map