/*
 * 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 {
  HTTPMetadata,
  HTTPMetadata$inboundSchema,
} from "../components/httpmetadata.js";
import {
  PayrollPrepared,
  PayrollPrepared$inboundSchema,
} from "../components/payroll.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 PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareHeaderXGustoAPIVersion =
  {
    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 PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareHeaderXGustoAPIVersion =
  ClosedEnum<
    typeof PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareHeaderXGustoAPIVersion
  >;

export type PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody = {
  /**
   * An array of employee UUIDs. If passed, only those employees payroll items will be prepared.
   */
  employeeUuids?: Array<string> | null | undefined;
};

export type PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest = {
  /**
   * 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?:
    | PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareHeaderXGustoAPIVersion
    | undefined;
  /**
   * The UUID of the company
   */
  companyId: string;
  /**
   * The UUID of the payroll
   */
  payrollId: string;
  /**
   * The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
   */
  page?: number | undefined;
  /**
   * Number of objects per page. For majority of endpoints will default to 25
   */
  per?: number | undefined;
  /**
   * Sort employee compensations by one or more fields. Options: first_name, last_name. Append `:asc` or `:desc` to specify direction (e.g., `last_name:asc` or `last_name:asc,first_name:asc`). Defaults to ascending.
   */
  sortBy?: string | undefined;
  requestBody?:
    | PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody
    | undefined;
};

export type PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareResponse = {
  httpMeta: HTTPMetadata;
  /**
   * Successful
   */
  payrollPrepared?: PayrollPrepared | undefined;
};

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

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

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

export function putV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBodyToJSON(
  putV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody:
    PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody,
): string {
  return JSON.stringify(
    PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody$outboundSchema
      .parse(putV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody),
  );
}

/** @internal */
export type PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest$Outbound = {
  "X-Gusto-API-Version": string;
  company_id: string;
  payroll_id: string;
  page?: number | undefined;
  per?: number | undefined;
  sort_by?: string | undefined;
  RequestBody?:
    | PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody$Outbound
    | undefined;
};

/** @internal */
export const PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest$outboundSchema:
  z.ZodType<
    PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest$Outbound,
    z.ZodTypeDef,
    PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest
  > = z.object({
    xGustoAPIVersion:
      PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareHeaderXGustoAPIVersion$outboundSchema
        .default("2025-06-15"),
    companyId: z.string(),
    payrollId: z.string(),
    page: z.number().int().optional(),
    per: z.number().int().optional(),
    sortBy: z.string().optional(),
    requestBody: z.lazy(() =>
      PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestBody$outboundSchema
    ).optional(),
  }).transform((v) => {
    return remap$(v, {
      xGustoAPIVersion: "X-Gusto-API-Version",
      companyId: "company_id",
      payrollId: "payroll_id",
      sortBy: "sort_by",
      requestBody: "RequestBody",
    });
  });

export function putV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequestToJSON(
  putV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest:
    PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest,
): string {
  return JSON.stringify(
    PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest$outboundSchema.parse(
      putV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest,
    ),
  );
}

/** @internal */
export const PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareResponse$inboundSchema:
  z.ZodType<
    PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareResponse,
    z.ZodTypeDef,
    unknown
  > = z.object({
    HttpMeta: HTTPMetadata$inboundSchema,
    "Payroll-Prepared": PayrollPrepared$inboundSchema.optional(),
  }).transform((v) => {
    return remap$(v, {
      "HttpMeta": "httpMeta",
      "Payroll-Prepared": "payrollPrepared",
    });
  });

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