@docusign/iam-sdk/src/models/components/workspaceenvelopeforcreate.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";

export type WorkspaceEnvelopeForCreate = {
  /**
   * The name for the envelope
   */
  envelopeName: string | null;
  /**
   * The optional list of document IDs to be added to the envelope
   */
  documentIds?: Array<string> | null | undefined;
};

/** @internal */
export type WorkspaceEnvelopeForCreate$Outbound = {
  envelope_name: string | null;
  document_ids?: Array<string> | null | undefined;
};

/** @internal */
export const WorkspaceEnvelopeForCreate$outboundSchema: z.ZodType<
  WorkspaceEnvelopeForCreate$Outbound,
  z.ZodTypeDef,
  WorkspaceEnvelopeForCreate
> = z.object({
  envelopeName: z.nullable(z.string()),
  documentIds: z.nullable(z.array(z.string())).optional(),
}).transform((v) => {
  return remap$(v, {
    envelopeName: "envelope_name",
    documentIds: "document_ids",
  });
});

export function workspaceEnvelopeForCreateToJSON(
  workspaceEnvelopeForCreate: WorkspaceEnvelopeForCreate,
): string {
  return JSON.stringify(
    WorkspaceEnvelopeForCreate$outboundSchema.parse(workspaceEnvelopeForCreate),
  );
}