@vepler/sdk 7.11.2 → 7.18.1

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

@@ -0,0 +1,393 @@
+/*
+ * 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";
+
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const GetPlaceAttributesPlacesResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type GetPlaceAttributesPlacesResponseType = OpenEnum<
+  typeof GetPlaceAttributesPlacesResponseType
+>;
+
+export type GetPlaceAttributesPlacesResponseError = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: GetPlaceAttributesPlacesResponseType;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetPlaceAttributesPlacesResponseResponseBodyData = {
+  error: GetPlaceAttributesPlacesResponseError;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetPlaceAttributesPlacesResponseResponseBody extends SDKBaseError {
+  error: GetPlaceAttributesPlacesResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetPlaceAttributesPlacesResponseResponseBodyData;
+
+  constructor(
+    err: GetPlaceAttributesPlacesResponseResponseBodyData,
+    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 = "GetPlaceAttributesPlacesResponseResponseBody";
+  }
+}
+
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const GetPlaceAttributesPlacesType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type GetPlaceAttributesPlacesType = OpenEnum<
+  typeof GetPlaceAttributesPlacesType
+>;
+
+export type GetPlaceAttributesPlacesError = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: GetPlaceAttributesPlacesType;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetPlaceAttributesPlacesResponseBodyData = {
+  error: GetPlaceAttributesPlacesError;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetPlaceAttributesPlacesResponseBody extends SDKBaseError {
+  error: GetPlaceAttributesPlacesError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetPlaceAttributesPlacesResponseBodyData;
+
+  constructor(
+    err: GetPlaceAttributesPlacesResponseBodyData,
+    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 = "GetPlaceAttributesPlacesResponseBody";
+  }
+}
+
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const GetPlaceAttributesType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type GetPlaceAttributesType = OpenEnum<typeof GetPlaceAttributesType>;
+
+export type GetPlaceAttributesError = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: GetPlaceAttributesType;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetPlaceAttributesResponseBodyData = {
+  error: GetPlaceAttributesError;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetPlaceAttributesResponseBody extends SDKBaseError {
+  error: GetPlaceAttributesError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetPlaceAttributesResponseBodyData;
+
+  constructor(
+    err: GetPlaceAttributesResponseBodyData,
+    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 = "GetPlaceAttributesResponseBody";
+  }
+}
+
+/** @internal */
+export const GetPlaceAttributesPlacesResponseType$inboundSchema: z.ZodType<
+  GetPlaceAttributesPlacesResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetPlaceAttributesPlacesResponseType);
+
+/** @internal */
+export const GetPlaceAttributesPlacesResponseError$inboundSchema: z.ZodType<
+  GetPlaceAttributesPlacesResponseError,
+  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: GetPlaceAttributesPlacesResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getPlaceAttributesPlacesResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPlaceAttributesPlacesResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetPlaceAttributesPlacesResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPlaceAttributesPlacesResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetPlaceAttributesPlacesResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetPlaceAttributesPlacesResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => GetPlaceAttributesPlacesResponseError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetPlaceAttributesPlacesResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetPlaceAttributesPlacesType$inboundSchema: z.ZodType<
+  GetPlaceAttributesPlacesType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetPlaceAttributesPlacesType);
+
+/** @internal */
+export const GetPlaceAttributesPlacesError$inboundSchema: z.ZodType<
+  GetPlaceAttributesPlacesError,
+  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: GetPlaceAttributesPlacesType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getPlaceAttributesPlacesErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPlaceAttributesPlacesError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPlaceAttributesPlacesError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPlaceAttributesPlacesError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetPlaceAttributesPlacesResponseBody$inboundSchema: z.ZodType<
+  GetPlaceAttributesPlacesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetPlaceAttributesPlacesError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetPlaceAttributesPlacesResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetPlaceAttributesType$inboundSchema: z.ZodType<
+  GetPlaceAttributesType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetPlaceAttributesType);
+
+/** @internal */
+export const GetPlaceAttributesError$inboundSchema: z.ZodType<
+  GetPlaceAttributesError,
+  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: GetPlaceAttributesType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getPlaceAttributesErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPlaceAttributesError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPlaceAttributesError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPlaceAttributesError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetPlaceAttributesResponseBody$inboundSchema: z.ZodType<
+  GetPlaceAttributesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetPlaceAttributesError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetPlaceAttributesResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -59,12 +59,15 @@ export * from "./getlistingbysource.js";
 export * from "./getlistingsbylocation.js";
 export * from "./getmetricvalues.js";
 export * from "./getnearesthistoriclandfill.js";
+export * from "./getnearestplaces.js";
 export * from "./getnearestpoi.js";
 export * from "./getnearestpostcodes.js";
 export * from "./getofficer.js";
 export * from "./getperson.js";
 export * from "./getpersonappointments.js";
 export * from "./getpersoncluster.js";
+export * from "./getplace.js";
+export * from "./getplaceattributes.js";
 export * from "./getplanningapplications.js";
 export * from "./getplanningapplicationsbysource.js";
 export * from "./getpoimultipletiles.js";

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

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetNearestPlacesRequest = {
+  /**
+   * Comma-separated category names. A place matches when any level of its `categoryPath` is one of them. Places with no corroborated category never match a category filter.
+   */
+  categories?: string | undefined;
+  /**
+   * Latitude of the point to search from, in decimal degrees (WGS84).
+   */
+  lat: number;
+  /**
+   * Most places to return. Defaults to 10. Maximum 100.
+   */
+  limit?: number | undefined;
+  /**
+   * Longitude of the point to search from, in decimal degrees (WGS84).
+   */
+  lng: number;
+  /**
+   * Search radius in metres, measured in a straight line. Maximum 10,000.
+   */
+  radius: number;
+};
+
+/** @internal */
+export type GetNearestPlacesRequest$Outbound = {
+  categories?: string | undefined;
+  lat: number;
+  limit: number;
+  lng: number;
+  radius: number;
+};
+
+/** @internal */
+export const GetNearestPlacesRequest$outboundSchema: z.ZodType<
+  GetNearestPlacesRequest$Outbound,
+  z.ZodTypeDef,
+  GetNearestPlacesRequest
+> = z.object({
+  categories: z.string().optional(),
+  lat: z.number(),
+  limit: z.number().int().default(10),
+  lng: z.number(),
+  radius: z.number(),
+});
+
+export function getNearestPlacesRequestToJSON(
+  getNearestPlacesRequest: GetNearestPlacesRequest,
+): string {
+  return JSON.stringify(
+    GetNearestPlacesRequest$outboundSchema.parse(getNearestPlacesRequest),
+  );
+}

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

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetPlaceRequest = {
+  /**
+   * Identifier of the place.
+   */
+  poiId: string;
+};
+
+/** @internal */
+export type GetPlaceRequest$Outbound = {
+  poiId: string;
+};
+
+/** @internal */
+export const GetPlaceRequest$outboundSchema: z.ZodType<
+  GetPlaceRequest$Outbound,
+  z.ZodTypeDef,
+  GetPlaceRequest
+> = z.object({
+  poiId: z.string(),
+});
+
+export function getPlaceRequestToJSON(
+  getPlaceRequest: GetPlaceRequest,
+): string {
+  return JSON.stringify(GetPlaceRequest$outboundSchema.parse(getPlaceRequest));
+}

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

@@ -64,12 +64,14 @@ export * from "./getlistingsbylocation.js";
 export * from "./getmetricprofiles.js";
 export * from "./getmetricvalues.js";
 export * from "./getnearesthistoriclandfill.js";
+export * from "./getnearestplaces.js";
 export * from "./getnearestpoi.js";
 export * from "./getnearestpostcodes.js";
 export * from "./getofficer.js";
 export * from "./getperson.js";
 export * from "./getpersonappointments.js";
 export * from "./getpersoncluster.js";
+export * from "./getplace.js";
 export * from "./getplanningapplications.js";
 export * from "./getplanningapplicationsbysource.js";
 export * from "./getpoimultipletiles.js";

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

@@ -322,8 +322,15 @@ export * from "./plannings106nonfinancialobligation.js";
 export * from "./plannings106party.js";
 export * from "./planningsemanticchunk.js";
 export * from "./planningstatushistory.js";
+export * from "./poiattribute.js";
+export * from "./poiattributecatalogue.js";
+export * from "./poifieldprovenance.js";
+export * from "./poinearestresponse.js";
 export * from "./pointcategorystats.js";
 export * from "./pointcategorystatslistresponse.js";
+export * from "./poiplace.js";
+export * from "./poiprovenance.js";
+export * from "./poiregistermatch.js";
 export * from "./postcodeaddress.js";
 export * from "./postcodelookupresponse.js";
 export * from "./postcodevalidationresponse.js";

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

@@ -120,7 +120,7 @@ export type MarketStatus = {
    */
   pricePerSqft?: number | null | undefined;
   /**
-   * Price per square metre of floor area.
+   * Sale price per square metre of floor area.
    */
   pricePerSqm?: number | null | undefined;
   /**

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

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PoiAttribute = {
+  /**
+   * What the attribute is.
+   */
+  description: string | null;
+  /**
+   * The values the attribute can take, when it is a closed list.
+   */
+  enumValues: Array<string> | null;
+  /**
+   * True when the attribute is also returned by the nearest endpoint.
+   */
+  inSummary: boolean;
+  /**
+   * True when the value can be null.
+   */
+  nullable: boolean;
+  /**
+   * Dotted path of the attribute in a place.
+   */
+  path: string;
+  /**
+   * The account permission the attribute needs, or null when every account receives it.
+   */
+  requiresPermission: string | null;
+  /**
+   * JSON type of the value.
+   */
+  type: string;
+};
+
+/** @internal */
+export const PoiAttribute$inboundSchema: z.ZodType<
+  PoiAttribute,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  description: z.nullable(z.string()),
+  enumValues: z.nullable(z.array(z.string())),
+  inSummary: z.boolean(),
+  nullable: z.boolean(),
+  path: z.string(),
+  requiresPermission: z.nullable(z.string()),
+  type: z.string(),
+});
+
+export function poiAttributeFromJSON(
+  jsonString: string,
+): SafeParseResult<PoiAttribute, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PoiAttribute$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PoiAttribute' from JSON`,
+  );
+}

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

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { PoiAttribute, PoiAttribute$inboundSchema } from "./poiattribute.js";
+
+/**
+ * The attributes of a point of interest, with their types and access requirements.
+ */
+export type PoiAttributeCatalogue = {
+  /**
+   * Every attribute a place can carry, in document order.
+   */
+  attributes: Array<PoiAttribute>;
+};
+
+/** @internal */
+export const PoiAttributeCatalogue$inboundSchema: z.ZodType<
+  PoiAttributeCatalogue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  attributes: z.array(PoiAttribute$inboundSchema),
+});
+
+export function poiAttributeCatalogueFromJSON(
+  jsonString: string,
+): SafeParseResult<PoiAttributeCatalogue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PoiAttributeCatalogue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PoiAttributeCatalogue' from JSON`,
+  );
+}