@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.
package/src/graphql.ts CHANGED
@@ -102,7 +102,7 @@ export enum AdhocAuthorisationMethod {
102
102
  export type AlternativeStationRadius = {
103
103
  /** Value of the alternative station radius. */
104
104
  value: Scalars["Float"];
105
- /** Type of the alternative station radius. */
105
+ /** Preferred unit for the alternative station radius. */
106
106
  type: DistanceUnit;
107
107
  /** Source of inputted data. */
108
108
  source: TelemetryInputSource;
@@ -111,7 +111,7 @@ export type AlternativeStationRadius = {
111
111
  export 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>;
@@ -192,18 +192,18 @@ export type AuthorizeConnectedVehicleOptions = {
192
192
  };
193
193
 
194
194
  export type AuxiliaryConsumption = {
195
- /** Value of the auxiliary power consumption of the vehicle. */
195
+ /** Value of the vehicle's auxiliary power consumption. */
196
196
  value: Scalars["Float"];
197
- /** Type of auxiliary power consumption of the vehicle. */
197
+ /** Preferred unit for the vehicle's auxiliary power consumption. */
198
198
  type: AuxiliaryConsumptionUnit;
199
199
  /** Source of inputted data. */
200
200
  source: TelemetryInputSource;
201
201
  };
202
202
 
203
203
  export type AuxiliaryConsumptionInput = {
204
- /** Value of the auxiliary power consumption of the vehicle. */
204
+ /** Value of the vehicle's auxiliary power consumption. */
205
205
  value: Scalars["Float"];
206
- /** Type of auxiliary power consumption of the vehicle. */
206
+ /** Preferred unit for the vehicle's auxiliary power consumption. */
207
207
  type: AuxiliaryConsumptionUnit;
208
208
  /** Source of inputted data, defaults to 'manual'. */
209
209
  source?: Maybe<TelemetryInputSource>;
@@ -226,7 +226,7 @@ export enum BatteryInputType {
226
226
  export type BatteryTemperatureInput = {
227
227
  /** Value of the temperature of the battery. */
228
228
  value: Scalars["Float"];
229
- /** Type of temperature of the battery. */
229
+ /** Preferred unit for the temperature of the battery. */
230
230
  type: TemperatureUnit;
231
231
  /** Source of inputted data, defaults to 'manual'. */
232
232
  source?: Maybe<TelemetryInputSource>;
@@ -263,16 +263,16 @@ export enum ChargeMode {
263
263
  export type ChargeSpeed = {
264
264
  /** Value of the charge speed of the battery. */
265
265
  value: Scalars["Float"];
266
- /** Type of the charge speed of the battery. */
266
+ /** Preferred unit for the battery's charge speed. */
267
267
  type: ChargeSpeedUnit;
268
268
  /** Source of inputted data */
269
269
  source: TelemetryInputSource;
270
270
  };
271
271
 
272
272
  export type ChargeSpeedInput = {
273
- /** Value of the charge speed of the battery. */
273
+ /** Value of the battery's charge speed. */
274
274
  value: Scalars["Float"];
275
- /** Type of the charge speed of the battery. */
275
+ /** Preferred unit for the battery's charge speed. */
276
276
  type: ChargeSpeedUnit;
277
277
  /** Source of inputted data, defaults to 'manual'. */
278
278
  source?: Maybe<TelemetryInputSource>;
@@ -291,7 +291,7 @@ export enum ChargeSpeedUnit {
291
291
  export type ChargeTotalInput = {
292
292
  /** Value of the temperature of the battery. */
293
293
  value: Scalars["Float"];
294
- /** Type of total charge amount. */
294
+ /** Preferred unit for the total charge amount. */
295
295
  type: StateOfChargeUnit;
296
296
  /** Source of inputted data, defaults to 'manual'. */
297
297
  source?: Maybe<TelemetryInputSource>;
@@ -616,7 +616,7 @@ export enum ConnectorPriceElementComponentType {
616
616
  FLAT = "flat",
617
617
  /** Parking price per hour. This fee is applicable even if the parked car is not charging. */
618
618
  PARKING_TIME = "parking_time",
619
- /** Fixed price per hour. */
619
+ /** Fixed price per unit of time defined in the step size. */
620
620
  TIME = "time"
621
621
  }
622
622
 
@@ -1155,8 +1155,8 @@ export type CreateRoute = {
1155
1155
  season: RouteSeason;
1156
1156
  /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
1157
1157
  alternative_station_radius?: Maybe<AlternativeStationRadius>;
1158
- /** Departure time of a route. */
1159
- departure_time?: Maybe<Scalars["DateTime"]>;
1158
+ /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
1159
+ departure_time: Scalars["DateTime"];
1160
1160
  };
1161
1161
 
1162
1162
  /** Input for the create route mutation. */
@@ -1175,7 +1175,7 @@ export type CreateRouteInput = {
1175
1175
  season?: Maybe<RouteSeason>;
1176
1176
  /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
1177
1177
  alternative_station_radius?: Maybe<AlternativeStationRadiusInput>;
1178
- /** Route departure time. */
1178
+ /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
1179
1179
  departure_time?: Maybe<Scalars["DateTime"]>;
1180
1180
  };
1181
1181
 
@@ -1590,7 +1590,7 @@ export type ElectricityGenerationMethodintensityArgs = {
1590
1590
  export type ElevationInput = {
1591
1591
  /** Value of the elevation. */
1592
1592
  value: Scalars["Float"];
1593
- /** Type of the value of elevation. */
1593
+ /** Preferred unit for the elevation. */
1594
1594
  type: DistanceUnit;
1595
1595
  /** Source of inputted data, defaults to 'manual'. */
1596
1596
  source?: Maybe<TelemetryInputSource>;
@@ -1809,7 +1809,9 @@ export enum HeavyVehiclesEUType {
1809
1809
  /** 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). */
1810
1810
  N2 = "N2",
1811
1811
  /** 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). */
1812
- N3 = "N3"
1812
+ N3 = "N3",
1813
+ /** 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). */
1814
+ N3_O4 = "N3_O4"
1813
1815
  }
1814
1816
 
1815
1817
  /** List of facilities in the location. */
@@ -2070,9 +2072,9 @@ export type Mutation = {
2070
2072
  * This is a premium feature, contact Chargetrip for more information.
2071
2073
  */
2072
2074
  deleteUserReview: Review;
2073
- /** [BETA] Create a new route from the route input and its ID. */
2075
+ /** Create a new route from the route input and its ID. */
2074
2076
  createRoute: Scalars["ID"];
2075
- /** Create a new route from the route input and its ID */
2077
+ /** Deprecated: In favor of createRoute. */
2076
2078
  newRoute?: Maybe<Scalars["ID"]>;
2077
2079
  };
2078
2080
 
@@ -2868,7 +2870,7 @@ export enum OICPValueAddedServices {
2868
2870
  export type Odometer = {
2869
2871
  /** Value of the vehicle's odometer. */
2870
2872
  value: Scalars["Float"];
2871
- /** Type of the value of the vehicle's odometer. */
2873
+ /** Preferred unit for the vehicle's odometer. */
2872
2874
  type: DistanceUnit;
2873
2875
  /** Source of inputted data. */
2874
2876
  source: TelemetryInputSource;
@@ -2877,7 +2879,7 @@ export type Odometer = {
2877
2879
  export type OdometerInput = {
2878
2880
  /** Value of the vehicle's odometer. */
2879
2881
  value: Scalars["Float"];
2880
- /** Type of the value of the vehicle's odometer. */
2882
+ /** Preferred unit for the vehicle's odometer. */
2881
2883
  type: DistanceUnit;
2882
2884
  /** Source of inputted data, defaults to 'manual'. */
2883
2885
  source?: Maybe<TelemetryInputSource>;
@@ -2904,20 +2906,30 @@ export type Operator = {
2904
2906
  countries?: Maybe<Array<CountryCodeAlpha2>>;
2905
2907
  /** Contact information. */
2906
2908
  contact?: Maybe<Contact>;
2907
- /** Ranking level on which the operator is placed or null in case the operator is not on any ranking level. */
2909
+ /**
2910
+ * 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.
2911
+ * @deprecated In favor of ranking_levels.
2912
+ */
2908
2913
  ranking?: Maybe<Scalars["Int"]>;
2909
- /** Flag which indicates if the operator is in the excluded list. */
2914
+ /**
2915
+ * 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.
2916
+ * @deprecated In favor of excluded_countries.
2917
+ */
2910
2918
  excluded?: Maybe<Scalars["Boolean"]>;
2919
+ /** 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. */
2920
+ ranking_levels?: Maybe<OperatorRankingLevels>;
2921
+ /** 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. */
2922
+ excluded_countries?: Maybe<Array<CountryCodeAlpha2>>;
2911
2923
  };
2912
2924
 
2913
2925
  /** Filter which can be applied to retrieve the operator list action. */
2914
2926
  export type OperatorListFilter = {
2915
2927
  /** ISO-3166 alpha-2 country codes an operator is active in. */
2916
2928
  countries?: Maybe<Array<CountryCodeAlpha2>>;
2917
- /** List of ranking level(s) to be retrieved. Valid values are 1 to 10. */
2918
- ranking?: Maybe<Array<Scalars["Int"]>>;
2919
- /** Only retrieve operators that are in the excluded list. */
2920
- excluded?: Maybe<Scalars["Boolean"]>;
2929
+ /** 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. */
2930
+ ranking_levels?: Maybe<OperatorRankingLevelsFilter>;
2931
+ /** 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. */
2932
+ excluded_countries?: Maybe<Array<CountryCodeAlpha2>>;
2921
2933
  };
2922
2934
 
2923
2935
  /** Filter which can be applied to retrieve the operator list action. */
@@ -2939,10 +2951,30 @@ export enum OperatorRankingLevel {
2939
2951
  HIGH = "high"
2940
2952
  }
2941
2953
 
2954
+ /** 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. */
2955
+ export type OperatorRankingLevels = {
2956
+ /** Low level for operators ranking. */
2957
+ low?: Maybe<Array<CountryCodeAlpha2>>;
2958
+ /** Medium level for operators ranking. */
2959
+ medium?: Maybe<Array<CountryCodeAlpha2>>;
2960
+ /** High level for operators ranking. */
2961
+ high?: Maybe<Array<CountryCodeAlpha2>>;
2962
+ };
2963
+
2964
+ /** Filter operators by ranking levels. */
2965
+ export type OperatorRankingLevelsFilter = {
2966
+ /** Low level for operators ranking. */
2967
+ low?: Maybe<Array<CountryCodeAlpha2>>;
2968
+ /** Medium level for operators ranking. */
2969
+ medium?: Maybe<Array<CountryCodeAlpha2>>;
2970
+ /** High level for operators ranking. */
2971
+ high?: Maybe<Array<CountryCodeAlpha2>>;
2972
+ };
2973
+
2942
2974
  export type OutsideTempInput = {
2943
2975
  /** Value of the outside temperature. */
2944
2976
  value: Scalars["Float"];
2945
- /** Type of the value of the outside temperature. */
2977
+ /** Preferred unit for the outside temperature. */
2946
2978
  type: TemperatureUnit;
2947
2979
  /** Source of inputted data, defaults to 'manual'. */
2948
2980
  source?: Maybe<TelemetryInputSource>;
@@ -2951,7 +2983,7 @@ export type OutsideTempInput = {
2951
2983
  export type OutsideTemperature = {
2952
2984
  /** Value of the temperature. */
2953
2985
  value: Scalars["Float"];
2954
- /** Type of the temperature. */
2986
+ /** Preferred unit for the outside temperature. */
2955
2987
  type: TemperatureUnit;
2956
2988
  /** Source of inputted data. */
2957
2989
  source: TelemetryInputSource;
@@ -2960,7 +2992,7 @@ export type OutsideTemperature = {
2960
2992
  export type OutsideTemperatureInput = {
2961
2993
  /** Value of the outside temperature. */
2962
2994
  value: Scalars["Float"];
2963
- /** Type of the value of the outside temperature. */
2995
+ /** Preferred unit for the outside temperature. */
2964
2996
  type: TemperatureUnit;
2965
2997
  /** Source of inputted data. */
2966
2998
  source?: Maybe<TelemetryInputSource>;
@@ -3026,7 +3058,7 @@ export enum PolylineInputDecimals {
3026
3058
  export type PowerInput = {
3027
3059
  /** Value of the positive or negative power. When negative the vehicle is charging. */
3028
3060
  value: Scalars["Float"];
3029
- /** Type of the value of the power. */
3061
+ /** Preferred unit for the power. */
3030
3062
  type: PowerUnit;
3031
3063
  /** Source of inputted data, defaults to 'manual'. */
3032
3064
  source?: Maybe<TelemetryInputSource>;
@@ -3130,15 +3162,15 @@ export type Query = {
3130
3162
  * This is a premium feature, contact Chargetrip for more information.
3131
3163
  */
3132
3164
  userReviewList?: Maybe<Array<Review>>;
3133
- /** Get a route by ID */
3165
+ /** Deprecated: In favor of getRoute. */
3134
3166
  route?: Maybe<Route>;
3135
- /** [BETA] Get a route by ID. */
3167
+ /** Get a route by ID. */
3136
3168
  getRoute: RouteResponse;
3137
- /** [BETA] Get emissions for a route. */
3169
+ /** Get emissions for a route. */
3138
3170
  getRouteEmissions: RouteDetailsEmissions;
3139
- /** Emissions profile for route. */
3171
+ /** Deprecated: In favor of getRouteEmissions. */
3140
3172
  routeEmissions: RouteEmissions;
3141
- /** Retrieve information about a route path segment */
3173
+ /** Deprecated: In favor of RouteDetails.path_plot. */
3142
3174
  routePath?: Maybe<RoutePath>;
3143
3175
  /** Get information about a station by its ID. */
3144
3176
  station?: Maybe<Station>;
@@ -3814,14 +3846,14 @@ export type RouteDetails = {
3814
3846
  distance: Scalars["Float"];
3815
3847
  /** Aggregation of all durations of a route. */
3816
3848
  durations: RouteDetailsDurations;
3817
- /** Total energy used for a route in kilowatt hours. */
3818
- consumption: Scalars["Float"];
3819
- /** Range available at the beginning of a trip. */
3820
- range_at_origin: Scalars["Float"];
3821
- /** Range available at the end of a trip. */
3822
- range_at_destination: Scalars["Float"];
3849
+ /** Total energy used for a route in kilowatt hours. For HEVs and PHEVs this field will return null. */
3850
+ consumption?: Maybe<Scalars["Float"]>;
3851
+ /** 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. */
3852
+ range_at_origin?: Maybe<Scalars["Float"]>;
3853
+ /** 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. */
3854
+ range_at_destination?: Maybe<Scalars["Float"]>;
3823
3855
  /** Polyline containing encoded coordinates. */
3824
- polyline?: Maybe<Scalars["String"]>;
3856
+ polyline: Scalars["String"];
3825
3857
  /** Path elevation, distance, duration, consumption and speed values, grouped into 100 segments. */
3826
3858
  path_plot: Array<RouteDetailsPathSegment>;
3827
3859
  /** Details about elevation on a route. */
@@ -3830,7 +3862,7 @@ export type RouteDetails = {
3830
3862
  savings?: Maybe<RouteDetailsSavings>;
3831
3863
  /** Legs of a route. */
3832
3864
  legs: Array<RouteDetailsLeg>;
3833
- /** Alternative stations along a route within specified radius. */
3865
+ /** Alternative stations along a route within a specified radius. Will only return stations if alternative_station_radius was specified in the createRoute mutation. */
3834
3866
  alternative_stations: Array<RouteDetailsAlternativeStation>;
3835
3867
  /** Aggregation of tags over the current RouteDetails. Tags are available on legs and further subdivided over individual sections and maneuvers. */
3836
3868
  tags: Array<RouteDetailsTag>;
@@ -3863,7 +3895,7 @@ export type RouteDetailsAlternativeStation = {
3863
3895
  speed: StationSpeedType;
3864
3896
  /** Status of a station. */
3865
3897
  status: ChargerStatus;
3866
- /** Ranking of an operator. */
3898
+ /** 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. */
3867
3899
  operator_ranking?: Maybe<OperatorRankingLevel>;
3868
3900
  };
3869
3901
 
@@ -3871,14 +3903,14 @@ export type RouteDetailsAlternativeStation = {
3871
3903
  export type RouteDetailsDurations = {
3872
3904
  /** Total duration, in seconds. */
3873
3905
  total: Scalars["Int"];
3874
- /** Total duration charging, in seconds. */
3906
+ /** Total charging duration, in seconds. */
3875
3907
  charging: Scalars["Int"];
3876
- /** Total duration driving, in seconds. */
3908
+ /** Total driving duration, in seconds. */
3877
3909
  driving: Scalars["Int"];
3878
- /** Total duration stopped for a short stay, for example at a via point, in seconds. */
3910
+ /** Total stop duration, excluding charge stops, in seconds. */
3879
3911
  stopover: Scalars["Int"];
3880
- /** Total duration of ferry rides, in seconds. */
3881
- ferry?: Maybe<Scalars["Int"]>;
3912
+ /** Total ferry duration, in seconds. */
3913
+ ferry: Scalars["Int"];
3882
3914
  };
3883
3915
 
3884
3916
  export type RouteDetailsElevation = {
@@ -3933,21 +3965,21 @@ export type RouteDetailsLeg = {
3933
3965
  distance: Scalars["Float"];
3934
3966
  /** Aggregation of all durations of a route leg. */
3935
3967
  durations: RouteDetailsDurations;
3936
- /** Total energy used in a leg in kilowatt hours. */
3937
- consumption: Scalars["Float"];
3968
+ /** Total energy used in a leg in kilowatt hours. For HEVs and PHEVs this field will return null. */
3969
+ consumption?: Maybe<Scalars["Float"]>;
3938
3970
  /** Origin point location. */
3939
3971
  origin: RouteDetailsLegFeaturePoint;
3940
3972
  /** Destination point location. */
3941
3973
  destination: RouteDetailsLegFeaturePoint;
3942
- /** Range at the origin of the leg. */
3943
- range_at_origin: Scalars["Float"];
3944
- /** Range at the destination of the leg. */
3945
- range_at_destination: Scalars["Float"];
3946
- /** Range after charging on the leg. */
3974
+ /** 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. */
3975
+ range_at_origin?: Maybe<Scalars["Float"]>;
3976
+ /** 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. */
3977
+ range_at_destination?: Maybe<Scalars["Float"]>;
3978
+ /** 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. */
3947
3979
  range_after_charge?: Maybe<Scalars["Float"]>;
3948
3980
  /** Type of a leg. */
3949
3981
  type: RouteDetailsLegType;
3950
- /** Information about the station at the origin of this leg. */
3982
+ /** Information about the station at the destination of a leg. */
3951
3983
  station?: Maybe<RouteDetailsLegStation>;
3952
3984
  /** Polyline containing encoded coordinates. */
3953
3985
  polyline: Scalars["String"];
@@ -4033,7 +4065,7 @@ export type RouteDetailsLegFeaturePropertiestotal_cargo_weightArgs = {
4033
4065
  export type RouteDetailsLegManeuverPoints = {
4034
4066
  /** Number of polyline points which are included in this instruction. */
4035
4067
  size: Scalars["Int"];
4036
- /** 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. */
4068
+ /** 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. */
4037
4069
  interval: Array<Scalars["Int"]>;
4038
4070
  };
4039
4071
 
@@ -4073,13 +4105,13 @@ export type RouteDetailsLegSection = {
4073
4105
  /** Aggregation of tags over the current section. */
4074
4106
  tags: Array<RouteDetailsTag>;
4075
4107
  /** Polyline containing encoded coordinates. */
4076
- polyline?: Maybe<Scalars["String"]>;
4108
+ polyline: Scalars["String"];
4077
4109
  /** Distance from the start to the end of a section. */
4078
4110
  distance: Scalars["Float"];
4079
4111
  /** Total duration of a section, in seconds. The value will be 0 for walking sections. */
4080
4112
  duration: Scalars["Float"];
4081
4113
  /** Total energy used in a section in kilowatt-hours. The value will be 0 for walking sections. */
4082
- consumption: Scalars["Float"];
4114
+ consumption?: Maybe<Scalars["Float"]>;
4083
4115
  };
4084
4116
 
4085
4117
  export type RouteDetailsLegSectionpolylineArgs = {
@@ -4136,11 +4168,17 @@ export type RouteDetailsLegStation = {
4136
4168
 
4137
4169
  /** Type of a leg. */
4138
4170
  export enum RouteDetailsLegType {
4171
+ /** This leg ends at a charging station and the vehicle must recharge. */
4139
4172
  STATION = "station",
4173
+ /** This leg ends at a via charging station and the vehicle must recharge. */
4140
4174
  STATION_VIA = "station_via",
4175
+ /** This leg ends at the destination which is a charging station, and is the last leg of the route. */
4141
4176
  STATION_FINAL = "station_final",
4177
+ /** This leg ends at a scheduled charging station and the vehicle must recharge. */
4142
4178
  STATION_AMENITY = "station_amenity",
4179
+ /** This leg ends at a via location. */
4143
4180
  VIA = "via",
4181
+ /** This leg ends at the destination, and is the last leg of the route. */
4144
4182
  FINAL = "final"
4145
4183
  }
4146
4184
 
@@ -4148,8 +4186,8 @@ export type RouteDetailsManeuver = {
4148
4186
  /** Type of instruction. */
4149
4187
  type: RouteDetailsLegManeuverType;
4150
4188
  /** Location of the maneuver. */
4151
- location?: Maybe<RouteDetailsLegSectionFeaturePoint>;
4152
- /** Name of the street on which an instruction is. */
4189
+ location: RouteDetailsLegSectionFeaturePoint;
4190
+ /** Name of the street associated with the instruction. */
4153
4191
  name?: Maybe<Scalars["String"]>;
4154
4192
  /** Distance, in meters, of a route instruction. */
4155
4193
  distance: Scalars["Float"];
@@ -4162,7 +4200,7 @@ export type RouteDetailsManeuver = {
4162
4200
  /** 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`. */
4163
4201
  turn_angle?: Maybe<Scalars["Float"]>;
4164
4202
  /** Aggregation of tags over the current maneuver. */
4165
- tags?: Maybe<Array<RouteDetailsTag>>;
4203
+ tags: Array<RouteDetailsTag>;
4166
4204
  };
4167
4205
 
4168
4206
  export type RouteDetailsManeuverdistanceArgs = {
@@ -4174,13 +4212,13 @@ export type RouteDetailsPathSegment = {
4174
4212
  elevation: Scalars["Float"];
4175
4213
  /** Average speed of a route path segment. */
4176
4214
  average_speed: Scalars["Float"];
4177
- /** Consumption, in kilowatt hours, of a route path segment. */
4178
- consumption: Scalars["Float"];
4215
+ /** Consumption, in kilowatt hours, of a route path segment. For HEVs and PHEVs this field will return null. */
4216
+ consumption?: Maybe<Scalars["Float"]>;
4179
4217
  /** Distance of a route path segment. */
4180
4218
  distance: Scalars["Float"];
4181
4219
  /** Duration, in seconds, of a route path segment. */
4182
4220
  duration: Scalars["Float"];
4183
- /** State of charge, in kilowatt hours, of a route path segment. */
4221
+ /** State of charge, in kilowatt hours, of a route path segment. For HEVs and PHEVs this field will return null. */
4184
4222
  state_of_charge?: Maybe<Scalars["Float"]>;
4185
4223
  /** Maximum vehicle speed of a route path segment. */
4186
4224
  maximum_speed: Scalars["Float"];
@@ -5000,7 +5038,7 @@ export type RouteOperationalMaintenanceEmissionsFielddisposalArgs = {
5000
5038
  export type RouteOperatorPreferences = {
5001
5039
  /** Ranking of an operator with multiple levels, each level having its own penalty value. */
5002
5040
  ranking?: Maybe<RouteOperatorPreferencesRanking>;
5003
- /** Route operators that should be excluded. */
5041
+ /** Operators that should be excluded for a route calculation. */
5004
5042
  exclude?: Maybe<Array<RouteOperatorsValue>>;
5005
5043
  };
5006
5044
 
@@ -5008,7 +5046,7 @@ export type RouteOperatorPreferences = {
5008
5046
  export type RouteOperatorPreferencesInput = {
5009
5047
  /** Ranking of an operator with multiple levels, each level having its own penalty value. */
5010
5048
  ranking?: Maybe<RouteOperatorPreferencesRankingInput>;
5011
- /** Route operators that should be excluded. */
5049
+ /** Operators that should be excluded for a route calculation. */
5012
5050
  exclude?: Maybe<Array<RouteOperatorsValueInput>>;
5013
5051
  };
5014
5052
 
@@ -5040,7 +5078,7 @@ export type RouteOperatorPreferencesRankingLevelsInput = {
5040
5078
  low?: Maybe<Array<RouteOperatorsValueInput>>;
5041
5079
  /** Medium level for operator ranking. */
5042
5080
  medium?: Maybe<Array<RouteOperatorsValueInput>>;
5043
- /** Most significant level three for operator ranking. */
5081
+ /** Most significant level for operator ranking. */
5044
5082
  high?: Maybe<Array<RouteOperatorsValueInput>>;
5045
5083
  };
5046
5084
 
@@ -5219,9 +5257,9 @@ export type RoutePropertiesStationInput = {
5219
5257
 
5220
5258
  export type RoutePropertiesVehicle = {
5221
5259
  /** Number of occupants present in the vehicle. */
5222
- occupants?: Maybe<Scalars["Int"]>;
5260
+ occupants: Scalars["Int"];
5223
5261
  /** Combined weight of the occupants. This can only be used in combination with occupants. */
5224
- total_occupant_weight?: Maybe<TotalOccupantWeight>;
5262
+ total_occupant_weight: TotalOccupantWeight;
5225
5263
  /** Weight of the cargo. */
5226
5264
  total_cargo_weight?: Maybe<TotalCargoWeight>;
5227
5265
  };
@@ -5348,26 +5386,26 @@ export type RouteVehicle = {
5348
5386
  /** ID of the vehicle. */
5349
5387
  id: Scalars["ID"];
5350
5388
  /** EV battery specific configuration. */
5351
- battery?: Maybe<RouteVehicleBattery>;
5389
+ battery: RouteVehicleBattery;
5352
5390
  /** Charging configuration. */
5353
- charging?: Maybe<RouteVehicleCharging>;
5354
- /** Average tire pressures of all wheels, starting from the front side (right to left) and then to the rear. */
5355
- tire_pressure?: Maybe<TirePressure>;
5391
+ charging: RouteVehicleCharging;
5392
+ /** Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right. */
5393
+ tire_pressure: TirePressure;
5356
5394
  /** Value of the vehicle's odometer. */
5357
5395
  odometer?: Maybe<Odometer>;
5358
5396
  /** Value of the auxiliary power consumption of the vehicle. */
5359
- auxiliary_consumption?: Maybe<AuxiliaryConsumption>;
5360
- /** Flag which indicates if climate control is on. */
5361
- climate?: Maybe<Scalars["Boolean"]>;
5397
+ auxiliary_consumption: AuxiliaryConsumption;
5398
+ /** Flag indicating if climate control is on. */
5399
+ climate: Scalars["Boolean"];
5362
5400
  /** Vehicle Heat Pump configuration. */
5363
5401
  heat_pump: HeatPumpMode;
5364
- /** Vehicle cabin configuration. */
5402
+ /** Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true. */
5365
5403
  cabin: RouteVehicleCabin;
5366
5404
  /** Revolutions per minute of the motor, a measure of the rotational speed of the motor's rotor component. */
5367
5405
  motor_rpm?: Maybe<Scalars["Int"]>;
5368
5406
  /** Value of the outside temperature. */
5369
5407
  outside_temperature?: Maybe<OutsideTemperature>;
5370
- /** Flag which indicates if vehicle is in park, neutral or turned off. */
5408
+ /** Flag indicating if a vehicle is in park, neutral, or turned off. */
5371
5409
  is_parked?: Maybe<Scalars["Boolean"]>;
5372
5410
  /** Value of the vehicle's speed. */
5373
5411
  vehicle_speed?: Maybe<VehicleSpeed>;
@@ -5376,11 +5414,11 @@ export type RouteVehicle = {
5376
5414
  };
5377
5415
 
5378
5416
  export type RouteVehicleBattery = {
5379
- /** Battery capacity. */
5417
+ /** 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. */
5380
5418
  capacity: StateOfCharge;
5381
- /** State of charge. */
5419
+ /** 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. */
5382
5420
  state_of_charge: StateOfCharge;
5383
- /** Minimum final battery state of charge. The value should be between 0 and 60% of the battery capacity. */
5421
+ /** 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. */
5384
5422
  final_state_of_charge: StateOfCharge;
5385
5423
  /** Temperature of the battery. */
5386
5424
  temperature?: Maybe<Temperature>;
@@ -5390,17 +5428,17 @@ export type RouteVehicleBattery = {
5390
5428
  voltage?: Maybe<Scalars["Float"]>;
5391
5429
  /** Value of the positive or negative power, in kWh. When negative, the vehicle is charging. */
5392
5430
  power?: Maybe<Scalars["Float"]>;
5393
- /** Flag which indicates if the vehicle is charging. */
5431
+ /** Flag indicating if the vehicle is charging. */
5394
5432
  is_charging?: Maybe<Scalars["Boolean"]>;
5395
5433
  };
5396
5434
 
5397
5435
  /** EV battery specific configuration for a create route mutation. */
5398
5436
  export type RouteVehicleBatteryInput = {
5399
- /** Battery capacity. */
5437
+ /** 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. */
5400
5438
  capacity?: Maybe<StateOfChargeInput>;
5401
- /** Battery state of charge. */
5439
+ /** 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. */
5402
5440
  state_of_charge?: Maybe<StateOfChargeInput>;
5403
- /** Minimum final battery state of charge. The value should be between 0 and 60% of the battery capacity. */
5441
+ /** 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. */
5404
5442
  final_state_of_charge?: Maybe<StateOfChargeInput>;
5405
5443
  /** Battery temperature. */
5406
5444
  temperature?: Maybe<TemperatureInput>;
@@ -5410,19 +5448,19 @@ export type RouteVehicleBatteryInput = {
5410
5448
  voltage?: Maybe<Scalars["Float"]>;
5411
5449
  /** Value of the positive or negative power, in kWh. When negative, the vehicle is charging. */
5412
5450
  power?: Maybe<Scalars["Float"]>;
5413
- /** Flag which indicates if the vehicle is charging. */
5451
+ /** Flag indicating if the vehicle is charging. */
5414
5452
  is_charging?: Maybe<Scalars["Boolean"]>;
5415
5453
  };
5416
5454
 
5417
5455
  export type RouteVehicleCabin = {
5418
- /** Flag which indicates if the vehicle cabin was preconditioned for the desired temperature. */
5456
+ /** Flag indicating if the vehicle cabin was preconditioned for the desired temperature. */
5419
5457
  is_preconditioned: Scalars["Boolean"];
5420
5458
  /** Desired cabin temperature. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
5421
5459
  desired_temperature: Temperature;
5422
5460
  };
5423
5461
 
5424
5462
  export type RouteVehicleCabinInput = {
5425
- /** Flag which indicates if the vehicle cabin was preconditioned for the desired temperature. */
5463
+ /** Flag indicating if the vehicle cabin was preconditioned for the desired temperature. */
5426
5464
  is_preconditioned?: Maybe<Scalars["Boolean"]>;
5427
5465
  /** Desired cabin temperature. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
5428
5466
  desired_temperature?: Maybe<TemperatureInput>;
@@ -5433,18 +5471,18 @@ export type RouteVehicleCharging = {
5433
5471
  mode: ChargeMode;
5434
5472
  /** Minimum desired power of chargers, in kWh. */
5435
5473
  minimum_power: Scalars["Float"];
5436
- /** Percentage for the minimum limit of the battery's capacity before a recharge. The value should be between 0 and 60. Defaults to 10. */
5474
+ /** 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. */
5437
5475
  risk_margin: Scalars["Int"];
5438
- /** Supported connectors. */
5439
- connectors?: Maybe<Array<RouteVehicleChargingConnector>>;
5440
- /** Supported adapters. */
5441
- adapters?: Maybe<Array<RouteVehicleChargingConnector>>;
5476
+ /** Supported connectors. If not specified, it defaults to the vehicle's connectors. */
5477
+ connectors: Array<RouteVehicleChargingConnector>;
5478
+ /** Supported adapters. If not specified, adapters will not be considered. */
5479
+ adapters: Array<RouteVehicleChargingConnector>;
5442
5480
  };
5443
5481
 
5444
5482
  export type RouteVehicleChargingConnector = {
5445
5483
  /** Type of the plug. */
5446
5484
  standard: ConnectorType;
5447
- /** Maximum charging speed for the plug. */
5485
+ /** Maximum charging speed for this plug. */
5448
5486
  maximum_charge_speed: ChargeSpeed;
5449
5487
  };
5450
5488
 
@@ -5460,11 +5498,11 @@ export type RouteVehicleChargingInput = {
5460
5498
  mode?: Maybe<ChargeMode>;
5461
5499
  /** Minimum desired power of chargers, in kWh. */
5462
5500
  minimum_power?: Maybe<Scalars["Float"]>;
5463
- /** Percentage representing the minimum value of the state of charge at a next charge stop. The value should be between 0 and 60. */
5501
+ /** 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. */
5464
5502
  risk_margin?: Maybe<Scalars["Int"]>;
5465
- /** Supported connectors. */
5503
+ /** Supported connectors. If not specified, it defaults to the vehicle's connectors. */
5466
5504
  connectors?: Maybe<Array<RouteVehicleChargingConnectorInput>>;
5467
- /** Supported adapters. */
5505
+ /** Supported adapters. If not specified, adapters will not be considered. */
5468
5506
  adapters?: Maybe<Array<RouteVehicleChargingConnectorInput>>;
5469
5507
  };
5470
5508
 
@@ -5499,23 +5537,23 @@ export type RouteVehicleInput = {
5499
5537
  battery?: Maybe<RouteVehicleBatteryInput>;
5500
5538
  /** Charging configuration. */
5501
5539
  charging?: Maybe<RouteVehicleChargingInput>;
5502
- /** Average tire pressures of all wheels. */
5540
+ /** Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right. */
5503
5541
  tire_pressure?: Maybe<TirePressureInput>;
5504
5542
  /** Odometer (mileage) reading. */
5505
5543
  odometer?: Maybe<OdometerInput>;
5506
5544
  /** Average auxiliary power consumption. */
5507
5545
  auxiliary_consumption?: Maybe<AuxiliaryConsumptionInput>;
5508
- /** Flag which indicates if climate control is on. */
5546
+ /** Flag indicating if climate control is on. */
5509
5547
  climate?: Maybe<Scalars["Boolean"]>;
5510
5548
  /** Vehicle Heat Pump configuration. */
5511
5549
  heat_pump?: Maybe<HeatPumpMode>;
5512
- /** Vehicle cabin configuration for creating the route. */
5550
+ /** Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true. */
5513
5551
  cabin?: Maybe<RouteVehicleCabinInput>;
5514
5552
  /** Revolutions per minute of the motor, a measure of the rotational speed of the motor's rotor component. */
5515
5553
  motor_rpm?: Maybe<Scalars["Int"]>;
5516
5554
  /** Outside temperature. */
5517
5555
  outside_temperature?: Maybe<OutsideTemperatureInput>;
5518
- /** Flag which indicates if vehicle is in park, neutral or turned off. */
5556
+ /** Flag indicating if a vehicle is in park, neutral, or turned off. */
5519
5557
  is_parked?: Maybe<Scalars["Boolean"]>;
5520
5558
  /** Vehicle speed. */
5521
5559
  vehicle_speed?: Maybe<VehicleSpeedInput>;
@@ -5644,16 +5682,16 @@ export enum SpeedUnit {
5644
5682
  export type StateOfCharge = {
5645
5683
  /** Value of the state of charge of the vehicle. */
5646
5684
  value: Scalars["Float"];
5647
- /** Type of the state of charge of the vehicle. */
5685
+ /** Preferred unit for the vehicle's state of charge. */
5648
5686
  type: StateOfChargeUnit;
5649
5687
  /** Source of inputted data. */
5650
5688
  source: TelemetryInputSource;
5651
5689
  };
5652
5690
 
5653
5691
  export type StateOfChargeInput = {
5654
- /** Value of the state of charge of the vehicle. */
5692
+ /** Value of the vehicle's state of charge. */
5655
5693
  value: Scalars["Float"];
5656
- /** Type of the state of charge of the vehicle. */
5694
+ /** Preferred unit for the vehicle's state of charge. */
5657
5695
  type: StateOfChargeUnit;
5658
5696
  /** Source of inputted data, defaults to 'manual'. */
5659
5697
  source?: Maybe<TelemetryInputSource>;
@@ -6083,9 +6121,9 @@ export type Subscription = {
6083
6121
  isoline?: Maybe<Isoline>;
6084
6122
  /** [BETA] Subscribe to navigation session system event updates. We strongly recommend using this at all times to not miss any updates */
6085
6123
  navigationUpdatedById?: Maybe<Navigation>;
6086
- /** Subscription for a specific route was updated in the system event */
6124
+ /** Deprecated: In favor of route. */
6087
6125
  routeUpdatedById?: Maybe<Route>;
6088
- /** [BETA] Subscription for a specific route was updated in the system event */
6126
+ /** Subscribe to a specific route to receive system event updates. */
6089
6127
  route: RouteResponse;
6090
6128
  };
6091
6129
 
@@ -6268,14 +6306,14 @@ export enum TelemetryInputSource {
6268
6306
  export type Temperature = {
6269
6307
  /** Value of the temperature. */
6270
6308
  value: Scalars["Float"];
6271
- /** Type of temperature. */
6309
+ /** Preferred unit for the temperature. */
6272
6310
  type: TemperatureUnit;
6273
6311
  };
6274
6312
 
6275
6313
  export type TemperatureInput = {
6276
6314
  /** Value of the temperature. */
6277
6315
  value: Scalars["Float"];
6278
- /** Type of temperature. */
6316
+ /** Preferred unit for the temperature. */
6279
6317
  type: TemperatureUnit;
6280
6318
  };
6281
6319
 
@@ -6288,18 +6326,18 @@ export enum TemperatureUnit {
6288
6326
  }
6289
6327
 
6290
6328
  export type TirePressure = {
6291
- /** Values for the tire pressure, starting from the front side right to left and to the rear (FR, FL, RL, RR). */
6329
+ /** Values for the tire pressure, ordered from front right to front left, then rear left to rear right. */
6292
6330
  value: Array<Scalars["Float"]>;
6293
- /** Type of the value of pressure. */
6331
+ /** Preferred unit for the tire pressure. */
6294
6332
  type: PressureUnit;
6295
6333
  /** Source of inputted data. */
6296
6334
  source: TelemetryInputSource;
6297
6335
  };
6298
6336
 
6299
6337
  export type TirePressureInput = {
6300
- /** Values for the tire pressure, starting from the front side right to left and to the rear. */
6338
+ /** Values for the tire pressure, ordered from front right to front left, then rear left to rear right. */
6301
6339
  value: Array<Scalars["Float"]>;
6302
- /** Type of the value of pressure. */
6340
+ /** Preferred unit for the tire pressure. */
6303
6341
  type: PressureUnit;
6304
6342
  /** Source of inputted data, defaults to 'manual'. */
6305
6343
  source?: Maybe<TelemetryInputSource>;
@@ -6315,7 +6353,7 @@ export enum TorqueUnit {
6315
6353
  export type TotalCargoWeight = {
6316
6354
  /** Value of the current weight of the cargo. */
6317
6355
  value: Scalars["Float"];
6318
- /** Type of the current weight of the cargo. */
6356
+ /** Preferred unit for the current weight of the cargo. */
6319
6357
  type: WeightUnit;
6320
6358
  /** Source of inputted data. */
6321
6359
  source: TelemetryInputSource;
@@ -6324,7 +6362,7 @@ export type TotalCargoWeight = {
6324
6362
  export type TotalCargoWeightInput = {
6325
6363
  /** Value of the current weight of the cargo. */
6326
6364
  value: Scalars["Float"];
6327
- /** Type of the current weight of the cargo. */
6365
+ /** Preferred unit for the current weight of the cargo. */
6328
6366
  type: WeightUnit;
6329
6367
  /** Source of inputted data, defaults to 'manual'. */
6330
6368
  source?: Maybe<TelemetryInputSource>;
@@ -6333,7 +6371,7 @@ export type TotalCargoWeightInput = {
6333
6371
  export type TotalOccupantWeight = {
6334
6372
  /** Value of the combined weight of the occupants. */
6335
6373
  value: Scalars["Float"];
6336
- /** Type of the current weight of the occupants. */
6374
+ /** Preferred unit for the current weight of the occupants. */
6337
6375
  type: WeightUnit;
6338
6376
  /** Source of inputted data. */
6339
6377
  source: TelemetryInputSource;
@@ -6342,7 +6380,7 @@ export type TotalOccupantWeight = {
6342
6380
  export type TotalOccupantWeightInput = {
6343
6381
  /** Value of the combined weight of the occupants. */
6344
6382
  value: Scalars["Float"];
6345
- /** Type of the current weight of the occupants. */
6383
+ /** Preferred unit for the current weight of the occupants. */
6346
6384
  type: WeightUnit;
6347
6385
  /** Source of inputted data, defaults to 'manual'. */
6348
6386
  source?: Maybe<TelemetryInputSource>;
@@ -7758,16 +7796,16 @@ export type VehicleRouting = {
7758
7796
  export type VehicleSpeed = {
7759
7797
  /** Value of the vehicle speed. */
7760
7798
  value: Scalars["Float"];
7761
- /** Type of the vehicle speed. */
7799
+ /** Preferred unit for the vehicle's speed. */
7762
7800
  type: SpeedUnit;
7763
7801
  /** Source of inputted data. */
7764
7802
  source: TelemetryInputSource;
7765
7803
  };
7766
7804
 
7767
7805
  export type VehicleSpeedInput = {
7768
- /** Value of the vehicle speed. */
7806
+ /** Value of the vehicle's speed. */
7769
7807
  value: Scalars["Float"];
7770
- /** Type of the vehicle speed. */
7808
+ /** Preferred unit for the vehicle's speed. */
7771
7809
  type: SpeedUnit;
7772
7810
  /** Source of inputted data, defaults to 'manual'. */
7773
7811
  source?: Maybe<TelemetryInputSource>;