@vepler/sdk 1.10.0 → 2.0.0

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

@@ -0,0 +1,1106 @@
+/*
+ * 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 GetChildAreasRequest = {
+  /**
+   * Optional type of child areas to retrieve
+   */
+  childType?: string | undefined;
+  /**
+   * Include GeoJSON boundary geometry for child areas (default: false)
+   */
+  includeGeometry?: string | undefined;
+  /**
+   * Code of the parent area
+   */
+  parentCode: string;
+};
+
+/**
+ * Error response format for failed requests
+ */
+export type GetChildAreasAreasResponseResponseBody = {
+  /**
+   * 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 GetChildAreasAreasResponseBody = {
+  /**
+   * 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 GetChildAreasHierarchy = {
+  /**
+   * 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 GetChildAreasRelationships = {
+  /**
+   * 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 GetChildAreasType = {
+  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 GetChildAreasType = ClosedEnum<typeof GetChildAreasType>;
+
+/**
+ * A geographic entity representing an administrative or statistical area
+ */
+export type Children = {
+  /**
+   * 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<GetChildAreasHierarchy> | 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<GetChildAreasRelationships> | 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: GetChildAreasType;
+};
+
+export type GetChildAreasAreasHierarchy = {
+  /**
+   * 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 GetChildAreasAreasRelationships = {
+  /**
+   * 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 GetChildAreasAreasType = {
+  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 GetChildAreasAreasType = ClosedEnum<typeof GetChildAreasAreasType>;
+
+/**
+ * A geographic entity representing an administrative or statistical area
+ */
+export type Parent = {
+  /**
+   * 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<GetChildAreasAreasHierarchy> | 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<GetChildAreasAreasRelationships> | 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: GetChildAreasAreasType;
+};
+
+/**
+ * Response containing parent area and its children
+ */
+export type GetChildAreasResponseBody = {
+  /**
+   * Array of child areas contained within the parent
+   */
+  children: Array<Children>;
+  /**
+   * Optional message providing additional context about the response
+   */
+  message?: string | undefined;
+  /**
+   * A geographic entity representing an administrative or statistical area
+   */
+  parent: Parent;
+  /**
+   * Indicates whether the request was successful
+   */
+  success: boolean;
+  /**
+   * Total number of child areas
+   */
+  total: number;
+};
+
+export type GetChildAreasResponse =
+  | GetChildAreasResponseBody
+  | GetChildAreasAreasResponseBody
+  | GetChildAreasAreasResponseResponseBody;
+
+/** @internal */
+export const GetChildAreasRequest$inboundSchema: z.ZodType<
+  GetChildAreasRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  childType: z.string().optional(),
+  includeGeometry: z.string().optional(),
+  parentCode: z.string(),
+});
+
+/** @internal */
+export type GetChildAreasRequest$Outbound = {
+  childType?: string | undefined;
+  includeGeometry?: string | undefined;
+  parentCode: string;
+};
+
+/** @internal */
+export const GetChildAreasRequest$outboundSchema: z.ZodType<
+  GetChildAreasRequest$Outbound,
+  z.ZodTypeDef,
+  GetChildAreasRequest
+> = z.object({
+  childType: z.string().optional(),
+  includeGeometry: z.string().optional(),
+  parentCode: 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 GetChildAreasRequest$ {
+  /** @deprecated use `GetChildAreasRequest$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasRequest$inboundSchema;
+  /** @deprecated use `GetChildAreasRequest$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasRequest$outboundSchema;
+  /** @deprecated use `GetChildAreasRequest$Outbound` instead. */
+  export type Outbound = GetChildAreasRequest$Outbound;
+}
+
+export function getChildAreasRequestToJSON(
+  getChildAreasRequest: GetChildAreasRequest,
+): string {
+  return JSON.stringify(
+    GetChildAreasRequest$outboundSchema.parse(getChildAreasRequest),
+  );
+}
+
+export function getChildAreasRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChildAreasRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChildAreasRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChildAreasRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasAreasResponseResponseBody$inboundSchema: z.ZodType<
+  GetChildAreasAreasResponseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  details: z.string().optional(),
+  error: z.string(),
+  success: z.boolean(),
+});
+
+/** @internal */
+export type GetChildAreasAreasResponseResponseBody$Outbound = {
+  code?: string | undefined;
+  details?: string | undefined;
+  error: string;
+  success: boolean;
+};
+
+/** @internal */
+export const GetChildAreasAreasResponseResponseBody$outboundSchema: z.ZodType<
+  GetChildAreasAreasResponseResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetChildAreasAreasResponseResponseBody
+> = 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 GetChildAreasAreasResponseResponseBody$ {
+  /** @deprecated use `GetChildAreasAreasResponseResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    GetChildAreasAreasResponseResponseBody$inboundSchema;
+  /** @deprecated use `GetChildAreasAreasResponseResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetChildAreasAreasResponseResponseBody$outboundSchema;
+  /** @deprecated use `GetChildAreasAreasResponseResponseBody$Outbound` instead. */
+  export type Outbound = GetChildAreasAreasResponseResponseBody$Outbound;
+}
+
+export function getChildAreasAreasResponseResponseBodyToJSON(
+  getChildAreasAreasResponseResponseBody:
+    GetChildAreasAreasResponseResponseBody,
+): string {
+  return JSON.stringify(
+    GetChildAreasAreasResponseResponseBody$outboundSchema.parse(
+      getChildAreasAreasResponseResponseBody,
+    ),
+  );
+}
+
+export function getChildAreasAreasResponseResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChildAreasAreasResponseResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetChildAreasAreasResponseResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChildAreasAreasResponseResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasAreasResponseBody$inboundSchema: z.ZodType<
+  GetChildAreasAreasResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  details: z.string().optional(),
+  error: z.string(),
+  success: z.boolean(),
+});
+
+/** @internal */
+export type GetChildAreasAreasResponseBody$Outbound = {
+  code?: string | undefined;
+  details?: string | undefined;
+  error: string;
+  success: boolean;
+};
+
+/** @internal */
+export const GetChildAreasAreasResponseBody$outboundSchema: z.ZodType<
+  GetChildAreasAreasResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetChildAreasAreasResponseBody
+> = 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 GetChildAreasAreasResponseBody$ {
+  /** @deprecated use `GetChildAreasAreasResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasAreasResponseBody$inboundSchema;
+  /** @deprecated use `GetChildAreasAreasResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasAreasResponseBody$outboundSchema;
+  /** @deprecated use `GetChildAreasAreasResponseBody$Outbound` instead. */
+  export type Outbound = GetChildAreasAreasResponseBody$Outbound;
+}
+
+export function getChildAreasAreasResponseBodyToJSON(
+  getChildAreasAreasResponseBody: GetChildAreasAreasResponseBody,
+): string {
+  return JSON.stringify(
+    GetChildAreasAreasResponseBody$outboundSchema.parse(
+      getChildAreasAreasResponseBody,
+    ),
+  );
+}
+
+export function getChildAreasAreasResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChildAreasAreasResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChildAreasAreasResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChildAreasAreasResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasHierarchy$inboundSchema: z.ZodType<
+  GetChildAreasHierarchy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  level: z.number(),
+  name: z.string(),
+  type: z.string(),
+});
+
+/** @internal */
+export type GetChildAreasHierarchy$Outbound = {
+  code: string;
+  level: number;
+  name: string;
+  type: string;
+};
+
+/** @internal */
+export const GetChildAreasHierarchy$outboundSchema: z.ZodType<
+  GetChildAreasHierarchy$Outbound,
+  z.ZodTypeDef,
+  GetChildAreasHierarchy
+> = 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 GetChildAreasHierarchy$ {
+  /** @deprecated use `GetChildAreasHierarchy$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasHierarchy$inboundSchema;
+  /** @deprecated use `GetChildAreasHierarchy$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasHierarchy$outboundSchema;
+  /** @deprecated use `GetChildAreasHierarchy$Outbound` instead. */
+  export type Outbound = GetChildAreasHierarchy$Outbound;
+}
+
+export function getChildAreasHierarchyToJSON(
+  getChildAreasHierarchy: GetChildAreasHierarchy,
+): string {
+  return JSON.stringify(
+    GetChildAreasHierarchy$outboundSchema.parse(getChildAreasHierarchy),
+  );
+}
+
+export function getChildAreasHierarchyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChildAreasHierarchy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChildAreasHierarchy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChildAreasHierarchy' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasRelationships$inboundSchema: z.ZodType<
+  GetChildAreasRelationships,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  relationshipType: z.string(),
+  targetId: z.string(),
+  targetType: z.string(),
+});
+
+/** @internal */
+export type GetChildAreasRelationships$Outbound = {
+  relationshipType: string;
+  targetId: string;
+  targetType: string;
+};
+
+/** @internal */
+export const GetChildAreasRelationships$outboundSchema: z.ZodType<
+  GetChildAreasRelationships$Outbound,
+  z.ZodTypeDef,
+  GetChildAreasRelationships
+> = 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 GetChildAreasRelationships$ {
+  /** @deprecated use `GetChildAreasRelationships$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasRelationships$inboundSchema;
+  /** @deprecated use `GetChildAreasRelationships$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasRelationships$outboundSchema;
+  /** @deprecated use `GetChildAreasRelationships$Outbound` instead. */
+  export type Outbound = GetChildAreasRelationships$Outbound;
+}
+
+export function getChildAreasRelationshipsToJSON(
+  getChildAreasRelationships: GetChildAreasRelationships,
+): string {
+  return JSON.stringify(
+    GetChildAreasRelationships$outboundSchema.parse(getChildAreasRelationships),
+  );
+}
+
+export function getChildAreasRelationshipsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChildAreasRelationships, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChildAreasRelationships$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChildAreasRelationships' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasType$inboundSchema: z.ZodNativeEnum<
+  typeof GetChildAreasType
+> = z.nativeEnum(GetChildAreasType);
+
+/** @internal */
+export const GetChildAreasType$outboundSchema: z.ZodNativeEnum<
+  typeof GetChildAreasType
+> = GetChildAreasType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetChildAreasType$ {
+  /** @deprecated use `GetChildAreasType$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasType$inboundSchema;
+  /** @deprecated use `GetChildAreasType$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasType$outboundSchema;
+}
+
+/** @internal */
+export const Children$inboundSchema: z.ZodType<
+  Children,
+  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(() => GetChildAreasHierarchy$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(() => GetChildAreasRelationships$inboundSchema)),
+  ).optional(),
+  status: z.string().optional(),
+  type: GetChildAreasType$inboundSchema,
+});
+
+/** @internal */
+export type Children$Outbound = {
+  areaSqm?: number | null | undefined;
+  code: string;
+  geometry?: any | null | undefined;
+  hierarchy?: Array<GetChildAreasHierarchy$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<GetChildAreasRelationships$Outbound> | null | undefined;
+  status?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const Children$outboundSchema: z.ZodType<
+  Children$Outbound,
+  z.ZodTypeDef,
+  Children
+> = z.object({
+  areaSqm: z.nullable(z.number()).optional(),
+  code: z.string(),
+  geometry: z.nullable(z.any()).optional(),
+  hierarchy: z.nullable(
+    z.array(z.lazy(() => GetChildAreasHierarchy$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(() => GetChildAreasRelationships$outboundSchema)),
+  ).optional(),
+  status: z.string().optional(),
+  type: GetChildAreasType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Children$ {
+  /** @deprecated use `Children$inboundSchema` instead. */
+  export const inboundSchema = Children$inboundSchema;
+  /** @deprecated use `Children$outboundSchema` instead. */
+  export const outboundSchema = Children$outboundSchema;
+  /** @deprecated use `Children$Outbound` instead. */
+  export type Outbound = Children$Outbound;
+}
+
+export function childrenToJSON(children: Children): string {
+  return JSON.stringify(Children$outboundSchema.parse(children));
+}
+
+export function childrenFromJSON(
+  jsonString: string,
+): SafeParseResult<Children, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Children$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Children' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasAreasHierarchy$inboundSchema: z.ZodType<
+  GetChildAreasAreasHierarchy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  level: z.number(),
+  name: z.string(),
+  type: z.string(),
+});
+
+/** @internal */
+export type GetChildAreasAreasHierarchy$Outbound = {
+  code: string;
+  level: number;
+  name: string;
+  type: string;
+};
+
+/** @internal */
+export const GetChildAreasAreasHierarchy$outboundSchema: z.ZodType<
+  GetChildAreasAreasHierarchy$Outbound,
+  z.ZodTypeDef,
+  GetChildAreasAreasHierarchy
+> = 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 GetChildAreasAreasHierarchy$ {
+  /** @deprecated use `GetChildAreasAreasHierarchy$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasAreasHierarchy$inboundSchema;
+  /** @deprecated use `GetChildAreasAreasHierarchy$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasAreasHierarchy$outboundSchema;
+  /** @deprecated use `GetChildAreasAreasHierarchy$Outbound` instead. */
+  export type Outbound = GetChildAreasAreasHierarchy$Outbound;
+}
+
+export function getChildAreasAreasHierarchyToJSON(
+  getChildAreasAreasHierarchy: GetChildAreasAreasHierarchy,
+): string {
+  return JSON.stringify(
+    GetChildAreasAreasHierarchy$outboundSchema.parse(
+      getChildAreasAreasHierarchy,
+    ),
+  );
+}
+
+export function getChildAreasAreasHierarchyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChildAreasAreasHierarchy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChildAreasAreasHierarchy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChildAreasAreasHierarchy' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasAreasRelationships$inboundSchema: z.ZodType<
+  GetChildAreasAreasRelationships,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  relationshipType: z.string(),
+  targetId: z.string(),
+  targetType: z.string(),
+});
+
+/** @internal */
+export type GetChildAreasAreasRelationships$Outbound = {
+  relationshipType: string;
+  targetId: string;
+  targetType: string;
+};
+
+/** @internal */
+export const GetChildAreasAreasRelationships$outboundSchema: z.ZodType<
+  GetChildAreasAreasRelationships$Outbound,
+  z.ZodTypeDef,
+  GetChildAreasAreasRelationships
+> = 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 GetChildAreasAreasRelationships$ {
+  /** @deprecated use `GetChildAreasAreasRelationships$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasAreasRelationships$inboundSchema;
+  /** @deprecated use `GetChildAreasAreasRelationships$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasAreasRelationships$outboundSchema;
+  /** @deprecated use `GetChildAreasAreasRelationships$Outbound` instead. */
+  export type Outbound = GetChildAreasAreasRelationships$Outbound;
+}
+
+export function getChildAreasAreasRelationshipsToJSON(
+  getChildAreasAreasRelationships: GetChildAreasAreasRelationships,
+): string {
+  return JSON.stringify(
+    GetChildAreasAreasRelationships$outboundSchema.parse(
+      getChildAreasAreasRelationships,
+    ),
+  );
+}
+
+export function getChildAreasAreasRelationshipsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChildAreasAreasRelationships, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChildAreasAreasRelationships$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChildAreasAreasRelationships' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasAreasType$inboundSchema: z.ZodNativeEnum<
+  typeof GetChildAreasAreasType
+> = z.nativeEnum(GetChildAreasAreasType);
+
+/** @internal */
+export const GetChildAreasAreasType$outboundSchema: z.ZodNativeEnum<
+  typeof GetChildAreasAreasType
+> = GetChildAreasAreasType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetChildAreasAreasType$ {
+  /** @deprecated use `GetChildAreasAreasType$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasAreasType$inboundSchema;
+  /** @deprecated use `GetChildAreasAreasType$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasAreasType$outboundSchema;
+}
+
+/** @internal */
+export const Parent$inboundSchema: z.ZodType<Parent, 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(() => GetChildAreasAreasHierarchy$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(() => GetChildAreasAreasRelationships$inboundSchema)),
+    ).optional(),
+    status: z.string().optional(),
+    type: GetChildAreasAreasType$inboundSchema,
+  });
+
+/** @internal */
+export type Parent$Outbound = {
+  areaSqm?: number | null | undefined;
+  code: string;
+  geometry?: any | null | undefined;
+  hierarchy?: Array<GetChildAreasAreasHierarchy$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<GetChildAreasAreasRelationships$Outbound>
+    | null
+    | undefined;
+  status?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const Parent$outboundSchema: z.ZodType<
+  Parent$Outbound,
+  z.ZodTypeDef,
+  Parent
+> = z.object({
+  areaSqm: z.nullable(z.number()).optional(),
+  code: z.string(),
+  geometry: z.nullable(z.any()).optional(),
+  hierarchy: z.nullable(
+    z.array(z.lazy(() => GetChildAreasAreasHierarchy$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(() => GetChildAreasAreasRelationships$outboundSchema)),
+  ).optional(),
+  status: z.string().optional(),
+  type: GetChildAreasAreasType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Parent$ {
+  /** @deprecated use `Parent$inboundSchema` instead. */
+  export const inboundSchema = Parent$inboundSchema;
+  /** @deprecated use `Parent$outboundSchema` instead. */
+  export const outboundSchema = Parent$outboundSchema;
+  /** @deprecated use `Parent$Outbound` instead. */
+  export type Outbound = Parent$Outbound;
+}
+
+export function parentToJSON(parent: Parent): string {
+  return JSON.stringify(Parent$outboundSchema.parse(parent));
+}
+
+export function parentFromJSON(
+  jsonString: string,
+): SafeParseResult<Parent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Parent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Parent' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasResponseBody$inboundSchema: z.ZodType<
+  GetChildAreasResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  children: z.array(z.lazy(() => Children$inboundSchema)),
+  message: z.string().optional(),
+  parent: z.lazy(() => Parent$inboundSchema),
+  success: z.boolean(),
+  total: z.number(),
+});
+
+/** @internal */
+export type GetChildAreasResponseBody$Outbound = {
+  children: Array<Children$Outbound>;
+  message?: string | undefined;
+  parent: Parent$Outbound;
+  success: boolean;
+  total: number;
+};
+
+/** @internal */
+export const GetChildAreasResponseBody$outboundSchema: z.ZodType<
+  GetChildAreasResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetChildAreasResponseBody
+> = z.object({
+  children: z.array(z.lazy(() => Children$outboundSchema)),
+  message: z.string().optional(),
+  parent: z.lazy(() => Parent$outboundSchema),
+  success: z.boolean(),
+  total: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetChildAreasResponseBody$ {
+  /** @deprecated use `GetChildAreasResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasResponseBody$inboundSchema;
+  /** @deprecated use `GetChildAreasResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasResponseBody$outboundSchema;
+  /** @deprecated use `GetChildAreasResponseBody$Outbound` instead. */
+  export type Outbound = GetChildAreasResponseBody$Outbound;
+}
+
+export function getChildAreasResponseBodyToJSON(
+  getChildAreasResponseBody: GetChildAreasResponseBody,
+): string {
+  return JSON.stringify(
+    GetChildAreasResponseBody$outboundSchema.parse(getChildAreasResponseBody),
+  );
+}
+
+export function getChildAreasResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChildAreasResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChildAreasResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChildAreasResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetChildAreasResponse$inboundSchema: z.ZodType<
+  GetChildAreasResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => GetChildAreasResponseBody$inboundSchema),
+  z.lazy(() => GetChildAreasAreasResponseBody$inboundSchema),
+  z.lazy(() => GetChildAreasAreasResponseResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type GetChildAreasResponse$Outbound =
+  | GetChildAreasResponseBody$Outbound
+  | GetChildAreasAreasResponseBody$Outbound
+  | GetChildAreasAreasResponseResponseBody$Outbound;
+
+/** @internal */
+export const GetChildAreasResponse$outboundSchema: z.ZodType<
+  GetChildAreasResponse$Outbound,
+  z.ZodTypeDef,
+  GetChildAreasResponse
+> = z.union([
+  z.lazy(() => GetChildAreasResponseBody$outboundSchema),
+  z.lazy(() => GetChildAreasAreasResponseBody$outboundSchema),
+  z.lazy(() => GetChildAreasAreasResponseResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetChildAreasResponse$ {
+  /** @deprecated use `GetChildAreasResponse$inboundSchema` instead. */
+  export const inboundSchema = GetChildAreasResponse$inboundSchema;
+  /** @deprecated use `GetChildAreasResponse$outboundSchema` instead. */
+  export const outboundSchema = GetChildAreasResponse$outboundSchema;
+  /** @deprecated use `GetChildAreasResponse$Outbound` instead. */
+  export type Outbound = GetChildAreasResponse$Outbound;
+}
+
+export function getChildAreasResponseToJSON(
+  getChildAreasResponse: GetChildAreasResponse,
+): string {
+  return JSON.stringify(
+    GetChildAreasResponse$outboundSchema.parse(getChildAreasResponse),
+  );
+}
+
+export function getChildAreasResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetChildAreasResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetChildAreasResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetChildAreasResponse' from JSON`,
+  );
+}