@vepler/sdk 2.57.3 → 2.131.0

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

@@ -0,0 +1,44 @@
+/*
+ * 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 PointCategoryStats = {
+  /**
+   * Map of crime category to incident count at this point for the period.
+   */
+  categories: { [k: string]: number };
+  /**
+   * `[longitude, latitude]` of the anonymised reporting point.
+   */
+  coordinates: Array<number>;
+  /**
+   * Period in YYYY-MM format.
+   */
+  date: string;
+};
+
+/** @internal */
+export const PointCategoryStats$inboundSchema: z.ZodType<
+  PointCategoryStats,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  categories: z.record(z.number()),
+  coordinates: z.array(z.number()),
+  date: z.string(),
+});
+
+export function pointCategoryStatsFromJSON(
+  jsonString: string,
+): SafeParseResult<PointCategoryStats, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PointCategoryStats$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PointCategoryStats' from JSON`,
+  );
+}

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

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PointCategoryStats,
+  PointCategoryStats$inboundSchema,
+} from "./pointcategorystats.js";
+
+/**
+ * String representing the object type
+ */
+export const PointCategoryStatsListResponseObject = {
+  List: "list",
+} as const;
+/**
+ * String representing the object type
+ */
+export type PointCategoryStatsListResponseObject = ClosedEnum<
+  typeof PointCategoryStatsListResponseObject
+>;
+
+export type PointCategoryStatsListResponse = {
+  /**
+   * One entry per (point, period) combination over the most recent 12 months of significant reporting. Multiple points within the radius produce multiple entries per period; clients can use the coordinates to render heat-map style overlays.
+   */
+  data: Array<PointCategoryStats>;
+  /**
+   * Whether more results exist
+   */
+  hasMore: boolean;
+  /**
+   * String representing the object type
+   */
+  object: PointCategoryStatsListResponseObject;
+  /**
+   * Total number of results in the response.
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export const PointCategoryStatsListResponseObject$inboundSchema:
+  z.ZodNativeEnum<typeof PointCategoryStatsListResponseObject> = z.nativeEnum(
+    PointCategoryStatsListResponseObject,
+  );
+
+/** @internal */
+export const PointCategoryStatsListResponse$inboundSchema: z.ZodType<
+  PointCategoryStatsListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(PointCategoryStats$inboundSchema),
+  has_more: z.boolean(),
+  object: PointCategoryStatsListResponseObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function pointCategoryStatsListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PointCategoryStatsListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PointCategoryStatsListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PointCategoryStatsListResponse' from JSON`,
+  );
+}

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

@@ -42,7 +42,7 @@ import { TenureData, TenureData$inboundSchema } from "./tenuredata.js";
 /**
  * Address composition within this building
  */
-export type AddressCount = {
+export type PropertyDataApiAddressCount = {
   /**
    * Commercial address count
    */
@@ -64,47 +64,47 @@ export type AddressCount = {
 /**
  * Basement presence
  */
-export const Present = {
+export const PropertyDataApiPresent = {
   Present: "present",
   Absent: "absent",
-  Unknown: "unknown",
 } as const;
 /**
  * Basement presence
  */
-export type Present = OpenEnum<typeof Present>;
+export type PropertyDataApiPresent = OpenEnum<typeof PropertyDataApiPresent>;
 
 /**
  * Whether the basement is self-contained with separate entrance
  */
-export const SelfContained = {
+export const PropertyDataApiSelfContained = {
   Present: "present",
   Absent: "absent",
-  Unknown: "unknown",
 } as const;
 /**
  * Whether the basement is self-contained with separate entrance
  */
-export type SelfContained = OpenEnum<typeof SelfContained>;
+export type PropertyDataApiSelfContained = OpenEnum<
+  typeof PropertyDataApiSelfContained
+>;
 
 /**
  * Basement detection
  */
-export type Basement = {
+export type PropertyDataApiBasement = {
   /**
    * Basement presence
    */
-  present?: Present | null | undefined;
+  present?: PropertyDataApiPresent | null | undefined;
   /**
    * Whether the basement is self-contained with separate entrance
    */
-  selfContained?: SelfContained | null | undefined;
+  selfContained?: PropertyDataApiSelfContained | null | undefined;
 };
 
 /**
  * Construction age and materials (multi-source: OS NGD + EPC)
  */
-export type Construction = {
+export type PropertyDataApiConstruction = {
   /**
    * Primary wall construction material
    */
@@ -176,28 +176,28 @@ export type Area = {
 /**
  * Green/living roof presence detected from aerial survey
  */
-export const GreenRoof = {
+export const PropertyDataApiGreenRoof = {
   Present: "present",
   Absent: "absent",
-  Unknown: "unknown",
 } as const;
 /**
  * Green/living roof presence detected from aerial survey
  */
-export type GreenRoof = OpenEnum<typeof GreenRoof>;
+export type PropertyDataApiGreenRoof = OpenEnum<
+  typeof PropertyDataApiGreenRoof
+>;
 
 /**
  * Solar panel presence detected from aerial survey
  */
-export const Solar = {
+export const PropertyDataApiSolar = {
   Present: "present",
   Absent: "absent",
-  Unknown: "unknown",
 } as const;
 /**
  * Solar panel presence detected from aerial survey
  */
-export type Solar = OpenEnum<typeof Solar>;
+export type PropertyDataApiSolar = OpenEnum<typeof PropertyDataApiSolar>;
 
 /**
  * Roof analysis — shape, materials, directional area breakdown
@@ -210,7 +210,7 @@ export type PropertyDataApiRoof = {
   /**
    * Green/living roof presence detected from aerial survey
    */
-  greenRoof?: GreenRoof | null | undefined;
+  greenRoof?: PropertyDataApiGreenRoof | null | undefined;
   /**
    * Primary roof covering material
    */
@@ -222,13 +222,13 @@ export type PropertyDataApiRoof = {
   /**
    * Solar panel presence detected from aerial survey
    */
-  solar?: Solar | null | undefined;
+  solar?: PropertyDataApiSolar | null | undefined;
 };
 
 /**
  * Physical dimensions and characteristics
  */
-export type Structure = {
+export type PropertyDataApiStructure = {
   /**
    * Building connectivity type
    */
@@ -254,23 +254,23 @@ export type Structure = {
 /**
  * Physical building data from OS NGD and EPC
  */
-export type Building = {
+export type PropertyDataApiBuilding = {
   /**
-   * Raw values per data source — stored only, not indexed
+   * Per-field provenance map. Same shape as the Buildings entity at the linked `osid`. Returned only when callers include `_provenance` in the attribute set.
    */
-  sourceValues?: { [k: string]: { [k: string]: any | null } } | undefined;
+  provenance?: { [k: string]: { [k: string]: any | null } } | undefined;
   /**
    * Address composition within this building
    */
-  addressCount?: AddressCount | null | undefined;
+  addressCount?: PropertyDataApiAddressCount | null | undefined;
   /**
    * Basement detection
    */
-  basement?: Basement | null | undefined;
+  basement?: PropertyDataApiBasement | null | undefined;
   /**
    * Construction age and materials (multi-source: OS NGD + EPC)
    */
-  construction?: Construction | null | undefined;
+  construction?: PropertyDataApiConstruction | null | undefined;
   /**
    * Data sources that contributed to this building record
    */
@@ -286,7 +286,7 @@ export type Building = {
   /**
    * Physical dimensions and characteristics
    */
-  structure?: Structure | null | undefined;
+  structure?: PropertyDataApiStructure | null | undefined;
   /**
    * OS NGD building type classification
    */
@@ -406,7 +406,7 @@ export type PropertyDataApi = {
   /**
    * Physical building data from OS NGD and EPC
    */
-  building?: Building | null | undefined;
+  building?: PropertyDataApiBuilding | null | undefined;
   /**
    * Property charges including service charge and ground rent
    */
@@ -501,8 +501,8 @@ export type PropertyDataApi = {
 };
 
 /** @internal */
-export const AddressCount$inboundSchema: z.ZodType<
-  AddressCount,
+export const PropertyDataApiAddressCount$inboundSchema: z.ZodType<
+  PropertyDataApiAddressCount,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -512,50 +512,54 @@ export const AddressCount$inboundSchema: z.ZodType<
   total: z.nullable(z.number().int()).optional(),
 });
 
-export function addressCountFromJSON(
+export function propertyDataApiAddressCountFromJSON(
   jsonString: string,
-): SafeParseResult<AddressCount, SDKValidationError> {
+): SafeParseResult<PropertyDataApiAddressCount, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => AddressCount$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AddressCount' from JSON`,
+    (x) => PropertyDataApiAddressCount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyDataApiAddressCount' from JSON`,
   );
 }
 
 /** @internal */
-export const Present$inboundSchema: z.ZodType<Present, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Present);
+export const PropertyDataApiPresent$inboundSchema: z.ZodType<
+  PropertyDataApiPresent,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyDataApiPresent);
 
 /** @internal */
-export const SelfContained$inboundSchema: z.ZodType<
-  SelfContained,
+export const PropertyDataApiSelfContained$inboundSchema: z.ZodType<
+  PropertyDataApiSelfContained,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(SelfContained);
+> = openEnums.inboundSchema(PropertyDataApiSelfContained);
 
 /** @internal */
-export const Basement$inboundSchema: z.ZodType<
-  Basement,
+export const PropertyDataApiBasement$inboundSchema: z.ZodType<
+  PropertyDataApiBasement,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  present: z.nullable(Present$inboundSchema).optional(),
-  selfContained: z.nullable(SelfContained$inboundSchema).optional(),
+  present: z.nullable(PropertyDataApiPresent$inboundSchema).optional(),
+  selfContained: z.nullable(PropertyDataApiSelfContained$inboundSchema)
+    .optional(),
 });
 
-export function basementFromJSON(
+export function propertyDataApiBasementFromJSON(
   jsonString: string,
-): SafeParseResult<Basement, SDKValidationError> {
+): SafeParseResult<PropertyDataApiBasement, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Basement$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Basement' from JSON`,
+    (x) => PropertyDataApiBasement$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyDataApiBasement' from JSON`,
   );
 }
 
 /** @internal */
-export const Construction$inboundSchema: z.ZodType<
-  Construction,
+export const PropertyDataApiConstruction$inboundSchema: z.ZodType<
+  PropertyDataApiConstruction,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -564,13 +568,13 @@ export const Construction$inboundSchema: z.ZodType<
   year: z.nullable(z.number().int()).optional(),
 });
 
-export function constructionFromJSON(
+export function propertyDataApiConstructionFromJSON(
   jsonString: string,
-): SafeParseResult<Construction, SDKValidationError> {
+): SafeParseResult<PropertyDataApiConstruction, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Construction$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Construction' from JSON`,
+    (x) => PropertyDataApiConstruction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyDataApiConstruction' from JSON`,
   );
 }
 
@@ -602,15 +606,18 @@ export function areaFromJSON(
 }
 
 /** @internal */
-export const GreenRoof$inboundSchema: z.ZodType<
-  GreenRoof,
+export const PropertyDataApiGreenRoof$inboundSchema: z.ZodType<
+  PropertyDataApiGreenRoof,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(GreenRoof);
+> = openEnums.inboundSchema(PropertyDataApiGreenRoof);
 
 /** @internal */
-export const Solar$inboundSchema: z.ZodType<Solar, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Solar);
+export const PropertyDataApiSolar$inboundSchema: z.ZodType<
+  PropertyDataApiSolar,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyDataApiSolar);
 
 /** @internal */
 export const PropertyDataApiRoof$inboundSchema: z.ZodType<
@@ -619,10 +626,10 @@ export const PropertyDataApiRoof$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   area: z.nullable(z.lazy(() => Area$inboundSchema)).optional(),
-  greenRoof: z.nullable(GreenRoof$inboundSchema).optional(),
+  greenRoof: z.nullable(PropertyDataApiGreenRoof$inboundSchema).optional(),
   material: z.nullable(z.string()).optional(),
   shape: z.nullable(z.string()).optional(),
-  solar: z.nullable(Solar$inboundSchema).optional(),
+  solar: z.nullable(PropertyDataApiSolar$inboundSchema).optional(),
 });
 
 export function propertyDataApiRoofFromJSON(
@@ -636,8 +643,8 @@ export function propertyDataApiRoofFromJSON(
 }
 
 /** @internal */
-export const Structure$inboundSchema: z.ZodType<
-  Structure,
+export const PropertyDataApiStructure$inboundSchema: z.ZodType<
+  PropertyDataApiStructure,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -648,45 +655,51 @@ export const Structure$inboundSchema: z.ZodType<
   physicalState: z.nullable(z.string()).optional(),
 });
 
-export function structureFromJSON(
+export function propertyDataApiStructureFromJSON(
   jsonString: string,
-): SafeParseResult<Structure, SDKValidationError> {
+): SafeParseResult<PropertyDataApiStructure, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Structure$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Structure' from JSON`,
+    (x) => PropertyDataApiStructure$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyDataApiStructure' from JSON`,
   );
 }
 
 /** @internal */
-export const Building$inboundSchema: z.ZodType<
-  Building,
+export const PropertyDataApiBuilding$inboundSchema: z.ZodType<
+  PropertyDataApiBuilding,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _sourceValues: z.record(z.record(z.nullable(z.any()))).optional(),
-  addressCount: z.nullable(z.lazy(() => AddressCount$inboundSchema)).optional(),
-  basement: z.nullable(z.lazy(() => Basement$inboundSchema)).optional(),
-  construction: z.nullable(z.lazy(() => Construction$inboundSchema)).optional(),
+  _provenance: z.record(z.record(z.nullable(z.any()))).optional(),
+  addressCount: z.nullable(
+    z.lazy(() => PropertyDataApiAddressCount$inboundSchema),
+  ).optional(),
+  basement: z.nullable(z.lazy(() => PropertyDataApiBasement$inboundSchema))
+    .optional(),
+  construction: z.nullable(
+    z.lazy(() => PropertyDataApiConstruction$inboundSchema),
+  ).optional(),
   dataSources: z.array(z.string()).optional(),
   osid: z.string().optional(),
   roof: z.nullable(z.lazy(() => PropertyDataApiRoof$inboundSchema)).optional(),
-  structure: z.nullable(z.lazy(() => Structure$inboundSchema)).optional(),
+  structure: z.nullable(z.lazy(() => PropertyDataApiStructure$inboundSchema))
+    .optional(),
   type: z.nullable(z.string()).optional(),
   use: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
-    "_sourceValues": "sourceValues",
+    "_provenance": "provenance",
   });
 });
 
-export function buildingFromJSON(
+export function propertyDataApiBuildingFromJSON(
   jsonString: string,
-): SafeParseResult<Building, SDKValidationError> {
+): SafeParseResult<PropertyDataApiBuilding, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Building$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Building' from JSON`,
+    (x) => PropertyDataApiBuilding$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyDataApiBuilding' from JSON`,
   );
 }
 
@@ -845,7 +858,8 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
 > = z.object({
   address: PropertyAddress$inboundSchema.optional(),
   build: BuildData$inboundSchema.optional(),
-  building: z.nullable(z.lazy(() => Building$inboundSchema)).optional(),
+  building: z.nullable(z.lazy(() => PropertyDataApiBuilding$inboundSchema))
+    .optional(),
   charges: z.lazy(() => Charges$inboundSchema).optional(),
   classificationCode: z.nullable(z.string()).optional(),
   coordinateConfidence: z.nullable(CoordinateConfidence$inboundSchema)

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

@@ -54,14 +54,16 @@ export type PropertyQueryRequestField = ClosedEnum<
 /**
  * How to handle missing values
  */
-export const Missing = {
+export const PropertyQueryRequestMissing = {
   First: "_first",
   Last: "_last",
 } as const;
 /**
  * How to handle missing values
  */
-export type Missing = ClosedEnum<typeof Missing>;
+export type PropertyQueryRequestMissing = ClosedEnum<
+  typeof PropertyQueryRequestMissing
+>;
 
 /**
  * Mode for multi-valued fields
@@ -92,7 +94,7 @@ export type PropertyQueryRequestOrder = ClosedEnum<
   typeof PropertyQueryRequestOrder
 >;
 
-export type Sort = {
+export type PropertyQueryRequestSort = {
   /**
    * Field to sort by (whitelisted fields only)
    */
@@ -100,7 +102,7 @@ export type Sort = {
   /**
    * How to handle missing values
    */
-  missing?: Missing | undefined;
+  missing?: PropertyQueryRequestMissing | undefined;
   /**
    * Mode for multi-valued fields
    */
@@ -135,7 +137,7 @@ export type PropertyQueryRequest = {
   /**
    * Sort configuration (max 3 fields)
    */
-  sort?: Array<Sort> | undefined;
+  sort?: Array<PropertyQueryRequestSort> | undefined;
   /**
    * Enable tracking for billing purposes
    */
@@ -168,8 +170,9 @@ export const PropertyQueryRequestField$outboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(PropertyQueryRequestField);
 
 /** @internal */
-export const Missing$outboundSchema: z.ZodNativeEnum<typeof Missing> = z
-  .nativeEnum(Missing);
+export const PropertyQueryRequestMissing$outboundSchema: z.ZodNativeEnum<
+  typeof PropertyQueryRequestMissing
+> = z.nativeEnum(PropertyQueryRequestMissing);
 
 /** @internal */
 export const Mode$outboundSchema: z.ZodNativeEnum<typeof Mode> = z.nativeEnum(
@@ -182,7 +185,7 @@ export const PropertyQueryRequestOrder$outboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(PropertyQueryRequestOrder);
 
 /** @internal */
-export type Sort$Outbound = {
+export type PropertyQueryRequestSort$Outbound = {
   field: string;
   missing?: string | undefined;
   mode?: string | undefined;
@@ -190,16 +193,23 @@ export type Sort$Outbound = {
 };
 
 /** @internal */
-export const Sort$outboundSchema: z.ZodType<Sort$Outbound, z.ZodTypeDef, Sort> =
-  z.object({
-    field: PropertyQueryRequestField$outboundSchema,
-    missing: Missing$outboundSchema.optional(),
-    mode: Mode$outboundSchema.optional(),
-    order: PropertyQueryRequestOrder$outboundSchema,
-  });
-
-export function sortToJSON(sort: Sort): string {
-  return JSON.stringify(Sort$outboundSchema.parse(sort));
+export const PropertyQueryRequestSort$outboundSchema: z.ZodType<
+  PropertyQueryRequestSort$Outbound,
+  z.ZodTypeDef,
+  PropertyQueryRequestSort
+> = z.object({
+  field: PropertyQueryRequestField$outboundSchema,
+  missing: PropertyQueryRequestMissing$outboundSchema.optional(),
+  mode: Mode$outboundSchema.optional(),
+  order: PropertyQueryRequestOrder$outboundSchema,
+});
+
+export function propertyQueryRequestSortToJSON(
+  propertyQueryRequestSort: PropertyQueryRequestSort,
+): string {
+  return JSON.stringify(
+    PropertyQueryRequestSort$outboundSchema.parse(propertyQueryRequestSort),
+  );
 }
 
 /** @internal */
@@ -209,7 +219,7 @@ export type PropertyQueryRequest$Outbound = {
   limit: number;
   offset: number;
   query: Array<PropertyQueryOperator$Outbound>;
-  sort?: Array<Sort$Outbound> | undefined;
+  sort?: Array<PropertyQueryRequestSort$Outbound> | undefined;
   track: boolean;
 };
 
@@ -224,7 +234,8 @@ export const PropertyQueryRequest$outboundSchema: z.ZodType<
   limit: z.number().default(25),
   offset: z.number().default(0),
   query: z.array(PropertyQueryOperator$outboundSchema),
-  sort: z.array(z.lazy(() => Sort$outboundSchema)).optional(),
+  sort: z.array(z.lazy(() => PropertyQueryRequestSort$outboundSchema))
+    .optional(),
   track: z.boolean().default(false),
 });