/*
 * 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 { ClosedEnum } from "../../types/enums.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import {
  GeneratedDocument,
  GeneratedDocument$inboundSchema,
} from "../components/generateddocument.js";
import {
  HTTPMetadata,
  HTTPMetadata$inboundSchema,
} from "../components/httpmetadata.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";

/**
 * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
 */
export const GetV1GeneratedDocumentsDocumentTypeRequestUuidHeaderXGustoAPIVersion =
  {
    TwoThousandAndTwentyFiveMinus06Minus15: "2025-06-15",
  } as const;
/**
 * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
 */
export type GetV1GeneratedDocumentsDocumentTypeRequestUuidHeaderXGustoAPIVersion =
  ClosedEnum<
    typeof GetV1GeneratedDocumentsDocumentTypeRequestUuidHeaderXGustoAPIVersion
  >;

/**
 * The type of document being generated
 */
export const DocumentType = {
  PrintablePayrollChecks: "printable_payroll_checks",
} as const;
/**
 * The type of document being generated
 */
export type DocumentType = ClosedEnum<typeof DocumentType>;

export type GetV1GeneratedDocumentsDocumentTypeRequestUuidRequest = {
  /**
   * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.
   */
  xGustoAPIVersion?:
    | GetV1GeneratedDocumentsDocumentTypeRequestUuidHeaderXGustoAPIVersion
    | undefined;
  /**
   * The type of document being generated
   */
  documentType: DocumentType;
  /**
   * The UUID of the request to generate a document. Generate document endpoints return request_uuids to be used with the GET generated document endpoint.
   */
  requestUuid: string;
};

export type GetV1GeneratedDocumentsDocumentTypeRequestUuidResponse = {
  httpMeta: HTTPMetadata;
  /**
   * Example response
   */
  generatedDocument?: GeneratedDocument | undefined;
};

/** @internal */
export const GetV1GeneratedDocumentsDocumentTypeRequestUuidHeaderXGustoAPIVersion$outboundSchema:
  z.ZodNativeEnum<
    typeof GetV1GeneratedDocumentsDocumentTypeRequestUuidHeaderXGustoAPIVersion
  > = z.nativeEnum(
    GetV1GeneratedDocumentsDocumentTypeRequestUuidHeaderXGustoAPIVersion,
  );

/** @internal */
export const DocumentType$outboundSchema: z.ZodNativeEnum<typeof DocumentType> =
  z.nativeEnum(DocumentType);

/** @internal */
export type GetV1GeneratedDocumentsDocumentTypeRequestUuidRequest$Outbound = {
  "X-Gusto-API-Version": string;
  document_type: string;
  request_uuid: string;
};

/** @internal */
export const GetV1GeneratedDocumentsDocumentTypeRequestUuidRequest$outboundSchema:
  z.ZodType<
    GetV1GeneratedDocumentsDocumentTypeRequestUuidRequest$Outbound,
    z.ZodTypeDef,
    GetV1GeneratedDocumentsDocumentTypeRequestUuidRequest
  > = z.object({
    xGustoAPIVersion:
      GetV1GeneratedDocumentsDocumentTypeRequestUuidHeaderXGustoAPIVersion$outboundSchema
        .default("2025-06-15"),
    documentType: DocumentType$outboundSchema,
    requestUuid: z.string(),
  }).transform((v) => {
    return remap$(v, {
      xGustoAPIVersion: "X-Gusto-API-Version",
      documentType: "document_type",
      requestUuid: "request_uuid",
    });
  });

export function getV1GeneratedDocumentsDocumentTypeRequestUuidRequestToJSON(
  getV1GeneratedDocumentsDocumentTypeRequestUuidRequest:
    GetV1GeneratedDocumentsDocumentTypeRequestUuidRequest,
): string {
  return JSON.stringify(
    GetV1GeneratedDocumentsDocumentTypeRequestUuidRequest$outboundSchema.parse(
      getV1GeneratedDocumentsDocumentTypeRequestUuidRequest,
    ),
  );
}

/** @internal */
export const GetV1GeneratedDocumentsDocumentTypeRequestUuidResponse$inboundSchema:
  z.ZodType<
    GetV1GeneratedDocumentsDocumentTypeRequestUuidResponse,
    z.ZodTypeDef,
    unknown
  > = z.object({
    HttpMeta: HTTPMetadata$inboundSchema,
    "Generated-Document": GeneratedDocument$inboundSchema.optional(),
  }).transform((v) => {
    return remap$(v, {
      "HttpMeta": "httpMeta",
      "Generated-Document": "generatedDocument",
    });
  });

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