@vepler/sdk 2.46.0 → 2.50.3

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

@@ -23,13 +23,37 @@ export const Unit = {
 export type Unit = ClosedEnum<typeof Unit>;
 
 export type SearchSchoolsNearbyRequest = {
+  /**
+   * Comma-separated list of related data to include (currently supports: ratings)
+   */
   expand?: string | undefined;
+  /**
+   * Comma-separated list of fields to include
+   */
   fields?: string | undefined;
+  /**
+   * Latitude coordinate
+   */
   latitude: string;
+  /**
+   * Maximum number of results
+   */
   limit?: string | undefined;
+  /**
+   * Longitude coordinate
+   */
   longitude: string;
+  /**
+   * Search radius
+   */
   radius?: string | undefined;
+  /**
+   * Ofsted rating filter
+   */
   rating?: string | undefined;
+  /**
+   * School status filter
+   */
   status?: string | undefined;
   /**
    * Unit for radius

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

@@ -11,14 +11,41 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as shared from "../shared/index.js";
 
 export type SearchSchoolsWithinRequest = {
+  /**
+   * Eastern boundary longitude
+   */
   east: string;
+  /**
+   * Comma-separated list of related data to include (currently supports: ratings)
+   */
   expand?: string | undefined;
+  /**
+   * Comma-separated list of fields to include
+   */
   fields?: string | undefined;
+  /**
+   * Maximum number of results
+   */
   limit?: string | undefined;
+  /**
+   * Northern boundary latitude
+   */
   north: string;
+  /**
+   * Ofsted rating filter
+   */
   rating?: string | undefined;
+  /**
+   * Southern boundary latitude
+   */
   south: string;
+  /**
+   * School status filter
+   */
   status?: string | undefined;
+  /**
+   * Western boundary longitude
+   */
   west: string;
 };
 

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

@@ -49,7 +49,7 @@ export type SearchSubstationsSearchSubstationsInput = {
 };
 
 /**
- * WGS84 coordinate pair
+ * Geographic location of the substation
  */
 export type SearchSubstationsCoordinates = {
   /**
@@ -104,7 +104,7 @@ export type SearchSubstationsSubstation = {
    */
   generationHeadroomMw: number | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic location of the substation
    */
   location: SearchSubstationsCoordinates | null;
   /**
@@ -120,7 +120,7 @@ export type SearchSubstationsSubstation = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator that owns and operates this substation
    */
   operator: string;
   /**
@@ -132,7 +132,7 @@ export type SearchSubstationsSubstation = {
    */
   reversePowerCapacityMw: number | null;
   /**
-   * Classification of substation within the electricity network hierarchy. Known values: 'gsp', 'bulk_supply', 'grid', 'primary', 'distribution'. 'gsp' (Grid Supply Point) connects to the national transmission grid. 'bulk_supply' and 'grid' operate at intermediate voltages. 'primary' steps down to 11kV for local distribution. 'distribution' serves end customers at low voltage.
+   * Classification of this substation in the network hierarchy
    */
   substationType: string | null;
   /**

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

@@ -9,13 +9,31 @@ import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Construction age information
+ */
 export type ConstructionAge = {
+  /**
+   * Construction period end year
+   */
   endYear?: number | undefined;
+  /**
+   * Whether the year is exact or estimated
+   */
   isExact?: boolean | undefined;
+  /**
+   * Mid-point year of construction period
+   */
   midYear?: number | undefined;
+  /**
+   * Construction period start year
+   */
   startYear?: number | undefined;
 };
 
+/**
+ * Property type
+ */
 export const BuildDataPropertyType = {
   Unknown: "unknown",
   Other: "other",
@@ -68,18 +86,51 @@ export const BuildDataPropertyType = {
   CommercialDevelopment: "commercialDevelopment",
   MixedUse: "mixedUse",
 } as const;
+/**
+ * Property type
+ */
 export type BuildDataPropertyType = OpenEnum<typeof BuildDataPropertyType>;
 
 export type BuildData = {
+  /**
+   * Construction age information
+   */
   constructionAge?: ConstructionAge | null | undefined;
+  /**
+   * Floor height in metres
+   */
   floorHeight?: number | null | undefined;
+  /**
+   * Main fuel type
+   */
   mainFuel?: string | null | undefined;
+  /**
+   * Mains gas availability flag
+   */
   mainsGasFlag?: string | null | undefined;
+  /**
+   * Property type
+   */
   propertyType?: BuildDataPropertyType | null | undefined;
+  /**
+   * Roof type
+   */
   roofType?: string | null | undefined;
+  /**
+   * Property sub-type
+   */
   subPropertyType?: string | null | undefined;
+  /**
+   * Total floor area in square metres
+   */
   totalFloorArea?: number | null | undefined;
+  /**
+   * Wall type
+   */
   wallType?: string | null | undefined;
+  /**
+   * Window type
+   */
   windowType?: string | null | undefined;
 };
 

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

@@ -11,28 +11,31 @@ export type ChargeEntry = {
   /**
    * Confidence score (0-100)
    */
-  confidence?: number | undefined;
+  confidence: number;
+  /**
+   * Currency code
+   */
   currency?: string | null | undefined;
   /**
    * Whether this value is an outlier
    */
-  isOutlier?: boolean | undefined;
+  isOutlier: boolean;
   /**
    * Date this charge was recorded
    */
-  recordedDate?: Date | undefined;
+  recordedDate: Date;
   /**
    * Source identifier
    */
-  sourceId?: string | undefined;
+  sourceId: string;
   /**
    * Source provider
    */
-  sourceProvider?: string | undefined;
+  sourceProvider: string;
   /**
    * Charge amount in pence
    */
-  value?: number | undefined;
+  value: number;
 };
 
 /** @internal */
@@ -41,15 +44,15 @@ export const ChargeEntry$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  confidence: z.number().optional(),
+  confidence: z.number(),
   currency: z.nullable(z.string()).optional(),
-  isOutlier: z.boolean().optional(),
+  isOutlier: z.boolean(),
   recordedDate: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
-  ).optional(),
-  sourceId: z.string().optional(),
-  sourceProvider: z.string().optional(),
-  value: z.number().optional(),
+  ),
+  sourceId: z.string(),
+  sourceProvider: z.string(),
+  value: z.number(),
 });
 
 export function chargeEntryFromJSON(

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

@@ -12,17 +12,23 @@ export type ChargeHistory = {
   /**
    * Overall confidence in current value
    */
-  confidence?: number | undefined;
+  confidence: number;
+  /**
+   * Currency code
+   */
   currency?: string | null | undefined;
+  /**
+   * Current best estimate (annual) in pence
+   */
   current?: number | null | undefined;
   /**
    * Historical charge records
    */
-  entries?: Array<ChargeEntry> | undefined;
+  entries: Array<ChargeEntry>;
   /**
    * Last update timestamp
    */
-  lastUpdated?: Date | undefined;
+  lastUpdated: Date;
 };
 
 /** @internal */
@@ -31,12 +37,13 @@ export const ChargeHistory$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  confidence: z.number().optional(),
+  confidence: z.number(),
   currency: z.nullable(z.string()).optional(),
   current: z.nullable(z.number()).optional(),
-  entries: z.array(ChargeEntry$inboundSchema).optional(),
-  lastUpdated: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
+  entries: z.array(ChargeEntry$inboundSchema),
+  lastUpdated: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
 });
 
 export function chargeHistoryFromJSON(

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

@@ -8,10 +8,6 @@ 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 {
-  CompanyAddress,
-  CompanyAddress$inboundSchema,
-} from "./companyaddress.js";
 import { PreviousName, PreviousName$inboundSchema } from "./previousname.js";
 import { SicCode, SicCode$inboundSchema } from "./siccode.js";
 
@@ -149,6 +145,52 @@ export const Jurisdiction = {
  */
 export type Jurisdiction = OpenEnum<typeof Jurisdiction>;
 
+/**
+ * The company's current registered office address. Every UK company must have a registered office, which is the official address for serving legal documents and correspondence from Companies House.
+ */
+export type RegisteredOfficeAddress = {
+  /**
+   * First line of the street address (e.g. 'Heene Road').
+   */
+  addressLine1?: string | null | undefined;
+  /**
+   * Second line of the address, if applicable (e.g. a district or area within a town).
+   */
+  addressLine2?: string | null | undefined;
+  /**
+   * 'Care of' (c/o) name, used when mail should be directed via a third party.
+   */
+  careOf?: string | null | undefined;
+  /**
+   * Country name as recorded by Companies House (e.g. 'United Kingdom', 'England').
+   */
+  country?: string | null | undefined;
+  /**
+   * Pre-formatted single-line address string combining all available components.
+   */
+  formattedAddress?: string | null | undefined;
+  /**
+   * Town or city name.
+   */
+  locality?: string | null | undefined;
+  /**
+   * PO Box number, if the address uses a PO Box.
+   */
+  poBox?: string | null | undefined;
+  /**
+   * UK postcode or international postal code.
+   */
+  postalCode?: string | null | undefined;
+  /**
+   * Building name or number (e.g. 'MGM House', '10').
+   */
+  premises?: string | null | undefined;
+  /**
+   * County, region, or administrative area.
+   */
+  region?: string | null | undefined;
+};
+
 /**
  * The full company record.
  */
@@ -248,7 +290,7 @@ export type Company = {
   /**
    * The company's current registered office address. Every UK company must have a registered office, which is the official address for serving legal documents and correspondence from Companies House.
    */
-  registeredOfficeAddress?: CompanyAddress | null | undefined;
+  registeredOfficeAddress?: RegisteredOfficeAddress | null | undefined;
   /**
    * Up to 4 Standard Industrial Classification (SIC 2007) codes describing the company's business activities. At least one is required at incorporation.
    */
@@ -294,6 +336,34 @@ export const Jurisdiction$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(Jurisdiction);
 
+/** @internal */
+export const RegisteredOfficeAddress$inboundSchema: z.ZodType<
+  RegisteredOfficeAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  addressLine1: z.nullable(z.string()).optional(),
+  addressLine2: z.nullable(z.string()).optional(),
+  careOf: z.nullable(z.string()).optional(),
+  country: z.nullable(z.string()).optional(),
+  formattedAddress: z.nullable(z.string()).optional(),
+  locality: z.nullable(z.string()).optional(),
+  poBox: z.nullable(z.string()).optional(),
+  postalCode: z.nullable(z.string()).optional(),
+  premises: z.nullable(z.string()).optional(),
+  region: z.nullable(z.string()).optional(),
+});
+
+export function registeredOfficeAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<RegisteredOfficeAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RegisteredOfficeAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RegisteredOfficeAddress' from JSON`,
+  );
+}
+
 /** @internal */
 export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
   z.object({
@@ -336,8 +406,9 @@ export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
     ).optional(),
     locationId: z.nullable(z.string()).optional(),
     previousNames: z.array(PreviousName$inboundSchema).optional(),
-    registeredOfficeAddress: z.nullable(CompanyAddress$inboundSchema)
-      .optional(),
+    registeredOfficeAddress: z.nullable(
+      z.lazy(() => RegisteredOfficeAddress$inboundSchema),
+    ).optional(),
     sicCodes: z.array(SicCode$inboundSchema),
     updatedAt: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)

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

@@ -8,10 +8,6 @@ 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 {
-  CompanyAddress,
-  CompanyAddress$inboundSchema,
-} from "./companyaddress.js";
 import { SicCode, SicCode$inboundSchema } from "./siccode.js";
 
 /**
@@ -112,6 +108,52 @@ export type CompanySummaryJurisdiction = OpenEnum<
   typeof CompanySummaryJurisdiction
 >;
 
+/**
+ * The company's current registered office address. May be null in summary responses.
+ */
+export type CompanySummaryRegisteredOfficeAddress = {
+  /**
+   * First line of the street address (e.g. 'Heene Road').
+   */
+  addressLine1?: string | null | undefined;
+  /**
+   * Second line of the address, if applicable (e.g. a district or area within a town).
+   */
+  addressLine2?: string | null | undefined;
+  /**
+   * 'Care of' (c/o) name, used when mail should be directed via a third party.
+   */
+  careOf?: string | null | undefined;
+  /**
+   * Country name as recorded by Companies House (e.g. 'United Kingdom', 'England').
+   */
+  country?: string | null | undefined;
+  /**
+   * Pre-formatted single-line address string combining all available components.
+   */
+  formattedAddress?: string | null | undefined;
+  /**
+   * Town or city name.
+   */
+  locality?: string | null | undefined;
+  /**
+   * PO Box number, if the address uses a PO Box.
+   */
+  poBox?: string | null | undefined;
+  /**
+   * UK postcode or international postal code.
+   */
+  postalCode?: string | null | undefined;
+  /**
+   * Building name or number (e.g. 'MGM House', '10').
+   */
+  premises?: string | null | undefined;
+  /**
+   * County, region, or administrative area.
+   */
+  region?: string | null | undefined;
+};
+
 /**
  * Lightweight company summary for list and search responses. Contains key identification, status, and classification fields without detailed filing information.
  */
@@ -152,7 +194,13 @@ export type CompanySummary = {
    * UPRN linking the company's registered office to a property. Null if unmatched.
    */
   locationId?: string | null | undefined;
-  registeredOfficeAddress?: CompanyAddress | null | undefined;
+  /**
+   * The company's current registered office address. May be null in summary responses.
+   */
+  registeredOfficeAddress?:
+    | CompanySummaryRegisteredOfficeAddress
+    | null
+    | undefined;
   /**
    * Up to 4 SIC 2007 codes describing the company's business activities.
    */
@@ -180,6 +228,35 @@ export const CompanySummaryJurisdiction$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(CompanySummaryJurisdiction);
 
+/** @internal */
+export const CompanySummaryRegisteredOfficeAddress$inboundSchema: z.ZodType<
+  CompanySummaryRegisteredOfficeAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  addressLine1: z.nullable(z.string()).optional(),
+  addressLine2: z.nullable(z.string()).optional(),
+  careOf: z.nullable(z.string()).optional(),
+  country: z.nullable(z.string()).optional(),
+  formattedAddress: z.nullable(z.string()).optional(),
+  locality: z.nullable(z.string()).optional(),
+  poBox: z.nullable(z.string()).optional(),
+  postalCode: z.nullable(z.string()).optional(),
+  premises: z.nullable(z.string()).optional(),
+  region: z.nullable(z.string()).optional(),
+});
+
+export function companySummaryRegisteredOfficeAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanySummaryRegisteredOfficeAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CompanySummaryRegisteredOfficeAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanySummaryRegisteredOfficeAddress' from JSON`,
+  );
+}
+
 /** @internal */
 export const CompanySummary$inboundSchema: z.ZodType<
   CompanySummary,
@@ -197,7 +274,9 @@ export const CompanySummary$inboundSchema: z.ZodType<
   ).optional(),
   jurisdiction: CompanySummaryJurisdiction$inboundSchema,
   locationId: z.nullable(z.string()).optional(),
-  registeredOfficeAddress: z.nullable(CompanyAddress$inboundSchema).optional(),
+  registeredOfficeAddress: z.nullable(
+    z.lazy(() => CompanySummaryRegisteredOfficeAddress$inboundSchema),
+  ).optional(),
   sicCodes: z.array(SicCode$inboundSchema),
 });
 

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

@@ -8,10 +8,25 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CouncilTaxBandDetails = {
+  /**
+   * Annual amount in pence for this period
+   */
   annualAmount?: number | null | undefined;
+  /**
+   * Effective from date
+   */
   effectiveFrom?: string | null | undefined;
+  /**
+   * Effective to date (null if current)
+   */
   effectiveTo?: string | null | undefined;
+  /**
+   * Record ID
+   */
   id?: number | null | undefined;
+  /**
+   * Tax year
+   */
   taxYear?: string | null | undefined;
 };
 

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

@@ -13,6 +13,9 @@ import {
   CouncilTaxBandDetails$inboundSchema,
 } from "./counciltaxbanddetails.js";
 
+/**
+ * Council tax band
+ */
 export const TaxBand = {
   A: "A",
   B: "B",
@@ -24,15 +27,39 @@ export const TaxBand = {
   H: "H",
   I: "I",
 } as const;
+/**
+ * Council tax band
+ */
 export type TaxBand = OpenEnum<typeof TaxBand>;
 
 export type CouncilTaxData = {
+  /**
+   * Council identifier
+   */
   councilId?: string | null | undefined;
+  /**
+   * Current annual council tax charge in pence
+   */
   currentAnnualAmount?: number | null | undefined;
+  /**
+   * Current tax year
+   */
   currentTaxYear?: string | null | undefined;
+  /**
+   * Whether amount is estimated
+   */
   isEstimated?: boolean | undefined;
+  /**
+   * Council tax record status
+   */
   status?: string | null | undefined;
+  /**
+   * Council tax band
+   */
   taxBand?: TaxBand | null | undefined;
+  /**
+   * Historical council tax band records
+   */
   taxBandDetails?: Array<CouncilTaxBandDetails> | undefined;
 };