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

/**
 * Response for adding a document to an upload request
 */
export type AddWorkspaceUploadRequestDocumentResponse = {
  /**
   * The ID of the upload request
   */
  uploadRequestId: string;
  /**
   * The ID of the document that was added
   */
  documentId: string;
  /**
   * The name of the document
   */
  documentName: string | null;
};

/** @internal */
export const AddWorkspaceUploadRequestDocumentResponse$inboundSchema: z.ZodType<
  AddWorkspaceUploadRequestDocumentResponse,
  z.ZodTypeDef,
  unknown
> = z.object({
  upload_request_id: types.string(),
  document_id: types.string(),
  document_name: types.nullable(types.string()),
}).transform((v) => {
  return remap$(v, {
    "upload_request_id": "uploadRequestId",
    "document_id": "documentId",
    "document_name": "documentName",
  });
});

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