@docusign/iam-sdk/src/models/components/bulkjobembedded.ts

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

/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import * as z from "zod/v3";
import { remap as remap$ } from "../../lib/primitives.js";
import { safeParse } from "../../lib/schemas.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import * as types from "../../types/primitives.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
import {
  BulkJobEmbeddedItems,
  BulkJobEmbeddedItems$inboundSchema,
} from "./bulkjobembeddeditems.js";

/**
 * Contains detailed information about the BulkJob including presigned upload links, document IDs, etc
 */
export type BulkJobEmbedded = {
  /**
   * All possible document status values
   */
  documentStatusEnum?: Array<string> | undefined;
  /**
   * List of documents with presigned upload URLs
   */
  documents?: Array<BulkJobEmbeddedItems> | undefined;
};

/** @internal */
export const BulkJobEmbedded$inboundSchema: z.ZodType<
  BulkJobEmbedded,
  z.ZodTypeDef,
  unknown
> = z.object({
  document_status_enum: types.optional(z.array(types.string())),
  documents: types.optional(z.array(BulkJobEmbeddedItems$inboundSchema)),
}).transform((v) => {
  return remap$(v, {
    "document_status_enum": "documentStatusEnum",
  });
});

export function bulkJobEmbeddedFromJSON(
  jsonString: string,
): SafeParseResult<BulkJobEmbedded, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => BulkJobEmbedded$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'BulkJobEmbedded' from JSON`,
  );
}