/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import * as z from "zod/v3";

export type ListCompaniesRequest = {
  /**
   * Page number. [Read more](https://docs.codat.io/using-the-api/paging).
   */
  page?: number | undefined;
  /**
   * Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).
   */
  pageSize?: number | undefined;
  /**
   * Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).
   */
  query?: string | undefined;
  /**
   * Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
   */
  orderBy?: string | undefined;
  /**
   * Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying).
   */
  tags?: string | undefined;
};

/** @internal */
export type ListCompaniesRequest$Outbound = {
  page: number;
  pageSize: number;
  query?: string | undefined;
  orderBy?: string | undefined;
  tags?: string | undefined;
};

/** @internal */
export const ListCompaniesRequest$outboundSchema: z.ZodType<
  ListCompaniesRequest$Outbound,
  z.ZodTypeDef,
  ListCompaniesRequest
> = z.object({
  page: z.number().int().default(1),
  pageSize: z.number().int().default(100),
  query: z.string().optional(),
  orderBy: z.string().optional(),
  tags: z.string().optional(),
});

export function listCompaniesRequestToJSON(
  listCompaniesRequest: ListCompaniesRequest,
): string {
  return JSON.stringify(
    ListCompaniesRequest$outboundSchema.parse(listCompaniesRequest),
  );
}