@tomtom-org/maps-sdk 0.51.5 → 0.52.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -0
- package/README.md +2 -2
- package/core/dist/core.es.js +1 -1
- package/core/dist/core.es.js.map +1 -1
- package/core/dist/index.d.ts +295 -360
- package/map/dist/index.d.ts +1315 -764
- package/map/dist/map.es.js +1 -1
- package/map/dist/map.es.js.map +1 -1
- package/package.json +7 -7
- package/services/dist/index.d.ts +238 -437
- package/services/dist/services.es.js +1 -1
- package/services/dist/services.es.js.map +1 -1
package/services/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ZodError, ZodIssue, ZodObject } from "zod";
|
|
2
|
-
import { AddressProperties, AreaAnalyticsMetricKey, Avoidable, BBox, ChargingPark, ChargingParkWithAvailability, ChargingStation, ChargingStationsAccessType, ChargingStationsAvailability, ChargingStopProps, CommonPlaceProps, Connector, ConnectorType, CurrentType, EVChargingStationWithAvailabilityPlaceProps, EntryPoint, Fuel, GeographyType, GetPositionEntryPointOption, GlobalConfig, HasBBox, HasLngLat, Instruction,
|
|
2
|
+
import { AddressProperties, AreaAnalyticsMetricKey, Avoidable, BBox, ChargingPark, ChargingParkWithAvailability, ChargingStation, ChargingStationsAccessType, ChargingStationsAvailability, ChargingStopProps, CommonPlaceProps, Connector, ConnectorType, CurrentType, EVChargingStationWithAvailabilityPlaceProps, EntryPoint, Fuel, GeographyType, GetPositionEntryPointOption, GlobalConfig, HasBBox, HasLngLat, Instruction, MapcodeType, OpeningHours, OpeningHoursMode, POICategory, Place, PlaceType, Places, PlugType, PolygonFeature, PolygonFeatures, RevGeoAddressProps, RoadShieldReference, Route, RoutePlanningLocation, Routes, SearchPlaceProps, TimeZone, TomTomAPIHeaders, TomTomHeaders, TrafficAreaAnalytics, TrafficIncidentDetails, TrafficIncidentRequestCategory, TrafficIncidentTEC, TrafficIncidentTimeValidity, TravelMode, View, inputSectionTypes } from "@tomtom-org/maps-sdk/core";
|
|
3
3
|
//#region src/shared/types/apiResponseErrorTypes.d.ts
|
|
4
4
|
/**
|
|
5
5
|
* @ignore
|
|
@@ -41,7 +41,7 @@ declare enum APICode {
|
|
|
41
41
|
* GET object with URL and optional service-specific API headers.
|
|
42
42
|
* @ignore
|
|
43
43
|
*/
|
|
44
|
-
type GetObject = {
|
|
44
|
+
export type GetObject = {
|
|
45
45
|
url: URL;
|
|
46
46
|
headers?: TomTomAPIHeaders;
|
|
47
47
|
};
|
|
@@ -49,7 +49,7 @@ type GetObject = {
|
|
|
49
49
|
* POST object with URL, optional payload, and optional service-specific API headers.
|
|
50
50
|
* @ignore
|
|
51
51
|
*/
|
|
52
|
-
type PostObject<D> = {
|
|
52
|
+
export type PostObject<D> = {
|
|
53
53
|
url: URL;
|
|
54
54
|
data?: D;
|
|
55
55
|
headers?: TomTomAPIHeaders;
|
|
@@ -60,12 +60,12 @@ type PostObject<D> = {
|
|
|
60
60
|
* * POST method comes with a URL, optional POST data, and optional headers.
|
|
61
61
|
* @ignore
|
|
62
62
|
*/
|
|
63
|
-
type FetchInput<PostData = void> = ({
|
|
63
|
+
export type FetchInput<PostData = void> = ({
|
|
64
64
|
method: 'GET';
|
|
65
65
|
} & GetObject) | ({
|
|
66
66
|
method: 'POST';
|
|
67
67
|
} & PostObject<PostData>);
|
|
68
|
-
type ParsedFetchResponse<T> = Promise<{
|
|
68
|
+
export type ParsedFetchResponse<T> = Promise<{
|
|
69
69
|
data: Promise<T>;
|
|
70
70
|
status: number;
|
|
71
71
|
}>;
|
|
@@ -109,7 +109,7 @@ type RequestValidationConfig<Params = any> = {
|
|
|
109
109
|
*
|
|
110
110
|
* @group Shared
|
|
111
111
|
*/
|
|
112
|
-
type CommonServiceParams<ApiRequest = any, ApiResponse = any> = Partial<GlobalConfig> & {
|
|
112
|
+
export type CommonServiceParams<ApiRequest = any, ApiResponse = any> = Partial<GlobalConfig> & {
|
|
113
113
|
/**
|
|
114
114
|
* Custom base URL for the service endpoint.
|
|
115
115
|
*
|
|
@@ -167,7 +167,7 @@ type CommonServiceParams<ApiRequest = any, ApiResponse = any> = Partial<GlobalCo
|
|
|
167
167
|
*
|
|
168
168
|
* @group Shared
|
|
169
169
|
*/
|
|
170
|
-
type ParseResponseError<T = DefaultAPIResponseErrorBody> = (apiError: APIErrorResponse<T>, serviceName: string) => SDKServiceError;
|
|
170
|
+
export type ParseResponseError<T = DefaultAPIResponseErrorBody> = (apiError: APIErrorResponse<T>, serviceName: string) => SDKServiceError;
|
|
171
171
|
/**
|
|
172
172
|
* Template interface defining the lifecycle methods for any service implementation.
|
|
173
173
|
*
|
|
@@ -182,7 +182,7 @@ type ParseResponseError<T = DefaultAPIResponseErrorBody> = (apiError: APIErrorRe
|
|
|
182
182
|
*
|
|
183
183
|
* @group Shared
|
|
184
184
|
*/
|
|
185
|
-
type ServiceTemplate<Params extends CommonServiceParams<ApiRequest, ApiResponse>, ApiRequest, ApiResponse, Response> = {
|
|
185
|
+
export type ServiceTemplate<Params extends CommonServiceParams<ApiRequest, ApiResponse>, ApiRequest, ApiResponse, Response> = {
|
|
186
186
|
/**
|
|
187
187
|
* Configuration for validating request parameters.
|
|
188
188
|
*
|
|
@@ -254,7 +254,7 @@ declare class ValidationError extends Error {
|
|
|
254
254
|
/**
|
|
255
255
|
* Name of a service managed by the SDK.
|
|
256
256
|
*/
|
|
257
|
-
type ServiceName = string;
|
|
257
|
+
export type ServiceName = string;
|
|
258
258
|
//#endregion
|
|
259
259
|
//#region src/shared/errors.d.ts
|
|
260
260
|
/**
|
|
@@ -279,7 +279,7 @@ type ServiceName = string;
|
|
|
279
279
|
*
|
|
280
280
|
* @group Errors
|
|
281
281
|
*/
|
|
282
|
-
declare class SDKError extends Error {
|
|
282
|
+
export declare class SDKError extends Error {
|
|
283
283
|
readonly service: string;
|
|
284
284
|
readonly issues?: ZodIssue[] | undefined;
|
|
285
285
|
/**
|
|
@@ -299,7 +299,7 @@ declare class SDKError extends Error {
|
|
|
299
299
|
*
|
|
300
300
|
* @group Errors
|
|
301
301
|
*/
|
|
302
|
-
declare const APIErrorCode: { readonly [K in APICode as number]: string; };
|
|
302
|
+
export declare const APIErrorCode: { readonly [K in APICode as number]: string; };
|
|
303
303
|
/**
|
|
304
304
|
* Error class for HTTP API response errors.
|
|
305
305
|
*
|
|
@@ -313,7 +313,7 @@ declare const APIErrorCode: { readonly [K in APICode as number]: string; };
|
|
|
313
313
|
*
|
|
314
314
|
* @group Errors
|
|
315
315
|
*/
|
|
316
|
-
declare class SDKServiceError extends SDKError {
|
|
316
|
+
export declare class SDKServiceError extends SDKError {
|
|
317
317
|
/**
|
|
318
318
|
* HTTP status code of the failed API request.
|
|
319
319
|
*
|
|
@@ -341,7 +341,7 @@ declare class SDKServiceError extends SDKError {
|
|
|
341
341
|
* @param error
|
|
342
342
|
* @param serviceName
|
|
343
343
|
*/
|
|
344
|
-
declare const parseDefaultResponseError: ParseResponseError<DefaultAPIResponseErrorBody>;
|
|
344
|
+
export declare const parseDefaultResponseError: ParseResponseError<DefaultAPIResponseErrorBody>;
|
|
345
345
|
/**
|
|
346
346
|
* @ignore
|
|
347
347
|
* Generate error for APIResponse, any other error type will be returned as it is.
|
|
@@ -349,13 +349,13 @@ declare const parseDefaultResponseError: ParseResponseError<DefaultAPIResponseEr
|
|
|
349
349
|
* @param serviceName The name of the service.
|
|
350
350
|
* @param parseResponseError
|
|
351
351
|
*/
|
|
352
|
-
declare const buildResponseError: (error: unknown, serviceName: ServiceName, parseResponseError?: ParseResponseError<unknown>) => SDKError;
|
|
352
|
+
export declare const buildResponseError: (error: unknown, serviceName: ServiceName, parseResponseError?: ParseResponseError<unknown>) => SDKError;
|
|
353
353
|
/**
|
|
354
354
|
* @ignore
|
|
355
355
|
* @param error
|
|
356
356
|
* @param serviceName
|
|
357
357
|
*/
|
|
358
|
-
declare const buildValidationError: (error: ValidationError, serviceName: ServiceName) => SDKError;
|
|
358
|
+
export declare const buildValidationError: (error: ValidationError, serviceName: ServiceName) => SDKError;
|
|
359
359
|
//#endregion
|
|
360
360
|
//#region src/shared/types/commonGeocodeAndFuzzySearchParams.d.ts
|
|
361
361
|
/**
|
|
@@ -371,7 +371,7 @@ declare const buildValidationError: (error: ValidationError, serviceName: Servic
|
|
|
371
371
|
*
|
|
372
372
|
* @group Search
|
|
373
373
|
*/
|
|
374
|
-
type CommonGeocodeAndFuzzySearchParams = {
|
|
374
|
+
export type CommonGeocodeAndFuzzySearchParams = {
|
|
375
375
|
/**
|
|
376
376
|
* Enable predictive/autocomplete mode for partial input queries.
|
|
377
377
|
*
|
|
@@ -581,7 +581,7 @@ type CommonGeocodeAndFuzzySearchParams = {
|
|
|
581
581
|
*
|
|
582
582
|
* @group Search
|
|
583
583
|
*/
|
|
584
|
-
type SearchIndexType = 'Geo' | 'PAD' | 'Addr' | 'Str' | 'XStr' | 'POI';
|
|
584
|
+
export type SearchIndexType = 'Geo' | 'PAD' | 'Addr' | 'Str' | 'XStr' | 'POI';
|
|
585
585
|
/**
|
|
586
586
|
* Common parameters shared across places-related services.
|
|
587
587
|
*
|
|
@@ -632,7 +632,7 @@ type SearchIndexType = 'Geo' | 'PAD' | 'Addr' | 'Str' | 'XStr' | 'POI';
|
|
|
632
632
|
*
|
|
633
633
|
* @group Search
|
|
634
634
|
*/
|
|
635
|
-
type CommonPlacesParams<ApiRequest, ApiResponse> = CommonServiceParams<ApiRequest, ApiResponse> & {
|
|
635
|
+
export type CommonPlacesParams<ApiRequest, ApiResponse> = CommonServiceParams<ApiRequest, ApiResponse> & {
|
|
636
636
|
/**
|
|
637
637
|
* Maximum number of results to return.
|
|
638
638
|
*
|
|
@@ -1131,107 +1131,30 @@ type PredefinedVehicleModel = {
|
|
|
1131
1131
|
variantId: string;
|
|
1132
1132
|
};
|
|
1133
1133
|
/**
|
|
1134
|
-
* Physical properties of the vehicle
|
|
1134
|
+
* Physical properties of the vehicle.
|
|
1135
1135
|
*
|
|
1136
1136
|
* @remarks
|
|
1137
|
-
*
|
|
1138
|
-
* - Check road
|
|
1139
|
-
* - Avoid unsuitable routes (narrow streets, low bridges)
|
|
1137
|
+
* The vehicle weight is used to:
|
|
1138
|
+
* - Check road weight restrictions
|
|
1140
1139
|
* - Calculate toll costs (weight-based pricing)
|
|
1141
|
-
* -
|
|
1142
|
-
*
|
|
1143
|
-
* **Important for:**
|
|
1144
|
-
* - Commercial vehicles (trucks, vans)
|
|
1145
|
-
* - Recreational vehicles (RVs, caravans)
|
|
1146
|
-
* - Oversized vehicles
|
|
1140
|
+
* - Refine consumption when a detailed consumption model is supplied
|
|
1147
1141
|
*
|
|
1148
1142
|
* @example
|
|
1149
1143
|
* ```typescript
|
|
1150
1144
|
* // Standard delivery van
|
|
1151
1145
|
* const vanDimensions: VehicleDimensions = {
|
|
1152
|
-
* lengthMeters: 5.5,
|
|
1153
|
-
* widthMeters: 2.0,
|
|
1154
|
-
* heightMeters: 2.5,
|
|
1155
1146
|
* weightKG: 3500
|
|
1156
1147
|
* };
|
|
1157
1148
|
*
|
|
1158
1149
|
* // Large truck
|
|
1159
1150
|
* const truckDimensions: VehicleDimensions = {
|
|
1160
|
-
*
|
|
1161
|
-
* widthMeters: 2.55,
|
|
1162
|
-
* heightMeters: 4.0,
|
|
1163
|
-
* weightKG: 40000,
|
|
1164
|
-
* axleWeightKG: 10000
|
|
1151
|
+
* weightKG: 40000
|
|
1165
1152
|
* };
|
|
1166
1153
|
* ```
|
|
1167
1154
|
*
|
|
1168
1155
|
* @group Vehicle
|
|
1169
1156
|
*/
|
|
1170
1157
|
type VehicleDimensions = {
|
|
1171
|
-
/**
|
|
1172
|
-
* Length of the vehicle in meters.
|
|
1173
|
-
*
|
|
1174
|
-
* @remarks
|
|
1175
|
-
* A value of 0 means that length restrictions are not considered.
|
|
1176
|
-
*
|
|
1177
|
-
* **Typical Values:**
|
|
1178
|
-
* - Small car: 3-4 m
|
|
1179
|
-
* - SUV/Van: 4-6 m
|
|
1180
|
-
* - Small truck: 6-10 m
|
|
1181
|
-
* - Large truck: 12-18 m
|
|
1182
|
-
*
|
|
1183
|
-
* @default 0
|
|
1184
|
-
*
|
|
1185
|
-
* @example
|
|
1186
|
-
* ```typescript
|
|
1187
|
-
* lengthMeters: 5.5 // Delivery van
|
|
1188
|
-
* lengthMeters: 16.5 // Articulated truck
|
|
1189
|
-
* ```
|
|
1190
|
-
*/
|
|
1191
|
-
lengthMeters?: number;
|
|
1192
|
-
/**
|
|
1193
|
-
* Width of the vehicle in meters.
|
|
1194
|
-
*
|
|
1195
|
-
* @remarks
|
|
1196
|
-
* A value of 0 means that width restrictions are not considered.
|
|
1197
|
-
*
|
|
1198
|
-
* **Typical Values:**
|
|
1199
|
-
* - Standard car: 1.7-1.9 m
|
|
1200
|
-
* - Van/truck: 2.0-2.5 m
|
|
1201
|
-
* - Maximum legal (Europe/US): 2.55 m
|
|
1202
|
-
*
|
|
1203
|
-
* @default 0
|
|
1204
|
-
*
|
|
1205
|
-
* @example
|
|
1206
|
-
* ```typescript
|
|
1207
|
-
* widthMeters: 1.8 // Standard car
|
|
1208
|
-
* widthMeters: 2.5 // Wide truck
|
|
1209
|
-
* ```
|
|
1210
|
-
*/
|
|
1211
|
-
widthMeters?: number;
|
|
1212
|
-
/**
|
|
1213
|
-
* Height of the vehicle in meters.
|
|
1214
|
-
*
|
|
1215
|
-
* @remarks
|
|
1216
|
-
* A value of 0 means that height restrictions are not considered.
|
|
1217
|
-
*
|
|
1218
|
-
* **Typical Values:**
|
|
1219
|
-
* - Sedan: 1.4-1.5 m
|
|
1220
|
-
* - SUV: 1.7-1.9 m
|
|
1221
|
-
* - Van: 2.0-2.8 m
|
|
1222
|
-
* - Truck: 3.5-4.5 m
|
|
1223
|
-
*
|
|
1224
|
-
* **Important:** Critical for avoiding low bridges and tunnels.
|
|
1225
|
-
*
|
|
1226
|
-
* @default 0
|
|
1227
|
-
*
|
|
1228
|
-
* @example
|
|
1229
|
-
* ```typescript
|
|
1230
|
-
* heightMeters: 1.5 // Sedan
|
|
1231
|
-
* heightMeters: 4.0 // Container truck
|
|
1232
|
-
* ```
|
|
1233
|
-
*/
|
|
1234
|
-
heightMeters?: number;
|
|
1235
1158
|
/**
|
|
1236
1159
|
* Weight of the vehicle in kilograms.
|
|
1237
1160
|
*
|
|
@@ -1261,29 +1184,6 @@ type VehicleDimensions = {
|
|
|
1261
1184
|
* ```
|
|
1262
1185
|
*/
|
|
1263
1186
|
weightKG?: number;
|
|
1264
|
-
/**
|
|
1265
|
-
* Weight per axle of the vehicle in kilograms.
|
|
1266
|
-
*
|
|
1267
|
-
* @remarks
|
|
1268
|
-
* A value of 0 means that weight restrictions per axle are not considered.
|
|
1269
|
-
*
|
|
1270
|
-
* **Use Cases:**
|
|
1271
|
-
* - Older bridges with axle weight limits
|
|
1272
|
-
* - Specialized roads with axle restrictions
|
|
1273
|
-
* - Heavy load transport
|
|
1274
|
-
*
|
|
1275
|
-
* **Typical Values:**
|
|
1276
|
-
* - Single axle: 6,000-10,000 kg
|
|
1277
|
-
* - Tandem axle: 8,000-11,500 kg (per axle)
|
|
1278
|
-
*
|
|
1279
|
-
* @default 0
|
|
1280
|
-
*
|
|
1281
|
-
* @example
|
|
1282
|
-
* ```typescript
|
|
1283
|
-
* axleWeightKG: 10000 // Heavy truck
|
|
1284
|
-
* ```
|
|
1285
|
-
*/
|
|
1286
|
-
axleWeightKG?: number;
|
|
1287
1187
|
};
|
|
1288
1188
|
/**
|
|
1289
1189
|
* Explicit vehicle model with manually specified properties.
|
|
@@ -1305,8 +1205,6 @@ type VehicleDimensions = {
|
|
|
1305
1205
|
* // Generic vehicle with dimensions only
|
|
1306
1206
|
* const customVan: ExplicitVehicleModel<undefined> = {
|
|
1307
1207
|
* dimensions: {
|
|
1308
|
-
* lengthMeters: 5.5,
|
|
1309
|
-
* heightMeters: 2.5,
|
|
1310
1208
|
* weightKG: 3500
|
|
1311
1209
|
* }
|
|
1312
1210
|
* };
|
|
@@ -1369,7 +1267,6 @@ type ExplicitVehicleModel<E extends VehicleEngineType> = {
|
|
|
1369
1267
|
* // Option 2: Explicit model
|
|
1370
1268
|
* const customModel: VehicleModel = {
|
|
1371
1269
|
* dimensions: {
|
|
1372
|
-
* heightMeters: 4.0,
|
|
1373
1270
|
* weightKG: 25000
|
|
1374
1271
|
* }
|
|
1375
1272
|
* };
|
|
@@ -1396,7 +1293,7 @@ type VehicleModel<E extends VehicleEngineType = undefined> = PredefinedVehicleMo
|
|
|
1396
1293
|
*
|
|
1397
1294
|
* @group Vehicle
|
|
1398
1295
|
*/
|
|
1399
|
-
type ChargingPreferencesPCT = {
|
|
1296
|
+
export type ChargingPreferencesPCT = {
|
|
1400
1297
|
/**
|
|
1401
1298
|
* The minimum battery percentage you wish to arrive at your destination with.
|
|
1402
1299
|
*
|
|
@@ -1460,7 +1357,7 @@ type ChargingPreferencesPCT = {
|
|
|
1460
1357
|
*
|
|
1461
1358
|
* @group Vehicle
|
|
1462
1359
|
*/
|
|
1463
|
-
type ChargingPreferencesKWH = {
|
|
1360
|
+
export type ChargingPreferencesKWH = {
|
|
1464
1361
|
/**
|
|
1465
1362
|
* The minimum battery kWh you wish to arrive at your destination with.
|
|
1466
1363
|
*
|
|
@@ -1536,7 +1433,7 @@ type ChargingPreferencesKWH = {
|
|
|
1536
1433
|
*
|
|
1537
1434
|
* @group Vehicle
|
|
1538
1435
|
*/
|
|
1539
|
-
type ChargingPreferences = ChargingPreferencesPCT | ChargingPreferencesKWH;
|
|
1436
|
+
export type ChargingPreferences = ChargingPreferencesPCT | ChargingPreferencesKWH;
|
|
1540
1437
|
/**
|
|
1541
1438
|
* Preferences specific to electric vehicles.
|
|
1542
1439
|
*
|
|
@@ -1556,7 +1453,7 @@ type ChargingPreferences = ChargingPreferencesPCT | ChargingPreferencesKWH;
|
|
|
1556
1453
|
*
|
|
1557
1454
|
* @group Vehicle
|
|
1558
1455
|
*/
|
|
1559
|
-
type ElectricVehiclePreferences = {
|
|
1456
|
+
export type ElectricVehiclePreferences = {
|
|
1560
1457
|
/**
|
|
1561
1458
|
* Charging preferences for Long Distance EV Routing.
|
|
1562
1459
|
*
|
|
@@ -1607,45 +1504,17 @@ type ElectricVehiclePreferences = {
|
|
|
1607
1504
|
*
|
|
1608
1505
|
* @group Vehicle
|
|
1609
1506
|
*/
|
|
1610
|
-
type VehiclePreferences<E extends VehicleEngineType = undefined> = E extends 'electric' ? ElectricVehiclePreferences : {};
|
|
1507
|
+
export type VehiclePreferences<E extends VehicleEngineType = undefined> = E extends 'electric' ? ElectricVehiclePreferences : {};
|
|
1611
1508
|
//#endregion
|
|
1612
1509
|
//#region src/shared/types/vehicleRestrictionParams.d.ts
|
|
1613
1510
|
/**
|
|
1614
|
-
*
|
|
1615
|
-
*/
|
|
1616
|
-
declare const loadTypes: readonly ["USHazmatClass1", "USHazmatClass2", "USHazmatClass3", "USHazmatClass4", "USHazmatClass5", "USHazmatClass6", "USHazmatClass7", "USHazmatClass8", "USHazmatClass9", "otherHazmatExplosive", "otherHazmatGeneral", "otherHazmatHarmfulToWater"];
|
|
1617
|
-
/**
|
|
1618
|
-
* Known hazardous truck load types. Should be used for trucks carrying hazardous materials.
|
|
1619
|
-
*
|
|
1620
|
-
* Use these values for routing in the USA:
|
|
1621
|
-
* * USHazmatClass1: Explosives
|
|
1622
|
-
* * USHazmatClass2: Compressed gas
|
|
1623
|
-
* * USHazmatClass3: Flammable liquids
|
|
1624
|
-
* * USHazmatClass4: Flammable solids
|
|
1625
|
-
* * USHazmatClass5: Oxidizers
|
|
1626
|
-
* * USHazmatClass6: Poisons
|
|
1627
|
-
* * USHazmatClass7: Radioactive
|
|
1628
|
-
* * USHazmatClass8: Corrosives
|
|
1629
|
-
* * USHazmatClass9: Miscellaneous
|
|
1630
|
-
*
|
|
1631
|
-
* Use these values for routing in all other countries:
|
|
1632
|
-
* * otherHazmatExplosive: Explosives
|
|
1633
|
-
* * otherHazmatGeneral: Miscellaneous
|
|
1634
|
-
* * otherHazmatHarmfulToWater: Harmful to water
|
|
1635
|
-
*/
|
|
1636
|
-
type LoadType = (typeof loadTypes)[number];
|
|
1637
|
-
/**
|
|
1638
|
-
* Parameters for a vehicle which are related to restrictions (e.g. related to the cargo and purpose of the vehicle).
|
|
1511
|
+
* Parameters for a vehicle which are related to restrictions applied during route planning.
|
|
1639
1512
|
*/
|
|
1640
1513
|
type VehicleRestrictions = {
|
|
1641
1514
|
/**
|
|
1642
|
-
* Vehicle restrictions
|
|
1515
|
+
* Vehicle restrictions applied during route planning.
|
|
1643
1516
|
*/
|
|
1644
1517
|
restrictions?: {
|
|
1645
|
-
/**
|
|
1646
|
-
* Specifies types of cargo that may be classified as hazardous materials and are restricted from some roads.
|
|
1647
|
-
*/
|
|
1648
|
-
loadTypes?: LoadType[];
|
|
1649
1518
|
/**
|
|
1650
1519
|
* Maximum speed of the vehicle in kilometers/hour.
|
|
1651
1520
|
* * Must have a value in the range [0, 250].
|
|
@@ -1654,27 +1523,6 @@ type VehicleRestrictions = {
|
|
|
1654
1523
|
* @default 0
|
|
1655
1524
|
*/
|
|
1656
1525
|
maxSpeedKMH?: number;
|
|
1657
|
-
/**
|
|
1658
|
-
* Subjects the vehicle to ADR tunnel restrictions.
|
|
1659
|
-
* * Vehicles with code B are restricted from roads with ADR tunnel categories B, C, D, and E.
|
|
1660
|
-
* * Vehicles with code C are restricted from roads with ADR tunnel categories C, D, and E.
|
|
1661
|
-
* * Vehicles with code D are restricted from roads with ADR tunnel categories D and E.
|
|
1662
|
-
* * Vehicles with code E are restricted from roads with ADR tunnel category E.
|
|
1663
|
-
*
|
|
1664
|
-
* Notes:
|
|
1665
|
-
* If travelMode is pedestrian or bicycle, adrCode is not considered.
|
|
1666
|
-
* The adrCode and loadType parameters are independent; please provide both if applicable.
|
|
1667
|
-
* @see https://unece.org/about-adr
|
|
1668
|
-
*/
|
|
1669
|
-
adrCode?: 'B' | 'C' | 'D' | 'E';
|
|
1670
|
-
/**
|
|
1671
|
-
*
|
|
1672
|
-
* The vehicle is used for commercial purposes (big letters on the side) and thus may not be allowed to drive on some roads.
|
|
1673
|
-
* This restriction is applicable only in some countries (e.g. US).
|
|
1674
|
-
*
|
|
1675
|
-
* @default false
|
|
1676
|
-
*/
|
|
1677
|
-
commercial?: boolean;
|
|
1678
1526
|
};
|
|
1679
1527
|
};
|
|
1680
1528
|
//#endregion
|
|
@@ -1694,7 +1542,7 @@ type VehicleRestrictions = {
|
|
|
1694
1542
|
*
|
|
1695
1543
|
* @group Vehicle
|
|
1696
1544
|
*/
|
|
1697
|
-
type CombustionVehicleState = {
|
|
1545
|
+
export type CombustionVehicleState = {
|
|
1698
1546
|
/**
|
|
1699
1547
|
* Specifies the current supply of fuel in liters.
|
|
1700
1548
|
*
|
|
@@ -1735,7 +1583,7 @@ type CombustionVehicleState = {
|
|
|
1735
1583
|
*
|
|
1736
1584
|
* @group Vehicle
|
|
1737
1585
|
*/
|
|
1738
|
-
type ElectricVehicleStatePCT = {
|
|
1586
|
+
export type ElectricVehicleStatePCT = {
|
|
1739
1587
|
/**
|
|
1740
1588
|
* Specifies the current battery charge in percentage.
|
|
1741
1589
|
*
|
|
@@ -1771,7 +1619,7 @@ type ElectricVehicleStatePCT = {
|
|
|
1771
1619
|
*
|
|
1772
1620
|
* @group Vehicle
|
|
1773
1621
|
*/
|
|
1774
|
-
type ElectricVehicleStateKWH = {
|
|
1622
|
+
export type ElectricVehicleStateKWH = {
|
|
1775
1623
|
/**
|
|
1776
1624
|
* Specifies the current battery charge in kWh.
|
|
1777
1625
|
*
|
|
@@ -1817,7 +1665,7 @@ type ElectricVehicleStateKWH = {
|
|
|
1817
1665
|
*
|
|
1818
1666
|
* @group Vehicle
|
|
1819
1667
|
*/
|
|
1820
|
-
type ElectricVehicleState = ElectricVehicleStatePCT | ElectricVehicleStateKWH;
|
|
1668
|
+
export type ElectricVehicleState = ElectricVehicleStatePCT | ElectricVehicleStateKWH;
|
|
1821
1669
|
/**
|
|
1822
1670
|
* Generic vehicle state properties applicable to all vehicle types.
|
|
1823
1671
|
*
|
|
@@ -1833,7 +1681,7 @@ type ElectricVehicleState = ElectricVehicleStatePCT | ElectricVehicleStateKWH;
|
|
|
1833
1681
|
*
|
|
1834
1682
|
* @group Vehicle
|
|
1835
1683
|
*/
|
|
1836
|
-
type GenericVehicleState = {
|
|
1684
|
+
export type GenericVehicleState = {
|
|
1837
1685
|
/**
|
|
1838
1686
|
* The current heading at the starting point, in degrees starting at true North and continuing in a clockwise direction.
|
|
1839
1687
|
*
|
|
@@ -1901,7 +1749,7 @@ type GenericVehicleState = {
|
|
|
1901
1749
|
*
|
|
1902
1750
|
* @group Vehicle
|
|
1903
1751
|
*/
|
|
1904
|
-
type VehicleState<E extends VehicleEngineType = undefined> = GenericVehicleState & (E extends 'combustion' ? CombustionVehicleState : E extends 'electric' ? ElectricVehicleState : {});
|
|
1752
|
+
export type VehicleState<E extends VehicleEngineType = undefined> = GenericVehicleState & (E extends 'combustion' ? CombustionVehicleState : E extends 'electric' ? ElectricVehicleState : {});
|
|
1905
1753
|
//#endregion
|
|
1906
1754
|
//#region src/shared/types/vehicleParams.d.ts
|
|
1907
1755
|
/**
|
|
@@ -1916,7 +1764,6 @@ type VehicleState<E extends VehicleEngineType = undefined> = GenericVehicleState
|
|
|
1916
1764
|
* const params: GenericVehicleParams = {
|
|
1917
1765
|
* model: {
|
|
1918
1766
|
* dimensions: {
|
|
1919
|
-
* heightMeters: 2.5,
|
|
1920
1767
|
* weightKG: 3500
|
|
1921
1768
|
* }
|
|
1922
1769
|
* }
|
|
@@ -1925,7 +1772,7 @@ type VehicleState<E extends VehicleEngineType = undefined> = GenericVehicleState
|
|
|
1925
1772
|
*
|
|
1926
1773
|
* @group Vehicle
|
|
1927
1774
|
*/
|
|
1928
|
-
type GenericVehicleParams = {
|
|
1775
|
+
export type GenericVehicleParams = {
|
|
1929
1776
|
/**
|
|
1930
1777
|
* Model (static properties) of the vehicle with generic/unspecified engine type.
|
|
1931
1778
|
*
|
|
@@ -1982,7 +1829,7 @@ type GenericVehicleParams = {
|
|
|
1982
1829
|
*
|
|
1983
1830
|
* @group Vehicle
|
|
1984
1831
|
*/
|
|
1985
|
-
type CombustionVehicleParams = {
|
|
1832
|
+
export type CombustionVehicleParams = {
|
|
1986
1833
|
/**
|
|
1987
1834
|
* Combustion vehicles.
|
|
1988
1835
|
*
|
|
@@ -2090,7 +1937,7 @@ type CombustionVehicleParams = {
|
|
|
2090
1937
|
*
|
|
2091
1938
|
* @group Vehicle
|
|
2092
1939
|
*/
|
|
2093
|
-
type ElectricVehicleParams = {
|
|
1940
|
+
export type ElectricVehicleParams = {
|
|
2094
1941
|
/**
|
|
2095
1942
|
* Electric vehicles (EV).
|
|
2096
1943
|
*
|
|
@@ -2128,7 +1975,7 @@ type ElectricVehicleParams = {
|
|
|
2128
1975
|
* - **Model**: Static properties (dimensions, engine specs)
|
|
2129
1976
|
* - **State**: Current conditions (fuel/charge level, heading)
|
|
2130
1977
|
* - **Preferences**: Routing preferences (charging stops, etc.)
|
|
2131
|
-
* - **Restrictions**:
|
|
1978
|
+
* - **Restrictions**: Maximum speed applied during route planning
|
|
2132
1979
|
*
|
|
2133
1980
|
* **Three Types:**
|
|
2134
1981
|
* 1. **Generic**: Basic vehicle without engine-specific features
|
|
@@ -2136,11 +1983,9 @@ type ElectricVehicleParams = {
|
|
|
2136
1983
|
* 3. **Electric**: Battery-powered with charging stop optimization
|
|
2137
1984
|
*
|
|
2138
1985
|
* **When to Specify:**
|
|
2139
|
-
* -
|
|
1986
|
+
* - Weight restrictions matter (trucks, vans)
|
|
2140
1987
|
* - Accurate range prediction needed
|
|
2141
1988
|
* - EV routing with charging stops
|
|
2142
|
-
* - Hazardous material transport
|
|
2143
|
-
* - Commercial vehicle routing
|
|
2144
1989
|
*
|
|
2145
1990
|
* @example
|
|
2146
1991
|
* ```typescript
|
|
@@ -2148,12 +1993,8 @@ type ElectricVehicleParams = {
|
|
|
2148
1993
|
* const van: VehicleParameters = {
|
|
2149
1994
|
* model: {
|
|
2150
1995
|
* dimensions: {
|
|
2151
|
-
* heightMeters: 2.5,
|
|
2152
1996
|
* weightKG: 3500
|
|
2153
1997
|
* }
|
|
2154
|
-
* },
|
|
2155
|
-
* restrictions: {
|
|
2156
|
-
* commercial: true
|
|
2157
1998
|
* }
|
|
2158
1999
|
* };
|
|
2159
2000
|
*
|
|
@@ -2192,17 +2033,14 @@ type ElectricVehicleParams = {
|
|
|
2192
2033
|
* }
|
|
2193
2034
|
* };
|
|
2194
2035
|
*
|
|
2195
|
-
* //
|
|
2196
|
-
* const
|
|
2036
|
+
* // Speed-limited truck
|
|
2037
|
+
* const truck: VehicleParameters = {
|
|
2197
2038
|
* model: {
|
|
2198
2039
|
* dimensions: {
|
|
2199
|
-
* heightMeters: 4.0,
|
|
2200
2040
|
* weightKG: 40000
|
|
2201
2041
|
* }
|
|
2202
2042
|
* },
|
|
2203
2043
|
* restrictions: {
|
|
2204
|
-
* loadTypes: ['USHazmatClass3'],
|
|
2205
|
-
* commercial: true,
|
|
2206
2044
|
* maxSpeedKMH: 80
|
|
2207
2045
|
* }
|
|
2208
2046
|
* };
|
|
@@ -2210,22 +2048,9 @@ type ElectricVehicleParams = {
|
|
|
2210
2048
|
*
|
|
2211
2049
|
* @group Vehicle
|
|
2212
2050
|
*/
|
|
2213
|
-
type VehicleParameters = (GenericVehicleParams | CombustionVehicleParams | ElectricVehicleParams) & VehicleRestrictions;
|
|
2051
|
+
export type VehicleParameters = (GenericVehicleParams | CombustionVehicleParams | ElectricVehicleParams) & VehicleRestrictions;
|
|
2214
2052
|
//#endregion
|
|
2215
2053
|
//#region src/shared/types/commonRoutingParams.d.ts
|
|
2216
|
-
/**
|
|
2217
|
-
* Basic low/normal/high intensity level option.
|
|
2218
|
-
*
|
|
2219
|
-
* Used for configuring route characteristics like hilliness or windingness.
|
|
2220
|
-
*
|
|
2221
|
-
* @remarks
|
|
2222
|
-
* - `low`: Minimal intensity
|
|
2223
|
-
* - `normal`: Moderate intensity
|
|
2224
|
-
* - `high`: Maximum intensity
|
|
2225
|
-
*
|
|
2226
|
-
* @group Routing
|
|
2227
|
-
*/
|
|
2228
|
-
type LNH = 'low' | 'normal' | 'high';
|
|
2229
2054
|
/**
|
|
2230
2055
|
* Available route types, where each type specifies the type of optimization used when calculating routes:
|
|
2231
2056
|
* * **fast**: Route calculation is optimized by travel time, while keeping the routes sensible. For example, the calculation may avoid shortcuts along inconvenient side roads or long detours that only save very little time.
|
|
@@ -2236,7 +2061,7 @@ type LNH = 'low' | 'normal' | 'high';
|
|
|
2236
2061
|
*
|
|
2237
2062
|
* @group Routing
|
|
2238
2063
|
*/
|
|
2239
|
-
declare const routeTypes: readonly ["fast", "short", "efficient", "thrilling"];
|
|
2064
|
+
export declare const routeTypes: readonly ["fast", "short", "efficient", "thrilling"];
|
|
2240
2065
|
/**
|
|
2241
2066
|
* Route optimization strategy for route calculation.
|
|
2242
2067
|
*
|
|
@@ -2282,7 +2107,7 @@ declare const routeTypes: readonly ["fast", "short", "efficient", "thrilling"];
|
|
|
2282
2107
|
*
|
|
2283
2108
|
* @group Routing
|
|
2284
2109
|
*/
|
|
2285
|
-
type RouteType = (typeof routeTypes)[number];
|
|
2110
|
+
export type RouteType = (typeof routeTypes)[number];
|
|
2286
2111
|
/**
|
|
2287
2112
|
* Traffic consideration mode for route calculation.
|
|
2288
2113
|
*
|
|
@@ -2314,7 +2139,7 @@ type RouteType = (typeof routeTypes)[number];
|
|
|
2314
2139
|
*
|
|
2315
2140
|
* @group Routing
|
|
2316
2141
|
*/
|
|
2317
|
-
type TrafficInput = 'live' | 'historical';
|
|
2142
|
+
export type TrafficInput = 'live' | 'historical';
|
|
2318
2143
|
/**
|
|
2319
2144
|
* Cost model criteria for route optimization.
|
|
2320
2145
|
*
|
|
@@ -2357,7 +2182,7 @@ type TrafficInput = 'live' | 'historical';
|
|
|
2357
2182
|
*
|
|
2358
2183
|
* @group Routing
|
|
2359
2184
|
*/
|
|
2360
|
-
type CostModel = {
|
|
2185
|
+
export type CostModel = {
|
|
2361
2186
|
/**
|
|
2362
2187
|
* Specifies something that the route calculation should try to avoid when determining the route.
|
|
2363
2188
|
* @default None
|
|
@@ -2461,7 +2286,7 @@ type DepartArriveOption = 'departAt' | 'arriveBy';
|
|
|
2461
2286
|
*
|
|
2462
2287
|
* @group Routing
|
|
2463
2288
|
*/
|
|
2464
|
-
type DepartArriveParams<Option extends DepartArriveOption = DepartArriveOption> = {
|
|
2289
|
+
export type DepartArriveParams<Option extends DepartArriveOption = DepartArriveOption> = {
|
|
2465
2290
|
/**
|
|
2466
2291
|
* Whether to specify a departure or arrival time.
|
|
2467
2292
|
*
|
|
@@ -2558,17 +2383,11 @@ type DepartArriveParams<Option extends DepartArriveOption = DepartArriveOption>
|
|
|
2558
2383
|
* vehicle: {
|
|
2559
2384
|
* model: {
|
|
2560
2385
|
* dimensions: {
|
|
2561
|
-
* lengthMeters: 16.5,
|
|
2562
|
-
* widthMeters: 2.5,
|
|
2563
|
-
* heightMeters: 4.0,
|
|
2564
2386
|
* weightKG: 40000
|
|
2565
|
-
* },
|
|
2566
|
-
* restrictions: {
|
|
2567
|
-
* restrictions: {
|
|
2568
|
-
* commercial: true,
|
|
2569
|
-
* maxSpeedKMH: 90
|
|
2570
|
-
* }
|
|
2571
2387
|
* }
|
|
2388
|
+
* },
|
|
2389
|
+
* restrictions: {
|
|
2390
|
+
* maxSpeedKMH: 90
|
|
2572
2391
|
* }
|
|
2573
2392
|
* }
|
|
2574
2393
|
* };
|
|
@@ -2578,7 +2397,7 @@ type DepartArriveParams<Option extends DepartArriveOption = DepartArriveOption>
|
|
|
2578
2397
|
*
|
|
2579
2398
|
* @group Routing
|
|
2580
2399
|
*/
|
|
2581
|
-
type CommonRoutingParams = {
|
|
2400
|
+
export type CommonRoutingParams = {
|
|
2582
2401
|
/**
|
|
2583
2402
|
* Criteria that specifies what paths to prefer during routing.
|
|
2584
2403
|
*/
|
|
@@ -2639,7 +2458,7 @@ type CommonRoutingParams = {
|
|
|
2639
2458
|
*
|
|
2640
2459
|
* @group Search
|
|
2641
2460
|
*/
|
|
2642
|
-
type RelatedPoisRequest = 'child' | 'parent' | 'all' | 'off';
|
|
2461
|
+
export type RelatedPoisRequest = 'child' | 'parent' | 'all' | 'off';
|
|
2643
2462
|
/**
|
|
2644
2463
|
* Timezone data format for POI responses.
|
|
2645
2464
|
*
|
|
@@ -2665,7 +2484,7 @@ type RelatedPoisRequest = 'child' | 'parent' | 'all' | 'off';
|
|
|
2665
2484
|
*
|
|
2666
2485
|
* @group Search
|
|
2667
2486
|
*/
|
|
2668
|
-
type TimeZoneRequest = 'iana';
|
|
2487
|
+
export type TimeZoneRequest = 'iana';
|
|
2669
2488
|
/**
|
|
2670
2489
|
* Common parameters for search services with POI filtering capabilities.
|
|
2671
2490
|
*
|
|
@@ -2692,7 +2511,7 @@ type TimeZoneRequest = 'iana';
|
|
|
2692
2511
|
*
|
|
2693
2512
|
* @group Search
|
|
2694
2513
|
*/
|
|
2695
|
-
type CommonSearchParams<ApiRequest, ApiResponse> = CommonPlacesParams<ApiRequest, ApiResponse> & {
|
|
2514
|
+
export type CommonSearchParams<ApiRequest, ApiResponse> = CommonPlacesParams<ApiRequest, ApiResponse> & {
|
|
2696
2515
|
/**
|
|
2697
2516
|
* Search query string.
|
|
2698
2517
|
*
|
|
@@ -3245,7 +3064,7 @@ type SummaryQueryType = 'NEARBY' | 'NON_NEAR';
|
|
|
3245
3064
|
*
|
|
3246
3065
|
* @group Search
|
|
3247
3066
|
*/
|
|
3248
|
-
type SearchSummary = {
|
|
3067
|
+
export type SearchSummary = {
|
|
3249
3068
|
/**
|
|
3250
3069
|
* The search query as interpreted and processed by the search engine.
|
|
3251
3070
|
*
|
|
@@ -3751,7 +3570,7 @@ type AlongRouteSearchTemplate = ServiceTemplate<AlongRouteSearchParams, AlongRou
|
|
|
3751
3570
|
*
|
|
3752
3571
|
* @ignore (exposed via 'search')
|
|
3753
3572
|
*/
|
|
3754
|
-
declare const alongRouteSearch: (params: AlongRouteSearchParams, customTemplate?: Partial<AlongRouteSearchTemplate>) => Promise<AlongRouteSearchResponse>;
|
|
3573
|
+
export declare const alongRouteSearch: (params: AlongRouteSearchParams, customTemplate?: Partial<AlongRouteSearchTemplate>) => Promise<AlongRouteSearchResponse>;
|
|
3755
3574
|
//#endregion
|
|
3756
3575
|
//#region src/autocomplete-search/types/autocompleteSearchResponse.d.ts
|
|
3757
3576
|
/**
|
|
@@ -4265,7 +4084,7 @@ type AutocompleteSearchTemplate = ServiceTemplate<AutocompleteSearchParams, URL,
|
|
|
4265
4084
|
*
|
|
4266
4085
|
* @group Autocomplete Search
|
|
4267
4086
|
*/
|
|
4268
|
-
declare const autocompleteSearch: (params: AutocompleteSearchParams, customTemplate?: Partial<AutocompleteSearchTemplate>) => Promise<AutocompleteSearchResponse>;
|
|
4087
|
+
export declare const autocompleteSearch: (params: AutocompleteSearchParams, customTemplate?: Partial<AutocompleteSearchTemplate>) => Promise<AutocompleteSearchResponse>;
|
|
4269
4088
|
//#endregion
|
|
4270
4089
|
//#region src/along-route-search/requestBuilder.d.ts
|
|
4271
4090
|
/**
|
|
@@ -5808,7 +5627,7 @@ type ReachableRangeResponseAPI = {
|
|
|
5808
5627
|
};
|
|
5809
5628
|
//#endregion
|
|
5810
5629
|
//#region src/reachable-range/types/reachableRangeParams.d.ts
|
|
5811
|
-
declare const budgetTypes: readonly ["timeMinutes", "remainingChargeCPT", "spentChargePCT", "spentFuelLiters", "distanceKM"];
|
|
5630
|
+
export declare const budgetTypes: readonly ["timeMinutes", "remainingChargeCPT", "spentChargePCT", "spentFuelLiters", "distanceKM"];
|
|
5812
5631
|
/**
|
|
5813
5632
|
* Type of budget constraint for reachable range calculation.
|
|
5814
5633
|
*
|
|
@@ -5835,7 +5654,7 @@ declare const budgetTypes: readonly ["timeMinutes", "remainingChargeCPT", "spent
|
|
|
5835
5654
|
*
|
|
5836
5655
|
* @group Reachable Range
|
|
5837
5656
|
*/
|
|
5838
|
-
type BudgetType = (typeof budgetTypes)[number];
|
|
5657
|
+
export type BudgetType = (typeof budgetTypes)[number];
|
|
5839
5658
|
/**
|
|
5840
5659
|
* Budget constraint for reachable range calculation.
|
|
5841
5660
|
*
|
|
@@ -5879,7 +5698,7 @@ type BudgetType = (typeof budgetTypes)[number];
|
|
|
5879
5698
|
*
|
|
5880
5699
|
* @group Reachable Range
|
|
5881
5700
|
*/
|
|
5882
|
-
type ReachableRangeBudget = {
|
|
5701
|
+
export type ReachableRangeBudget = {
|
|
5883
5702
|
/**
|
|
5884
5703
|
* The type of budget, including units.
|
|
5885
5704
|
*
|
|
@@ -5909,6 +5728,50 @@ type ReachableRangeBudget = {
|
|
|
5909
5728
|
*/
|
|
5910
5729
|
value: number;
|
|
5911
5730
|
};
|
|
5731
|
+
/**
|
|
5732
|
+
* Route features `calculateReachableRange` can avoid.
|
|
5733
|
+
*
|
|
5734
|
+
* @remarks
|
|
5735
|
+
* Every {@link Avoidable} except `alreadyUsedRoads`, which this endpoint rejects with
|
|
5736
|
+
* *"Avoid alreadyUsedRoads not supported for calculateReachableRange"*. It stays available on
|
|
5737
|
+
* `calculateRoute`.
|
|
5738
|
+
*
|
|
5739
|
+
* @group Reachable Range
|
|
5740
|
+
*/
|
|
5741
|
+
export type ReachableRangeAvoidable = Exclude<Avoidable, 'alreadyUsedRoads'>;
|
|
5742
|
+
/**
|
|
5743
|
+
* Cost model accepted by `calculateReachableRange`.
|
|
5744
|
+
*
|
|
5745
|
+
* @remarks
|
|
5746
|
+
* {@link CostModel} without `avoidAreas`, which this endpoint has no parameter for, and with the
|
|
5747
|
+
* narrower {@link ReachableRangeAvoidable} avoid list.
|
|
5748
|
+
*
|
|
5749
|
+
* @group Reachable Range
|
|
5750
|
+
*/
|
|
5751
|
+
export type ReachableRangeCostModel = Omit<CostModel, 'avoid' | 'avoidAreas'> & {
|
|
5752
|
+
/**
|
|
5753
|
+
* Route features to avoid when calculating the range.
|
|
5754
|
+
*/
|
|
5755
|
+
avoid?: ReachableRangeAvoidable[];
|
|
5756
|
+
};
|
|
5757
|
+
/**
|
|
5758
|
+
* Vehicle parameters accepted by `calculateReachableRange`.
|
|
5759
|
+
*
|
|
5760
|
+
* @remarks
|
|
5761
|
+
* {@link VehicleParameters} without `state.heading`, which this endpoint rejects with
|
|
5762
|
+
* *"parameter [vehicleHeading] not supported"*. It stays available on `calculateRoute`, where the
|
|
5763
|
+
* routing API takes it as `vehicleHeadingInDegrees`.
|
|
5764
|
+
*
|
|
5765
|
+
* Everything else is unchanged, including the engine-specific `state` variants -- an electric
|
|
5766
|
+
* vehicle still picks between the percentage and kWh forms.
|
|
5767
|
+
*
|
|
5768
|
+
* @group Reachable Range
|
|
5769
|
+
*/
|
|
5770
|
+
export type ReachableRangeVehicleParameters = (Omit<GenericVehicleParams, 'state'> | (Omit<CombustionVehicleParams, 'state'> & {
|
|
5771
|
+
state?: CombustionVehicleState;
|
|
5772
|
+
}) | (Omit<ElectricVehicleParams, 'state'> & {
|
|
5773
|
+
state?: ElectricVehicleState;
|
|
5774
|
+
})) & VehicleRestrictions;
|
|
5912
5775
|
/**
|
|
5913
5776
|
* Parameters specific to reachable range calculation.
|
|
5914
5777
|
*
|
|
@@ -5918,7 +5781,23 @@ type ReachableRangeBudget = {
|
|
|
5918
5781
|
*
|
|
5919
5782
|
* @group Reachable Range
|
|
5920
5783
|
*/
|
|
5921
|
-
type ReachableRangeOwnParams = {
|
|
5784
|
+
export type ReachableRangeOwnParams = {
|
|
5785
|
+
/**
|
|
5786
|
+
* How the routes underlying the range are optimized, and what they avoid.
|
|
5787
|
+
*
|
|
5788
|
+
* @remarks
|
|
5789
|
+
* Narrower than {@link CostModel}: `calculateReachableRange` rejects `alreadyUsedRoads` and has
|
|
5790
|
+
* no avoid-areas parameter, so neither is offered here.
|
|
5791
|
+
*/
|
|
5792
|
+
costModel?: ReachableRangeCostModel;
|
|
5793
|
+
/**
|
|
5794
|
+
* Parameters for the vehicle whose reachable range is calculated.
|
|
5795
|
+
*
|
|
5796
|
+
* @remarks
|
|
5797
|
+
* Narrower than {@link VehicleParameters}: `calculateReachableRange` has no vehicle-heading
|
|
5798
|
+
* parameter, so {@link ReachableRangeVehicleParameters} does not offer `state.heading`.
|
|
5799
|
+
*/
|
|
5800
|
+
vehicle?: ReachableRangeVehicleParameters;
|
|
5922
5801
|
/**
|
|
5923
5802
|
* Location from which the range calculation should start.
|
|
5924
5803
|
*
|
|
@@ -6082,7 +5961,7 @@ type ReachableRangeOwnParams = {
|
|
|
6082
5961
|
*
|
|
6083
5962
|
* @group Reachable Range
|
|
6084
5963
|
*/
|
|
6085
|
-
type ReachableRangeParams = CommonServiceParams<ReachableRangeRequestAPI, ReachableRangeResponseAPI> & CommonRoutingParams & ReachableRangeOwnParams;
|
|
5964
|
+
export type ReachableRangeParams = CommonServiceParams<ReachableRangeRequestAPI, ReachableRangeResponseAPI> & Omit<CommonRoutingParams, 'costModel' | 'vehicle'> & ReachableRangeOwnParams;
|
|
6086
5965
|
//#endregion
|
|
6087
5966
|
//#region src/reachable-range/reachableRangeTemplate.d.ts
|
|
6088
5967
|
type ReachableRangeTemplate = ServiceTemplate<ReachableRangeParams, ReachableRangeRequestAPI, ReachableRangeResponseAPI, PolygonFeature<ReachableRangeParams>>;
|
|
@@ -6110,51 +5989,68 @@ declare const customize$4: {
|
|
|
6110
5989
|
};
|
|
6111
5990
|
//#endregion
|
|
6112
5991
|
//#region src/revgeo/types/apiTypes.d.ts
|
|
5992
|
+
/** Orbis Reverse Geocoding v2 top-level result type.
|
|
5993
|
+
* (geocode v2 also has `'intersection'`; reverse geocoding does not.)
|
|
5994
|
+
* @ignore
|
|
5995
|
+
*/
|
|
5996
|
+
type ReverseGeocodingResultTypeAPI = 'address' | 'street' | 'area';
|
|
5997
|
+
/** Orbis Reverse Geocoding v2 area sub-type.
|
|
5998
|
+
* @ignore
|
|
5999
|
+
*/
|
|
6000
|
+
type ReverseGeocodingAreaTypeAPI = 'country' | 'countrySubdivision' | 'countrySecondarySubdivision' | 'countryTertiarySubdivision' | 'municipality' | 'municipalitySubdivision' | 'municipalitySecondarySubdivision' | 'neighborhood' | 'postalCode';
|
|
6001
|
+
/**
|
|
6002
|
+
* Address object as returned by the Orbis Reverse Geocoding v2 API.
|
|
6003
|
+
* @ignore
|
|
6004
|
+
*/
|
|
6005
|
+
type ReverseGeocodingAddressAPI = {
|
|
6006
|
+
houseNumber?: string;
|
|
6007
|
+
street?: string;
|
|
6008
|
+
municipalitySubdivision?: string;
|
|
6009
|
+
municipalitySecondarySubdivision?: string;
|
|
6010
|
+
neighborhood?: string;
|
|
6011
|
+
municipality?: string;
|
|
6012
|
+
countrySecondarySubdivision?: string;
|
|
6013
|
+
countryTertiarySubdivision?: string;
|
|
6014
|
+
countrySubdivision?: string;
|
|
6015
|
+
countrySubdivisionCodeIso?: string;
|
|
6016
|
+
postalCode?: string;
|
|
6017
|
+
postalName?: string;
|
|
6018
|
+
extendedPostalCode?: string;
|
|
6019
|
+
countryCodeIso2?: string;
|
|
6020
|
+
country?: string;
|
|
6021
|
+
/** Road numbers of the street (reverse geocoding only; not returned by geocode v2). */
|
|
6022
|
+
routeNumbers?: string[];
|
|
6023
|
+
};
|
|
6024
|
+
/**
|
|
6025
|
+
* A single result element from the Orbis Reverse Geocoding v2 API.
|
|
6026
|
+
* @ignore
|
|
6027
|
+
*/
|
|
6028
|
+
type ReverseGeocodingResultAPI = {
|
|
6029
|
+
/** Unique identifier of the result. It can change between new data releases. */
|
|
6030
|
+
id: string;
|
|
6031
|
+
/** Type of result: `address`, `street`, or `area`. */
|
|
6032
|
+
type: ReverseGeocodingResultTypeAPI;
|
|
6033
|
+
/** Localized display title for the result. */
|
|
6034
|
+
title: string;
|
|
6035
|
+
/** Sub-type of an `area` result; present only when `type` is `area`. */
|
|
6036
|
+
areaType?: ReverseGeocodingAreaTypeAPI;
|
|
6037
|
+
/** The structured address for the result. */
|
|
6038
|
+
address: ReverseGeocodingAddressAPI;
|
|
6039
|
+
/** The position of the result, in GeoJSON format. */
|
|
6040
|
+
position: Point;
|
|
6041
|
+
/** List of access points (e.g. building entrances) of the location, in GeoJSON format. */
|
|
6042
|
+
accessPoints?: Array<{
|
|
6043
|
+
position: Point;
|
|
6044
|
+
}>;
|
|
6045
|
+
};
|
|
6113
6046
|
/**
|
|
6114
6047
|
* @ignore
|
|
6115
6048
|
*/
|
|
6116
6049
|
type ReverseGeocodingResponseAPI = {
|
|
6117
|
-
|
|
6118
|
-
queryTime: number;
|
|
6119
|
-
numResults: number;
|
|
6120
|
-
};
|
|
6121
|
-
addresses: [{
|
|
6122
|
-
address: AddressProperties & {
|
|
6123
|
-
boundingBox?: {
|
|
6124
|
-
northEast: string;
|
|
6125
|
-
southWest: string;
|
|
6126
|
-
entity: 'position';
|
|
6127
|
-
};
|
|
6128
|
-
sideOfStreet?: SideOfStreet;
|
|
6129
|
-
offsetPosition?: string;
|
|
6130
|
-
[key: string]: any;
|
|
6131
|
-
};
|
|
6132
|
-
linkedAddress?: AddressProperties & {
|
|
6133
|
-
boundingBox?: {
|
|
6134
|
-
northEast: string;
|
|
6135
|
-
southWest: string;
|
|
6136
|
-
entity: 'position';
|
|
6137
|
-
};
|
|
6138
|
-
[key: string]: any;
|
|
6139
|
-
};
|
|
6140
|
-
dataSources?: PlaceDataSources;
|
|
6141
|
-
entityType?: PlaceType;
|
|
6142
|
-
mapcodes?: Mapcode[];
|
|
6143
|
-
position: string;
|
|
6144
|
-
roadUse?: string[];
|
|
6145
|
-
}];
|
|
6050
|
+
results: ReverseGeocodingResultAPI[];
|
|
6146
6051
|
};
|
|
6147
6052
|
//#endregion
|
|
6148
6053
|
//#region src/revgeo/types/reverseGeocodingParams.d.ts
|
|
6149
|
-
/**
|
|
6150
|
-
* Road use classification types for filtering reverse geocoding results.
|
|
6151
|
-
*
|
|
6152
|
-
* @remarks
|
|
6153
|
-
* Use these values to restrict reverse geocoding results to specific road types.
|
|
6154
|
-
*
|
|
6155
|
-
* @group Reverse Geocoding
|
|
6156
|
-
*/
|
|
6157
|
-
type RoadUse = 'LimitedAccess' | 'Arterial' | 'Terminal' | 'Ramp' | 'Rotary' | 'LocalStreet';
|
|
6158
6054
|
/**
|
|
6159
6055
|
* Required parameters for reverse geocoding requests.
|
|
6160
6056
|
*
|
|
@@ -6183,30 +6079,13 @@ type ReverseGeocodingMandatoryParams = {
|
|
|
6183
6079
|
* @group Reverse Geocoding
|
|
6184
6080
|
*/
|
|
6185
6081
|
type ReverseGeocodingOptionalParams = {
|
|
6186
|
-
/**
|
|
6187
|
-
* Controls newline formatting in the returned address.
|
|
6188
|
-
*
|
|
6189
|
-
* @remarks
|
|
6190
|
-
* When `true`, the formatted address will contain newline characters.
|
|
6191
|
-
* When `false` or omitted, newlines are converted to spaces.
|
|
6192
|
-
*
|
|
6193
|
-
* @defaultValue `false`
|
|
6194
|
-
*/
|
|
6195
|
-
allowFreeformNewline?: boolean;
|
|
6196
6082
|
/**
|
|
6197
6083
|
* Filters results to specific geography entity types.
|
|
6198
6084
|
*
|
|
6199
6085
|
* @remarks
|
|
6200
6086
|
* Narrows the search to specified geography types (e.g., country, state, city).
|
|
6201
|
-
* The response includes the geography ID, which can be used to retrieve the geometry.
|
|
6202
6087
|
*
|
|
6203
|
-
* **Note:** When set,
|
|
6204
|
-
* - `heading`
|
|
6205
|
-
* - `number`
|
|
6206
|
-
* - `returnRoadUse`
|
|
6207
|
-
* - `returnSpeedLimit`
|
|
6208
|
-
* - `roadUse`
|
|
6209
|
-
* - `returnMatchType`
|
|
6088
|
+
* **Note:** When set, `heading` is ignored.
|
|
6210
6089
|
*/
|
|
6211
6090
|
geographyType?: GeographyType[];
|
|
6212
6091
|
/**
|
|
@@ -6214,7 +6093,7 @@ type ReverseGeocodingOptionalParams = {
|
|
|
6214
6093
|
*
|
|
6215
6094
|
* @remarks
|
|
6216
6095
|
* Specifies the travel direction along a road segment to provide
|
|
6217
|
-
* direction-aware address information.
|
|
6096
|
+
* direction-aware address information. Ignored when `geographyType` is set.
|
|
6218
6097
|
*
|
|
6219
6098
|
* - `0` = North
|
|
6220
6099
|
* - `90` = East
|
|
@@ -6230,36 +6109,6 @@ type ReverseGeocodingOptionalParams = {
|
|
|
6230
6109
|
* @maximum 360
|
|
6231
6110
|
*/
|
|
6232
6111
|
heading?: number;
|
|
6233
|
-
/**
|
|
6234
|
-
* Enables mapcode inclusion in the response.
|
|
6235
|
-
*
|
|
6236
|
-
* @remarks
|
|
6237
|
-
* Returns a comma-separated list of mapcodes for the location.
|
|
6238
|
-
* Mapcodes are short codes representing specific locations within a few meters.
|
|
6239
|
-
* Can filter to show only selected mapcode types.
|
|
6240
|
-
*
|
|
6241
|
-
* Available types:
|
|
6242
|
-
* - `Local` - Territory-specific mapcode
|
|
6243
|
-
* - `International` - Globally valid mapcode
|
|
6244
|
-
* - `Alternative` - Alternative mapcode representations
|
|
6245
|
-
*
|
|
6246
|
-
* @see {@link https://www.mapcode.com | Mapcode Project}
|
|
6247
|
-
*/
|
|
6248
|
-
mapcodes?: MapcodeType[];
|
|
6249
|
-
/**
|
|
6250
|
-
* Street number for enhanced address matching.
|
|
6251
|
-
*
|
|
6252
|
-
* @remarks
|
|
6253
|
-
* When provided, the response may include:
|
|
6254
|
-
* - Side of the street (Left/Right)
|
|
6255
|
-
* - Offset position for the street number
|
|
6256
|
-
*
|
|
6257
|
-
* @example
|
|
6258
|
-
* ```ts
|
|
6259
|
-
* number: "123"
|
|
6260
|
-
* ```
|
|
6261
|
-
*/
|
|
6262
|
-
number?: string;
|
|
6263
6112
|
/**
|
|
6264
6113
|
* Search radius in meters from the specified position.
|
|
6265
6114
|
*
|
|
@@ -6270,48 +6119,6 @@ type ReverseGeocodingOptionalParams = {
|
|
|
6270
6119
|
* @minimum 1
|
|
6271
6120
|
*/
|
|
6272
6121
|
radiusMeters?: number;
|
|
6273
|
-
/**
|
|
6274
|
-
* Includes match type information in the response.
|
|
6275
|
-
*
|
|
6276
|
-
* @remarks
|
|
6277
|
-
* When `true`, the response includes details about how well the
|
|
6278
|
-
* geocoder matched the provided coordinates to an address.
|
|
6279
|
-
*
|
|
6280
|
-
* @defaultValue `false`
|
|
6281
|
-
*/
|
|
6282
|
-
returnMatchType?: boolean;
|
|
6283
|
-
/**
|
|
6284
|
-
* Includes road use classification in the response.
|
|
6285
|
-
*
|
|
6286
|
-
* @remarks
|
|
6287
|
-
* When `true` and reverse geocoding at street level, returns an array
|
|
6288
|
-
* of applicable road use types for the location.
|
|
6289
|
-
*
|
|
6290
|
-
* @defaultValue `false`
|
|
6291
|
-
*/
|
|
6292
|
-
returnRoadUse?: boolean;
|
|
6293
|
-
/**
|
|
6294
|
-
* Includes speed limit information in the response.
|
|
6295
|
-
*
|
|
6296
|
-
* @remarks
|
|
6297
|
-
* When `true`, returns the speed limit at the given location if available.
|
|
6298
|
-
*
|
|
6299
|
-
* @defaultValue `false`
|
|
6300
|
-
*/
|
|
6301
|
-
returnSpeedLimit?: boolean;
|
|
6302
|
-
/**
|
|
6303
|
-
* Restricts results to specific road use types.
|
|
6304
|
-
*
|
|
6305
|
-
* @remarks
|
|
6306
|
-
* Filters reverse geocoding results to only include addresses
|
|
6307
|
-
* on roads matching the specified use classifications.
|
|
6308
|
-
*
|
|
6309
|
-
* @example
|
|
6310
|
-
* ```ts
|
|
6311
|
-
* roadUses: ['LimitedAccess', 'Arterial'] // Only highways and major roads
|
|
6312
|
-
* ```
|
|
6313
|
-
*/
|
|
6314
|
-
roadUses?: RoadUse[];
|
|
6315
6122
|
/**
|
|
6316
6123
|
* Specifies the geopolitical view for the results.
|
|
6317
6124
|
*
|
|
@@ -6321,13 +6128,15 @@ type ReverseGeocodingOptionalParams = {
|
|
|
6321
6128
|
* Available views:
|
|
6322
6129
|
* - `Unified` - International view (default)
|
|
6323
6130
|
* - `AR` - Argentina
|
|
6324
|
-
* - `
|
|
6325
|
-
* - `PK` - Pakistan
|
|
6131
|
+
* - `CN` - China
|
|
6326
6132
|
* - `IL` - Israel
|
|
6133
|
+
* - `IN` - India
|
|
6327
6134
|
* - `MA` - Morocco
|
|
6135
|
+
* - `PK` - Pakistan
|
|
6136
|
+
* - `RS` - Serbia
|
|
6328
6137
|
* - `RU` - Russia
|
|
6329
6138
|
* - `TR` - Turkey
|
|
6330
|
-
* - `
|
|
6139
|
+
* - `TW` - Taiwan
|
|
6331
6140
|
*
|
|
6332
6141
|
* @defaultValue `"Unified"`
|
|
6333
6142
|
*/
|
|
@@ -6342,21 +6151,21 @@ type ReverseGeocodingOptionalParams = {
|
|
|
6342
6151
|
*
|
|
6343
6152
|
* @group Reverse Geocoding
|
|
6344
6153
|
*/
|
|
6345
|
-
type ReverseGeocodingParams = CommonServiceParams<
|
|
6154
|
+
type ReverseGeocodingParams = CommonServiceParams<GetObject, ReverseGeocodingResponseAPI> & ReverseGeocodingMandatoryParams & ReverseGeocodingOptionalParams;
|
|
6346
6155
|
//#endregion
|
|
6347
6156
|
//#region src/revgeo/requestBuilder.d.ts
|
|
6348
6157
|
/**
|
|
6349
6158
|
* Default function for building a reverse geocoding request from {@link ReverseGeocodingParams}
|
|
6350
6159
|
* @param params The reverse geocoding parameters, with global configuration already merged into them.
|
|
6351
6160
|
*/
|
|
6352
|
-
declare const buildRevGeoRequest: (params: ReverseGeocodingParams) =>
|
|
6161
|
+
declare const buildRevGeoRequest: (params: ReverseGeocodingParams) => GetObject;
|
|
6353
6162
|
//#endregion
|
|
6354
6163
|
//#region src/revgeo/reverseGeocodingTemplate.d.ts
|
|
6355
6164
|
/**
|
|
6356
6165
|
* Reverse Geocoding service template type.
|
|
6357
6166
|
* @ignore
|
|
6358
6167
|
*/
|
|
6359
|
-
type ReverseGeocodingTemplate = ServiceTemplate<ReverseGeocodingParams,
|
|
6168
|
+
type ReverseGeocodingTemplate = ServiceTemplate<ReverseGeocodingParams, GetObject, ReverseGeocodingResponseAPI, ReverseGeocodingResponse>;
|
|
6360
6169
|
//#endregion
|
|
6361
6170
|
//#region src/revgeo/reverseGeocoding.d.ts
|
|
6362
6171
|
/**
|
|
@@ -6366,7 +6175,7 @@ type ReverseGeocodingTemplate = ServiceTemplate<ReverseGeocodingParams, URL, Rev
|
|
|
6366
6175
|
*
|
|
6367
6176
|
* @group Reverse Geocoding
|
|
6368
6177
|
*/
|
|
6369
|
-
type ReverseGeocodingResponse = Place<RevGeoAddressProps>;
|
|
6178
|
+
export type ReverseGeocodingResponse = Place<RevGeoAddressProps>;
|
|
6370
6179
|
/**
|
|
6371
6180
|
* Convert geographic coordinates into human-readable addresses (reverse geocoding).
|
|
6372
6181
|
*
|
|
@@ -6384,10 +6193,9 @@ type ReverseGeocodingResponse = Place<RevGeoAddressProps>;
|
|
|
6384
6193
|
*
|
|
6385
6194
|
* Features:
|
|
6386
6195
|
* - Returns complete address hierarchy (street, city, state, country)
|
|
6387
|
-
* -
|
|
6388
|
-
* -
|
|
6389
|
-
* -
|
|
6390
|
-
* - Returns multiple result types (street, POI, geography)
|
|
6196
|
+
* - Returns the result type (address, street, or geography)
|
|
6197
|
+
* - Narrows results to administrative areas with `geographyType`
|
|
6198
|
+
* - Direction-aware street matching with `heading`
|
|
6391
6199
|
*
|
|
6392
6200
|
* @param params - Reverse geocoding parameters including coordinates
|
|
6393
6201
|
* @param customTemplate - Advanced customization for request/response handling
|
|
@@ -6403,19 +6211,18 @@ type ReverseGeocodingResponse = Place<RevGeoAddressProps>;
|
|
|
6403
6211
|
* });
|
|
6404
6212
|
* // Returns: Dam, 1012 Amsterdam, Netherlands
|
|
6405
6213
|
*
|
|
6406
|
-
* // Get address
|
|
6214
|
+
* // Get the address matched along a given travel direction
|
|
6407
6215
|
* const specificAddress = await reverseGeocode({
|
|
6408
6216
|
* key: 'your-api-key',
|
|
6409
6217
|
* position: [-77.0369, 38.8977], // Washington DC
|
|
6410
|
-
*
|
|
6218
|
+
* heading: 90 // Traveling east
|
|
6411
6219
|
* });
|
|
6412
|
-
* // Returns: 1600 Pennsylvania Avenue NW
|
|
6413
6220
|
*
|
|
6414
|
-
* // Get
|
|
6415
|
-
* const
|
|
6221
|
+
* // Get the containing municipality instead of the street
|
|
6222
|
+
* const municipality = await reverseGeocode({
|
|
6416
6223
|
* key: 'your-api-key',
|
|
6417
6224
|
* position: [-74.0060, 40.7128], // New York
|
|
6418
|
-
*
|
|
6225
|
+
* geographyType: ['Municipality']
|
|
6419
6226
|
* });
|
|
6420
6227
|
* ```
|
|
6421
6228
|
*
|
|
@@ -6425,7 +6232,7 @@ type ReverseGeocodingResponse = Place<RevGeoAddressProps>;
|
|
|
6425
6232
|
*
|
|
6426
6233
|
* @group Reverse Geocoding
|
|
6427
6234
|
*/
|
|
6428
|
-
declare const reverseGeocode: (params: ReverseGeocodingParams, customTemplate?: Partial<ReverseGeocodingTemplate>) => Promise<ReverseGeocodingResponse>;
|
|
6235
|
+
export declare const reverseGeocode: (params: ReverseGeocodingParams, customTemplate?: Partial<ReverseGeocodingTemplate>) => Promise<ReverseGeocodingResponse>;
|
|
6429
6236
|
//#endregion
|
|
6430
6237
|
//#region src/revgeo/responseParser.d.ts
|
|
6431
6238
|
/**
|
|
@@ -6581,7 +6388,6 @@ type InputSectionTypes = InputSectionType[];
|
|
|
6581
6388
|
* // Request coded guidance with phonetics
|
|
6582
6389
|
* const guidance: GuidanceParams = {
|
|
6583
6390
|
* type: 'coded',
|
|
6584
|
-
* version: 2,
|
|
6585
6391
|
* phonetics: 'IPA'
|
|
6586
6392
|
* };
|
|
6587
6393
|
* ```
|
|
@@ -6595,12 +6401,6 @@ type GuidanceParams = {
|
|
|
6595
6401
|
* Currently only 'coded' format is supported.
|
|
6596
6402
|
*/
|
|
6597
6403
|
type: 'coded';
|
|
6598
|
-
/**
|
|
6599
|
-
* Guidance instruction version.
|
|
6600
|
-
*
|
|
6601
|
-
* @default 2
|
|
6602
|
-
*/
|
|
6603
|
-
version?: 2;
|
|
6604
6404
|
/**
|
|
6605
6405
|
* Phonetic transcription format for street names.
|
|
6606
6406
|
*
|
|
@@ -6748,7 +6548,12 @@ type CalculateRouteParams = CommonServiceParams<CalculateRouteRequestAPI, Calcul
|
|
|
6748
6548
|
* Supported formats:
|
|
6749
6549
|
* - Coordinate arrays: `[longitude, latitude]`
|
|
6750
6550
|
* - Path arrays for route reconstruction
|
|
6751
|
-
* -
|
|
6551
|
+
* - Waypoint Features, whose properties carry the per-stop options
|
|
6552
|
+
*
|
|
6553
|
+
* The route ends a leg at every location in this list. There is no circle (soft) waypoint
|
|
6554
|
+
* that the route merely passes: the routing API takes a plain point for each one. A path
|
|
6555
|
+
* pins the geometry the route must follow, but its endpoints go out as waypoints as well,
|
|
6556
|
+
* so it shapes the route without shortening the list of legs.
|
|
6752
6557
|
*
|
|
6753
6558
|
* @see [POST data parameters](https://docs.tomtom.com/routing-api/documentation/tomtom-maps/calculate-route#post-data-parameters)
|
|
6754
6559
|
* @see [Response structure](https://docs.tomtom.com/routing-api/documentation/tomtom-maps/calculate-route#structure-of-a-successful-response)
|
|
@@ -6769,17 +6574,6 @@ type CalculateRouteParams = CommonServiceParams<CalculateRouteRequestAPI, Calcul
|
|
|
6769
6574
|
* ],
|
|
6770
6575
|
* [4.5, 51.9] // Destination waypoint
|
|
6771
6576
|
* ]
|
|
6772
|
-
*
|
|
6773
|
-
* // (not supported) Waypoint objects with radius for circle waypoints
|
|
6774
|
-
* locations: [
|
|
6775
|
-
* [4.9, 52.3],
|
|
6776
|
-
* {
|
|
6777
|
-
* type: 'Feature',
|
|
6778
|
-
* geometry: { type: 'Point', coordinates: [4.7, 52.1] },
|
|
6779
|
-
* properties: { radiusMeters: 5000 }
|
|
6780
|
-
* },
|
|
6781
|
-
* [4.5, 51.9]
|
|
6782
|
-
* ]
|
|
6783
6577
|
* ```
|
|
6784
6578
|
*/
|
|
6785
6579
|
locations: RoutePlanningLocation[];
|
|
@@ -6831,11 +6625,19 @@ type CalculateRouteParams = CommonServiceParams<CalculateRouteRequestAPI, Calcul
|
|
|
6831
6625
|
*
|
|
6832
6626
|
* Useful for displaying progress during navigation or animating route visualization.
|
|
6833
6627
|
*
|
|
6628
|
+
* @remarks
|
|
6629
|
+
* Orbis v3 has no per-representation selector: progress points are all-or-nothing. Any
|
|
6630
|
+
* non-empty array therefore requests both `distance` and `travelTime`. Pass an empty array
|
|
6631
|
+
* to opt out entirely and keep the progress data out of the response payload.
|
|
6632
|
+
*
|
|
6834
6633
|
* @default ['distance', 'travelTime']
|
|
6835
6634
|
*
|
|
6836
6635
|
* @example
|
|
6837
6636
|
* ```typescript
|
|
6838
6637
|
* extendedRouteRepresentations: ['distance', 'travelTime']
|
|
6638
|
+
*
|
|
6639
|
+
* // Opt out of progress points altogether
|
|
6640
|
+
* extendedRouteRepresentations: []
|
|
6839
6641
|
* ```
|
|
6840
6642
|
*/
|
|
6841
6643
|
extendedRouteRepresentations?: ExtendedRouteRepresentation[];
|
|
@@ -6849,7 +6651,6 @@ type CalculateRouteParams = CommonServiceParams<CalculateRouteRequestAPI, Calcul
|
|
|
6849
6651
|
* ```typescript
|
|
6850
6652
|
* guidance: {
|
|
6851
6653
|
* type: 'coded',
|
|
6852
|
-
* version: 2,
|
|
6853
6654
|
* phonetics: 'IPA'
|
|
6854
6655
|
* }
|
|
6855
6656
|
* ```
|
|
@@ -7539,7 +7340,7 @@ declare const customize: {
|
|
|
7539
7340
|
*
|
|
7540
7341
|
* @group Advanced
|
|
7541
7342
|
*/
|
|
7542
|
-
declare const customizeService: {
|
|
7343
|
+
export declare const customizeService: {
|
|
7543
7344
|
alongRouteSearch: typeof customize$11;
|
|
7544
7345
|
reverseGeocode: typeof customize$3;
|
|
7545
7346
|
geocode: typeof customize$8;
|
|
@@ -7598,7 +7399,7 @@ declare const customizeService: {
|
|
|
7598
7399
|
*
|
|
7599
7400
|
* @group EV Charging
|
|
7600
7401
|
*/
|
|
7601
|
-
declare const evChargingStationsAvailability: (params: ChargingStationsAvailabilityParams, customTemplate?: Partial<EVChargingStationsAvailabilityTemplate>) => Promise<ChargingStationsAvailability | undefined>;
|
|
7402
|
+
export declare const evChargingStationsAvailability: (params: ChargingStationsAvailabilityParams, customTemplate?: Partial<EVChargingStationsAvailabilityTemplate>) => Promise<ChargingStationsAvailability | undefined>;
|
|
7602
7403
|
/**
|
|
7603
7404
|
* Enhance a place with real-time EV charging availability data.
|
|
7604
7405
|
*
|
|
@@ -7627,7 +7428,7 @@ declare const evChargingStationsAvailability: (params: ChargingStationsAvailabil
|
|
|
7627
7428
|
*
|
|
7628
7429
|
* @group EV Charging
|
|
7629
7430
|
*/
|
|
7630
|
-
declare const getPlaceWithEVAvailability: <P extends CommonPlaceProps = CommonPlaceProps>(place: Place<P>, commonParams?: Omit<ChargingStationsAvailabilityParams, "id">) => Promise<Place<EVChargingStationWithAvailabilityPlaceProps> | undefined>;
|
|
7431
|
+
export declare const getPlaceWithEVAvailability: <P extends CommonPlaceProps = CommonPlaceProps>(place: Place<P>, commonParams?: Omit<ChargingStationsAvailabilityParams, "id">) => Promise<Place<EVChargingStationWithAvailabilityPlaceProps> | undefined>;
|
|
7631
7432
|
/**
|
|
7632
7433
|
* Enhance multiple places with real-time EV charging availability data.
|
|
7633
7434
|
*
|
|
@@ -7666,10 +7467,10 @@ declare const getPlaceWithEVAvailability: <P extends CommonPlaceProps = CommonPl
|
|
|
7666
7467
|
*
|
|
7667
7468
|
* @group EV Charging
|
|
7668
7469
|
*/
|
|
7669
|
-
declare function getPlacesWithEVAvailability<P extends CommonPlaceProps = CommonPlaceProps>(places: Places<P>, options?: Omit<ChargingStationsAvailabilityParams, 'id'> & {
|
|
7470
|
+
export declare function getPlacesWithEVAvailability<P extends CommonPlaceProps = CommonPlaceProps>(places: Places<P>, options?: Omit<ChargingStationsAvailabilityParams, 'id'> & {
|
|
7670
7471
|
excludeIfAvailabilityUnknown: true;
|
|
7671
7472
|
}): Promise<Places<EVChargingStationWithAvailabilityPlaceProps>>;
|
|
7672
|
-
declare function getPlacesWithEVAvailability<P extends CommonPlaceProps = CommonPlaceProps>(places: Places<P>, options?: Omit<ChargingStationsAvailabilityParams, 'id'> & {
|
|
7473
|
+
export declare function getPlacesWithEVAvailability<P extends CommonPlaceProps = CommonPlaceProps>(places: Places<P>, options?: Omit<ChargingStationsAvailabilityParams, 'id'> & {
|
|
7673
7474
|
/**
|
|
7674
7475
|
* If true, places with unknown availability will be filtered out. Otherwise, they will be included.
|
|
7675
7476
|
* @default false
|
|
@@ -7684,7 +7485,7 @@ declare function getPlacesWithEVAvailability<P extends CommonPlaceProps = Common
|
|
|
7684
7485
|
*
|
|
7685
7486
|
* @group EV Charging
|
|
7686
7487
|
*/
|
|
7687
|
-
declare const hasChargingAvailability: (chargingPark: ChargingPark | ChargingParkWithAvailability | undefined) => chargingPark is ChargingParkWithAvailability;
|
|
7488
|
+
export declare const hasChargingAvailability: (chargingPark: ChargingPark | ChargingParkWithAvailability | undefined) => chargingPark is ChargingParkWithAvailability;
|
|
7688
7489
|
//#endregion
|
|
7689
7490
|
//#region src/exploration-search/types/areaTags.d.ts
|
|
7690
7491
|
/**
|
|
@@ -7712,7 +7513,7 @@ declare const hasChargingAvailability: (chargingPark: ChargingPark | ChargingPar
|
|
|
7712
7513
|
* @ignore
|
|
7713
7514
|
* @experimental
|
|
7714
7515
|
*/
|
|
7715
|
-
declare const POPULATED_AREA_TAGS: readonly ["village", "small_town", "mid_town", "suburban", "rural", "semi_rural", "residential", "inland", "coastal", "atlantic_coast", "alpine", "mountain", "foothills", "forest", "plains", "farmland", "agricultural", "no_tourism", "low_tourism", "moderate_tourism", "tourism_economy", "eco_tourism", "heritage_tourism", "watersports", "hiking", "cycling", "industrial", "logistics_hub", "retail_hub", "shopping_district", "hospital_town", "dining_scene", "car_oriented", "walkable", "transit_connected", "transit_sparse", "highway_corridor", "commuter_town", "low_traffic", "moderate_traffic", "sparse_commercial", "western_europe", "central_europe", "southern_europe", "north_american", "iberian"];
|
|
7516
|
+
export declare const POPULATED_AREA_TAGS: readonly ["village", "small_town", "mid_town", "suburban", "rural", "semi_rural", "residential", "inland", "coastal", "atlantic_coast", "alpine", "mountain", "foothills", "forest", "plains", "farmland", "agricultural", "no_tourism", "low_tourism", "moderate_tourism", "tourism_economy", "eco_tourism", "heritage_tourism", "watersports", "hiking", "cycling", "industrial", "logistics_hub", "retail_hub", "shopping_district", "hospital_town", "dining_scene", "car_oriented", "walkable", "transit_connected", "transit_sparse", "highway_corridor", "commuter_town", "low_traffic", "moderate_traffic", "sparse_commercial", "western_europe", "central_europe", "southern_europe", "north_american", "iberian"];
|
|
7716
7517
|
/**
|
|
7717
7518
|
* Vocabulary tokens that exist canonically in the area-tag taxonomy but
|
|
7718
7519
|
* aren't emitted by the current pipeline run (per the schema doc's
|
|
@@ -7723,7 +7524,7 @@ declare const POPULATED_AREA_TAGS: readonly ["village", "small_town", "mid_town"
|
|
|
7723
7524
|
* @ignore
|
|
7724
7525
|
* @experimental
|
|
7725
7526
|
*/
|
|
7726
|
-
declare const RESERVED_AREA_TAGS: readonly ["lakefront", "riverine", "wetland", "marina", "harbor", "beach", "mediterranean", "ski_destination", "beach_destination", "wine_tourism", "vineyard", "university_town", "medieval_old_town", "unesco_site", "midwest_us", "rust_belt"];
|
|
7527
|
+
export declare const RESERVED_AREA_TAGS: readonly ["lakefront", "riverine", "wetland", "marina", "harbor", "beach", "mediterranean", "ski_destination", "beach_destination", "wine_tourism", "vineyard", "university_town", "medieval_old_town", "unesco_site", "midwest_us", "rust_belt"];
|
|
7727
7528
|
/**
|
|
7728
7529
|
* Union of every populated area-tag token currently emitted by the
|
|
7729
7530
|
* places-api pipeline.
|
|
@@ -8123,7 +7924,7 @@ type ExplorationSearchTemplate = ServiceTemplate<ExplorationSearchParams, Explor
|
|
|
8123
7924
|
* @ignore
|
|
8124
7925
|
* @experimental
|
|
8125
7926
|
*/
|
|
8126
|
-
declare const explorationSearch: (params: ExplorationSearchParams, customTemplate?: Partial<ExplorationSearchTemplate>) => Promise<ExplorationSearchResponse>;
|
|
7927
|
+
export declare const explorationSearch: (params: ExplorationSearchParams, customTemplate?: Partial<ExplorationSearchTemplate>) => Promise<ExplorationSearchResponse>;
|
|
8127
7928
|
//#endregion
|
|
8128
7929
|
//#region src/geocode/geocoding.d.ts
|
|
8129
7930
|
/**
|
|
@@ -8183,7 +7984,7 @@ declare const explorationSearch: (params: ExplorationSearchParams, customTemplat
|
|
|
8183
7984
|
*
|
|
8184
7985
|
* @group Geocoding
|
|
8185
7986
|
*/
|
|
8186
|
-
declare const geocode: (params: GeocodingParams, customTemplate?: Partial<GeocodingTemplate>) => Promise<GeocodingResponse>;
|
|
7987
|
+
export declare const geocode: (params: GeocodingParams, customTemplate?: Partial<GeocodingTemplate>) => Promise<GeocodingResponse>;
|
|
8187
7988
|
/**
|
|
8188
7989
|
* Geocode a query and return the single best-matching place.
|
|
8189
7990
|
*
|
|
@@ -8205,7 +8006,7 @@ declare const geocode: (params: GeocodingParams, customTemplate?: Partial<Geocod
|
|
|
8205
8006
|
*
|
|
8206
8007
|
* @group Geocoding
|
|
8207
8008
|
*/
|
|
8208
|
-
declare const geocodeOne: (query: string) => Promise<Place<GeocodingProps>>;
|
|
8009
|
+
export declare const geocodeOne: (query: string) => Promise<Place<GeocodingProps>>;
|
|
8209
8010
|
//#endregion
|
|
8210
8011
|
//#region src/geometry-data/geometryData.d.ts
|
|
8211
8012
|
/**
|
|
@@ -8264,8 +8065,8 @@ declare const geocodeOne: (query: string) => Promise<Place<GeocodingProps>>;
|
|
|
8264
8065
|
*
|
|
8265
8066
|
* @group Geometry
|
|
8266
8067
|
*/
|
|
8267
|
-
declare function geometryData(params: GeometryDataParams, customTemplate?: Partial<GeometryDataTemplate>): Promise<PolygonFeatures>;
|
|
8268
|
-
declare function geometryData(params: GeometryPlaceParams, customTemplate?: Partial<GeometryDataTemplate>): Promise<PolygonFeatures<CommonPlaceProps>>;
|
|
8068
|
+
export declare function geometryData(params: GeometryDataParams, customTemplate?: Partial<GeometryDataTemplate>): Promise<PolygonFeatures>;
|
|
8069
|
+
export declare function geometryData(params: GeometryPlaceParams, customTemplate?: Partial<GeometryDataTemplate>): Promise<PolygonFeatures<CommonPlaceProps>>;
|
|
8269
8070
|
//#endregion
|
|
8270
8071
|
//#region src/place-by-id/placeById.d.ts
|
|
8271
8072
|
/**
|
|
@@ -8332,7 +8133,7 @@ declare function geometryData(params: GeometryPlaceParams, customTemplate?: Part
|
|
|
8332
8133
|
*
|
|
8333
8134
|
* @group Place
|
|
8334
8135
|
*/
|
|
8335
|
-
declare const placeById: (params: PlaceByIdParams, customTemplate?: Partial<PlaceByIdTemplate>) => Promise<PlaceByIdResponse>;
|
|
8136
|
+
export declare const placeById: (params: PlaceByIdParams, customTemplate?: Partial<PlaceByIdTemplate>) => Promise<PlaceByIdResponse>;
|
|
8336
8137
|
//#endregion
|
|
8337
8138
|
//#region src/poi-categories/types/poiCategoriesResponseAPI.d.ts
|
|
8338
8139
|
/**
|
|
@@ -8459,7 +8260,7 @@ type POICategoriesResponse = {
|
|
|
8459
8260
|
*
|
|
8460
8261
|
* @group POI Categories
|
|
8461
8262
|
*/
|
|
8462
|
-
declare const getPOICategories: (params?: POICategoriesParams) => Promise<POICategoriesResponse>;
|
|
8263
|
+
export declare const getPOICategories: (params?: POICategoriesParams) => Promise<POICategoriesResponse>;
|
|
8463
8264
|
/**
|
|
8464
8265
|
* Convenience wrapper around {@link getPOICategories} that returns a flat array of `POICategory` codes.
|
|
8465
8266
|
*
|
|
@@ -8484,7 +8285,7 @@ declare const getPOICategories: (params?: POICategoriesParams) => Promise<POICat
|
|
|
8484
8285
|
*
|
|
8485
8286
|
* @group POI Categories
|
|
8486
8287
|
*/
|
|
8487
|
-
declare const getPOICategoryCodes: (params?: POICategoriesParams) => Promise<POICategory[]>;
|
|
8288
|
+
export declare const getPOICategoryCodes: (params?: POICategoriesParams) => Promise<POICategory[]>;
|
|
8488
8289
|
//#endregion
|
|
8489
8290
|
//#region src/reachable-range/calculateReachableRange.d.ts
|
|
8490
8291
|
/**
|
|
@@ -8555,7 +8356,7 @@ declare const getPOICategoryCodes: (params?: POICategoriesParams) => Promise<POI
|
|
|
8555
8356
|
*
|
|
8556
8357
|
* @group Routing
|
|
8557
8358
|
*/
|
|
8558
|
-
declare const calculateReachableRange: (params: ReachableRangeParams, customTemplate?: Partial<ReachableRangeTemplate>) => Promise<PolygonFeature<ReachableRangeParams>>;
|
|
8359
|
+
export declare const calculateReachableRange: (params: ReachableRangeParams, customTemplate?: Partial<ReachableRangeTemplate>) => Promise<PolygonFeature<ReachableRangeParams>>;
|
|
8559
8360
|
/**
|
|
8560
8361
|
* Calculate multiple reachable range areas from different origins or with different constraints.
|
|
8561
8362
|
*
|
|
@@ -8617,7 +8418,7 @@ declare const calculateReachableRange: (params: ReachableRangeParams, customTemp
|
|
|
8617
8418
|
*
|
|
8618
8419
|
* @group Routing
|
|
8619
8420
|
*/
|
|
8620
|
-
declare const calculateReachableRanges: (paramsArray: ReachableRangeParams[], options?: {
|
|
8421
|
+
export declare const calculateReachableRanges: (paramsArray: ReachableRangeParams[], options?: {
|
|
8621
8422
|
signal?: AbortSignal;
|
|
8622
8423
|
}, customTemplate?: Partial<ReachableRangeTemplate>) => Promise<PolygonFeatures<ReachableRangeParams>>;
|
|
8623
8424
|
//#endregion
|
|
@@ -8633,7 +8434,7 @@ declare const calculateReachableRanges: (paramsArray: ReachableRangeParams[], op
|
|
|
8633
8434
|
*
|
|
8634
8435
|
* @group Routing
|
|
8635
8436
|
*/
|
|
8636
|
-
declare const calculateRoute: (params: CalculateRouteParams, customTemplate?: Partial<CalculateRouteTemplate>) => Promise<Routes>;
|
|
8437
|
+
export declare const calculateRoute: (params: CalculateRouteParams, customTemplate?: Partial<CalculateRouteTemplate>) => Promise<Routes>;
|
|
8637
8438
|
//#endregion
|
|
8638
8439
|
//#region src/fuzzy-search/types/fuzzySearchResponse.d.ts
|
|
8639
8440
|
/**
|
|
@@ -9046,7 +8847,7 @@ type SearchFeatureCollectionProps = SearchSummary & {
|
|
|
9046
8847
|
*
|
|
9047
8848
|
* @group Search
|
|
9048
8849
|
*/
|
|
9049
|
-
type SearchResponse = Places<SearchPlaceProps, SearchFeatureCollectionProps>;
|
|
8850
|
+
export type SearchResponse = Places<SearchPlaceProps, SearchFeatureCollectionProps>;
|
|
9050
8851
|
/**
|
|
9051
8852
|
* Universal search function for finding places by text query or within geometries.
|
|
9052
8853
|
*
|
|
@@ -9099,7 +8900,7 @@ type SearchResponse = Places<SearchPlaceProps, SearchFeatureCollectionProps>;
|
|
|
9099
8900
|
*
|
|
9100
8901
|
* @group Search
|
|
9101
8902
|
*/
|
|
9102
|
-
declare const search: (params: GeometrySearchParams | FuzzySearchParams | AlongRouteSearchParams, customTemplate?: Partial<GeometrySearchTemplate | FuzzySearchTemplate | AlongRouteSearchTemplate>) => Promise<SearchResponse>;
|
|
8903
|
+
export declare const search: (params: GeometrySearchParams | FuzzySearchParams | AlongRouteSearchParams, customTemplate?: Partial<GeometrySearchTemplate | FuzzySearchTemplate | AlongRouteSearchTemplate>) => Promise<SearchResponse>;
|
|
9103
8904
|
/**
|
|
9104
8905
|
* Search for a single place by text query.
|
|
9105
8906
|
*
|
|
@@ -9122,7 +8923,7 @@ declare const search: (params: GeometrySearchParams | FuzzySearchParams | AlongR
|
|
|
9122
8923
|
*
|
|
9123
8924
|
* @group Search
|
|
9124
8925
|
*/
|
|
9125
|
-
declare const searchOne: (query: string) => Promise<Place<SearchPlaceProps>>;
|
|
8926
|
+
export declare const searchOne: (query: string) => Promise<Place<SearchPlaceProps>>;
|
|
9126
8927
|
//#endregion
|
|
9127
8928
|
//#region src/traffic-area-analytics/trafficAreaAnalytics.d.ts
|
|
9128
8929
|
/**
|
|
@@ -9201,7 +9002,7 @@ declare const searchOne: (query: string) => Promise<Place<SearchPlaceProps>>;
|
|
|
9201
9002
|
*
|
|
9202
9003
|
* @group Traffic
|
|
9203
9004
|
*/
|
|
9204
|
-
declare const trafficAreaAnalytics: (params: TrafficAreaAnalyticsParams, customTemplate?: Partial<TrafficAreaAnalyticsTemplate>) => Promise<TrafficAreaAnalytics>;
|
|
9005
|
+
export declare const trafficAreaAnalytics: (params: TrafficAreaAnalyticsParams, customTemplate?: Partial<TrafficAreaAnalyticsTemplate>) => Promise<TrafficAreaAnalytics>;
|
|
9205
9006
|
//#endregion
|
|
9206
9007
|
//#region src/traffic-incident-details/trafficIncidentDetails.d.ts
|
|
9207
9008
|
/**
|
|
@@ -9276,6 +9077,6 @@ declare const trafficAreaAnalytics: (params: TrafficAreaAnalyticsParams, customT
|
|
|
9276
9077
|
*
|
|
9277
9078
|
* @group Traffic
|
|
9278
9079
|
*/
|
|
9279
|
-
declare const trafficIncidentDetails: (params: TrafficIncidentDetailsParams, customTemplate?: Partial<TrafficIncidentDetailsTemplate>) => Promise<TrafficIncidentDetails>;
|
|
9080
|
+
export declare const trafficIncidentDetails: (params: TrafficIncidentDetailsParams, customTemplate?: Partial<TrafficIncidentDetailsTemplate>) => Promise<TrafficIncidentDetails>;
|
|
9280
9081
|
//#endregion
|
|
9281
|
-
export {
|
|
9082
|
+
export type { AdditionalDataAPI, AlongRouteSearchParams, AlongRouteSearchPayloadAPI, AlongRouteSearchRequestAPI, AlongRouteSearchResponse, AlongRouteSearchResponseAPI, AlongRouteSearchResultAPI, AlongRouteSortBy, AreaAnalyticsDateInput, AreaTag, AutocompleteGenericSearchSegment, AutocompleteSearchBrandSegment, AutocompleteSearchCategorySegment, AutocompleteSearchCategorySegmentAPI, AutocompleteSearchContext, AutocompleteSearchContextAPI, AutocompleteSearchMatch, AutocompleteSearchMatches, AutocompleteSearchParams, AutocompleteSearchPlaintextSegment, AutocompleteSearchResponse, AutocompleteSearchResponseAPI, AutocompleteSearchResult, AutocompleteSearchResultAPI, AutocompleteSearchResultGeoBias, AutocompleteSearchResultGeoBiasAPI, AutocompleteSearchSegment, AutocompleteSearchSegmentAPI, AutocompleteSearchSegmentType, BookmarkIntent, BookmarkIntentDetails, CalculateRouteParams, CanonicalAreaTag, ChargingStationsAvailabilityParams, Circle, CircleAPI, CommonServiceParamsWithZoom, ComputeTravelTimeFor, CoordinateIntent, CoordinateIntentAPI, CoordinateIntentDetails, CoordinateIntentDetailsAPI, ExplorationBrandAPI, ExplorationChargingParkAPI, ExplorationClassificationAPI, ExplorationOpeningHoursAPI, ExplorationOpeningIntervalAPI, ExplorationPOIAPI, ExplorationPlaceProps, ExplorationRecordType, ExplorationSearchParams, ExplorationSearchPayloadAPI, ExplorationSearchRequestAPI, ExplorationSearchResponse, ExplorationSearchResponseAPI, ExplorationSearchResultAPI, ExplorationViewportAPI, ExtendedRouteRepresentation, FunctionalRoadClass, FuzzySearchParams, FuzzySearchResponse, FuzzySearchResponseAPI, FuzzySearchResultAPI, GeocodingParams, GeocodingProps, GeocodingResponse, GeometriesInput, GeometryAPI, GeometryDataParams, GeometryDataResponseAPI, GeometryParams, GeometryPlaceParams, GeometrySearchFeatureCollectionProps, GeometrySearchParams, GeometrySearchPayloadAPI, GeometrySearchRequestAPI, GeometrySearchResponse, GeometrySearchResponseAPI, GeometrySearchResultAPI, GuidanceParams, InputSectionType, InputSectionTypes, MaxNumberOfAlternatives, NearAPI, NearbyIntent, NearbyIntentAPI, NearbyIntentDetails, NearbyIntentDetailsAPI, POICategoriesParams, POICategoriesResponse, POICategoryResult, PlaceByIdMandatoryParams, PlaceByIdOptionalParams, PlaceByIdParams, PlaceByIdResponse, PlaceByIdResponseAPI, PlaceByIdResultAPI, PoiCategoriesResponseAPI, PoiCategoryAPI, PolygonAPI, PopulatedAreaTag, QueryIntent, QueryIntentAPI, ReverseGeocodingMandatoryParams, ReverseGeocodingOptionalParams, ReverseGeocodingParams, RoutePointAPI, SearchGeometryInput, TrafficAreaAnalyticsDateRange, TrafficAreaAnalyticsDays, TrafficAreaAnalyticsParams, TrafficIncidentDetailsByBBoxParams, TrafficIncidentDetailsByIdsParams, TrafficIncidentDetailsParams, W3WIntent, W3WIntentDetails, functionalRoadClasses, metricKeyToApiDataType };
|