@vepler/sdk 2.155.0 → 2.164.0

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

@@ -48,7 +48,7 @@ import {
 /**
  * A structured key-value property feature extracted from the listing. Features capture specific property attributes such as tenure, EPC rating, parking arrangements, and amenities.
  */
-export type Features = {
+export type AdvancedListingFeatures = {
   /**
    * Normalised feature identifier key. Common values include: 'parking', 'garden', 'garage', 'central_heating', 'double_glazing', 'epc_rating', 'council_tax_band', 'tenure', 'chain_free', 'conservatory', 'fireplace'. The set of available feature IDs varies by data provider and is not strictly enumerated — treat as a free-form key.
    */
@@ -62,7 +62,7 @@ export type Features = {
 /**
  * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
  */
-export const AdvancedListingType = {
+export const AdvancedListingSchemasType = {
   Standard: "standard",
   Floorplan: "floorplan",
   Epc: "epc",
@@ -71,7 +71,9 @@ export const AdvancedListingType = {
 /**
  * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
  */
-export type AdvancedListingType = OpenEnum<typeof AdvancedListingType>;
+export type AdvancedListingSchemasType = OpenEnum<
+  typeof AdvancedListingSchemasType
+>;
 
 /**
  * A single image asset associated with a property listing. Images are sourced from property portal CDNs and are publicly accessible.
@@ -88,7 +90,7 @@ export type FloorPlanImages = {
   /**
    * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
    */
-  type?: AdvancedListingType | undefined;
+  type?: AdvancedListingSchemasType | undefined;
   /**
    * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
@@ -98,7 +100,7 @@ export type FloorPlanImages = {
 /**
  * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
  */
-export const AdvancedListingSchemasType = {
+export const AdvancedListingSchemasImagesType = {
   Standard: "standard",
   Floorplan: "floorplan",
   Epc: "epc",
@@ -107,8 +109,8 @@ export const AdvancedListingSchemasType = {
 /**
  * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
  */
-export type AdvancedListingSchemasType = OpenEnum<
-  typeof AdvancedListingSchemasType
+export type AdvancedListingSchemasImagesType = OpenEnum<
+  typeof AdvancedListingSchemasImagesType
 >;
 
 /**
@@ -126,7 +128,7 @@ export type Images = {
   /**
    * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
    */
-  type?: AdvancedListingSchemasType | undefined;
+  type?: AdvancedListingSchemasImagesType | undefined;
   /**
    * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
@@ -166,14 +168,14 @@ export type Status = OpenEnum<typeof Status>;
 /**
  * Market type for the listing. 'sale': property is listed for purchase — the price field represents the asking price in GBP pence. 'rent': property is listed for tenancy — the price field represents the monthly rental amount in GBP pence (per calendar month).
  */
-export const Type = {
+export const AdvancedListingType = {
   Sale: "sale",
   Rent: "rent",
 } as const;
 /**
  * Market type for the listing. 'sale': property is listed for purchase — the price field represents the asking price in GBP pence. 'rent': property is listed for tenancy — the price field represents the monthly rental amount in GBP pence (per calendar month).
  */
-export type Type = OpenEnum<typeof Type>;
+export type AdvancedListingType = OpenEnum<typeof AdvancedListingType>;
 
 /**
  * An aggregated property listing document, combining data from all available sources for the property. All monetary values are in GBP pounds.
@@ -197,7 +199,7 @@ export type AdvancedListing = {
   /**
    * Structured property features.
    */
-  features?: Array<Features> | undefined;
+  features?: Array<AdvancedListingFeatures> | undefined;
   /**
    * Floor plan images.
    */
@@ -281,12 +283,12 @@ export type AdvancedListing = {
   /**
    * Market type for the listing. 'sale': property is listed for purchase — the price field represents the asking price in GBP pence. 'rent': property is listed for tenancy — the price field represents the monthly rental amount in GBP pence (per calendar month).
    */
-  type: Type;
+  type: AdvancedListingType;
 };
 
 /** @internal */
-export const Features$inboundSchema: z.ZodType<
-  Features,
+export const AdvancedListingFeatures$inboundSchema: z.ZodType<
+  AdvancedListingFeatures,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -294,22 +296,22 @@ export const Features$inboundSchema: z.ZodType<
   value: z.string(),
 });
 
-export function featuresFromJSON(
+export function advancedListingFeaturesFromJSON(
   jsonString: string,
-): SafeParseResult<Features, SDKValidationError> {
+): SafeParseResult<AdvancedListingFeatures, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Features$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Features' from JSON`,
+    (x) => AdvancedListingFeatures$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdvancedListingFeatures' from JSON`,
   );
 }
 
 /** @internal */
-export const AdvancedListingType$inboundSchema: z.ZodType<
-  AdvancedListingType,
+export const AdvancedListingSchemasType$inboundSchema: z.ZodType<
+  AdvancedListingSchemasType,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(AdvancedListingType);
+> = openEnums.inboundSchema(AdvancedListingSchemasType);
 
 /** @internal */
 export const FloorPlanImages$inboundSchema: z.ZodType<
@@ -319,7 +321,7 @@ export const FloorPlanImages$inboundSchema: z.ZodType<
 > = z.object({
   caption: z.string().optional(),
   order: z.number().optional(),
-  type: AdvancedListingType$inboundSchema.optional(),
+  type: AdvancedListingSchemasType$inboundSchema.optional(),
   url: z.string(),
 });
 
@@ -334,18 +336,18 @@ export function floorPlanImagesFromJSON(
 }
 
 /** @internal */
-export const AdvancedListingSchemasType$inboundSchema: z.ZodType<
-  AdvancedListingSchemasType,
+export const AdvancedListingSchemasImagesType$inboundSchema: z.ZodType<
+  AdvancedListingSchemasImagesType,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(AdvancedListingSchemasType);
+> = openEnums.inboundSchema(AdvancedListingSchemasImagesType);
 
 /** @internal */
 export const Images$inboundSchema: z.ZodType<Images, z.ZodTypeDef, unknown> = z
   .object({
     caption: z.string().optional(),
     order: z.number().optional(),
-    type: AdvancedListingSchemasType$inboundSchema.optional(),
+    type: AdvancedListingSchemasImagesType$inboundSchema.optional(),
     url: z.string(),
   });
 
@@ -381,8 +383,11 @@ export const Status$inboundSchema: z.ZodType<Status, z.ZodTypeDef, unknown> =
   openEnums.inboundSchema(Status);
 
 /** @internal */
-export const Type$inboundSchema: z.ZodType<Type, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Type);
+export const AdvancedListingType$inboundSchema: z.ZodType<
+  AdvancedListingType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AdvancedListingType);
 
 /** @internal */
 export const AdvancedListing$inboundSchema: z.ZodType<
@@ -396,7 +401,8 @@ export const AdvancedListing$inboundSchema: z.ZodType<
   description: z.nullable(z.string()).optional(),
   descriptors: z.record(z.any()).optional(),
   energyRating: AdvancedListingEnergyRating$inboundSchema.optional(),
-  features: z.array(z.lazy(() => Features$inboundSchema)).optional(),
+  features: z.array(z.lazy(() => AdvancedListingFeatures$inboundSchema))
+    .optional(),
   floorPlanImages: z.array(z.lazy(() => FloorPlanImages$inboundSchema))
     .optional(),
   id: z.string(),
@@ -425,7 +431,7 @@ export const AdvancedListing$inboundSchema: z.ZodType<
   statusHistory: z.array(AdvancedListingStatusHistory$inboundSchema).optional(),
   tags: z.record(z.boolean()).optional(),
   tenure: AdvancedListingTenure$inboundSchema.optional(),
-  type: Type$inboundSchema,
+  type: AdvancedListingType$inboundSchema,
 });
 
 export function advancedListingFromJSON(

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

@@ -81,7 +81,7 @@ export type Nearest = {
 /**
  * Outside the zone
  */
-export type Two = {
+export type AirQualityRegulatoryZoneMembership2 = {
   /**
    * False — the point is not inside any zone of this kind
    */
@@ -95,7 +95,7 @@ export type Two = {
 /**
  * Inside the zone
  */
-export type One = {
+export type AirQualityRegulatoryZoneMembership1 = {
   /**
    * True — the point is inside this zone
    */
@@ -109,7 +109,9 @@ export type One = {
 /**
  * Discriminated inside/outside-with-nearest membership wrapper around any zone schema
  */
-export type AirQualityRegulatoryZoneMembership = One | Two;
+export type AirQualityRegulatoryZoneMembership =
+  | AirQualityRegulatoryZoneMembership1
+  | AirQualityRegulatoryZoneMembership2;
 
 /** @internal */
 export const Nearest$inboundSchema: z.ZodType<Nearest, z.ZodTypeDef, unknown> =
@@ -141,36 +143,44 @@ export function nearestFromJSON(
 }
 
 /** @internal */
-export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
-  .object({
-    inside: z.literal(false),
-    nearest: z.lazy(() => Nearest$inboundSchema).optional(),
-  });
+export const AirQualityRegulatoryZoneMembership2$inboundSchema: z.ZodType<
+  AirQualityRegulatoryZoneMembership2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(false),
+  nearest: z.lazy(() => Nearest$inboundSchema).optional(),
+});
 
-export function twoFromJSON(
+export function airQualityRegulatoryZoneMembership2FromJSON(
   jsonString: string,
-): SafeParseResult<Two, SDKValidationError> {
+): SafeParseResult<AirQualityRegulatoryZoneMembership2, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Two$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Two' from JSON`,
+    (x) =>
+      AirQualityRegulatoryZoneMembership2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityRegulatoryZoneMembership2' from JSON`,
   );
 }
 
 /** @internal */
-export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
-  .object({
-    inside: z.literal(true),
-    zone: RegulatoryZone$inboundSchema,
-  });
+export const AirQualityRegulatoryZoneMembership1$inboundSchema: z.ZodType<
+  AirQualityRegulatoryZoneMembership1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(true),
+  zone: RegulatoryZone$inboundSchema,
+});
 
-export function oneFromJSON(
+export function airQualityRegulatoryZoneMembership1FromJSON(
   jsonString: string,
-): SafeParseResult<One, SDKValidationError> {
+): SafeParseResult<AirQualityRegulatoryZoneMembership1, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => One$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'One' from JSON`,
+    (x) =>
+      AirQualityRegulatoryZoneMembership1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityRegulatoryZoneMembership1' from JSON`,
   );
 }
 
@@ -179,7 +189,10 @@ export const AirQualityRegulatoryZoneMembership$inboundSchema: z.ZodType<
   AirQualityRegulatoryZoneMembership,
   z.ZodTypeDef,
   unknown
-> = z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
+> = z.union([
+  z.lazy(() => AirQualityRegulatoryZoneMembership1$inboundSchema),
+  z.lazy(() => AirQualityRegulatoryZoneMembership2$inboundSchema),
+]);
 
 export function airQualityRegulatoryZoneMembershipFromJSON(
   jsonString: string,

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

@@ -0,0 +1,246 @@
+/*
+ * 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";
+import {
+  ConservationZone,
+  ConservationZone$inboundSchema,
+} from "./conservationzone.js";
+import { Provenance, Provenance$inboundSchema } from "./provenance.js";
+
+/**
+ * Honest precision of designatedDate — a year-only date is not a day
+ */
+export const ConservationAssessmentsDatePrecision = {
+  Day: "day",
+  Month: "month",
+  Year: "year",
+  None: "none",
+} as const;
+/**
+ * Honest precision of designatedDate — a year-only date is not a day
+ */
+export type ConservationAssessmentsDatePrecision = OpenEnum<
+  typeof ConservationAssessmentsDatePrecision
+>;
+
+/**
+ * Optional — the nearest zone of this kind, with distance
+ */
+export type ConservationAssessmentsNearest = {
+  /**
+   * Designation area in hectares
+   */
+  areaHectares?: number | null | undefined;
+  /**
+   * Compass bearing to the feature, degrees from true north (0-360)
+   */
+  bearingDeg?: number | undefined;
+  /**
+   * Honest precision of designatedDate — a year-only date is not a day
+   */
+  datePrecision?: ConservationAssessmentsDatePrecision | undefined;
+  /**
+   * ISO date the designation took effect
+   */
+  designatedDate?: string | null | undefined;
+  /**
+   * Distance to the feature in metres
+   */
+  distanceM: number;
+  /**
+   * Priority-habitat classification code (priority_habitat only) — UKBAP / EUNIS code, verbatim
+   */
+  habitatCode?: string | undefined;
+  /**
+   * Landscape class (landscape_designation only) — known values: aonb | national_scenic_area
+   */
+  landscapeClass?: string | undefined;
+  /**
+   * Designation lifecycle — known values: designated | candidate | withdrawn
+   */
+  lifecycle?: string | undefined;
+  /**
+   * Designation name, e.g. 'City of Bath'
+   */
+  name?: string | null | undefined;
+  /**
+   * Custodian register reference (identity-tuple component)
+   */
+  reference?: string | undefined;
+  /**
+   * Woodland antiquity class (woodland types only) — e.g. 'ancient_semi_natural' | 'plantation_on_ancient' | 'long_established'
+   */
+  woodlandClass?: string | undefined;
+};
+
+/**
+ * Outside the zone
+ */
+export type ConservationAssessments2 = {
+  /**
+   * False — the point is not inside any zone of this kind
+   */
+  inside: false;
+  /**
+   * Optional — the nearest zone of this kind, with distance
+   */
+  nearest?: ConservationAssessmentsNearest | undefined;
+};
+
+/**
+ * Inside the zone
+ */
+export type ConservationAssessments1 = {
+  /**
+   * True — the point is inside this zone
+   */
+  inside: true;
+  zone: ConservationZone;
+};
+
+/**
+ * Discriminated inside/outside-with-nearest membership wrapper around any zone schema
+ */
+export type Designations = ConservationAssessments1 | ConservationAssessments2;
+
+export type ConservationAssessments = {
+  /**
+   * Conservation designations keyed by designation_type; only matched (inside / nearby) types are present.
+   */
+  designations: {
+    [k: string]: ConservationAssessments1 | ConservationAssessments2;
+  };
+  /**
+   * Universal provenance block — every product envelope carries this
+   */
+  provenance: Provenance;
+};
+
+/** @internal */
+export const ConservationAssessmentsDatePrecision$inboundSchema: z.ZodType<
+  ConservationAssessmentsDatePrecision,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ConservationAssessmentsDatePrecision);
+
+/** @internal */
+export const ConservationAssessmentsNearest$inboundSchema: z.ZodType<
+  ConservationAssessmentsNearest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaHectares: z.nullable(z.number()).optional(),
+  bearingDeg: z.number().optional(),
+  datePrecision: ConservationAssessmentsDatePrecision$inboundSchema.optional(),
+  designatedDate: z.nullable(z.string()).optional(),
+  distanceM: z.number(),
+  habitatCode: z.string().optional(),
+  landscapeClass: z.string().optional(),
+  lifecycle: z.string().optional(),
+  name: z.nullable(z.string()).optional(),
+  reference: z.string().optional(),
+  woodlandClass: z.string().optional(),
+});
+
+export function conservationAssessmentsNearestFromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationAssessmentsNearest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationAssessmentsNearest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationAssessmentsNearest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConservationAssessments2$inboundSchema: z.ZodType<
+  ConservationAssessments2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(false),
+  nearest: z.lazy(() => ConservationAssessmentsNearest$inboundSchema)
+    .optional(),
+});
+
+export function conservationAssessments2FromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationAssessments2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationAssessments2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationAssessments2' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConservationAssessments1$inboundSchema: z.ZodType<
+  ConservationAssessments1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(true),
+  zone: ConservationZone$inboundSchema,
+});
+
+export function conservationAssessments1FromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationAssessments1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationAssessments1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationAssessments1' from JSON`,
+  );
+}
+
+/** @internal */
+export const Designations$inboundSchema: z.ZodType<
+  Designations,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => ConservationAssessments1$inboundSchema),
+  z.lazy(() => ConservationAssessments2$inboundSchema),
+]);
+
+export function designationsFromJSON(
+  jsonString: string,
+): SafeParseResult<Designations, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Designations$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Designations' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConservationAssessments$inboundSchema: z.ZodType<
+  ConservationAssessments,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  designations: z.record(
+    z.union([
+      z.lazy(() => ConservationAssessments1$inboundSchema),
+      z.lazy(() => ConservationAssessments2$inboundSchema),
+    ]),
+  ),
+  provenance: Provenance$inboundSchema,
+});
+
+export function conservationAssessmentsFromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationAssessments, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationAssessments$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationAssessments' from JSON`,
+  );
+}