@vepler/sdk 2.6.6 → 2.9.0

package/src/funcs/avmPredictPropertyValueByLocation.ts

@@ -0,0 +1,178 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.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 operations from "../sdk/models/operations/index.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";
+
+/**
+ * Predict property value by location ID
+ *
+ * @remarks
+ * Get an automated valuation for a property using its location ID. We'll retrieve the property details and generate an accurate valuation with confidence intervals. You can optionally override any property characteristics to see how they affect the valuation.
+ */
+export function avmPredictPropertyValueByLocation(
+  client: SDKCore,
+  request: shared.AVMPredictByLocationRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.PredictPropertyValueByLocationResponse,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: shared.AVMPredictByLocationRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.PredictPropertyValueByLocationResponse,
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => shared.AVMPredictByLocationRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/avm/predict-by-location")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: "predictPropertyValueByLocation",
+    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: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    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<
+    operations.PredictPropertyValueByLocationResponse,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.PredictPropertyValueByLocationResponse$inboundSchema,
+    ),
+    M.json(
+      400,
+      operations.PredictPropertyValueByLocationResponse$inboundSchema,
+    ),
+    M.json(
+      404,
+      operations.PredictPropertyValueByLocationResponse$inboundSchema,
+    ),
+    M.json(
+      422,
+      operations.PredictPropertyValueByLocationResponse$inboundSchema,
+    ),
+    M.json(
+      500,
+      operations.PredictPropertyValueByLocationResponse$inboundSchema,
+    ),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/{epcGetEPCByPostcode.ts → roaVerifyROA.ts}

@@ -3,7 +3,7 @@
  */
 
 import { SDKCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeJSON } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -21,22 +21,23 @@ import { ResponseValidationError } from "../sdk/models/errors/responsevalidation
 import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
 import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
 import * as operations from "../sdk/models/operations/index.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";
 
 /**
- * Get EPC certificates by postcode
+ * Verify Registered Office Address
  *
  * @remarks
- * Retrieve Energy Performance Certificates for all properties in a specific postcode. Coming soon - currently returns 501 Not Implemented.
+ * Comprehensive Registered Office Address (ROA) verification service for Companies House compliance. Performs address resolution, appropriateness checks, fraud risk analysis, and right-to-use inference. Returns detailed breakdown of all checks and scores for transparent decision-making.
  */
-export function epcGetEPCByPostcode(
+export function roaVerifyROA(
   client: SDKCore,
-  request: operations.GetEPCByPostcodeRequest,
+  request?: shared.RoaVerifyRequest | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetEPCByPostcodeResponse,
+    operations.VerifyRoaResponse,
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -56,12 +57,12 @@ export function epcGetEPCByPostcode(
 
 async function $do(
   client: SDKCore,
-  request: operations.GetEPCByPostcodeRequest,
+  request?: shared.RoaVerifyRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.GetEPCByPostcodeResponse,
+      operations.VerifyRoaResponse,
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -76,25 +77,21 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.GetEPCByPostcodeRequest$outboundSchema.parse(value),
+    (value) => shared.RoaVerifyRequest$outboundSchema.optional().parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = null;
+  const body = payload === undefined
+    ? null
+    : encodeJSON("body", payload, { explode: true });
 
-  const pathParams = {
-    postcode: encodeSimple("postcode", payload.postcode, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-  };
-
-  const path = pathToFunc("/v1/epc/postcode/{postcode}")(pathParams);
+  const path = pathToFunc("/v1/roa/verify")();
 
   const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
     Accept: "application/json",
   }));
 
@@ -105,7 +102,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getEPCByPostcode",
+    operationID: "verifyRoa",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -119,7 +116,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "GET",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
@@ -144,7 +141,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetEPCByPostcodeResponse,
+    operations.VerifyRoaResponse,
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -154,8 +151,9 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetEPCByPostcodeResponse$inboundSchema),
-    M.json(501, operations.GetEPCByPostcodeResponse$inboundSchema),
+    M.json(200, operations.VerifyRoaResponse$inboundSchema),
+    M.json([400, 401], operations.VerifyRoaResponse$inboundSchema),
+    M.json([500, 503], operations.VerifyRoaResponse$inboundSchema),
   )(response, req);
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/{epcGetEPC.ts → searchSearchSuggest.ts}

@@ -3,7 +3,7 @@
  */
 
 import { SDKCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -25,18 +25,18 @@ import { APICall, APIPromise } from "../sdk/types/async.js";
 import { Result } from "../sdk/types/fp.js";
 
 /**
- * Get EPC certificate by location ID
+ * Autocomplete search for UK addresses and locations
  *
  * @remarks
- * Retrieve Energy Performance Certificate data for a property by its location ID (UPRN). Coming soon - currently returns 501 Not Implemented.
+ * Simple autocomplete for UK properties and locations. Searches across Address and Location sources with fuzzy matching. Automatically detects query type (postcode, address, place name) and returns suggestions.
  */
-export function epcGetEPC(
+export function searchSearchSuggest(
   client: SDKCore,
-  request: operations.GetEPCByLocationIdRequest,
+  request: operations.SearchSuggestRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetEPCByLocationIdResponse,
+    operations.SearchSuggestResponse,
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -56,12 +56,12 @@ export function epcGetEPC(
 
 async function $do(
   client: SDKCore,
-  request: operations.GetEPCByLocationIdRequest,
+  request: operations.SearchSuggestRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.GetEPCByLocationIdResponse,
+      operations.SearchSuggestResponse,
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -76,7 +76,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.GetEPCByLocationIdRequest$outboundSchema.parse(value),
+    (value) => operations.SearchSuggestRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -85,14 +85,14 @@ async function $do(
   const payload = parsed.value;
   const body = null;
 
-  const pathParams = {
-    locationId: encodeSimple("locationId", payload.locationId, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-  };
+  const path = pathToFunc("/v1/search/suggest")();
 
-  const path = pathToFunc("/v1/epc/{locationId}")(pathParams);
+  const query = encodeFormQuery({
+    "limit": payload.limit,
+    "offset": payload.offset,
+    "q": payload.q,
+    "source": payload.source,
+  });
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -105,7 +105,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getEPCByLocationId",
+    operationID: "searchSuggest",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -123,6 +123,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
@@ -144,7 +145,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetEPCByLocationIdResponse,
+    operations.SearchSuggestResponse,
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -154,9 +155,9 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetEPCByLocationIdResponse$inboundSchema),
-    M.json(404, operations.GetEPCByLocationIdResponse$inboundSchema),
-    M.json(501, operations.GetEPCByLocationIdResponse$inboundSchema),
+    M.json(200, operations.SearchSuggestResponse$inboundSchema),
+    M.json(400, operations.SearchSuggestResponse$inboundSchema),
+    M.json(500, operations.SearchSuggestResponse$inboundSchema),
   )(response, req);
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

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.9.0",
+  sdkVersion: "0.7.0",
+  genVersion: "2.760.2",
+  userAgent: "speakeasy-sdk/typescript 0.7.0 2.760.2 2.9.0 @vepler/sdk",
 } as const;

package/src/sdk/avm.ts

@@ -3,6 +3,7 @@
  */
 
 import { avmPredictPropertyValue } from "../funcs/avmPredictPropertyValue.js";
+import { avmPredictPropertyValueByLocation } from "../funcs/avmPredictPropertyValueByLocation.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
@@ -13,7 +14,7 @@ export class Avm extends ClientSDK {
    * Predict property value
    *
    * @remarks
-   * Get an automated valuation for a property based on its characteristics and location. The AVM uses ensemble machine learning models (Neural Networks, XGBoost, LightGBM) to provide accurate property valuations with confidence intervals.
+   * Get an automated valuation for a property based on its characteristics and location. Receive accurate property valuations with confidence intervals powered by advanced machine learning.
    */
   async predictPropertyValue(
     request: shared.AVMPredictRequest,
@@ -25,4 +26,21 @@ export class Avm extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Predict property value by location ID
+   *
+   * @remarks
+   * Get an automated valuation for a property using its location ID. We'll retrieve the property details and generate an accurate valuation with confidence intervals. You can optionally override any property characteristics to see how they affect the valuation.
+   */
+  async predictPropertyValueByLocation(
+    request: shared.AVMPredictByLocationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PredictPropertyValueByLocationResponse> {
+    return unwrapAsync(avmPredictPropertyValueByLocation(
+      this,
+      request,
+      options,
+    ));
+  }
 }

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

@@ -11,8 +11,6 @@ export * from "./getareaswithinradius.js";
 export * from "./getborderingareas.js";
 export * from "./getchildareas.js";
 export * from "./getconnectivityscores.js";
-export * from "./getepcbylocationid.js";
-export * from "./getepcbypostcode.js";
 export * from "./getlistingbyid.js";
 export * from "./getlistingbysource.js";
 export * from "./getlistingsbylocation.js";
@@ -35,6 +33,7 @@ export * from "./getv1safetycrime.js";
 export * from "./getv1safetycrimestats.js";
 export * from "./listschools.js";
 export * from "./predictpropertyvalue.js";
+export * from "./predictpropertyvaluebylocation.js";
 export * from "./querylistings.js";
 export * from "./querylistingsbysource.js";
 export * from "./resolveaddress.js";
@@ -43,3 +42,5 @@ export * from "./searchproperties.js";
 export * from "./searchschoolsnearby.js";
 export * from "./searchschoolswithin.js";
 export * from "./searchstreets.js";
+export * from "./searchsuggest.js";
+export * from "./verifyroa.js";