@docusign/iam-sdk/dist/commonjs/models/components/bulkjobactiontemplate.d.ts

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

import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import { BulkJobConstraints } from "./bulkjobconstraints.js";
/**
 * Key value pairs of variable names and descriptions, explaining how they are to be used
 */
export type TemplateVariables = {};
/**
 * Key value pairs of header names and example values
 */
export type Headers = {};
/**
 * Key value pairs of error response codes and explanations of those codes
 */
export type ErrorStatusCodes = {};
export type BulkJobActionTemplate = {
    /**
     * HTTP method used for this template
     */
    method?: string | undefined;
    /**
     * Whether this action is required
     */
    required?: boolean | undefined;
    description?: string | undefined;
    /**
     * Key value pairs of variable names and descriptions, explaining how they are to be used
     */
    templateVariables?: TemplateVariables | undefined;
    /**
     * Key value pairs of header names and example values
     */
    headers?: Headers | undefined;
    /**
     * Describes the limits of a bulk job, or an action associated with a bulk job
     */
    constraints?: BulkJobConstraints | undefined;
    successStatusCode?: number | undefined;
    /**
     * Key value pairs of error response codes and explanations of those codes
     */
    errorStatusCodes?: ErrorStatusCodes | undefined;
};
/** @internal */
export declare const TemplateVariables$inboundSchema: z.ZodType<TemplateVariables, z.ZodTypeDef, unknown>;
export declare function templateVariablesFromJSON(jsonString: string): SafeParseResult<TemplateVariables, SDKValidationError>;
/** @internal */
export declare const Headers$inboundSchema: z.ZodType<Headers, z.ZodTypeDef, unknown>;
export declare function headersFromJSON(jsonString: string): SafeParseResult<Headers, SDKValidationError>;
/** @internal */
export declare const ErrorStatusCodes$inboundSchema: z.ZodType<ErrorStatusCodes, z.ZodTypeDef, unknown>;
export declare function errorStatusCodesFromJSON(jsonString: string): SafeParseResult<ErrorStatusCodes, SDKValidationError>;
/** @internal */
export declare const BulkJobActionTemplate$inboundSchema: z.ZodType<BulkJobActionTemplate, z.ZodTypeDef, unknown>;
export declare function bulkJobActionTemplateFromJSON(jsonString: string): SafeParseResult<BulkJobActionTemplate, SDKValidationError>;
//# sourceMappingURL=bulkjobactiontemplate.d.ts.map