@vepler/sdk 2.139.0 → 2.140.0

package/src/funcs/prosperityGet.ts

@@ -0,0 +1,185 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeSimple } 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 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 the Prosperity Index for one or more small areas
+ *
+ * @remarks
+ * Returns the Vepler Prosperity Index for one or more small-area codes — a composite 0-100 economic-prosperity score with national decile (1-10) and percentile. Pass a single code (e.g. `E01000001`) or a comma-separated list (up to 100). Each result is self-describing, carrying its own `geographicCode`, so multi-code lookups can be mapped back by the caller.
+ *
+ * The score breaks down into four weighted dimensions (income, housing, employment, living standards) and the curated underlying indicators (19 ONS/MHCLG measures) that feed them, each with display value, national median/mean, percentile and source attribution. England & Wales areas also carry the ONS OAC 2021 geodemographic classification (null for Scotland and Northern Ireland, which have no OAC).
+ *
+ * Codes with no persisted score are silently omitted from the result set — a request for valid-but-unscored codes returns an empty list, not a 404.
+ */
+export function prosperityGet(
+  client: SDKCore,
+  request: operations.GetProsperityRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.ProsperityListResponse,
+    | errors.GetProsperityResponseBody
+    | errors.GetProsperityProsperityResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetProsperityRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.ProsperityListResponse,
+      | errors.GetProsperityResponseBody
+      | errors.GetProsperityProsperityResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetProsperityRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    geographicCodes: encodeSimple("geographicCodes", payload.geographicCodes, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v1/prosperity/{geographicCodes}")(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: "getProsperity",
+    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,
+    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.ProsperityListResponse,
+    | errors.GetProsperityResponseBody
+    | errors.GetProsperityProsperityResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.ProsperityListResponse$inboundSchema),
+    M.jsonErr(400, errors.GetProsperityResponseBody$inboundSchema),
+    M.jsonErr(500, errors.GetProsperityProsperityResponseBody$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/lib/config.ts

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

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

@@ -0,0 +1,264 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKBaseError } from "./sdkbaseerror.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+/**
+ * Error type category
+ */
+export const GetProsperityProsperityType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetProsperityProsperityType = OpenEnum<
+  typeof GetProsperityProsperityType
+>;
+
+export type GetProsperityProsperityError = {
+  /**
+   * 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;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Error type category
+   */
+  type: GetProsperityProsperityType;
+};
+
+/**
+ * Error response
+ */
+export type GetProsperityProsperityResponseBodyData = {
+  error: GetProsperityProsperityError;
+};
+
+/**
+ * Error response
+ */
+export class GetProsperityProsperityResponseBody extends SDKBaseError {
+  error: GetProsperityProsperityError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetProsperityProsperityResponseBodyData;
+
+  constructor(
+    err: GetProsperityProsperityResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "GetProsperityProsperityResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetProsperityType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetProsperityType = OpenEnum<typeof GetProsperityType>;
+
+export type GetProsperityError = {
+  /**
+   * 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;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Error type category
+   */
+  type: GetProsperityType;
+};
+
+/**
+ * Error response
+ */
+export type GetProsperityResponseBodyData = {
+  error: GetProsperityError;
+};
+
+/**
+ * Error response
+ */
+export class GetProsperityResponseBody extends SDKBaseError {
+  error: GetProsperityError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetProsperityResponseBodyData;
+
+  constructor(
+    err: GetProsperityResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "GetProsperityResponseBody";
+  }
+}
+
+/** @internal */
+export const GetProsperityProsperityType$inboundSchema: z.ZodType<
+  GetProsperityProsperityType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetProsperityProsperityType);
+
+/** @internal */
+export const GetProsperityProsperityError$inboundSchema: z.ZodType<
+  GetProsperityProsperityError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
+  type: GetProsperityProsperityType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getProsperityProsperityErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetProsperityProsperityError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetProsperityProsperityError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetProsperityProsperityError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetProsperityProsperityResponseBody$inboundSchema: z.ZodType<
+  GetProsperityProsperityResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetProsperityProsperityError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetProsperityProsperityResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetProsperityType$inboundSchema: z.ZodType<
+  GetProsperityType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetProsperityType);
+
+/** @internal */
+export const GetProsperityError$inboundSchema: z.ZodType<
+  GetProsperityError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
+  type: GetProsperityType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getProsperityErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetProsperityError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetProsperityError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetProsperityError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetProsperityResponseBody$inboundSchema: z.ZodType<
+  GetProsperityResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetProsperityError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetProsperityResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -71,6 +71,7 @@ export * from "./getpropertiesbyslugs.js";
 export * from "./getpropertiesbysource.js";
 export * from "./getpropertiesinsite.js";
 export * from "./getpropertytiles.js";
+export * from "./getprosperity.js";
 export * from "./getpsc.js";
 export * from "./getschoolbyid.js";
 export * from "./getschoolbysource.js";

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetProsperityRequest = {
+  /**
+   * Single small-area code or comma-separated list (up to 100), e.g. E01000001 or E01000001,E01000002
+   */
+  geographicCodes: string;
+};
+
+/** @internal */
+export type GetProsperityRequest$Outbound = {
+  geographicCodes: string;
+};
+
+/** @internal */
+export const GetProsperityRequest$outboundSchema: z.ZodType<
+  GetProsperityRequest$Outbound,
+  z.ZodTypeDef,
+  GetProsperityRequest
+> = z.object({
+  geographicCodes: z.string(),
+});
+
+export function getProsperityRequestToJSON(
+  getProsperityRequest: GetProsperityRequest,
+): string {
+  return JSON.stringify(
+    GetProsperityRequest$outboundSchema.parse(getProsperityRequest),
+  );
+}

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

@@ -69,6 +69,7 @@ export * from "./getpropertiesbylocation.js";
 export * from "./getpropertiesbysource.js";
 export * from "./getpropertiesinsite.js";
 export * from "./getpropertytiles.js";
+export * from "./getprosperity.js";
 export * from "./getpsc.js";
 export * from "./getschoolbyid.js";
 export * from "./getschoolbysource.js";

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

@@ -274,6 +274,7 @@ export * from "./propertyvalueimpact.js";
 export * from "./prosperitydata.js";
 export * from "./prosperitydimensionscore.js";
 export * from "./prosperityindicator.js";
+export * from "./prosperitylistresponse.js";
 export * from "./provenance.js";
 export * from "./psc.js";
 export * from "./psclistresponse.js";

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

@@ -26,10 +26,6 @@ import {
   PropertyAddress$inboundSchema,
 } from "./propertyaddress.js";
 import { PropertyTags, PropertyTags$inboundSchema } from "./propertytags.js";
-import {
-  ProsperityData,
-  ProsperityData$inboundSchema,
-} from "./prosperitydata.js";
 import {
   RefurbishmentData,
   RefurbishmentData$inboundSchema,
@@ -471,7 +467,6 @@ export type PropertyDataApi = {
    * Unique property identifier
    */
   propertyId?: string | undefined;
-  prosperity?: ProsperityData | undefined;
   refurbishment?: RefurbishmentData | undefined;
   /**
    * Related property IDs
@@ -884,7 +879,6 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
   pricing: PricingData$inboundSchema.optional(),
   propertyCategory: z.nullable(PropertyCategory$inboundSchema).optional(),
   propertyId: z.string().optional(),
-  prosperity: ProsperityData$inboundSchema.optional(),
   refurbishment: RefurbishmentData$inboundSchema.optional(),
   relationships: z.array(z.string()).optional(),
   roomDetails: RoomDetails$inboundSchema.optional(),

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

@@ -84,6 +84,10 @@ export type ProsperityData = {
    * Per-dimension prosperity breakdown, keyed by dimension
    */
   dimensions?: Dimensions | undefined;
+  /**
+   * Small-area code this score belongs to (LSOA in England/Wales, Data Zone in Scotland, SOA in NI)
+   */
+  geographicCode: string;
   /**
    * Curated array of the underlying indicators (19 ONS/MHCLG measures) that feed the dimensions
    */
@@ -93,7 +97,7 @@ export type ProsperityData = {
    */
   percentile: number;
   /**
-   * Overall prosperity score 0-100 for the property’s LSOA
+   * Overall prosperity score 0-100 for the area
    */
   score: number;
   /**
@@ -165,6 +169,7 @@ export const ProsperityData$inboundSchema: z.ZodType<
   dataQuality: DataQuality$inboundSchema,
   decile: z.number().int(),
   dimensions: z.lazy(() => Dimensions$inboundSchema).optional(),
+  geographicCode: z.string(),
   indicators: z.array(ProsperityIndicator$inboundSchema).optional(),
   percentile: z.number().int(),
   score: z.number(),

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

@@ -0,0 +1,86 @@
+/*
+ * 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 {
+  ProsperityData,
+  ProsperityData$inboundSchema,
+} from "./prosperitydata.js";
+
+/**
+ * Object type identifier
+ */
+export const ProsperityListResponseObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type ProsperityListResponseObject = ClosedEnum<
+  typeof ProsperityListResponseObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type ProsperityListResponse = {
+  /**
+   * Array of items
+   */
+  data: Array<ProsperityData>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: ProsperityListResponseObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export const ProsperityListResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof ProsperityListResponseObject
+> = z.nativeEnum(ProsperityListResponseObject);
+
+/** @internal */
+export const ProsperityListResponse$inboundSchema: z.ZodType<
+  ProsperityListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(ProsperityData$inboundSchema),
+  has_more: z.boolean(),
+  object: ProsperityListResponseObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function prosperityListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ProsperityListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProsperityListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProsperityListResponse' from JSON`,
+  );
+}

package/src/sdk/prosperity.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { prosperityGet } from "../funcs/prosperityGet.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Prosperity extends ClientSDK {
+  /**
+   * Get the Prosperity Index for one or more small areas
+   *
+   * @remarks
+   * Returns the Vepler Prosperity Index for one or more small-area codes — a composite 0-100 economic-prosperity score with national decile (1-10) and percentile. Pass a single code (e.g. `E01000001`) or a comma-separated list (up to 100). Each result is self-describing, carrying its own `geographicCode`, so multi-code lookups can be mapped back by the caller.
+   *
+   * The score breaks down into four weighted dimensions (income, housing, employment, living standards) and the curated underlying indicators (19 ONS/MHCLG measures) that feed them, each with display value, national median/mean, percentile and source attribution. England & Wales areas also carry the ONS OAC 2021 geodemographic classification (null for Scotland and Northern Ireland, which have no OAC).
+   *
+   * Codes with no persisted score are silently omitted from the result set — a request for valid-but-unscored codes returns an empty list, not a 404.
+   */
+  async get(
+    request: operations.GetProsperityRequest,
+    options?: RequestOptions,
+  ): Promise<shared.ProsperityListResponse> {
+    return unwrapAsync(prosperityGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}