@chargetrip/types 1.46.1 → 1.46.2

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.
@@ -103,7 +103,7 @@ export declare enum AdhocAuthorisationMethod {
103
103
  export declare type AlternativeStationRadius = {
104
104
  /** Value of the alternative station radius. */
105
105
  value: Scalars["Float"];
106
- /** Type of the alternative station radius. */
106
+ /** Preferred unit for the alternative station radius. */
107
107
  type: DistanceUnit;
108
108
  /** Source of inputted data. */
109
109
  source: TelemetryInputSource;
@@ -111,7 +111,7 @@ export declare type AlternativeStationRadius = {
111
111
  export declare type AlternativeStationRadiusInput = {
112
112
  /** Value of the alternative station radius. */
113
113
  value: Scalars["Float"];
114
- /** Type of the alternative station radius. */
114
+ /** Preferred unit for the alternative station radius. */
115
115
  type: DistanceUnit;
116
116
  /** Source of inputted data. */
117
117
  source?: Maybe<TelemetryInputSource>;
@@ -185,17 +185,17 @@ export declare type AuthorizeConnectedVehicleOptions = {
185
185
  code?: Maybe<Scalars["PlainString"]>;
186
186
  };
187
187
  export declare type AuxiliaryConsumption = {
188
- /** Value of the auxiliary power consumption of the vehicle. */
188
+ /** Value of the vehicle's auxiliary power consumption. */
189
189
  value: Scalars["Float"];
190
- /** Type of auxiliary power consumption of the vehicle. */
190
+ /** Preferred unit for the vehicle's auxiliary power consumption. */
191
191
  type: AuxiliaryConsumptionUnit;
192
192
  /** Source of inputted data. */
193
193
  source: TelemetryInputSource;
194
194
  };
195
195
  export declare type AuxiliaryConsumptionInput = {
196
- /** Value of the auxiliary power consumption of the vehicle. */
196
+ /** Value of the vehicle's auxiliary power consumption. */
197
197
  value: Scalars["Float"];
198
- /** Type of auxiliary power consumption of the vehicle. */
198
+ /** Preferred unit for the vehicle's auxiliary power consumption. */
199
199
  type: AuxiliaryConsumptionUnit;
200
200
  /** Source of inputted data, defaults to 'manual'. */
201
201
  source?: Maybe<TelemetryInputSource>;
@@ -215,7 +215,7 @@ export declare enum BatteryInputType {
215
215
  export declare type BatteryTemperatureInput = {
216
216
  /** Value of the temperature of the battery. */
217
217
  value: Scalars["Float"];
218
- /** Type of temperature of the battery. */
218
+ /** Preferred unit for the temperature of the battery. */
219
219
  type: TemperatureUnit;
220
220
  /** Source of inputted data, defaults to 'manual'. */
221
221
  source?: Maybe<TelemetryInputSource>;
@@ -247,15 +247,15 @@ export declare enum ChargeMode {
247
247
  export declare type ChargeSpeed = {
248
248
  /** Value of the charge speed of the battery. */
249
249
  value: Scalars["Float"];
250
- /** Type of the charge speed of the battery. */
250
+ /** Preferred unit for the battery's charge speed. */
251
251
  type: ChargeSpeedUnit;
252
252
  /** Source of inputted data */
253
253
  source: TelemetryInputSource;
254
254
  };
255
255
  export declare type ChargeSpeedInput = {
256
- /** Value of the charge speed of the battery. */
256
+ /** Value of the battery's charge speed. */
257
257
  value: Scalars["Float"];
258
- /** Type of the charge speed of the battery. */
258
+ /** Preferred unit for the battery's charge speed. */
259
259
  type: ChargeSpeedUnit;
260
260
  /** Source of inputted data, defaults to 'manual'. */
261
261
  source?: Maybe<TelemetryInputSource>;
@@ -272,7 +272,7 @@ export declare enum ChargeSpeedUnit {
272
272
  export declare type ChargeTotalInput = {
273
273
  /** Value of the temperature of the battery. */
274
274
  value: Scalars["Float"];
275
- /** Type of total charge amount. */
275
+ /** Preferred unit for the total charge amount. */
276
276
  type: StateOfChargeUnit;
277
277
  /** Source of inputted data, defaults to 'manual'. */
278
278
  source?: Maybe<TelemetryInputSource>;
@@ -571,7 +571,7 @@ export declare enum ConnectorPriceElementComponentType {
571
571
  FLAT = "flat",
572
572
  /** Parking price per hour. This fee is applicable even if the parked car is not charging. */
573
573
  PARKING_TIME = "parking_time",
574
- /** Fixed price per hour. */
574
+ /** Fixed price per unit of time defined in the step size. */
575
575
  TIME = "time"
576
576
  }
577
577
  export declare type ConnectorPriceElementRestrictions = {
@@ -1092,8 +1092,8 @@ export declare type CreateRoute = {
1092
1092
  season: RouteSeason;
1093
1093
  /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
1094
1094
  alternative_station_radius?: Maybe<AlternativeStationRadius>;
1095
- /** Departure time of a route. */
1096
- departure_time?: Maybe<Scalars["DateTime"]>;
1095
+ /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
1096
+ departure_time: Scalars["DateTime"];
1097
1097
  };
1098
1098
  /** Input for the create route mutation. */
1099
1099
  export declare type CreateRouteInput = {
@@ -1111,7 +1111,7 @@ export declare type CreateRouteInput = {
1111
1111
  season?: Maybe<RouteSeason>;
1112
1112
  /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
1113
1113
  alternative_station_radius?: Maybe<AlternativeStationRadiusInput>;
1114
- /** Route departure time. */
1114
+ /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
1115
1115
  departure_time?: Maybe<Scalars["DateTime"]>;
1116
1116
  };
1117
1117
  /** Currency in the ISO 4217 format. */
@@ -1517,7 +1517,7 @@ export declare type ElectricityGenerationMethodintensityArgs = {
1517
1517
  export declare type ElevationInput = {
1518
1518
  /** Value of the elevation. */
1519
1519
  value: Scalars["Float"];
1520
- /** Type of the value of elevation. */
1520
+ /** Preferred unit for the elevation. */
1521
1521
  type: DistanceUnit;
1522
1522
  /** Source of inputted data, defaults to 'manual'. */
1523
1523
  source?: Maybe<TelemetryInputSource>;
@@ -1708,7 +1708,9 @@ export declare enum HeavyVehiclesEUType {
1708
1708
  /** Only N2 type of heavy vehicles can be parked at the charging station. N2 vehicles have a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes (26,000 lbs). */
1709
1709
  N2 = "N2",
1710
1710
  /** Only N3 type of heavy vehicles can be parked at the charging station. N3 vehicles have a maximum mass exceeding 12 tonnes (26,000 lbs). */
1711
- N3 = "N3"
1711
+ N3 = "N3",
1712
+ /** N3 type of heavy vehicles having O4 type of trailers can be parked at the charging station. N3 vehicles have a maximum mass exceeding 12 tonnes (26,000 lbs) and O4 trailers have a maximum mass exceeding 10 tonnes (22000 lbs). */
1713
+ N3_O4 = "N3_O4"
1712
1714
  }
1713
1715
  /** List of facilities in the location. */
1714
1716
  export declare enum HeavyVehiclesFacility {
@@ -1943,9 +1945,9 @@ export declare type Mutation = {
1943
1945
  * This is a premium feature, contact Chargetrip for more information.
1944
1946
  */
1945
1947
  deleteUserReview: Review;
1946
- /** [BETA] Create a new route from the route input and its ID. */
1948
+ /** Create a new route from the route input and its ID. */
1947
1949
  createRoute: Scalars["ID"];
1948
- /** Create a new route from the route input and its ID */
1950
+ /** Deprecated: In favor of createRoute. */
1949
1951
  newRoute?: Maybe<Scalars["ID"]>;
1950
1952
  };
1951
1953
  export declare type MutationcreateConnectedVehicleArgs = {
@@ -2675,7 +2677,7 @@ export declare enum OICPValueAddedServices {
2675
2677
  export declare type Odometer = {
2676
2678
  /** Value of the vehicle's odometer. */
2677
2679
  value: Scalars["Float"];
2678
- /** Type of the value of the vehicle's odometer. */
2680
+ /** Preferred unit for the vehicle's odometer. */
2679
2681
  type: DistanceUnit;
2680
2682
  /** Source of inputted data. */
2681
2683
  source: TelemetryInputSource;
@@ -2683,7 +2685,7 @@ export declare type Odometer = {
2683
2685
  export declare type OdometerInput = {
2684
2686
  /** Value of the vehicle's odometer. */
2685
2687
  value: Scalars["Float"];
2686
- /** Type of the value of the vehicle's odometer. */
2688
+ /** Preferred unit for the vehicle's odometer. */
2687
2689
  type: DistanceUnit;
2688
2690
  /** Source of inputted data, defaults to 'manual'. */
2689
2691
  source?: Maybe<TelemetryInputSource>;
@@ -2709,19 +2711,29 @@ export declare type Operator = {
2709
2711
  countries?: Maybe<Array<CountryCodeAlpha2>>;
2710
2712
  /** Contact information. */
2711
2713
  contact?: Maybe<Contact>;
2712
- /** Ranking level on which the operator is placed or null in case the operator is not on any ranking level. */
2714
+ /**
2715
+ * Ranking level on which the operator is placed or null in case the operator is not on any ranking level. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.
2716
+ * @deprecated In favor of ranking_levels.
2717
+ */
2713
2718
  ranking?: Maybe<Scalars["Int"]>;
2714
- /** Flag which indicates if the operator is in the excluded list. */
2719
+ /**
2720
+ * Flag which indicates if the operator is in the excluded list. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.
2721
+ * @deprecated In favor of excluded_countries.
2722
+ */
2715
2723
  excluded?: Maybe<Scalars["Boolean"]>;
2724
+ /** Ranking configuration for the operator. An operator can be ranked on different levels in different countries. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request. */
2725
+ ranking_levels?: Maybe<OperatorRankingLevels>;
2726
+ /** List of countries where the operator is excluded. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request. */
2727
+ excluded_countries?: Maybe<Array<CountryCodeAlpha2>>;
2716
2728
  };
2717
2729
  /** Filter which can be applied to retrieve the operator list action. */
2718
2730
  export declare type OperatorListFilter = {
2719
2731
  /** ISO-3166 alpha-2 country codes an operator is active in. */
2720
2732
  countries?: Maybe<Array<CountryCodeAlpha2>>;
2721
- /** List of ranking level(s) to be retrieved. Valid values are 1 to 10. */
2722
- ranking?: Maybe<Array<Scalars["Int"]>>;
2723
- /** Only retrieve operators that are in the excluded list. */
2724
- excluded?: Maybe<Scalars["Boolean"]>;
2733
+ /** List of ranking level(s) to be retrieved. An operator can be ranked on different levels in different countries. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request. */
2734
+ ranking_levels?: Maybe<OperatorRankingLevelsFilter>;
2735
+ /** List of countries where the operator is excluded. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request. */
2736
+ excluded_countries?: Maybe<Array<CountryCodeAlpha2>>;
2725
2737
  };
2726
2738
  /** Filter which can be applied to retrieve the operator list action. */
2727
2739
  export declare type OperatorListQuery = {
@@ -2740,10 +2752,28 @@ export declare enum OperatorRankingLevel {
2740
2752
  MEDIUM = "medium",
2741
2753
  HIGH = "high"
2742
2754
  }
2755
+ /** Ranking configuration for the operator. An operator can be ranked on different levels in different countries. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request. */
2756
+ export declare type OperatorRankingLevels = {
2757
+ /** Low level for operators ranking. */
2758
+ low?: Maybe<Array<CountryCodeAlpha2>>;
2759
+ /** Medium level for operators ranking. */
2760
+ medium?: Maybe<Array<CountryCodeAlpha2>>;
2761
+ /** High level for operators ranking. */
2762
+ high?: Maybe<Array<CountryCodeAlpha2>>;
2763
+ };
2764
+ /** Filter operators by ranking levels. */
2765
+ export declare type OperatorRankingLevelsFilter = {
2766
+ /** Low level for operators ranking. */
2767
+ low?: Maybe<Array<CountryCodeAlpha2>>;
2768
+ /** Medium level for operators ranking. */
2769
+ medium?: Maybe<Array<CountryCodeAlpha2>>;
2770
+ /** High level for operators ranking. */
2771
+ high?: Maybe<Array<CountryCodeAlpha2>>;
2772
+ };
2743
2773
  export declare type OutsideTempInput = {
2744
2774
  /** Value of the outside temperature. */
2745
2775
  value: Scalars["Float"];
2746
- /** Type of the value of the outside temperature. */
2776
+ /** Preferred unit for the outside temperature. */
2747
2777
  type: TemperatureUnit;
2748
2778
  /** Source of inputted data, defaults to 'manual'. */
2749
2779
  source?: Maybe<TelemetryInputSource>;
@@ -2751,7 +2781,7 @@ export declare type OutsideTempInput = {
2751
2781
  export declare type OutsideTemperature = {
2752
2782
  /** Value of the temperature. */
2753
2783
  value: Scalars["Float"];
2754
- /** Type of the temperature. */
2784
+ /** Preferred unit for the outside temperature. */
2755
2785
  type: TemperatureUnit;
2756
2786
  /** Source of inputted data. */
2757
2787
  source: TelemetryInputSource;
@@ -2759,7 +2789,7 @@ export declare type OutsideTemperature = {
2759
2789
  export declare type OutsideTemperatureInput = {
2760
2790
  /** Value of the outside temperature. */
2761
2791
  value: Scalars["Float"];
2762
- /** Type of the value of the outside temperature. */
2792
+ /** Preferred unit for the outside temperature. */
2763
2793
  type: TemperatureUnit;
2764
2794
  /** Source of inputted data. */
2765
2795
  source?: Maybe<TelemetryInputSource>;
@@ -2817,7 +2847,7 @@ export declare enum PolylineInputDecimals {
2817
2847
  export declare type PowerInput = {
2818
2848
  /** Value of the positive or negative power. When negative the vehicle is charging. */
2819
2849
  value: Scalars["Float"];
2820
- /** Type of the value of the power. */
2850
+ /** Preferred unit for the power. */
2821
2851
  type: PowerUnit;
2822
2852
  /** Source of inputted data, defaults to 'manual'. */
2823
2853
  source?: Maybe<TelemetryInputSource>;
@@ -2912,15 +2942,15 @@ export declare type Query = {
2912
2942
  * This is a premium feature, contact Chargetrip for more information.
2913
2943
  */
2914
2944
  userReviewList?: Maybe<Array<Review>>;
2915
- /** Get a route by ID */
2945
+ /** Deprecated: In favor of getRoute. */
2916
2946
  route?: Maybe<Route>;
2917
- /** [BETA] Get a route by ID. */
2947
+ /** Get a route by ID. */
2918
2948
  getRoute: RouteResponse;
2919
- /** [BETA] Get emissions for a route. */
2949
+ /** Get emissions for a route. */
2920
2950
  getRouteEmissions: RouteDetailsEmissions;
2921
- /** Emissions profile for route. */
2951
+ /** Deprecated: In favor of getRouteEmissions. */
2922
2952
  routeEmissions: RouteEmissions;
2923
- /** Retrieve information about a route path segment */
2953
+ /** Deprecated: In favor of RouteDetails.path_plot. */
2924
2954
  routePath?: Maybe<RoutePath>;
2925
2955
  /** Get information about a station by its ID. */
2926
2956
  station?: Maybe<Station>;
@@ -3536,14 +3566,14 @@ export declare type RouteDetails = {
3536
3566
  distance: Scalars["Float"];
3537
3567
  /** Aggregation of all durations of a route. */
3538
3568
  durations: RouteDetailsDurations;
3539
- /** Total energy used for a route in kilowatt hours. */
3540
- consumption: Scalars["Float"];
3541
- /** Range available at the beginning of a trip. */
3542
- range_at_origin: Scalars["Float"];
3543
- /** Range available at the end of a trip. */
3544
- range_at_destination: Scalars["Float"];
3569
+ /** Total energy used for a route in kilowatt hours. For HEVs and PHEVs this field will return null. */
3570
+ consumption?: Maybe<Scalars["Float"]>;
3571
+ /** 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. */
3572
+ range_at_origin?: Maybe<Scalars["Float"]>;
3573
+ /** 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. */
3574
+ range_at_destination?: Maybe<Scalars["Float"]>;
3545
3575
  /** Polyline containing encoded coordinates. */
3546
- polyline?: Maybe<Scalars["String"]>;
3576
+ polyline: Scalars["String"];
3547
3577
  /** Path elevation, distance, duration, consumption and speed values, grouped into 100 segments. */
3548
3578
  path_plot: Array<RouteDetailsPathSegment>;
3549
3579
  /** Details about elevation on a route. */
@@ -3552,7 +3582,7 @@ export declare type RouteDetails = {
3552
3582
  savings?: Maybe<RouteDetailsSavings>;
3553
3583
  /** Legs of a route. */
3554
3584
  legs: Array<RouteDetailsLeg>;
3555
- /** Alternative stations along a route within specified radius. */
3585
+ /** Alternative stations along a route within a specified radius. Will only return stations if alternative_station_radius was specified in the createRoute mutation. */
3556
3586
  alternative_stations: Array<RouteDetailsAlternativeStation>;
3557
3587
  /** Aggregation of tags over the current RouteDetails. Tags are available on legs and further subdivided over individual sections and maneuvers. */
3558
3588
  tags: Array<RouteDetailsTag>;
@@ -3580,21 +3610,21 @@ export declare type RouteDetailsAlternativeStation = {
3580
3610
  speed: StationSpeedType;
3581
3611
  /** Status of a station. */
3582
3612
  status: ChargerStatus;
3583
- /** Ranking of an operator. */
3613
+ /** 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. */
3584
3614
  operator_ranking?: Maybe<OperatorRankingLevel>;
3585
3615
  };
3586
3616
  /** Aggregation of all durations of a route. */
3587
3617
  export declare type RouteDetailsDurations = {
3588
3618
  /** Total duration, in seconds. */
3589
3619
  total: Scalars["Int"];
3590
- /** Total duration charging, in seconds. */
3620
+ /** Total charging duration, in seconds. */
3591
3621
  charging: Scalars["Int"];
3592
- /** Total duration driving, in seconds. */
3622
+ /** Total driving duration, in seconds. */
3593
3623
  driving: Scalars["Int"];
3594
- /** Total duration stopped for a short stay, for example at a via point, in seconds. */
3624
+ /** Total stop duration, excluding charge stops, in seconds. */
3595
3625
  stopover: Scalars["Int"];
3596
- /** Total duration of ferry rides, in seconds. */
3597
- ferry?: Maybe<Scalars["Int"]>;
3626
+ /** Total ferry duration, in seconds. */
3627
+ ferry: Scalars["Int"];
3598
3628
  };
3599
3629
  export declare type RouteDetailsElevation = {
3600
3630
  /** Total value driving uphill on a route. */
@@ -3640,21 +3670,21 @@ export declare type RouteDetailsLeg = {
3640
3670
  distance: Scalars["Float"];
3641
3671
  /** Aggregation of all durations of a route leg. */
3642
3672
  durations: RouteDetailsDurations;
3643
- /** Total energy used in a leg in kilowatt hours. */
3644
- consumption: Scalars["Float"];
3673
+ /** Total energy used in a leg in kilowatt hours. For HEVs and PHEVs this field will return null. */
3674
+ consumption?: Maybe<Scalars["Float"]>;
3645
3675
  /** Origin point location. */
3646
3676
  origin: RouteDetailsLegFeaturePoint;
3647
3677
  /** Destination point location. */
3648
3678
  destination: RouteDetailsLegFeaturePoint;
3649
- /** Range at the origin of the leg. */
3650
- range_at_origin: Scalars["Float"];
3651
- /** Range at the destination of the leg. */
3652
- range_at_destination: Scalars["Float"];
3653
- /** Range after charging on the leg. */
3679
+ /** 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. */
3680
+ range_at_origin?: Maybe<Scalars["Float"]>;
3681
+ /** 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. */
3682
+ range_at_destination?: Maybe<Scalars["Float"]>;
3683
+ /** 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. */
3654
3684
  range_after_charge?: Maybe<Scalars["Float"]>;
3655
3685
  /** Type of a leg. */
3656
3686
  type: RouteDetailsLegType;
3657
- /** Information about the station at the origin of this leg. */
3687
+ /** Information about the station at the destination of a leg. */
3658
3688
  station?: Maybe<RouteDetailsLegStation>;
3659
3689
  /** Polyline containing encoded coordinates. */
3660
3690
  polyline: Scalars["String"];
@@ -3729,7 +3759,7 @@ export declare type RouteDetailsLegFeaturePropertiestotal_cargo_weightArgs = {
3729
3759
  export declare type RouteDetailsLegManeuverPoints = {
3730
3760
  /** Number of polyline points which are included in this instruction. */
3731
3761
  size: Scalars["Int"];
3732
- /** Interval of points that are included in this instruction, an array with 2 values, where the first value is the index of the polyline where the interval starts. The second value is where it ends. */
3762
+ /** Interval of points included in this instruction, represented as an array with two values: the first is the index of the polyline where the interval starts, and the second is where it ends. */
3733
3763
  interval: Array<Scalars["Int"]>;
3734
3764
  };
3735
3765
  /** Type of a maneuver indicating the main action. */
@@ -3767,13 +3797,13 @@ export declare type RouteDetailsLegSection = {
3767
3797
  /** Aggregation of tags over the current section. */
3768
3798
  tags: Array<RouteDetailsTag>;
3769
3799
  /** Polyline containing encoded coordinates. */
3770
- polyline?: Maybe<Scalars["String"]>;
3800
+ polyline: Scalars["String"];
3771
3801
  /** Distance from the start to the end of a section. */
3772
3802
  distance: Scalars["Float"];
3773
3803
  /** Total duration of a section, in seconds. The value will be 0 for walking sections. */
3774
3804
  duration: Scalars["Float"];
3775
3805
  /** Total energy used in a section in kilowatt-hours. The value will be 0 for walking sections. */
3776
- consumption: Scalars["Float"];
3806
+ consumption?: Maybe<Scalars["Float"]>;
3777
3807
  };
3778
3808
  export declare type RouteDetailsLegSectionpolylineArgs = {
3779
3809
  decimals?: Maybe<PolylineInputDecimals>;
@@ -3821,19 +3851,25 @@ export declare type RouteDetailsLegStation = {
3821
3851
  };
3822
3852
  /** Type of a leg. */
3823
3853
  export declare enum RouteDetailsLegType {
3854
+ /** This leg ends at a charging station and the vehicle must recharge. */
3824
3855
  STATION = "station",
3856
+ /** This leg ends at a via charging station and the vehicle must recharge. */
3825
3857
  STATION_VIA = "station_via",
3858
+ /** This leg ends at the destination which is a charging station, and is the last leg of the route. */
3826
3859
  STATION_FINAL = "station_final",
3860
+ /** This leg ends at a scheduled charging station and the vehicle must recharge. */
3827
3861
  STATION_AMENITY = "station_amenity",
3862
+ /** This leg ends at a via location. */
3828
3863
  VIA = "via",
3864
+ /** This leg ends at the destination, and is the last leg of the route. */
3829
3865
  FINAL = "final"
3830
3866
  }
3831
3867
  export declare type RouteDetailsManeuver = {
3832
3868
  /** Type of instruction. */
3833
3869
  type: RouteDetailsLegManeuverType;
3834
3870
  /** Location of the maneuver. */
3835
- location?: Maybe<RouteDetailsLegSectionFeaturePoint>;
3836
- /** Name of the street on which an instruction is. */
3871
+ location: RouteDetailsLegSectionFeaturePoint;
3872
+ /** Name of the street associated with the instruction. */
3837
3873
  name?: Maybe<Scalars["String"]>;
3838
3874
  /** Distance, in meters, of a route instruction. */
3839
3875
  distance: Scalars["Float"];
@@ -3846,7 +3882,7 @@ export declare type RouteDetailsManeuver = {
3846
3882
  /** Curvature angle between the roundabout and the exit of the roundabout. This field exists only on sign USE_ROUNDABOUT (6), otherwise this value is `null`. */
3847
3883
  turn_angle?: Maybe<Scalars["Float"]>;
3848
3884
  /** Aggregation of tags over the current maneuver. */
3849
- tags?: Maybe<Array<RouteDetailsTag>>;
3885
+ tags: Array<RouteDetailsTag>;
3850
3886
  };
3851
3887
  export declare type RouteDetailsManeuverdistanceArgs = {
3852
3888
  unit?: Maybe<DistanceUnit>;
@@ -3856,13 +3892,13 @@ export declare type RouteDetailsPathSegment = {
3856
3892
  elevation: Scalars["Float"];
3857
3893
  /** Average speed of a route path segment. */
3858
3894
  average_speed: Scalars["Float"];
3859
- /** Consumption, in kilowatt hours, of a route path segment. */
3860
- consumption: Scalars["Float"];
3895
+ /** Consumption, in kilowatt hours, of a route path segment. For HEVs and PHEVs this field will return null. */
3896
+ consumption?: Maybe<Scalars["Float"]>;
3861
3897
  /** Distance of a route path segment. */
3862
3898
  distance: Scalars["Float"];
3863
3899
  /** Duration, in seconds, of a route path segment. */
3864
3900
  duration: Scalars["Float"];
3865
- /** State of charge, in kilowatt hours, of a route path segment. */
3901
+ /** State of charge, in kilowatt hours, of a route path segment. For HEVs and PHEVs this field will return null. */
3866
3902
  state_of_charge?: Maybe<Scalars["Float"]>;
3867
3903
  /** Maximum vehicle speed of a route path segment. */
3868
3904
  maximum_speed: Scalars["Float"];
@@ -4585,14 +4621,14 @@ export declare type RouteOperationalMaintenanceEmissionsFielddisposalArgs = {
4585
4621
  export declare type RouteOperatorPreferences = {
4586
4622
  /** Ranking of an operator with multiple levels, each level having its own penalty value. */
4587
4623
  ranking?: Maybe<RouteOperatorPreferencesRanking>;
4588
- /** Route operators that should be excluded. */
4624
+ /** Operators that should be excluded for a route calculation. */
4589
4625
  exclude?: Maybe<Array<RouteOperatorsValue>>;
4590
4626
  };
4591
4627
  /** Prioritized operators for a route calculation. */
4592
4628
  export declare type RouteOperatorPreferencesInput = {
4593
4629
  /** Ranking of an operator with multiple levels, each level having its own penalty value. */
4594
4630
  ranking?: Maybe<RouteOperatorPreferencesRankingInput>;
4595
- /** Route operators that should be excluded. */
4631
+ /** Operators that should be excluded for a route calculation. */
4596
4632
  exclude?: Maybe<Array<RouteOperatorsValueInput>>;
4597
4633
  };
4598
4634
  export declare type RouteOperatorPreferencesRanking = {
@@ -4620,7 +4656,7 @@ export declare type RouteOperatorPreferencesRankingLevelsInput = {
4620
4656
  low?: Maybe<Array<RouteOperatorsValueInput>>;
4621
4657
  /** Medium level for operator ranking. */
4622
4658
  medium?: Maybe<Array<RouteOperatorsValueInput>>;
4623
- /** Most significant level three for operator ranking. */
4659
+ /** Most significant level for operator ranking. */
4624
4660
  high?: Maybe<Array<RouteOperatorsValueInput>>;
4625
4661
  };
4626
4662
  /** Prioritized operators for a route calculation. */
@@ -4782,9 +4818,9 @@ export declare type RoutePropertiesStationInput = {
4782
4818
  };
4783
4819
  export declare type RoutePropertiesVehicle = {
4784
4820
  /** Number of occupants present in the vehicle. */
4785
- occupants?: Maybe<Scalars["Int"]>;
4821
+ occupants: Scalars["Int"];
4786
4822
  /** Combined weight of the occupants. This can only be used in combination with occupants. */
4787
- total_occupant_weight?: Maybe<TotalOccupantWeight>;
4823
+ total_occupant_weight: TotalOccupantWeight;
4788
4824
  /** Weight of the cargo. */
4789
4825
  total_cargo_weight?: Maybe<TotalCargoWeight>;
4790
4826
  };
@@ -4899,26 +4935,26 @@ export declare type RouteVehicle = {
4899
4935
  /** ID of the vehicle. */
4900
4936
  id: Scalars["ID"];
4901
4937
  /** EV battery specific configuration. */
4902
- battery?: Maybe<RouteVehicleBattery>;
4938
+ battery: RouteVehicleBattery;
4903
4939
  /** Charging configuration. */
4904
- charging?: Maybe<RouteVehicleCharging>;
4905
- /** Average tire pressures of all wheels, starting from the front side (right to left) and then to the rear. */
4906
- tire_pressure?: Maybe<TirePressure>;
4940
+ charging: RouteVehicleCharging;
4941
+ /** Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right. */
4942
+ tire_pressure: TirePressure;
4907
4943
  /** Value of the vehicle's odometer. */
4908
4944
  odometer?: Maybe<Odometer>;
4909
4945
  /** Value of the auxiliary power consumption of the vehicle. */
4910
- auxiliary_consumption?: Maybe<AuxiliaryConsumption>;
4911
- /** Flag which indicates if climate control is on. */
4912
- climate?: Maybe<Scalars["Boolean"]>;
4946
+ auxiliary_consumption: AuxiliaryConsumption;
4947
+ /** Flag indicating if climate control is on. */
4948
+ climate: Scalars["Boolean"];
4913
4949
  /** Vehicle Heat Pump configuration. */
4914
4950
  heat_pump: HeatPumpMode;
4915
- /** Vehicle cabin configuration. */
4951
+ /** Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true. */
4916
4952
  cabin: RouteVehicleCabin;
4917
4953
  /** Revolutions per minute of the motor, a measure of the rotational speed of the motor's rotor component. */
4918
4954
  motor_rpm?: Maybe<Scalars["Int"]>;
4919
4955
  /** Value of the outside temperature. */
4920
4956
  outside_temperature?: Maybe<OutsideTemperature>;
4921
- /** Flag which indicates if vehicle is in park, neutral or turned off. */
4957
+ /** Flag indicating if a vehicle is in park, neutral, or turned off. */
4922
4958
  is_parked?: Maybe<Scalars["Boolean"]>;
4923
4959
  /** Value of the vehicle's speed. */
4924
4960
  vehicle_speed?: Maybe<VehicleSpeed>;
@@ -4926,11 +4962,11 @@ export declare type RouteVehicle = {
4926
4962
  heading?: Maybe<Scalars["Float"]>;
4927
4963
  };
4928
4964
  export declare type RouteVehicleBattery = {
4929
- /** Battery capacity. */
4965
+ /** 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. */
4930
4966
  capacity: StateOfCharge;
4931
- /** State of charge. */
4967
+ /** 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. */
4932
4968
  state_of_charge: StateOfCharge;
4933
- /** Minimum final battery state of charge. The value should be between 0 and 60% of the battery capacity. */
4969
+ /** Desired final amount of energy in a battery at the and 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. */
4934
4970
  final_state_of_charge: StateOfCharge;
4935
4971
  /** Temperature of the battery. */
4936
4972
  temperature?: Maybe<Temperature>;
@@ -4940,16 +4976,16 @@ export declare type RouteVehicleBattery = {
4940
4976
  voltage?: Maybe<Scalars["Float"]>;
4941
4977
  /** Value of the positive or negative power, in kWh. When negative, the vehicle is charging. */
4942
4978
  power?: Maybe<Scalars["Float"]>;
4943
- /** Flag which indicates if the vehicle is charging. */
4979
+ /** Flag indicating if the vehicle is charging. */
4944
4980
  is_charging?: Maybe<Scalars["Boolean"]>;
4945
4981
  };
4946
4982
  /** EV battery specific configuration for a create route mutation. */
4947
4983
  export declare type RouteVehicleBatteryInput = {
4948
- /** Battery capacity. */
4984
+ /** 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. */
4949
4985
  capacity?: Maybe<StateOfChargeInput>;
4950
- /** Battery state of charge. */
4986
+ /** 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. */
4951
4987
  state_of_charge?: Maybe<StateOfChargeInput>;
4952
- /** Minimum final battery state of charge. The value should be between 0 and 60% of the battery capacity. */
4988
+ /** Desired final amount of energy in a battery at the and 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. */
4953
4989
  final_state_of_charge?: Maybe<StateOfChargeInput>;
4954
4990
  /** Battery temperature. */
4955
4991
  temperature?: Maybe<TemperatureInput>;
@@ -4959,17 +4995,17 @@ export declare type RouteVehicleBatteryInput = {
4959
4995
  voltage?: Maybe<Scalars["Float"]>;
4960
4996
  /** Value of the positive or negative power, in kWh. When negative, the vehicle is charging. */
4961
4997
  power?: Maybe<Scalars["Float"]>;
4962
- /** Flag which indicates if the vehicle is charging. */
4998
+ /** Flag indicating if the vehicle is charging. */
4963
4999
  is_charging?: Maybe<Scalars["Boolean"]>;
4964
5000
  };
4965
5001
  export declare type RouteVehicleCabin = {
4966
- /** Flag which indicates if the vehicle cabin was preconditioned for the desired temperature. */
5002
+ /** Flag indicating if the vehicle cabin was preconditioned for the desired temperature. */
4967
5003
  is_preconditioned: Scalars["Boolean"];
4968
5004
  /** Desired cabin temperature. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
4969
5005
  desired_temperature: Temperature;
4970
5006
  };
4971
5007
  export declare type RouteVehicleCabinInput = {
4972
- /** Flag which indicates if the vehicle cabin was preconditioned for the desired temperature. */
5008
+ /** Flag indicating if the vehicle cabin was preconditioned for the desired temperature. */
4973
5009
  is_preconditioned?: Maybe<Scalars["Boolean"]>;
4974
5010
  /** Desired cabin temperature. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
4975
5011
  desired_temperature?: Maybe<TemperatureInput>;
@@ -4979,17 +5015,17 @@ export declare type RouteVehicleCharging = {
4979
5015
  mode: ChargeMode;
4980
5016
  /** Minimum desired power of chargers, in kWh. */
4981
5017
  minimum_power: Scalars["Float"];
4982
- /** Percentage for the minimum limit of the battery's capacity before a recharge. The value should be between 0 and 60. Defaults to 10. */
5018
+ /** 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. */
4983
5019
  risk_margin: Scalars["Int"];
4984
- /** Supported connectors. */
4985
- connectors?: Maybe<Array<RouteVehicleChargingConnector>>;
4986
- /** Supported adapters. */
4987
- adapters?: Maybe<Array<RouteVehicleChargingConnector>>;
5020
+ /** Supported connectors. If not specified, it defaults to the vehicle's connectors. */
5021
+ connectors: Array<RouteVehicleChargingConnector>;
5022
+ /** Supported adapters. If not specified, adapters will not be considered. */
5023
+ adapters: Array<RouteVehicleChargingConnector>;
4988
5024
  };
4989
5025
  export declare type RouteVehicleChargingConnector = {
4990
5026
  /** Type of the plug. */
4991
5027
  standard: ConnectorType;
4992
- /** Maximum charging speed for the plug. */
5028
+ /** Maximum charging speed for this plug. */
4993
5029
  maximum_charge_speed: ChargeSpeed;
4994
5030
  };
4995
5031
  export declare type RouteVehicleChargingConnectorInput = {
@@ -5003,11 +5039,11 @@ export declare type RouteVehicleChargingInput = {
5003
5039
  mode?: Maybe<ChargeMode>;
5004
5040
  /** Minimum desired power of chargers, in kWh. */
5005
5041
  minimum_power?: Maybe<Scalars["Float"]>;
5006
- /** Percentage representing the minimum value of the state of charge at a next charge stop. The value should be between 0 and 60. */
5042
+ /** 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. */
5007
5043
  risk_margin?: Maybe<Scalars["Int"]>;
5008
- /** Supported connectors. */
5044
+ /** Supported connectors. If not specified, it defaults to the vehicle's connectors. */
5009
5045
  connectors?: Maybe<Array<RouteVehicleChargingConnectorInput>>;
5010
- /** Supported adapters. */
5046
+ /** Supported adapters. If not specified, adapters will not be considered. */
5011
5047
  adapters?: Maybe<Array<RouteVehicleChargingConnectorInput>>;
5012
5048
  };
5013
5049
  export declare type RouteVehicleEmissions = {
@@ -5038,23 +5074,23 @@ export declare type RouteVehicleInput = {
5038
5074
  battery?: Maybe<RouteVehicleBatteryInput>;
5039
5075
  /** Charging configuration. */
5040
5076
  charging?: Maybe<RouteVehicleChargingInput>;
5041
- /** Average tire pressures of all wheels. */
5077
+ /** Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right. */
5042
5078
  tire_pressure?: Maybe<TirePressureInput>;
5043
5079
  /** Odometer (mileage) reading. */
5044
5080
  odometer?: Maybe<OdometerInput>;
5045
5081
  /** Average auxiliary power consumption. */
5046
5082
  auxiliary_consumption?: Maybe<AuxiliaryConsumptionInput>;
5047
- /** Flag which indicates if climate control is on. */
5083
+ /** Flag indicating if climate control is on. */
5048
5084
  climate?: Maybe<Scalars["Boolean"]>;
5049
5085
  /** Vehicle Heat Pump configuration. */
5050
5086
  heat_pump?: Maybe<HeatPumpMode>;
5051
- /** Vehicle cabin configuration for creating the route. */
5087
+ /** Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true. */
5052
5088
  cabin?: Maybe<RouteVehicleCabinInput>;
5053
5089
  /** Revolutions per minute of the motor, a measure of the rotational speed of the motor's rotor component. */
5054
5090
  motor_rpm?: Maybe<Scalars["Int"]>;
5055
5091
  /** Outside temperature. */
5056
5092
  outside_temperature?: Maybe<OutsideTemperatureInput>;
5057
- /** Flag which indicates if vehicle is in park, neutral or turned off. */
5093
+ /** Flag indicating if a vehicle is in park, neutral, or turned off. */
5058
5094
  is_parked?: Maybe<Scalars["Boolean"]>;
5059
5095
  /** Vehicle speed. */
5060
5096
  vehicle_speed?: Maybe<VehicleSpeedInput>;
@@ -5168,15 +5204,15 @@ export declare enum SpeedUnit {
5168
5204
  export declare type StateOfCharge = {
5169
5205
  /** Value of the state of charge of the vehicle. */
5170
5206
  value: Scalars["Float"];
5171
- /** Type of the state of charge of the vehicle. */
5207
+ /** Preferred unit for the vehicle's state of charge. */
5172
5208
  type: StateOfChargeUnit;
5173
5209
  /** Source of inputted data. */
5174
5210
  source: TelemetryInputSource;
5175
5211
  };
5176
5212
  export declare type StateOfChargeInput = {
5177
- /** Value of the state of charge of the vehicle. */
5213
+ /** Value of the vehicle's state of charge. */
5178
5214
  value: Scalars["Float"];
5179
- /** Type of the state of charge of the vehicle. */
5215
+ /** Preferred unit for the vehicle's state of charge. */
5180
5216
  type: StateOfChargeUnit;
5181
5217
  /** Source of inputted data, defaults to 'manual'. */
5182
5218
  source?: Maybe<TelemetryInputSource>;
@@ -5579,9 +5615,9 @@ export declare type Subscription = {
5579
5615
  isoline?: Maybe<Isoline>;
5580
5616
  /** [BETA] Subscribe to navigation session system event updates. We strongly recommend using this at all times to not miss any updates */
5581
5617
  navigationUpdatedById?: Maybe<Navigation>;
5582
- /** Subscription for a specific route was updated in the system event */
5618
+ /** Deprecated: In favor of route. */
5583
5619
  routeUpdatedById?: Maybe<Route>;
5584
- /** [BETA] Subscription for a specific route was updated in the system event */
5620
+ /** Subscribe to a specific route to receive system event updates. */
5585
5621
  route: RouteResponse;
5586
5622
  };
5587
5623
  export declare type SubscriptionconnectedVehicleArgs = {
@@ -5742,13 +5778,13 @@ export declare enum TelemetryInputSource {
5742
5778
  export declare type Temperature = {
5743
5779
  /** Value of the temperature. */
5744
5780
  value: Scalars["Float"];
5745
- /** Type of temperature. */
5781
+ /** Preferred unit for the temperature. */
5746
5782
  type: TemperatureUnit;
5747
5783
  };
5748
5784
  export declare type TemperatureInput = {
5749
5785
  /** Value of the temperature. */
5750
5786
  value: Scalars["Float"];
5751
- /** Type of temperature. */
5787
+ /** Preferred unit for the temperature. */
5752
5788
  type: TemperatureUnit;
5753
5789
  };
5754
5790
  /** Temperature unit. */
@@ -5759,17 +5795,17 @@ export declare enum TemperatureUnit {
5759
5795
  FAHRENHEIT = "Fahrenheit"
5760
5796
  }
5761
5797
  export declare type TirePressure = {
5762
- /** Values for the tire pressure, starting from the front side right to left and to the rear (FR, FL, RL, RR). */
5798
+ /** Values for the tire pressure, ordered from front right to front left, then rear left to rear right. */
5763
5799
  value: Array<Scalars["Float"]>;
5764
- /** Type of the value of pressure. */
5800
+ /** Preferred unit for the tire pressure. */
5765
5801
  type: PressureUnit;
5766
5802
  /** Source of inputted data. */
5767
5803
  source: TelemetryInputSource;
5768
5804
  };
5769
5805
  export declare type TirePressureInput = {
5770
- /** Values for the tire pressure, starting from the front side right to left and to the rear. */
5806
+ /** Values for the tire pressure, ordered from front right to front left, then rear left to rear right. */
5771
5807
  value: Array<Scalars["Float"]>;
5772
- /** Type of the value of pressure. */
5808
+ /** Preferred unit for the tire pressure. */
5773
5809
  type: PressureUnit;
5774
5810
  /** Source of inputted data, defaults to 'manual'. */
5775
5811
  source?: Maybe<TelemetryInputSource>;
@@ -5783,7 +5819,7 @@ export declare enum TorqueUnit {
5783
5819
  export declare type TotalCargoWeight = {
5784
5820
  /** Value of the current weight of the cargo. */
5785
5821
  value: Scalars["Float"];
5786
- /** Type of the current weight of the cargo. */
5822
+ /** Preferred unit for the current weight of the cargo. */
5787
5823
  type: WeightUnit;
5788
5824
  /** Source of inputted data. */
5789
5825
  source: TelemetryInputSource;
@@ -5791,7 +5827,7 @@ export declare type TotalCargoWeight = {
5791
5827
  export declare type TotalCargoWeightInput = {
5792
5828
  /** Value of the current weight of the cargo. */
5793
5829
  value: Scalars["Float"];
5794
- /** Type of the current weight of the cargo. */
5830
+ /** Preferred unit for the current weight of the cargo. */
5795
5831
  type: WeightUnit;
5796
5832
  /** Source of inputted data, defaults to 'manual'. */
5797
5833
  source?: Maybe<TelemetryInputSource>;
@@ -5799,7 +5835,7 @@ export declare type TotalCargoWeightInput = {
5799
5835
  export declare type TotalOccupantWeight = {
5800
5836
  /** Value of the combined weight of the occupants. */
5801
5837
  value: Scalars["Float"];
5802
- /** Type of the current weight of the occupants. */
5838
+ /** Preferred unit for the current weight of the occupants. */
5803
5839
  type: WeightUnit;
5804
5840
  /** Source of inputted data. */
5805
5841
  source: TelemetryInputSource;
@@ -5807,7 +5843,7 @@ export declare type TotalOccupantWeight = {
5807
5843
  export declare type TotalOccupantWeightInput = {
5808
5844
  /** Value of the combined weight of the occupants. */
5809
5845
  value: Scalars["Float"];
5810
- /** Type of the current weight of the occupants. */
5846
+ /** Preferred unit for the current weight of the occupants. */
5811
5847
  type: WeightUnit;
5812
5848
  /** Source of inputted data, defaults to 'manual'. */
5813
5849
  source?: Maybe<TelemetryInputSource>;
@@ -7065,15 +7101,15 @@ export declare type VehicleRouting = {
7065
7101
  export declare type VehicleSpeed = {
7066
7102
  /** Value of the vehicle speed. */
7067
7103
  value: Scalars["Float"];
7068
- /** Type of the vehicle speed. */
7104
+ /** Preferred unit for the vehicle's speed. */
7069
7105
  type: SpeedUnit;
7070
7106
  /** Source of inputted data. */
7071
7107
  source: TelemetryInputSource;
7072
7108
  };
7073
7109
  export declare type VehicleSpeedInput = {
7074
- /** Value of the vehicle speed. */
7110
+ /** Value of the vehicle's speed. */
7075
7111
  value: Scalars["Float"];
7076
- /** Type of the vehicle speed. */
7112
+ /** Preferred unit for the vehicle's speed. */
7077
7113
  type: SpeedUnit;
7078
7114
  /** Source of inputted data, defaults to 'manual'. */
7079
7115
  source?: Maybe<TelemetryInputSource>;