@vepler/sdk 2.30.4 → 2.37.0

package/src/sdk/models/shared/officersummary.ts

@@ -0,0 +1,131 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The specific role held by the officer in this appointment. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (e.g. 'corporate-director') indicate a body corporate acting as officer. See the full enum for European entity roles, partnership roles, and special roles.
+ */
+export const OfficerSummaryOfficerRole = {
+  CicManager: "cic-manager",
+  CorporateDirector: "corporate-director",
+  CorporateLlpDesignatedMember: "corporate-llp-designated-member",
+  CorporateLlpMember: "corporate-llp-member",
+  CorporateManagerOfAnEeig: "corporate-manager-of-an-eeig",
+  CorporateManagingOfficer: "corporate-managing-officer",
+  CorporateMemberOfAManagementOrgan: "corporate-member-of-a-management-organ",
+  CorporateMemberOfASupervisoryOrgan: "corporate-member-of-a-supervisory-organ",
+  CorporateMemberOfAnAdministrativeOrgan:
+    "corporate-member-of-an-administrative-organ",
+  CorporateNomineeDirector: "corporate-nominee-director",
+  CorporateNomineeSecretary: "corporate-nominee-secretary",
+  CorporateSecretary: "corporate-secretary",
+  Director: "director",
+  GeneralPartnerInALimitedPartnership:
+    "general-partner-in-a-limited-partnership",
+  JudicialFactor: "judicial-factor",
+  LimitedPartnerInALimitedPartnership:
+    "limited-partner-in-a-limited-partnership",
+  LlpDesignatedMember: "llp-designated-member",
+  LlpMember: "llp-member",
+  ManagerOfAnEeig: "manager-of-an-eeig",
+  ManagingOfficer: "managing-officer",
+  MemberOfAManagementOrgan: "member-of-a-management-organ",
+  MemberOfASupervisoryOrgan: "member-of-a-supervisory-organ",
+  MemberOfAnAdministrativeOrgan: "member-of-an-administrative-organ",
+  NomineeDirector: "nominee-director",
+  NomineeSecretary: "nominee-secretary",
+  PersonAuthorisedToAccept: "person-authorised-to-accept",
+  PersonAuthorisedToRepresent: "person-authorised-to-represent",
+  PersonAuthorisedToRepresentAndAccept:
+    "person-authorised-to-represent-and-accept",
+  ReceiverAndManager: "receiver-and-manager",
+  Secretary: "secretary",
+} as const;
+/**
+ * The specific role held by the officer in this appointment. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (e.g. 'corporate-director') indicate a body corporate acting as officer. See the full enum for European entity roles, partnership roles, and special roles.
+ */
+export type OfficerSummaryOfficerRole = OpenEnum<
+  typeof OfficerSummaryOfficerRole
+>;
+
+/**
+ * Lightweight officer appointment summary for list responses. Contains key identification, role, and date fields.
+ */
+export type OfficerSummary = {
+  /**
+   * Date the officer was appointed. ISO 8601 format.
+   */
+  appointedOn?: Date | null | undefined;
+  /**
+   * The 8-character registration number of the company.
+   */
+  companyNumber: string;
+  /**
+   * Unique identifier for this officer appointment record (UUID v4).
+   */
+  id: string;
+  /**
+   * Officer's name as recorded in this appointment.
+   */
+  name: string;
+  /**
+   * The officer's self-declared occupation.
+   */
+  occupation?: string | null | undefined;
+  /**
+   * The specific role held by the officer in this appointment. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (e.g. 'corporate-director') indicate a body corporate acting as officer. See the full enum for European entity roles, partnership roles, and special roles.
+   */
+  officerRole: OfficerSummaryOfficerRole;
+  /**
+   * Link to the deduplicated person record (for natural persons). Use with the /persons endpoint.
+   */
+  personId?: string | null | undefined;
+  /**
+   * Date the officer resigned. Null if still active. ISO 8601 format.
+   */
+  resignedOn?: Date | null | undefined;
+};
+
+/** @internal */
+export const OfficerSummaryOfficerRole$inboundSchema: z.ZodType<
+  OfficerSummaryOfficerRole,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(OfficerSummaryOfficerRole);
+
+/** @internal */
+export const OfficerSummary$inboundSchema: z.ZodType<
+  OfficerSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  appointedOn: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  companyNumber: z.string(),
+  id: z.string(),
+  name: z.string(),
+  occupation: z.nullable(z.string()).optional(),
+  officerRole: OfficerSummaryOfficerRole$inboundSchema,
+  personId: z.nullable(z.string()).optional(),
+  resignedOn: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+});
+
+export function officerSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<OfficerSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OfficerSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OfficerSummary' from JSON`,
+  );
+}

package/src/sdk/models/shared/outcodelookupresponse.ts

@@ -0,0 +1,120 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * WGS84 coordinate pair
+ */
+export type OutcodeLookupResponseCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+export const OutcodeLookupResponseObject = {
+  Outcode: "outcode",
+} as const;
+export type OutcodeLookupResponseObject = ClosedEnum<
+  typeof OutcodeLookupResponseObject
+>;
+
+export type OutcodeLookupResponse = {
+  /**
+   * WGS84 coordinate pair
+   */
+  coordinates?: OutcodeLookupResponseCoordinates | undefined;
+  /**
+   * Primary country
+   */
+  country?: string | undefined;
+  /**
+   * Primary local authority
+   */
+  localAuthority?: string | undefined;
+  object: OutcodeLookupResponseObject;
+  /**
+   * Outward code
+   */
+  outcode: string;
+  /**
+   * Number of postcodes in this outcode
+   */
+  postcodeCount: number;
+  /**
+   * Postcodes in outcode (when include=postcodes)
+   */
+  postcodes?: Array<string> | undefined;
+  /**
+   * Primary region
+   */
+  region?: string | undefined;
+};
+
+/** @internal */
+export const OutcodeLookupResponseCoordinates$inboundSchema: z.ZodType<
+  OutcodeLookupResponseCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function outcodeLookupResponseCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<OutcodeLookupResponseCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OutcodeLookupResponseCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OutcodeLookupResponseCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const OutcodeLookupResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof OutcodeLookupResponseObject
+> = z.nativeEnum(OutcodeLookupResponseObject);
+
+/** @internal */
+export const OutcodeLookupResponse$inboundSchema: z.ZodType<
+  OutcodeLookupResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.lazy(() => OutcodeLookupResponseCoordinates$inboundSchema)
+    .optional(),
+  country: z.string().optional(),
+  local_authority: z.string().optional(),
+  object: OutcodeLookupResponseObject$inboundSchema,
+  outcode: z.string(),
+  postcode_count: z.number().int(),
+  postcodes: z.array(z.string()).optional(),
+  region: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "local_authority": "localAuthority",
+    "postcode_count": "postcodeCount",
+  });
+});
+
+export function outcodeLookupResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<OutcodeLookupResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OutcodeLookupResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OutcodeLookupResponse' from JSON`,
+  );
+}

package/src/sdk/models/shared/person.ts

@@ -0,0 +1,109 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { DateOfBirth, DateOfBirth$inboundSchema } from "./dateofbirth.js";
+
+/**
+ * The full deduplicated person record.
+ */
+export type Person = {
+  /**
+   * Number of currently active (non-resigned) officer appointments this person holds.
+   */
+  activeAppointments: number;
+  /**
+   * Entity resolution cluster identifier. All person records with the same clusterId have been determined (through probabilistic matching) to represent the same real-world individual. Use the /persons/cluster/{clusterId} endpoint to retrieve all records in the cluster. Requires COMPANIES_HOUSE_PREMIUM product access.
+   */
+  clusterId?: string | null | undefined;
+  /**
+   * Country of usual residence as declared on the most recent appointment or PSC notification.
+   */
+  countryOfResidence?: string | null | undefined;
+  /**
+   * Timestamp when this record was first created in our database. ISO 8601 format.
+   */
+  createdAt: Date;
+  /**
+   * Month and year of birth. Day of birth is not disclosed by Companies House for privacy. Null if not available (e.g. for very old records).
+   */
+  dateOfBirth?: DateOfBirth | null | undefined;
+  /**
+   * First (given) name, extracted from the full name.
+   */
+  forename?: string | null | undefined;
+  /**
+   * Unique identifier for this person record in our database (UUID v4).
+   */
+  id: string;
+  /**
+   * Whether this is the canonical (primary) record within its entity resolution cluster. When multiple records are merged, one is designated as canonical and the others become non-canonical. By default, queries return only canonical records to avoid duplicates.
+   */
+  isCanonical: boolean;
+  /**
+   * The person's full name, typically in uppercase as recorded by Companies House. This is the best available representation derived from their most recent appointment.
+   */
+  name: string;
+  /**
+   * Nationality as declared on the most recent appointment or PSC notification.
+   */
+  nationality?: string | null | undefined;
+  /**
+   * Middle name(s) or other forenames, if declared.
+   */
+  otherForenames?: string | null | undefined;
+  /**
+   * Surname (family name), extracted from the full name.
+   */
+  surname?: string | null | undefined;
+  /**
+   * Personal title (e.g. 'Mr', 'Mrs', 'Dr', 'Sir'). As declared on appointment forms.
+   */
+  title?: string | null | undefined;
+  /**
+   * Total number of officer appointments this person holds or has held across all companies (both active and resigned).
+   */
+  totalAppointments: number;
+  /**
+   * Timestamp when this record was last updated in our database. ISO 8601 format.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const Person$inboundSchema: z.ZodType<Person, z.ZodTypeDef, unknown> = z
+  .object({
+    activeAppointments: z.number().int(),
+    clusterId: z.nullable(z.string()).optional(),
+    countryOfResidence: z.nullable(z.string()).optional(),
+    createdAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    dateOfBirth: z.nullable(DateOfBirth$inboundSchema).optional(),
+    forename: z.nullable(z.string()).optional(),
+    id: z.string(),
+    isCanonical: z.boolean(),
+    name: z.string(),
+    nationality: z.nullable(z.string()).optional(),
+    otherForenames: z.nullable(z.string()).optional(),
+    surname: z.nullable(z.string()).optional(),
+    title: z.nullable(z.string()).optional(),
+    totalAppointments: z.number().int(),
+    updatedAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+  });
+
+export function personFromJSON(
+  jsonString: string,
+): SafeParseResult<Person, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Person$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Person' from JSON`,
+  );
+}

package/src/sdk/models/shared/personcluster.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { PersonSummary, PersonSummary$inboundSchema } from "./personsummary.js";
+
+/**
+ * The entity resolution cluster with all member records.
+ */
+export type PersonCluster = {
+  /**
+   * The canonical (primary) person record in this cluster. This is the authoritative representation of the individual. Null if no canonical record has been designated.
+   */
+  canonicalPerson?: PersonSummary | null | undefined;
+  /**
+   * Overall quality score for this cluster (0.0 to 1.0). Reflects the average pairwise match probability across all cluster members. Null if not yet computed.
+   */
+  clusterConfidence?: number | null | undefined;
+  /**
+   * Unique identifier for this entity resolution cluster (UUID v4).
+   */
+  clusterId: string;
+  /**
+   * Aggregated total of currently active officer appointments across all cluster members.
+   */
+  combinedActiveAppointments: number;
+  /**
+   * Aggregated total of officer appointments across all person records in the cluster (both active and resigned).
+   */
+  combinedAppointments: number;
+  /**
+   * All person records in this cluster, including the canonical record. Each member represents a separate record from Companies House that has been determined to belong to the same real-world individual.
+   */
+  members: Array<PersonSummary | null>;
+  /**
+   * Total number of person records in this cluster.
+   */
+  totalRecords: number;
+};
+
+/** @internal */
+export const PersonCluster$inboundSchema: z.ZodType<
+  PersonCluster,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  canonicalPerson: z.nullable(PersonSummary$inboundSchema).optional(),
+  clusterConfidence: z.nullable(z.number()).optional(),
+  clusterId: z.string(),
+  combinedActiveAppointments: z.number().int(),
+  combinedAppointments: z.number().int(),
+  members: z.array(z.nullable(PersonSummary$inboundSchema)),
+  totalRecords: z.number().int(),
+});
+
+export function personClusterFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonCluster, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonCluster$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonCluster' from JSON`,
+  );
+}

package/src/sdk/models/shared/personclusterresponse.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { PersonCluster, PersonCluster$inboundSchema } from "./personcluster.js";
+
+/**
+ * Response containing an entity resolution cluster -- a group of person records that belong to the same real-world individual. Requires COMPANIES_HOUSE_PREMIUM.
+ */
+export type PersonClusterResponse = {
+  /**
+   * The entity resolution cluster with all member records.
+   */
+  result: PersonCluster;
+  /**
+   * Indicates the request was successful.
+   */
+  success: boolean;
+};
+
+/** @internal */
+export const PersonClusterResponse$inboundSchema: z.ZodType<
+  PersonClusterResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  result: PersonCluster$inboundSchema,
+  success: z.boolean(),
+});
+
+export function personClusterResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonClusterResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonClusterResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonClusterResponse' from JSON`,
+  );
+}

package/src/sdk/models/shared/personlistresponse.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { PersonSummary, PersonSummary$inboundSchema } from "./personsummary.js";
+
+/**
+ * Paginated list of deduplicated persons matching search criteria.
+ */
+export type PersonListResponse = {
+  /**
+   * Whether additional results are available beyond this page.
+   */
+  hasMore: boolean;
+  /**
+   * The maximum number of results returned in this page.
+   */
+  limit: number;
+  /**
+   * The number of results skipped (for pagination).
+   */
+  offset: number;
+  /**
+   * Array of person summary records matching the search criteria.
+   */
+  results: Array<PersonSummary | null>;
+  /**
+   * Indicates the request was successful.
+   */
+  success: boolean;
+  /**
+   * Total number of persons matching the search criteria (across all pages).
+   */
+  total: number;
+};
+
+/** @internal */
+export const PersonListResponse$inboundSchema: z.ZodType<
+  PersonListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hasMore: z.boolean(),
+  limit: z.number().int(),
+  offset: z.number().int(),
+  results: z.array(z.nullable(PersonSummary$inboundSchema)),
+  success: z.boolean(),
+  total: z.number().int(),
+});
+
+export function personListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonListResponse' from JSON`,
+  );
+}

package/src/sdk/models/shared/personqueryrequest.ts

@@ -0,0 +1,156 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Field to sort results by. 'name' for alphabetical, 'totalAppointments' or 'activeAppointments' for most/least connected, 'updatedAt' for most recently changed.
+ */
+export const PersonQueryRequestSortBy = {
+  Name: "name",
+  TotalAppointments: "totalAppointments",
+  ActiveAppointments: "activeAppointments",
+  UpdatedAt: "updatedAt",
+} as const;
+/**
+ * Field to sort results by. 'name' for alphabetical, 'totalAppointments' or 'activeAppointments' for most/least connected, 'updatedAt' for most recently changed.
+ */
+export type PersonQueryRequestSortBy = ClosedEnum<
+  typeof PersonQueryRequestSortBy
+>;
+
+/**
+ * Sort direction: 'asc' for ascending, 'desc' for descending.
+ */
+export const PersonQueryRequestSortOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort direction: 'asc' for ascending, 'desc' for descending.
+ */
+export type PersonQueryRequestSortOrder = ClosedEnum<
+  typeof PersonQueryRequestSortOrder
+>;
+
+/**
+ * Person search request body. Supports filtering by name, surname, date of birth, nationality, country of residence, appointment counts, and entity resolution cluster. Returns paginated, deduplicated person records.
+ */
+export type PersonQueryRequest = {
+  /**
+   * Find all person records belonging to a specific entity resolution cluster. Returns all members of the cluster (both canonical and non-canonical). Requires COMPANIES_HOUSE_PREMIUM.
+   */
+  clusterId?: string | undefined;
+  /**
+   * Filter by country of usual residence (e.g. 'United Kingdom').
+   */
+  countryOfResidence?: string | undefined;
+  /**
+   * Filter by birth month (1 = January, 12 = December). Best used in combination with dobYear.
+   */
+  dobMonth?: number | undefined;
+  /**
+   * Filter by 4-digit birth year. Best used in combination with dobMonth for precise matching.
+   */
+  dobYear?: number | undefined;
+  /**
+   * When false (default), only canonical (primary) person records are returned, avoiding duplicate results for merged identities. Set to true to include non-canonical records that have been merged into a canonical record.
+   */
+  includeNonCanonical?: boolean | undefined;
+  /**
+   * Maximum number of results to return per page (1-50, default: 25).
+   */
+  limit?: number | undefined;
+  /**
+   * Only return persons with at least this many currently active officer appointments.
+   */
+  minActiveAppointments?: number | undefined;
+  /**
+   * Only return persons with at least this many total officer appointments (active and resigned combined). Useful for finding prolific directors.
+   */
+  minAppointments?: number | undefined;
+  /**
+   * Search by person name. Supports fuzzy matching -- partial names will return relevant results. Case-insensitive.
+   */
+  name?: string | undefined;
+  /**
+   * Filter by nationality (e.g. 'British', 'Irish'). As declared on appointment forms.
+   */
+  nationality?: string | undefined;
+  /**
+   * Number of results to skip for pagination.
+   */
+  offset?: number | undefined;
+  /**
+   * Field to sort results by. 'name' for alphabetical, 'totalAppointments' or 'activeAppointments' for most/least connected, 'updatedAt' for most recently changed.
+   */
+  sortBy?: PersonQueryRequestSortBy | undefined;
+  /**
+   * Sort direction: 'asc' for ascending, 'desc' for descending.
+   */
+  sortOrder?: PersonQueryRequestSortOrder | undefined;
+  /**
+   * Filter by exact surname (family name). Case-insensitive.
+   */
+  surname?: string | undefined;
+};
+
+/** @internal */
+export const PersonQueryRequestSortBy$outboundSchema: z.ZodNativeEnum<
+  typeof PersonQueryRequestSortBy
+> = z.nativeEnum(PersonQueryRequestSortBy);
+
+/** @internal */
+export const PersonQueryRequestSortOrder$outboundSchema: z.ZodNativeEnum<
+  typeof PersonQueryRequestSortOrder
+> = z.nativeEnum(PersonQueryRequestSortOrder);
+
+/** @internal */
+export type PersonQueryRequest$Outbound = {
+  clusterId?: string | undefined;
+  countryOfResidence?: string | undefined;
+  dobMonth?: number | undefined;
+  dobYear?: number | undefined;
+  includeNonCanonical: boolean;
+  limit: number;
+  minActiveAppointments?: number | undefined;
+  minAppointments?: number | undefined;
+  name?: string | undefined;
+  nationality?: string | undefined;
+  offset: number;
+  sortBy: string;
+  sortOrder: string;
+  surname?: string | undefined;
+};
+
+/** @internal */
+export const PersonQueryRequest$outboundSchema: z.ZodType<
+  PersonQueryRequest$Outbound,
+  z.ZodTypeDef,
+  PersonQueryRequest
+> = z.object({
+  clusterId: z.string().optional(),
+  countryOfResidence: z.string().optional(),
+  dobMonth: z.number().int().optional(),
+  dobYear: z.number().int().optional(),
+  includeNonCanonical: z.boolean().default(false),
+  limit: z.number().int().default(25),
+  minActiveAppointments: z.number().int().optional(),
+  minAppointments: z.number().int().optional(),
+  name: z.string().optional(),
+  nationality: z.string().optional(),
+  offset: z.number().int().default(0),
+  sortBy: PersonQueryRequestSortBy$outboundSchema.default("name"),
+  sortOrder: PersonQueryRequestSortOrder$outboundSchema.default("asc"),
+  surname: z.string().optional(),
+});
+
+export function personQueryRequestToJSON(
+  personQueryRequest: PersonQueryRequest,
+): string {
+  return JSON.stringify(
+    PersonQueryRequest$outboundSchema.parse(personQueryRequest),
+  );
+}