@vepler/sdk 1.10.1 → 2.3.0

package/src/sdk/models/operations/getareasbyfieldandids.ts

@@ -0,0 +1,796 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+export type GetAreasByFieldAndIdsRequest = {
+  /**
+   * Field type to search by (e.g., postcode, ward, county, or 'all' for any type)
+   */
+  field: string;
+  /**
+   * Field to group results by (e.g., 'type' to group by area type)
+   */
+  groupBy?: string | undefined;
+  /**
+   * Comma-separated list of IDs to retrieve
+   */
+  ids: string;
+  /**
+   * Include GeoJSON boundary geometry (default: false)
+   */
+  includeGeometry?: string | undefined;
+  /**
+   * Include hierarchical parent areas (e.g., postcode → ward → district, default: false)
+   */
+  includeHierarchy?: string | undefined;
+  /**
+   * Include relationships with other geographic entities (default: false)
+   */
+  includeRelationships?: string | undefined;
+  /**
+   * Maximum number of results to return (max: 1000)
+   */
+  limit?: string | undefined;
+  /**
+   * Number of results to skip (for pagination)
+   */
+  offset?: string | undefined;
+};
+
+/**
+ * Error response format for failed requests
+ */
+export type GetAreasByFieldAndIdsAreasResponseResponseBody = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * Detailed error information for debugging
+   */
+  details?: string | undefined;
+  /**
+   * High-level error category or message
+   */
+  error: string;
+  /**
+   * Always false for error responses
+   */
+  success: boolean;
+};
+
+/**
+ * Error response format for failed requests
+ */
+export type GetAreasByFieldAndIdsAreasResponseBody = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * Detailed error information for debugging
+   */
+  details?: string | undefined;
+  /**
+   * High-level error category or message
+   */
+  error: string;
+  /**
+   * Always false for error responses
+   */
+  success: boolean;
+};
+
+export type Hierarchy = {
+  /**
+   * Code of the area at this hierarchy level
+   */
+  code: string;
+  /**
+   * Hierarchy level (0 = finest granularity like output_area, higher numbers = broader areas like country)
+   */
+  level: number;
+  /**
+   * Name of the area at this hierarchy level
+   */
+  name: string;
+  /**
+   * Geographic type at this level
+   */
+  type: string;
+};
+
+export type Relationships = {
+  /**
+   * Nature of the relationship: 'contains' (parent-child), 'borders' (adjacent), 'overlaps' (partial overlap)
+   */
+  relationshipType: string;
+  /**
+   * Code of the related geographic entity
+   */
+  targetId: string;
+  /**
+   * Type of the related geographic entity
+   */
+  targetType: string;
+};
+
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export const GetAreasByFieldAndIdsType = {
+  Postcode: "postcode",
+  Lsoa21: "lsoa21",
+  UkOutputArea: "uk_output_area",
+  Ward: "ward",
+  Country: "country",
+  County: "county",
+  LocalAuthorityDistrict: "local_authority_district",
+  AreaNaturalBeauty: "area_natural_beauty",
+  NationalScenicArea: "national_scenic_area",
+} as const;
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export type GetAreasByFieldAndIdsType = ClosedEnum<
+  typeof GetAreasByFieldAndIdsType
+>;
+
+/**
+ * A geographic entity representing an administrative or statistical area
+ */
+export type GetAreasByFieldAndIdsResult = {
+  /**
+   * Total area in square metres
+   */
+  areaSqm?: number | null | undefined;
+  /**
+   * Unique identifier code for this area (e.g., 'SW1A1AA' for postcode, 'E09000001' for local authority)
+   */
+  code: string;
+  /**
+   * GeoJSON geometry object representing the area boundary (Polygon or MultiPolygon format)
+   */
+  geometry?: any | null | undefined;
+  /**
+   * Geographic hierarchy showing parent areas at different administrative levels
+   */
+  hierarchy?: Array<Hierarchy> | null | undefined;
+  /**
+   * Internal database ID for the geographic entity
+   */
+  id?: number | undefined;
+  /**
+   * Latitude of the area's centroid point in WGS84 (EPSG:4326)
+   */
+  lat?: number | null | undefined;
+  /**
+   * Longitude of the area's centroid point in WGS84 (EPSG:4326)
+   */
+  long?: number | null | undefined;
+  /**
+   * Additional metadata about the area in key-value format
+   */
+  metadata?: { [k: string]: any | null } | null | undefined;
+  /**
+   * Human-readable name of the geographic area
+   */
+  name: string;
+  /**
+   * List of relationships this area has with other geographic entities
+   */
+  relationships?: Array<Relationships> | null | undefined;
+  /**
+   * Current status of the area (e.g., 'active', 'archived')
+   */
+  status?: string | undefined;
+  /**
+   * Geographic hierarchy type - from smallest (output_area) to largest (country)
+   */
+  type: GetAreasByFieldAndIdsType;
+};
+
+/**
+ * Response containing an array of geographic areas
+ */
+export type GetAreasByFieldAndIdsResponseBody = {
+  /**
+   * Optional message providing additional context about the response
+   */
+  message?: string | undefined;
+  /**
+   * Array of geographic entities matching the request criteria
+   */
+  result: Array<GetAreasByFieldAndIdsResult>;
+  /**
+   * Indicates whether the request was successful
+   */
+  success: boolean;
+};
+
+export type GetAreasByFieldAndIdsResponse =
+  | GetAreasByFieldAndIdsResponseBody
+  | GetAreasByFieldAndIdsAreasResponseBody
+  | GetAreasByFieldAndIdsAreasResponseResponseBody;
+
+/** @internal */
+export const GetAreasByFieldAndIdsRequest$inboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  field: z.string(),
+  groupBy: z.string().optional(),
+  ids: z.string(),
+  includeGeometry: z.string().optional(),
+  includeHierarchy: z.string().optional(),
+  includeRelationships: z.string().optional(),
+  limit: z.string().default("100"),
+  offset: z.string().default("0"),
+});
+
+/** @internal */
+export type GetAreasByFieldAndIdsRequest$Outbound = {
+  field: string;
+  groupBy?: string | undefined;
+  ids: string;
+  includeGeometry?: string | undefined;
+  includeHierarchy?: string | undefined;
+  includeRelationships?: string | undefined;
+  limit: string;
+  offset: string;
+};
+
+/** @internal */
+export const GetAreasByFieldAndIdsRequest$outboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsRequest$Outbound,
+  z.ZodTypeDef,
+  GetAreasByFieldAndIdsRequest
+> = z.object({
+  field: z.string(),
+  groupBy: z.string().optional(),
+  ids: z.string(),
+  includeGeometry: z.string().optional(),
+  includeHierarchy: z.string().optional(),
+  includeRelationships: z.string().optional(),
+  limit: z.string().default("100"),
+  offset: z.string().default("0"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAreasByFieldAndIdsRequest$ {
+  /** @deprecated use `GetAreasByFieldAndIdsRequest$inboundSchema` instead. */
+  export const inboundSchema = GetAreasByFieldAndIdsRequest$inboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsRequest$outboundSchema` instead. */
+  export const outboundSchema = GetAreasByFieldAndIdsRequest$outboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsRequest$Outbound` instead. */
+  export type Outbound = GetAreasByFieldAndIdsRequest$Outbound;
+}
+
+export function getAreasByFieldAndIdsRequestToJSON(
+  getAreasByFieldAndIdsRequest: GetAreasByFieldAndIdsRequest,
+): string {
+  return JSON.stringify(
+    GetAreasByFieldAndIdsRequest$outboundSchema.parse(
+      getAreasByFieldAndIdsRequest,
+    ),
+  );
+}
+
+export function getAreasByFieldAndIdsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAreasByFieldAndIdsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAreasByFieldAndIdsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAreasByFieldAndIdsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAreasByFieldAndIdsAreasResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetAreasByFieldAndIdsAreasResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    code: z.string().optional(),
+    details: z.string().optional(),
+    error: z.string(),
+    success: z.boolean(),
+  });
+
+/** @internal */
+export type GetAreasByFieldAndIdsAreasResponseResponseBody$Outbound = {
+  code?: string | undefined;
+  details?: string | undefined;
+  error: string;
+  success: boolean;
+};
+
+/** @internal */
+export const GetAreasByFieldAndIdsAreasResponseResponseBody$outboundSchema:
+  z.ZodType<
+    GetAreasByFieldAndIdsAreasResponseResponseBody$Outbound,
+    z.ZodTypeDef,
+    GetAreasByFieldAndIdsAreasResponseResponseBody
+  > = z.object({
+    code: z.string().optional(),
+    details: z.string().optional(),
+    error: z.string(),
+    success: z.boolean(),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAreasByFieldAndIdsAreasResponseResponseBody$ {
+  /** @deprecated use `GetAreasByFieldAndIdsAreasResponseResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    GetAreasByFieldAndIdsAreasResponseResponseBody$inboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsAreasResponseResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetAreasByFieldAndIdsAreasResponseResponseBody$outboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsAreasResponseResponseBody$Outbound` instead. */
+  export type Outbound =
+    GetAreasByFieldAndIdsAreasResponseResponseBody$Outbound;
+}
+
+export function getAreasByFieldAndIdsAreasResponseResponseBodyToJSON(
+  getAreasByFieldAndIdsAreasResponseResponseBody:
+    GetAreasByFieldAndIdsAreasResponseResponseBody,
+): string {
+  return JSON.stringify(
+    GetAreasByFieldAndIdsAreasResponseResponseBody$outboundSchema.parse(
+      getAreasByFieldAndIdsAreasResponseResponseBody,
+    ),
+  );
+}
+
+export function getAreasByFieldAndIdsAreasResponseResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetAreasByFieldAndIdsAreasResponseResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetAreasByFieldAndIdsAreasResponseResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetAreasByFieldAndIdsAreasResponseResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAreasByFieldAndIdsAreasResponseBody$inboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsAreasResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  details: z.string().optional(),
+  error: z.string(),
+  success: z.boolean(),
+});
+
+/** @internal */
+export type GetAreasByFieldAndIdsAreasResponseBody$Outbound = {
+  code?: string | undefined;
+  details?: string | undefined;
+  error: string;
+  success: boolean;
+};
+
+/** @internal */
+export const GetAreasByFieldAndIdsAreasResponseBody$outboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsAreasResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetAreasByFieldAndIdsAreasResponseBody
+> = z.object({
+  code: z.string().optional(),
+  details: z.string().optional(),
+  error: z.string(),
+  success: z.boolean(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAreasByFieldAndIdsAreasResponseBody$ {
+  /** @deprecated use `GetAreasByFieldAndIdsAreasResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    GetAreasByFieldAndIdsAreasResponseBody$inboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsAreasResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetAreasByFieldAndIdsAreasResponseBody$outboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsAreasResponseBody$Outbound` instead. */
+  export type Outbound = GetAreasByFieldAndIdsAreasResponseBody$Outbound;
+}
+
+export function getAreasByFieldAndIdsAreasResponseBodyToJSON(
+  getAreasByFieldAndIdsAreasResponseBody:
+    GetAreasByFieldAndIdsAreasResponseBody,
+): string {
+  return JSON.stringify(
+    GetAreasByFieldAndIdsAreasResponseBody$outboundSchema.parse(
+      getAreasByFieldAndIdsAreasResponseBody,
+    ),
+  );
+}
+
+export function getAreasByFieldAndIdsAreasResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAreasByFieldAndIdsAreasResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetAreasByFieldAndIdsAreasResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAreasByFieldAndIdsAreasResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const Hierarchy$inboundSchema: z.ZodType<
+  Hierarchy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  level: z.number(),
+  name: z.string(),
+  type: z.string(),
+});
+
+/** @internal */
+export type Hierarchy$Outbound = {
+  code: string;
+  level: number;
+  name: string;
+  type: string;
+};
+
+/** @internal */
+export const Hierarchy$outboundSchema: z.ZodType<
+  Hierarchy$Outbound,
+  z.ZodTypeDef,
+  Hierarchy
+> = z.object({
+  code: z.string(),
+  level: z.number(),
+  name: z.string(),
+  type: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Hierarchy$ {
+  /** @deprecated use `Hierarchy$inboundSchema` instead. */
+  export const inboundSchema = Hierarchy$inboundSchema;
+  /** @deprecated use `Hierarchy$outboundSchema` instead. */
+  export const outboundSchema = Hierarchy$outboundSchema;
+  /** @deprecated use `Hierarchy$Outbound` instead. */
+  export type Outbound = Hierarchy$Outbound;
+}
+
+export function hierarchyToJSON(hierarchy: Hierarchy): string {
+  return JSON.stringify(Hierarchy$outboundSchema.parse(hierarchy));
+}
+
+export function hierarchyFromJSON(
+  jsonString: string,
+): SafeParseResult<Hierarchy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Hierarchy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Hierarchy' from JSON`,
+  );
+}
+
+/** @internal */
+export const Relationships$inboundSchema: z.ZodType<
+  Relationships,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  relationshipType: z.string(),
+  targetId: z.string(),
+  targetType: z.string(),
+});
+
+/** @internal */
+export type Relationships$Outbound = {
+  relationshipType: string;
+  targetId: string;
+  targetType: string;
+};
+
+/** @internal */
+export const Relationships$outboundSchema: z.ZodType<
+  Relationships$Outbound,
+  z.ZodTypeDef,
+  Relationships
+> = z.object({
+  relationshipType: z.string(),
+  targetId: z.string(),
+  targetType: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Relationships$ {
+  /** @deprecated use `Relationships$inboundSchema` instead. */
+  export const inboundSchema = Relationships$inboundSchema;
+  /** @deprecated use `Relationships$outboundSchema` instead. */
+  export const outboundSchema = Relationships$outboundSchema;
+  /** @deprecated use `Relationships$Outbound` instead. */
+  export type Outbound = Relationships$Outbound;
+}
+
+export function relationshipsToJSON(relationships: Relationships): string {
+  return JSON.stringify(Relationships$outboundSchema.parse(relationships));
+}
+
+export function relationshipsFromJSON(
+  jsonString: string,
+): SafeParseResult<Relationships, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Relationships$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Relationships' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAreasByFieldAndIdsType$inboundSchema: z.ZodNativeEnum<
+  typeof GetAreasByFieldAndIdsType
+> = z.nativeEnum(GetAreasByFieldAndIdsType);
+
+/** @internal */
+export const GetAreasByFieldAndIdsType$outboundSchema: z.ZodNativeEnum<
+  typeof GetAreasByFieldAndIdsType
+> = GetAreasByFieldAndIdsType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAreasByFieldAndIdsType$ {
+  /** @deprecated use `GetAreasByFieldAndIdsType$inboundSchema` instead. */
+  export const inboundSchema = GetAreasByFieldAndIdsType$inboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsType$outboundSchema` instead. */
+  export const outboundSchema = GetAreasByFieldAndIdsType$outboundSchema;
+}
+
+/** @internal */
+export const GetAreasByFieldAndIdsResult$inboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaSqm: z.nullable(z.number()).optional(),
+  code: z.string(),
+  geometry: z.nullable(z.any()).optional(),
+  hierarchy: z.nullable(z.array(z.lazy(() => Hierarchy$inboundSchema)))
+    .optional(),
+  id: z.number().optional(),
+  lat: z.nullable(z.number()).optional(),
+  long: z.nullable(z.number()).optional(),
+  metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+  name: z.string(),
+  relationships: z.nullable(z.array(z.lazy(() => Relationships$inboundSchema)))
+    .optional(),
+  status: z.string().optional(),
+  type: GetAreasByFieldAndIdsType$inboundSchema,
+});
+
+/** @internal */
+export type GetAreasByFieldAndIdsResult$Outbound = {
+  areaSqm?: number | null | undefined;
+  code: string;
+  geometry?: any | null | undefined;
+  hierarchy?: Array<Hierarchy$Outbound> | null | undefined;
+  id?: number | undefined;
+  lat?: number | null | undefined;
+  long?: number | null | undefined;
+  metadata?: { [k: string]: any | null } | null | undefined;
+  name: string;
+  relationships?: Array<Relationships$Outbound> | null | undefined;
+  status?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const GetAreasByFieldAndIdsResult$outboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsResult$Outbound,
+  z.ZodTypeDef,
+  GetAreasByFieldAndIdsResult
+> = z.object({
+  areaSqm: z.nullable(z.number()).optional(),
+  code: z.string(),
+  geometry: z.nullable(z.any()).optional(),
+  hierarchy: z.nullable(z.array(z.lazy(() => Hierarchy$outboundSchema)))
+    .optional(),
+  id: z.number().optional(),
+  lat: z.nullable(z.number()).optional(),
+  long: z.nullable(z.number()).optional(),
+  metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+  name: z.string(),
+  relationships: z.nullable(z.array(z.lazy(() => Relationships$outboundSchema)))
+    .optional(),
+  status: z.string().optional(),
+  type: GetAreasByFieldAndIdsType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAreasByFieldAndIdsResult$ {
+  /** @deprecated use `GetAreasByFieldAndIdsResult$inboundSchema` instead. */
+  export const inboundSchema = GetAreasByFieldAndIdsResult$inboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsResult$outboundSchema` instead. */
+  export const outboundSchema = GetAreasByFieldAndIdsResult$outboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsResult$Outbound` instead. */
+  export type Outbound = GetAreasByFieldAndIdsResult$Outbound;
+}
+
+export function getAreasByFieldAndIdsResultToJSON(
+  getAreasByFieldAndIdsResult: GetAreasByFieldAndIdsResult,
+): string {
+  return JSON.stringify(
+    GetAreasByFieldAndIdsResult$outboundSchema.parse(
+      getAreasByFieldAndIdsResult,
+    ),
+  );
+}
+
+export function getAreasByFieldAndIdsResultFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAreasByFieldAndIdsResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAreasByFieldAndIdsResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAreasByFieldAndIdsResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAreasByFieldAndIdsResponseBody$inboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string().optional(),
+  result: z.array(z.lazy(() => GetAreasByFieldAndIdsResult$inboundSchema)),
+  success: z.boolean(),
+});
+
+/** @internal */
+export type GetAreasByFieldAndIdsResponseBody$Outbound = {
+  message?: string | undefined;
+  result: Array<GetAreasByFieldAndIdsResult$Outbound>;
+  success: boolean;
+};
+
+/** @internal */
+export const GetAreasByFieldAndIdsResponseBody$outboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetAreasByFieldAndIdsResponseBody
+> = z.object({
+  message: z.string().optional(),
+  result: z.array(z.lazy(() => GetAreasByFieldAndIdsResult$outboundSchema)),
+  success: z.boolean(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAreasByFieldAndIdsResponseBody$ {
+  /** @deprecated use `GetAreasByFieldAndIdsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetAreasByFieldAndIdsResponseBody$inboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetAreasByFieldAndIdsResponseBody$outboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsResponseBody$Outbound` instead. */
+  export type Outbound = GetAreasByFieldAndIdsResponseBody$Outbound;
+}
+
+export function getAreasByFieldAndIdsResponseBodyToJSON(
+  getAreasByFieldAndIdsResponseBody: GetAreasByFieldAndIdsResponseBody,
+): string {
+  return JSON.stringify(
+    GetAreasByFieldAndIdsResponseBody$outboundSchema.parse(
+      getAreasByFieldAndIdsResponseBody,
+    ),
+  );
+}
+
+export function getAreasByFieldAndIdsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAreasByFieldAndIdsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAreasByFieldAndIdsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAreasByFieldAndIdsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAreasByFieldAndIdsResponse$inboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => GetAreasByFieldAndIdsResponseBody$inboundSchema),
+  z.lazy(() => GetAreasByFieldAndIdsAreasResponseBody$inboundSchema),
+  z.lazy(() => GetAreasByFieldAndIdsAreasResponseResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type GetAreasByFieldAndIdsResponse$Outbound =
+  | GetAreasByFieldAndIdsResponseBody$Outbound
+  | GetAreasByFieldAndIdsAreasResponseBody$Outbound
+  | GetAreasByFieldAndIdsAreasResponseResponseBody$Outbound;
+
+/** @internal */
+export const GetAreasByFieldAndIdsResponse$outboundSchema: z.ZodType<
+  GetAreasByFieldAndIdsResponse$Outbound,
+  z.ZodTypeDef,
+  GetAreasByFieldAndIdsResponse
+> = z.union([
+  z.lazy(() => GetAreasByFieldAndIdsResponseBody$outboundSchema),
+  z.lazy(() => GetAreasByFieldAndIdsAreasResponseBody$outboundSchema),
+  z.lazy(() => GetAreasByFieldAndIdsAreasResponseResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetAreasByFieldAndIdsResponse$ {
+  /** @deprecated use `GetAreasByFieldAndIdsResponse$inboundSchema` instead. */
+  export const inboundSchema = GetAreasByFieldAndIdsResponse$inboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsResponse$outboundSchema` instead. */
+  export const outboundSchema = GetAreasByFieldAndIdsResponse$outboundSchema;
+  /** @deprecated use `GetAreasByFieldAndIdsResponse$Outbound` instead. */
+  export type Outbound = GetAreasByFieldAndIdsResponse$Outbound;
+}
+
+export function getAreasByFieldAndIdsResponseToJSON(
+  getAreasByFieldAndIdsResponse: GetAreasByFieldAndIdsResponse,
+): string {
+  return JSON.stringify(
+    GetAreasByFieldAndIdsResponse$outboundSchema.parse(
+      getAreasByFieldAndIdsResponse,
+    ),
+  );
+}
+
+export function getAreasByFieldAndIdsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAreasByFieldAndIdsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAreasByFieldAndIdsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAreasByFieldAndIdsResponse' from JSON`,
+  );
+}