@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
62 lines • 2.25 kB
TypeScript
import * as z from "zod/v3";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import { BulkJobActionTemplates } from "./bulkjobactiontemplates.js";
import { BulkJobConstraints } from "./bulkjobconstraints.js";
import { BulkJobEmbedded } from "./bulkjobembedded.js";
import { BulkJobLinks } from "./bulkjoblinks.js";
import { BulkJobMetadata } from "./bulkjobmetadata.js";
import { BulkJobStatus } from "./bulkjobstatus.js";
export type BulkJob = {
/**
* Id for job
*/
id: string;
/**
* User provided reference ID for this job
*/
externalJobId?: string | undefined;
/**
* User provided name for this job
*/
name: string;
/**
* Job lifecycle states:
*
* @remarks
* * OPEN - Job created and accepting documents
* * UPLOAD_COMPLETE - All documents have been received, and processing has not yet started
* * IN_PROGRESS - Documents are being processed (AI extraction)
* * COMPLETE - The full e2e process is complete
* * FAILED - System error prevented job execution
* * CANCELED - User initiated request to cancel a job
*/
status: BulkJobStatus;
statusEnum: Array<string>;
createdAt: Date;
modifiedAt: Date;
expiresAt: Date;
/**
* ISO 8601 duration for job validity
*/
ttlPeriod?: string | undefined;
/**
* Contains detailed information about the BulkJob including presigned upload links, document IDs, etc
*/
embedded?: BulkJobEmbedded | undefined;
actionTemplates?: BulkJobActionTemplates | undefined;
links?: BulkJobLinks | undefined;
/**
* Describes the limits of a bulk job, or an action associated with a bulk job
*/
constraints?: BulkJobConstraints | undefined;
/**
* Properties about THIS request/response, not the job resource itself
*/
metadata: BulkJobMetadata;
message?: string | undefined;
};
/** @internal */
export declare const BulkJob$inboundSchema: z.ZodType<BulkJob, z.ZodTypeDef, unknown>;
export declare function bulkJobFromJSON(jsonString: string): SafeParseResult<BulkJob, SDKValidationError>;
//# sourceMappingURL=bulkjob.d.ts.map