/*
 * 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 {
  Contractor,
  Contractor$inboundSchema,
} from "../components/contractor.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 GetV1CompaniesCompanyUuidContractorsHeaderXGustoAPIVersion = {
  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 GetV1CompaniesCompanyUuidContractorsHeaderXGustoAPIVersion =
  ClosedEnum<typeof GetV1CompaniesCompanyUuidContractorsHeaderXGustoAPIVersion>;

export const GetV1CompaniesCompanyUuidContractorsQueryParamInclude = {
  CompanyName: "company_name",
  PortalInvitations: "portal_invitations",
} as const;
export type GetV1CompaniesCompanyUuidContractorsQueryParamInclude = ClosedEnum<
  typeof GetV1CompaniesCompanyUuidContractorsQueryParamInclude
>;

export type GetV1CompaniesCompanyUuidContractorsRequest = {
  /**
   * 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?:
    | GetV1CompaniesCompanyUuidContractorsHeaderXGustoAPIVersion
    | undefined;
  /**
   * The UUID of the company
   */
  companyUuid: string;
  /**
   * A string to search for in the object's names
   */
  searchTerm?: string | undefined;
  /**
   * Sort by one or more fields. Options: created_at, type, onboarding_status, name. Append `:asc` or `:desc` to specify direction (e.g., `created_at:asc`). Defaults to ascending.
   */
  sortBy?: string | undefined;
  /**
   * Filters contractors by those who have completed onboarding
   */
  onboarded?: boolean | undefined;
  /**
   * Filters contractors who are ready to work (onboarded AND active today)
   */
  onboardedActive?: boolean | undefined;
  /**
   * Filters contractors by those who have been or are scheduled to be dismissed
   */
  terminated?: boolean | undefined;
  /**
   * Filters contractors by those who have been dismissed and whose dismissal is in effect today (excludes active and scheduled to be dismissed)
   */
  terminatedToday?: boolean | undefined;
  /**
   * Include the requested attribute(s) in each contractor response. Multiple options are comma separated.
   */
  include?:
    | Array<GetV1CompaniesCompanyUuidContractorsQueryParamInclude>
    | 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;
};

export type GetV1CompaniesCompanyUuidContractorsResponse = {
  httpMeta: HTTPMetadata;
  /**
   * Successful
   */
  contractors?: Array<Contractor> | undefined;
};

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

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

/** @internal */
export type GetV1CompaniesCompanyUuidContractorsRequest$Outbound = {
  "X-Gusto-API-Version": string;
  company_uuid: string;
  search_term?: string | undefined;
  sort_by?: string | undefined;
  onboarded?: boolean | undefined;
  onboarded_active?: boolean | undefined;
  terminated?: boolean | undefined;
  terminated_today?: boolean | undefined;
  include?: Array<string> | undefined;
  page?: number | undefined;
  per?: number | undefined;
};

/** @internal */
export const GetV1CompaniesCompanyUuidContractorsRequest$outboundSchema:
  z.ZodType<
    GetV1CompaniesCompanyUuidContractorsRequest$Outbound,
    z.ZodTypeDef,
    GetV1CompaniesCompanyUuidContractorsRequest
  > = z.object({
    xGustoAPIVersion:
      GetV1CompaniesCompanyUuidContractorsHeaderXGustoAPIVersion$outboundSchema
        .default("2025-06-15"),
    companyUuid: z.string(),
    searchTerm: z.string().optional(),
    sortBy: z.string().optional(),
    onboarded: z.boolean().optional(),
    onboardedActive: z.boolean().optional(),
    terminated: z.boolean().optional(),
    terminatedToday: z.boolean().optional(),
    include: z.array(
      GetV1CompaniesCompanyUuidContractorsQueryParamInclude$outboundSchema,
    ).optional(),
    page: z.number().int().optional(),
    per: z.number().int().optional(),
  }).transform((v) => {
    return remap$(v, {
      xGustoAPIVersion: "X-Gusto-API-Version",
      companyUuid: "company_uuid",
      searchTerm: "search_term",
      sortBy: "sort_by",
      onboardedActive: "onboarded_active",
      terminatedToday: "terminated_today",
    });
  });

export function getV1CompaniesCompanyUuidContractorsRequestToJSON(
  getV1CompaniesCompanyUuidContractorsRequest:
    GetV1CompaniesCompanyUuidContractorsRequest,
): string {
  return JSON.stringify(
    GetV1CompaniesCompanyUuidContractorsRequest$outboundSchema.parse(
      getV1CompaniesCompanyUuidContractorsRequest,
    ),
  );
}

/** @internal */
export const GetV1CompaniesCompanyUuidContractorsResponse$inboundSchema:
  z.ZodType<
    GetV1CompaniesCompanyUuidContractorsResponse,
    z.ZodTypeDef,
    unknown
  > = z.object({
    HttpMeta: HTTPMetadata$inboundSchema,
    Contractors: z.array(Contractor$inboundSchema).optional(),
  }).transform((v) => {
    return remap$(v, {
      "HttpMeta": "httpMeta",
      "Contractors": "contractors",
    });
  });

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