/*
 * 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 { Form, Form$inboundSchema } from "../components/form.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 GetV1CompanyFormsHeaderXGustoAPIVersion = {
  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 GetV1CompanyFormsHeaderXGustoAPIVersion = ClosedEnum<
  typeof GetV1CompanyFormsHeaderXGustoAPIVersion
>;

export type GetV1CompanyFormsRequest = {
  /**
   * 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?: GetV1CompanyFormsHeaderXGustoAPIVersion | undefined;
  /**
   * The UUID of the company
   */
  companyId: string;
  /**
   * Sort by one or more fields. Options: created_at, name, year, quarter, draft, document_content_type. Append `:asc` or `:desc` to specify direction (e.g., `created_at:asc`). Defaults to ascending.
   */
  sortBy?: string | 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 GetV1CompanyFormsResponse = {
  httpMeta: HTTPMetadata;
  /**
   * Success
   */
  forms?: Array<Form> | undefined;
};

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

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

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

export function getV1CompanyFormsRequestToJSON(
  getV1CompanyFormsRequest: GetV1CompanyFormsRequest,
): string {
  return JSON.stringify(
    GetV1CompanyFormsRequest$outboundSchema.parse(getV1CompanyFormsRequest),
  );
}

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

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