/*
 * 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 {
  CompanyBenefitWithEmployeeBenefits,
  CompanyBenefitWithEmployeeBenefits$inboundSchema,
} from "../components/companybenefitwithemployeebenefits.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 GetV1CompanyBenefitsCompanyBenefitIdHeaderXGustoAPIVersion = {
  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 GetV1CompanyBenefitsCompanyBenefitIdHeaderXGustoAPIVersion =
  ClosedEnum<typeof GetV1CompanyBenefitsCompanyBenefitIdHeaderXGustoAPIVersion>;

/**
 * Available options:
 *
 * @remarks
 * - all_benefits: If with_employee_benefits=true, include all effective dated benefits for each employee instead of only the current benefits.
 */
export const GetV1CompanyBenefitsCompanyBenefitIdQueryParamInclude = {
  AllBenefits: "all_benefits",
} as const;
/**
 * Available options:
 *
 * @remarks
 * - all_benefits: If with_employee_benefits=true, include all effective dated benefits for each employee instead of only the current benefits.
 */
export type GetV1CompanyBenefitsCompanyBenefitIdQueryParamInclude = ClosedEnum<
  typeof GetV1CompanyBenefitsCompanyBenefitIdQueryParamInclude
>;

export type GetV1CompanyBenefitsCompanyBenefitIdRequest = {
  /**
   * 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?:
    | GetV1CompanyBenefitsCompanyBenefitIdHeaderXGustoAPIVersion
    | undefined;
  /**
   * The UUID of the company benefit
   */
  companyBenefitId: string;
  /**
   * Whether to return employee benefits associated with the benefit
   */
  withEmployeeBenefits?: boolean | undefined;
  /**
   * Available options:
   *
   * @remarks
   * - all_benefits: If with_employee_benefits=true, include all effective dated benefits for each employee instead of only the current benefits.
   */
  include?: GetV1CompanyBenefitsCompanyBenefitIdQueryParamInclude | undefined;
};

export type GetV1CompanyBenefitsCompanyBenefitIdResponse = {
  httpMeta: HTTPMetadata;
  /**
   * Success
   */
  companyBenefitWithEmployeeBenefits?:
    | CompanyBenefitWithEmployeeBenefits
    | undefined;
};

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

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

/** @internal */
export type GetV1CompanyBenefitsCompanyBenefitIdRequest$Outbound = {
  "X-Gusto-API-Version": string;
  company_benefit_id: string;
  with_employee_benefits?: boolean | undefined;
  include?: string | undefined;
};

/** @internal */
export const GetV1CompanyBenefitsCompanyBenefitIdRequest$outboundSchema:
  z.ZodType<
    GetV1CompanyBenefitsCompanyBenefitIdRequest$Outbound,
    z.ZodTypeDef,
    GetV1CompanyBenefitsCompanyBenefitIdRequest
  > = z.object({
    xGustoAPIVersion:
      GetV1CompanyBenefitsCompanyBenefitIdHeaderXGustoAPIVersion$outboundSchema
        .default("2025-06-15"),
    companyBenefitId: z.string(),
    withEmployeeBenefits: z.boolean().optional(),
    include:
      GetV1CompanyBenefitsCompanyBenefitIdQueryParamInclude$outboundSchema
        .optional(),
  }).transform((v) => {
    return remap$(v, {
      xGustoAPIVersion: "X-Gusto-API-Version",
      companyBenefitId: "company_benefit_id",
      withEmployeeBenefits: "with_employee_benefits",
    });
  });

export function getV1CompanyBenefitsCompanyBenefitIdRequestToJSON(
  getV1CompanyBenefitsCompanyBenefitIdRequest:
    GetV1CompanyBenefitsCompanyBenefitIdRequest,
): string {
  return JSON.stringify(
    GetV1CompanyBenefitsCompanyBenefitIdRequest$outboundSchema.parse(
      getV1CompanyBenefitsCompanyBenefitIdRequest,
    ),
  );
}

/** @internal */
export const GetV1CompanyBenefitsCompanyBenefitIdResponse$inboundSchema:
  z.ZodType<
    GetV1CompanyBenefitsCompanyBenefitIdResponse,
    z.ZodTypeDef,
    unknown
  > = z.object({
    HttpMeta: HTTPMetadata$inboundSchema,
    "Company-Benefit-With-Employee-Benefits":
      CompanyBenefitWithEmployeeBenefits$inboundSchema.optional(),
  }).transform((v) => {
    return remap$(v, {
      "HttpMeta": "httpMeta",
      "Company-Benefit-With-Employee-Benefits":
        "companyBenefitWithEmployeeBenefits",
    });
  });

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