@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.
package/src/graphql.ts CHANGED
@@ -396,12 +396,14 @@ export type ChargeSpeedInput = {
396
396
  };
397
397
 
398
398
  export enum ChargeSpeedUnit {
399
- /** Return the charge speed in kilowatt hours. */
399
+ /** Charge speed in kilowatt hours. */
400
400
  KILOWATT_HOUR = "kilowatt_hour",
401
- /** Return the charge speed in kilometers per hour. */
401
+ /** Charge speed in kilometers per hour. */
402
402
  KILOMETERS_PER_HOUR = "kilometers_per_hour",
403
- /** Return the charge speed in miles per hour. */
404
- MILES_PER_HOUR = "miles_per_hour"
403
+ /** Charge speed in miles per hour. */
404
+ MILES_PER_HOUR = "miles_per_hour",
405
+ /** Charge speed in kilowatts. */
406
+ KILOWATT = "kilowatt"
405
407
  }
406
408
 
407
409
  export type ChargeTotalInput = {
@@ -1269,6 +1271,46 @@ export type CreateConnectedVehicleOptions = {
1269
1271
  scope?: Maybe<Array<ConnectScope>>;
1270
1272
  };
1271
1273
 
1274
+ export type CreateMatchedRoute = {
1275
+ /** Vehicle used on a route. */
1276
+ vehicle: MatchedRouteVehicle;
1277
+ /** Via points of a route. */
1278
+ via?: Maybe<Array<MatchedRouteVia>>;
1279
+ /** Chronological sequence of GPS points used for map-matching. Minimum 2. */
1280
+ points: Array<MatchedRoutePoint>;
1281
+ /** Operator preferences for a route. When provided, prefers routes that use higher order operators. */
1282
+ operators?: Maybe<MatchedRouteOperatorPreferences>;
1283
+ /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
1284
+ alternative_station_radius?: Maybe<MatchedRouteAlternativeStationRadius>;
1285
+ /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
1286
+ departure_time: Scalars["DateTime"];
1287
+ /** 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. */
1288
+ driving_preferences?: Maybe<MatchedRouteDrivingPreferences>;
1289
+ /** Weather configuration for the route. Defined by a preset or custom weather conditions. */
1290
+ weather: MatchedRouteWeather;
1291
+ };
1292
+
1293
+ export type CreateMatchedRouteInput = {
1294
+ /** Vehicle specific input. */
1295
+ vehicle: MatchedRouteVehicleInput;
1296
+ /** Chronological sequence of GPS points used for map-matching. Minimum 2. */
1297
+ points: Array<MatchedRoutePointInput>;
1298
+ /** Intermediate via points along the route. */
1299
+ via?: Maybe<Array<MatchedRouteViaInput>>;
1300
+ /** Route departure time. Used to calculate the arrival time and, when 'weather.type' is 'ACTUAL',retrieve weather data. */
1301
+ departure_time?: Maybe<Scalars["DateTime"]>;
1302
+ /** Weather configuration for the route. Defined by actual, a preset or custom weather conditions. */
1303
+ weather?: Maybe<RouteWeatherInput>;
1304
+ /** 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. */
1305
+ driving_preferences?: Maybe<MatchedRouteDrivingPreferencesInput>;
1306
+ /** 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. */
1307
+ plan_charging_stops?: Maybe<Scalars["Boolean"]>;
1308
+ /** 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. */
1309
+ operators?: Maybe<MatchedRouteOperatorPreferencesInput>;
1310
+ /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
1311
+ alternative_station_radius?: Maybe<MatchedRouteAlternativeStationRadiusInput>;
1312
+ };
1313
+
1272
1314
  export type CreateRoute = {
1273
1315
  /** Vehicle used on a route. */
1274
1316
  vehicle: RouteVehicle;
@@ -1325,7 +1367,7 @@ export type CreateRouteInput = {
1325
1367
  departure_time?: Maybe<Scalars["DateTime"]>;
1326
1368
  /** [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. */
1327
1369
  avoid?: Maybe<Array<RouteAvoid>>;
1328
- /** Weather configuration for the route. Defined by a preset or custom weather conditions. If not specified, defaults to real-time weather data. */
1370
+ /** 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`. */
1329
1371
  weather?: Maybe<RouteWeatherInput>;
1330
1372
  /** Charging stations preferences for route calculation. */
1331
1373
  station_preferences?: Maybe<RouteStationPreferencesInput>;
@@ -2264,6 +2306,623 @@ export enum LineStringType {
2264
2306
  LINESTRING = "LineString"
2265
2307
  }
2266
2308
 
2309
+ export type MatchedRouteAlternativeStationRadius = {
2310
+ /** Value of the alternative station radius. */
2311
+ value: Scalars["Float"];
2312
+ /** Preferred unit for the alternative station radius. */
2313
+ type: DistanceUnit;
2314
+ };
2315
+
2316
+ export type MatchedRouteAlternativeStationRadiusInput = {
2317
+ /** Value of the alternative station radius. */
2318
+ value: Scalars["Float"];
2319
+ /** Preferred unit for the alternative station radius. */
2320
+ type: DistanceUnit;
2321
+ };
2322
+
2323
+ export type MatchedRouteDetails = {
2324
+ /** ID of a route computation. */
2325
+ id: Scalars["ID"];
2326
+ /** Total distance of a route. */
2327
+ distance: Scalars["Float"];
2328
+ /** Aggregation of all durations of a route. */
2329
+ durations: MatchedRouteDetailsDurations;
2330
+ /** Total energy used for a route in kilowatt hours. For HEVs and PHEVs this field will return null. */
2331
+ consumption?: Maybe<Scalars["Float"]>;
2332
+ /** 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. */
2333
+ range_at_origin?: Maybe<Scalars["Float"]>;
2334
+ /** 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. */
2335
+ range_at_destination?: Maybe<Scalars["Float"]>;
2336
+ /** Polyline containing encoded coordinates. */
2337
+ polyline: Scalars["String"];
2338
+ /** Path elevation, distance, duration, consumption and speed values, grouped into 100 segments. */
2339
+ path_plot: Array<MatchedRouteDetailsPathSegment>;
2340
+ /** Details about elevation on a route. */
2341
+ elevation: MatchedRouteDetailsElevation;
2342
+ /** Money saving information. */
2343
+ savings?: Maybe<MatchedRouteDetailsSavings>;
2344
+ /** Legs of a route. */
2345
+ legs: Array<MatchedRouteDetailsLeg>;
2346
+ /**
2347
+ * Alternative stations along a route within a specified radius.
2348
+ *
2349
+ * Includes stations from preferred/required/avoided operators but excludes stations from excluded operators.
2350
+ * This list is only populated if `alternative_station_radius` was specified in the `createRoute` mutation.
2351
+ */
2352
+ alternative_stations: Array<MatchedRouteDetailsAlternativeStation>;
2353
+ /** Aggregation of tags over the current RouteDetails. Tags are available on legs and further subdivided over individual sections and maneuvers. */
2354
+ tags: Array<RouteDetailsTag>;
2355
+ /** Number of charging stops required for this route. */
2356
+ charges: Scalars["Int"];
2357
+ };
2358
+
2359
+ export type MatchedRouteDetailsdistanceArgs = {
2360
+ unit?: Maybe<DistanceUnit>;
2361
+ };
2362
+
2363
+ export type MatchedRouteDetailsrange_at_originArgs = {
2364
+ unit?: Maybe<StateOfChargeUnit>;
2365
+ };
2366
+
2367
+ export type MatchedRouteDetailsrange_at_destinationArgs = {
2368
+ unit?: Maybe<StateOfChargeUnit>;
2369
+ };
2370
+
2371
+ export type MatchedRouteDetailspolylineArgs = {
2372
+ decimals?: Maybe<PolylineInputDecimals>;
2373
+ };
2374
+
2375
+ export type MatchedRouteDetailsAlternativeStation = {
2376
+ /** ID of a station. */
2377
+ id: Scalars["ID"];
2378
+ /** GeoJSON location of a station. */
2379
+ location: Point;
2380
+ /** Speed of a station. A station along a route can be either fast or turbo. */
2381
+ speed: StationSpeedType;
2382
+ /** Status of a station. */
2383
+ status: ChargerStatus;
2384
+ /** 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. */
2385
+ operator_ranking?: Maybe<OperatorRankingLevel>;
2386
+ /** ID of the station's operator. */
2387
+ operator_id?: Maybe<Scalars["ID"]>;
2388
+ };
2389
+
2390
+ export type MatchedRouteDetailsDurations = {
2391
+ /** Total duration, in seconds. */
2392
+ total: Scalars["Int"];
2393
+ /** Total charging duration, in seconds. */
2394
+ charging: Scalars["Int"];
2395
+ /** Total driving duration, in seconds. */
2396
+ driving: Scalars["Int"];
2397
+ /** Total duration stopped at a location via or at a station via, excluding charging time and charging penalty, in seconds. */
2398
+ stopover: Scalars["Int"];
2399
+ /** Total ferry duration, in seconds. */
2400
+ ferry: Scalars["Int"];
2401
+ };
2402
+
2403
+ export type MatchedRouteDetailsElevation = {
2404
+ /** Total value driving uphill on a route. */
2405
+ up: Scalars["Float"];
2406
+ /** Total value driving downhill on a route. */
2407
+ down: Scalars["Float"];
2408
+ /** Maximum elevation on a route. */
2409
+ maximum: Scalars["Float"];
2410
+ /** Minimum elevation on a route. */
2411
+ minimum: Scalars["Float"];
2412
+ };
2413
+
2414
+ export type MatchedRouteDetailsElevationupArgs = {
2415
+ unit?: Maybe<DistanceUnit>;
2416
+ };
2417
+
2418
+ export type MatchedRouteDetailsElevationdownArgs = {
2419
+ unit?: Maybe<DistanceUnit>;
2420
+ };
2421
+
2422
+ export type MatchedRouteDetailsElevationmaximumArgs = {
2423
+ unit?: Maybe<DistanceUnit>;
2424
+ };
2425
+
2426
+ export type MatchedRouteDetailsElevationminimumArgs = {
2427
+ unit?: Maybe<DistanceUnit>;
2428
+ };
2429
+
2430
+ /** Leg of a route detail. */
2431
+ export type MatchedRouteDetailsLeg = {
2432
+ /** Distance from the start to the end of a leg. */
2433
+ distance: Scalars["Float"];
2434
+ /** Aggregation of all durations of a route leg. */
2435
+ durations: MatchedRouteDetailsDurations;
2436
+ /** Total energy used in a leg in kilowatt hours. For HEVs and PHEVs this field will return null. */
2437
+ consumption?: Maybe<Scalars["Float"]>;
2438
+ /** Origin point location. */
2439
+ origin: MatchedRouteDetailsLegFeaturePoint;
2440
+ /** Destination point location. */
2441
+ destination: MatchedRouteDetailsLegFeaturePoint;
2442
+ /** 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. */
2443
+ range_at_origin?: Maybe<Scalars["Float"]>;
2444
+ /** 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. */
2445
+ range_at_destination?: Maybe<Scalars["Float"]>;
2446
+ /** 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. */
2447
+ range_after_charge?: Maybe<Scalars["Float"]>;
2448
+ /** Type of a leg. */
2449
+ type: RouteDetailsLegType;
2450
+ /** Information about the station at the destination of a leg. */
2451
+ station?: Maybe<MatchedRouteDetailsLegStation>;
2452
+ /** Polyline containing encoded coordinates. */
2453
+ polyline: Scalars["String"];
2454
+ /** Aggregation of tags over the current leg. Tags are further subdivided over individual sections and maneuvers. */
2455
+ tags: Array<RouteDetailsTag>;
2456
+ /** Maneuvers of a leg - used to generate turn-by-turn instructions. */
2457
+ maneuvers: Array<RouteDetailsManeuver>;
2458
+ /** Road sections of a leg - divided by means of transportation. */
2459
+ sections: Array<MatchedRouteDetailsLegSection>;
2460
+ };
2461
+
2462
+ /** Leg of a route detail. */
2463
+ export type MatchedRouteDetailsLegdistanceArgs = {
2464
+ unit?: Maybe<DistanceUnit>;
2465
+ };
2466
+
2467
+ /** Leg of a route detail. */
2468
+ export type MatchedRouteDetailsLegrange_at_originArgs = {
2469
+ unit?: Maybe<StateOfChargeUnit>;
2470
+ };
2471
+
2472
+ /** Leg of a route detail. */
2473
+ export type MatchedRouteDetailsLegrange_at_destinationArgs = {
2474
+ unit?: Maybe<StateOfChargeUnit>;
2475
+ };
2476
+
2477
+ /** Leg of a route detail. */
2478
+ export type MatchedRouteDetailsLegrange_after_chargeArgs = {
2479
+ unit?: Maybe<StateOfChargeUnit>;
2480
+ };
2481
+
2482
+ /** Leg of a route detail. */
2483
+ export type MatchedRouteDetailsLegpolylineArgs = {
2484
+ decimals?: Maybe<PolylineInputDecimals>;
2485
+ };
2486
+
2487
+ export type MatchedRouteDetailsLegFeaturePoint = {
2488
+ /** ID of the feature. */
2489
+ id?: Maybe<Scalars["ID"]>;
2490
+ /** Feature type. */
2491
+ type: FeatureType;
2492
+ /** Geometry of the feature. */
2493
+ geometry: Point;
2494
+ /** Properties of the feature. */
2495
+ properties?: Maybe<MatchedRouteDetailsLegFeatureProperties>;
2496
+ };
2497
+
2498
+ export type MatchedRouteDetailsLegFeatureProperties = {
2499
+ /** Name of the location. */
2500
+ name?: Maybe<Scalars["String"]>;
2501
+ /** ID of the station. */
2502
+ station_id?: Maybe<Scalars["ID"]>;
2503
+ /** External ID of the station. */
2504
+ external_station_id?: Maybe<Scalars["ID"]>;
2505
+ /** Temperature at the location. */
2506
+ temperature?: Maybe<Scalars["Int"]>;
2507
+ /** Air pressure at the location. */
2508
+ air_pressure?: Maybe<Scalars["Float"]>;
2509
+ /** Solar irradiance at the location. */
2510
+ solar_irradiance?: Maybe<Scalars["Float"]>;
2511
+ /**
2512
+ * Duration, in seconds, of time spent at this location.
2513
+ * @deprecated In favor of `legs.durations`.
2514
+ */
2515
+ duration?: Maybe<Scalars["Int"]>;
2516
+ /** Number of occupants present in the vehicle. */
2517
+ occupants?: Maybe<Scalars["Int"]>;
2518
+ /** Value of the combined weight of the occupants. */
2519
+ total_occupant_weight?: Maybe<Scalars["Float"]>;
2520
+ /** Value of the current weight of the cargo. */
2521
+ total_cargo_weight?: Maybe<Scalars["Float"]>;
2522
+ };
2523
+
2524
+ export type MatchedRouteDetailsLegFeaturePropertiestemperatureArgs = {
2525
+ unit?: Maybe<TemperatureUnit>;
2526
+ };
2527
+
2528
+ export type MatchedRouteDetailsLegFeaturePropertiestotal_occupant_weightArgs = {
2529
+ unit?: Maybe<WeightUnit>;
2530
+ };
2531
+
2532
+ export type MatchedRouteDetailsLegFeaturePropertiestotal_cargo_weightArgs = {
2533
+ unit?: Maybe<WeightUnit>;
2534
+ };
2535
+
2536
+ export type MatchedRouteDetailsLegSection = {
2537
+ /** Section type. */
2538
+ type: RouteDetailsLegSectionType;
2539
+ /** Origin point. */
2540
+ origin: MatchedRouteDetailsLegSectionFeaturePoint;
2541
+ /** Destination point. */
2542
+ destination: MatchedRouteDetailsLegSectionFeaturePoint;
2543
+ /** Aggregation of tags over the current section. */
2544
+ tags: Array<RouteDetailsTag>;
2545
+ /** Polyline containing encoded coordinates. */
2546
+ polyline: Scalars["String"];
2547
+ /** Distance from the start to the end of a section. */
2548
+ distance: Scalars["Float"];
2549
+ /** Total duration of a section, in seconds. The value will be 0 for walking sections. */
2550
+ duration: Scalars["Float"];
2551
+ /** Total energy used in a section in kilowatt-hours. The value will be 0 for walking sections. */
2552
+ consumption?: Maybe<Scalars["Float"]>;
2553
+ };
2554
+
2555
+ export type MatchedRouteDetailsLegSectionpolylineArgs = {
2556
+ decimals?: Maybe<PolylineInputDecimals>;
2557
+ };
2558
+
2559
+ export type MatchedRouteDetailsLegSectiondistanceArgs = {
2560
+ unit?: Maybe<DistanceUnit>;
2561
+ };
2562
+
2563
+ export type MatchedRouteDetailsLegSectionFeaturePoint = {
2564
+ /** ID of the feature. */
2565
+ id?: Maybe<Scalars["ID"]>;
2566
+ /** Feature type. */
2567
+ type: FeatureType;
2568
+ /** Geometry of the feature. */
2569
+ geometry: Point;
2570
+ /** Properties of the feature. */
2571
+ properties: MatchedRouteDetailsLegSectionFeaturePointProperties;
2572
+ };
2573
+
2574
+ export type MatchedRouteDetailsLegSectionFeaturePointProperties = {
2575
+ /** Number of occupants present in the vehicle. */
2576
+ occupants: Scalars["Int"];
2577
+ /** Value of the combined weight of the occupants. */
2578
+ total_occupant_weight?: Maybe<Scalars["Float"]>;
2579
+ /** Value of the current weight of the cargo. */
2580
+ total_cargo_weight?: Maybe<Scalars["Float"]>;
2581
+ };
2582
+
2583
+ export type MatchedRouteDetailsLegSectionFeaturePointPropertiestotal_occupant_weightArgs = {
2584
+ unit?: Maybe<WeightUnit>;
2585
+ };
2586
+
2587
+ export type MatchedRouteDetailsLegSectionFeaturePointPropertiestotal_cargo_weightArgs = {
2588
+ unit?: Maybe<WeightUnit>;
2589
+ };
2590
+
2591
+ export type MatchedRouteDetailsLegStation = {
2592
+ /** ID of a station. */
2593
+ station_id: Scalars["ID"];
2594
+ /** ID of the EVSE that was selected in a route. */
2595
+ evse_id?: Maybe<Scalars["ID"]>;
2596
+ /** ID of the connector that was selected in a route. */
2597
+ connector_id: Scalars["ID"];
2598
+ };
2599
+
2600
+ export type MatchedRouteDetailsPathSegment = {
2601
+ /** Elevation value of a route path segment. */
2602
+ elevation: Scalars["Float"];
2603
+ /** Average speed of a route path segment. This value is determined using legal maximum speed and, if provided, the user defined maximum speed. */
2604
+ average_speed: Scalars["Float"];
2605
+ /** Consumption, in kilowatt hours, of a route path segment. For HEVs and PHEVs this field will return null. */
2606
+ consumption?: Maybe<Scalars["Float"]>;
2607
+ /** Distance of a route path segment. */
2608
+ distance: Scalars["Float"];
2609
+ /** Duration, in seconds, of a route path segment. */
2610
+ duration: Scalars["Float"];
2611
+ /** State of charge, in kilowatt hours, of a route path segment. For HEVs and PHEVs this field will return null. */
2612
+ state_of_charge?: Maybe<Scalars["Float"]>;
2613
+ };
2614
+
2615
+ export type MatchedRouteDetailsPathSegmentelevationArgs = {
2616
+ unit?: Maybe<DistanceUnit>;
2617
+ };
2618
+
2619
+ export type MatchedRouteDetailsPathSegmentaverage_speedArgs = {
2620
+ unit?: Maybe<SpeedUnit>;
2621
+ };
2622
+
2623
+ export type MatchedRouteDetailsPathSegmentdistanceArgs = {
2624
+ unit?: Maybe<DistanceUnit>;
2625
+ };
2626
+
2627
+ export type MatchedRouteDetailsPathSegmentstate_of_chargeArgs = {
2628
+ unit?: Maybe<StateOfChargeUnit>;
2629
+ };
2630
+
2631
+ /** Money saving information. */
2632
+ export type MatchedRouteDetailsSavings = {
2633
+ /** Money saved by a user driving this route with an electric vehicle. */
2634
+ money?: Maybe<Scalars["Float"]>;
2635
+ /** Average gas price with which the calculation was made. */
2636
+ average_gas_price: Scalars["Float"];
2637
+ /** Average energy price with which the calculation was made. */
2638
+ average_energy_price: Scalars["Float"];
2639
+ };
2640
+
2641
+ /** Money saving information. */
2642
+ export type MatchedRouteDetailsSavingsmoneyArgs = {
2643
+ currency?: Maybe<Currency>;
2644
+ };
2645
+
2646
+ /** Money saving information. */
2647
+ export type MatchedRouteDetailsSavingsaverage_gas_priceArgs = {
2648
+ currency?: Maybe<Currency>;
2649
+ };
2650
+
2651
+ /** Money saving information. */
2652
+ export type MatchedRouteDetailsSavingsaverage_energy_priceArgs = {
2653
+ currency?: Maybe<Currency>;
2654
+ };
2655
+
2656
+ export type MatchedRouteDrivingPreferences = {
2657
+ /** 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'. */
2658
+ speed_factor?: Maybe<Scalars["Float"]>;
2659
+ /** 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'. */
2660
+ maximum_speed?: Maybe<MaximumSpeed>;
2661
+ /** Defines a driving style. If provided in combination with 'maximum_speed' or 'speed_factor', those values override the values defined by the selected 'style'. */
2662
+ style?: Maybe<RouteDrivingStyle>;
2663
+ };
2664
+
2665
+ export type MatchedRouteDrivingPreferencesInput = {
2666
+ /** [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'. */
2667
+ speed_factor?: Maybe<Scalars["Float"]>;
2668
+ /** [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'. */
2669
+ maximum_speed?: Maybe<MaximumSpeedInput>;
2670
+ /** [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'. */
2671
+ style?: Maybe<RouteDrivingStyle>;
2672
+ };
2673
+
2674
+ export type MatchedRouteMetadata = {
2675
+ /** Application identifier. */
2676
+ app_id: Scalars["ID"];
2677
+ /** Date when a route was created by the 'createMatchedRoute' mutation. */
2678
+ created_at: Scalars["DateTime"];
2679
+ /** Last updated date of a route. */
2680
+ updated_at: Scalars["DateTime"];
2681
+ /** Length of time required to successfully calculate a route, in milliseconds. */
2682
+ computation_time?: Maybe<Scalars["Int"]>;
2683
+ };
2684
+
2685
+ export type MatchedRouteOperatorPreferences = {
2686
+ /** Ranking of an operator with multiple levels, each level having its own penalty value. */
2687
+ ranking?: Maybe<RouteOperatorPreferencesRanking>;
2688
+ /** Operators that should be excluded for a route calculation. */
2689
+ exclude?: Maybe<Array<RouteOperatorsValue>>;
2690
+ /** Operators that should be avoided, but not excluded, for a route calculation. */
2691
+ avoid?: Maybe<Array<RouteOperatorsValue>>;
2692
+ };
2693
+
2694
+ /** Prioritized operators for a route calculation. */
2695
+ export type MatchedRouteOperatorPreferencesInput = {
2696
+ /** Operators to be preferred in route calculation. If not specified, no operator ranking is applied (including project-configured ranking). */
2697
+ ranking?: Maybe<MatchedRouteOperatorPreferencesRankingInput>;
2698
+ /** Operators to be excluded from route calculation. If specified, overrides project-configured operator exclusions. If not specified, applies project-configured operator exclusions. */
2699
+ exclude?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2700
+ /** Operators that should be avoided, but not excluded, for a route calculation. */
2701
+ avoid?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2702
+ };
2703
+
2704
+ export type MatchedRouteOperatorPreferencesRankingInput = {
2705
+ /** Flag indicating if an operator should be preferred or required. */
2706
+ type: RouteOperatorsType;
2707
+ /** Ranking levels for operator ranking. */
2708
+ levels?: Maybe<MatchedRouteOperatorPreferencesRankingLevelsInput>;
2709
+ };
2710
+
2711
+ export type MatchedRouteOperatorPreferencesRankingLevelsInput = {
2712
+ /** Least significant level for operator ranking. */
2713
+ low?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2714
+ /** Medium level for operator ranking. */
2715
+ medium?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2716
+ /** Most significant level for operator ranking. */
2717
+ high?: Maybe<Array<MatchedRouteOperatorsValueInput>>;
2718
+ };
2719
+
2720
+ export type MatchedRouteOperatorsValueInput = {
2721
+ /** ID of an operator. */
2722
+ id: Scalars["ID"];
2723
+ /** List of countries in which the operator should be preferred/excluded/avoided. When omitted the operator will be preferred/excluded in every country. */
2724
+ countries?: Maybe<Array<CountryCodeAlpha2>>;
2725
+ };
2726
+
2727
+ export type MatchedRoutePoint = {
2728
+ /** Coordinates [longitude, latitude]. */
2729
+ coordinates: Array<Scalars["Float"]>;
2730
+ };
2731
+
2732
+ export type MatchedRoutePointInput = {
2733
+ /** Chronological sequence of coordinates [longitude, latitude]. Minimum 2. */
2734
+ coordinates: Array<Scalars["Float"]>;
2735
+ };
2736
+
2737
+ export type MatchedRoutePropertiesVehicle = {
2738
+ /** Occupant configuration from this point. Null when this via only overrides total_cargo_weight. */
2739
+ occupants?: Maybe<MatchedRouteVehicleOccupants>;
2740
+ /** Weight of the cargo from this point. Null when this via only overrides occupants. */
2741
+ total_cargo_weight?: Maybe<TotalCargoWeight>;
2742
+ };
2743
+
2744
+ export type MatchedRoutePropertiesVehicleInput = {
2745
+ /** Occupant configuration from this point. */
2746
+ occupants?: Maybe<MatchedRouteVehicleOccupantsInput>;
2747
+ /** Weight of the cargo from this point. */
2748
+ total_cargo_weight?: Maybe<TotalCargoWeightInput>;
2749
+ };
2750
+
2751
+ export type MatchedRoutePropertiesViaLocation = {
2752
+ /** Name that should overwrite the name that is automatically assigned to this location (for example: address). */
2753
+ name?: Maybe<Scalars["String"]>;
2754
+ /** Duration to stay at this point, in seconds. */
2755
+ stop_duration?: Maybe<Scalars["Int"]>;
2756
+ };
2757
+
2758
+ export type MatchedRoutePropertiesViaLocationInput = {
2759
+ /** Name that should overwrite the name that is automatically assigned to this location (for example: address). */
2760
+ name?: Maybe<Scalars["String"]>;
2761
+ /** Duration to stay at this point, in seconds. */
2762
+ stop_duration?: Maybe<Scalars["Int"]>;
2763
+ };
2764
+
2765
+ export type MatchedRouteResponse = {
2766
+ /** ID of a route calculation. */
2767
+ id: Scalars["ID"];
2768
+ /** Status of a route. */
2769
+ status: RouteStatus;
2770
+ /** Recommended route. */
2771
+ route_details?: Maybe<MatchedRouteDetails>;
2772
+ /** Meta data for a route. */
2773
+ meta: MatchedRouteMetadata;
2774
+ /** Route request. */
2775
+ request_input: CreateMatchedRoute;
2776
+ };
2777
+
2778
+ export type MatchedRouteVehicle = {
2779
+ /** ID of the vehicle. */
2780
+ id: Scalars["ID"];
2781
+ /** EV battery specific configuration. */
2782
+ battery: RouteVehicleBattery;
2783
+ /** Charging configuration. */
2784
+ charging: MatchedRouteVehicleCharging;
2785
+ /** Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right. */
2786
+ tire_pressure: TirePressure;
2787
+ /** Value of the vehicle's odometer. */
2788
+ odometer?: Maybe<Odometer>;
2789
+ /** Value of the auxiliary power consumption of the vehicle. */
2790
+ auxiliary_consumption: AuxiliaryConsumption;
2791
+ /** Flag indicating if climate control is on. */
2792
+ climate: Scalars["Boolean"];
2793
+ /** Vehicle Heat Pump configuration. */
2794
+ heat_pump: HeatPumpMode;
2795
+ /** Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true. */
2796
+ cabin: RouteVehicleCabin;
2797
+ /** Initial occupant settings. This value can be overridden along the journey through 'via.properties.vehicle.occupants' field. */
2798
+ occupants: MatchedRouteVehicleOccupants;
2799
+ /** Initial cargo. This value can be overridden along the journey through 'via.properties.vehicle.total_cargo_weight' field. */
2800
+ total_cargo_weight: TotalCargoWeight;
2801
+ };
2802
+
2803
+ /** EV battery specific configuration for a create route mutation. */
2804
+ export type MatchedRouteVehicleBatteryInput = {
2805
+ /** 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‘. */
2806
+ capacity?: Maybe<StateOfChargeInput>;
2807
+ /** 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‘. */
2808
+ state_of_charge?: Maybe<StateOfChargeInput>;
2809
+ /** 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. */
2810
+ final_state_of_charge?: Maybe<StateOfChargeInput>;
2811
+ };
2812
+
2813
+ export type MatchedRouteVehicleCharging = {
2814
+ /** Mode that indicates if the charging time is optimized or if always charged to the maximum capacity. */
2815
+ mode: ChargeMode;
2816
+ /** Minimum desired power of chargers, in kWh. */
2817
+ minimum_power: Scalars["Float"];
2818
+ /** 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. */
2819
+ risk_margin: Scalars["Int"];
2820
+ /** Supported connectors. If not specified, it defaults to the vehicle's connectors. */
2821
+ connectors: Array<RouteVehicleChargingConnector>;
2822
+ /** Supported adapters. If not specified, adapters will not be considered. */
2823
+ adapters: Array<RouteVehicleChargingConnector>;
2824
+ };
2825
+
2826
+ export type MatchedRouteVehicleChargingConnector = {
2827
+ /** Type of the plug. */
2828
+ standard: ConnectorType;
2829
+ /** Maximum charging speed for this plug. */
2830
+ maximum_charge_speed: ChargeSpeed;
2831
+ };
2832
+
2833
+ export type MatchedRouteVehicleChargingConnectorInput = {
2834
+ /** Plug type. */
2835
+ standard: ConnectorType;
2836
+ /** Maximum charging speed for this plug. */
2837
+ maximum_charge_speed: ChargeSpeedInput;
2838
+ };
2839
+
2840
+ export type MatchedRouteVehicleChargingInput = {
2841
+ /** Mode that indicates if the charging time is optimized or if always charged to the maximum capacity. */
2842
+ mode?: Maybe<ChargeMode>;
2843
+ /** Minimum desired power of chargers, in kW. */
2844
+ minimum_power?: Maybe<Scalars["Float"]>;
2845
+ /** 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. */
2846
+ risk_margin?: Maybe<Scalars["Int"]>;
2847
+ /** Supported connectors. If not specified, it defaults to the vehicle's connectors. */
2848
+ connectors?: Maybe<Array<MatchedRouteVehicleChargingConnectorInput>>;
2849
+ /** Supported adapters. If not specified, adapters will not be considered. */
2850
+ adapters?: Maybe<Array<MatchedRouteVehicleChargingConnectorInput>>;
2851
+ };
2852
+
2853
+ /** Vehicle specific input for a create route mutation. */
2854
+ export type MatchedRouteVehicleInput = {
2855
+ /** ID of the vehicle. */
2856
+ id: Scalars["ID"];
2857
+ /** EV battery specific configuration. */
2858
+ battery?: Maybe<MatchedRouteVehicleBatteryInput>;
2859
+ /** Charging configuration. */
2860
+ charging?: Maybe<MatchedRouteVehicleChargingInput>;
2861
+ /** Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right. */
2862
+ tire_pressure?: Maybe<TirePressureInput>;
2863
+ /** Average auxiliary power consumption. */
2864
+ auxiliary_consumption?: Maybe<AuxiliaryConsumptionInput>;
2865
+ /** Flag indicating if climate control is on. */
2866
+ climate?: Maybe<Scalars["Boolean"]>;
2867
+ /** Vehicle Heat Pump configuration. */
2868
+ heat_pump?: Maybe<HeatPumpMode>;
2869
+ /** Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true. */
2870
+ cabin?: Maybe<RouteVehicleCabinInput>;
2871
+ /** Initial occupant settings. This value can be overridden along the journey through 'via.properties.vehicle.occupants' field. */
2872
+ occupants?: Maybe<MatchedRouteVehicleOccupantsInput>;
2873
+ /** "Initial cargo. This value can be overridden along the journey through 'via.properties.vehicle.total_cargo_weight' field." */
2874
+ total_cargo_weight?: Maybe<TotalCargoWeightInput>;
2875
+ };
2876
+
2877
+ export type MatchedRouteVehicleOccupants = {
2878
+ /** Number of occupants present in the vehicle. */
2879
+ occupants: Scalars["Int"];
2880
+ /** Combined weight of the occupants. This can only be used in combination with occupants. */
2881
+ total_occupant_weight?: Maybe<TotalOccupantWeight>;
2882
+ };
2883
+
2884
+ export type MatchedRouteVehicleOccupantsInput = {
2885
+ /** Number of occupants present in the vehicle. */
2886
+ count: Scalars["Int"];
2887
+ /** Combined weight of the occupants. */
2888
+ total_weight?: Maybe<TotalOccupantWeightInput>;
2889
+ };
2890
+
2891
+ export type MatchedRouteVia = {
2892
+ /** Index of the corresponding coordinate in the points array. */
2893
+ index: Scalars["Int"];
2894
+ /** Via properties. */
2895
+ properties?: Maybe<MatchedRouteViaProperties>;
2896
+ };
2897
+
2898
+ export type MatchedRouteViaInput = {
2899
+ /** Index of the corresponding coordinate in the points array. */
2900
+ index: Scalars["Int"];
2901
+ /** Additional details of the via. */
2902
+ properties?: Maybe<MatchedRouteViaPropertiesInput>;
2903
+ };
2904
+
2905
+ export type MatchedRouteViaProperties = {
2906
+ /** Location data of the via point. */
2907
+ location?: Maybe<MatchedRoutePropertiesViaLocation>;
2908
+ /** Vehicle data of the via point. */
2909
+ vehicle?: Maybe<MatchedRoutePropertiesVehicle>;
2910
+ };
2911
+
2912
+ export type MatchedRouteViaPropertiesInput = {
2913
+ /** Location data of the via point. */
2914
+ location?: Maybe<MatchedRoutePropertiesViaLocationInput>;
2915
+ /** 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. */
2916
+ vehicle?: Maybe<MatchedRoutePropertiesVehicleInput>;
2917
+ };
2918
+
2919
+ export type MatchedRouteWeather = {
2920
+ /** Weather configuration applied to the route. */
2921
+ type: WeatherType;
2922
+ /** [BETA] Custom weather conditions applied to the route. Only present when 'type' is set to 'CUSTOM'. */
2923
+ custom?: Maybe<RouteWeatherCustomConditions>;
2924
+ };
2925
+
2267
2926
  export type MaximumSpeed = {
2268
2927
  /** Numeric value of the user-defined maximum speed. */
2269
2928
  value: Scalars["Int"];
@@ -2343,6 +3002,8 @@ export type Mutation = {
2343
3002
  createRoute: Scalars["ID"];
2344
3003
  /** [ALPHA] Create a new truck route from the route input and its ID. */
2345
3004
  createTruckRoute: Scalars["ID"];
3005
+ /** [ALPHA] Creates route from a sequence of points. */
3006
+ createMatchedRoute?: Maybe<Scalars["ID"]>;
2346
3007
  };
2347
3008
 
2348
3009
  export type MutationcreateConnectedVehicleArgs = {
@@ -2405,6 +3066,10 @@ export type MutationcreateTruckRouteArgs = {
2405
3066
  input: CreateTruckRouteInput;
2406
3067
  };
2407
3068
 
3069
+ export type MutationcreateMatchedRouteArgs = {
3070
+ input: CreateMatchedRouteInput;
3071
+ };
3072
+
2408
3073
  /** Navigation session data. */
2409
3074
  export type Navigation = {
2410
3075
  /** ID of the navigation session. */
@@ -3761,6 +4426,8 @@ export type Query = {
3761
4426
  getRouteStationsWithAmenities: RouteStationsWithAmenitiesConnection;
3762
4427
  /** [ALPHA] Get a e-truck route by ID. */
3763
4428
  getTruckRoute: TruckRouteResponse;
4429
+ /** [ALPHA] Get a route by request ID. */
4430
+ getMatchedRoute?: Maybe<MatchedRouteResponse>;
3764
4431
  /** Get information about a station by its ID. */
3765
4432
  station?: Maybe<Station>;
3766
4433
  /** Get a full list of stations. */
@@ -3873,6 +4540,10 @@ export type QuerygetTruckRouteArgs = {
3873
4540
  id: Scalars["ID"];
3874
4541
  };
3875
4542
 
4543
+ export type QuerygetMatchedRouteArgs = {
4544
+ id: Scalars["ID"];
4545
+ };
4546
+
3876
4547
  export type QuerystationArgs = {
3877
4548
  id?: Maybe<Scalars["ID"]>;
3878
4549
  evse_id?: Maybe<Scalars["String"]>;
@@ -6433,7 +7104,7 @@ export type RouteVehicleBattery = {
6433
7104
  current?: Maybe<Scalars["Float"]>;
6434
7105
  /** Battery voltage in volts. */
6435
7106
  voltage?: Maybe<Scalars["Float"]>;
6436
- /** Value of the positive or negative power, in kWh. When negative, the vehicle is charging. */
7107
+ /** Value of the positive or negative power, in kW. When negative, the vehicle is charging. */
6437
7108
  power?: Maybe<Scalars["Float"]>;
6438
7109
  /** Flag indicating if the vehicle is charging. */
6439
7110
  is_charging?: Maybe<Scalars["Boolean"]>;
@@ -6453,7 +7124,7 @@ export type RouteVehicleBatteryInput = {
6453
7124
  current?: Maybe<Scalars["Float"]>;
6454
7125
  /** Battery voltage in volts. */
6455
7126
  voltage?: Maybe<Scalars["Float"]>;
6456
- /** Value of the positive or negative power, in kWh. When negative, the vehicle is charging. */
7127
+ /** Value of the positive or negative power, in kW. When negative, the vehicle is charging. */
6457
7128
  power?: Maybe<Scalars["Float"]>;
6458
7129
  /** Flag indicating if the vehicle is charging. */
6459
7130
  is_charging?: Maybe<Scalars["Boolean"]>;
@@ -6476,7 +7147,7 @@ export type RouteVehicleCabinInput = {
6476
7147
  export type RouteVehicleCharging = {
6477
7148
  /** Mode that indicates if the charging time is optimized or if always charged to the maximum state of charge. */
6478
7149
  mode: ChargeMode;
6479
- /** Minimum desired power of chargers, in kWh. */
7150
+ /** Minimum desired power of chargers, in kW. */
6480
7151
  minimum_power: Scalars["Float"];
6481
7152
  /** 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. */
6482
7153
  risk_margin: Scalars["Int"];
@@ -7174,6 +7845,8 @@ export type Subscription = {
7174
7845
  * @deprecated In favor of `route`.
7175
7846
  */
7176
7847
  routeUpdatedById?: Maybe<Route>;
7848
+ /** [ALPHA] Subscribe to a route by request ID. */
7849
+ matchedRoute?: Maybe<MatchedRouteResponse>;
7177
7850
  /** Subscribe to a specific route to receive system event updates. */
7178
7851
  route: RouteResponse;
7179
7852
  /** [ALPHA] Subscribe to e-truck route to receive system event updates. */
@@ -7190,6 +7863,10 @@ export type SubscriptionrouteUpdatedByIdArgs = {
7190
7863
  id: Scalars["ID"];
7191
7864
  };
7192
7865
 
7866
+ export type SubscriptionmatchedRouteArgs = {
7867
+ id: Scalars["ID"];
7868
+ };
7869
+
7193
7870
  export type SubscriptionrouteArgs = {
7194
7871
  id: Scalars["ID"];
7195
7872
  };
@@ -7858,18 +8535,18 @@ export type VehicleBodyWeightmaximalArgs = {
7858
8535
  export type VehicleConnector = {
7859
8536
  /** Connector type, known as connector standard in OCPI. */
7860
8537
  standard: ConnectorType;
7861
- /** Usable electric power. */
8538
+ /** 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`. */
7862
8539
  power: Scalars["Float"];
7863
- /** Maximum electric power. */
8540
+ /** Peak charging power. For slow charging connectors, value is identical to `power`. */
7864
8541
  max_electric_power: Scalars["Float"];
7865
- /** Time it takes to charge from 10 to 80% with a fast charger, shown in minutes. */
8542
+ /** 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%. */
7866
8543
  time: Scalars["Int"];
7867
8544
  /**
7868
8545
  * Charging speed.
7869
8546
  * @deprecated In favor of `charge_speed`.
7870
8547
  */
7871
8548
  speed: Scalars["Float"];
7872
- /** Charging speed. */
8549
+ /** 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%. */
7873
8550
  charge_speed: Scalars["Float"];
7874
8551
  };
7875
8552
 
@@ -8899,9 +9576,9 @@ export type VehiclePremiumPrice = {
8899
9576
  };
8900
9577
 
8901
9578
  export type VehiclePremiumPriceValueWithGrant = {
8902
- /** Starting price for local market expressed in the currency in the field currency. */
9579
+ /** 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. */
8903
9580
  value?: Maybe<Scalars["Float"]>;
8904
- /** Currency in which the value without optional field conversion is expressed. */
9581
+ /** 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). */
8905
9582
  currency?: Maybe<CurrencyUnit>;
8906
9583
  /** Indicates if the starting price is based on an estimate. */
8907
9584
  is_estimated?: Maybe<Scalars["Boolean"]>;