@vepler/sdk 2.6.5 → 2.8.0

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

@@ -0,0 +1,276 @@
+/*
+ * 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 * as shared from "../shared/index.js";
+
+export type SearchSuggestRequest = {
+  /**
+   * Maximum number of results (1-100)
+   */
+  limit?: string | undefined;
+  /**
+   * Number of results to skip for pagination
+   */
+  offset?: string | undefined;
+  /**
+   * Search query
+   */
+  q: string;
+  /**
+   * Filter results to specific search source (address or location)
+   */
+  source?: string | undefined;
+};
+
+/**
+ * Error type category
+ */
+export const SearchSuggestSearchType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type SearchSuggestSearchType = ClosedEnum<
+  typeof SearchSuggestSearchType
+>;
+
+export type SearchSuggestSearchError = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * URL to relevant documentation
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable error message
+   */
+  message: string;
+  /**
+   * Parameter that caused the error
+   */
+  param?: string | undefined;
+  /**
+   * Error type category
+   */
+  type: SearchSuggestSearchType;
+};
+
+/**
+ * Error response
+ */
+export type SearchSuggestSearchResponseBody = {
+  error: SearchSuggestSearchError;
+};
+
+/**
+ * Error type category
+ */
+export const SearchSuggestType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type SearchSuggestType = ClosedEnum<typeof SearchSuggestType>;
+
+export type SearchSuggestError = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * URL to relevant documentation
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable error message
+   */
+  message: string;
+  /**
+   * Parameter that caused the error
+   */
+  param?: string | undefined;
+  /**
+   * Error type category
+   */
+  type: SearchSuggestType;
+};
+
+/**
+ * Error response
+ */
+export type SearchSuggestResponseBody = {
+  error: SearchSuggestError;
+};
+
+export type SearchSuggestResponse =
+  | shared.SearchResponse
+  | SearchSuggestResponseBody
+  | SearchSuggestSearchResponseBody;
+
+/** @internal */
+export type SearchSuggestRequest$Outbound = {
+  limit?: string | undefined;
+  offset?: string | undefined;
+  q: string;
+  source?: string | undefined;
+};
+
+/** @internal */
+export const SearchSuggestRequest$outboundSchema: z.ZodType<
+  SearchSuggestRequest$Outbound,
+  z.ZodTypeDef,
+  SearchSuggestRequest
+> = z.object({
+  limit: z.string().optional(),
+  offset: z.string().optional(),
+  q: z.string(),
+  source: z.string().optional(),
+});
+
+export function searchSuggestRequestToJSON(
+  searchSuggestRequest: SearchSuggestRequest,
+): string {
+  return JSON.stringify(
+    SearchSuggestRequest$outboundSchema.parse(searchSuggestRequest),
+  );
+}
+
+/** @internal */
+export const SearchSuggestSearchType$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSuggestSearchType
+> = z.nativeEnum(SearchSuggestSearchType);
+
+/** @internal */
+export const SearchSuggestSearchError$inboundSchema: z.ZodType<
+  SearchSuggestSearchError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: SearchSuggestSearchType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function searchSuggestSearchErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSuggestSearchError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSuggestSearchError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSuggestSearchError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSuggestSearchResponseBody$inboundSchema: z.ZodType<
+  SearchSuggestSearchResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => SearchSuggestSearchError$inboundSchema),
+});
+
+export function searchSuggestSearchResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSuggestSearchResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSuggestSearchResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSuggestSearchResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSuggestType$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSuggestType
+> = z.nativeEnum(SearchSuggestType);
+
+/** @internal */
+export const SearchSuggestError$inboundSchema: z.ZodType<
+  SearchSuggestError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: SearchSuggestType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function searchSuggestErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSuggestError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSuggestError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSuggestError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSuggestResponseBody$inboundSchema: z.ZodType<
+  SearchSuggestResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => SearchSuggestError$inboundSchema),
+});
+
+export function searchSuggestResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSuggestResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSuggestResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSuggestResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSuggestResponse$inboundSchema: z.ZodType<
+  SearchSuggestResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.SearchResponse$inboundSchema,
+  z.lazy(() => SearchSuggestResponseBody$inboundSchema),
+  z.lazy(() => SearchSuggestSearchResponseBody$inboundSchema),
+]);
+
+export function searchSuggestResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSuggestResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSuggestResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSuggestResponse' from JSON`,
+  );
+}

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

@@ -38,7 +38,7 @@ export const Epc = {
 export type Epc = ClosedEnum<typeof Epc>;
 
 /**
- * Type of property
+ * Type of property. Additional types (maisonette, cottage, etc.) are automatically mapped to core ML model types for prediction.
  */
 export const PropertyType = {
   Detached: "detached",
@@ -46,10 +46,20 @@ export const PropertyType = {
   Terraced: "terraced",
   Flat: "flat",
   Bungalow: "bungalow",
+  Maisonette: "maisonette",
+  Cottage: "cottage",
+  Chalet: "chalet",
+  Lodge: "lodge",
+  CharacterProperty: "characterProperty",
+  MobileHome: "mobileHome",
+  Retirement: "retirement",
+  BlockOfFlats: "blockOfFlats",
+  Farmhouse: "farmhouse",
+  Unknown: "unknown",
   Other: "other",
 } as const;
 /**
- * Type of property
+ * Type of property. Additional types (maisonette, cottage, etc.) are automatically mapped to core ML model types for prediction.
  */
 export type PropertyType = ClosedEnum<typeof PropertyType>;
 
@@ -107,7 +117,7 @@ export type AVMPredictRequest = {
    */
   postcode?: string | undefined;
   /**
-   * Type of property
+   * Type of property. Additional types (maisonette, cottage, etc.) are automatically mapped to core ML model types for prediction.
    */
   propertyType: PropertyType;
   /**

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

@@ -7,68 +7,23 @@ import { safeParse } from "../../../lib/schemas.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;
-  /**
-   * Whether the year is exact or estimated
-   */
-  isExact: boolean;
-  /**
-   * Mid-point year of construction period
-   */
-  midYear: number;
-  /**
-   * Construction period start year
-   */
-  startYear: number;
+  endYear?: number | undefined;
+  isExact?: boolean | undefined;
+  midYear?: number | undefined;
+  startYear?: number | undefined;
 };
 
 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?: string | 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;
 };
 
@@ -78,10 +33,10 @@ export const ConstructionAge$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  endYear: z.number(),
-  isExact: z.boolean(),
-  midYear: z.number(),
-  startYear: z.number(),
+  endYear: z.number().optional(),
+  isExact: z.boolean().optional(),
+  midYear: z.number().optional(),
+  startYear: z.number().optional(),
 });
 
 export function constructionAgeFromJSON(

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

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

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

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

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

@@ -8,26 +8,11 @@ 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;
-  /**
-   * Effective from date
-   */
-  effectiveFrom: string;
-  /**
-   * Effective to date (null if current)
-   */
+  annualAmount?: number | null | undefined;
+  effectiveFrom?: string | null | undefined;
   effectiveTo?: string | null | undefined;
-  /**
-   * Record ID
-   */
-  id: number;
-  /**
-   * Tax year
-   */
-  taxYear: string;
+  id?: number | null | undefined;
+  taxYear?: string | null | undefined;
 };
 
 /** @internal */
@@ -36,11 +21,11 @@ export const CouncilTaxBandDetails$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  annualAmount: z.number(),
-  effectiveFrom: z.string(),
+  annualAmount: z.nullable(z.number()).optional(),
+  effectiveFrom: z.nullable(z.string()).optional(),
   effectiveTo: z.nullable(z.string()).optional(),
-  id: z.number(),
-  taxYear: z.string(),
+  id: z.nullable(z.number()).optional(),
+  taxYear: z.nullable(z.string()).optional(),
 });
 
 export function councilTaxBandDetailsFromJSON(

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

@@ -12,9 +12,6 @@ import {
   CouncilTaxBandDetails$inboundSchema,
 } from "./counciltaxbanddetails.js";
 
-/**
- * Council tax band
- */
 export const TaxBand = {
   A: "A",
   B: "B",
@@ -26,39 +23,15 @@ export const TaxBand = {
   H: "H",
   I: "I",
 } as const;
-/**
- * Council tax band
- */
 export type TaxBand = ClosedEnum<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;
 };