/*
 * 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 {
  PayrollShow,
  PayrollShow$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 GetV1CompaniesCompanyIdPayrollsPayrollIdHeaderXGustoAPIVersion = {
  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 GetV1CompaniesCompanyIdPayrollsPayrollIdHeaderXGustoAPIVersion =
  ClosedEnum<
    typeof GetV1CompaniesCompanyIdPayrollsPayrollIdHeaderXGustoAPIVersion
  >;

export const GetV1CompaniesCompanyIdPayrollsPayrollIdQueryParamInclude = {
  Benefits: "benefits",
  Deductions: "deductions",
  Taxes: "taxes",
  PayrollStatusMeta: "payroll_status_meta",
  Totals: "totals",
  RiskBlockers: "risk_blockers",
  Reversals: "reversals",
  PayrollTaxes: "payroll_taxes",
} as const;
export type GetV1CompaniesCompanyIdPayrollsPayrollIdQueryParamInclude =
  ClosedEnum<typeof GetV1CompaniesCompanyIdPayrollsPayrollIdQueryParamInclude>;

export type GetV1CompaniesCompanyIdPayrollsPayrollIdRequest = {
  /**
   * The UUID of the company
   */
  companyId: string;
  /**
   * The UUID of the payroll
   */
  payrollId: string;
  /**
   * 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?:
    | GetV1CompaniesCompanyIdPayrollsPayrollIdHeaderXGustoAPIVersion
    | undefined;
  /**
   * Include the requested attribute in the response, for multiple attributes comma separate the values, i.e. `?include=benefits,deductions,taxes`
   */
  include?:
    | Array<GetV1CompaniesCompanyIdPayrollsPayrollIdQueryParamInclude>
    | undefined;
  /**
   * 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;
};

export type GetV1CompaniesCompanyIdPayrollsPayrollIdResponse = {
  httpMeta: HTTPMetadata;
  /**
   * successful with wait_for_reverse_wire credit blocker
   */
  payrollShow?: PayrollShow | undefined;
};

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

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

/** @internal */
export type GetV1CompaniesCompanyIdPayrollsPayrollIdRequest$Outbound = {
  company_id: string;
  payroll_id: string;
  "X-Gusto-API-Version": string;
  include?: Array<string> | undefined;
  page?: number | undefined;
  per?: number | undefined;
  sort_by?: string | undefined;
};

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

export function getV1CompaniesCompanyIdPayrollsPayrollIdRequestToJSON(
  getV1CompaniesCompanyIdPayrollsPayrollIdRequest:
    GetV1CompaniesCompanyIdPayrollsPayrollIdRequest,
): string {
  return JSON.stringify(
    GetV1CompaniesCompanyIdPayrollsPayrollIdRequest$outboundSchema.parse(
      getV1CompaniesCompanyIdPayrollsPayrollIdRequest,
    ),
  );
}

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

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