@vepler/sdk 2.38.2 → 2.42.0

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

@@ -3,110 +3,26 @@
  */
 
 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";
 
 export type GetV1SafetyCrimeStatsRequest = {
   /**
-   * WGS84 latitude of the search centre point in decimal degrees. Must be between -90 and 90. For UK locations, typical values range from 49.9 (southern England) to 55.8 (northern England).
+   * Latitude coordinate
    */
   latitude: string;
   /**
-   * WGS84 longitude of the search centre point in decimal degrees. Must be between -180 and 180. For UK locations, typical values range from -5.7 (western Wales) to 1.8 (eastern England).
+   * Longitude coordinate
    */
   longitude: string;
   /**
-   * Number of months to include in the analysis, counting backwards from the current date. Defaults to 12. Increasing this value provides a longer baseline for trend detection but increases response time as each month requires a separate data query. Recommended range: 6-24 months.
+   * Number of months to analyse
    */
   months?: string | undefined;
   /**
-   * Search radius in metres around the centre point. Defaults to 1,000m. The radius defines a circular search area; all crimes recorded within this area across the requested months are included in the statistics. Larger radii produce more statistically reliable results but cover a wider area.
+   * Search radius in metres (100-50000)
    */
   radius?: string | undefined;
 };
 
-export type MonthlyBreakdown = {
-  /**
-   * Total number of crimes recorded in this month within the search area.
-   */
-  count: number;
-  /**
-   * Month identifier in YYYY-MM format.
-   */
-  month: string;
-};
-
-export type TopCategories = {
-  /**
-   * Crime category key using underscore-separated names (e.g. 'violence_and_sexual_offences').
-   */
-  category: string;
-  /**
-   * Total number of crimes in this category over the analysis period.
-   */
-  count: number;
-  /**
-   * This category's share of total crimes as a whole-number percentage (0-100).
-   */
-  percentage: number;
-};
-
-/**
- * Overall crime trend direction over the analysis period. Determined by comparing the average monthly crime count in the first half of the period to the second half. 'increasing': second half is >10% higher than first half. 'decreasing': second half is >10% lower than first half. 'stable': change is within +/-10%.
- */
-export const Trend = {
-  Increasing: "increasing",
-  Decreasing: "decreasing",
-  Stable: "stable",
-} as const;
-/**
- * Overall crime trend direction over the analysis period. Determined by comparing the average monthly crime count in the first half of the period to the second half. 'increasing': second half is >10% higher than first half. 'decreasing': second half is >10% lower than first half. 'stable': change is within +/-10%.
- */
-export type Trend = OpenEnum<typeof Trend>;
-
-/**
- * Aggregated crime statistics for the queried area and time window.
- */
-export type GetV1SafetyCrimeStatsData = {
-  /**
-   * Average number of crimes per month over the analysis period, rounded to the nearest integer.
-   */
-  monthlyAverage: number;
-  /**
-   * Month-by-month crime counts over the analysis period, ordered from most recent to oldest. Useful for visualising temporal patterns and seasonality.
-   */
-  monthlyBreakdown: Array<MonthlyBreakdown>;
-  /**
-   * Computed safety score for the search area (0-100). Higher scores indicate safer areas. Calculated as an inverse function of crime density: score = 100 - (crimes per km² per month x 10), clamped to the 0-100 range. This is a simplified density-based metric; for the full severity-weighted, time-decayed national score, use the batch crime metrics endpoint with LSOA codes.
-   */
-  safetyScore: number;
-  /**
-   * The top 5 crime categories by volume, sorted in descending order. Each entry includes the category name, absolute count, and percentage of total.
-   */
-  topCategories: Array<TopCategories>;
-  /**
-   * Total number of recorded crimes across all categories within the search area and time window.
-   */
-  totalCrimes: number;
-  /**
-   * Overall crime trend direction over the analysis period. Determined by comparing the average monthly crime count in the first half of the period to the second half. 'increasing': second half is >10% higher than first half. 'decreasing': second half is >10% lower than first half. 'stable': change is within +/-10%.
-   */
-  trend: Trend;
-};
-
-/**
- * Crime statistics successfully retrieved.
- */
-export type GetV1SafetyCrimeStatsResponseBody = {
-  /**
-   * Aggregated crime statistics for the queried area and time window.
-   */
-  data: GetV1SafetyCrimeStatsData;
-};
-
 /** @internal */
 export type GetV1SafetyCrimeStatsRequest$Outbound = {
   latitude: string;
@@ -136,91 +52,3 @@ export function getV1SafetyCrimeStatsRequestToJSON(
     ),
   );
 }
-
-/** @internal */
-export const MonthlyBreakdown$inboundSchema: z.ZodType<
-  MonthlyBreakdown,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  count: z.number(),
-  month: z.string(),
-});
-
-export function monthlyBreakdownFromJSON(
-  jsonString: string,
-): SafeParseResult<MonthlyBreakdown, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => MonthlyBreakdown$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'MonthlyBreakdown' from JSON`,
-  );
-}
-
-/** @internal */
-export const TopCategories$inboundSchema: z.ZodType<
-  TopCategories,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  category: z.string(),
-  count: z.number(),
-  percentage: z.number(),
-});
-
-export function topCategoriesFromJSON(
-  jsonString: string,
-): SafeParseResult<TopCategories, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => TopCategories$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TopCategories' from JSON`,
-  );
-}
-
-/** @internal */
-export const Trend$inboundSchema: z.ZodType<Trend, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Trend);
-
-/** @internal */
-export const GetV1SafetyCrimeStatsData$inboundSchema: z.ZodType<
-  GetV1SafetyCrimeStatsData,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  monthlyAverage: z.number(),
-  monthlyBreakdown: z.array(z.lazy(() => MonthlyBreakdown$inboundSchema)),
-  safetyScore: z.number(),
-  topCategories: z.array(z.lazy(() => TopCategories$inboundSchema)),
-  totalCrimes: z.number(),
-  trend: Trend$inboundSchema,
-});
-
-export function getV1SafetyCrimeStatsDataFromJSON(
-  jsonString: string,
-): SafeParseResult<GetV1SafetyCrimeStatsData, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GetV1SafetyCrimeStatsData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetV1SafetyCrimeStatsData' from JSON`,
-  );
-}
-
-/** @internal */
-export const GetV1SafetyCrimeStatsResponseBody$inboundSchema: z.ZodType<
-  GetV1SafetyCrimeStatsResponseBody,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  data: z.lazy(() => GetV1SafetyCrimeStatsData$inboundSchema),
-});
-
-export function getV1SafetyCrimeStatsResponseBodyFromJSON(
-  jsonString: string,
-): SafeParseResult<GetV1SafetyCrimeStatsResponseBody, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GetV1SafetyCrimeStatsResponseBody$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetV1SafetyCrimeStatsResponseBody' from JSON`,
-  );
-}

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

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetV1TitleDeedsTitleNumberDocumentsRequest = {
+  titleNumber: string;
+};
+
+/** @internal */
+export type GetV1TitleDeedsTitleNumberDocumentsRequest$Outbound = {
+  titleNumber: string;
+};
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsRequest$outboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsRequest$Outbound,
+    z.ZodTypeDef,
+    GetV1TitleDeedsTitleNumberDocumentsRequest
+  > = z.object({
+    titleNumber: z.string(),
+  });
+
+export function getV1TitleDeedsTitleNumberDocumentsRequestToJSON(
+  getV1TitleDeedsTitleNumberDocumentsRequest:
+    GetV1TitleDeedsTitleNumberDocumentsRequest,
+): string {
+  return JSON.stringify(
+    GetV1TitleDeedsTitleNumberDocumentsRequest$outboundSchema.parse(
+      getV1TitleDeedsTitleNumberDocumentsRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * HMLR document type
+ */
+export const DocumentType = {
+  RegisterExtract: "register-extract",
+  OfficialTitle: "official-title",
+  TitlePlan: "title-plan",
+} as const;
+/**
+ * HMLR document type
+ */
+export type DocumentType = ClosedEnum<typeof DocumentType>;
+
+export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest = {
+  /**
+   * HMLR document type
+   */
+  documentType: DocumentType;
+  titleNumber: string;
+};
+
+/** @internal */
+export const DocumentType$outboundSchema: z.ZodNativeEnum<typeof DocumentType> =
+  z.nativeEnum(DocumentType);
+
+/** @internal */
+export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest$Outbound = {
+  documentType: string;
+  titleNumber: string;
+};
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest$outboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest$Outbound,
+    z.ZodTypeDef,
+    GetV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest
+  > = z.object({
+    documentType: DocumentType$outboundSchema,
+    titleNumber: z.string(),
+  });
+
+export function getV1TitleDeedsTitleNumberDocumentsDocumentTypeRequestToJSON(
+  getV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest:
+    GetV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest,
+): string {
+  return JSON.stringify(
+    GetV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest$outboundSchema.parse(
+      getV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest,
+    ),
+  );
+}

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

@@ -49,15 +49,19 @@ export * from "./getsitebyid.js";
 export * from "./getsitetiles.js";
 export * from "./getv1safetycrime.js";
 export * from "./getv1safetycrimestats.js";
+export * from "./getv1titledeedstitlenumberdocuments.js";
+export * from "./getv1titledeedstitlenumberdocumentsdocumenttype.js";
 export * from "./listcouncils.js";
 export * from "./listschools.js";
 export * from "./lookupoutcode.js";
 export * from "./lookuppostcode.js";
 export * from "./lookupuprn.js";
+export * from "./postv1titledeedstitlenumberpurchase.js";
 export * from "./querylistings.js";
 export * from "./querylistingsbysource.js";
 export * from "./resolveaddress.js";
 export * from "./reversegeocode.js";
+export * from "./searchplanningpolicy.js";
 export * from "./searchschoolsnearby.js";
 export * from "./searchschoolswithin.js";
 export * from "./searchsuggest.js";

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

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type PostV1TitleDeedsTitleNumberPurchaseRequest = {
+  titleNumber: string;
+};
+
+/** @internal */
+export type PostV1TitleDeedsTitleNumberPurchaseRequest$Outbound = {
+  titleNumber: string;
+};
+
+/** @internal */
+export const PostV1TitleDeedsTitleNumberPurchaseRequest$outboundSchema:
+  z.ZodType<
+    PostV1TitleDeedsTitleNumberPurchaseRequest$Outbound,
+    z.ZodTypeDef,
+    PostV1TitleDeedsTitleNumberPurchaseRequest
+  > = z.object({
+    titleNumber: z.string(),
+  });
+
+export function postV1TitleDeedsTitleNumberPurchaseRequestToJSON(
+  postV1TitleDeedsTitleNumberPurchaseRequest:
+    PostV1TitleDeedsTitleNumberPurchaseRequest,
+): string {
+  return JSON.stringify(
+    PostV1TitleDeedsTitleNumberPurchaseRequest$outboundSchema.parse(
+      postV1TitleDeedsTitleNumberPurchaseRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,274 @@
+/*
+ * 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";
+
+/**
+ * Filter by rule type
+ */
+export const RuleType = {
+  Requirement: "requirement",
+  Guideline: "guideline",
+  Standard: "standard",
+  Threshold: "threshold",
+  Procedure: "procedure",
+  Definition: "definition",
+  Exemption: "exemption",
+} as const;
+/**
+ * Filter by rule type
+ */
+export type RuleType = ClosedEnum<typeof RuleType>;
+
+/**
+ * Filter by source type
+ */
+export const SourceType = {
+  NationalFramework: "national_framework",
+  LocalPlan: "local_plan",
+  SupplementaryPlanningDocument: "supplementary_planning_document",
+  DesignGuide: "design_guide",
+  NeighbourhoodPlan: "neighbourhood_plan",
+} as const;
+/**
+ * Filter by source type
+ */
+export type SourceType = ClosedEnum<typeof SourceType>;
+
+export type SearchPlanningPolicyRequest = {
+  council?: string | undefined;
+  limit?: number | undefined;
+  q: string;
+  /**
+   * Filter by rule type
+   */
+  ruleType?: RuleType | undefined;
+  /**
+   * Filter by source type
+   */
+  sourceType?: SourceType | undefined;
+};
+
+export type Meta = {
+  query: string;
+  searchTimeMs: number;
+  total: number;
+};
+
+export type Two = {
+  content: string;
+  contextSummary: string | null;
+  id: string;
+  pageEnd: number | null;
+  pageStart: number | null;
+  score: number;
+  sectionPath: Array<string> | null;
+  source: string;
+  type: "chunk";
+};
+
+export type Provenance = {
+  chapter?: string | undefined;
+  page?: number | undefined;
+  paragraph?: string | undefined;
+  section?: string | undefined;
+  source: string;
+  url?: string | undefined;
+};
+
+export type One = {
+  category: string | null;
+  confidence: number | null;
+  id: string;
+  provenance: Provenance;
+  ruleText: string;
+  ruleType: string;
+  score: number;
+  type: "rule";
+};
+
+export type Results = One | Two;
+
+/**
+ * Search results
+ */
+export type SearchPlanningPolicyResponseBody = {
+  meta: Meta;
+  results: Array<One | Two>;
+};
+
+/** @internal */
+export const RuleType$outboundSchema: z.ZodNativeEnum<typeof RuleType> = z
+  .nativeEnum(RuleType);
+
+/** @internal */
+export const SourceType$outboundSchema: z.ZodNativeEnum<typeof SourceType> = z
+  .nativeEnum(SourceType);
+
+/** @internal */
+export type SearchPlanningPolicyRequest$Outbound = {
+  council?: string | undefined;
+  limit: number;
+  q: string;
+  rule_type?: string | undefined;
+  source_type?: string | undefined;
+};
+
+/** @internal */
+export const SearchPlanningPolicyRequest$outboundSchema: z.ZodType<
+  SearchPlanningPolicyRequest$Outbound,
+  z.ZodTypeDef,
+  SearchPlanningPolicyRequest
+> = z.object({
+  council: z.string().optional(),
+  limit: z.number().int().default(10),
+  q: z.string(),
+  ruleType: RuleType$outboundSchema.optional(),
+  sourceType: SourceType$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    ruleType: "rule_type",
+    sourceType: "source_type",
+  });
+});
+
+export function searchPlanningPolicyRequestToJSON(
+  searchPlanningPolicyRequest: SearchPlanningPolicyRequest,
+): string {
+  return JSON.stringify(
+    SearchPlanningPolicyRequest$outboundSchema.parse(
+      searchPlanningPolicyRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const Meta$inboundSchema: z.ZodType<Meta, z.ZodTypeDef, unknown> = z
+  .object({
+    query: z.string(),
+    searchTimeMs: z.number(),
+    total: z.number(),
+  });
+
+export function metaFromJSON(
+  jsonString: string,
+): SafeParseResult<Meta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Meta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Meta' from JSON`,
+  );
+}
+
+/** @internal */
+export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
+  .object({
+    content: z.string(),
+    contextSummary: z.nullable(z.string()),
+    id: z.string(),
+    pageEnd: z.nullable(z.number()),
+    pageStart: z.nullable(z.number()),
+    score: z.number(),
+    sectionPath: z.nullable(z.array(z.string())),
+    source: z.string(),
+    type: z.literal("chunk"),
+  });
+
+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 Provenance$inboundSchema: z.ZodType<
+  Provenance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chapter: z.string().optional(),
+  page: z.number().optional(),
+  paragraph: z.string().optional(),
+  section: z.string().optional(),
+  source: z.string(),
+  url: z.string().optional(),
+});
+
+export function provenanceFromJSON(
+  jsonString: string,
+): SafeParseResult<Provenance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Provenance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Provenance' from JSON`,
+  );
+}
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({
+    category: z.nullable(z.string()),
+    confidence: z.nullable(z.number()),
+    id: z.string(),
+    provenance: z.lazy(() => Provenance$inboundSchema),
+    ruleText: z.string(),
+    ruleType: z.string(),
+    score: z.number(),
+    type: z.literal("rule"),
+  });
+
+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 Results$inboundSchema: z.ZodType<Results, z.ZodTypeDef, unknown> =
+  z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
+
+export function resultsFromJSON(
+  jsonString: string,
+): SafeParseResult<Results, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Results$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Results' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchPlanningPolicyResponseBody$inboundSchema: z.ZodType<
+  SearchPlanningPolicyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: z.lazy(() => Meta$inboundSchema),
+  results: z.array(
+    z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]),
+  ),
+});
+
+export function searchPlanningPolicyResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchPlanningPolicyResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchPlanningPolicyResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchPlanningPolicyResponseBody' from JSON`,
+  );
+}

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

@@ -6,10 +6,18 @@ 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";
+import {
+  ExtendedStatsAggregationResult,
+  ExtendedStatsAggregationResult$inboundSchema,
+} from "./extendedstatsaggregationresult.js";
 import {
   HistogramAggregationResult,
   HistogramAggregationResult$inboundSchema,
 } from "./histogramaggregationresult.js";
+import {
+  PercentilesAggregationResult,
+  PercentilesAggregationResult$inboundSchema,
+} from "./percentilesaggregationresult.js";
 import {
   SingleValueAggregationResult,
   SingleValueAggregationResult$inboundSchema,
@@ -24,9 +32,11 @@ import {
 } from "./termsaggregationresult.js";
 
 export type AggregationResult =
+  | ExtendedStatsAggregationResult
   | StatsAggregationResult
   | TermsAggregationResult
   | HistogramAggregationResult
+  | PercentilesAggregationResult
   | SingleValueAggregationResult;
 
 /** @internal */
@@ -35,9 +45,11 @@ export const AggregationResult$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
+  ExtendedStatsAggregationResult$inboundSchema,
   StatsAggregationResult$inboundSchema,
   TermsAggregationResult$inboundSchema,
   HistogramAggregationResult$inboundSchema,
+  PercentilesAggregationResult$inboundSchema,
   SingleValueAggregationResult$inboundSchema,
 ]);