@vepler/sdk 2.39.0 → 2.45.0

package/src/funcs/planningPolicySearch.ts

@@ -0,0 +1,185 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.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";
+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 operations from "../sdk/models/operations/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Search planning policy rules
+ *
+ * @remarks
+ * Hybrid search across extracted planning rules and document chunks using vector similarity, keyword matching, and reciprocal rank fusion. Returns rules with full provenance (source, page, section).
+ */
+export function planningPolicySearch(
+  client: SDKCore,
+  request: operations.SearchPlanningPolicyRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.SearchPlanningPolicyResponseBody,
+    | errors.SearchPlanningPolicyResponseBody
+    | errors.SearchPlanningPolicyPlanningPolicyResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.SearchPlanningPolicyRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SearchPlanningPolicyResponseBody,
+      | errors.SearchPlanningPolicyResponseBody
+      | errors.SearchPlanningPolicyPlanningPolicyResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.SearchPlanningPolicyRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v1/planning-policy/search")();
+
+  const query = encodeFormQuery({
+    "council": payload.council,
+    "limit": payload.limit,
+    "q": payload.q,
+    "rule_type": payload.rule_type,
+    "source_type": payload.source_type,
+  });
+
+  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: "searchPlanningPolicy",
+    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,
+    query: query,
+    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: ["400", "4XX", "500", "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<
+    operations.SearchPlanningPolicyResponseBody,
+    | errors.SearchPlanningPolicyResponseBody
+    | errors.SearchPlanningPolicyPlanningPolicyResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.SearchPlanningPolicyResponseBody$inboundSchema),
+    M.jsonErr(400, errors.SearchPlanningPolicyResponseBody$inboundSchema),
+    M.jsonErr(
+      500,
+      errors.SearchPlanningPolicyPlanningPolicyResponseBody$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/propertySearchProperties.ts

@@ -29,7 +29,10 @@ import { Result } from "../sdk/types/fp.js";
  * Query properties with advanced filters
  *
  * @remarks
- * Search for properties using location, price, and other criteria
+ * Search for properties using location, price, and other criteria. By default, only residential properties are returned. To include commercial properties, add a `propertyCategory` condition to your query:
+ *
+ * - Commercial only: `{ "field": "propertyCategory", "comparator": "eq", "value": "commercial" }`
+ * - All categories: omit the default by adding `{ "field": "propertyCategory", "comparator": "exists" }`
  */
 export function propertySearchProperties(
   client: SDKCore,

package/src/funcs/safetyGetV1SafetyCrime.ts

@@ -22,6 +22,7 @@ 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";
 
@@ -29,7 +30,7 @@ import { Result } from "../sdk/types/fp.js";
  * Get crime data near location
  *
  * @remarks
- * Retrieve individual crime incidents recorded within a specified radius of the given coordinates. Data is sourced from police.uk street-level crime records covering England and Wales. Incident locations are anonymised by police.uk to a nearby map point (accurate to ~150m). Data is published monthly with an approximate 2-month lag. Use the /crime/stats endpoint for aggregated statistics and safety scores instead of raw incidents.
+ * Retrieve crime incidents within a specified radius of coordinates
  */
 export function safetyGetV1SafetyCrime(
   client: SDKCore,
@@ -37,7 +38,7 @@ export function safetyGetV1SafetyCrime(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetV1SafetyCrimeResponseBody,
+    shared.CrimeDataResponse,
     | errors.GetV1SafetyCrimeResponseBody
     | errors.GetV1SafetyCrimeSafetyResponseBody
     | SDKBaseError
@@ -64,7 +65,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetV1SafetyCrimeResponseBody,
+      shared.CrimeDataResponse,
       | errors.GetV1SafetyCrimeResponseBody
       | errors.GetV1SafetyCrimeSafetyResponseBody
       | SDKBaseError
@@ -154,7 +155,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.GetV1SafetyCrimeResponseBody,
+    shared.CrimeDataResponse,
     | errors.GetV1SafetyCrimeResponseBody
     | errors.GetV1SafetyCrimeSafetyResponseBody
     | SDKBaseError
@@ -166,7 +167,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetV1SafetyCrimeResponseBody$inboundSchema),
+    M.json(200, shared.CrimeDataResponse$inboundSchema),
     M.jsonErr(400, errors.GetV1SafetyCrimeResponseBody$inboundSchema),
     M.jsonErr(500, errors.GetV1SafetyCrimeSafetyResponseBody$inboundSchema),
     M.fail("4XX"),

package/src/funcs/safetyGetV1SafetyCrimeStats.ts

@@ -22,6 +22,7 @@ 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";
 
@@ -29,7 +30,7 @@ import { Result } from "../sdk/types/fp.js";
  * Get crime statistics for an area
  *
  * @remarks
- * Retrieve aggregated crime statistics and a computed safety score for the area around a given coordinate. This endpoint queries crime data across multiple months, calculates trends, category breakdowns, and an overall safety score. It is more suitable than /crime for area-level analysis as it returns summary statistics rather than individual incidents. Coverage: England and Wales (police.uk data). Data has an approximate 2-month publication lag.
+ * Retrieve aggregated crime statistics for a specified area
  */
 export function safetyGetV1SafetyCrimeStats(
   client: SDKCore,
@@ -37,7 +38,7 @@ export function safetyGetV1SafetyCrimeStats(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetV1SafetyCrimeStatsResponseBody,
+    shared.AreaStatsResponse,
     | errors.GetV1SafetyCrimeStatsResponseBody
     | errors.GetV1SafetyCrimeStatsSafetyResponseBody
     | SDKBaseError
@@ -64,7 +65,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetV1SafetyCrimeStatsResponseBody,
+      shared.AreaStatsResponse,
       | errors.GetV1SafetyCrimeStatsResponseBody
       | errors.GetV1SafetyCrimeStatsSafetyResponseBody
       | SDKBaseError
@@ -155,7 +156,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.GetV1SafetyCrimeStatsResponseBody,
+    shared.AreaStatsResponse,
     | errors.GetV1SafetyCrimeStatsResponseBody
     | errors.GetV1SafetyCrimeStatsSafetyResponseBody
     | SDKBaseError
@@ -167,7 +168,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetV1SafetyCrimeStatsResponseBody$inboundSchema),
+    M.json(200, shared.AreaStatsResponse$inboundSchema),
     M.jsonErr(400, errors.GetV1SafetyCrimeStatsResponseBody$inboundSchema),
     M.jsonErr(
       500,

package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.ts

@@ -0,0 +1,207 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeSimple } 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 * 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 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";
+
+/**
+ * List documents for a purchased title deed
+ *
+ * @remarks
+ * Returns all documents associated with a title deed, including their processing status (pending, uploaded, or failed).
+ */
+export function titleDeedsGetV1TitleDeedsTitleNumberDocuments(
+  client: SDKCore,
+  request: operations.GetV1TitleDeedsTitleNumberDocumentsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.TitleDeedDocumentListResponse,
+    | errors.GetV1TitleDeedsTitleNumberDocumentsResponseBody
+    | errors.GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBody
+    | errors.GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBody
+    | errors.GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetV1TitleDeedsTitleNumberDocumentsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.TitleDeedDocumentListResponse,
+      | errors.GetV1TitleDeedsTitleNumberDocumentsResponseBody
+      | errors.GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBody
+      | errors.GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBody
+      | errors.GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetV1TitleDeedsTitleNumberDocumentsRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    titleNumber: encodeSimple("titleNumber", payload.titleNumber, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/title-deeds/{titleNumber}/documents")(
+    pathParams,
+  );
+
+  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: "get_/v1/title-deeds/{titleNumber}/documents",
+    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,
+    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: ["400", "401", "403", "4XX", "500", "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.TitleDeedDocumentListResponse,
+    | errors.GetV1TitleDeedsTitleNumberDocumentsResponseBody
+    | errors.GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBody
+    | errors.GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBody
+    | errors.GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.TitleDeedDocumentListResponse$inboundSchema),
+    M.jsonErr(
+      400,
+      errors.GetV1TitleDeedsTitleNumberDocumentsResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      401,
+      errors
+        .GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      403,
+      errors
+        .GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors
+        .GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBody$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 }];
+}