@vepler/sdk 2.151.0 → 2.154.1

package/src/funcs/floodRiskPoint.ts

@@ -0,0 +1,199 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 * as errors from "../sdk/models/errors/index.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";
+
+/**
+ * Coordinate-exact flood-risk assessment
+ *
+ * @remarks
+ * Returns a property-level flood-risk assessment for a single (lat, lon) coordinate, from the Environment Agency National Flood Risk Assessment 2 (NaFRA-2).
+ *
+ * Separates the two real sources — Rivers & Sea (with depth-if-it-floods) and Surface Water (with hazard and flow velocity) — and reports present-day risk plus, where it differs, the climate-change 2080 outlook. Flood planning zone and nearby defences are included when present.
+ *
+ * Every response carries a `dataAvailability` field stating whether the point was assessed, falls outside modelled flood extents, or isn't yet covered (Scotland and Wales). Missing data is never reported as a green all-clear: `overallRiskLevel` is null when not assessed, and unbacked concerns (insurance, groundwater, reservoir, historic flooding) are omitted rather than synthesised.
+ */
+export function floodRiskPoint(
+  client: SDKCore,
+  request?: shared.FloodRiskPointRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.FloodRiskPoint,
+    | errors.QueryFloodRiskPointResponseBody
+    | errors.QueryFloodRiskPointFloodRiskResponseBody
+    | errors.QueryFloodRiskPointFloodRiskResponseResponseBody
+    | errors.QueryFloodRiskPointFloodRiskResponse503ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request?: shared.FloodRiskPointRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.FloodRiskPoint,
+      | errors.QueryFloodRiskPointResponseBody
+      | errors.QueryFloodRiskPointFloodRiskResponseBody
+      | errors.QueryFloodRiskPointFloodRiskResponseResponseBody
+      | errors.QueryFloodRiskPointFloodRiskResponse503ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      shared.FloodRiskPointRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = payload === undefined
+    ? null
+    : encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/flood-risk/point")();
+
+  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: "queryFloodRiskPoint",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    shared.FloodRiskPoint,
+    | errors.QueryFloodRiskPointResponseBody
+    | errors.QueryFloodRiskPointFloodRiskResponseBody
+    | errors.QueryFloodRiskPointFloodRiskResponseResponseBody
+    | errors.QueryFloodRiskPointFloodRiskResponse503ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.FloodRiskPoint$inboundSchema),
+    M.jsonErr(400, errors.QueryFloodRiskPointResponseBody$inboundSchema),
+    M.jsonErr(
+      404,
+      errors.QueryFloodRiskPointFloodRiskResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.QueryFloodRiskPointFloodRiskResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      503,
+      errors.QueryFloodRiskPointFloodRiskResponse503ResponseBody$inboundSchema,
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/searchSearchSuggest.ts

@@ -101,6 +101,7 @@ async function $do(
   const path = pathToFunc("/v1/search/suggest")();
 
   const query = encodeFormQuery({
+    "addressable_only": payload.addressable_only,
     "classification": payload.classification,
     "geo_mode": payload.geo_mode,
     "lat": payload.lat,

package/src/hooks/types.ts

@@ -15,6 +15,7 @@ export type HookContext = {
   retryConfig: RetryConfig;
   resolvedSecurity: SecurityState | null;
   options: SDKOptions;
+  timeoutMs?: number;
 };
 
 export type Awaitable<T> = T | Promise<T>;

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.151.0",
+  openapiDocVersion: "2.154.1",
   sdkVersion: "0.10.0",
-  genVersion: "2.893.0",
-  userAgent: "speakeasy-sdk/typescript 0.10.0 2.893.0 2.151.0 @vepler/sdk",
+  genVersion: "2.897.1",
+  userAgent: "speakeasy-sdk/typescript 0.10.0 2.897.1 2.154.1 @vepler/sdk",
 } as const;

package/src/lib/sdks.ts

@@ -23,6 +23,7 @@ import {
   matchContentType,
 } from "./http.js";
 import { Logger } from "./logger.js";
+import { combineSignals } from "./primitives.js";
 import { retry, RetryConfig } from "./retries.js";
 import { SecurityState } from "./security.js";
 
@@ -194,9 +195,8 @@ export class ClientSDK {
       ...options?.fetchOptions,
       ...options,
     };
-    if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) {
-      const timeoutSignal = AbortSignal.timeout(conf.timeoutMs);
-      fetchOptions.signal = timeoutSignal;
+    if (!fetchOptions?.signal && conf.timeoutMs != null && conf.timeoutMs > 0) {
+      context.timeoutMs = conf.timeoutMs;
     }
 
     if (conf.body instanceof ReadableStream) {
@@ -243,10 +243,19 @@ export class ClientSDK {
     >
   > {
     const { context, isErrorStatusCode } = options;
+    const timeoutMs = context.timeoutMs;
 
     return retry(
       async () => {
-        const req = await this.#hooks.beforeRequest(context, request.clone());
+        const cloned = request.clone();
+        let attempt = cloned;
+        if (timeoutMs != null && timeoutMs > 0) {
+          const timeoutSignal = AbortSignal.timeout(timeoutMs);
+          const combined = combineSignals(cloned.signal, timeoutSignal)
+            ?? timeoutSignal;
+          attempt = new Request(cloned, { signal: combined });
+        }
+        const req = await this.#hooks.beforeRequest(context, attempt);
         await logRequest(this.#logger, req).catch((e) =>
           this.#logger?.log("Failed to log request:", e)
         );

package/src/sdk/floodrisk.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { floodRiskPoint } from "../funcs/floodRiskPoint.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class FloodRisk extends ClientSDK {
+  /**
+   * Coordinate-exact flood-risk assessment
+   *
+   * @remarks
+   * Returns a property-level flood-risk assessment for a single (lat, lon) coordinate, from the Environment Agency National Flood Risk Assessment 2 (NaFRA-2).
+   *
+   * Separates the two real sources — Rivers & Sea (with depth-if-it-floods) and Surface Water (with hazard and flow velocity) — and reports present-day risk plus, where it differs, the climate-change 2080 outlook. Flood planning zone and nearby defences are included when present.
+   *
+   * Every response carries a `dataAvailability` field stating whether the point was assessed, falls outside modelled flood extents, or isn't yet covered (Scotland and Wales). Missing data is never reported as a green all-clear: `overallRiskLevel` is null when not assessed, and unbacked concerns (insurance, groundwater, reservoir, historic flooding) are omitted rather than synthesised.
+   */
+  async point(
+    request?: shared.FloodRiskPointRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.FloodRiskPoint> {
+    return unwrapAsync(floodRiskPoint(
+      this,
+      request,
+      options,
+    ));
+  }
+}

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

@@ -108,6 +108,7 @@ export * from "./queryairquality.js";
 export * from "./queryairqualitypoint.js";
 export * from "./querycompanies.js";
 export * from "./queryepc.js";
+export * from "./queryfloodriskpoint.js";
 export * from "./querylistings.js";
 export * from "./querylistingsadvanced.js";
 export * from "./querylistingsbysource.js";