@vepler/sdk 2.42.0 → 2.46.0

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

@@ -0,0 +1,123 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Filter matched addresses by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
+ */
+export const Classification = {
+  Residential: "residential",
+  Commercial: "commercial",
+  All: "all",
+} as const;
+/**
+ * Filter matched addresses by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
+ */
+export type Classification = ClosedEnum<typeof Classification>;
+
+/**
+ * Optional matching configuration
+ */
+export type Options = {
+  /**
+   * Filter matched addresses by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
+   */
+  classification?: Classification | undefined;
+  /**
+   * Minimum confidence threshold for matches (0-100)
+   */
+  confidenceThreshold?: number | undefined;
+  /**
+   * Enable postcode-based fallback matching
+   */
+  enableFallback?: boolean | undefined;
+  /**
+   * Confidence threshold below which fallback matching is triggered
+   */
+  fallbackThreshold?: number | undefined;
+  /**
+   * Include detailed processing steps in response
+   */
+  includeProcessingDetails?: boolean | undefined;
+  /**
+   * Maximum number of results to return
+   */
+  maxResults?: number | undefined;
+  /**
+   * Request timeout in milliseconds
+   */
+  timeout?: number | undefined;
+};
+
+export type AddressResolveRequest = {
+  /**
+   * The address string to resolve
+   */
+  address: string;
+  /**
+   * Optional matching configuration
+   */
+  options?: Options | undefined;
+};
+
+/** @internal */
+export const Classification$outboundSchema: z.ZodNativeEnum<
+  typeof Classification
+> = z.nativeEnum(Classification);
+
+/** @internal */
+export type Options$Outbound = {
+  classification?: string | undefined;
+  confidenceThreshold?: number | undefined;
+  enableFallback?: boolean | undefined;
+  fallbackThreshold?: number | undefined;
+  includeProcessingDetails?: boolean | undefined;
+  maxResults?: number | undefined;
+  timeout?: number | undefined;
+};
+
+/** @internal */
+export const Options$outboundSchema: z.ZodType<
+  Options$Outbound,
+  z.ZodTypeDef,
+  Options
+> = z.object({
+  classification: Classification$outboundSchema.optional(),
+  confidenceThreshold: z.number().optional(),
+  enableFallback: z.boolean().optional(),
+  fallbackThreshold: z.number().optional(),
+  includeProcessingDetails: z.boolean().optional(),
+  maxResults: z.number().optional(),
+  timeout: z.number().optional(),
+});
+
+export function optionsToJSON(options: Options): string {
+  return JSON.stringify(Options$outboundSchema.parse(options));
+}
+
+/** @internal */
+export type AddressResolveRequest$Outbound = {
+  address: string;
+  options?: Options$Outbound | undefined;
+};
+
+/** @internal */
+export const AddressResolveRequest$outboundSchema: z.ZodType<
+  AddressResolveRequest$Outbound,
+  z.ZodTypeDef,
+  AddressResolveRequest
+> = z.object({
+  address: z.string(),
+  options: z.lazy(() => Options$outboundSchema).optional(),
+});
+
+export function addressResolveRequestToJSON(
+  addressResolveRequest: AddressResolveRequest,
+): string {
+  return JSON.stringify(
+    AddressResolveRequest$outboundSchema.parse(addressResolveRequest),
+  );
+}

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

@@ -160,7 +160,7 @@ export type AppointmentsResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total officer appointments held by this person (active and resigned).
    */
@@ -227,7 +227,7 @@ export const AppointmentsResponse$inboundSchema: z.ZodType<
   offset: z.number().int(),
   personId: z.string(),
   personName: z.string(),
-  success: z.boolean(),
+  success: z.literal(true),
   totalAppointments: z.number().int(),
 });
 

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

@@ -4,8 +4,25 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Address dataset: 'os' (OS AddressBase, default) or 'paf' (Royal Mail PAF)
+ */
+export const Dataset = {
+  Os: "os",
+  Paf: "paf",
+} as const;
+/**
+ * Address dataset: 'os' (OS AddressBase, default) or 'paf' (Royal Mail PAF)
+ */
+export type Dataset = ClosedEnum<typeof Dataset>;
 
 export type BulkPostcodeLookupRequest = {
+  /**
+   * Address dataset: 'os' (OS AddressBase, default) or 'paf' (Royal Mail PAF)
+   */
+  dataset?: Dataset | undefined;
   /**
    * Maximum addresses per postcode
    */
@@ -16,8 +33,13 @@ export type BulkPostcodeLookupRequest = {
   postcodes: Array<string>;
 };
 
+/** @internal */
+export const Dataset$outboundSchema: z.ZodNativeEnum<typeof Dataset> = z
+  .nativeEnum(Dataset);
+
 /** @internal */
 export type BulkPostcodeLookupRequest$Outbound = {
+  dataset: string;
   per_postcode: number;
   postcodes: Array<string>;
 };
@@ -28,6 +50,7 @@ export const BulkPostcodeLookupRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BulkPostcodeLookupRequest
 > = z.object({
+  dataset: Dataset$outboundSchema.default("os"),
   perPostcode: z.number().int().default(50),
   postcodes: z.array(z.string()),
 }).transform((v) => {

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

@@ -26,7 +26,7 @@ export type CompaniesByLocationResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total number of companies registered at this property.
    */
@@ -41,7 +41,7 @@ export const CompaniesByLocationResponse$inboundSchema: z.ZodType<
 > = z.object({
   companies: z.array(CompanySummary$inboundSchema),
   locationId: z.string(),
-  success: z.boolean(),
+  success: z.literal(true),
   total: z.number().int(),
 });
 

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

@@ -34,7 +34,7 @@ export type CompanyListResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total number of companies matching the search criteria (across all pages).
    */
@@ -51,7 +51,7 @@ export const CompanyListResponse$inboundSchema: z.ZodType<
   limit: z.number().int(),
   offset: z.number().int(),
   results: z.array(CompanySummary$inboundSchema),
-  success: z.boolean(),
+  success: z.literal(true),
   total: z.number().int(),
 });
 

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

@@ -32,7 +32,7 @@ export type CompanyResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
 };
 
 /** @internal */
@@ -44,7 +44,7 @@ export const CompanyResponse$inboundSchema: z.ZodType<
   officers: z.array(OfficerSummary$inboundSchema).optional(),
   pscs: z.array(PscSummary$inboundSchema).optional(),
   result: Company$inboundSchema,
-  success: z.boolean(),
+  success: z.literal(true),
 });
 
 export function companyResponseFromJSON(

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

@@ -4,6 +4,7 @@
 
 export * from "./addresscleanserequest.js";
 export * from "./addresscleanseresponse.js";
+export * from "./addressresolverequest.js";
 export * from "./aggregationinput.js";
 export * from "./aggregationresult.js";
 export * from "./analysiscomparable.js";
@@ -69,10 +70,18 @@ export * from "./personlistresponse.js";
 export * from "./personqueryrequest.js";
 export * from "./personresponse.js";
 export * from "./personsummary.js";
+export * from "./planningaddress.js";
+export * from "./planningagent.js";
+export * from "./planningapplicant.js";
 export * from "./planningapplication.js";
+export * from "./planningconstraint.js";
+export * from "./planningdocument.js";
 export * from "./planninglistresponse.js";
+export * from "./planningpeople.js";
 export * from "./planningqueryfilters.js";
 export * from "./planningqueryrequest.js";
+export * from "./planningrelatedcase.js";
+export * from "./planningstatushistory.js";
 export * from "./postcodeaddress.js";
 export * from "./postcodelookupresponse.js";
 export * from "./postcodevalidationresponse.js";

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

@@ -8,6 +8,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListingImage = {
+  /**
+   * Pre-generated CDN thumbnail URL (640×480 WebP)
+   */
+  thumbnailUrl?: string | null | undefined;
   /**
    * Image URL
    */
@@ -20,6 +24,7 @@ export const ListingImage$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  thumbnailUrl: z.nullable(z.string()).optional(),
   url: z.nullable(z.string()).optional(),
 });
 

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

@@ -34,7 +34,7 @@ export type OfficerListResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total number of officer appointments matching the filters.
    */
@@ -51,7 +51,7 @@ export const OfficerListResponse$inboundSchema: z.ZodType<
   limit: z.number().int(),
   offset: z.number().int(),
   results: z.array(OfficerSummary$inboundSchema),
-  success: z.boolean(),
+  success: z.literal(true),
   total: z.number().int(),
 });
 

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

@@ -19,7 +19,7 @@ export type OfficerResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
 };
 
 /** @internal */
@@ -29,7 +29,7 @@ export const OfficerResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   result: Officer$inboundSchema,
-  success: z.boolean(),
+  success: z.literal(true),
 });
 
 export function officerResponseFromJSON(

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

@@ -19,7 +19,7 @@ export type PersonClusterResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
 };
 
 /** @internal */
@@ -29,7 +29,7 @@ export const PersonClusterResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   result: PersonCluster$inboundSchema,
-  success: z.boolean(),
+  success: z.literal(true),
 });
 
 export function personClusterResponseFromJSON(

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

@@ -31,7 +31,7 @@ export type PersonListResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total number of persons matching the search criteria (across all pages).
    */
@@ -48,7 +48,7 @@ export const PersonListResponse$inboundSchema: z.ZodType<
   limit: z.number().int(),
   offset: z.number().int(),
   results: z.array(z.nullable(PersonSummary$inboundSchema)),
-  success: z.boolean(),
+  success: z.literal(true),
   total: z.number().int(),
 });
 

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

@@ -32,7 +32,7 @@ export type PersonResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
 };
 
 /** @internal */
@@ -44,7 +44,7 @@ export const PersonResponse$inboundSchema: z.ZodType<
   appointments: z.array(OfficerSummary$inboundSchema).optional(),
   pscNotifications: z.array(PscSummary$inboundSchema).optional(),
   result: Person$inboundSchema,
-  success: z.boolean(),
+  success: z.literal(true),
 });
 
 export function personResponseFromJSON(

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

@@ -0,0 +1,77 @@
+/*
+ * 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";
+
+/**
+ * Structured address of the application site, as scraped from the planning authority. Field availability varies by council — some provide full structured addresses whilst others provide only a raw string. Null if no address data was available.
+ */
+export type PlanningAddress = {
+  /**
+   * County.
+   */
+  county?: string | null | undefined;
+  /**
+   * Full formatted address as a single string, when available.
+   */
+  formattedAddress?: string | null | undefined;
+  /**
+   * First line of the site address.
+   */
+  line1?: string | null | undefined;
+  /**
+   * Second line of the site address.
+   */
+  line2?: string | null | undefined;
+  /**
+   * Third line of the site address.
+   */
+  line3?: string | null | undefined;
+  /**
+   * Fourth line of the site address.
+   */
+  line4?: string | null | undefined;
+  /**
+   * UK postcode.
+   */
+  postcode?: string | null | undefined;
+  /**
+   * Town or city.
+   */
+  town?: string | null | undefined;
+  /**
+   * Electoral ward in which the site is located.
+   */
+  ward?: string | null | undefined;
+};
+
+/** @internal */
+export const PlanningAddress$inboundSchema: z.ZodType<
+  PlanningAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  county: z.nullable(z.string()).optional(),
+  formattedAddress: z.nullable(z.string()).optional(),
+  line1: z.nullable(z.string()).optional(),
+  line2: z.nullable(z.string()).optional(),
+  line3: z.nullable(z.string()).optional(),
+  line4: z.nullable(z.string()).optional(),
+  postcode: z.nullable(z.string()).optional(),
+  town: z.nullable(z.string()).optional(),
+  ward: z.nullable(z.string()).optional(),
+});
+
+export function planningAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningAddress' from JSON`,
+  );
+}

package/src/sdk/models/shared/planningagent.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 PlanningAgent = {
+  /**
+   * Full name of the planning agent.
+   */
+  name?: string | null | undefined;
+  /**
+   * Agent's company or practice name.
+   */
+  organisation?: string | null | undefined;
+};
+
+/** @internal */
+export const PlanningAgent$inboundSchema: z.ZodType<
+  PlanningAgent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.nullable(z.string()).optional(),
+  organisation: z.nullable(z.string()).optional(),
+});
+
+export function planningAgentFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningAgent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningAgent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningAgent' from JSON`,
+  );
+}

package/src/sdk/models/shared/planningapplicant.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 PlanningApplicant = {
+  /**
+   * Company or organisation name, if applicable.
+   */
+  company?: string | null | undefined;
+  /**
+   * Full name of the applicant.
+   */
+  name?: string | null | undefined;
+};
+
+/** @internal */
+export const PlanningApplicant$inboundSchema: z.ZodType<
+  PlanningApplicant,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  company: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+});
+
+export function planningApplicantFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningApplicant, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningApplicant$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningApplicant' from JSON`,
+  );
+}