@vepler/sdk 2.155.0 → 2.164.0

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

@@ -3,6 +3,21 @@
  */
 
 import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Tile mode. 'hits' (default) returns individual property features in the 'hits' layer, capped at 10,000 per tile. 'density' returns no hits — instead a fine geotile grid in the 'aggs' layer with per-cell counts and average sale price, never truncated, intended for low-zoom rendering.
+ */
+export const GetPropertyTilesQueryParamMode = {
+  Hits: "hits",
+  Density: "density",
+} as const;
+/**
+ * Tile mode. 'hits' (default) returns individual property features in the 'hits' layer, capped at 10,000 per tile. 'density' returns no hits — instead a fine geotile grid in the 'aggs' layer with per-cell counts and average sale price, never truncated, intended for low-zoom rendering.
+ */
+export type GetPropertyTilesQueryParamMode = ClosedEnum<
+  typeof GetPropertyTilesQueryParamMode
+>;
 
 export type GetPropertyTilesRequest = {
   /**
@@ -13,6 +28,10 @@ export type GetPropertyTilesRequest = {
    * Comma-separated list of property attributes to include
    */
   attributes?: string | undefined;
+  /**
+   * Tile mode. 'hits' (default) returns individual property features in the 'hits' layer, capped at 10,000 per tile. 'density' returns no hits — instead a fine geotile grid in the 'aggs' layer with per-cell counts and average sale price, never truncated, intended for low-zoom rendering.
+   */
+  mode?: GetPropertyTilesQueryParamMode | undefined;
   /**
    * JSON-encoded property filter query using PropertyQueryOperator[] format
    */
@@ -31,10 +50,16 @@ export type GetPropertyTilesRequest = {
   z: string;
 };
 
+/** @internal */
+export const GetPropertyTilesQueryParamMode$outboundSchema: z.ZodNativeEnum<
+  typeof GetPropertyTilesQueryParamMode
+> = z.nativeEnum(GetPropertyTilesQueryParamMode);
+
 /** @internal */
 export type GetPropertyTilesRequest$Outbound = {
   area?: string | undefined;
   attributes?: string | undefined;
+  mode?: string | undefined;
   query?: string | undefined;
   x: string;
   y: string;
@@ -49,6 +74,7 @@ export const GetPropertyTilesRequest$outboundSchema: z.ZodType<
 > = z.object({
   area: z.string().optional(),
   attributes: z.string().optional(),
+  mode: GetPropertyTilesQueryParamMode$outboundSchema.optional(),
   query: z.string().optional(),
   x: z.string(),
   y: z.string(),

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

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetSchoolAdmissionAreaRequest = {
+  /**
+   * Academic year id for the distance radius (defaults to the most recent year with a distance).
+   */
+  academicYear?: string | undefined;
+  /**
+   * ISO date — return polygons effective on this date (default: today).
+   */
+  asOfDate?: string | undefined;
+  /**
+   * Internal school identifier.
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetSchoolAdmissionAreaRequest$Outbound = {
+  academicYear?: string | undefined;
+  asOfDate?: string | undefined;
+  id: string;
+};
+
+/** @internal */
+export const GetSchoolAdmissionAreaRequest$outboundSchema: z.ZodType<
+  GetSchoolAdmissionAreaRequest$Outbound,
+  z.ZodTypeDef,
+  GetSchoolAdmissionAreaRequest
+> = z.object({
+  academicYear: z.string().optional(),
+  asOfDate: z.string().optional(),
+  id: z.string(),
+});
+
+export function getSchoolAdmissionAreaRequestToJSON(
+  getSchoolAdmissionAreaRequest: GetSchoolAdmissionAreaRequest,
+): string {
+  return JSON.stringify(
+    GetSchoolAdmissionAreaRequest$outboundSchema.parse(
+      getSchoolAdmissionAreaRequest,
+    ),
+  );
+}

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

@@ -39,6 +39,7 @@ export * from "./getcompanypscs.js";
 export * from "./getconnectionqueuebysubstation.js";
 export * from "./getconnectionqueueentry.js";
 export * from "./getconnectivityscores.js";
+export * from "./getconservationdesignation.js";
 export * from "./getcouncilbyproviderid.js";
 export * from "./getcrimeareastats.js";
 export * from "./getcrimeincidents.js";
@@ -49,6 +50,8 @@ export * from "./getepchealth.js";
 export * from "./getframework.js";
 export * from "./getgeographicmetricaggregation.js";
 export * from "./getgeographymetrics.js";
+export * from "./getheritagedesignation.js";
+export * from "./getlandconstraintdesignation.js";
 export * from "./getlistingbyid.js";
 export * from "./getlistingbysource.js";
 export * from "./getlistingsbylocation.js";
@@ -71,6 +74,7 @@ export * from "./getpropertiesinsite.js";
 export * from "./getpropertytiles.js";
 export * from "./getprosperity.js";
 export * from "./getpsc.js";
+export * from "./getschooladmissionarea.js";
 export * from "./getschoolbyid.js";
 export * from "./getschoolbysource.js";
 export * from "./getschoolmetrics.js";

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

@@ -0,0 +1,39 @@
+/*
+ * 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";
+
+export type AdmissionAreaCriterion = {
+  applicationsCount: number | null;
+  category: string;
+  criterionNumber: number;
+  lastDistanceM: number | null;
+  offersCount: number;
+};
+
+/** @internal */
+export const AdmissionAreaCriterion$inboundSchema: z.ZodType<
+  AdmissionAreaCriterion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applicationsCount: z.nullable(z.number().int()),
+  category: z.string(),
+  criterionNumber: z.number().int(),
+  lastDistanceM: z.nullable(z.number().int()),
+  offersCount: z.number().int(),
+});
+
+export function admissionAreaCriterionFromJSON(
+  jsonString: string,
+): SafeParseResult<AdmissionAreaCriterion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdmissionAreaCriterion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdmissionAreaCriterion' from JSON`,
+  );
+}

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

@@ -0,0 +1,349 @@
+/*
+ * 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";
+import {
+  AdmissionAreaCriterion,
+  AdmissionAreaCriterion$inboundSchema,
+} from "./admissionareacriterion.js";
+
+export const AdmissionAreaResponseSchemasFeaturesType = {
+  Point: "Point",
+} as const;
+export type AdmissionAreaResponseSchemasFeaturesType = ClosedEnum<
+  typeof AdmissionAreaResponseSchemasFeaturesType
+>;
+
+/**
+ * School centre point [lng, lat] — the radius is drawn around this.
+ */
+export type Geometry = {
+  coordinates: Array<number>;
+  type: AdmissionAreaResponseSchemasFeaturesType;
+};
+
+export const AdmissionAreaResponseBoundaryType = {
+  DistanceRadius: "distance_radius",
+} as const;
+export type AdmissionAreaResponseBoundaryType = ClosedEnum<
+  typeof AdmissionAreaResponseBoundaryType
+>;
+
+export const AdmissionAreaResponseSchemasConfidence = {
+  Indicative: "indicative",
+} as const;
+export type AdmissionAreaResponseSchemasConfidence = ClosedEnum<
+  typeof AdmissionAreaResponseSchemasConfidence
+>;
+
+export type AdmissionAreaResponseProperties = {
+  academicYear: string;
+  boundaryType: AdmissionAreaResponseBoundaryType;
+  confidence: AdmissionAreaResponseSchemasConfidence;
+  criteria: Array<AdmissionAreaCriterion>;
+  phaseScope: string | null;
+  publishedAdmissionNumber: number | null;
+  /**
+   * Last-admitted distance in metres — draw a circle of this radius around the centre.
+   */
+  radiusM: number;
+  sourceUrl: string;
+  totalOffersMade: number | null;
+  wasOversubscribed: boolean;
+};
+
+export const AdmissionAreaResponseType = {
+  Feature: "Feature",
+} as const;
+export type AdmissionAreaResponseType = ClosedEnum<
+  typeof AdmissionAreaResponseType
+>;
+
+export type Two = {
+  /**
+   * School centre point [lng, lat] — the radius is drawn around this.
+   */
+  geometry: Geometry | null;
+  properties: AdmissionAreaResponseProperties;
+  type: AdmissionAreaResponseType;
+};
+
+export const BoundaryType = {
+  Polygon: "polygon",
+} as const;
+export type BoundaryType = ClosedEnum<typeof BoundaryType>;
+
+export const AdmissionAreaResponseConfidence = {
+  Hard: "hard",
+} as const;
+export type AdmissionAreaResponseConfidence = ClosedEnum<
+  typeof AdmissionAreaResponseConfidence
+>;
+
+export type AdmissionAreaResponseSchemasProperties = {
+  boundaryType: BoundaryType;
+  catchmentType: string;
+  confidence: AdmissionAreaResponseConfidence;
+  effectiveFrom: string;
+  effectiveTo: string | null;
+  phaseScope: string | null;
+  polygonId: number;
+  sourceUrl: string;
+};
+
+export const AdmissionAreaResponseSchemasType = {
+  Feature: "Feature",
+} as const;
+export type AdmissionAreaResponseSchemasType = ClosedEnum<
+  typeof AdmissionAreaResponseSchemasType
+>;
+
+export type One = {
+  /**
+   * GeoJSON Polygon or MultiPolygon.
+   */
+  geometry: { [k: string]: any };
+  properties: AdmissionAreaResponseSchemasProperties;
+  type: AdmissionAreaResponseSchemasType;
+};
+
+export type Features = One | Two;
+
+export type School = {
+  /**
+   * School centre [lng, lat].
+   */
+  centre: Array<number | null> | null;
+  id: number;
+  name: string;
+};
+
+export const Type = {
+  FeatureCollection: "FeatureCollection",
+} as const;
+export type Type = ClosedEnum<typeof Type>;
+
+export type AdmissionAreaResponse = {
+  /**
+   * Mixed boundary features. `polygon` features are hard designated catchments; the `distance_radius` feature is an indicative circle (centre + radiusM) from last year's furthest admitted pupil.
+   */
+  features: Array<One | Two>;
+  school: School;
+  type: Type;
+};
+
+/** @internal */
+export const AdmissionAreaResponseSchemasFeaturesType$inboundSchema:
+  z.ZodNativeEnum<typeof AdmissionAreaResponseSchemasFeaturesType> = z
+    .nativeEnum(AdmissionAreaResponseSchemasFeaturesType);
+
+/** @internal */
+export const Geometry$inboundSchema: z.ZodType<
+  Geometry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.array(z.number()),
+  type: AdmissionAreaResponseSchemasFeaturesType$inboundSchema,
+});
+
+export function geometryFromJSON(
+  jsonString: string,
+): SafeParseResult<Geometry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Geometry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Geometry' from JSON`,
+  );
+}
+
+/** @internal */
+export const AdmissionAreaResponseBoundaryType$inboundSchema: z.ZodNativeEnum<
+  typeof AdmissionAreaResponseBoundaryType
+> = z.nativeEnum(AdmissionAreaResponseBoundaryType);
+
+/** @internal */
+export const AdmissionAreaResponseSchemasConfidence$inboundSchema:
+  z.ZodNativeEnum<typeof AdmissionAreaResponseSchemasConfidence> = z.nativeEnum(
+    AdmissionAreaResponseSchemasConfidence,
+  );
+
+/** @internal */
+export const AdmissionAreaResponseProperties$inboundSchema: z.ZodType<
+  AdmissionAreaResponseProperties,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  academicYear: z.string(),
+  boundaryType: AdmissionAreaResponseBoundaryType$inboundSchema,
+  confidence: AdmissionAreaResponseSchemasConfidence$inboundSchema,
+  criteria: z.array(AdmissionAreaCriterion$inboundSchema),
+  phaseScope: z.nullable(z.string()),
+  publishedAdmissionNumber: z.nullable(z.number().int()),
+  radiusM: z.number().int(),
+  sourceUrl: z.string(),
+  totalOffersMade: z.nullable(z.number().int()),
+  wasOversubscribed: z.boolean(),
+});
+
+export function admissionAreaResponsePropertiesFromJSON(
+  jsonString: string,
+): SafeParseResult<AdmissionAreaResponseProperties, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdmissionAreaResponseProperties$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdmissionAreaResponseProperties' from JSON`,
+  );
+}
+
+/** @internal */
+export const AdmissionAreaResponseType$inboundSchema: z.ZodNativeEnum<
+  typeof AdmissionAreaResponseType
+> = z.nativeEnum(AdmissionAreaResponseType);
+
+/** @internal */
+export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
+  .object({
+    geometry: z.nullable(z.lazy(() => Geometry$inboundSchema)),
+    properties: z.lazy(() => AdmissionAreaResponseProperties$inboundSchema),
+    type: AdmissionAreaResponseType$inboundSchema,
+  });
+
+export function twoFromJSON(
+  jsonString: string,
+): SafeParseResult<Two, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Two$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Two' from JSON`,
+  );
+}
+
+/** @internal */
+export const BoundaryType$inboundSchema: z.ZodNativeEnum<typeof BoundaryType> =
+  z.nativeEnum(BoundaryType);
+
+/** @internal */
+export const AdmissionAreaResponseConfidence$inboundSchema: z.ZodNativeEnum<
+  typeof AdmissionAreaResponseConfidence
+> = z.nativeEnum(AdmissionAreaResponseConfidence);
+
+/** @internal */
+export const AdmissionAreaResponseSchemasProperties$inboundSchema: z.ZodType<
+  AdmissionAreaResponseSchemasProperties,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  boundaryType: BoundaryType$inboundSchema,
+  catchmentType: z.string(),
+  confidence: AdmissionAreaResponseConfidence$inboundSchema,
+  effectiveFrom: z.string(),
+  effectiveTo: z.nullable(z.string()),
+  phaseScope: z.nullable(z.string()),
+  polygonId: z.number().int(),
+  sourceUrl: z.string(),
+});
+
+export function admissionAreaResponseSchemasPropertiesFromJSON(
+  jsonString: string,
+): SafeParseResult<AdmissionAreaResponseSchemasProperties, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AdmissionAreaResponseSchemasProperties$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdmissionAreaResponseSchemasProperties' from JSON`,
+  );
+}
+
+/** @internal */
+export const AdmissionAreaResponseSchemasType$inboundSchema: z.ZodNativeEnum<
+  typeof AdmissionAreaResponseSchemasType
+> = z.nativeEnum(AdmissionAreaResponseSchemasType);
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({
+    geometry: z.record(z.any()),
+    properties: z.lazy(() =>
+      AdmissionAreaResponseSchemasProperties$inboundSchema
+    ),
+    type: AdmissionAreaResponseSchemasType$inboundSchema,
+  });
+
+export function oneFromJSON(
+  jsonString: string,
+): SafeParseResult<One, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => One$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'One' from JSON`,
+  );
+}
+
+/** @internal */
+export const Features$inboundSchema: z.ZodType<
+  Features,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
+
+export function featuresFromJSON(
+  jsonString: string,
+): SafeParseResult<Features, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Features$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Features' from JSON`,
+  );
+}
+
+/** @internal */
+export const School$inboundSchema: z.ZodType<School, z.ZodTypeDef, unknown> = z
+  .object({
+    centre: z.nullable(z.array(z.nullable(z.number()))),
+    id: z.number().int(),
+    name: z.string(),
+  });
+
+export function schoolFromJSON(
+  jsonString: string,
+): SafeParseResult<School, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => School$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'School' from JSON`,
+  );
+}
+
+/** @internal */
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+
+/** @internal */
+export const AdmissionAreaResponse$inboundSchema: z.ZodType<
+  AdmissionAreaResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  features: z.array(
+    z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]),
+  ),
+  school: z.lazy(() => School$inboundSchema),
+  type: Type$inboundSchema,
+});
+
+export function admissionAreaResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AdmissionAreaResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdmissionAreaResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdmissionAreaResponse' from JSON`,
+  );
+}