@chargetrip/types 1.66.0 → 1.68.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.
@@ -367,12 +367,14 @@ export declare type ChargeSpeedInput = {
367
367
  source?: Maybe<TelemetryInputSource>;
368
368
  };
369
369
  export declare enum ChargeSpeedUnit {
370
- /** Return the charge speed in kilowatt hours. */
370
+ /** Charge speed in kilowatt hours. */
371
371
  KILOWATT_HOUR = "kilowatt_hour",
372
- /** Return the charge speed in kilometers per hour. */
372
+ /** Charge speed in kilometers per hour. */
373
373
  KILOMETERS_PER_HOUR = "kilometers_per_hour",
374
- /** Return the charge speed in miles per hour. */
375
- MILES_PER_HOUR = "miles_per_hour"
374
+ /** Charge speed in miles per hour. */
375
+ MILES_PER_HOUR = "miles_per_hour",
376
+ /** Charge speed in kilowatts. */
377
+ KILOWATT = "kilowatt"
376
378
  }
377
379
  export declare type ChargeTotalInput = {
378
380
  /** Value of the temperature of the battery. */
@@ -1194,6 +1196,44 @@ export declare type CreateConnectedVehicleOptions = {
1194
1196
  /** Scope */
1195
1197
  scope?: Maybe<Array<ConnectScope>>;
1196
1198
  };
1199
+ export declare type CreateMatchedRoute = {
1200
+ /** Vehicle used on a route. */
1201
+ vehicle: MatchedRouteVehicle;
1202
+ /** Via points of a route. */
1203
+ via?: Maybe<Array<MatchedRouteVia>>;
1204
+ /** Chronological sequence of GPS points used for map-matching. Minimum 2. */
1205
+ points: Array<MatchedRoutePoint>;
1206
+ /** Operator preferences for a route. When provided, prefers routes that use higher order operators. */
1207
+ operators?: Maybe<MatchedRouteOperatorPreferences>;
1208
+ /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
1209
+ alternative_station_radius?: Maybe<MatchedRouteAlternativeStationRadius>;
1210
+ /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
1211
+ departure_time: Scalars["DateTime"];
1212
+ /** Configuration options for the route's driving conditions. Includes factors to adjust average speed, set a maximum speed, and define a base driving style. If not specified, no adjustments are applied. */
1213
+ driving_preferences?: Maybe<MatchedRouteDrivingPreferences>;
1214
+ /** Weather configuration for the route. Defined by a preset or custom weather conditions. */
1215
+ weather: MatchedRouteWeather;
1216
+ };
1217
+ export declare type CreateMatchedRouteInput = {
1218
+ /** Vehicle specific input. */
1219
+ vehicle: MatchedRouteVehicleInput;
1220
+ /** Chronological sequence of GPS points used for map-matching. Minimum 2. */
1221
+ points: Array<MatchedRoutePointInput>;
1222
+ /** Intermediate via points along the route. */
1223
+ via?: Maybe<Array<MatchedRouteViaInput>>;
1224
+ /** Route departure time. Used to calculate the arrival time and, when 'weather.type' is 'ACTUAL',retrieve weather data. */
1225
+ departure_time?: Maybe<Scalars["DateTime"]>;
1226
+ /** Weather configuration for the route. Defined by actual, a preset or custom weather conditions. */
1227
+ weather?: Maybe<RouteWeatherInput>;
1228
+ /** Configuration options for the route's driving conditions. Includes factors to adjust average speed, set a maximum speed, and define a base driving style. If not specified, no adjustments are applied. */
1229
+ driving_preferences?: Maybe<MatchedRouteDrivingPreferencesInput>;
1230
+ /** Flag that indicates if charging stations are to be found and planned if the vehicle state of charge reaches the threshold at any point in route. This modifies the original route. */
1231
+ plan_charging_stops?: Maybe<Scalars["Boolean"]>;
1232
+ /** Operator preferences and restrictions for route calculation. If not specified, excludes operators per project settings, but applies no operator ranking. Only applied if applied if `plan_charging_stops` is set true. */
1233
+ operators?: Maybe<MatchedRouteOperatorPreferencesInput>;
1234
+ /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
1235
+ alternative_station_radius?: Maybe<MatchedRouteAlternativeStationRadiusInput>;
1236
+ };
1197
1237
  export declare type CreateRoute = {
1198
1238
  /** Vehicle used on a route. */
1199
1239
  vehicle: RouteVehicle;
@@ -1249,7 +1289,7 @@ export declare type CreateRouteInput = {
1249
1289
  departure_time?: Maybe<Scalars["DateTime"]>;
1250
1290
  /** [BETA] Optional list of route features to avoid in a route. This is a best-effort preference; depending on the available routes, some features may not be fully avoidable. */
1251
1291
  avoid?: Maybe<Array<RouteAvoid>>;
1252
- /** Weather configuration for the route. Defined by a preset or custom weather conditions. If not specified, defaults to real-time weather data. */
1292
+ /** Weather configuration for the route. Defined by a preset or custom weather conditions. If not specified, defaults to use real weather data based on the route's `departure_time`. */
1253
1293
  weather?: Maybe<RouteWeatherInput>;
1254
1294
  /** Charging stations preferences for route calculation. */
1255
1295
  station_preferences?: Maybe<RouteStationPreferencesInput>;
@@ -2123,6 +2163,552 @@ export declare type LineString = {
2123
2163
  export declare enum LineStringType {
2124
2164
  LINESTRING = "LineString"
2125
2165
  }
2166
+ export declare type MatchedRouteAlternativeStationRadius = {
2167
+ /** Value of the alternative station radius. */
2168
+ value: Scalars["Float"];
2169
+ /** Preferred unit for the alternative station radius. */
2170
+ type: DistanceUnit;
2171
+ };
2172
+ export declare type MatchedRouteAlternativeStationRadiusInput = {
2173
+ /** Value of the alternative station radius. */
2174
+ value: Scalars["Float"];
2175
+ /** Preferred unit for the alternative station radius. */
2176
+ type: DistanceUnit;
2177
+ };
2178
+ export declare type MatchedRouteDetails = {
2179
+ /** ID of a route computation. */
2180
+ id: Scalars["ID"];
2181
+ /** Total distance of a route. */
2182
+ distance: Scalars["Float"];
2183
+ /** Aggregation of all durations of a route. */
2184
+ durations: MatchedRouteDetailsDurations;
2185
+ /** Total energy used for a route in kilowatt hours. For HEVs and PHEVs this field will return null. */
2186
+ consumption?: Maybe<Scalars["Float"]>;
2187
+ /** Range available at the start of a trip. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null. */
2188
+ range_at_origin?: Maybe<Scalars["Float"]>;
2189
+ /** Range available at the end of a trip. Note: The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null. */
2190
+ range_at_destination?: Maybe<Scalars["Float"]>;
2191
+ /** Polyline containing encoded coordinates. */
2192
+ polyline: Scalars["String"];
2193
+ /** Path elevation, distance, duration, consumption and speed values, grouped into 100 segments. */
2194
+ path_plot: Array<MatchedRouteDetailsPathSegment>;
2195
+ /** Details about elevation on a route. */
2196
+ elevation: MatchedRouteDetailsElevation;
2197
+ /** Money saving information. */
2198
+ savings?: Maybe<MatchedRouteDetailsSavings>;
2199
+ /** Legs of a route. */
2200
+ legs: Array<MatchedRouteDetailsLeg>;
2201
+ /**
2202
+ * Alternative stations along a route within a specified radius.
2203
+ *
2204
+ * Includes stations from preferred/required/avoided operators but excludes stations from excluded operators.
2205
+ * This list is only populated if `alternative_station_radius` was specified in the `createRoute` mutation.
2206
+ */
2207
+ alternative_stations: Array<MatchedRouteDetailsAlternativeStation>;
2208
+ /** Aggregation of tags over the current RouteDetails. Tags are available on legs and further subdivided over individual sections and maneuvers. */
2209
+ tags: Array<RouteDetailsTag>;
2210
+ /** Number of charging stops required for this route. */
2211
+ charges: Scalars["Int"];
2212
+ };
2213
+ export declare type MatchedRouteDetailsdistanceArgs = {
2214
+ unit?: Maybe<DistanceUnit>;
2215
+ };
2216
+ export declare type MatchedRouteDetailsrange_at_originArgs = {
2217
+ unit?: Maybe<StateOfChargeUnit>;
2218
+ };
2219
+ export declare type MatchedRouteDetailsrange_at_destinationArgs = {
2220
+ unit?: Maybe<StateOfChargeUnit>;
2221
+ };
2222
+ export declare type MatchedRouteDetailspolylineArgs = {
2223
+ decimals?: Maybe<PolylineInputDecimals>;
2224
+ };
2225
+ export declare type MatchedRouteDetailsAlternativeStation = {
2226
+ /** ID of a station. */
2227
+ id: Scalars["ID"];
2228
+ /** GeoJSON location of a station. */
2229
+ location: Point;
2230
+ /** Speed of a station. A station along a route can be either fast or turbo. */
2231
+ speed: StationSpeedType;
2232
+ /** Status of a station. */
2233
+ status: ChargerStatus;
2234
+ /** The value indicates the operator's ranking based on the station's location, in accordance with the list of countries from the configuration or request. */
2235
+ operator_ranking?: Maybe<OperatorRankingLevel>;
2236
+ /** ID of the station's operator. */
2237
+ operator_id?: Maybe<Scalars["ID"]>;
2238
+ };
2239
+ export declare type MatchedRouteDetailsDurations = {
2240
+ /** Total duration, in seconds. */
2241
+ total: Scalars["Int"];
2242
+ /** Total charging duration, in seconds. */
2243
+ charging: Scalars["Int"];
2244
+ /** Total driving duration, in seconds. */
2245
+ driving: Scalars["Int"];
2246
+ /** Total duration stopped at a location via or at a station via, excluding charging time and charging penalty, in seconds. */
2247
+ stopover: Scalars["Int"];
2248
+ /** Total ferry duration, in seconds. */
2249
+ ferry: Scalars["Int"];
2250
+ };
2251
+ export declare type MatchedRouteDetailsElevation = {
2252
+ /** Total value driving uphill on a route. */
2253
+ up: Scalars["Float"];
2254
+ /** Total value driving downhill on a route. */
2255
+ down: Scalars["Float"];
2256
+ /** Maximum elevation on a route. */
2257
+ maximum: Scalars["Float"];
2258
+ /** Minimum elevation on a route. */
2259
+ minimum: Scalars["Float"];
2260
+ };
2261
+ export declare type MatchedRouteDetailsElevationupArgs = {
2262
+ unit?: Maybe<DistanceUnit>;
2263
+ };
2264
+ export declare type MatchedRouteDetailsElevationdownArgs = {
2265
+ unit?: Maybe<DistanceUnit>;
2266
+ };
2267
+ export declare type MatchedRouteDetailsElevationmaximumArgs = {
2268
+ unit?: Maybe<DistanceUnit>;
2269
+ };
2270
+ export declare type MatchedRouteDetailsElevationminimumArgs = {
2271
+ unit?: Maybe<DistanceUnit>;
2272
+ };
2273
+ /** Leg of a route detail. */
2274
+ export declare type MatchedRouteDetailsLeg = {
2275
+ /** Distance from the start to the end of a leg. */
2276
+ distance: Scalars["Float"];
2277
+ /** Aggregation of all durations of a route leg. */
2278
+ durations: MatchedRouteDetailsDurations;
2279
+ /** Total energy used in a leg in kilowatt hours. For HEVs and PHEVs this field will return null. */
2280
+ consumption?: Maybe<Scalars["Float"]>;
2281
+ /** Origin point location. */
2282
+ origin: MatchedRouteDetailsLegFeaturePoint;
2283
+ /** Destination point location. */
2284
+ destination: MatchedRouteDetailsLegFeaturePoint;
2285
+ /** Range at the start of a leg. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null. */
2286
+ range_at_origin?: Maybe<Scalars["Float"]>;
2287
+ /** Range available at the end of a leg. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null. */
2288
+ range_at_destination?: Maybe<Scalars["Float"]>;
2289
+ /** Range after charging on the leg. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null. */
2290
+ range_after_charge?: Maybe<Scalars["Float"]>;
2291
+ /** Type of a leg. */
2292
+ type: RouteDetailsLegType;
2293
+ /** Information about the station at the destination of a leg. */
2294
+ station?: Maybe<MatchedRouteDetailsLegStation>;
2295
+ /** Polyline containing encoded coordinates. */
2296
+ polyline: Scalars["String"];
2297
+ /** Aggregation of tags over the current leg. Tags are further subdivided over individual sections and maneuvers. */
2298
+ tags: Array<RouteDetailsTag>;
2299
+ /** Maneuvers of a leg - used to generate turn-by-turn instructions. */
2300
+ maneuvers: Array<RouteDetailsManeuver>;
2301
+ /** Road sections of a leg - divided by means of transportation. */
2302
+ sections: Array<MatchedRouteDetailsLegSection>;
2303
+ };
2304
+ /** Leg of a route detail. */
2305
+ export declare type MatchedRouteDetailsLegdistanceArgs = {
2306
+ unit?: Maybe<DistanceUnit>;
2307
+ };
2308
+ /** Leg of a route detail. */
2309
+ export declare type MatchedRouteDetailsLegrange_at_originArgs = {
2310
+ unit?: Maybe<StateOfChargeUnit>;
2311
+ };
2312
+ /** Leg of a route detail. */
2313
+ export declare type MatchedRouteDetailsLegrange_at_destinationArgs = {
2314
+ unit?: Maybe<StateOfChargeUnit>;
2315
+ };
2316
+ /** Leg of a route detail. */
2317
+ export declare type MatchedRouteDetailsLegrange_after_chargeArgs = {
2318
+ unit?: Maybe<StateOfChargeUnit>;
2319
+ };
2320
+ /** Leg of a route detail. */
2321
+ export declare type MatchedRouteDetailsLegpolylineArgs = {
2322
+ decimals?: Maybe<PolylineInputDecimals>;
2323
+ };
2324
+ export declare type MatchedRouteDetailsLegFeaturePoint = {
2325
+ /** ID of the feature. */
2326
+ id?: Maybe<Scalars["ID"]>;
2327
+ /** Feature type. */
2328
+ type: FeatureType;
2329
+ /** Geometry of the feature. */
2330
+ geometry: Point;
2331
+ /** Properties of the feature. */
2332
+ properties?: Maybe<MatchedRouteDetailsLegFeatureProperties>;
2333
+ };
2334
+ export declare type MatchedRouteDetailsLegFeatureProperties = {
2335
+ /** Name of the location. */
2336
+ name?: Maybe<Scalars["String"]>;
2337
+ /** ID of the station. */
2338
+ station_id?: Maybe<Scalars["ID"]>;
2339
+ /** External ID of the station. */
2340
+ external_station_id?: Maybe<Scalars["ID"]>;
2341
+ /** Temperature at the location. */
2342
+ temperature?: Maybe<Scalars["Int"]>;
2343
+ /** Air pressure at the location. */
2344
+ air_pressure?: Maybe<Scalars["Float"]>;
2345
+ /** Solar irradiance at the location. */
2346
+ solar_irradiance?: Maybe<Scalars["Float"]>;
2347
+ /**
2348
+ * Duration, in seconds, of time spent at this location.
2349
+ * @deprecated In favor of `legs.durations`.
2350
+ */
2351
+ duration?: Maybe<Scalars["Int"]>;
2352
+ /** Number of occupants present in the vehicle. */
2353
+ occupants?: Maybe<Scalars["Int"]>;
2354
+ /** Value of the combined weight of the occupants. */
2355
+ total_occupant_weight?: Maybe<Scalars["Float"]>;
2356
+ /** Value of the current weight of the cargo. */
2357
+ total_cargo_weight?: Maybe<Scalars["Float"]>;
2358
+ };
2359
+ export declare type MatchedRouteDetailsLegFeaturePropertiestemperatureArgs = {
2360
+ unit?: Maybe<TemperatureUnit>;
2361
+ };
2362
+ export declare type MatchedRouteDetailsLegFeaturePropertiestotal_occupant_weightArgs = {
2363
+ unit?: Maybe<WeightUnit>;
2364
+ };
2365
+ export declare type MatchedRouteDetailsLegFeaturePropertiestotal_cargo_weightArgs = {
2366
+ unit?: Maybe<WeightUnit>;
2367
+ };
2368
+ export declare type MatchedRouteDetailsLegSection = {
2369
+ /** Section type. */
2370
+ type: RouteDetailsLegSectionType;
2371
+ /** Origin point. */
2372
+ origin: MatchedRouteDetailsLegSectionFeaturePoint;
2373
+ /** Destination point. */
2374
+ destination: MatchedRouteDetailsLegSectionFeaturePoint;
2375
+ /** Aggregation of tags over the current section. */
2376
+ tags: Array<RouteDetailsTag>;
2377
+ /** Polyline containing encoded coordinates. */
2378
+ polyline: Scalars["String"];
2379
+ /** Distance from the start to the end of a section. */
2380
+ distance: Scalars["Float"];
2381
+ /** Total duration of a section, in seconds. The value will be 0 for walking sections. */
2382
+ duration: Scalars["Float"];
2383
+ /** Total energy used in a section in kilowatt-hours. The value will be 0 for walking sections. */
2384
+ consumption?: Maybe<Scalars["Float"]>;
2385
+ };
2386
+ export declare type MatchedRouteDetailsLegSectionpolylineArgs = {
2387
+ decimals?: Maybe<PolylineInputDecimals>;
2388
+ };
2389
+ export declare type MatchedRouteDetailsLegSectiondistanceArgs = {
2390
+ unit?: Maybe<DistanceUnit>;
2391
+ };
2392
+ export declare type MatchedRouteDetailsLegSectionFeaturePoint = {
2393
+ /** ID of the feature. */
2394
+ id?: Maybe<Scalars["ID"]>;
2395
+ /** Feature type. */
2396
+ type: FeatureType;
2397
+ /** Geometry of the feature. */
2398
+ geometry: Point;
2399
+ /** Properties of the feature. */
2400
+ properties: MatchedRouteDetailsLegSectionFeaturePointProperties;
2401
+ };
2402
+ export declare type MatchedRouteDetailsLegSectionFeaturePointProperties = {
2403
+ /** Number of occupants present in the vehicle. */
2404
+ occupants: Scalars["Int"];
2405
+ /** Value of the combined weight of the occupants. */
2406
+ total_occupant_weight?: Maybe<Scalars["Float"]>;
2407
+ /** Value of the current weight of the cargo. */
2408
+ total_cargo_weight?: Maybe<Scalars["Float"]>;
2409
+ };
2410
+ export declare type MatchedRouteDetailsLegSectionFeaturePointPropertiestotal_occupant_weightArgs = {
2411
+ unit?: Maybe<WeightUnit>;
2412
+ };
2413
+ export declare type MatchedRouteDetailsLegSectionFeaturePointPropertiestotal_cargo_weightArgs = {
2414
+ unit?: Maybe<WeightUnit>;
2415
+ };
2416
+ export declare type MatchedRouteDetailsLegStation = {
2417
+ /** ID of a station. */
2418
+ station_id: Scalars["ID"];
2419
+ /** ID of the EVSE that was selected in a route. */
2420
+ evse_id?: Maybe<Scalars["ID"]>;
2421
+ /** ID of the connector that was selected in a route. */
2422
+ connector_id: Scalars["ID"];
2423
+ };
2424
+ export declare type MatchedRouteDetailsPathSegment = {
2425
+ /** Elevation value of a route path segment. */
2426
+ elevation: Scalars["Float"];
2427
+ /** Average speed of a route path segment. This value is determined using legal maximum speed and, if provided, the user defined maximum speed. */
2428
+ average_speed: Scalars["Float"];
2429
+ /** Consumption, in kilowatt hours, of a route path segment. For HEVs and PHEVs this field will return null. */
2430
+ consumption?: Maybe<Scalars["Float"]>;
2431
+ /** Distance of a route path segment. */
2432
+ distance: Scalars["Float"];
2433
+ /** Duration, in seconds, of a route path segment. */
2434
+ duration: Scalars["Float"];
2435
+ /** State of charge, in kilowatt hours, of a route path segment. For HEVs and PHEVs this field will return null. */
2436
+ state_of_charge?: Maybe<Scalars["Float"]>;
2437
+ };
2438
+ export declare type MatchedRouteDetailsPathSegmentelevationArgs = {
2439
+ unit?: Maybe<DistanceUnit>;
2440
+ };
2441
+ export declare type MatchedRouteDetailsPathSegmentaverage_speedArgs = {
2442
+ unit?: Maybe<SpeedUnit>;
2443
+ };
2444
+ export declare type MatchedRouteDetailsPathSegmentdistanceArgs = {
2445
+ unit?: Maybe<DistanceUnit>;
2446
+ };
2447
+ export declare type MatchedRouteDetailsPathSegmentstate_of_chargeArgs = {
2448
+ unit?: Maybe<StateOfChargeUnit>;
2449
+ };
2450
+ /** Money saving information. */
2451
+ export declare type MatchedRouteDetailsSavings = {
2452
+ /** Money saved by a user driving this route with an electric vehicle. */
2453
+ money?: Maybe<Scalars["Float"]>;
2454
+ /** Average gas price with which the calculation was made. */
2455
+ average_gas_price: Scalars["Float"];
2456
+ /** Average energy price with which the calculation was made. */
2457
+ average_energy_price: Scalars["Float"];
2458
+ };
2459
+ /** Money saving information. */
2460
+ export declare type MatchedRouteDetailsSavingsmoneyArgs = {
2461
+ currency?: Maybe<Currency>;
2462
+ };
2463
+ /** Money saving information. */
2464
+ export declare type MatchedRouteDetailsSavingsaverage_gas_priceArgs = {
2465
+ currency?: Maybe<Currency>;
2466
+ };
2467
+ /** Money saving information. */
2468
+ export declare type MatchedRouteDetailsSavingsaverage_energy_priceArgs = {
2469
+ currency?: Maybe<Currency>;
2470
+ };
2471
+ export declare type MatchedRouteDrivingPreferences = {
2472
+ /** Factor to adjust the route's calculated average speed. Accepts values between 0.80 and 1.20. 1.0 is neutral. Values below 1.0 reduce speed (e.g. 0.95 is -5%), values above increase it. If provided in combination with style, this overrides the speed factor implied by the selected 'style'. */
2473
+ speed_factor?: Maybe<Scalars["Float"]>;
2474
+ /** Maximum speed to consider when generating the route. In the segments where legal speed is lower than this value, the legal speed will be used instead. If provided in combination with 'style, this overrides the maximum speed implied by the selected 'style'. */
2475
+ maximum_speed?: Maybe<MaximumSpeed>;
2476
+ /** Defines a driving style. If provided in combination with 'maximum_speed' or 'speed_factor', those values override the values defined by the selected 'style'. */
2477
+ style?: Maybe<RouteDrivingStyle>;
2478
+ };
2479
+ export declare type MatchedRouteDrivingPreferencesInput = {
2480
+ /** [BETA] Factor to adjust the route's calculated average speed. Accepts values between 0.80 and 1.20. 1.0 is neutral. Values below 1.0 reduce speed (e.g. 0.95 is -5%), values above increase it. If provided in combination with style, this overrides the speed factor implied by the selected 'style'. */
2481
+ speed_factor?: Maybe<Scalars["Float"]>;
2482
+ /** [BETA] Maximum speed to consider when generating the route. In the segments where legal speed is lower than this value, the legal speed will be used instead. If provided in combination with 'style, this overrides the maximum speed implied by the selected 'style'. */
2483
+ maximum_speed?: Maybe<MaximumSpeedInput>;
2484
+ /** [BETA] Defines a driving style. If provided in combination with 'maximum_speed' or 'speed_factor', those values override the values defined by the selected 'style'. */
2485
+ style?: Maybe<RouteDrivingStyle>;
2486
+ };
2487
+ export declare type MatchedRouteMetadata = {
2488
+ /** Application identifier. */
2489
+ app_id: Scalars["ID"];
2490
+ /** Date when a route was created by the 'createMatchedRoute' mutation. */
2491
+ created_at: Scalars["DateTime"];
2492
+ /** Last updated date of a route. */
2493
+ updated_at: Scalars["DateTime"];
2494
+ /** Length of time required to successfully calculate a route, in milliseconds. */
2495
+ computation_time?: Maybe<Scalars["Int"]>;
2496
+ };
2497
+ export declare type MatchedRouteOperatorPreferences = {
2498
+ /** Ranking of an operator with multiple levels, each level having its own penalty value. */
2499
+ ranking?: Maybe<RouteOperatorPreferencesRanking>;
2500
+ /** Operators that should be excluded for a route calculation. */
2501
+ exclude?: Maybe<Array<RouteOperatorsValue>>;
2502
+ /** Operators that should be avoided, but not excluded, for a route calculation. */
2503
+ avoid?: Maybe<Array<RouteOperatorsValue>>;
2504
+ };
2505
+ /** Prioritized operators for a route calculation. */
2506
+ export declare type MatchedRouteOperatorPreferencesInput = {
2507
+ /** Operators to be preferred in route calculation. If not specified, no operator ranking is applied (including project-configured ranking). */
2508
+ ranking?: Maybe<MatchedRouteOperatorPreferencesRankingInput>;
2509
+ /** Operators to be excluded from route calculation. If specified, overrides project-configured operator exclusions. If not specified, applies project-configured operator exclusions. */
2510
+ exclude?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2511
+ /** Operators that should be avoided, but not excluded, for a route calculation. */
2512
+ avoid?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2513
+ };
2514
+ export declare type MatchedRouteOperatorPreferencesRankingInput = {
2515
+ /** Flag indicating if an operator should be preferred or required. */
2516
+ type: RouteOperatorsType;
2517
+ /** Ranking levels for operator ranking. */
2518
+ levels?: Maybe<MatchedRouteOperatorPreferencesRankingLevelsInput>;
2519
+ };
2520
+ export declare type MatchedRouteOperatorPreferencesRankingLevelsInput = {
2521
+ /** Least significant level for operator ranking. */
2522
+ low?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2523
+ /** Medium level for operator ranking. */
2524
+ medium?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2525
+ /** Most significant level for operator ranking. */
2526
+ high?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2527
+ };
2528
+ export declare type MatchedRouteOperatorsValueInput = {
2529
+ /** ID of an operator. */
2530
+ id: Scalars["ID"];
2531
+ /** List of countries in which the operator should be preferred/excluded/avoided. When omitted the operator will be preferred/excluded in every country. */
2532
+ countries?: Maybe<Array<CountryCodeAlpha2>>;
2533
+ };
2534
+ export declare type MatchedRoutePoint = {
2535
+ /** Coordinates [longitude, latitude]. */
2536
+ coordinates: Array<Scalars["Float"]>;
2537
+ };
2538
+ export declare type MatchedRoutePointInput = {
2539
+ /** Chronological sequence of coordinates [longitude, latitude]. Minimum 2. */
2540
+ coordinates: Array<Scalars["Float"]>;
2541
+ };
2542
+ export declare type MatchedRoutePropertiesVehicle = {
2543
+ /** Occupant configuration from this point. Null when this via only overrides total_cargo_weight. */
2544
+ occupants?: Maybe<MatchedRouteVehicleOccupants>;
2545
+ /** Weight of the cargo from this point. Null when this via only overrides occupants. */
2546
+ total_cargo_weight?: Maybe<TotalCargoWeight>;
2547
+ };
2548
+ export declare type MatchedRoutePropertiesVehicleInput = {
2549
+ /** Occupant configuration from this point. */
2550
+ occupants?: Maybe<MatchedRouteVehicleOccupantsInput>;
2551
+ /** Weight of the cargo from this point. */
2552
+ total_cargo_weight?: Maybe<TotalCargoWeightInput>;
2553
+ };
2554
+ export declare type MatchedRoutePropertiesViaLocation = {
2555
+ /** Name that should overwrite the name that is automatically assigned to this location (for example: address). */
2556
+ name?: Maybe<Scalars["String"]>;
2557
+ /** Duration to stay at this point, in seconds. */
2558
+ stop_duration?: Maybe<Scalars["Int"]>;
2559
+ };
2560
+ export declare type MatchedRoutePropertiesViaLocationInput = {
2561
+ /** Name that should overwrite the name that is automatically assigned to this location (for example: address). */
2562
+ name?: Maybe<Scalars["String"]>;
2563
+ /** Duration to stay at this point, in seconds. */
2564
+ stop_duration?: Maybe<Scalars["Int"]>;
2565
+ };
2566
+ export declare type MatchedRouteResponse = {
2567
+ /** ID of a route calculation. */
2568
+ id: Scalars["ID"];
2569
+ /** Status of a route. */
2570
+ status: RouteStatus;
2571
+ /** Recommended route. */
2572
+ route_details?: Maybe<MatchedRouteDetails>;
2573
+ /** Meta data for a route. */
2574
+ meta: MatchedRouteMetadata;
2575
+ /** Route request. */
2576
+ request_input: CreateMatchedRoute;
2577
+ };
2578
+ export declare type MatchedRouteVehicle = {
2579
+ /** ID of the vehicle. */
2580
+ id: Scalars["ID"];
2581
+ /** EV battery specific configuration. */
2582
+ battery: RouteVehicleBattery;
2583
+ /** Charging configuration. */
2584
+ charging: MatchedRouteVehicleCharging;
2585
+ /** Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right. */
2586
+ tire_pressure: TirePressure;
2587
+ /** Value of the vehicle's odometer. */
2588
+ odometer?: Maybe<Odometer>;
2589
+ /** Value of the auxiliary power consumption of the vehicle. */
2590
+ auxiliary_consumption: AuxiliaryConsumption;
2591
+ /** Flag indicating if climate control is on. */
2592
+ climate: Scalars["Boolean"];
2593
+ /** Vehicle Heat Pump configuration. */
2594
+ heat_pump: HeatPumpMode;
2595
+ /** Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true. */
2596
+ cabin: RouteVehicleCabin;
2597
+ /** Initial occupant settings. This value can be overridden along the journey through 'via.properties.vehicle.occupants' field. */
2598
+ occupants: MatchedRouteVehicleOccupants;
2599
+ /** Initial cargo. This value can be overridden along the journey through 'via.properties.vehicle.total_cargo_weight' field. */
2600
+ total_cargo_weight: TotalCargoWeight;
2601
+ };
2602
+ /** EV battery specific configuration for a create route mutation. */
2603
+ export declare type MatchedRouteVehicleBatteryInput = {
2604
+ /** Usable capacity of a battery used to compute a route. Value must be between 50% and 150%. If not provided, it defaults to the vehicle ‘battery.usable_kwh‘. */
2605
+ capacity?: Maybe<StateOfChargeInput>;
2606
+ /** Current amount of energy in a battery. If not provided, it is assumed the battery is fully charged and equal to the vehicle ‘battery.capacity‘. */
2607
+ state_of_charge?: Maybe<StateOfChargeInput>;
2608
+ /** Desired final amount of energy in a battery at the end of a trip. The value must be between 0 and 60% of the vehicle ‘battery.capacity‘. If not provided—or if the specified value is below the safe risk margin—the safe risk margin is used by default. */
2609
+ final_state_of_charge?: Maybe<StateOfChargeInput>;
2610
+ };
2611
+ export declare type MatchedRouteVehicleCharging = {
2612
+ /** Mode that indicates if the charging time is optimized or if always charged to the maximum capacity. */
2613
+ mode: ChargeMode;
2614
+ /** Minimum desired power of chargers, in kWh. */
2615
+ minimum_power: Scalars["Float"];
2616
+ /** Minimum remaining state of charge at charging stops, expressed as a percentage. The value must be between 0 and 60. If not provided, the project configuration value is used. */
2617
+ risk_margin: Scalars["Int"];
2618
+ /** Supported connectors. If not specified, it defaults to the vehicle's connectors. */
2619
+ connectors: Array<RouteVehicleChargingConnector>;
2620
+ /** Supported adapters. If not specified, adapters will not be considered. */
2621
+ adapters: Array<RouteVehicleChargingConnector>;
2622
+ };
2623
+ export declare type MatchedRouteVehicleChargingConnector = {
2624
+ /** Type of the plug. */
2625
+ standard: ConnectorType;
2626
+ /** Maximum charging speed for this plug. */
2627
+ maximum_charge_speed: ChargeSpeed;
2628
+ };
2629
+ export declare type MatchedRouteVehicleChargingConnectorInput = {
2630
+ /** Plug type. */
2631
+ standard: ConnectorType;
2632
+ /** Maximum charging speed for this plug. */
2633
+ maximum_charge_speed: ChargeSpeedInput;
2634
+ };
2635
+ export declare type MatchedRouteVehicleChargingInput = {
2636
+ /** Mode that indicates if the charging time is optimized or if always charged to the maximum capacity. */
2637
+ mode?: Maybe<ChargeMode>;
2638
+ /** Minimum desired power of chargers, in kW. */
2639
+ minimum_power?: Maybe<Scalars["Float"]>;
2640
+ /** Minimum remaining state of charge at charging stops, expressed as a percentage. The value must be between 0 and 60. If not provided, the project configuration value is used. */
2641
+ risk_margin?: Maybe<Scalars["Int"]>;
2642
+ /** Supported connectors. If not specified, it defaults to the vehicle's connectors. */
2643
+ connectors?: Maybe<Array<MatchedRouteVehicleChargingConnectorInput>>;
2644
+ /** Supported adapters. If not specified, adapters will not be considered. */
2645
+ adapters?: Maybe<Array<MatchedRouteVehicleChargingConnectorInput>>;
2646
+ };
2647
+ /** Vehicle specific input for a create route mutation. */
2648
+ export declare type MatchedRouteVehicleInput = {
2649
+ /** ID of the vehicle. */
2650
+ id: Scalars["ID"];
2651
+ /** EV battery specific configuration. */
2652
+ battery?: Maybe<MatchedRouteVehicleBatteryInput>;
2653
+ /** Charging configuration. */
2654
+ charging?: Maybe<MatchedRouteVehicleChargingInput>;
2655
+ /** Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right. */
2656
+ tire_pressure?: Maybe<TirePressureInput>;
2657
+ /** Average auxiliary power consumption. */
2658
+ auxiliary_consumption?: Maybe<AuxiliaryConsumptionInput>;
2659
+ /** Flag indicating if climate control is on. */
2660
+ climate?: Maybe<Scalars["Boolean"]>;
2661
+ /** Vehicle Heat Pump configuration. */
2662
+ heat_pump?: Maybe<HeatPumpMode>;
2663
+ /** Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true. */
2664
+ cabin?: Maybe<RouteVehicleCabinInput>;
2665
+ /** Initial occupant settings. This value can be overridden along the journey through 'via.properties.vehicle.occupants' field. */
2666
+ occupants?: Maybe<MatchedRouteVehicleOccupantsInput>;
2667
+ /** "Initial cargo. This value can be overridden along the journey through 'via.properties.vehicle.total_cargo_weight' field." */
2668
+ total_cargo_weight?: Maybe<TotalCargoWeightInput>;
2669
+ };
2670
+ export declare type MatchedRouteVehicleOccupants = {
2671
+ /** Number of occupants present in the vehicle. */
2672
+ occupants: Scalars["Int"];
2673
+ /** Combined weight of the occupants. This can only be used in combination with occupants. */
2674
+ total_occupant_weight?: Maybe<TotalOccupantWeight>;
2675
+ };
2676
+ export declare type MatchedRouteVehicleOccupantsInput = {
2677
+ /** Number of occupants present in the vehicle. */
2678
+ count: Scalars["Int"];
2679
+ /** Combined weight of the occupants. */
2680
+ total_weight?: Maybe<TotalOccupantWeightInput>;
2681
+ };
2682
+ export declare type MatchedRouteVia = {
2683
+ /** Index of the corresponding coordinate in the points array. */
2684
+ index: Scalars["Int"];
2685
+ /** Via properties. */
2686
+ properties?: Maybe<MatchedRouteViaProperties>;
2687
+ };
2688
+ export declare type MatchedRouteViaInput = {
2689
+ /** Index of the corresponding coordinate in the points array. */
2690
+ index: Scalars["Int"];
2691
+ /** Additional details of the via. */
2692
+ properties?: Maybe<MatchedRouteViaPropertiesInput>;
2693
+ };
2694
+ export declare type MatchedRouteViaProperties = {
2695
+ /** Location data of the via point. */
2696
+ location?: Maybe<MatchedRoutePropertiesViaLocation>;
2697
+ /** Vehicle data of the via point. */
2698
+ vehicle?: Maybe<MatchedRoutePropertiesVehicle>;
2699
+ };
2700
+ export declare type MatchedRouteViaPropertiesInput = {
2701
+ /** Location data of the via point. */
2702
+ location?: Maybe<MatchedRoutePropertiesViaLocationInput>;
2703
+ /** Vehicle data of the via point. If provided, the values override the configuration set in 'vehicle' or the previous 'via', and are propagated to subsequent legs until overridden. */
2704
+ vehicle?: Maybe<MatchedRoutePropertiesVehicleInput>;
2705
+ };
2706
+ export declare type MatchedRouteWeather = {
2707
+ /** Weather configuration applied to the route. */
2708
+ type: WeatherType;
2709
+ /** [BETA] Custom weather conditions applied to the route. Only present when 'type' is set to 'CUSTOM'. */
2710
+ custom?: Maybe<RouteWeatherCustomConditions>;
2711
+ };
2126
2712
  export declare type MaximumSpeed = {
2127
2713
  /** Numeric value of the user-defined maximum speed. */
2128
2714
  value: Scalars["Int"];
@@ -2195,6 +2781,8 @@ export declare type Mutation = {
2195
2781
  createRoute: Scalars["ID"];
2196
2782
  /** [ALPHA] Create a new truck route from the route input and its ID. */
2197
2783
  createTruckRoute: Scalars["ID"];
2784
+ /** [ALPHA] Creates route from a sequence of points. */
2785
+ createMatchedRoute?: Maybe<Scalars["ID"]>;
2198
2786
  };
2199
2787
  export declare type MutationcreateConnectedVehicleArgs = {
2200
2788
  input?: Maybe<CreateConnectedVehicleInput>;
@@ -2241,6 +2829,9 @@ export declare type MutationcreateRouteArgs = {
2241
2829
  export declare type MutationcreateTruckRouteArgs = {
2242
2830
  input: CreateTruckRouteInput;
2243
2831
  };
2832
+ export declare type MutationcreateMatchedRouteArgs = {
2833
+ input: CreateMatchedRouteInput;
2834
+ };
2244
2835
  /** Navigation session data. */
2245
2836
  export declare type Navigation = {
2246
2837
  /** ID of the navigation session. */
@@ -3489,6 +4080,8 @@ export declare type Query = {
3489
4080
  getRouteStationsWithAmenities: RouteStationsWithAmenitiesConnection;
3490
4081
  /** [ALPHA] Get a e-truck route by ID. */
3491
4082
  getTruckRoute: TruckRouteResponse;
4083
+ /** [ALPHA] Get a route by request ID. */
4084
+ getMatchedRoute?: Maybe<MatchedRouteResponse>;
3492
4085
  /** Get information about a station by its ID. */
3493
4086
  station?: Maybe<Station>;
3494
4087
  /** Get a full list of stations. */
@@ -3583,6 +4176,9 @@ export declare type QuerygetRouteStationsWithAmenitiesArgs = {
3583
4176
  export declare type QuerygetTruckRouteArgs = {
3584
4177
  id: Scalars["ID"];
3585
4178
  };
4179
+ export declare type QuerygetMatchedRouteArgs = {
4180
+ id: Scalars["ID"];
4181
+ };
3586
4182
  export declare type QuerystationArgs = {
3587
4183
  id?: Maybe<Scalars["ID"]>;
3588
4184
  evse_id?: Maybe<Scalars["String"]>;
@@ -5887,7 +6483,7 @@ export declare type RouteVehicleBattery = {
5887
6483
  current?: Maybe<Scalars["Float"]>;
5888
6484
  /** Battery voltage in volts. */
5889
6485
  voltage?: Maybe<Scalars["Float"]>;
5890
- /** Value of the positive or negative power, in kWh. When negative, the vehicle is charging. */
6486
+ /** Value of the positive or negative power, in kW. When negative, the vehicle is charging. */
5891
6487
  power?: Maybe<Scalars["Float"]>;
5892
6488
  /** Flag indicating if the vehicle is charging. */
5893
6489
  is_charging?: Maybe<Scalars["Boolean"]>;
@@ -5906,7 +6502,7 @@ export declare type RouteVehicleBatteryInput = {
5906
6502
  current?: Maybe<Scalars["Float"]>;
5907
6503
  /** Battery voltage in volts. */
5908
6504
  voltage?: Maybe<Scalars["Float"]>;
5909
- /** Value of the positive or negative power, in kWh. When negative, the vehicle is charging. */
6505
+ /** Value of the positive or negative power, in kW. When negative, the vehicle is charging. */
5910
6506
  power?: Maybe<Scalars["Float"]>;
5911
6507
  /** Flag indicating if the vehicle is charging. */
5912
6508
  is_charging?: Maybe<Scalars["Boolean"]>;
@@ -5926,7 +6522,7 @@ export declare type RouteVehicleCabinInput = {
5926
6522
  export declare type RouteVehicleCharging = {
5927
6523
  /** Mode that indicates if the charging time is optimized or if always charged to the maximum state of charge. */
5928
6524
  mode: ChargeMode;
5929
- /** Minimum desired power of chargers, in kWh. */
6525
+ /** Minimum desired power of chargers, in kW. */
5930
6526
  minimum_power: Scalars["Float"];
5931
6527
  /** Minimum remaining state of charge at charging stops, expressed as a percentage. The value must be between 0 and 60. If not provided, the project configuration value is used. */
5932
6528
  risk_margin: Scalars["Int"];
@@ -6565,6 +7161,8 @@ export declare type Subscription = {
6565
7161
  * @deprecated In favor of `route`.
6566
7162
  */
6567
7163
  routeUpdatedById?: Maybe<Route>;
7164
+ /** [ALPHA] Subscribe to a route by request ID. */
7165
+ matchedRoute?: Maybe<MatchedRouteResponse>;
6568
7166
  /** Subscribe to a specific route to receive system event updates. */
6569
7167
  route: RouteResponse;
6570
7168
  /** [ALPHA] Subscribe to e-truck route to receive system event updates. */
@@ -6579,6 +7177,9 @@ export declare type Subscription = {
6579
7177
  export declare type SubscriptionrouteUpdatedByIdArgs = {
6580
7178
  id: Scalars["ID"];
6581
7179
  };
7180
+ export declare type SubscriptionmatchedRouteArgs = {
7181
+ id: Scalars["ID"];
7182
+ };
6582
7183
  export declare type SubscriptionrouteArgs = {
6583
7184
  id: Scalars["ID"];
6584
7185
  };
@@ -7171,18 +7772,18 @@ export declare type VehicleBodyWeightmaximalArgs = {
7171
7772
  export declare type VehicleConnector = {
7172
7773
  /** Connector type, known as connector standard in OCPI. */
7173
7774
  standard: ConnectorType;
7174
- /** Usable electric power. */
7775
+ /** Average charging power. For fast charging connectors, represents the average power from 10% to 80% state of charge. For slow charging connectors, value is identical to `max_electric_power`. */
7175
7776
  power: Scalars["Float"];
7176
- /** Maximum electric power. */
7777
+ /** Peak charging power. For slow charging connectors, value is identical to `power`. */
7177
7778
  max_electric_power: Scalars["Float"];
7178
- /** Time it takes to charge from 10 to 80% with a fast charger, shown in minutes. */
7779
+ /** Time needed to charge, in minutes. For fast charging connectors, represents time from 10% to 80% state of charge. For slow charging connectors, represents time from 0% to 100%. */
7179
7780
  time: Scalars["Int"];
7180
7781
  /**
7181
7782
  * Charging speed.
7182
7783
  * @deprecated In favor of `charge_speed`.
7183
7784
  */
7184
7785
  speed: Scalars["Float"];
7185
- /** Charging speed. */
7786
+ /** Average charging speed. For fast charging connectors, represents average rate from 10% to 80% state of charge. For slow charging connectors, represents average rate from 0% to 100%. */
7186
7787
  charge_speed: Scalars["Float"];
7187
7788
  };
7188
7789
  /** Vehicle plug model. */
@@ -8097,9 +8698,9 @@ export declare type VehiclePremiumPrice = {
8097
8698
  GB?: Maybe<VehiclePremiumPriceValueWithGrant>;
8098
8699
  };
8099
8700
  export declare type VehiclePremiumPriceValueWithGrant = {
8100
- /** Starting price for local market expressed in the currency in the field currency. */
8701
+ /** Starting price for the local market. The value applies to the optional `country` field provided in the query input. If `country` is not specified, it defaults to the Dutch market price. If the unit argument is not provided, the value is returned in the local currency of the selected country. */
8101
8702
  value?: Maybe<Scalars["Float"]>;
8102
- /** Currency in which the value without optional field conversion is expressed. */
8703
+ /** Currency in which the prices of `grant_applied`, `price_delivery` and `price_first_registration_fee` fields are expressed. The value applies to the optional `country` field provided in the query input. If `country` is not specified, defaults to Euro (EUR). */
8103
8704
  currency?: Maybe<CurrencyUnit>;
8104
8705
  /** Indicates if the starting price is based on an estimate. */
8105
8706
  is_estimated?: Maybe<Scalars["Boolean"]>;