@vepler/sdk 7.1.2 → 7.7.0

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

@@ -4,7 +4,6 @@
 
 import * as z from "zod/v3";
 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";
 
@@ -14,7 +13,7 @@ export type GetNearestPOIRequest = {
    */
   lat: string;
   /**
-   * Maximum number of places to return for each category. Defaults to 10. Results come back nearest first.
+   * Maximum number of places to return in total, across every category in `types`. Defaults to 5, at most 100. Results come back nearest first.
    */
   limit?: string | undefined;
   /**
@@ -22,11 +21,11 @@ export type GetNearestPOIRequest = {
    */
   lng: string;
   /**
-   * How far from that point to search, in metres. Defaults to 5000. Places further away are not returned.
+   * How far from that point to search, in metres. Defaults to 10000, at most 50000. Places further away are not returned.
    */
   radius?: string | undefined;
   /**
-   * Set to `true` to add the distance and travel time along roads and paths for each place, in `routingDistance` and `routingDuration`. Working these out takes longer than the straight-line distance alone.
+   * Set to `true` to add, for each place, the distance and travel time by car, by bicycle and on foot along roads and paths, in `routing`. Working these out takes longer than the straight-line distance alone.
    */
   routing?: string | undefined;
   /**
@@ -38,134 +37,225 @@ export type GetNearestPOIRequest = {
 /**
  * The point the search was centred on.
  */
-export type SearchLocation = {
+export type QueryPoint = {
   /**
    * Latitude the search was centred on.
    */
-  lat: number;
+  latitude: number;
   /**
    * Longitude the search was centred on.
    */
-  lng: number;
+  longitude: number;
 };
 
 /**
  * The search that produced these results.
  */
-export type Metadata = {
+export type Meta = {
   /**
-   * The categories the search covered. Not present in every response.
+   * The category codes the search was limited to. Absent when every category was searched.
    */
-  categories?: Array<string> | undefined;
+  categoryFilters?: Array<string> | undefined;
   /**
-   * True when distances and times along roads and paths were calculated.
+   * How long the search took, in milliseconds.
    */
-  routingEnabled?: boolean | undefined;
+  executionTimeMs?: number | undefined;
   /**
    * The point the search was centred on.
    */
-  searchLocation: SearchLocation;
+  queryPoint: QueryPoint;
   /**
    * The radius that was applied, in metres.
    */
-  searchRadius: number;
+  radiusMeters: number;
   /**
-   * Number of points of interest found within that radius.
+   * Number of places returned. It is never more than `limit`.
    */
-  totalResults: number;
+  totalFound: number;
 };
 
 /**
- * Geometry type discriminator. Always `Point`.
+ * Logo images for the place's brand. Present only when artwork is held for that brand.
  */
-export const GetNearestPOIType = {
-  Point: "Point",
-} as const;
+export type GetNearestPOIBranding = {
+  /**
+   * The square icon at 64, 128, 256 and 512 pixels wide, as an `<img>` `srcset` value.
+   */
+  iconSrcset: string;
+  /**
+   * URL of the brand's square icon, 256 pixels wide.
+   */
+  iconUrl: string;
+  /**
+   * The wordmark at 256, 512 and 1024 pixels wide, as an `<img>` `srcset` value. Absent when the brand has no wordmark.
+   */
+  wordmarkSrcset?: string | undefined;
+  /**
+   * URL of the brand's horizontal wordmark, 512 pixels wide. Absent when the brand has no wordmark.
+   */
+  wordmarkUrl?: string | undefined;
+};
+
 /**
- * Geometry type discriminator. Always `Point`.
+ * Position of the place.
  */
-export type GetNearestPOIType = ClosedEnum<typeof GetNearestPOIType>;
+export type GetNearestPOICoordinates = {
+  /**
+   * Latitude of the place, in WGS84 decimal degrees.
+   */
+  latitude: number;
+  /**
+   * Longitude of the place, in WGS84 decimal degrees.
+   */
+  longitude: number;
+};
 
 /**
- * Location of the place, as a GeoJSON Point.
+ * The route by bicycle. Null when no route was found by bicycle.
  */
-export type GetNearestPOILocation = {
+export type Bike = {
   /**
-   * Position of the place: longitude first, then latitude, in WGS84 decimal degrees (the GeoJSON order).
+   * Distance along the route, in whole metres.
    */
-  coordinates: Array<number>;
+  distance: number;
   /**
-   * Geometry type discriminator. Always `Point`.
+   * The same distance in kilometres, to two decimal places.
    */
-  type: GetNearestPOIType;
+  distanceKm: number;
+  /**
+   * Estimated travel time along the route, in whole seconds.
+   */
+  duration: number;
+  /**
+   * The same travel time in minutes, rounded to the nearest minute.
+   */
+  durationMinutes: number;
 };
 
 /**
- * A point of interest, such as a shop, a station or an airport.
+ * The route by car. Null when no route was found by car.
  */
-export type GetNearestPOIResult = {
+export type Car = {
   /**
-   * Street address of the place. Not present in every response.
+   * Distance along the route, in whole metres.
    */
-  address?: string | null | undefined;
+  distance: number;
   /**
-   * Code identifying the category the place belongs to, one of RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL. Pass it in `types` to filter a search.
+   * The same distance in kilometres, to two decimal places.
    */
-  categoryId: string;
+  distanceKm: number;
   /**
-   * Straight-line distance from the search point, in metres. Returned by the nearest points of interest search.
+   * Estimated travel time along the route, in whole seconds.
    */
-  distance?: number | undefined;
+  duration: number;
   /**
-   * Identifier for the point of interest.
+   * The same travel time in minutes, rounded to the nearest minute.
    */
-  id: number;
+  durationMinutes: number;
+};
+
+/**
+ * The route on foot. Null when no route was found on foot.
+ */
+export type Foot = {
   /**
-   * Location of the place, as a GeoJSON Point.
+   * Distance along the route, in whole metres.
    */
-  location: GetNearestPOILocation;
+  distance: number;
   /**
-   * Name of the place.
+   * The same distance in kilometres, to two decimal places.
    */
-  name: string;
+  distanceKm: number;
+  /**
+   * Estimated travel time along the route, in whole seconds.
+   */
+  duration: number;
   /**
-   * Distance from the search point along roads and paths, in metres. Returned only when `routing` is true.
+   * The same travel time in minutes, rounded to the nearest minute.
    */
-  routingDistance?: number | undefined;
+  durationMinutes: number;
+};
+
+/**
+ * Distance and travel time from the search point to the place by car, by bicycle and on foot, along roads and paths. Present only when `routing` is true, and absent for a place whose routes could not be worked out.
+ */
+export type Routing = {
   /**
-   * Estimated travel time along that route, in seconds. Returned only when `routing` is true.
+   * The route by bicycle. Null when no route was found by bicycle.
    */
-  routingDuration?: number | undefined;
+  bike: Bike | null;
   /**
-   * Name of the source the record came from, such as `OpenStreetMap`.
+   * The route by car. Null when no route was found by car.
    */
-  source?: string | null | undefined;
+  car: Car | null;
   /**
-   * Identifier for this place within that source.
+   * The route on foot. Null when no route was found on foot.
    */
-  sourceId?: string | null | undefined;
+  foot: Foot | null;
 };
 
 /**
- * Points of interest near the requested location, nearest first.
+ * A point of interest near the search point, such as a shop, a station or an airport.
  */
-export type GetNearestPOIResponseBody = {
+export type Results = {
   /**
-   * Human-readable note about the response. Not present in every response.
+   * Street address of the place. Absent when none is held.
    */
-  message?: string | undefined;
+  address?: string | undefined;
   /**
-   * The search that produced these results.
+   * Direction of the place from the search point, in whole degrees clockwise from true north, from 0 to 359. Null when the place is at the search point itself.
    */
-  metadata: Metadata;
+  bearingDegrees: number | null;
   /**
-   * Points of interest within the search radius, nearest first.
+   * Identifier for the brand the place trades under. Absent when the place has no known brand.
+   */
+  brandId?: string | undefined;
+  /**
+   * Logo images for the place's brand. Present only when artwork is held for that brand.
    */
-  result: Array<GetNearestPOIResult>;
+  branding?: GetNearestPOIBranding | undefined;
+  /**
+   * Code identifying the category the place belongs to, one of RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL. Pass it in `types` to filter a search.
+   */
+  categoryId: string;
   /**
-   * True when the request succeeded.
+   * Position of the place.
    */
-  success: boolean;
+  coordinates: GetNearestPOICoordinates;
+  /**
+   * Straight-line distance from the search point, in whole metres.
+   */
+  distanceMeters: number;
+  /**
+   * Identifier for the point of interest.
+   */
+  id: string;
+  /**
+   * Name of the place.
+   */
+  name: string;
+  /**
+   * Distance and travel time from the search point to the place by car, by bicycle and on foot, along roads and paths. Present only when `routing` is true, and absent for a place whose routes could not be worked out.
+   */
+  routing?: Routing | undefined;
+  /**
+   * When this record was last refreshed in the dataset, as an ISO 8601 timestamp. It is not the date the place itself last changed.
+   */
+  updatedAt?: string | undefined;
+};
+
+/**
+ * Points of interest near the requested location, nearest first.
+ */
+export type GetNearestPOIResponseBody = {
+  /**
+   * The search that produced these results.
+   */
+  meta: Meta;
+  /**
+   * Points of interest within the search radius, nearest first.
+   */
+  results: Array<Results>;
 };
 
 /** @internal */
@@ -185,9 +275,9 @@ export const GetNearestPOIRequest$outboundSchema: z.ZodType<
   GetNearestPOIRequest
 > = z.object({
   lat: z.string(),
-  limit: z.string().default("10"),
+  limit: z.string().default("5"),
   lng: z.string(),
-  radius: z.string().default("5000"),
+  radius: z.string().default("10000"),
   routing: z.string().optional(),
   types: z.string().optional(),
 });
@@ -201,98 +291,185 @@ export function getNearestPOIRequestToJSON(
 }
 
 /** @internal */
-export const SearchLocation$inboundSchema: z.ZodType<
-  SearchLocation,
+export const QueryPoint$inboundSchema: z.ZodType<
+  QueryPoint,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  lat: z.number(),
-  lng: z.number(),
+  latitude: z.number(),
+  longitude: z.number(),
 });
 
-export function searchLocationFromJSON(
+export function queryPointFromJSON(
   jsonString: string,
-): SafeParseResult<SearchLocation, SDKValidationError> {
+): SafeParseResult<QueryPoint, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => SearchLocation$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SearchLocation' from JSON`,
+    (x) => QueryPoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryPoint' from JSON`,
   );
 }
 
 /** @internal */
-export const Metadata$inboundSchema: z.ZodType<
-  Metadata,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  categories: z.array(z.string()).optional(),
-  routingEnabled: z.boolean().optional(),
-  searchLocation: z.lazy(() => SearchLocation$inboundSchema),
-  searchRadius: z.number(),
-  totalResults: z.number(),
-});
+export const Meta$inboundSchema: z.ZodType<Meta, z.ZodTypeDef, unknown> = z
+  .object({
+    categoryFilters: z.array(z.string()).optional(),
+    executionTimeMs: z.number().optional(),
+    queryPoint: z.lazy(() => QueryPoint$inboundSchema),
+    radiusMeters: z.number(),
+    totalFound: z.number(),
+  });
 
-export function metadataFromJSON(
+export function metaFromJSON(
   jsonString: string,
-): SafeParseResult<Metadata, SDKValidationError> {
+): SafeParseResult<Meta, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Metadata' from JSON`,
+    (x) => Meta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Meta' from JSON`,
   );
 }
 
 /** @internal */
-export const GetNearestPOIType$inboundSchema: z.ZodNativeEnum<
-  typeof GetNearestPOIType
-> = z.nativeEnum(GetNearestPOIType);
-
-/** @internal */
-export const GetNearestPOILocation$inboundSchema: z.ZodType<
-  GetNearestPOILocation,
+export const GetNearestPOIBranding$inboundSchema: z.ZodType<
+  GetNearestPOIBranding,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  coordinates: z.array(z.number()),
-  type: GetNearestPOIType$inboundSchema,
+  iconSrcset: z.string(),
+  iconUrl: z.string(),
+  wordmarkSrcset: z.string().optional(),
+  wordmarkUrl: z.string().optional(),
 });
 
-export function getNearestPOILocationFromJSON(
+export function getNearestPOIBrandingFromJSON(
   jsonString: string,
-): SafeParseResult<GetNearestPOILocation, SDKValidationError> {
+): SafeParseResult<GetNearestPOIBranding, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GetNearestPOILocation$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetNearestPOILocation' from JSON`,
+    (x) => GetNearestPOIBranding$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetNearestPOIBranding' from JSON`,
   );
 }
 
 /** @internal */
-export const GetNearestPOIResult$inboundSchema: z.ZodType<
-  GetNearestPOIResult,
+export const GetNearestPOICoordinates$inboundSchema: z.ZodType<
+  GetNearestPOICoordinates,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  address: z.nullable(z.string()).optional(),
-  categoryId: z.string(),
-  distance: z.number().optional(),
-  id: z.number(),
-  location: z.lazy(() => GetNearestPOILocation$inboundSchema),
-  name: z.string(),
-  routingDistance: z.number().optional(),
-  routingDuration: z.number().optional(),
-  source: z.nullable(z.string()).optional(),
-  sourceId: z.nullable(z.string()).optional(),
+  latitude: z.number(),
+  longitude: z.number(),
 });
 
-export function getNearestPOIResultFromJSON(
+export function getNearestPOICoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<GetNearestPOICoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetNearestPOICoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetNearestPOICoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const Bike$inboundSchema: z.ZodType<Bike, z.ZodTypeDef, unknown> = z
+  .object({
+    distance: z.number(),
+    distanceKm: z.number(),
+    duration: z.number(),
+    durationMinutes: z.number(),
+  });
+
+export function bikeFromJSON(
+  jsonString: string,
+): SafeParseResult<Bike, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Bike$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Bike' from JSON`,
+  );
+}
+
+/** @internal */
+export const Car$inboundSchema: z.ZodType<Car, z.ZodTypeDef, unknown> = z
+  .object({
+    distance: z.number(),
+    distanceKm: z.number(),
+    duration: z.number(),
+    durationMinutes: z.number(),
+  });
+
+export function carFromJSON(
+  jsonString: string,
+): SafeParseResult<Car, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Car$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Car' from JSON`,
+  );
+}
+
+/** @internal */
+export const Foot$inboundSchema: z.ZodType<Foot, z.ZodTypeDef, unknown> = z
+  .object({
+    distance: z.number(),
+    distanceKm: z.number(),
+    duration: z.number(),
+    durationMinutes: z.number(),
+  });
+
+export function footFromJSON(
+  jsonString: string,
+): SafeParseResult<Foot, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Foot$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Foot' from JSON`,
+  );
+}
+
+/** @internal */
+export const Routing$inboundSchema: z.ZodType<Routing, z.ZodTypeDef, unknown> =
+  z.object({
+    bike: z.nullable(z.lazy(() => Bike$inboundSchema)),
+    car: z.nullable(z.lazy(() => Car$inboundSchema)),
+    foot: z.nullable(z.lazy(() => Foot$inboundSchema)),
+  });
+
+export function routingFromJSON(
+  jsonString: string,
+): SafeParseResult<Routing, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Routing$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Routing' from JSON`,
+  );
+}
+
+/** @internal */
+export const Results$inboundSchema: z.ZodType<Results, z.ZodTypeDef, unknown> =
+  z.object({
+    address: z.string().optional(),
+    bearingDegrees: z.nullable(z.number()),
+    brandId: z.string().optional(),
+    branding: z.lazy(() => GetNearestPOIBranding$inboundSchema).optional(),
+    categoryId: z.string(),
+    coordinates: z.lazy(() => GetNearestPOICoordinates$inboundSchema),
+    distanceMeters: z.number(),
+    id: z.string(),
+    name: z.string(),
+    routing: z.lazy(() => Routing$inboundSchema).optional(),
+    updatedAt: z.string().optional(),
+  });
+
+export function resultsFromJSON(
   jsonString: string,
-): SafeParseResult<GetNearestPOIResult, SDKValidationError> {
+): SafeParseResult<Results, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GetNearestPOIResult$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetNearestPOIResult' from JSON`,
+    (x) => Results$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Results' from JSON`,
   );
 }
 
@@ -302,10 +479,8 @@ export const GetNearestPOIResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  message: z.string().optional(),
-  metadata: z.lazy(() => Metadata$inboundSchema),
-  result: z.array(z.lazy(() => GetNearestPOIResult$inboundSchema)),
-  success: z.boolean(),
+  meta: z.lazy(() => Meta$inboundSchema),
+  results: z.array(z.lazy(() => Results$inboundSchema)),
 });
 
 export function getNearestPOIResponseBodyFromJSON(

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

@@ -49,7 +49,7 @@ export type GetPOIMultipleTilesFormat = OpenEnum<
 /**
  * Counts across the whole request, and the format the tiles were returned in.
  */
-export type GetPOIMultipleTilesMetadata = {
+export type Metadata = {
   /**
    * Number of tiles that could not be returned, each with its own `error`.
    */
@@ -158,7 +158,7 @@ export type GetPOIMultipleTilesTile = {
 /**
  * Which tile this is and when it was built. Not present in every response.
  */
-export type GetPOIMultipleTilesPOIMetadata = {
+export type GetPOIMultipleTilesMetadata = {
   /**
    * Number of points of interest in the tile.
    */
@@ -191,7 +191,7 @@ export type GetPOIMultipleTiles1 = {
   /**
    * Which tile this is and when it was built. Not present in every response.
    */
-  metadata?: GetPOIMultipleTilesPOIMetadata | undefined;
+  metadata?: GetPOIMultipleTilesMetadata | undefined;
   type: GetPOIMultipleTilesType;
 };
 
@@ -228,7 +228,7 @@ export type GetPOIMultipleTilesResponseBody = {
   /**
    * Counts across the whole request, and the format the tiles were returned in.
    */
-  metadata: GetPOIMultipleTilesMetadata;
+  metadata: Metadata;
   /**
    * One entry per requested tile.
    */
@@ -276,8 +276,8 @@ export const GetPOIMultipleTilesFormat$inboundSchema: z.ZodType<
 > = openEnums.inboundSchema(GetPOIMultipleTilesFormat);
 
 /** @internal */
-export const GetPOIMultipleTilesMetadata$inboundSchema: z.ZodType<
-  GetPOIMultipleTilesMetadata,
+export const Metadata$inboundSchema: z.ZodType<
+  Metadata,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -287,13 +287,13 @@ export const GetPOIMultipleTilesMetadata$inboundSchema: z.ZodType<
   successfulTiles: z.number(),
 });
 
-export function getPOIMultipleTilesMetadataFromJSON(
+export function metadataFromJSON(
   jsonString: string,
-): SafeParseResult<GetPOIMultipleTilesMetadata, SDKValidationError> {
+): SafeParseResult<Metadata, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GetPOIMultipleTilesMetadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetPOIMultipleTilesMetadata' from JSON`,
+    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Metadata' from JSON`,
   );
 }
 
@@ -414,8 +414,8 @@ export function getPOIMultipleTilesTileFromJSON(
 }
 
 /** @internal */
-export const GetPOIMultipleTilesPOIMetadata$inboundSchema: z.ZodType<
-  GetPOIMultipleTilesPOIMetadata,
+export const GetPOIMultipleTilesMetadata$inboundSchema: z.ZodType<
+  GetPOIMultipleTilesMetadata,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -424,13 +424,13 @@ export const GetPOIMultipleTilesPOIMetadata$inboundSchema: z.ZodType<
   tile: z.lazy(() => GetPOIMultipleTilesTile$inboundSchema),
 });
 
-export function getPOIMultipleTilesPOIMetadataFromJSON(
+export function getPOIMultipleTilesMetadataFromJSON(
   jsonString: string,
-): SafeParseResult<GetPOIMultipleTilesPOIMetadata, SDKValidationError> {
+): SafeParseResult<GetPOIMultipleTilesMetadata, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GetPOIMultipleTilesPOIMetadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetPOIMultipleTilesPOIMetadata' from JSON`,
+    (x) => GetPOIMultipleTilesMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPOIMultipleTilesMetadata' from JSON`,
   );
 }
 
@@ -446,8 +446,7 @@ export const GetPOIMultipleTiles1$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   features: z.array(z.lazy(() => GetPOIMultipleTilesFeatures$inboundSchema)),
-  metadata: z.lazy(() => GetPOIMultipleTilesPOIMetadata$inboundSchema)
-    .optional(),
+  metadata: z.lazy(() => GetPOIMultipleTilesMetadata$inboundSchema).optional(),
   type: GetPOIMultipleTilesType$inboundSchema,
 });
 
@@ -512,7 +511,7 @@ export const GetPOIMultipleTilesResponseBody$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   message: z.string().optional(),
-  metadata: z.lazy(() => GetPOIMultipleTilesMetadata$inboundSchema),
+  metadata: z.lazy(() => Metadata$inboundSchema),
   result: z.array(z.lazy(() => GetPOIMultipleTilesResult$inboundSchema)),
   success: z.boolean(),
 });