@vepler/sdk 2.6.6 → 2.8.0

package/src/funcs/systemCheckSearchHealth.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Search service health check
+ *
+ * @remarks
+ * Check if the search service is operational
+ */
+export function systemCheckSearchHealth(
+  client: SDKCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.HealthResponse,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.HealthResponse,
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v1/search/health")();
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "checkSearchHealth",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    shared.HealthResponse,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.HealthResponse$inboundSchema),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.6.6",
-  sdkVersion: "0.6.1",
-  genVersion: "2.748.0",
-  userAgent: "speakeasy-sdk/typescript 0.6.1 2.748.0 2.6.6 @vepler/sdk",
+  openapiDocVersion: "2.8.0",
+  sdkVersion: "0.7.0",
+  genVersion: "2.755.9",
+  userAgent: "speakeasy-sdk/typescript 0.7.0 2.755.9 2.8.0 @vepler/sdk",
 } as const;

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

@@ -43,3 +43,4 @@ export * from "./searchproperties.js";
 export * from "./searchschoolsnearby.js";
 export * from "./searchschoolswithin.js";
 export * from "./searchstreets.js";
+export * from "./searchsuggest.js";

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/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)

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

@@ -13,7 +13,7 @@ export type ChargeHistory = {
    * Overall confidence in current value
    */
   confidence?: number | undefined;
-  currency?: string | undefined;
+  currency?: string | null | undefined;
   current?: number | null | undefined;
   /**
    * Historical charge records
@@ -32,7 +32,7 @@ export const ChargeHistory$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   confidence: z.number().optional(),
-  currency: z.string().optional(),
+  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))

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

@@ -8,11 +8,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CouncilTaxBandDetails = {
-  annualAmount?: number | undefined;
-  effectiveFrom?: string | undefined;
+  annualAmount?: number | null | undefined;
+  effectiveFrom?: string | null | undefined;
   effectiveTo?: string | null | undefined;
-  id?: number | undefined;
-  taxYear?: string | undefined;
+  id?: number | null | undefined;
+  taxYear?: string | null | undefined;
 };
 
 /** @internal */
@@ -21,11 +21,11 @@ export const CouncilTaxBandDetails$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  annualAmount: z.number().optional(),
-  effectiveFrom: z.string().optional(),
+  annualAmount: z.nullable(z.number()).optional(),
+  effectiveFrom: z.nullable(z.string()).optional(),
   effectiveTo: z.nullable(z.string()).optional(),
-  id: z.number().optional(),
-  taxYear: z.string().optional(),
+  id: z.nullable(z.number()).optional(),
+  taxYear: z.nullable(z.string()).optional(),
 });
 
 export function councilTaxBandDetailsFromJSON(

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

@@ -31,14 +31,14 @@ export const PotentialEnergyRating = {
 export type PotentialEnergyRating = ClosedEnum<typeof PotentialEnergyRating>;
 
 export type EPCData = {
-  currentEnergyEfficiency?: number | undefined;
+  currentEnergyEfficiency?: number | null | undefined;
   currentEnergyRating?: CurrentEnergyRating | undefined;
-  heatingCostCurrent?: number | undefined;
-  heatingCostPotential?: number | undefined;
-  hotWaterCostCurrent?: number | undefined;
-  hotWaterCostPotential?: number | undefined;
-  mainHeatingControls?: string | undefined;
-  potentialEnergyEfficiency?: number | undefined;
+  heatingCostCurrent?: number | null | undefined;
+  heatingCostPotential?: number | null | undefined;
+  hotWaterCostCurrent?: number | null | undefined;
+  hotWaterCostPotential?: number | null | undefined;
+  mainHeatingControls?: string | null | undefined;
+  potentialEnergyEfficiency?: number | null | undefined;
   potentialEnergyRating?: PotentialEnergyRating | undefined;
 };
 
@@ -55,14 +55,14 @@ export const PotentialEnergyRating$inboundSchema: z.ZodNativeEnum<
 /** @internal */
 export const EPCData$inboundSchema: z.ZodType<EPCData, z.ZodTypeDef, unknown> =
   z.object({
-    currentEnergyEfficiency: z.number().optional(),
+    currentEnergyEfficiency: z.nullable(z.number()).optional(),
     currentEnergyRating: CurrentEnergyRating$inboundSchema.optional(),
-    heatingCostCurrent: z.number().optional(),
-    heatingCostPotential: z.number().optional(),
-    hotWaterCostCurrent: z.number().optional(),
-    hotWaterCostPotential: z.number().optional(),
-    mainHeatingControls: z.string().optional(),
-    potentialEnergyEfficiency: z.number().optional(),
+    heatingCostCurrent: z.nullable(z.number()).optional(),
+    heatingCostPotential: z.nullable(z.number()).optional(),
+    hotWaterCostCurrent: z.nullable(z.number()).optional(),
+    hotWaterCostPotential: z.nullable(z.number()).optional(),
+    mainHeatingControls: z.nullable(z.string()).optional(),
+    potentialEnergyEfficiency: z.nullable(z.number()).optional(),
     potentialEnergyRating: PotentialEnergyRating$inboundSchema.optional(),
   });
 

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

@@ -46,6 +46,9 @@ export * from "./refurbishmentdata.js";
 export * from "./roomdetails.js";
 export * from "./salerecord.js";
 export * from "./school.js";
+export * from "./searchhighlight.js";
+export * from "./searchresponse.js";
+export * from "./searchresult.js";
 export * from "./security.js";
 export * from "./streetdescriptor.js";
 export * from "./streetdetails.js";

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

@@ -11,7 +11,7 @@ export type Lease = {
   alienationClause?: boolean | undefined;
   dateOfLease?: string | null | undefined;
   expiryDate?: string | null | undefined;
-  leaseType?: string | undefined;
+  leaseType?: string | null | undefined;
 };
 
 /** @internal */
@@ -20,7 +20,7 @@ export const Lease$inboundSchema: z.ZodType<Lease, z.ZodTypeDef, unknown> = z
     alienationClause: z.boolean().optional(),
     dateOfLease: z.nullable(z.string()).optional(),
     expiryDate: z.nullable(z.string()).optional(),
-    leaseType: z.string().optional(),
+    leaseType: z.nullable(z.string()).optional(),
   });
 
 export function leaseFromJSON(

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

@@ -48,7 +48,7 @@ export type Pricing = {
   /**
    * Currency code
    */
-  currency?: string | undefined;
+  currency?: string | null | undefined;
   /**
    * Estimated price in pence
    */
@@ -56,7 +56,7 @@ export type Pricing = {
   /**
    * Listed price in pence
    */
-  price?: number | undefined;
+  price?: number | null | undefined;
 };
 
 /**
@@ -66,11 +66,11 @@ export type Seller = {
   /**
    * Property Agent Identifier (PAID)
    */
-  paid?: string | undefined;
+  paid?: string | null | undefined;
   /**
    * Seller/agent name
    */
-  name?: string | undefined;
+  name?: string | null | undefined;
 };
 
 /**
@@ -195,9 +195,9 @@ export function featuresFromJSON(
 /** @internal */
 export const Pricing$inboundSchema: z.ZodType<Pricing, z.ZodTypeDef, unknown> =
   z.object({
-    currency: z.string().optional(),
+    currency: z.nullable(z.string()).optional(),
     estimated: z.nullable(z.number()).optional(),
-    price: z.number().optional(),
+    price: z.nullable(z.number()).optional(),
   });
 
 export function pricingFromJSON(
@@ -213,8 +213,8 @@ export function pricingFromJSON(
 /** @internal */
 export const Seller$inboundSchema: z.ZodType<Seller, z.ZodTypeDef, unknown> = z
   .object({
-    PAID: z.string().optional(),
-    name: z.string().optional(),
+    PAID: z.nullable(z.string()).optional(),
+    name: z.nullable(z.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "PAID": "paid",

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

@@ -11,7 +11,7 @@ export type ListingImage = {
   /**
    * Image URL
    */
-  url?: string | undefined;
+  url?: string | null | undefined;
 };
 
 /** @internal */
@@ -20,7 +20,7 @@ export const ListingImage$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  url: z.string().optional(),
+  url: z.nullable(z.string()).optional(),
 });
 
 export function listingImageFromJSON(