@vepler/sdk 2.6.6 → 2.9.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/operations/verifyroa.ts

@@ -0,0 +1,31 @@
+/*
+ * 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";
+import * as shared from "../shared/index.js";
+
+export type VerifyRoaResponse = shared.RoaVerifyResponse | shared.RoaError;
+
+/** @internal */
+export const VerifyRoaResponse$inboundSchema: z.ZodType<
+  VerifyRoaResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.RoaVerifyResponse$inboundSchema,
+  shared.RoaError$inboundSchema,
+]);
+
+export function verifyRoaResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<VerifyRoaResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerifyRoaResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerifyRoaResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,194 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Override property condition
+ */
+export const Condition = {
+  Poor: "poor",
+  Average: "average",
+  Good: "good",
+  Excellent: "excellent",
+  NewBuild: "newBuild",
+} as const;
+/**
+ * Override property condition
+ */
+export type Condition = ClosedEnum<typeof Condition>;
+
+/**
+ * Override Energy Performance Certificate rating
+ */
+export const Epc = {
+  A: "A",
+  B: "B",
+  C: "C",
+  D: "D",
+  E: "E",
+  F: "F",
+  G: "G",
+} as const;
+/**
+ * Override Energy Performance Certificate rating
+ */
+export type Epc = ClosedEnum<typeof Epc>;
+
+/**
+ * Override property type from fetched data
+ */
+export const PropertyType = {
+  Detached: "detached",
+  SemiDetached: "semiDetached",
+  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;
+/**
+ * Override property type from fetched data
+ */
+export type PropertyType = ClosedEnum<typeof PropertyType>;
+
+/**
+ * Type of transaction - sale or rental valuation
+ */
+export const TransactionType = {
+  Sale: "sale",
+  Rent: "rent",
+} as const;
+/**
+ * Type of transaction - sale or rental valuation
+ */
+export type TransactionType = ClosedEnum<typeof TransactionType>;
+
+/**
+ * Request to predict property value by location ID
+ */
+export type AVMPredictByLocationRequest = {
+  /**
+   * Override number of bathrooms from fetched data
+   */
+  baths?: number | undefined;
+  /**
+   * Override number of bedrooms from fetched data
+   */
+  beds?: number | undefined;
+  /**
+   * Override property condition
+   */
+  condition?: Condition | undefined;
+  /**
+   * Override Energy Performance Certificate rating
+   */
+  epc?: Epc | undefined;
+  /**
+   * Override floor area in square metres from fetched data
+   */
+  floorArea?: number | undefined;
+  /**
+   * Price to rate against market value (requires ratePrice: true)
+   */
+  inputPrice?: number | undefined;
+  /**
+   * Override listing price (for comparison)
+   */
+  listingPrice?: number | undefined;
+  /**
+   * Property location identifier
+   */
+  locationId: string;
+  /**
+   * Override property type from fetched data
+   */
+  propertyType?: PropertyType | undefined;
+  /**
+   * Whether to rate the input price against estimated market value
+   */
+  ratePrice?: boolean | undefined;
+  /**
+   * Type of transaction - sale or rental valuation
+   */
+  transactionType?: TransactionType | undefined;
+  /**
+   * Override year the property was built
+   */
+  yearBuilt?: number | undefined;
+};
+
+/** @internal */
+export const Condition$outboundSchema: z.ZodNativeEnum<typeof Condition> = z
+  .nativeEnum(Condition);
+
+/** @internal */
+export const Epc$outboundSchema: z.ZodNativeEnum<typeof Epc> = z.nativeEnum(
+  Epc,
+);
+
+/** @internal */
+export const PropertyType$outboundSchema: z.ZodNativeEnum<typeof PropertyType> =
+  z.nativeEnum(PropertyType);
+
+/** @internal */
+export const TransactionType$outboundSchema: z.ZodNativeEnum<
+  typeof TransactionType
+> = z.nativeEnum(TransactionType);
+
+/** @internal */
+export type AVMPredictByLocationRequest$Outbound = {
+  baths?: number | undefined;
+  beds?: number | undefined;
+  condition?: string | undefined;
+  epc?: string | undefined;
+  floorArea?: number | undefined;
+  inputPrice?: number | undefined;
+  listingPrice?: number | undefined;
+  locationId: string;
+  propertyType?: string | undefined;
+  ratePrice?: boolean | undefined;
+  transactionType: string;
+  yearBuilt?: number | undefined;
+};
+
+/** @internal */
+export const AVMPredictByLocationRequest$outboundSchema: z.ZodType<
+  AVMPredictByLocationRequest$Outbound,
+  z.ZodTypeDef,
+  AVMPredictByLocationRequest
+> = z.object({
+  baths: z.number().int().optional(),
+  beds: z.number().int().optional(),
+  condition: Condition$outboundSchema.optional(),
+  epc: Epc$outboundSchema.optional(),
+  floorArea: z.number().optional(),
+  inputPrice: z.number().optional(),
+  listingPrice: z.number().optional(),
+  locationId: z.string(),
+  propertyType: PropertyType$outboundSchema.optional(),
+  ratePrice: z.boolean().optional(),
+  transactionType: TransactionType$outboundSchema.default("sale"),
+  yearBuilt: z.number().int().optional(),
+});
+
+export function avmPredictByLocationRequestToJSON(
+  avmPredictByLocationRequest: AVMPredictByLocationRequest,
+): string {
+  return JSON.stringify(
+    AVMPredictByLocationRequest$outboundSchema.parse(
+      avmPredictByLocationRequest,
+    ),
+  );
+}

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

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * Property condition
  */
-export const Condition = {
+export const AVMPredictRequestCondition = {
   Poor: "poor",
   Average: "average",
   Good: "good",
@@ -18,12 +18,14 @@ export const Condition = {
 /**
  * Property condition
  */
-export type Condition = ClosedEnum<typeof Condition>;
+export type AVMPredictRequestCondition = ClosedEnum<
+  typeof AVMPredictRequestCondition
+>;
 
 /**
  * Energy Performance Certificate rating
  */
-export const Epc = {
+export const AVMPredictRequestEpc = {
   A: "A",
   B: "B",
   C: "C",
@@ -35,35 +37,49 @@ export const Epc = {
 /**
  * Energy Performance Certificate rating
  */
-export type Epc = ClosedEnum<typeof Epc>;
+export type AVMPredictRequestEpc = ClosedEnum<typeof AVMPredictRequestEpc>;
 
 /**
- * Type of property
+ * Type of property. Additional types (maisonette, cottage, etc.) are automatically mapped to core ML model types for prediction.
  */
-export const PropertyType = {
+export const AVMPredictRequestPropertyType = {
   Detached: "detached",
   SemiDetached: "semiDetached",
   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>;
+export type AVMPredictRequestPropertyType = ClosedEnum<
+  typeof AVMPredictRequestPropertyType
+>;
 
 /**
  * Type of transaction - sale or rental valuation
  */
-export const TransactionType = {
+export const AVMPredictRequestTransactionType = {
   Sale: "sale",
   Rent: "rent",
 } as const;
 /**
  * Type of transaction - sale or rental valuation
  */
-export type TransactionType = ClosedEnum<typeof TransactionType>;
+export type AVMPredictRequestTransactionType = ClosedEnum<
+  typeof AVMPredictRequestTransactionType
+>;
 
 export type AVMPredictRequest = {
   /**
@@ -77,11 +93,11 @@ export type AVMPredictRequest = {
   /**
    * Property condition
    */
-  condition?: Condition | undefined;
+  condition?: AVMPredictRequestCondition | undefined;
   /**
    * Energy Performance Certificate rating
    */
-  epc?: Epc | undefined;
+  epc?: AVMPredictRequestEpc | undefined;
   /**
    * Floor area in square metres
    */
@@ -107,9 +123,9 @@ 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;
+  propertyType: AVMPredictRequestPropertyType;
   /**
    * Whether to rate the input price against estimated market value
    */
@@ -117,7 +133,7 @@ export type AVMPredictRequest = {
   /**
    * Type of transaction - sale or rental valuation
    */
-  transactionType?: TransactionType | undefined;
+  transactionType?: AVMPredictRequestTransactionType | undefined;
   /**
    * Year the property was built
    */
@@ -125,22 +141,24 @@ export type AVMPredictRequest = {
 };
 
 /** @internal */
-export const Condition$outboundSchema: z.ZodNativeEnum<typeof Condition> = z
-  .nativeEnum(Condition);
+export const AVMPredictRequestCondition$outboundSchema: z.ZodNativeEnum<
+  typeof AVMPredictRequestCondition
+> = z.nativeEnum(AVMPredictRequestCondition);
 
 /** @internal */
-export const Epc$outboundSchema: z.ZodNativeEnum<typeof Epc> = z.nativeEnum(
-  Epc,
-);
+export const AVMPredictRequestEpc$outboundSchema: z.ZodNativeEnum<
+  typeof AVMPredictRequestEpc
+> = z.nativeEnum(AVMPredictRequestEpc);
 
 /** @internal */
-export const PropertyType$outboundSchema: z.ZodNativeEnum<typeof PropertyType> =
-  z.nativeEnum(PropertyType);
+export const AVMPredictRequestPropertyType$outboundSchema: z.ZodNativeEnum<
+  typeof AVMPredictRequestPropertyType
+> = z.nativeEnum(AVMPredictRequestPropertyType);
 
 /** @internal */
-export const TransactionType$outboundSchema: z.ZodNativeEnum<
-  typeof TransactionType
-> = z.nativeEnum(TransactionType);
+export const AVMPredictRequestTransactionType$outboundSchema: z.ZodNativeEnum<
+  typeof AVMPredictRequestTransactionType
+> = z.nativeEnum(AVMPredictRequestTransactionType);
 
 /** @internal */
 export type AVMPredictRequest$Outbound = {
@@ -168,17 +186,19 @@ export const AVMPredictRequest$outboundSchema: z.ZodType<
 > = z.object({
   baths: z.number().int().optional(),
   beds: z.number().int(),
-  condition: Condition$outboundSchema.optional(),
-  epc: Epc$outboundSchema.optional(),
+  condition: AVMPredictRequestCondition$outboundSchema.optional(),
+  epc: AVMPredictRequestEpc$outboundSchema.optional(),
   floorArea: z.number().optional(),
   inputPrice: z.number().optional(),
   latitude: z.number().optional(),
   listingPrice: z.number().optional(),
   longitude: z.number().optional(),
   postcode: z.string().optional(),
-  propertyType: PropertyType$outboundSchema,
+  propertyType: AVMPredictRequestPropertyType$outboundSchema,
   ratePrice: z.boolean().optional(),
-  transactionType: TransactionType$outboundSchema.default("sale"),
+  transactionType: AVMPredictRequestTransactionType$outboundSchema.default(
+    "sale",
+  ),
   yearBuilt: z.number().int().optional(),
 });
 

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

@@ -12,7 +12,7 @@ export type ChargeEntry = {
    * Confidence score (0-100)
    */
   confidence?: number | undefined;
-  currency?: string | undefined;
+  currency?: string | null | undefined;
   /**
    * Whether this value is an outlier
    */
@@ -42,7 +42,7 @@ export const ChargeEntry$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   confidence: z.number().optional(),
-  currency: z.string().optional(),
+  currency: z.nullable(z.string()).optional(),
   isOutlier: z.boolean().optional(),
   recordedDate: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)