@vepler/sdk 1.10.1 → 2.3.0

package/src/funcs/systemCheckEPCHealth.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 operations from "../sdk/models/operations/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * EPC service health check
+ *
+ * @remarks
+ * Check if the EPC service is operational
+ */
+export function systemCheckEPCHealth(
+  client: SDKCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.CheckEPCHealthResponseBody,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.CheckEPCHealthResponseBody,
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v1/epc/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: "checkEPCHealth",
+    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<
+    operations.CheckEPCHealthResponseBody,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.CheckEPCHealthResponseBody$inboundSchema),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/systemCheckListingsHealth.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 operations from "../sdk/models/operations/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Listings service health check
+ *
+ * @remarks
+ * Check if the listings service is operational
+ */
+export function systemCheckListingsHealth(
+  client: SDKCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.CheckListingsHealthResponseBody,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.CheckListingsHealthResponseBody,
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v1/listings/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: "checkListingsHealth",
+    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<
+    operations.CheckListingsHealthResponseBody,
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.CheckListingsHealthResponseBody$inboundSchema),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/{healthCheckLocationHealth.ts → systemCheckLocationHealth.ts}

@@ -28,7 +28,7 @@ import { Result } from "../sdk/types/fp.js";
  * @remarks
  * Check if the location service is operational
  */
-export function healthCheckLocationHealth(
+export function systemCheckLocationHealth(
   client: SDKCore,
   options?: RequestOptions,
 ): APIPromise<
@@ -83,7 +83,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "checkLocationHealth",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/funcs/{healthCheckPlanningHealth.ts → systemCheckPlanningHealth.ts}

@@ -28,7 +28,7 @@ import { Result } from "../sdk/types/fp.js";
  * @remarks
  * Check if the planning service is operational
  */
-export function healthCheckPlanningHealth(
+export function systemCheckPlanningHealth(
   client: SDKCore,
   options?: RequestOptions,
 ): APIPromise<
@@ -83,7 +83,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "checkPlanningHealth",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/funcs/{healthCheckPropertyHealth.ts → systemCheckPropertyHealth.ts}

@@ -28,7 +28,7 @@ import { Result } from "../sdk/types/fp.js";
  * @remarks
  * Check if the property service is operational
  */
-export function healthCheckPropertyHealth(
+export function systemCheckPropertyHealth(
   client: SDKCore,
   options?: RequestOptions,
 ): APIPromise<
@@ -83,7 +83,7 @@ async function $do(
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
     operationID: "checkPropertyHealth",
-    oAuth2Scopes: [],
+    oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 

package/src/lib/base64.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
 export function bytesToBase64(u8arr: Uint8Array): string {
   return btoa(String.fromCodePoint(...u8arr));

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "1.10.1",
-  sdkVersion: "0.2.0",
-  genVersion: "2.716.16",
-  userAgent: "speakeasy-sdk/typescript 0.2.0 2.716.16 1.10.1 @vepler/sdk",
+  openapiDocVersion: "2.3.0",
+  sdkVersion: "0.5.0",
+  genVersion: "2.735.1",
+  userAgent: "speakeasy-sdk/typescript 0.5.0 2.735.1 2.3.0 @vepler/sdk",
 } as const;

package/src/lib/schemas.ts

@@ -9,7 +9,7 @@ import {
   ZodObject,
   ZodRawShape,
   ZodTypeAny,
-} from "zod";
+} from "zod/v3";
 import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
 import { ERR, OK, Result } from "../sdk/types/fp.js";
 

package/src/sdk/address.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { addressResolveAddress } from "../funcs/addressResolveAddress.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Address extends ClientSDK {
+  /**
+   * Resolve addresses to UPRNs with AI
+   *
+   * @remarks
+   * AI-powered address resolution that converts address strings to UPRNs (Unique Property Reference Numbers). Uses advanced LLM parsing to handle complex multi-unit addresses, ranges, incomplete addresses, and various formatting styles. Combines Elasticsearch search with intelligent postcode-based fallback for maximum accuracy.
+   */
+  async resolveAddress(
+    request?: operations.ResolveAddressRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ResolveAddressResponse> {
+    return unwrapAsync(addressResolveAddress(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/areas.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { areasGetAreas } from "../funcs/areasGetAreas.js";
+import { areasGetAreasWithin } from "../funcs/areasGetAreasWithin.js";
+import { areasGetBorderingAreas } from "../funcs/areasGetBorderingAreas.js";
+import { areasGetChildAreas } from "../funcs/areasGetChildAreas.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Areas extends ClientSDK {
+  /**
+   * Get geographic areas by field and IDs
+   *
+   * @remarks
+   * Retrieve geographic areas by field type (postcode, ward, county, etc.) and comma-separated IDs. Optionally include geometry, relationships, and hierarchy data.
+   */
+  async getAreas(
+    request: operations.GetAreasByFieldAndIdsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetAreasByFieldAndIdsResponse> {
+    return unwrapAsync(areasGetAreas(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Find areas within a radius of a location
+   *
+   * @remarks
+   * Find geographic areas within a specified radius of a latitude/longitude point. Filter by area type and optionally include geometry data.
+   */
+  async getAreasWithin(
+    request: operations.GetAreasWithinRadiusRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetAreasWithinRadiusResponse> {
+    return unwrapAsync(areasGetAreasWithin(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Find areas that border a target area
+   *
+   * @remarks
+   * Find all areas of a specified type that share a border with the target area.
+   */
+  async getBorderingAreas(
+    request: operations.GetBorderingAreasRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetBorderingAreasResponse> {
+    return unwrapAsync(areasGetBorderingAreas(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get child areas within a parent area
+   *
+   * @remarks
+   * Retrieve all child areas contained within a parent geographic area. Optionally filter by child type using the childType query parameter.
+   */
+  async getChildAreas(
+    request: operations.GetChildAreasRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetChildAreasResponse> {
+    return unwrapAsync(areasGetChildAreas(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/connectivity.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { connectivityGetConnectivityScores } from "../funcs/connectivityGetConnectivityScores.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Connectivity extends ClientSDK {
+  /**
+   * Get broadband and mobile connectivity scores
+   *
+   * @remarks
+   * Retrieve connectivity scores for one or more geographic areas, including fixed broadband and mobile coverage data. Supports historical data and detailed breakdowns.
+   */
+  async getConnectivityScores(
+    request: operations.GetConnectivityScoresRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetConnectivityScoresResponse> {
+    return unwrapAsync(connectivityGetConnectivityScores(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/epc.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { epcGetEPC } from "../funcs/epcGetEPC.js";
+import { epcGetEPCByPostcode } from "../funcs/epcGetEPCByPostcode.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Epc extends ClientSDK {
+  /**
+   * Get EPC certificate by location ID
+   *
+   * @remarks
+   * Retrieve Energy Performance Certificate data for a property by its location ID (UPRN). Coming soon - currently returns 501 Not Implemented.
+   */
+  async getEPC(
+    request: operations.GetEPCByLocationIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetEPCByLocationIdResponse> {
+    return unwrapAsync(epcGetEPC(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get EPC certificates by postcode
+   *
+   * @remarks
+   * Retrieve Energy Performance Certificates for all properties in a specific postcode. Coming soon - currently returns 501 Not Implemented.
+   */
+  async getEPCByPostcode(
+    request: operations.GetEPCByPostcodeRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetEPCByPostcodeResponse> {
+    return unwrapAsync(epcGetEPCByPostcode(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/listings.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { listingsGetListingById } from "../funcs/listingsGetListingById.js";
+import { listingsGetListingBySource } from "../funcs/listingsGetListingBySource.js";
+import { listingsGetListingsByLocation } from "../funcs/listingsGetListingsByLocation.js";
+import { listingsQueryListings } from "../funcs/listingsQueryListings.js";
+import { listingsQueryListingsBySource } from "../funcs/listingsQueryListingsBySource.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Listings extends ClientSDK {
+  /**
+   * Get listing by ID
+   *
+   * @remarks
+   * Retrieve a single property listing by its unique identifier
+   */
+  async getListingById(
+    request: operations.GetListingByIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetListingByIdResponse> {
+    return unwrapAsync(listingsGetListingById(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get listing by provider and key
+   *
+   * @remarks
+   * Retrieve a property listing by its provider identifier and key. Optionally aggregate data from multiple sources.
+   */
+  async getListingBySource(
+    request: operations.GetListingBySourceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetListingBySourceResponse> {
+    return unwrapAsync(listingsGetListingBySource(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get listings by location ID
+   *
+   * @remarks
+   * Retrieve property listings by location identifier(s). Supports comma-separated location IDs for batch queries. Can aggregate listings from multiple sources.
+   */
+  async getListingsByLocation(
+    request: operations.GetListingsByLocationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetListingsByLocationResponse> {
+    return unwrapAsync(listingsGetListingsByLocation(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query listings with filters
+   *
+   * @remarks
+   * Search for property listings using various filters including location, provider, status, and ordering. Supports pagination with limit and offset parameters.
+   */
+  async queryListings(
+    request?: operations.QueryListingsRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.QueryListingsResponse> {
+    return unwrapAsync(listingsQueryListings(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query listings by provider and keys
+   *
+   * @remarks
+   * Retrieve multiple listings from a specific provider using their keys. Queries aggregated data from Elasticsearch. Supports up to 500 keys per request.
+   */
+  async queryListingsBySource(
+    request?: operations.QueryListingsBySourceRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.QueryListingsBySourceResponse> {
+    return unwrapAsync(listingsQueryListingsBySource(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/metrics.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { metricsGetMetricValues } from "../funcs/metricsGetMetricValues.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Metrics extends ClientSDK {
+  /**
+   * Get metric values for geographic areas
+   *
+   * @remarks
+   * Retrieve metric values for geographic areas. Filter by geographic code, metric ID, time period, and other parameters.
+   */
+  async getMetricValues(
+    request?: operations.GetMetricValuesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.GetMetricValuesResponse> {
+    return unwrapAsync(metricsGetMetricValues(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/models/errors/responsevalidationerror.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { SDKBaseError } from "./sdkbaseerror.js";
 import { formatZodError } from "./sdkvalidationerror.js";