Final API changes for v9

Author: ianthetechie

__tests__/routing.test.ts

@@ -67,7 +67,7 @@ const optimizedRouteRequest: OptimizedRouteRequest = {
   },
   units: DistanceUnit.Mi,
   dateTime: {
-    type: 0,
+    type: "depart_now",
   },
 };
 const mockRouteRes = {

src/generated/.openapi-generator/FILES

@@ -77,6 +77,7 @@ models/MatrixResponse.ts
 models/MatrixWaypoint.ts
 models/MotorScooterCostingOptions.ts
 models/MotorcycleCostingOptions.ts
+models/NearestRoadsCostingModel.ts
 models/NearestRoadsRequest.ts
 models/NodeId.ts
 models/NodeType.ts

src/generated/.openapi-generator/VERSION

@@ -1 +1 @@
-7.20.0
+7.21.0

src/generated/models/BaseTraceRequest.ts

@@ -34,20 +34,6 @@ import {
   TimeConstraintV1ToJSON,
   TimeConstraintV1ToJSONTyped,
 } from "./TimeConstraintV1";
-import type { DistanceUnit } from "./DistanceUnit";
-import {
-  DistanceUnitFromJSON,
-  DistanceUnitFromJSONTyped,
-  DistanceUnitToJSON,
-  DistanceUnitToJSONTyped,
-} from "./DistanceUnit";
-import type { RoutingLanguages } from "./RoutingLanguages";
-import {
-  RoutingLanguagesFromJSON,
-  RoutingLanguagesFromJSONTyped,
-  RoutingLanguagesToJSON,
-  RoutingLanguagesToJSONTyped,
-} from "./RoutingLanguages";
 import type { MapMatchWaypoint } from "./MapMatchWaypoint";
 import {
   MapMatchWaypointFromJSON,
@@ -62,24 +48,6 @@ import {
  * @interface BaseTraceRequest
  */
 export interface BaseTraceRequest {
-  /**
-   *
-   * @type {DistanceUnit}
-   * @memberof BaseTraceRequest
-   */
-  units?: DistanceUnit;
-  /**
-   *
-   * @type {RoutingLanguages}
-   * @memberof BaseTraceRequest
-   */
-  language?: RoutingLanguages;
-  /**
-   * The level of directional narrative to include. Locations and times will always be returned, but narrative generation verbosity can be controlled with this parameter.
-   * @type {BaseTraceRequestDirectionsTypeEnum}
-   * @memberof BaseTraceRequest
-   */
-  directionsType?: BaseTraceRequestDirectionsTypeEnum;
   /**
    * An identifier to disambiguate requests (echoed by the server).
    * @type {string}
@@ -125,17 +93,6 @@ export interface BaseTraceRequest {
   shapeMatch?: BaseTraceRequestShapeMatchEnum;
 }
 
-/**
- * @export
- */
-export const BaseTraceRequestDirectionsTypeEnum = {
-  None: "none",
-  Maneuvers: "maneuvers",
-  Instructions: "instructions",
-} as const;
-export type BaseTraceRequestDirectionsTypeEnum =
-  (typeof BaseTraceRequestDirectionsTypeEnum)[keyof typeof BaseTraceRequestDirectionsTypeEnum];
-
 /**
  * @export
  */
@@ -169,14 +126,6 @@ export function BaseTraceRequestFromJSONTyped(
     return json;
   }
   return {
-    units:
-      json["units"] == null ? undefined : DistanceUnitFromJSON(json["units"]),
-    language:
-      json["language"] == null
-        ? undefined
-        : RoutingLanguagesFromJSON(json["language"]),
-    directionsType:
-      json["directions_type"] == null ? undefined : json["directions_type"],
     id: json["id"] == null ? undefined : json["id"],
     shape:
       json["shape"] == null
@@ -210,9 +159,6 @@ export function BaseTraceRequestToJSONTyped(
   }
 
   return {
-    units: DistanceUnitToJSON(value["units"]),
-    language: RoutingLanguagesToJSON(value["language"]),
-    directions_type: value["directionsType"],
     id: value["id"],
     shape:
       value["shape"] == null

src/generated/models/NearestRoadsCostingModel.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stadia Maps Geospatial APIs
+ * The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
+ *
+ * The version of the OpenAPI document: 11.0.0
+ * Contact: support@stadiamaps.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * A routing profile that determines which roads are eligible for matching (e.g. trucks probably aren't on sidewalks, so the search will snap to the nearest truck-accessible road).
+ * @export
+ */
+export const NearestRoadsCostingModel = {
+  Auto: "auto",
+  Bus: "bus",
+  Taxi: "taxi",
+  Truck: "truck",
+  Bicycle: "bicycle",
+  Bikeshare: "bikeshare",
+  MotorScooter: "motor_scooter",
+  Motorcycle: "motorcycle",
+  Pedestrian: "pedestrian",
+  LowSpeedVehicle: "low_speed_vehicle",
+} as const;
+export type NearestRoadsCostingModel =
+  (typeof NearestRoadsCostingModel)[keyof typeof NearestRoadsCostingModel];
+
+export function instanceOfNearestRoadsCostingModel(value: any): boolean {
+  for (const key in NearestRoadsCostingModel) {
+    if (Object.prototype.hasOwnProperty.call(NearestRoadsCostingModel, key)) {
+      if (
+        NearestRoadsCostingModel[
+          key as keyof typeof NearestRoadsCostingModel
+        ] === value
+      ) {
+        return true;
+      }
+    }
+  }
+  return false;
+}
+
+export function NearestRoadsCostingModelFromJSON(
+  json: any,
+): NearestRoadsCostingModel {
+  return NearestRoadsCostingModelFromJSONTyped(json, false);
+}
+
+export function NearestRoadsCostingModelFromJSONTyped(
+  json: any,
+  ignoreDiscriminator: boolean,
+): NearestRoadsCostingModel {
+  return json as NearestRoadsCostingModel;
+}
+
+export function NearestRoadsCostingModelToJSON(
+  value?: NearestRoadsCostingModel | null,
+): any {
+  return value as any;
+}
+
+export function NearestRoadsCostingModelToJSONTyped(
+  value: any,
+  ignoreDiscriminator: boolean,
+): NearestRoadsCostingModel {
+  return value as NearestRoadsCostingModel;
+}

src/generated/models/NearestRoadsRequest.ts

@@ -13,13 +13,6 @@
  */
 
 import { mapValues } from "../runtime";
-import type { CostingModel } from "./CostingModel";
-import {
-  CostingModelFromJSON,
-  CostingModelFromJSONTyped,
-  CostingModelToJSON,
-  CostingModelToJSONTyped,
-} from "./CostingModel";
 import type { CostingOptions } from "./CostingOptions";
 import {
   CostingOptionsFromJSON,
@@ -34,6 +27,13 @@ import {
   CoordinateToJSON,
   CoordinateToJSONTyped,
 } from "./Coordinate";
+import type { NearestRoadsCostingModel } from "./NearestRoadsCostingModel";
+import {
+  NearestRoadsCostingModelFromJSON,
+  NearestRoadsCostingModelFromJSONTyped,
+  NearestRoadsCostingModelToJSON,
+  NearestRoadsCostingModelToJSONTyped,
+} from "./NearestRoadsCostingModel";
 
 /**
  *
@@ -49,10 +49,10 @@ export interface NearestRoadsRequest {
   locations: Array<Coordinate>;
   /**
    *
-   * @type {CostingModel}
+   * @type {NearestRoadsCostingModel}
    * @memberof NearestRoadsRequest
    */
-  costing?: CostingModel;
+  costing?: NearestRoadsCostingModel;
   /**
    *
    * @type {CostingOptions}
@@ -93,7 +93,7 @@ export function NearestRoadsRequestFromJSONTyped(
     costing:
       json["costing"] == null
         ? undefined
-        : CostingModelFromJSON(json["costing"]),
+        : NearestRoadsCostingModelFromJSON(json["costing"]),
     costingOptions:
       json["costing_options"] == null
         ? undefined
@@ -116,7 +116,7 @@ export function NearestRoadsRequestToJSONTyped(
 
   return {
     locations: (value["locations"] as Array<any>).map(CoordinateToJSON),
-    costing: CostingModelToJSON(value["costing"]),
+    costing: NearestRoadsCostingModelToJSON(value["costing"]),
     costing_options: CostingOptionsToJSON(value["costingOptions"]),
     verbose: value["verbose"],
   };

src/generated/models/TimeConstraintV1.ts

@@ -14,13 +14,13 @@
 
 import { mapValues } from "../runtime";
 /**
- * Specifies the time context for time-dependent routing (e.g., to account for traffic patterns or time-based access restrictions). Defaults to "depart_now" for traffic-influenced routing profiles like `auto_traffic`.
+ * Specifies the time context for time-dependent routing (e.g., to account for traffic patterns or time-based access restrictions). Defaults to depart_now for traffic-influenced routing profiles like `auto_traffic`.
  * @export
  * @interface TimeConstraintV1
  */
 export interface TimeConstraintV1 {
   /**
-   * The type of time constraint: "depart_now" = depart now (current time), "depart_at" = depart at the specified time, "arrive_at" = arrive by the specified time.
+   * The type of time constraint: `depart_now` = depart now (current time), `depart_at` = depart at the specified time, `arrive_at` = arrive by the specified time.
    * @type {TimeConstraintV1TypeEnum}
    * @memberof TimeConstraintV1
    */

src/generated/models/TraceAttributesRequest.ts

@@ -48,13 +48,6 @@ import {
   DistanceUnitToJSON,
   DistanceUnitToJSONTyped,
 } from "./DistanceUnit";
-import type { RoutingLanguages } from "./RoutingLanguages";
-import {
-  RoutingLanguagesFromJSON,
-  RoutingLanguagesFromJSONTyped,
-  RoutingLanguagesToJSON,
-  RoutingLanguagesToJSONTyped,
-} from "./RoutingLanguages";
 import type { MapMatchWaypoint } from "./MapMatchWaypoint";
 import {
   MapMatchWaypointFromJSON,
@@ -112,24 +105,6 @@ export interface TraceAttributesRequest {
    * @memberof TraceAttributesRequest
    */
   shapeMatch?: TraceAttributesRequestShapeMatchEnum;
-  /**
-   *
-   * @type {DistanceUnit}
-   * @memberof TraceAttributesRequest
-   */
-  units?: DistanceUnit;
-  /**
-   *
-   * @type {RoutingLanguages}
-   * @memberof TraceAttributesRequest
-   */
-  language?: RoutingLanguages;
-  /**
-   * The level of directional narrative to include. Locations and times will always be returned, but narrative generation verbosity can be controlled with this parameter.
-   * @type {TraceAttributesRequestDirectionsTypeEnum}
-   * @memberof TraceAttributesRequest
-   */
-  directionsType?: TraceAttributesRequestDirectionsTypeEnum;
   /**
    * If present, provides either a whitelist or a blacklist of keys to include/exclude in the response. This key is optional, and if omitted from the request, all available info will be returned.
    * @type {TraceAttributeFilterOptions}
@@ -144,6 +119,12 @@ export interface TraceAttributesRequest {
    * @memberof TraceAttributesRequest
    */
   elevationInterval?: number;
+  /**
+   *
+   * @type {DistanceUnit}
+   * @memberof TraceAttributesRequest
+   */
+  units?: DistanceUnit;
 }
 
 /**
@@ -157,17 +138,6 @@ export const TraceAttributesRequestShapeMatchEnum = {
 export type TraceAttributesRequestShapeMatchEnum =
   (typeof TraceAttributesRequestShapeMatchEnum)[keyof typeof TraceAttributesRequestShapeMatchEnum];
 
-/**
- * @export
- */
-export const TraceAttributesRequestDirectionsTypeEnum = {
-  None: "none",
-  Maneuvers: "maneuvers",
-  Instructions: "instructions",
-} as const;
-export type TraceAttributesRequestDirectionsTypeEnum =
-  (typeof TraceAttributesRequestDirectionsTypeEnum)[keyof typeof TraceAttributesRequestDirectionsTypeEnum];
-
 /**
  * Check if a given object implements the TraceAttributesRequest interface.
  */
@@ -209,14 +179,6 @@ export function TraceAttributesRequestFromJSONTyped(
         ? undefined
         : TimeConstraintV1FromJSON(json["date_time"]),
     shapeMatch: json["shape_match"] == null ? undefined : json["shape_match"],
-    units:
-      json["units"] == null ? undefined : DistanceUnitFromJSON(json["units"]),
-    language:
-      json["language"] == null
-        ? undefined
-        : RoutingLanguagesFromJSON(json["language"]),
-    directionsType:
-      json["directions_type"] == null ? undefined : json["directions_type"],
     filters:
       json["filters"] == null
         ? undefined
@@ -225,6 +187,8 @@ export function TraceAttributesRequestFromJSONTyped(
       json["elevation_interval"] == null
         ? undefined
         : json["elevation_interval"],
+    units:
+      json["units"] == null ? undefined : DistanceUnitFromJSON(json["units"]),
   };
 }
 
@@ -253,10 +217,8 @@ export function TraceAttributesRequestToJSONTyped(
     costing_options: CostingOptionsToJSON(value["costingOptions"]),
     date_time: TimeConstraintV1ToJSON(value["dateTime"]),
     shape_match: value["shapeMatch"],
-    units: DistanceUnitToJSON(value["units"]),
-    language: RoutingLanguagesToJSON(value["language"]),
-    directions_type: value["directionsType"],
     filters: TraceAttributeFilterOptionsToJSON(value["filters"]),
     elevation_interval: value["elevationInterval"],
+    units: DistanceUnitToJSON(value["units"]),
   };
 }

src/generated/models/index.ts

@@ -74,6 +74,7 @@ export * from "./MatrixResponse";
 export * from "./MatrixWaypoint";
 export * from "./MotorScooterCostingOptions";
 export * from "./MotorcycleCostingOptions";
+export * from "./NearestRoadsCostingModel";
 export * from "./NearestRoadsRequest";
 export * from "./NodeId";
 export * from "./NodeType";