@chargetrip/types 1.71.0 → 1.73.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.
@@ -75,7 +75,10 @@ export declare type Address = {
75
75
  formattedAddress?: Maybe<Array<Maybe<Scalars["String"]>>>;
76
76
  /** Postal code of the location. */
77
77
  postal_code?: Maybe<Scalars["String"]>;
78
- /** String composed of 3 words which represent the location of an address on the globe. More details: http://w3w.co/<what3Words>. */
78
+ /**
79
+ * String composed of 3 words which represent the location of an address on the globe. More details: http://w3w.co/<what3Words>.
80
+ * @deprecated No longer in use.
81
+ */
79
82
  what_3_words?: Maybe<Scalars["String"]>;
80
83
  /** Human-readable address of the location. */
81
84
  formatted_address?: Maybe<Array<Maybe<Scalars["String"]>>>;
@@ -217,7 +220,7 @@ export declare type AmenityListFilter = {
217
220
  export declare type AmenityOpeningHours = {
218
221
  /** True to represent 24 hours a day and 7 days a week. */
219
222
  twentyfourseven?: Maybe<Scalars["Boolean"]>;
220
- /** Regular hours, weekday-based. Only to be used if twentyfourseven=false, then this field needs to contain at least one RegularHours object. */
223
+ /** Regular hours, weekday-based. Only to be used if `twentyfourseven` = false, then this field needs to contain at least one RegularHours object. */
221
224
  regular_hours?: Maybe<Array<Maybe<AmenityRegularHours>>>;
222
225
  };
223
226
  /** Amenity preferences for a route. */
@@ -227,7 +230,7 @@ export declare type AmenityPreferencesInput = {
227
230
  /** Scheduled charge stops, with a specified amenity and timeline. */
228
231
  scheduled_charge_stops?: Maybe<Array<ScheduledChargeStopInput>>;
229
232
  };
230
- /** Regular hours, weekday-based. Only to be used if twentyfourseven=false, then this field needs to contain at least one RegularHours object. */
233
+ /** Regular hours, weekday-based. Only to be used if `twentyfourseven` = false, then this field needs to contain at least one RegularHours object. */
231
234
  export declare type AmenityRegularHours = {
232
235
  /** Number of days in the week, from Monday (1) till Sunday (7). */
233
236
  weekday?: Maybe<Scalars["Int"]>;
@@ -285,7 +288,7 @@ export declare type AuxiliaryConsumptionInput = {
285
288
  value: Scalars["Float"];
286
289
  /** Preferred unit for the vehicle's auxiliary power consumption. */
287
290
  type: AuxiliaryConsumptionUnit;
288
- /** Source of inputted data, defaults to 'manual'. */
291
+ /** Source of inputted data, defaults to `manual`. */
289
292
  source?: Maybe<TelemetryInputSource>;
290
293
  };
291
294
  /** Auxiliary consumption units. */
@@ -305,7 +308,7 @@ export declare type BatteryTemperatureInput = {
305
308
  value: Scalars["Float"];
306
309
  /** Preferred unit for the temperature of the battery. */
307
310
  type: TemperatureUnit;
308
- /** Source of inputted data, defaults to 'manual'. */
311
+ /** Source of inputted data, defaults to `manual`. */
309
312
  source?: Maybe<TelemetryInputSource>;
310
313
  };
311
314
  export declare enum CarConnectivityProvider {
@@ -327,9 +330,9 @@ export declare type CarConsumptionInput = {
327
330
  };
328
331
  /** Charging mode used at charging stations. */
329
332
  export declare enum ChargeMode {
330
- /** Optimizes the charging time at each station, in order to decrease the total travel time. Charges the vehicle only to the SOC required to reach the next stop, without exceeding the configured 'maximum_state_of_charge'. */
333
+ /** Optimizes the charging time at each station, in order to decrease the total travel time. Charges the vehicle only to the SOC required to reach the next stop, without exceeding the configured `maximum_state_of_charge`. */
331
334
  OPTIMIZE_TRAVEL_TIME = "OPTIMIZE_TRAVEL_TIME",
332
- /** Charges up to the maximum configured state of charge (SoC) at each station. The maximum SoC is determined by 'maximum_state_of_charge'. */
335
+ /** Charges up to the maximum configured state of charge (SoC) at each station. The maximum SoC is determined by `maximum_state_of_charge`. */
333
336
  ALWAYS_TO_MAX_CHARGE = "ALWAYS_TO_MAX_CHARGE"
334
337
  }
335
338
  export declare type ChargeSpeed = {
@@ -345,7 +348,7 @@ export declare type ChargeSpeedInput = {
345
348
  value: Scalars["Float"];
346
349
  /** Preferred unit for the battery's charge speed. */
347
350
  type: ChargeSpeedUnit;
348
- /** Source of inputted data, defaults to 'manual'. */
351
+ /** Source of inputted data, defaults to `manual`. */
349
352
  source?: Maybe<TelemetryInputSource>;
350
353
  };
351
354
  export declare enum ChargeSpeedUnit {
@@ -363,7 +366,7 @@ export declare type ChargeTotalInput = {
363
366
  value: Scalars["Float"];
364
367
  /** Preferred unit for the total charge amount. */
365
368
  type: StateOfChargeUnit;
366
- /** Source of inputted data, defaults to 'manual'. */
369
+ /** Source of inputted data, defaults to `manual`. */
367
370
  source?: Maybe<TelemetryInputSource>;
368
371
  };
369
372
  /** A grouped representation of EVSEs. */
@@ -562,7 +565,7 @@ export declare type ConnectedVehicleListFilter = {
562
565
  export declare enum ConnectedVehicleStatus {
563
566
  /** Vehicle was added to the Chargetrip Connect platform but not yet authorized */
564
567
  PENDING_AUTHORIZATION = "pending_authorization",
565
- /** Vehicle was authorized. Chargetrip can retrieve data on behave of the user */
568
+ /** Vehicle was authorized. Chargetrip can retrieve data on behalf of the user */
566
569
  AUTHORIZED = "authorized",
567
570
  /** Pending vehicle removal */
568
571
  PENDING_REMOVAL = "pending_removal",
@@ -571,35 +574,35 @@ export declare enum ConnectedVehicleStatus {
571
574
  }
572
575
  /** Connector data which extends OCPI Connector. */
573
576
  export declare type Connector = {
574
- /** Identifier of a connector within an EVSE. Two connectors may have the same ID as long as they do not belong to the same EVSE object. */
577
+ /** Identifier of a connector within an EVSE. Two connectors may have the same ID as long as they do not belong to the same EVSE object. This property is OCPI-compliant. */
575
578
  id?: Maybe<Scalars["String"]>;
576
- /** Standard of an installed connector. */
579
+ /** Standard of an installed connector. This property is OCPI-compliant. */
577
580
  standard?: Maybe<ConnectorType>;
578
- /** Format (socket/cable) of an installed connector. */
581
+ /** Format (socket/cable) of an installed connector. This property is OCPI-compliant. */
579
582
  format?: Maybe<OCPIConnectorFormat>;
580
- /** Type of power of an installed connector. */
583
+ /** Type of power of an installed connector. This property is OCPI-compliant. */
581
584
  power_type?: Maybe<OCPIPowerType>;
582
- /** Maximum voltage of an connector (line to neutral for AC_3_PHASE), in volt [V]. For example: DC Chargers might vary the voltage during charging when battery almost full. */
585
+ /** Maximum voltage of a connector (line to neutral for AC_3_PHASE), in volt [V]. For example: DC Chargers might vary the voltage during charging when battery almost full. This property is OCPI-compliant. */
583
586
  max_voltage?: Maybe<Scalars["Int"]>;
584
- /** Maximum amperage of a connector, in ampere [A]. */
587
+ /** Maximum amperage of a connector, in ampere [A]. This property is OCPI-compliant. */
585
588
  max_amperage?: Maybe<Scalars["Int"]>;
586
589
  /**
587
590
  * Maximum electric power that can be delivered by a connector, in watt [W]. When the maximum electric power is lower than the calculated value from voltage and amperage, this value should be set.
588
591
  * For example: A DC Charge Point which can deliver up to 920V and up to 400A can be limited to a maximum of 150kW. Depending on the vehicle, it may supply maximum voltage or current, but not both at the same time.
589
- * For AC Charge Points, the amount of phases used can also have influence on the maximum power.
592
+ * For AC Charge Points, the amount of phases used can also have influence on the maximum power. This property is OCPI-compliant.
590
593
  */
591
594
  max_electric_power?: Maybe<Scalars["Int"]>;
592
595
  /** Maximum electric power in kW. */
593
596
  power?: Maybe<Scalars["Float"]>;
594
597
  /**
595
- * Identifiers of the currently valid charging tariffs. Multiple tariffs are possible, but only one of each Tariff.type can be active at the same time. Tariffs with the same type are only allowed, if they are not active at the same time: start_date_time and end_date_time period not overlapping.
598
+ * Identifiers of the currently valid charging tariffs. Multiple tariffs are possible, but only one of each Tariff.type can be active at the same time. Tariffs with the same type are only allowed, if they are not active at the same time: `start_date_time` and `end_date_time` period not overlapping.
596
599
  * When preference-based smart charging is supported, one tariff for every possible ProfileType should be provided. This tells the user about the options they have at this Connector, and what the tariff is for every option.
597
- * For a "free of charge" tariff, this field should be set and point to a defined "free of charge" tariff.
600
+ * For a "free of charge" tariff, this field should be set and point to a defined "free of charge" tariff. This property is OCPI-compliant.
598
601
  */
599
602
  tariff_ids?: Maybe<Array<Maybe<Scalars["String"]>>>;
600
- /** URL to an operator’s terms and conditions. */
603
+ /** URL to an operator’s terms and conditions. This property is OCPI-compliant. */
601
604
  terms_and_conditions?: Maybe<Scalars["String"]>;
602
- /** Timestamp when a connector was last updated (or created). */
605
+ /** Timestamp when a connector was last updated (or created). This property is OCPI-compliant. */
603
606
  last_updated?: Maybe<Scalars["DateTime"]>;
604
607
  /** Optional object where you can store custom data you need in your application. This extends the current functionalities we offer. */
605
608
  properties?: Maybe<Scalars["JSON"]>;
@@ -655,8 +658,8 @@ export declare type ConnectorPriceElementComponent = {
655
658
  vat: Scalars["Float"];
656
659
  /**
657
660
  * Indicates the minimum amount that is billed.
658
- * A unit is billed in step-size blocks. For example, if the type is TIME and step_size is 300, then the time is billed in blocks of 5 minutes. Hence, if 6 minutes is used, then 10 minutes (2 blocks of step_size) is billed.
659
- * Note: step_size also depends on the type. Every type (except FLAT) defines a step_size multiplier. This is the size of every 'step' and the unit. For example, PARKING_TIME has a step-size multiplier of 1 second. Therefore, the step_size of a price component is multiplied by 1 second. Thus, step_size = 300 means 300 seconds."
661
+ * A unit is billed in step-size blocks. For example, if the `type` is TIME and `step_size` is 300, then the time is billed in blocks of 5 minutes. Hence, if 6 minutes is used, then 10 minutes (2 blocks of `step_size`) is billed.
662
+ * Note: `step_size` also depends on the `type`. Every `type` (except FLAT) defines a `step_size` multiplier. This is the size of every 'step' and the unit. For example, PARKING_TIME has a step-size multiplier of 1 second. Therefore, the `step_size` of a price component is multiplied by 1 second. Thus, `step_size` = 300 means 300 seconds.
660
663
  */
661
664
  step_size: Scalars["Int"];
662
665
  };
@@ -1687,31 +1690,31 @@ export declare enum DistanceUnit {
1687
1690
  /** EVSE data which extends OCPI EVSE. */
1688
1691
  export declare type EVSE = {
1689
1692
  /**
1690
- * Uniquely identifies an EVSE within the CPOs platform (and suboperator platforms). For example a database ID or the actual "EVSE ID". This field can never be changed, modified or renamed. This is the 'technical' identification of the EVSE, not to be used as 'human readable' identification, use the field evse_id for that.
1691
- * This field is named uid instead of id, because id could be confused with evse_id which is an eMI3 defined field.
1693
+ * Uniquely identifies an EVSE within the CPOs platform (and suboperator platforms). For example a database ID or the actual "EVSE ID". This field can never be changed, modified or renamed. This is the 'technical' identification of the EVSE, not to be used as 'human readable' identification, use the field `evse_id` for that.
1694
+ * This field is named `uid` instead of `id`, because `id` could be confused with `evse_id` which is an eMI3 defined field. This property is OCPI-compliant.
1692
1695
  */
1693
1696
  uid?: Maybe<Scalars["String"]>;
1694
- /** Compliant with the following specification for EVSE ID from "eMI3 standard version V1.0" (http://emi3group.com/documents-links/) "Part 2: business objects." Optional because: if an evse_id is to be re-used in the real world, the evse_id can be removed from an EVSE object if the status is set to REMOVED. */
1697
+ /** Compliant with the following specification for EVSE ID from "eMI3 standard version V1.0" (http://emi3group.com/documents-links/) "Part 2: business objects." Optional because: if an `evse_id` is to be re-used in the real world, the `evse_id` can be removed from an EVSE object if the status is set to REMOVED. This property is OCPI-compliant. */
1695
1698
  evse_id?: Maybe<Scalars["String"]>;
1696
- /** Indicates the current status of an EVSE. */
1699
+ /** Indicates the current status of an EVSE. This property is OCPI-compliant. */
1697
1700
  status?: Maybe<OCPIStatus>;
1698
- /** Indicates a planned status update of a nEVSE. */
1701
+ /** Indicates a planned status update of a nEVSE. This property is OCPI-compliant. */
1699
1702
  status_schedule?: Maybe<Array<Maybe<OCPIStatusSchedule>>>;
1700
- /** List of functionalities that an EVSE is capable of. */
1703
+ /** List of functionalities that an EVSE is capable of. This property is OCPI-compliant. */
1701
1704
  capabilities?: Maybe<Array<Maybe<OCPICapability>>>;
1702
- /** List of available connectors on an EVSE. */
1705
+ /** List of available connectors on an EVSE. This property is OCPI-compliant. */
1703
1706
  connectors?: Maybe<Array<Maybe<Connector>>>;
1704
- /** Level on which a Charge Point is located (in garage buildings) in the locally displayed numbering scheme. */
1707
+ /** Level on which a Charge Point is located (in garage buildings) in the locally displayed numbering scheme. This property is OCPI-compliant. */
1705
1708
  floor_level?: Maybe<Scalars["String"]>;
1706
- /** Coordinates of a EVSE. */
1709
+ /** Coordinates of a EVSE. This property is OCPI-compliant. */
1707
1710
  coordinates?: Maybe<OCPIGeoLocation>;
1708
- /** A number/string printed on the outside of an EVSE for visual identification. */
1711
+ /** A number/string printed on the outside of an EVSE for visual identification. This property is OCPI-compliant. */
1709
1712
  physical_reference?: Maybe<Scalars["String"]>;
1710
- /** Restrictions that apply to a parking spot. */
1713
+ /** Restrictions that apply to a parking spot. This property is OCPI-compliant. */
1711
1714
  parking_restrictions?: Maybe<Array<Maybe<OCPIParkingRestriction>>>;
1712
- /** Links to images related to an EVSE such as photos or logos. */
1715
+ /** Links to images related to an EVSE such as photos or logos. This property is OCPI-compliant. */
1713
1716
  images?: Maybe<Array<Maybe<OCPIImage>>>;
1714
- /** Timestamp when this EVSE or one of its Connectors was last updated (or created). */
1717
+ /** Timestamp when this EVSE or one of its Connectors was last updated (or created). This property is OCPI-compliant. */
1715
1718
  last_updated?: Maybe<Scalars["DateTime"]>;
1716
1719
  /** Indicates if parking is free or paid. */
1717
1720
  parking_cost?: Maybe<ParkingCost>;
@@ -1736,7 +1739,7 @@ export declare type ElevationInput = {
1736
1739
  value: Scalars["Float"];
1737
1740
  /** Preferred unit for the elevation. */
1738
1741
  type: DistanceUnit;
1739
- /** Source of inputted data, defaults to 'manual'. */
1742
+ /** Source of inputted data, defaults to `manual`. */
1740
1743
  source?: Maybe<TelemetryInputSource>;
1741
1744
  };
1742
1745
  export declare enum ElevationUnit {
@@ -1938,7 +1941,7 @@ export declare type Isoline = {
1938
1941
  status: IsolineStatus;
1939
1942
  /** Distance from the origin to the furthest reachable point within the isoline. Represents the longest drivable distance, not a straight-line or vehicle range. */
1940
1943
  maximum_distance?: Maybe<Scalars["Float"]>;
1941
- /** Shape of the isoline consisting in a list of multipolygons. */
1944
+ /** Shape of the isoline consisting of a list of multipolygons. */
1942
1945
  polygons?: Maybe<Array<Maybe<FeatureMultiPolygon>>>;
1943
1946
  /** List of the ferries uniting islands formed by the isoline. */
1944
1947
  ferries?: Maybe<Array<Maybe<FeatureLineString>>>;
@@ -1949,7 +1952,7 @@ export declare type Isolinemaximum_distanceArgs = {
1949
1952
  unit?: Maybe<DistanceUnit>;
1950
1953
  };
1951
1954
  export declare type IsolineCabin = {
1952
- /** Flag which indicate if the vehicle cabin was preconditioned for the desired temperature. */
1955
+ /** Flag which indicates if the vehicle cabin was preconditioned for the desired temperature. */
1953
1956
  is_preconditioned?: Maybe<Scalars["Boolean"]>;
1954
1957
  /** Desired temperature inside the cabin. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
1955
1958
  desired_temperature?: Maybe<Scalars["Float"]>;
@@ -1959,7 +1962,7 @@ export declare type IsolineCabindesired_temperatureArgs = {
1959
1962
  };
1960
1963
  /** Information about the cabin of the vehicle. */
1961
1964
  export declare type IsolineCabinInput = {
1962
- /** Flag which indicate if the vehicle cabin was preconditioned for the desired temperature. */
1965
+ /** Flag which indicates if the vehicle cabin was preconditioned for the desired temperature. */
1963
1966
  is_preconditioned?: Maybe<Scalars["Boolean"]>;
1964
1967
  /** Desired temperature inside the cabin. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
1965
1968
  desired_temperature?: Maybe<TemperatureInput>;
@@ -2036,7 +2039,7 @@ export declare type IsolineRequestInput = {
2036
2039
  cabin?: Maybe<IsolineCabin>;
2037
2040
  /**
2038
2041
  * Season taken into account when isoline was generated.
2039
- * @deprecated In favor of weather.
2042
+ * @deprecated In favor of `weather`.
2040
2043
  */
2041
2044
  season?: Maybe<RouteSeason>;
2042
2045
  /** Weather configuration for the isoline. Defined by a preset or custom weather conditions. */
@@ -2076,7 +2079,7 @@ export declare enum IsolineStatus {
2076
2079
  export declare type IsolineWeather = {
2077
2080
  /** Weather configuration applied to the isoline. */
2078
2081
  type: WeatherType;
2079
- /** [BETA] Custom weather conditions applied to the isoline. Only present when 'type' is set to 'CUSTOM'. */
2082
+ /** [BETA] Custom weather conditions applied to the isoline. Only present when `type` is set to `CUSTOM`. */
2080
2083
  custom?: Maybe<IsolineWeatherCustomConditions>;
2081
2084
  };
2082
2085
  export declare type IsolineWeatherCustomConditions = {
@@ -2098,7 +2101,7 @@ export declare type IsolineWeatherCustomConditionsInput = {
2098
2101
  export declare type IsolineWeatherInput = {
2099
2102
  /** Weather configuration applied within the isoline. */
2100
2103
  type?: Maybe<WeatherType>;
2101
- /** [BETA] Custom weather conditions to apply within the isoline. Required only when 'type' is 'CUSTOM'. Must be omitted for other weather types. */
2104
+ /** [BETA] Custom weather conditions to apply within the isoline. Required only when `type` is `CUSTOM`. Must be omitted for other weather types. */
2102
2105
  custom?: Maybe<IsolineWeatherCustomConditionsInput>;
2103
2106
  };
2104
2107
  /** Types of a leg. */
@@ -2719,7 +2722,7 @@ export declare type Mutation = {
2719
2722
  advanceNavigationLeg?: Maybe<Scalars["Boolean"]>;
2720
2723
  /**
2721
2724
  * Add a new review.
2722
- * If the `x-token` header is send for a valid user, the review will belong to it, otherwise will be added for an anonymouse user
2725
+ * If the `x-token` header is sent for a valid user, the review will belong to it, otherwise it will be added for an anonymous user.
2723
2726
  */
2724
2727
  addReview: Review;
2725
2728
  /**
@@ -2738,7 +2741,7 @@ export declare type Mutation = {
2738
2741
  /** Create a new route from the route input. */
2739
2742
  createRoute: Scalars["ID"];
2740
2743
  /** [ALPHA] Create a new truck route from the route input and its ID. */
2741
- createTruckRoute: Scalars["ID"];
2744
+ createTruckRoute?: Maybe<Scalars["ID"]>;
2742
2745
  /** [ALPHA] Creates route from a sequence of points. */
2743
2746
  createMatchedRoute?: Maybe<Scalars["ID"]>;
2744
2747
  };
@@ -2944,7 +2947,7 @@ export declare type NavigationPropertiesStationInput = {
2944
2947
  export declare type NavigationPropertiesVehicle = {
2945
2948
  /** Number of occupants present in the vehicle. */
2946
2949
  occupants: Scalars["Int"];
2947
- /** Combined weight of the occupants. This can only be used in combination with occupants. */
2950
+ /** Combined weight of the occupants. This can only be used in combination with `occupants`. */
2948
2951
  total_occupant_weight: TotalOccupantWeight;
2949
2952
  /** Weight of the cargo. */
2950
2953
  total_cargo_weight?: Maybe<TotalCargoWeight>;
@@ -2952,7 +2955,7 @@ export declare type NavigationPropertiesVehicle = {
2952
2955
  export declare type NavigationPropertiesVehicleInput = {
2953
2956
  /** Number of occupants present in the vehicle. */
2954
2957
  occupants?: Maybe<Scalars["Int"]>;
2955
- /** Combined weight of the occupants. This can only be used in combination with occupants. */
2958
+ /** Combined weight of the occupants. This can only be used in combination with `occupants`. */
2956
2959
  total_occupant_weight?: Maybe<TotalOccupantWeightInput>;
2957
2960
  /** Weight of the cargo. */
2958
2961
  total_cargo_weight?: Maybe<TotalCargoWeightInput>;
@@ -3164,11 +3167,11 @@ export declare type NavigationViaPropertiesInput = {
3164
3167
  };
3165
3168
  /** This class defines an additional geo location that is relevant for the Charge Point. The geodetic system to be used is WGS 84. */
3166
3169
  export declare type OCPIAdditionalGeoLocation = {
3167
- /** Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}\.[0-9]{5,7} */
3170
+ /** Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}\.[0-9]{5,7}. This property is OCPI-compliant. */
3168
3171
  latitude?: Maybe<Scalars["String"]>;
3169
- /** Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}\.[0-9]{5,7} */
3172
+ /** Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}\.[0-9]{5,7}. This property is OCPI-compliant. */
3170
3173
  longitude?: Maybe<Scalars["String"]>;
3171
- /** Name of the point in local language or as written at the location. For example the street name of a parking lot entrance or it’s number. */
3174
+ /** Name of the point in local language or as written at the location. For example the street name of a parking lot entrance or it’s number. This property is OCPI-compliant. */
3172
3175
  name?: Maybe<OCPIDisplayText>;
3173
3176
  };
3174
3177
  /** The capabilities of an EVSE. */
@@ -3197,7 +3200,7 @@ export declare enum OCPICapability {
3197
3200
  TOKEN_GROUP_CAPABLE = "TOKEN_GROUP_CAPABLE",
3198
3201
  /** Connectors have a mechanical lock that can be requested by the eMSP to be unlocked. */
3199
3202
  UNLOCK_CAPABLE = "UNLOCK_CAPABLE",
3200
- /** When a StartSession is sent to this EVSE, the MSP is required to add the optional connector_id field in the StartSession object. */
3203
+ /** When a StartSession is sent to this EVSE, the MSP is required to add the optional `connector_id` field in the StartSession object. */
3201
3204
  START_SESSION_CONNECTOR_REQUIRED = "START_SESSION_CONNECTOR_REQUIRED"
3202
3205
  }
3203
3206
  /** The format of the connector, whether it is a socket or a plug. */
@@ -3217,28 +3220,28 @@ export declare enum OCPIDayOfWeek {
3217
3220
  SUNDAY = "SUNDAY"
3218
3221
  }
3219
3222
  export declare type OCPIDisplayText = {
3220
- /** Language Code ISO 639-1 */
3223
+ /** Language Code ISO 639-1. This property is OCPI-compliant. */
3221
3224
  language?: Maybe<Scalars["String"]>;
3222
- /** Text to be displayed to an end user. No markup, html etc. allowed. */
3225
+ /** Text to be displayed to an end user. No markup, html etc. allowed. This property is OCPI-compliant. */
3223
3226
  text?: Maybe<Scalars["String"]>;
3224
3227
  };
3225
3228
  /** This type is used to specify the energy mix and environmental impact of the supplied energy at a location or in a tariff. */
3226
3229
  export declare type OCPIEnergyMix = {
3227
- /** True if the power is 100% from regenerative sources */
3230
+ /** True if the power is 100% from regenerative sources. This property is OCPI-compliant. */
3228
3231
  is_green_energy?: Maybe<Scalars["Boolean"]>;
3229
- /** Key-value pairs (enum + percentage) of energy sources of this location’s tariff. */
3232
+ /** Key-value pairs (enum + percentage) of energy sources of this location’s tariff. This property is OCPI-compliant. */
3230
3233
  energy_sources?: Maybe<Array<Maybe<OCPIEnergySource>>>;
3231
- /** Key-value pairs (enum + percentage) of nuclear waste and CO2 exhaust of this location’s tariff. */
3234
+ /** Key-value pairs (enum + percentage) of nuclear waste and CO2 exhaust of this location’s tariff. This property is OCPI-compliant. */
3232
3235
  environ_impact?: Maybe<Array<Maybe<OCPIEnvironmentalImpact>>>;
3233
- /** Name of the energy supplier, delivering the energy for this location or tariff.* */
3236
+ /** Name of the energy supplier, delivering the energy for this location or tariff.*. This property is OCPI-compliant. */
3234
3237
  supplier_name?: Maybe<Scalars["String"]>;
3235
- /** Name of the energy suppliers product/tariff plan used at this location.* */
3238
+ /** Name of the energy suppliers product/tariff plan used at this location.*. This property is OCPI-compliant. */
3236
3239
  energy_product_name?: Maybe<Scalars["String"]>;
3237
3240
  };
3238
3241
  export declare type OCPIEnergySource = {
3239
- /** The type of energy source. */
3242
+ /** The type of energy source. This property is OCPI-compliant. */
3240
3243
  source?: Maybe<OCPIEnergySourceCategory>;
3241
- /** Percentage of this source (0-100) in the mix. */
3244
+ /** Percentage of this source (0-100) in the mix. This property is OCPI-compliant. */
3242
3245
  percentage?: Maybe<Scalars["Int"]>;
3243
3246
  };
3244
3247
  /** Categories of energy sources. */
@@ -3262,9 +3265,9 @@ export declare enum OCPIEnergySourceCategory {
3262
3265
  }
3263
3266
  /** Amount of waste produced/emitted per kWh. */
3264
3267
  export declare type OCPIEnvironmentalImpact = {
3265
- /** The environmental impact category of this value. */
3268
+ /** The environmental impact category of this value. This property is OCPI-compliant. */
3266
3269
  category?: Maybe<OCPIEnvironmentalImpactCategory>;
3267
- /** Amount of this portion in g/kWh. */
3270
+ /** Amount of this portion in g/kWh. This property is OCPI-compliant. */
3268
3271
  amount?: Maybe<Scalars["Float"]>;
3269
3272
  };
3270
3273
  /** Categories of environmental impact values. */
@@ -3276,9 +3279,9 @@ export declare enum OCPIEnvironmentalImpactCategory {
3276
3279
  }
3277
3280
  /** Specifies one exceptional period for opening or access hours. */
3278
3281
  export declare type OCPIExceptionalPeriod = {
3279
- /** Begin of the exception. In UTC, time_zone field can be used to convert to local time. */
3282
+ /** Begin of the exception. In UTC, `time_zone` field can be used to convert to local time. This property is OCPI-compliant. */
3280
3283
  period_begin?: Maybe<Scalars["DateTime"]>;
3281
- /** End of the exception. In UTC, time_zone field can be used to convert to local time. */
3284
+ /** End of the exception. In UTC, `time_zone` field can be used to convert to local time. This property is OCPI-compliant. */
3282
3285
  period_end?: Maybe<Scalars["DateTime"]>;
3283
3286
  };
3284
3287
  export declare enum OCPIFacility {
@@ -3325,34 +3328,34 @@ export declare enum OCPIFacility {
3325
3328
  }
3326
3329
  /** This class defines the geo location of the Charge Point. The geodetic system to be used is WGS 84. */
3327
3330
  export declare type OCPIGeoLocation = {
3328
- /** Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}\.[0-9]{5,7} */
3331
+ /** Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}\.[0-9]{5,7}. This property is OCPI-compliant. */
3329
3332
  latitude?: Maybe<Scalars["String"]>;
3330
- /** Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}\.[0-9]{5,7} */
3333
+ /** Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}\.[0-9]{5,7}. This property is OCPI-compliant. */
3331
3334
  longitude?: Maybe<Scalars["String"]>;
3332
3335
  };
3333
3336
  /** Opening and access hours of the location. */
3334
3337
  export declare type OCPIHours = {
3335
- /** True to represent 24 hours a day and 7 days a week, except the given exceptions. */
3338
+ /** True to represent 24 hours a day and 7 days a week, except the given exceptions. This property is OCPI-compliant. */
3336
3339
  twentyfourseven?: Maybe<Scalars["Boolean"]>;
3337
- /** Regular hours, weekday-based. Only to be used if twentyfourseven=false, then this field needs to contain at least one RegularHours object. */
3340
+ /** Regular hours, weekday-based. Only to be used if `twentyfourseven` = false, then this field needs to contain at least one RegularHours object. This property is OCPI-compliant. */
3338
3341
  regular_hours?: Maybe<Array<Maybe<OCPIRegularHours>>>;
3339
- /** Exceptions for specified calendar dates, time-range based. Periods the station is operating/accessible. Additional to regular_hours. May overlap regular rules. */
3342
+ /** Exceptions for specified calendar dates, time-range based. Periods the station is operating/accessible. Additional to `regular_hours`. May overlap regular rules. This property is OCPI-compliant. */
3340
3343
  exceptional_openings?: Maybe<Array<Maybe<OCPIExceptionalPeriod>>>;
3341
- /** Exceptions for specified calendar dates, time-range based. Periods the station is not operating/accessible. Overwriting regular_hours and exceptional_openings. Should not overlap exceptional_openings. */
3344
+ /** Exceptions for specified calendar dates, time-range based. Periods the station is not operating/accessible. Overwriting `regular_hours` and `exceptional_openings`. Should not overlap `exceptional_openings`. This property is OCPI-compliant. */
3342
3345
  exceptional_closings?: Maybe<Array<Maybe<OCPIExceptionalPeriod>>>;
3343
3346
  };
3344
3347
  export declare type OCPIImage = {
3345
- /** URL from where the image data can be fetched through a web browser. */
3348
+ /** URL from where the image data can be fetched through a web browser. This property is OCPI-compliant. */
3346
3349
  url?: Maybe<Scalars["String"]>;
3347
- /** URL from where a thumbnail of the image can be fetched through a webbrowser. */
3350
+ /** URL from where a thumbnail of the image can be fetched through a webbrowser. This property is OCPI-compliant. */
3348
3351
  thumbnail?: Maybe<Scalars["String"]>;
3349
- /** Category of an image */
3352
+ /** Category of an image. This property is OCPI-compliant. */
3350
3353
  category?: Maybe<OCPIImageCategory>;
3351
- /** Image type: gif, jpeg, png, svg */
3354
+ /** Image type: gif, jpeg, png, svg. This property is OCPI-compliant. */
3352
3355
  type?: Maybe<Scalars["String"]>;
3353
- /** Width of the full scale image */
3356
+ /** Width of the full scale image. This property is OCPI-compliant. */
3354
3357
  width?: Maybe<Scalars["Int"]>;
3355
- /** Height of the full scale image */
3358
+ /** Height of the full scale image. This property is OCPI-compliant. */
3356
3359
  height?: Maybe<Scalars["Int"]>;
3357
3360
  };
3358
3361
  /** The category of an image to obtain the correct usage in a user presentation. The category has to be set accordingly to the image content in order to guarantee the right usage. */
@@ -3413,28 +3416,28 @@ export declare enum OCPIPowerType {
3413
3416
  DC = "DC"
3414
3417
  }
3415
3418
  export declare type OCPIPrice = {
3416
- /** Price/Cost excluding VAT. */
3419
+ /** Price/Cost excluding VAT. This property is OCPI-compliant. */
3417
3420
  excl_vat?: Maybe<Scalars["Float"]>;
3418
- /** Price/Cost including VAT. */
3421
+ /** Price/Cost including VAT. This property is OCPI-compliant. */
3419
3422
  incl_vat?: Maybe<Scalars["Float"]>;
3420
3423
  };
3421
3424
  export declare type OCPIPriceComponent = {
3422
- /** Type of tariff dimension. */
3425
+ /** Type of tariff dimension. This property is OCPI-compliant. */
3423
3426
  type?: Maybe<OCPITariffDimensionType>;
3424
- /** Price per unit (excl. VAT) for this tariff dimension. */
3427
+ /** Price per unit (excl. VAT) for this tariff dimension. This property is OCPI-compliant. */
3425
3428
  price?: Maybe<Scalars["Float"]>;
3426
- /** Applicable VAT percentage for this tariff dimension. If omitted, no VAT is applicable. Not providing a VAT is different from 0% VAT, which would be a value of 0.0 here. */
3429
+ /** Applicable VAT percentage for this tariff dimension. If omitted, no VAT is applicable. Not providing a VAT is different from 0% VAT, which would be a value of 0.0 here. This property is OCPI-compliant. */
3427
3430
  vat?: Maybe<Scalars["Float"]>;
3428
- /** Minimum amount to be billed. This unit will be billed in this step_size blocks. For example: if type is TIME and step_size has a value of 300, then time will be billed in blocks of 5 minutes. If 6 minutes were used, 10 minutes (2 blocks of step_size) will be billed. */
3431
+ /** Minimum amount to be billed. This unit will be billed in this `step_size` blocks. For example: if `type` is TIME and `step_size` has a value of 300, then time will be billed in blocks of 5 minutes. If 6 minutes were used, 10 minutes (2 blocks of `step_size`) will be billed. This property is OCPI-compliant. */
3429
3432
  step_size?: Maybe<Scalars["Int"]>;
3430
3433
  };
3431
3434
  /** Regular recurring operation or access hours. */
3432
3435
  export declare type OCPIRegularHours = {
3433
- /** Number of days in the week, from Monday (1) till Sunday (7) */
3436
+ /** Number of days in the week, from Monday (1) till Sunday (7). This property is OCPI-compliant. */
3434
3437
  weekday?: Maybe<Scalars["Int"]>;
3435
- /** Begin of the regular period, in local time, given in hours and minutes. Must be in 24h format with leading zeros. Example: "18:15". Hour/Minute separator: ":" Regex: ([0-1][0-9]|2[1-3]):[0-5][0-9]. */
3438
+ /** Begin of the regular period, in local time, given in hours and minutes. Must be in 24h format with leading zeros. Example: "18:15". Hour/Minute separator: ":" Regex: ([0-1][0-9]|2[1-3]):[0-5][0-9]. This property is OCPI-compliant. */
3436
3439
  period_begin?: Maybe<Scalars["String"]>;
3437
- /** End of the regular period, in local time, syntax as for period_begin. Must be later than period_begin. */
3440
+ /** End of the regular period, in local time, syntax as for period_begin. Must be later than period_begin. This property is OCPI-compliant. */
3438
3441
  period_end?: Maybe<Scalars["String"]>;
3439
3442
  };
3440
3443
  export declare enum OCPIReservationRestrictionType {
@@ -3466,87 +3469,87 @@ export declare enum OCPIStatus {
3466
3469
  }
3467
3470
  /** This type is used to schedule status periods in the future. The eMSP can provide this information to the EV user for trip planning purposes. A period MAY have no end. Example: "This station will be running as of tomorrow. Today it is still planned and under construction. */
3468
3471
  export declare type OCPIStatusSchedule = {
3469
- /** Begin of the scheduled period. */
3472
+ /** Begin of the scheduled period. This property is OCPI-compliant. */
3470
3473
  period_begin?: Maybe<Scalars["DateTime"]>;
3471
- /** End of the scheduled period, if known. */
3474
+ /** End of the scheduled period, if known. This property is OCPI-compliant. */
3472
3475
  period_end?: Maybe<Scalars["DateTime"]>;
3473
- /** Status value during the scheduled period. */
3476
+ /** Status value during the scheduled period. This property is OCPI-compliant. */
3474
3477
  status?: Maybe<OCPIStatus>;
3475
3478
  };
3476
3479
  export declare type OCPITariff = {
3477
- /** ISO-3166 alpha-2 country code of the CPO that owns this tariff */
3480
+ /** ISO-3166 alpha-2 country code of the CPO that owns this tariff. This property is OCPI-compliant. */
3478
3481
  country_code?: Maybe<Scalars["String"]>;
3479
- /** CPO ID of the CPO that owns this tariff (following the ISO-15118 standard) */
3482
+ /** CPO ID of the CPO that owns this tariff (following the ISO-15118 standard). This property is OCPI-compliant. */
3480
3483
  party_id?: Maybe<Scalars["String"]>;
3481
- /** Uniquely identifies the tariff within the CPO’s platform (and suboperator platforms) */
3484
+ /** Uniquely identifies the tariff within the CPO’s platform (and suboperator platforms). This property is OCPI-compliant. */
3482
3485
  id?: Maybe<Scalars["String"]>;
3483
- /** ISO-4217 code of the currency of this tariff. */
3486
+ /** ISO-4217 code of the currency of this tariff. This property is OCPI-compliant. */
3484
3487
  currency?: Maybe<Scalars["String"]>;
3485
- /** Defines the type of the tariff. This allows for distinction in case of given charging preferences. When omitted, this tariff is valid for all sessions */
3488
+ /** Defines the type of the tariff. This allows for distinction in case of given charging preferences. When omitted, this tariff is valid for all sessions. This property is OCPI-compliant. */
3486
3489
  type?: Maybe<OCPITariffType>;
3487
- /** List of alternative tariff information texts, in multiple languages */
3490
+ /** List of alternative tariff information texts, in multiple languages. This property is OCPI-compliant. */
3488
3491
  tariff_alt_text?: Maybe<Array<Maybe<OCPIDisplayText>>>;
3489
- /** URL to a web page that contains an explanation of the tariff information in human readable form */
3492
+ /** URL to a web page that contains an explanation of the tariff information in human readable form. This property is OCPI-compliant. */
3490
3493
  tariff_alt_url?: Maybe<Scalars["String"]>;
3491
- /** When this field is set, a charging session with this tariff will cost at least the amount shown. This is different from a FLAT fee (start tariff, transaction fee), as a FLAT fee is a fixed amount that must be paid for any charging session. A minimum price indicates that when the cost of a charging session is lower than this amount, the cost of the session will be equal to this amount */
3494
+ /** When this field is set, a charging session with this tariff will cost at least the amount shown. This is different from a FLAT fee (start tariff, transaction fee), as a FLAT fee is a fixed amount that must be paid for any charging session. A minimum price indicates that when the cost of a charging session is lower than this amount, the cost of the session will be equal to this amount. This property is OCPI-compliant. */
3492
3495
  min_price?: Maybe<OCPIPrice>;
3493
- /** When this field is set, a charging session with this tariff will NOT cost more than this amount */
3496
+ /** When this field is set, a charging session with this tariff will NOT cost more than this amount. This property is OCPI-compliant. */
3494
3497
  max_price?: Maybe<OCPIPrice>;
3495
- /** List of tariff elements */
3498
+ /** List of tariff elements. This property is OCPI-compliant. */
3496
3499
  elements?: Maybe<Array<Maybe<OCPITariffElement>>>;
3497
- /** Time when this tariff becomes active, in UTC, time_zone field of the Location can be used to convert to local time. Typically used for a new tariff that is already given with the location, before it becomes active */
3500
+ /** Time when this tariff becomes active, in UTC, `time_zone` field of the Location can be used to convert to local time. Typically used for a new tariff that is already given with the location, before it becomes active. This property is OCPI-compliant. */
3498
3501
  start_date_time?: Maybe<Scalars["DateTime"]>;
3499
- /** Time after which this tariff is no longer valid, in UTC, time_zone field if the location can be used to convert to local time. Typically used when this tariff is going to be replaced with a different tariff in the near future */
3502
+ /** Time after which this tariff is no longer valid, in UTC, `time_zone` field of the location can be used to convert to local time. Typically used when this tariff is going to be replaced with a different tariff in the near future. This property is OCPI-compliant. */
3500
3503
  end_date_time?: Maybe<Scalars["DateTime"]>;
3501
- /** Details about the energy supplied with this tariff */
3504
+ /** Details about the energy supplied with this tariff. This property is OCPI-compliant. */
3502
3505
  energy_mix?: Maybe<OCPIEnergyMix>;
3503
- /** Timestamp when this tariff was last updated (or created) */
3506
+ /** Timestamp when this tariff was last updated (or created). This property is OCPI-compliant. */
3504
3507
  last_updated?: Maybe<Scalars["DateTime"]>;
3505
3508
  };
3506
3509
  export declare enum OCPITariffDimensionType {
3507
- /** Defined in kWh, step_size multiplier: 1 Wh */
3510
+ /** Defined in kWh, `step_size` multiplier: 1 Wh */
3508
3511
  ENERGY = "ENERGY",
3509
- /** Flat fee without unit for step_size */
3512
+ /** Flat fee without unit for `step_size` */
3510
3513
  FLAT = "FLAT",
3511
- /** Time not charging: defined in hours, step_size multiplier: 1 second */
3514
+ /** Time not charging: defined in hours, `step_size` multiplier: 1 second */
3512
3515
  PARKING_TIME = "PARKING_TIME",
3513
- /** Time charging: defined in hours, step_size multiplier: 1 second Can also be used in combination with a RESERVATION restriction to describe the price of the reservation time. */
3516
+ /** Time charging: defined in hours, `step_size` multiplier: 1 second. Can also be used in combination with a RESERVATION restriction to describe the price of the reservation time. */
3514
3517
  TIME = "TIME"
3515
3518
  }
3516
3519
  export declare type OCPITariffElement = {
3517
- /** List of price components that describe the pricing of a tariff. */
3520
+ /** List of price components that describe the pricing of a tariff. This property is OCPI-compliant. */
3518
3521
  price_components?: Maybe<Array<Maybe<OCPIPriceComponent>>>;
3519
- /** Restrictions that describe the applicability of a tariff. */
3522
+ /** Restrictions that describe the applicability of a tariff. This property is OCPI-compliant. */
3520
3523
  restrictions?: Maybe<Array<Maybe<OCPITariffRestrictions>>>;
3521
3524
  };
3522
3525
  export declare type OCPITariffRestrictions = {
3523
- /** Start time of day in local time, the time zone is defined in the time_zone field of the Location, for example 13:30, valid from this time of the day. Must be in 24h format with leading zeros. Hour/Minute separator: ":" Regex: ([0-1][0-9]|2[1-3]):[0-5][0-9] */
3526
+ /** Start time of day in local time, the time zone is defined in the `time_zone` field of the Location, for example 13:30, valid from this time of the day. Must be in 24h format with leading zeros. Hour/Minute separator: ":" Regex: ([0-1][0-9]|2[1-3]):[0-5][0-9]. This property is OCPI-compliant. */
3524
3527
  start_time?: Maybe<Scalars["String"]>;
3525
- /** End time of day in local time, the time zone is defined in the time_zone field of the Location, for example 19:45, valid until this time of the day. Same syntax as start_time. */
3528
+ /** End time of day in local time, the time zone is defined in the `time_zone` field of the Location, for example 19:45, valid until this time of the day. Same syntax as `start_time`. This property is OCPI-compliant. */
3526
3529
  end_time?: Maybe<Scalars["String"]>;
3527
- /** Start date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-24, valid from this day. Regex: ([12][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) */
3530
+ /** Start date in local time, the time zone is defined in the `time_zone` field of the Location, for example: 2015-12-24, valid from this day. Regex: ([12][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]). This property is OCPI-compliant. */
3528
3531
  start_date?: Maybe<Scalars["String"]>;
3529
- /** End date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-27, valid until this day (exclusive). Same syntax as start_date */
3532
+ /** End date in local time, the time zone is defined in the `time_zone` field of the Location, for example: 2015-12-27, valid until this day (exclusive). Same syntax as `start_date`. This property is OCPI-compliant. */
3530
3533
  end_date?: Maybe<Scalars["String"]>;
3531
- /** Minimum consumed energy in kWh, for example 20, valid from this amount of energy being used */
3534
+ /** Minimum consumed energy in kWh, for example 20, valid from this amount of energy being used. This property is OCPI-compliant. */
3532
3535
  min_kwh?: Maybe<Scalars["Float"]>;
3533
- /** Maximum consumed energy in kWh, for example 50, valid until this amount of energy being used */
3536
+ /** Maximum consumed energy in kWh, for example 50, valid until this amount of energy being used. This property is OCPI-compliant. */
3534
3537
  max_kwh?: Maybe<Scalars["Float"]>;
3535
- /** Sum of the minimum current in over all phases, for example 5. When the EV is charging with more than the defined amount of current, this tariff element is/becomes active. If the charging current is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum current over the entire charging session. This restriction can make a tariff element become active when the charging current is above the defined value, but the tariff element MUST no longer be active when the charging current drops below the defined value */
3538
+ /** Sum of the minimum current in over all phases, for example 5. When the EV is charging with more than the defined amount of current, this tariff element is/becomes active. If the charging current is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum current over the entire charging session. This restriction can make a tariff element become active when the charging current is above the defined value, but the tariff element MUST no longer be active when the charging current drops below the defined value. This property is OCPI-compliant. */
3536
3539
  min_current?: Maybe<Scalars["Float"]>;
3537
- /** Sum of the maximum current in over all phases, for example 20. When the EV is charging with less than the defined amount of current, this tariff element becomes/is active. If the charging current is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This describes NOT the maximum current over the entire Charging Session. This restriction can make a tariff element become active when the charging current is below this value, but the tariff element MUST no longer be active when the charging current raises above the defined value */
3540
+ /** Sum of the maximum current in over all phases, for example 20. When the EV is charging with less than the defined amount of current, this tariff element becomes/is active. If the charging current is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This describes NOT the maximum current over the entire Charging Session. This restriction can make a tariff element become active when the charging current is below this value, but the tariff element MUST no longer be active when the charging current rises above the defined value. This property is OCPI-compliant. */
3538
3541
  max_current?: Maybe<Scalars["Float"]>;
3539
- /** Minimum power in kW, for example 5. When the EV is charging with more than the defined amount of power, this tariff element is/becomes active. If the charging power is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum power over the entire charging session. This restriction can make a tariff element become active when the charging power is above this value, but the TariffElement MUST no longer be active when the charging power drops below the defined value */
3542
+ /** Minimum power in kW, for example 5. When the EV is charging with more than the defined amount of power, this tariff element is/becomes active. If the charging power is or becomes lower, this tariff element is not or no longer valid and becomes inactive. This does not describe the minimum power over the entire charging session. This restriction can make a tariff element become active when the charging power is above this value, but the TariffElement MUST no longer be active when the charging power drops below the defined value. This property is OCPI-compliant. */
3540
3543
  min_power?: Maybe<Scalars["Float"]>;
3541
- /** Maximum power in kW, for example 20. When the EV is charging with less than the defined amount of power, this tariff element becomes/is active. If the charging power is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This does not describe the maximum power over the entire charging session. This restriction can make a tariff element become active when the charging power is below this value, but the TariffElement MUST no longer be active when the charging power raises above the defined value */
3544
+ /** Maximum power in kW, for example 20. When the EV is charging with less than the defined amount of power, this tariff element becomes/is active. If the charging power is or becomes higher, this tariff element is not or no longer valid and becomes inactive. This does not describe the maximum power over the entire charging session. This restriction can make a tariff element become active when the charging power is below this value, but the TariffElement MUST no longer be active when the charging power rises above the defined value. This property is OCPI-compliant. */
3542
3545
  max_power?: Maybe<Scalars["Float"]>;
3543
- /** Minimum duration in seconds the charging session MUST last (inclusive). When the duration of a charging session is longer than the defined value, this TariffElement is or becomes active. Before that moment, this tariff element is not yet active */
3546
+ /** Minimum duration in seconds the charging session MUST last (inclusive). When the duration of a charging session is longer than the defined value, this TariffElement is or becomes active. Before that moment, this tariff element is not yet active. This property is OCPI-compliant. */
3544
3547
  min_duration?: Maybe<Scalars["Float"]>;
3545
- /** Maximum duration in seconds the charging session MUST last (exclusive). When the duration of a charging session is shorter than the defined value, this tariff element is or becomes active. After that moment, this tariff element is no longer active */
3548
+ /** Maximum duration in seconds the charging session MUST last (exclusive). When the duration of a charging session is shorter than the defined value, this tariff element is or becomes active. After that moment, this tariff element is no longer active. This property is OCPI-compliant. */
3546
3549
  max_duration?: Maybe<Scalars["Float"]>;
3547
- /** Which day(s) of the week this tariff element is active. */
3550
+ /** Which day(s) of the week this tariff element is active. This property is OCPI-compliant. */
3548
3551
  day_of_week?: Maybe<OCPIDayOfWeek>;
3549
- /** When this field is present, the tariff element describes reservation costs. A reservation starts when the reservation is made, and ends when the drivers starts charging on the reserved EVSE/Location, or when the reservation expires. A reservation can only have: FLAT and TIME TariffDimensions, where TIME is for the duration of the reservation */
3552
+ /** When this field is present, the tariff element describes reservation costs. A reservation starts when the reservation is made, and ends when the drivers starts charging on the reserved EVSE/Location, or when the reservation expires. A reservation can only have: FLAT and TIME TariffDimensions, where TIME is for the duration of the reservation. This property is OCPI-compliant. */
3550
3553
  reservation?: Maybe<OCPIReservationRestrictionType>;
3551
3554
  };
3552
3555
  export declare enum OCPITariffType {
@@ -3649,7 +3652,7 @@ export declare type OdometerInput = {
3649
3652
  value: Scalars["Float"];
3650
3653
  /** Preferred unit for the vehicle's odometer. */
3651
3654
  type: DistanceUnit;
3652
- /** Source of inputted data, defaults to 'manual'. */
3655
+ /** Source of inputted data, defaults to `manual`. */
3653
3656
  source?: Maybe<TelemetryInputSource>;
3654
3657
  };
3655
3658
  /** Operator data which extends OCPI BusinessDetails. */
@@ -3658,11 +3661,11 @@ export declare type Operator = {
3658
3661
  id?: Maybe<Scalars["ID"]>;
3659
3662
  /** External ID of an operator provided by the operator data source. */
3660
3663
  external_id?: Maybe<Scalars["String"]>;
3661
- /** Name of an operator. */
3664
+ /** Name of an operator. This property is OCPI-compliant. */
3662
3665
  name?: Maybe<Scalars["String"]>;
3663
- /** Link to an operator’s website. */
3666
+ /** Link to an operator’s website. This property is OCPI-compliant. */
3664
3667
  website?: Maybe<Scalars["String"]>;
3665
- /** Image link to an operator’s logo. */
3668
+ /** Image link to an operator’s logo. This property is OCPI-compliant. */
3666
3669
  logo?: Maybe<OCPIImage>;
3667
3670
  /**
3668
3671
  * ISO-3166 alpha-2 country code an operator is active in.
@@ -3674,33 +3677,33 @@ export declare type Operator = {
3674
3677
  /** Contact information. */
3675
3678
  contact?: Maybe<Contact>;
3676
3679
  /**
3677
- * 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.
3680
+ * 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.
3678
3681
  * @deprecated In favor of `ranking_levels`.
3679
3682
  */
3680
3683
  ranking?: Maybe<Scalars["Int"]>;
3681
3684
  /**
3682
- * 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.
3685
+ * 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.
3683
3686
  * @deprecated In favor of `excluded_countries`.
3684
3687
  */
3685
3688
  excluded?: Maybe<Scalars["Boolean"]>;
3686
- /** 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. */
3689
+ /** 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. */
3687
3690
  ranking_levels?: Maybe<OperatorRankingLevels>;
3688
- /** 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. */
3691
+ /** 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. */
3689
3692
  excluded_countries?: Maybe<Array<CountryCodeAlpha2>>;
3690
- /** List of countries where the operator is avoided. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request. */
3693
+ /** List of countries where the operator is avoided. Default operator preference applied to routes created through `createRoute` mutation if no operator preference is specified in the request. */
3691
3694
  avoided_countries?: Maybe<Array<CountryCodeAlpha2>>;
3692
3695
  };
3693
3696
  /** Criteria to filter operators in the operator list query. */
3694
3697
  export declare type OperatorListFilter = {
3695
3698
  /** ISO-3166 alpha-2 country codes an operator is active in. */
3696
3699
  countries?: Maybe<Array<CountryCodeAlpha2>>;
3697
- /** List of ranking level(s) to be retrieved. Valid values are 1 to 10. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request. */
3700
+ /** List of ranking level(s) to be retrieved. Valid values are 1 to 10. Default operator preference applied to routes created through `newRoute` mutation if no operator preference is specified in the request. */
3698
3701
  ranking?: Maybe<Array<Scalars["Int"]>>;
3699
- /** Only retrieve operators that are in the excluded list. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request. */
3702
+ /** Only retrieve operators that are in the excluded list. Default operator preference applied to routes created through `newRoute` mutation if no operator preference is specified in the request. */
3700
3703
  excluded?: Maybe<Scalars["Boolean"]>;
3701
- /** 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. */
3704
+ /** 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. */
3702
3705
  ranking_levels?: Maybe<OperatorRankingLevelsFilter>;
3703
- /** 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. */
3706
+ /** 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. */
3704
3707
  excluded_countries?: Maybe<Array<CountryCodeAlpha2>>;
3705
3708
  };
3706
3709
  /** Query parameters to filter operators in the operator list query. */
@@ -3730,7 +3733,7 @@ export declare enum OperatorRankingLevel {
3730
3733
  MEDIUM = "medium",
3731
3734
  HIGH = "high"
3732
3735
  }
3733
- /** 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. */
3736
+ /** 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. */
3734
3737
  export declare type OperatorRankingLevels = {
3735
3738
  /** Low level for operators ranking. */
3736
3739
  low?: Maybe<Array<CountryCodeAlpha2>>;
@@ -3753,7 +3756,7 @@ export declare type OutsideTempInput = {
3753
3756
  value: Scalars["Float"];
3754
3757
  /** Preferred unit for the outside temperature. */
3755
3758
  type: TemperatureUnit;
3756
- /** Source of inputted data, defaults to 'manual'. */
3759
+ /** Source of inputted data, defaults to `manual`. */
3757
3760
  source?: Maybe<TelemetryInputSource>;
3758
3761
  };
3759
3762
  export declare type OutsideTemperature = {
@@ -3838,7 +3841,7 @@ export declare type PowerInput = {
3838
3841
  value: Scalars["Float"];
3839
3842
  /** Preferred unit for the power. */
3840
3843
  type: PowerUnit;
3841
- /** Source of inputted data, defaults to 'manual'. */
3844
+ /** Source of inputted data, defaults to `manual`. */
3842
3845
  source?: Maybe<TelemetryInputSource>;
3843
3846
  };
3844
3847
  export declare enum PowerSupported {
@@ -3908,7 +3911,7 @@ export declare type PricingListProduct = {
3908
3911
  export declare type Query = {
3909
3912
  /** Get a full list of amenities around a station. */
3910
3913
  amenityList?: Maybe<Array<Maybe<Amenity>>>;
3911
- /** [BETA] Get a connected vehicles by id */
3914
+ /** [BETA] Get a connected vehicle by ID. */
3912
3915
  connectedVehicle?: Maybe<ConnectedVehicle>;
3913
3916
  /** [BETA] Get the connected vehicles for the current user */
3914
3917
  connectedVehicleList?: Maybe<Array<Maybe<ConnectedVehicle>>>;
@@ -3950,9 +3953,9 @@ export declare type Query = {
3950
3953
  /** Get a route by ID. */
3951
3954
  getRoute: RouteResponse;
3952
3955
  /** [BETA] Search for stations with amenities within a specific time window and distance of a previously calculated route. */
3953
- getRouteStationsWithAmenities: RouteStationsWithAmenitiesConnection;
3954
- /** [ALPHA] Get a e-truck route by ID. */
3955
- getTruckRoute: TruckRouteResponse;
3956
+ getRouteStationsWithAmenities?: Maybe<RouteStationsWithAmenitiesConnection>;
3957
+ /** [ALPHA] Get an e-truck route by ID. */
3958
+ getTruckRoute?: Maybe<TruckRouteResponse>;
3956
3959
  /** [ALPHA] Get a route by request ID. */
3957
3960
  getMatchedRoute?: Maybe<MatchedRouteResponse>;
3958
3961
  /** Get information about a station by its ID. */
@@ -4175,7 +4178,7 @@ export declare type RequestEvBatteryValue = {
4175
4178
  };
4176
4179
  /** Vehicle cabin configuration. */
4177
4180
  export declare type RequestEvCabin = {
4178
- /** Flag which indicate if the vehicle cabin was preconditioned for the desired temperature. */
4181
+ /** Flag which indicates if the vehicle cabin was preconditioned for the desired temperature. */
4179
4182
  isPreconditioned?: Maybe<Scalars["Boolean"]>;
4180
4183
  /** Desired cabin temperature. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
4181
4184
  desiredTemperature?: Maybe<Scalars["Float"]>;
@@ -4186,7 +4189,7 @@ export declare type RequestEvCabindesiredTemperatureArgs = {
4186
4189
  };
4187
4190
  /** Vehicle cabin configuration. */
4188
4191
  export declare type RequestEvCabinInput = {
4189
- /** Flag which indicate if the vehicle cabin was preconditioned for the desired temperature. */
4192
+ /** Flag which indicates if the vehicle cabin was preconditioned for the desired temperature. */
4190
4193
  isPreconditioned?: Maybe<Scalars["Boolean"]>;
4191
4194
  /** Desired cabin temperature. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
4192
4195
  desiredTemperature?: Maybe<TemperatureInput>;
@@ -4308,7 +4311,7 @@ export declare type RequestRoute = {
4308
4311
  /** Radius in meters for alternative stations along a route (min 500 - max 5000). */
4309
4312
  stationsAlongRouteRadius?: Maybe<Scalars["Int"]>;
4310
4313
  /**
4311
- * Flag indicating wether the turn-by-turn navigation instructions should be prepared. Disclaimer: The functionality is under active development and the final API is a subject to change. Not ready for production.
4314
+ * Flag indicating whether the turn-by-turn navigation instructions should be prepared. Disclaimer: The functionality is under active development and the final API is a subject to change. Not ready for production.
4312
4315
  * @deprecated All routes will have turn-by-turn instructions prepared. Boolean will be ignored.
4313
4316
  */
4314
4317
  instructions?: Maybe<Scalars["Boolean"]>;
@@ -4502,7 +4505,7 @@ export declare type RouteAlternative = {
4502
4505
  legs?: Maybe<Array<Maybe<RouteLeg>>>;
4503
4506
  /** List of raw turn-by-turn navigation instructions. */
4504
4507
  instructions?: Maybe<Array<Maybe<RouteInstruction>>>;
4505
- /** Alternative stations along a route within specified radius in meters. Only if it was provided at newRoute mutation. */
4508
+ /** Alternative stations along a route within specified radius in meters. Only if it was provided at `newRoute` mutation. */
4506
4509
  stationsAlongRoute?: Maybe<Array<Maybe<RouteStationsAlong>>>;
4507
4510
  /** Tags of a route alternative. Values: road, highway, toll, ferry, etc. */
4508
4511
  tags?: Maybe<Array<Maybe<RouteTagType>>>;
@@ -4847,7 +4850,7 @@ export declare type RouteDetailsLegSection = {
4847
4850
  duration: Scalars["Float"];
4848
4851
  /** Total energy used in a section in kilowatt-hours. The value will be 0 for walking sections. */
4849
4852
  consumption?: Maybe<Scalars["Float"]>;
4850
- /** [BETA] Information regarding traffic conditions along the leg's section. Available for routes created with traffic_aware set to true. */
4853
+ /** [BETA] Information regarding traffic conditions along the leg's section. Available for routes created with `traffic_aware` set to true. */
4851
4854
  traffic?: Maybe<RouteDetailsLegSectionTraffic>;
4852
4855
  };
4853
4856
  export declare type RouteDetailsLegSectionpolylineArgs = {
@@ -4904,17 +4907,17 @@ export declare type RouteDetailsLegTraffic = {
4904
4907
  };
4905
4908
  /** Type of a leg. */
4906
4909
  export declare enum RouteDetailsLegType {
4907
- /** This leg ends at a charging station and the vehicle must recharge. */
4910
+ /** Leg ending at a an automatically calculated charging station where the vehicle recharges. */
4908
4911
  STATION = "station",
4909
- /** This leg ends at a via charging station and the vehicle must recharge. */
4912
+ /** Leg ending at a user-defined via waypoint that is a charging station. */
4910
4913
  STATION_VIA = "station_via",
4911
- /** This leg ends at the destination which is a charging station, and is the last leg of the route. */
4914
+ /** Last leg of the route, ending at a destination that is a charging station. */
4912
4915
  STATION_FINAL = "station_final",
4913
4916
  /** This leg ends at a scheduled charging station and the vehicle must recharge. */
4914
4917
  STATION_AMENITY = "station_amenity",
4915
- /** This leg ends at a via location. */
4918
+ /** Leg ending at a user-defined via waypoint that is not a charging station. */
4916
4919
  VIA = "via",
4917
- /** This leg ends at the destination, and is the last leg of the route. */
4920
+ /** Last leg of the route, ending at a destination that is not a charging station. */
4918
4921
  FINAL = "final"
4919
4922
  }
4920
4923
  export declare type RouteDetailsLegWarning = {
@@ -4923,29 +4926,31 @@ export declare type RouteDetailsLegWarning = {
4923
4926
  };
4924
4927
  /** Types of warnings that can be encountered in a route leg. */
4925
4928
  export declare enum RouteDetailsLegWarningCode {
4926
- /** The via location cannot be reached by vehicle. */
4929
+ /** Via location cannot be reached by vehicle. */
4927
4930
  VIA_NOT_VEHICLE_ACCESSIBLE = "via_not_vehicle_accessible",
4928
- /** The leg could not use stations from the preferred operator(s). */
4931
+ /** Leg could not use stations from the preferred operator(s). */
4929
4932
  OPERATORS_PREFERRED_NOT_AVAILABLE = "operators_preferred_not_available",
4933
+ /** Leg's station belongs to a non-ranked operator. */
4934
+ OPERATORS_REQUIRED_NOT_AVAILABLE = "operators_required_not_available",
4930
4935
  /** Vehicle's load may exceed the maximum supported weight of the vehicle. */
4931
4936
  MAXIMUM_WEIGHT_EXCEEDED = "maximum_weight_exceeded",
4932
- /** The leg includes sections requested to be avoided. */
4937
+ /** Leg includes sections requested to be avoided. */
4933
4938
  SEGMENT_UNAVOIDABLE = "segment_unavoidable",
4934
- /** The charging station used in the leg has limited opening hours. */
4939
+ /** Leg's charging station has limited opening hours. */
4935
4940
  STATION_LIMITED_OPEN_HOURS = "station_limited_open_hours",
4936
- /** The leg's charging station has unknown open hours. */
4941
+ /** Leg's charging station has unknown open hours. */
4937
4942
  STATION_UNKNOWN_OPEN_HOURS = "station_unknown_open_hours",
4938
- /** The leg's charging station is closed at the estimated time of arrival. */
4943
+ /** Leg's charging station is closed at the estimated time of arrival. */
4939
4944
  STATION_CLOSED = "station_closed",
4940
- /** The leg's charging station is closing within 45 minutes of the estimated time of arrival. */
4945
+ /** Leg's charging station is closing within 45 minutes of the estimated time of arrival. */
4941
4946
  STATION_CLOSING_SOON = "station_closing_soon",
4942
- /** The specified stop duration at the via charging station is insufficient to start a charging session. */
4947
+ /** Specified stop duration at the via charging station is insufficient to start a charging session. */
4943
4948
  VIA_INSUFFICIENT_CHARGING_TIME = "via_insufficient_charging_time",
4944
- /** The selected via station does not have compatible connectors that meet the minimum power threshold. The route still includes this charging stop, but charging will be slower than requested. */
4949
+ /** Selected via station does not have compatible connectors that meet the minimum power threshold. The route still includes this charging stop, but charging will be slower than requested. */
4945
4950
  VIA_STATION_BELOW_MINIMUM_POWER = "via_station_below_minimum_power",
4946
- /** The charging station at the destination does not have any connectors compatible with the selected vehicle. */
4951
+ /** Charging station at the destination does not have any connectors compatible with the selected vehicle. */
4947
4952
  DESTINATION_CHARGER_INCOMPATIBLE = "destination_charger_incompatible",
4948
- /** The charging station at the destination is restricted to heavy-duty trucks. */
4953
+ /** Charging station at the destination is restricted to heavy-duty trucks. */
4949
4954
  DESTINATION_STATION_TRUCK_ONLY = "destination_station_truck_only",
4950
4955
  /** Expected arrival state of charge for the leg is below the safety risk margin. */
4951
4956
  RISK_MARGIN_SOC_NOT_POSSIBLE = "risk_margin_soc_not_possible",
@@ -5046,19 +5051,19 @@ export declare type RouteDetailsTraffic = {
5046
5051
  congestions: Array<Maybe<TrafficCongestionInterval>>;
5047
5052
  };
5048
5053
  export declare type RouteDrivingPreferences = {
5049
- /** [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'. */
5054
+ /** [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`. */
5050
5055
  speed_factor?: Maybe<Scalars["Float"]>;
5051
- /** [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'. */
5056
+ /** [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`. */
5052
5057
  maximum_speed?: Maybe<MaximumSpeed>;
5053
- /** [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'. */
5058
+ /** [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`. */
5054
5059
  style?: Maybe<RouteDrivingStyle>;
5055
5060
  };
5056
5061
  export declare type RouteDrivingPreferencesInput = {
5057
- /** [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'. */
5062
+ /** [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`. */
5058
5063
  speed_factor?: Maybe<Scalars["Float"]>;
5059
- /** [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'. */
5064
+ /** [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`. */
5060
5065
  maximum_speed?: Maybe<MaximumSpeedInput>;
5061
- /** [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'. */
5066
+ /** [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`. */
5062
5067
  style?: Maybe<RouteDrivingStyle>;
5063
5068
  };
5064
5069
  export declare enum RouteDrivingStyle {
@@ -5418,7 +5423,7 @@ export declare type RouteLegOperationalElectricityEmissionsIntensityinfrastructu
5418
5423
  export declare type RouteMetadata = {
5419
5424
  /** Refers to the x-app-id specified in the headers. */
5420
5425
  app_id: Scalars["ID"];
5421
- /** Date when a route was created by a createRoute mutation. */
5426
+ /** Date when a route was created by a `createRoute` mutation. */
5422
5427
  created_at: Scalars["DateTime"];
5423
5428
  /** Last updated date of a route. */
5424
5429
  updated_at: Scalars["DateTime"];
@@ -5766,7 +5771,7 @@ export declare type RouteOperatorPreferencesRanking = {
5766
5771
  levels?: Maybe<RouteOperatorPreferencesRankingLevels>;
5767
5772
  };
5768
5773
  export declare type RouteOperatorPreferencesRankingInput = {
5769
- /** Determines how operator preferences are applied to stations during route calculation. If no ranking is provided through 'levels' or project settings, no operator preference is applied. */
5774
+ /** Determines how operator preferences are applied to stations during route calculation. If no ranking is provided through `levels` or project settings, no operator preference is applied. */
5770
5775
  type: RouteOperatorsType;
5771
5776
  /** Priority levels for operator ranking. If not specified, applies the specified enforcement type to the project-configured operator ranking. */
5772
5777
  levels?: Maybe<RouteOperatorPreferencesRankingLevelsInput>;
@@ -5951,7 +5956,7 @@ export declare type RoutePropertiesStationInput = {
5951
5956
  export declare type RoutePropertiesVehicle = {
5952
5957
  /** Number of occupants present in the vehicle. */
5953
5958
  occupants: Scalars["Int"];
5954
- /** Combined weight of the occupants. This can only be used in combination with occupants. */
5959
+ /** Combined weight of the occupants. This can only be used in combination with `occupants`. */
5955
5960
  total_occupant_weight: TotalOccupantWeight;
5956
5961
  /** Weight of the cargo. */
5957
5962
  total_cargo_weight?: Maybe<TotalCargoWeight>;
@@ -5959,7 +5964,7 @@ export declare type RoutePropertiesVehicle = {
5959
5964
  export declare type RoutePropertiesVehicleInput = {
5960
5965
  /** Number of occupants present in the vehicle. */
5961
5966
  occupants?: Maybe<Scalars["Int"]>;
5962
- /** Combined weight of the occupants. This can only be used in combination with occupants. */
5967
+ /** Combined weight of the occupants. This can only be used in combination with `occupants`. */
5963
5968
  total_occupant_weight?: Maybe<TotalOccupantWeightInput>;
5964
5969
  /** Weight of the cargo. */
5965
5970
  total_cargo_weight?: Maybe<TotalCargoWeightInput>;
@@ -5996,7 +6001,7 @@ export declare type RouteScheduledChargeStop = {
5996
6001
  types?: Maybe<Array<Maybe<AmenityType>>>;
5997
6002
  /** Duration at the amenity, in seconds. */
5998
6003
  duration?: Maybe<Scalars["Int"]>;
5999
- /** Maximum allowed offset from the stop_after value in seconds. Default is 1800. */
6004
+ /** Maximum allowed offset from the `stop_after` value in seconds. Default is 1800. */
6000
6005
  offset?: Maybe<Scalars["Int"]>;
6001
6006
  /** Desired drive time before a scheduled stop after leaving the previous stop, in seconds. */
6002
6007
  stop_after?: Maybe<Scalars["Int"]>;
@@ -6120,7 +6125,7 @@ export declare enum RouteTagType {
6120
6125
  export declare type RouteTimeWindow = {
6121
6126
  /** Center point of the search, expressed as the travel time, in seconds, from the journey's origin. */
6122
6127
  center: Scalars["Int"];
6123
- /** Duration in seconds to extend the search on either side of the 'center'. Maximum allowed value is 2700 (45 minutes). If not specified, defaults to 900 seconds (15 minutes). */
6128
+ /** Duration in seconds to extend the search on either side of the `center`. Maximum allowed value is 2700 (45 minutes). If not specified, defaults to 900 seconds (15 minutes). */
6124
6129
  margin?: Maybe<Scalars["Int"]>;
6125
6130
  };
6126
6131
  /** Types of route features that can be avoided in truck routing. */
@@ -6161,11 +6166,11 @@ export declare type RouteTruckOriginPropertiesInput = {
6161
6166
  vehicle?: Maybe<RouteTruckPropertiesVehicleInput>;
6162
6167
  };
6163
6168
  export declare type RouteTruckPropertiesLocation = {
6164
- /** Name override for the choosen location. */
6169
+ /** Name override for the chosen location. */
6165
6170
  name?: Maybe<Scalars["String"]>;
6166
6171
  };
6167
6172
  export declare type RouteTruckPropertiesLocationInput = {
6168
- /** Name override for the choosen location. */
6173
+ /** Name override for the chosen location. */
6169
6174
  name?: Maybe<Scalars["String"]>;
6170
6175
  };
6171
6176
  export declare type RouteTruckPropertiesVehicle = {
@@ -6175,9 +6180,9 @@ export declare type RouteTruckPropertiesVehicle = {
6175
6180
  total_occupant_weight?: Maybe<TotalOccupantWeight>;
6176
6181
  /** Total weight of all cargo in the vehicle, including the cargo in any attached trailers. */
6177
6182
  total_cargo_weight?: Maybe<TotalCargoWeight>;
6178
- /** The number of axles of the main vehicle (e.g., rigid truck or tractor unit) in contact with the road. Excludes semi-trailer axles, those should be provided in trailer object. If not specified, it assumes main vehicle's all axles (liftable and rigid) are in use. */
6183
+ /** The number of axles of the main vehicle (e.g., rigid truck or tractor unit) in contact with the road. Excludes semi-trailer axles, those should be provided in trailer object. If not specified, it assumes all axles of the main vehicle (liftable and rigid) are in use. */
6179
6184
  axles_in_use?: Maybe<Scalars["Int"]>;
6180
- /** Configuration and dimensions for attached trailers. Required when the choosen vehicle is tractor unit. If not specified, no trailer configuration is set . */
6185
+ /** Configuration and dimensions for attached trailers. Required when the chosen vehicle is a tractor unit. If not specified, no trailer configuration is set. */
6181
6186
  trailer?: Maybe<RouteTruckVehicleTrailer>;
6182
6187
  };
6183
6188
  export declare type RouteTruckPropertiesVehicleInput = {
@@ -6187,9 +6192,9 @@ export declare type RouteTruckPropertiesVehicleInput = {
6187
6192
  total_occupant_weight?: Maybe<TotalOccupantWeightInput>;
6188
6193
  /** Total weight of all cargo in the vehicle, including the cargo in any attached trailers. */
6189
6194
  total_cargo_weight?: Maybe<TotalCargoWeightInput>;
6190
- /** The number of axles of the main vehicle (e.g., rigid truck or tractor unit) in contact with the road. Excludes semi-trailer axles, those should be provided in trailer object. If not specified, it assumes main vehicle's all axles (liftable and rigid) are in use. */
6195
+ /** The number of axles of the main vehicle (e.g., rigid truck or tractor unit) in contact with the road. Excludes semi-trailer axles, those should be provided in trailer object. If not specified, it assumes all axles of the main vehicle (liftable and rigid) are in use. */
6191
6196
  axles_in_use?: Maybe<Scalars["Int"]>;
6192
- /** Configuration and dimensions for attached trailers. Required when the choosen vehicle is tractor unit. If not specified, no trailer configuration is set . */
6197
+ /** Configuration and dimensions for attached trailers. Required when the chosen vehicle is a tractor unit. If not specified, no trailer configuration is set. */
6193
6198
  trailer?: Maybe<RouteTruckVehicleTrailerInput>;
6194
6199
  };
6195
6200
  export declare type RouteTruckVehicle = {
@@ -6543,7 +6548,7 @@ export declare type RouteWarning = {
6543
6548
  };
6544
6549
  /** Types of warnings that can be encountered in a route. */
6545
6550
  export declare enum RouteWarningCode {
6546
- /** Selected vehicle model is unavailable on one or more regions along the route. */
6551
+ /** Selected vehicle model is unavailable in one or more regions along the route. */
6547
6552
  EV_UNAVAILABLE_IN_REGION = "ev_unavailable_in_region",
6548
6553
  /** Route excludes charging stations as a hybrid vehicle does not require external charging. */
6549
6554
  HEV_NO_CHARGING_STATIONS = "hev_no_charging_stations",
@@ -6571,7 +6576,7 @@ export declare enum RouteWarningCode {
6571
6576
  export declare type RouteWeather = {
6572
6577
  /** Weather configuration applied to the route. */
6573
6578
  type: WeatherType;
6574
- /** [BETA] Custom weather conditions applied to the route. Only present when 'type' is set to 'CUSTOM'. */
6579
+ /** [BETA] Custom weather conditions applied to the route. Only present when `type` is set to `CUSTOM`. */
6575
6580
  custom?: Maybe<RouteWeatherCustomConditions>;
6576
6581
  };
6577
6582
  export declare type RouteWeatherCustomConditions = {
@@ -6593,7 +6598,7 @@ export declare type RouteWeatherCustomConditionsInput = {
6593
6598
  export declare type RouteWeatherInput = {
6594
6599
  /** Weather configuration applied to the route. */
6595
6600
  type?: Maybe<WeatherType>;
6596
- /** [BETA] Custom weather conditions to apply to the route. Required only when 'type' is 'CUSTOM'. Must be omitted for other weather types. */
6601
+ /** [BETA] Custom weather conditions to apply to the route. Required only when `type` is `CUSTOM`. Must be omitted for other weather types. */
6597
6602
  custom?: Maybe<RouteWeatherCustomConditionsInput>;
6598
6603
  };
6599
6604
  /** Scheduled charge stop along a route. */
@@ -6602,7 +6607,7 @@ export declare type ScheduledChargeStopInput = {
6602
6607
  types: Array<AmenityType>;
6603
6608
  /** Duration at the amenity, in seconds. The value should be between 900 and 86400. */
6604
6609
  duration: Scalars["Int"];
6605
- /** Maximum allowed offset from the stop_after value in seconds. */
6610
+ /** Maximum allowed offset from the `stop_after` value in seconds. */
6606
6611
  offset?: Maybe<Scalars["Int"]>;
6607
6612
  /** Desired drive time for a scheduled stop after leaving the origin point, in seconds. */
6608
6613
  stop_after: Scalars["Int"];
@@ -6643,7 +6648,7 @@ export declare type StateOfChargeInput = {
6643
6648
  value: Scalars["Float"];
6644
6649
  /** Preferred unit for the vehicle's state of charge. */
6645
6650
  type: StateOfChargeUnit;
6646
- /** Source of inputted data, defaults to 'manual'. */
6651
+ /** Source of inputted data, defaults to `manual`. */
6647
6652
  source?: Maybe<TelemetryInputSource>;
6648
6653
  };
6649
6654
  export declare enum StateOfChargeUnit {
@@ -6658,59 +6663,59 @@ export declare enum StateOfChargeUnit {
6658
6663
  }
6659
6664
  /** Station data which extends OCPI Location. */
6660
6665
  export declare type Station = {
6661
- /** Unique ID of a station. */
6666
+ /** Unique ID of a station. This property is OCPI-compliant. */
6662
6667
  id: Scalars["ID"];
6663
- /** ISO-3166 alpha-2 country code of a station. */
6668
+ /** ISO-3166 alpha-2 country code of a station. This property is OCPI-compliant. */
6664
6669
  country_code?: Maybe<Scalars["String"]>;
6665
- /** CPO ID of a CPO that 'owns' this station (following the ISO-15118 standard). */
6670
+ /** CPO ID of a CPO that 'owns' this station (following the ISO-15118 standard). This property is OCPI-compliant. */
6666
6671
  party_id?: Maybe<Scalars["String"]>;
6667
6672
  /**
6668
6673
  * Defines if a location may be published on a website or app etc.
6669
- * When this is set to false, only tokens identified in the field: publish_allowed_to are allowed to show this location.
6670
- * When the same location has EVSEs that may be published and may not be published, two 'locations' should be created.
6674
+ * When this is set to false, only tokens identified in the field: `publish_allowed_to` are allowed to show this location.
6675
+ * When the same location has EVSEs that may be published and may not be published, two 'locations' should be created. This property is OCPI-compliant.
6671
6676
  */
6672
6677
  publish?: Maybe<Scalars["Boolean"]>;
6673
- /** Name of a charging station. */
6678
+ /** Name of a charging station. This property is OCPI-compliant. */
6674
6679
  name?: Maybe<Scalars["String"]>;
6675
- /** Street/block name and house number if available. */
6680
+ /** Street/block name and house number if available. This property is OCPI-compliant. */
6676
6681
  address?: Maybe<Scalars["String"]>;
6677
- /** City or town */
6682
+ /** City or town. This property is OCPI-compliant. */
6678
6683
  city?: Maybe<Scalars["String"]>;
6679
- /** Postal code of a location, may only be omitted when a location has no postal code: in some countries charging locations at highways don’t have postal codes. */
6684
+ /** Postal code of a location, may only be omitted when a location has no postal code: in some countries charging locations at highways don’t have postal codes. This property is OCPI-compliant. */
6680
6685
  postal_code?: Maybe<Scalars["String"]>;
6681
- /** State or province of a location, only to be used when relevant. */
6686
+ /** State or province of a location, only to be used when relevant. This property is OCPI-compliant. */
6682
6687
  state?: Maybe<Scalars["String"]>;
6683
- /** ISO 3166-1 alpha-3 code for the country of this station. */
6688
+ /** ISO 3166-1 alpha-3 code for the country of this station. This property is OCPI-compliant. */
6684
6689
  country?: Maybe<Scalars["String"]>;
6685
- /** Coordinates of a location. */
6690
+ /** Coordinates of a location. This property is OCPI-compliant. */
6686
6691
  coordinates?: Maybe<OCPIGeoLocation>;
6687
- /** Geographical location of related points relevant to a user. */
6692
+ /** Geographical location of related points relevant to a user. This property is OCPI-compliant. */
6688
6693
  related_locations?: Maybe<Array<Maybe<OCPIAdditionalGeoLocation>>>;
6689
- /** Type of parking at a charge point location. */
6694
+ /** Type of parking at a charge point location. This property is OCPI-compliant. */
6690
6695
  parking_type?: Maybe<OCPIParkingType>;
6691
- /** EVSEs that belong to a station. */
6696
+ /** EVSEs that belong to a station. This property is OCPI-compliant. */
6692
6697
  evses?: Maybe<Array<Maybe<EVSE>>>;
6693
- /** Human-readable directions on how to reach a station. */
6698
+ /** Human-readable directions on how to reach a station. This property is OCPI-compliant. */
6694
6699
  directions?: Maybe<Array<Maybe<OCPIDisplayText>>>;
6695
- /** Information about an operator. */
6700
+ /** Information about an operator. This property is OCPI-compliant. */
6696
6701
  operator?: Maybe<Operator>;
6697
- /** Information about a suboperator if applicable. */
6702
+ /** Information about a suboperator if applicable. This property is OCPI-compliant. */
6698
6703
  suboperator?: Maybe<Operator>;
6699
- /** Information about an owner if available. */
6704
+ /** Information about an owner if available. This property is OCPI-compliant. */
6700
6705
  owner?: Maybe<Operator>;
6701
- /** Facilities a charging station belongs to. */
6706
+ /** Facilities a charging station belongs to. This property is OCPI-compliant. */
6702
6707
  facilities?: Maybe<Array<Maybe<OCPIFacility>>>;
6703
- /** Value from the IANA time zone database representing the time zone of a location. Examples: "Europe/Oslo", "Europe/Zurich". (http://www.iana.org/time-zones). */
6708
+ /** Value from the IANA time zone database representing the time zone of a location. Examples: "Europe/Oslo", "Europe/Zurich". (http://www.iana.org/time-zones). This property is OCPI-compliant. */
6704
6709
  time_zone?: Maybe<Scalars["String"]>;
6705
- /** Times when an EVSEs at a location can be accessed for charging. */
6710
+ /** Times when an EVSEs at a location can be accessed for charging. This property is OCPI-compliant. */
6706
6711
  opening_times?: Maybe<OCPIHours>;
6707
- /** Indicates if the EVSEs are still charging outside the opening hours. E.g. when a parking garage closes its barriers overnight, is it allowed to charge till the next morning? Default: true. */
6712
+ /** Indicates if the EVSEs are still charging outside the opening hours. E.g. when a parking garage closes its barriers overnight, is it allowed to charge till the next morning? Default: true. This property is OCPI-compliant. */
6708
6713
  charging_when_closed?: Maybe<Scalars["Boolean"]>;
6709
- /** Links to images related to a location such as photos or logos. */
6714
+ /** Links to images related to a location such as photos or logos. This property is OCPI-compliant. */
6710
6715
  images?: Maybe<Array<Maybe<OCPIImage>>>;
6711
- /** Details of the energy supplied at a location. */
6716
+ /** Details of the energy supplied at a location. This property is OCPI-compliant. */
6712
6717
  energy_mix?: Maybe<OCPIEnergyMix>;
6713
- /** Timestamp when a location, or one of its EVSEs or Connectors were last updated (or created). */
6718
+ /** Timestamp when a location, or one of its EVSEs or Connectors was last updated (or created). This property is OCPI-compliant. */
6714
6719
  last_updated?: Maybe<Scalars["DateTime"]>;
6715
6720
  /** ID provided by a station data source. */
6716
6721
  external_id?: Maybe<Scalars["String"]>;
@@ -6730,9 +6735,9 @@ export declare type Station = {
6730
6735
  heavy_vehicles_restrictions?: Maybe<StationHeavyVehiclesRestrictions>;
6731
6736
  /** Describes the vehicle restrictions at the location. */
6732
6737
  vehicle_restrictions?: Maybe<StationVehicleRestrictions>;
6733
- /** Type of location where the charge point is located. For example, shop. */
6738
+ /** Type of location where the charge point is located. For example: "shop". */
6734
6739
  location_category?: Maybe<Scalars["String"]>;
6735
- /** Coordinates for the location's entrances in decimal degrees. If available, there can be more than one entrances to the location. */
6740
+ /** Coordinates for the location's entrances in decimal degrees. If available, there can be more than one entrance to the location. */
6736
6741
  entrance_for_navigation?: Maybe<Array<OCPIAdditionalGeoLocation>>;
6737
6742
  /**
6738
6743
  * Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
@@ -6773,7 +6778,7 @@ export declare enum StationAdhocAuthorisationPaymentMethod {
6773
6778
  AUTH_BY_CAR_PLUG_AND_CHARGE = "AUTH_BY_CAR_PLUG_AND_CHARGE",
6774
6779
  /** Apple Pay. */
6775
6780
  ONLINE_APPLE_PAY = "ONLINE_APPLE_PAY",
6776
- /** Terminal in app. */
6781
+ /** Terminal in-app. */
6777
6782
  TERMINAL_IN_APP = "TERMINAL_IN_APP",
6778
6783
  /** PayPal. */
6779
6784
  ONLINE_PAYPAL = "ONLINE_PAYPAL",
@@ -7002,7 +7007,7 @@ export declare type Subscription = {
7002
7007
  /** Subscribe to a specific route to receive system event updates. */
7003
7008
  route: RouteResponse;
7004
7009
  /** [ALPHA] Subscribe to e-truck route to receive system event updates. */
7005
- truckRoute: TruckRouteResponse;
7010
+ truckRoute?: Maybe<TruckRouteResponse>;
7006
7011
  /** [BETA] Subscribe to navigation session system event updates. We strongly recommend using this at all times to not miss any updates. */
7007
7012
  navigation?: Maybe<NavigationSubscription>;
7008
7013
  /** [BETA] Subscribe to a connected vehicle. */
@@ -7197,7 +7202,7 @@ export declare type TirePressureInput = {
7197
7202
  value: Array<Scalars["Float"]>;
7198
7203
  /** Preferred unit for the tire pressure. */
7199
7204
  type: PressureUnit;
7200
- /** Source of inputted data, defaults to 'manual'. */
7205
+ /** Source of inputted data, defaults to `manual`. */
7201
7206
  source?: Maybe<TelemetryInputSource>;
7202
7207
  };
7203
7208
  export declare enum TorqueUnit {
@@ -7219,7 +7224,7 @@ export declare type TotalCargoWeightInput = {
7219
7224
  value: Scalars["Float"];
7220
7225
  /** Preferred unit for the current weight of the cargo. */
7221
7226
  type: WeightUnit;
7222
- /** Source of inputted data, defaults to 'manual'. */
7227
+ /** Source of inputted data, defaults to `manual`. */
7223
7228
  source?: Maybe<TelemetryInputSource>;
7224
7229
  };
7225
7230
  export declare type TotalOccupantWeight = {
@@ -7235,7 +7240,7 @@ export declare type TotalOccupantWeightInput = {
7235
7240
  value: Scalars["Float"];
7236
7241
  /** Preferred unit for the current weight of the occupants. */
7237
7242
  type: WeightUnit;
7238
- /** Source of inputted data, defaults to 'manual'. */
7243
+ /** Source of inputted data, defaults to `manual`. */
7239
7244
  source?: Maybe<TelemetryInputSource>;
7240
7245
  };
7241
7246
  export declare type TrafficCongestionInterval = {
@@ -7269,7 +7274,7 @@ export declare type TruckRouteDetails = {
7269
7274
  savings?: Maybe<RouteDetailsSavings>;
7270
7275
  /** Legs of a route. */
7271
7276
  legs: Array<TruckRouteDetailsLeg>;
7272
- /** Alternative stations along a route within a specified radius. Will only return stations if alternative_station_radius was specified in the createRoute mutation. */
7277
+ /** Alternative stations along a route within a specified radius. Will only return stations if `alternative_station_radius` was specified in the `createRoute` mutation. */
7273
7278
  alternative_stations: Array<RouteDetailsAlternativeStation>;
7274
7279
  /** Aggregation of tags over the current RouteDetails. Tags are available on legs and further subdivided over individual sections and maneuvers. */
7275
7280
  tags: Array<RouteDetailsTag>;
@@ -7357,7 +7362,7 @@ export declare type TruckRouteDetailsLegFeatureProperties = {
7357
7362
  /** External ID of the station. */
7358
7363
  external_station_id?: Maybe<Scalars["ID"]>;
7359
7364
  /** Temperature at the location. */
7360
- temperature?: Maybe<Scalars["Int"]>;
7365
+ temperature?: Maybe<Scalars["Float"]>;
7361
7366
  /** Air pressure at the location. */
7362
7367
  air_pressure?: Maybe<Scalars["Float"]>;
7363
7368
  /** Solar irradiance at the location. */
@@ -7560,11 +7565,11 @@ export declare type VehicleBattery = {
7560
7565
  export declare enum VehicleBatteryFieldEstimations {
7561
7566
  /** Both of the battery kWh fields are estimations. */
7562
7567
  B = "B",
7563
- /** full_kwh field is estimated. */
7568
+ /** `full_kwh` field is estimated. */
7564
7569
  F = "F",
7565
7570
  /** None of the battery kWh fields are estimations. */
7566
7571
  N = "N",
7567
- /** usable_kwh field is estimated. */
7572
+ /** `usable_kwh` field is estimated. */
7568
7573
  U = "U"
7569
7574
  }
7570
7575
  export declare enum VehicleBatteryType {
@@ -7804,7 +7809,7 @@ export declare type VehicleListNaming = {
7804
7809
  version?: Maybe<Scalars["String"]>;
7805
7810
  /** Another submodel level of the vehicle. */
7806
7811
  edition?: Maybe<Scalars["String"]>;
7807
- /** Vehicle model version. Added by Chargetrip as an alternative for when a vehicle manufacturer does not provide an version name, or uses the same version name across all trims or consecutive years. */
7812
+ /** Vehicle model version. Added by Chargetrip as an alternative for when a vehicle manufacturer does not provide a version name, or uses the same version name across all trims or consecutive years. */
7808
7813
  chargetrip_version: Scalars["String"];
7809
7814
  };
7810
7815
  export declare type VehicleListRange = {
@@ -7894,7 +7899,7 @@ export declare type VehicleNaming = {
7894
7899
  version?: Maybe<Scalars["String"]>;
7895
7900
  /** Another submodel level of the vehicle. */
7896
7901
  edition?: Maybe<Scalars["String"]>;
7897
- /** Vehicle model version. Added by Chargetrip as an alternative for when a vehicle manufacturer does not provide an version name, or uses the same version name across all trims or consecutive years. */
7902
+ /** Vehicle model version. Added by Chargetrip as an alternative for when a vehicle manufacturer does not provide a version name, or uses the same version name across all trims or consecutive years. */
7898
7903
  chargetrip_version: Scalars["String"];
7899
7904
  };
7900
7905
  export declare type VehiclePerformance = {
@@ -7941,7 +7946,7 @@ export declare type VehiclePremium = {
7941
7946
  body: VehiclePremiumBody;
7942
7947
  /** Availability of the vehicle. */
7943
7948
  availability: VehiclePremiumAvailability;
7944
- /** Starting price in the currency defined in the field argument. If not defined, it will return the starting price in the currency returned in the currency field. */
7949
+ /** Starting price in the currency defined in the field argument. If not defined, it will return the starting price in the currency returned in the `currency` field. */
7945
7950
  pricing: VehiclePremiumPriceValueWithGrant;
7946
7951
  /** Drivetrain of the vehicle. */
7947
7952
  drivetrain: VehiclePremiumDrivetrain;
@@ -7973,7 +7978,7 @@ export declare type VehiclePremiumAvailability = {
7973
7978
  status: VehicleAvailabilityStatus;
7974
7979
  /** Date of introduction, mm-yyyy. */
7975
7980
  date_from?: Maybe<Scalars["String"]>;
7976
- /** Indicates if date from field is estimated. */
7981
+ /** Indicates if `date_from` field is estimated. */
7977
7982
  date_from_is_estimated?: Maybe<Scalars["Boolean"]>;
7978
7983
  /** Date last available, mm-yyyy. */
7979
7984
  date_to?: Maybe<Scalars["String"]>;
@@ -8022,7 +8027,7 @@ export declare type VehiclePremiumBody = {
8022
8027
  size_is_estimated?: Maybe<Scalars["Boolean"]>;
8023
8028
  /** Wheelbase. */
8024
8029
  wheelbase?: Maybe<Scalars["Float"]>;
8025
- /** Indicates if wheelbase field is estimated. */
8030
+ /** Indicates if `wheelbase` field is estimated. */
8026
8031
  wheelbase_is_estimated?: Maybe<Scalars["Boolean"]>;
8027
8032
  /** Ground clearance of a vehicle as specified by the OEM. */
8028
8033
  ground_clearance?: Maybe<Scalars["Float"]>;
@@ -8034,7 +8039,7 @@ export declare type VehiclePremiumBody = {
8034
8039
  weight_gtw?: Maybe<VehicleBodyWeight>;
8035
8040
  /** Allowed payload weight. */
8036
8041
  weight_payload?: Maybe<VehicleBodyWeight>;
8037
- /** Indicates if weight field is estimated. */
8042
+ /** Indicates if `weight` field is estimated. */
8038
8043
  weight_is_estimated?: Maybe<Scalars["Boolean"]>;
8039
8044
  /** Maximum payload allowed for the vehicle. */
8040
8045
  weight_max_payload?: Maybe<Scalars["Float"]>;
@@ -8251,17 +8256,17 @@ export declare type VehiclePremiumDrivetrain = {
8251
8256
  fuel?: Maybe<VehicleFuel>;
8252
8257
  /** Propulsion type. */
8253
8258
  propulsion?: Maybe<VehiclePropulsion>;
8254
- /** Indicates if propulsion field is estimated. */
8259
+ /** Indicates if `propulsion` field is estimated. */
8255
8260
  propulsion_is_estimated?: Maybe<Scalars["Boolean"]>;
8256
8261
  /** Maximum (combined) power output. */
8257
8262
  power?: Maybe<Scalars["Float"]>;
8258
- /** Indicates if power field is estimated. */
8263
+ /** Indicates if `power` field is estimated. */
8259
8264
  power_is_estimated?: Maybe<Scalars["Boolean"]>;
8260
- /** Maximum (combine) power output. */
8265
+ /** Maximum (combined) power output. */
8261
8266
  power_hp?: Maybe<Scalars["Float"]>;
8262
- /** Maximum (combine) torque output. */
8267
+ /** Maximum (combined) torque output. */
8263
8268
  torque?: Maybe<Scalars["Float"]>;
8264
- /** Indicates if torque field is estimated. */
8269
+ /** Indicates if `torque` field is estimated. */
8265
8270
  torque_is_estimated?: Maybe<Scalars["Boolean"]>;
8266
8271
  };
8267
8272
  export declare type VehiclePremiumDrivetrainpowerArgs = {
@@ -8483,11 +8488,11 @@ export declare type VehiclePremiumNaming = {
8483
8488
  export declare type VehiclePremiumPerformance = {
8484
8489
  /** Acceleration 0-100 km/h. */
8485
8490
  acceleration?: Maybe<Scalars["Float"]>;
8486
- /** Indicates if acceleration field is estimated. */
8491
+ /** Indicates if `acceleration` field is estimated. */
8487
8492
  acceleration_is_estimated?: Maybe<Scalars["Boolean"]>;
8488
8493
  /** Top speed of the vehicle. */
8489
8494
  top_speed?: Maybe<Scalars["Float"]>;
8490
- /** Indicates if top_speed field is estimated. */
8495
+ /** Indicates if `top_speed` field is estimated. */
8491
8496
  top_speed_is_estimated?: Maybe<Scalars["Boolean"]>;
8492
8497
  };
8493
8498
  export declare type VehiclePremiumPerformanceaccelerationArgs = {
@@ -8630,7 +8635,7 @@ export declare enum VehiclePurpose {
8630
8635
  PASSENGER = "passenger",
8631
8636
  /** Vehicle intended for the transportation of cargo. */
8632
8637
  CARGO = "cargo",
8633
- /** Vehicle intended for the transportation of everything except cargo or passengers. Eg: ambulances, agricultural vehicles, etcetera. */
8638
+ /** Vehicle intended for the transportation of everything except cargo or passengers. E.g., ambulances, agricultural vehicles, etcetera. */
8634
8639
  UTILITY = "utility"
8635
8640
  }
8636
8641
  export declare type VehicleRange = {
@@ -8701,7 +8706,7 @@ export declare type VehicleSpeedInput = {
8701
8706
  value: Scalars["Float"];
8702
8707
  /** Preferred unit for the vehicle's speed. */
8703
8708
  type: SpeedUnit;
8704
- /** Source of inputted data, defaults to 'manual'. */
8709
+ /** Source of inputted data, defaults to `manual`. */
8705
8710
  source?: Maybe<TelemetryInputSource>;
8706
8711
  };
8707
8712
  export declare type VehicleToEverything = {
@@ -8778,13 +8783,13 @@ export declare enum VolumeUnit {
8778
8783
  }
8779
8784
  /** Type of weather conditions used in the route calculation. */
8780
8785
  export declare enum WeatherType {
8781
- /** Fixed seasonal preset representing typical summer weather conditions. Can't be used in combination with weather.custom. */
8786
+ /** Fixed seasonal preset representing typical summer weather conditions. Can't be used in combination with `weather.custom`. */
8782
8787
  SUMMER = "summer",
8783
- /** Fixed seasonal preset representing typical winter weather conditions. Can't be used in combination with weather.custom. */
8788
+ /** Fixed seasonal preset representing typical winter weather conditions. Can't be used in combination with `weather.custom`. */
8784
8789
  WINTER = "winter",
8785
- /** A dynamic preset that uses real weather data based on the route's departure time. Can't be used in combination with weather.custom. */
8790
+ /** A dynamic preset that uses real weather data based on the route's departure time. Can't be used in combination with `weather.custom`. */
8786
8791
  ACTUAL = "actual",
8787
- /** Must be used in combination with weather.custom object. */
8792
+ /** Must be used in combination with `weather.custom` object. */
8788
8793
  CUSTOM = "custom"
8789
8794
  }
8790
8795
  export declare type WeightInput = {