@chargetrip/types 1.70.0 → 1.72.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.
@@ -19,23 +19,15 @@ export declare type Scalars = {
19
19
  Float: number;
20
20
  /** The date and time scalar. */
21
21
  DateTime: string;
22
- /** Email address scalar, email regex with HTML sanitization. */
23
- Email: any;
24
22
  /** Any JSON object or array. */
25
23
  JSON: {
26
24
  [key: string]: number | string | boolean | null | Scalars["JSON"];
27
25
  };
28
- /** The non empty string scalar. */
29
- NonEmptyString: any;
30
- /** The `PlainID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The `PlainID` type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID. */
31
- PlainID: any;
32
26
  /**
33
27
  * The `PlainString` scalar type represents textual data, represented as UTF-8 character sequences.
34
28
  * The PlainString type represents free-form human-readable text with HTML sanitization.
35
29
  */
36
30
  PlainString: any;
37
- /** The File Upload scalar. */
38
- Upload: any;
39
31
  };
40
32
  export declare enum AccelerationUnit {
41
33
  /** Return the acceleration in seconds to 100 kilometers per hour. */
@@ -83,21 +75,14 @@ export declare type Address = {
83
75
  formattedAddress?: Maybe<Array<Maybe<Scalars["String"]>>>;
84
76
  /** Postal code of the location. */
85
77
  postal_code?: Maybe<Scalars["String"]>;
86
- /** 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
+ */
87
82
  what_3_words?: Maybe<Scalars["String"]>;
88
83
  /** Human-readable address of the location. */
89
84
  formatted_address?: Maybe<Array<Maybe<Scalars["String"]>>>;
90
85
  };
91
- export declare enum AdhocAuthorisationMethod {
92
- CREDIT_CARD = "CREDIT_CARD",
93
- DEBIT_CARD = "DEBIT_CARD",
94
- OTHER = "OTHER",
95
- OTHER_APPLE_PAY = "OTHER_Apple_Pay",
96
- OTHER_AUTHENTICATION_BY_CAR = "OTHER_Authentication_by_car",
97
- OTHER_GOOGLE_PAY = "OTHER_Google_Pay",
98
- QR_CODE = "QR_CODE",
99
- SMS = "SMS"
100
- }
101
86
  /** Input fields to continue the navigation session to the next leg. */
102
87
  export declare type AdvanceNavigationLegInput = {
103
88
  /** The unique identifier of the active navigation session. */
@@ -235,7 +220,7 @@ export declare type AmenityListFilter = {
235
220
  export declare type AmenityOpeningHours = {
236
221
  /** True to represent 24 hours a day and 7 days a week. */
237
222
  twentyfourseven?: Maybe<Scalars["Boolean"]>;
238
- /** 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. */
239
224
  regular_hours?: Maybe<Array<Maybe<AmenityRegularHours>>>;
240
225
  };
241
226
  /** Amenity preferences for a route. */
@@ -245,7 +230,7 @@ export declare type AmenityPreferencesInput = {
245
230
  /** Scheduled charge stops, with a specified amenity and timeline. */
246
231
  scheduled_charge_stops?: Maybe<Array<ScheduledChargeStopInput>>;
247
232
  };
248
- /** 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. */
249
234
  export declare type AmenityRegularHours = {
250
235
  /** Number of days in the week, from Monday (1) till Sunday (7). */
251
236
  weekday?: Maybe<Scalars["Int"]>;
@@ -303,7 +288,7 @@ export declare type AuxiliaryConsumptionInput = {
303
288
  value: Scalars["Float"];
304
289
  /** Preferred unit for the vehicle's auxiliary power consumption. */
305
290
  type: AuxiliaryConsumptionUnit;
306
- /** Source of inputted data, defaults to 'manual'. */
291
+ /** Source of inputted data, defaults to `manual`. */
307
292
  source?: Maybe<TelemetryInputSource>;
308
293
  };
309
294
  /** Auxiliary consumption units. */
@@ -323,7 +308,7 @@ export declare type BatteryTemperatureInput = {
323
308
  value: Scalars["Float"];
324
309
  /** Preferred unit for the temperature of the battery. */
325
310
  type: TemperatureUnit;
326
- /** Source of inputted data, defaults to 'manual'. */
311
+ /** Source of inputted data, defaults to `manual`. */
327
312
  source?: Maybe<TelemetryInputSource>;
328
313
  };
329
314
  export declare enum CarConnectivityProvider {
@@ -345,9 +330,9 @@ export declare type CarConsumptionInput = {
345
330
  };
346
331
  /** Charging mode used at charging stations. */
347
332
  export declare enum ChargeMode {
348
- /** 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`. */
349
334
  OPTIMIZE_TRAVEL_TIME = "OPTIMIZE_TRAVEL_TIME",
350
- /** 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`. */
351
336
  ALWAYS_TO_MAX_CHARGE = "ALWAYS_TO_MAX_CHARGE"
352
337
  }
353
338
  export declare type ChargeSpeed = {
@@ -363,7 +348,7 @@ export declare type ChargeSpeedInput = {
363
348
  value: Scalars["Float"];
364
349
  /** Preferred unit for the battery's charge speed. */
365
350
  type: ChargeSpeedUnit;
366
- /** Source of inputted data, defaults to 'manual'. */
351
+ /** Source of inputted data, defaults to `manual`. */
367
352
  source?: Maybe<TelemetryInputSource>;
368
353
  };
369
354
  export declare enum ChargeSpeedUnit {
@@ -381,7 +366,7 @@ export declare type ChargeTotalInput = {
381
366
  value: Scalars["Float"];
382
367
  /** Preferred unit for the total charge amount. */
383
368
  type: StateOfChargeUnit;
384
- /** Source of inputted data, defaults to 'manual'. */
369
+ /** Source of inputted data, defaults to `manual`. */
385
370
  source?: Maybe<TelemetryInputSource>;
386
371
  };
387
372
  /** A grouped representation of EVSEs. */
@@ -580,7 +565,7 @@ export declare type ConnectedVehicleListFilter = {
580
565
  export declare enum ConnectedVehicleStatus {
581
566
  /** Vehicle was added to the Chargetrip Connect platform but not yet authorized */
582
567
  PENDING_AUTHORIZATION = "pending_authorization",
583
- /** 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 */
584
569
  AUTHORIZED = "authorized",
585
570
  /** Pending vehicle removal */
586
571
  PENDING_REMOVAL = "pending_removal",
@@ -589,35 +574,35 @@ export declare enum ConnectedVehicleStatus {
589
574
  }
590
575
  /** Connector data which extends OCPI Connector. */
591
576
  export declare type Connector = {
592
- /** 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. */
593
578
  id?: Maybe<Scalars["String"]>;
594
- /** Standard of an installed connector. */
579
+ /** Standard of an installed connector. This property is OCPI-compliant. */
595
580
  standard?: Maybe<ConnectorType>;
596
- /** Format (socket/cable) of an installed connector. */
581
+ /** Format (socket/cable) of an installed connector. This property is OCPI-compliant. */
597
582
  format?: Maybe<OCPIConnectorFormat>;
598
- /** Type of power of an installed connector. */
583
+ /** Type of power of an installed connector. This property is OCPI-compliant. */
599
584
  power_type?: Maybe<OCPIPowerType>;
600
- /** 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. */
601
586
  max_voltage?: Maybe<Scalars["Int"]>;
602
- /** Maximum amperage of a connector, in ampere [A]. */
587
+ /** Maximum amperage of a connector, in ampere [A]. This property is OCPI-compliant. */
603
588
  max_amperage?: Maybe<Scalars["Int"]>;
604
589
  /**
605
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.
606
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.
607
- * 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.
608
593
  */
609
594
  max_electric_power?: Maybe<Scalars["Int"]>;
610
595
  /** Maximum electric power in kW. */
611
596
  power?: Maybe<Scalars["Float"]>;
612
597
  /**
613
- * 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.
614
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.
615
- * 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.
616
601
  */
617
602
  tariff_ids?: Maybe<Array<Maybe<Scalars["String"]>>>;
618
- /** URL to an operator’s terms and conditions. */
603
+ /** URL to an operator’s terms and conditions. This property is OCPI-compliant. */
619
604
  terms_and_conditions?: Maybe<Scalars["String"]>;
620
- /** Timestamp when a connector was last updated (or created). */
605
+ /** Timestamp when a connector was last updated (or created). This property is OCPI-compliant. */
621
606
  last_updated?: Maybe<Scalars["DateTime"]>;
622
607
  /** Optional object where you can store custom data you need in your application. This extends the current functionalities we offer. */
623
608
  properties?: Maybe<Scalars["JSON"]>;
@@ -673,8 +658,8 @@ export declare type ConnectorPriceElementComponent = {
673
658
  vat: Scalars["Float"];
674
659
  /**
675
660
  * Indicates the minimum amount that is billed.
676
- * 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.
677
- * 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.
678
663
  */
679
664
  step_size: Scalars["Int"];
680
665
  };
@@ -1705,31 +1690,31 @@ export declare enum DistanceUnit {
1705
1690
  /** EVSE data which extends OCPI EVSE. */
1706
1691
  export declare type EVSE = {
1707
1692
  /**
1708
- * 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.
1709
- * 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.
1710
1695
  */
1711
1696
  uid?: Maybe<Scalars["String"]>;
1712
- /** 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. */
1713
1698
  evse_id?: Maybe<Scalars["String"]>;
1714
- /** Indicates the current status of an EVSE. */
1699
+ /** Indicates the current status of an EVSE. This property is OCPI-compliant. */
1715
1700
  status?: Maybe<OCPIStatus>;
1716
- /** Indicates a planned status update of a nEVSE. */
1701
+ /** Indicates a planned status update of a nEVSE. This property is OCPI-compliant. */
1717
1702
  status_schedule?: Maybe<Array<Maybe<OCPIStatusSchedule>>>;
1718
- /** List of functionalities that an EVSE is capable of. */
1703
+ /** List of functionalities that an EVSE is capable of. This property is OCPI-compliant. */
1719
1704
  capabilities?: Maybe<Array<Maybe<OCPICapability>>>;
1720
- /** List of available connectors on an EVSE. */
1705
+ /** List of available connectors on an EVSE. This property is OCPI-compliant. */
1721
1706
  connectors?: Maybe<Array<Maybe<Connector>>>;
1722
- /** 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. */
1723
1708
  floor_level?: Maybe<Scalars["String"]>;
1724
- /** Coordinates of a EVSE. */
1709
+ /** Coordinates of a EVSE. This property is OCPI-compliant. */
1725
1710
  coordinates?: Maybe<OCPIGeoLocation>;
1726
- /** 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. */
1727
1712
  physical_reference?: Maybe<Scalars["String"]>;
1728
- /** Restrictions that apply to a parking spot. */
1713
+ /** Restrictions that apply to a parking spot. This property is OCPI-compliant. */
1729
1714
  parking_restrictions?: Maybe<Array<Maybe<OCPIParkingRestriction>>>;
1730
- /** 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. */
1731
1716
  images?: Maybe<Array<Maybe<OCPIImage>>>;
1732
- /** 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. */
1733
1718
  last_updated?: Maybe<Scalars["DateTime"]>;
1734
1719
  /** Indicates if parking is free or paid. */
1735
1720
  parking_cost?: Maybe<ParkingCost>;
@@ -1754,7 +1739,7 @@ export declare type ElevationInput = {
1754
1739
  value: Scalars["Float"];
1755
1740
  /** Preferred unit for the elevation. */
1756
1741
  type: DistanceUnit;
1757
- /** Source of inputted data, defaults to 'manual'. */
1742
+ /** Source of inputted data, defaults to `manual`. */
1758
1743
  source?: Maybe<TelemetryInputSource>;
1759
1744
  };
1760
1745
  export declare enum ElevationUnit {
@@ -1814,15 +1799,6 @@ export declare type FeatureMultiPolygon = {
1814
1799
  properties?: Maybe<PolygonProperties>;
1815
1800
  };
1816
1801
  /** A GeoJSON Feature<Point>. */
1817
- export declare type FeatureMultiPolygonPoint = {
1818
- /** Feature type. */
1819
- type: FeatureType;
1820
- /** Geometry of the feature. */
1821
- geometry: Point;
1822
- /** Optional object where you can store custom data you need in your application. */
1823
- properties?: Maybe<Scalars["JSON"]>;
1824
- };
1825
- /** A GeoJSON Feature<Point>. */
1826
1802
  export declare type FeaturePoint = {
1827
1803
  /** Feature ID. */
1828
1804
  id?: Maybe<Scalars["String"]>;
@@ -1854,16 +1830,11 @@ export declare type FeaturePointPolygonInput = {
1854
1830
  properties?: Maybe<FeaturePointPolygonPropertiesInput>;
1855
1831
  };
1856
1832
  /** Properties for Feature<Point> input. */
1857
- export declare type FeaturePointPolygonProperties = {
1858
- /** Name of the location. */
1859
- name?: Maybe<Scalars["String"]>;
1860
- };
1861
- /** Properties for Feature<Point> input. */
1862
1833
  export declare type FeaturePointPolygonPropertiesInput = {
1863
1834
  /** Name of the location. */
1864
1835
  name?: Maybe<Scalars["String"]>;
1865
1836
  };
1866
- /** GeoJSON Feature type. */
1837
+ /** GeoJSON Feature type */
1867
1838
  export declare enum FeatureType {
1868
1839
  FEATURE = "Feature"
1869
1840
  }
@@ -1970,7 +1941,7 @@ export declare type Isoline = {
1970
1941
  status: IsolineStatus;
1971
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. */
1972
1943
  maximum_distance?: Maybe<Scalars["Float"]>;
1973
- /** Shape of the isoline consisting in a list of multipolygons. */
1944
+ /** Shape of the isoline consisting of a list of multipolygons. */
1974
1945
  polygons?: Maybe<Array<Maybe<FeatureMultiPolygon>>>;
1975
1946
  /** List of the ferries uniting islands formed by the isoline. */
1976
1947
  ferries?: Maybe<Array<Maybe<FeatureLineString>>>;
@@ -1981,7 +1952,7 @@ export declare type Isolinemaximum_distanceArgs = {
1981
1952
  unit?: Maybe<DistanceUnit>;
1982
1953
  };
1983
1954
  export declare type IsolineCabin = {
1984
- /** 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. */
1985
1956
  is_preconditioned?: Maybe<Scalars["Boolean"]>;
1986
1957
  /** Desired temperature inside the cabin. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
1987
1958
  desired_temperature?: Maybe<Scalars["Float"]>;
@@ -1991,7 +1962,7 @@ export declare type IsolineCabindesired_temperatureArgs = {
1991
1962
  };
1992
1963
  /** Information about the cabin of the vehicle. */
1993
1964
  export declare type IsolineCabinInput = {
1994
- /** 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. */
1995
1966
  is_preconditioned?: Maybe<Scalars["Boolean"]>;
1996
1967
  /** Desired temperature inside the cabin. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
1997
1968
  desired_temperature?: Maybe<TemperatureInput>;
@@ -2068,7 +2039,7 @@ export declare type IsolineRequestInput = {
2068
2039
  cabin?: Maybe<IsolineCabin>;
2069
2040
  /**
2070
2041
  * Season taken into account when isoline was generated.
2071
- * @deprecated In favor of weather.
2042
+ * @deprecated In favor of `weather`.
2072
2043
  */
2073
2044
  season?: Maybe<RouteSeason>;
2074
2045
  /** Weather configuration for the isoline. Defined by a preset or custom weather conditions. */
@@ -2108,7 +2079,7 @@ export declare enum IsolineStatus {
2108
2079
  export declare type IsolineWeather = {
2109
2080
  /** Weather configuration applied to the isoline. */
2110
2081
  type: WeatherType;
2111
- /** [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`. */
2112
2083
  custom?: Maybe<IsolineWeatherCustomConditions>;
2113
2084
  };
2114
2085
  export declare type IsolineWeatherCustomConditions = {
@@ -2130,7 +2101,7 @@ export declare type IsolineWeatherCustomConditionsInput = {
2130
2101
  export declare type IsolineWeatherInput = {
2131
2102
  /** Weather configuration applied within the isoline. */
2132
2103
  type?: Maybe<WeatherType>;
2133
- /** [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. */
2134
2105
  custom?: Maybe<IsolineWeatherCustomConditionsInput>;
2135
2106
  };
2136
2107
  /** Types of a leg. */
@@ -2616,12 +2587,6 @@ export declare type MatchedRouteVehicleCharging = {
2616
2587
  /** Supported adapters. If not specified, adapters will not be considered. */
2617
2588
  adapters: Array<RouteVehicleChargingConnector>;
2618
2589
  };
2619
- export declare type MatchedRouteVehicleChargingConnector = {
2620
- /** Type of the plug. */
2621
- standard: ConnectorType;
2622
- /** Maximum charging speed for this plug. */
2623
- maximum_charge_speed: ChargeSpeed;
2624
- };
2625
2590
  export declare type MatchedRouteVehicleChargingConnectorInput = {
2626
2591
  /** Plug type. */
2627
2592
  standard: ConnectorType;
@@ -2757,7 +2722,7 @@ export declare type Mutation = {
2757
2722
  advanceNavigationLeg?: Maybe<Scalars["Boolean"]>;
2758
2723
  /**
2759
2724
  * Add a new review.
2760
- * 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.
2761
2726
  */
2762
2727
  addReview: Review;
2763
2728
  /**
@@ -2776,7 +2741,7 @@ export declare type Mutation = {
2776
2741
  /** Create a new route from the route input. */
2777
2742
  createRoute: Scalars["ID"];
2778
2743
  /** [ALPHA] Create a new truck route from the route input and its ID. */
2779
- createTruckRoute: Scalars["ID"];
2744
+ createTruckRoute?: Maybe<Scalars["ID"]>;
2780
2745
  /** [ALPHA] Creates route from a sequence of points. */
2781
2746
  createMatchedRoute?: Maybe<Scalars["ID"]>;
2782
2747
  };
@@ -2982,7 +2947,7 @@ export declare type NavigationPropertiesStationInput = {
2982
2947
  export declare type NavigationPropertiesVehicle = {
2983
2948
  /** Number of occupants present in the vehicle. */
2984
2949
  occupants: Scalars["Int"];
2985
- /** 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`. */
2986
2951
  total_occupant_weight: TotalOccupantWeight;
2987
2952
  /** Weight of the cargo. */
2988
2953
  total_cargo_weight?: Maybe<TotalCargoWeight>;
@@ -2990,7 +2955,7 @@ export declare type NavigationPropertiesVehicle = {
2990
2955
  export declare type NavigationPropertiesVehicleInput = {
2991
2956
  /** Number of occupants present in the vehicle. */
2992
2957
  occupants?: Maybe<Scalars["Int"]>;
2993
- /** 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`. */
2994
2959
  total_occupant_weight?: Maybe<TotalOccupantWeightInput>;
2995
2960
  /** Weight of the cargo. */
2996
2961
  total_cargo_weight?: Maybe<TotalCargoWeightInput>;
@@ -3202,11 +3167,11 @@ export declare type NavigationViaPropertiesInput = {
3202
3167
  };
3203
3168
  /** This class defines an additional geo location that is relevant for the Charge Point. The geodetic system to be used is WGS 84. */
3204
3169
  export declare type OCPIAdditionalGeoLocation = {
3205
- /** 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. */
3206
3171
  latitude?: Maybe<Scalars["String"]>;
3207
- /** 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. */
3208
3173
  longitude?: Maybe<Scalars["String"]>;
3209
- /** 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. */
3210
3175
  name?: Maybe<OCPIDisplayText>;
3211
3176
  };
3212
3177
  /** The capabilities of an EVSE. */
@@ -3235,7 +3200,7 @@ export declare enum OCPICapability {
3235
3200
  TOKEN_GROUP_CAPABLE = "TOKEN_GROUP_CAPABLE",
3236
3201
  /** Connectors have a mechanical lock that can be requested by the eMSP to be unlocked. */
3237
3202
  UNLOCK_CAPABLE = "UNLOCK_CAPABLE",
3238
- /** 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. */
3239
3204
  START_SESSION_CONNECTOR_REQUIRED = "START_SESSION_CONNECTOR_REQUIRED"
3240
3205
  }
3241
3206
  /** The format of the connector, whether it is a socket or a plug. */
@@ -3245,91 +3210,6 @@ export declare enum OCPIConnectorFormat {
3245
3210
  /** The connector is an attached cable; the EV users car needs to have a fitting inlet. */
3246
3211
  CABLE = "CABLE"
3247
3212
  }
3248
- /** Socket or plug standard of the charging point. */
3249
- export declare enum OCPIConnectorType {
3250
- /** The connector type is CHAdeMO, DC */
3251
- CHADEMO = "CHADEMO",
3252
- /** Standard/domestic household, type "A", NEMA 1-15, 2 pins */
3253
- DOMESTIC_A = "DOMESTIC_A",
3254
- /** Standard/domestic household, type "B", NEMA 5-15, 3 pins */
3255
- DOMESTIC_B = "DOMESTIC_B",
3256
- /** Standard/domestic household, type "C", CEE 7/17, 2 pins */
3257
- DOMESTIC_C = "DOMESTIC_C",
3258
- /** Standard/domestic household, type "D", 3 pins */
3259
- DOMESTIC_D = "DOMESTIC_D",
3260
- /** Standard/domestic household, type "E", CEE 7/5 3 pins */
3261
- DOMESTIC_E = "DOMESTIC_E",
3262
- /** Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins */
3263
- DOMESTIC_F = "DOMESTIC_F",
3264
- /** Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins */
3265
- DOMESTIC_G = "DOMESTIC_G",
3266
- /** Standard/domestic household, type "H", SI-32, 3 pins */
3267
- DOMESTIC_H = "DOMESTIC_H",
3268
- /** Standard/domestic household, type "I", AS 3112, 3 pins */
3269
- DOMESTIC_I = "DOMESTIC_I",
3270
- /** Standard/domestic household, type "J", SEV 1011, 3 pins */
3271
- DOMESTIC_J = "DOMESTIC_J",
3272
- /** Standard/domestic household, type "K", DS 60884-2-D1, 3 pins */
3273
- DOMESTIC_K = "DOMESTIC_K",
3274
- /** Standard/domestic household, type "L", CEI 23-16-VII, 3 pins */
3275
- DOMESTIC_L = "DOMESTIC_L",
3276
- /** Standard/Domestic household, type "M", BS 546, 3 pins */
3277
- DOMESTIC_M = "DOMESTIC_M",
3278
- /** Standard/Domestic household, type "N", NBR 14136, 3 pins */
3279
- DOMESTIC_N = "DOMESTIC_N",
3280
- /** Standard/Domestic household, type "O", TIS 166-2549, 3 pins */
3281
- DOMESTIC_O = "DOMESTIC_O",
3282
- /** IEC 60309-2 Industrial connector single phase 16 amperes (usually blue) */
3283
- IEC_60309_2_SINGLE_16 = "IEC_60309_2_single_16",
3284
- /** IEC 60309-2 Industrial connector three phase 16 amperes (usually red) */
3285
- IEC_60309_2_THREE_16 = "IEC_60309_2_three_16",
3286
- /** IEC 60309-2 Industrial connector three phase 32 amperes (usually red) */
3287
- IEC_60309_2_THREE_32 = "IEC_60309_2_three_32",
3288
- /** IEC 60309-2 Industrial connector three phase 64 amperes (usually red) */
3289
- IEC_60309_2_THREE_64 = "IEC_60309_2_three_64",
3290
- /** IEC 62196 Type 1 "SAE J1772" */
3291
- IEC_62196_T1 = "IEC_62196_T1",
3292
- /** Combo Type 1 based, DC */
3293
- IEC_62196_T1_COMBO = "IEC_62196_T1_COMBO",
3294
- /** IEC 62196 Type 2 "Mennekes" */
3295
- IEC_62196_T2 = "IEC_62196_T2",
3296
- /** Combo Type 2 based, DC */
3297
- IEC_62196_T2_COMBO = "IEC_62196_T2_COMBO",
3298
- /** IEC 62196 Type 3A */
3299
- IEC_62196_T3A = "IEC_62196_T3A",
3300
- /** IEC 62196 Type 3C "Scame" */
3301
- IEC_62196_T3C = "IEC_62196_T3C",
3302
- /** On-board bottom-up-pantograph typically for bus charging */
3303
- PANTOGRAPH_BOTTOM_UP = "PANTOGRAPH_BOTTOM_UP",
3304
- /** Off-board top-down-pantograph typically for bus charging */
3305
- PANTOGRAPH_TOP_DOWN = "PANTOGRAPH_TOP_DOWN",
3306
- /** Tesla connector "Roadster"-type (round, 4 pins) */
3307
- TESLA_R = "TESLA_R",
3308
- /** Tesla connector "Model-S"-type (oval, 5 pins) */
3309
- TESLA_S = "TESLA_S",
3310
- /** The connector type is GB_T (Chinese standard), DC */
3311
- GB_T = "GB_T",
3312
- /** The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC. */
3313
- CHAOJI = "CHAOJI",
3314
- /** The connector type is NEMA 5-20, 3 pins */
3315
- NEMA_5_20 = "NEMA_5_20",
3316
- /** The connector type is NEMA 6-30, 3 pins */
3317
- NEMA_6_30 = "NEMA_6_30",
3318
- /** The connector type is NEMA 6-50, 3 pins */
3319
- NEMA_6_50 = "NEMA_6_50",
3320
- /** The connector type is NEMA 10-30, 3 pins */
3321
- NEMA_10_30 = "NEMA_10_30",
3322
- /** The connector type is NEMA 10-50, 3 pins */
3323
- NEMA_10_50 = "NEMA_10_50",
3324
- /** The connector type is NEMA 14-30, 3 pins, rating of 30 A */
3325
- NEMA_14_30 = "NEMA_14_30",
3326
- /** The connector type is NEMA 14-50, 3 pins, rating of 50 A */
3327
- NEMA_14_50 = "NEMA_14_50",
3328
- /** Guobiao GB/T 20234.2 AC socket/connector. */
3329
- GBT_AC = "GBT_AC",
3330
- /** Guobiao GB/T 20234.3 DC connector. */
3331
- GBT_DC = "GBT_DC"
3332
- }
3333
3213
  export declare enum OCPIDayOfWeek {
3334
3214
  MONDAY = "MONDAY",
3335
3215
  TUESDAY = "TUESDAY",
@@ -3340,28 +3220,28 @@ export declare enum OCPIDayOfWeek {
3340
3220
  SUNDAY = "SUNDAY"
3341
3221
  }
3342
3222
  export declare type OCPIDisplayText = {
3343
- /** Language Code ISO 639-1 */
3223
+ /** Language Code ISO 639-1. This property is OCPI-compliant. */
3344
3224
  language?: Maybe<Scalars["String"]>;
3345
- /** 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. */
3346
3226
  text?: Maybe<Scalars["String"]>;
3347
3227
  };
3348
3228
  /** This type is used to specify the energy mix and environmental impact of the supplied energy at a location or in a tariff. */
3349
3229
  export declare type OCPIEnergyMix = {
3350
- /** True if the power is 100% from regenerative sources */
3230
+ /** True if the power is 100% from regenerative sources. This property is OCPI-compliant. */
3351
3231
  is_green_energy?: Maybe<Scalars["Boolean"]>;
3352
- /** 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. */
3353
3233
  energy_sources?: Maybe<Array<Maybe<OCPIEnergySource>>>;
3354
- /** 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. */
3355
3235
  environ_impact?: Maybe<Array<Maybe<OCPIEnvironmentalImpact>>>;
3356
- /** 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. */
3357
3237
  supplier_name?: Maybe<Scalars["String"]>;
3358
- /** 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. */
3359
3239
  energy_product_name?: Maybe<Scalars["String"]>;
3360
3240
  };
3361
3241
  export declare type OCPIEnergySource = {
3362
- /** The type of energy source. */
3242
+ /** The type of energy source. This property is OCPI-compliant. */
3363
3243
  source?: Maybe<OCPIEnergySourceCategory>;
3364
- /** Percentage of this source (0-100) in the mix. */
3244
+ /** Percentage of this source (0-100) in the mix. This property is OCPI-compliant. */
3365
3245
  percentage?: Maybe<Scalars["Int"]>;
3366
3246
  };
3367
3247
  /** Categories of energy sources. */
@@ -3385,9 +3265,9 @@ export declare enum OCPIEnergySourceCategory {
3385
3265
  }
3386
3266
  /** Amount of waste produced/emitted per kWh. */
3387
3267
  export declare type OCPIEnvironmentalImpact = {
3388
- /** The environmental impact category of this value. */
3268
+ /** The environmental impact category of this value. This property is OCPI-compliant. */
3389
3269
  category?: Maybe<OCPIEnvironmentalImpactCategory>;
3390
- /** Amount of this portion in g/kWh. */
3270
+ /** Amount of this portion in g/kWh. This property is OCPI-compliant. */
3391
3271
  amount?: Maybe<Scalars["Float"]>;
3392
3272
  };
3393
3273
  /** Categories of environmental impact values. */
@@ -3399,9 +3279,9 @@ export declare enum OCPIEnvironmentalImpactCategory {
3399
3279
  }
3400
3280
  /** Specifies one exceptional period for opening or access hours. */
3401
3281
  export declare type OCPIExceptionalPeriod = {
3402
- /** 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. */
3403
3283
  period_begin?: Maybe<Scalars["DateTime"]>;
3404
- /** 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. */
3405
3285
  period_end?: Maybe<Scalars["DateTime"]>;
3406
3286
  };
3407
3287
  export declare enum OCPIFacility {
@@ -3448,34 +3328,34 @@ export declare enum OCPIFacility {
3448
3328
  }
3449
3329
  /** This class defines the geo location of the Charge Point. The geodetic system to be used is WGS 84. */
3450
3330
  export declare type OCPIGeoLocation = {
3451
- /** 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. */
3452
3332
  latitude?: Maybe<Scalars["String"]>;
3453
- /** 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. */
3454
3334
  longitude?: Maybe<Scalars["String"]>;
3455
3335
  };
3456
3336
  /** Opening and access hours of the location. */
3457
3337
  export declare type OCPIHours = {
3458
- /** 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. */
3459
3339
  twentyfourseven?: Maybe<Scalars["Boolean"]>;
3460
- /** 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. */
3461
3341
  regular_hours?: Maybe<Array<Maybe<OCPIRegularHours>>>;
3462
- /** 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. */
3463
3343
  exceptional_openings?: Maybe<Array<Maybe<OCPIExceptionalPeriod>>>;
3464
- /** 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. */
3465
3345
  exceptional_closings?: Maybe<Array<Maybe<OCPIExceptionalPeriod>>>;
3466
3346
  };
3467
3347
  export declare type OCPIImage = {
3468
- /** 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. */
3469
3349
  url?: Maybe<Scalars["String"]>;
3470
- /** 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. */
3471
3351
  thumbnail?: Maybe<Scalars["String"]>;
3472
- /** Category of an image */
3352
+ /** Category of an image. This property is OCPI-compliant. */
3473
3353
  category?: Maybe<OCPIImageCategory>;
3474
- /** Image type: gif, jpeg, png, svg */
3354
+ /** Image type: gif, jpeg, png, svg. This property is OCPI-compliant. */
3475
3355
  type?: Maybe<Scalars["String"]>;
3476
- /** Width of the full scale image */
3356
+ /** Width of the full scale image. This property is OCPI-compliant. */
3477
3357
  width?: Maybe<Scalars["Int"]>;
3478
- /** Height of the full scale image */
3358
+ /** Height of the full scale image. This property is OCPI-compliant. */
3479
3359
  height?: Maybe<Scalars["Int"]>;
3480
3360
  };
3481
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. */
@@ -3536,28 +3416,28 @@ export declare enum OCPIPowerType {
3536
3416
  DC = "DC"
3537
3417
  }
3538
3418
  export declare type OCPIPrice = {
3539
- /** Price/Cost excluding VAT. */
3419
+ /** Price/Cost excluding VAT. This property is OCPI-compliant. */
3540
3420
  excl_vat?: Maybe<Scalars["Float"]>;
3541
- /** Price/Cost including VAT. */
3421
+ /** Price/Cost including VAT. This property is OCPI-compliant. */
3542
3422
  incl_vat?: Maybe<Scalars["Float"]>;
3543
3423
  };
3544
3424
  export declare type OCPIPriceComponent = {
3545
- /** Type of tariff dimension. */
3425
+ /** Type of tariff dimension. This property is OCPI-compliant. */
3546
3426
  type?: Maybe<OCPITariffDimensionType>;
3547
- /** Price per unit (excl. VAT) for this tariff dimension. */
3427
+ /** Price per unit (excl. VAT) for this tariff dimension. This property is OCPI-compliant. */
3548
3428
  price?: Maybe<Scalars["Float"]>;
3549
- /** 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. */
3550
3430
  vat?: Maybe<Scalars["Float"]>;
3551
- /** 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. */
3552
3432
  step_size?: Maybe<Scalars["Int"]>;
3553
3433
  };
3554
3434
  /** Regular recurring operation or access hours. */
3555
3435
  export declare type OCPIRegularHours = {
3556
- /** 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. */
3557
3437
  weekday?: Maybe<Scalars["Int"]>;
3558
- /** 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. */
3559
3439
  period_begin?: Maybe<Scalars["String"]>;
3560
- /** 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. */
3561
3441
  period_end?: Maybe<Scalars["String"]>;
3562
3442
  };
3563
3443
  export declare enum OCPIReservationRestrictionType {
@@ -3589,87 +3469,87 @@ export declare enum OCPIStatus {
3589
3469
  }
3590
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. */
3591
3471
  export declare type OCPIStatusSchedule = {
3592
- /** Begin of the scheduled period. */
3472
+ /** Begin of the scheduled period. This property is OCPI-compliant. */
3593
3473
  period_begin?: Maybe<Scalars["DateTime"]>;
3594
- /** End of the scheduled period, if known. */
3474
+ /** End of the scheduled period, if known. This property is OCPI-compliant. */
3595
3475
  period_end?: Maybe<Scalars["DateTime"]>;
3596
- /** Status value during the scheduled period. */
3476
+ /** Status value during the scheduled period. This property is OCPI-compliant. */
3597
3477
  status?: Maybe<OCPIStatus>;
3598
3478
  };
3599
3479
  export declare type OCPITariff = {
3600
- /** 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. */
3601
3481
  country_code?: Maybe<Scalars["String"]>;
3602
- /** 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. */
3603
3483
  party_id?: Maybe<Scalars["String"]>;
3604
- /** 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. */
3605
3485
  id?: Maybe<Scalars["String"]>;
3606
- /** ISO-4217 code of the currency of this tariff. */
3486
+ /** ISO-4217 code of the currency of this tariff. This property is OCPI-compliant. */
3607
3487
  currency?: Maybe<Scalars["String"]>;
3608
- /** 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. */
3609
3489
  type?: Maybe<OCPITariffType>;
3610
- /** List of alternative tariff information texts, in multiple languages */
3490
+ /** List of alternative tariff information texts, in multiple languages. This property is OCPI-compliant. */
3611
3491
  tariff_alt_text?: Maybe<Array<Maybe<OCPIDisplayText>>>;
3612
- /** 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. */
3613
3493
  tariff_alt_url?: Maybe<Scalars["String"]>;
3614
- /** 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. */
3615
3495
  min_price?: Maybe<OCPIPrice>;
3616
- /** 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. */
3617
3497
  max_price?: Maybe<OCPIPrice>;
3618
- /** List of tariff elements */
3498
+ /** List of tariff elements. This property is OCPI-compliant. */
3619
3499
  elements?: Maybe<Array<Maybe<OCPITariffElement>>>;
3620
- /** 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. */
3621
3501
  start_date_time?: Maybe<Scalars["DateTime"]>;
3622
- /** 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. */
3623
3503
  end_date_time?: Maybe<Scalars["DateTime"]>;
3624
- /** Details about the energy supplied with this tariff */
3504
+ /** Details about the energy supplied with this tariff. This property is OCPI-compliant. */
3625
3505
  energy_mix?: Maybe<OCPIEnergyMix>;
3626
- /** Timestamp when this tariff was last updated (or created) */
3506
+ /** Timestamp when this tariff was last updated (or created). This property is OCPI-compliant. */
3627
3507
  last_updated?: Maybe<Scalars["DateTime"]>;
3628
3508
  };
3629
3509
  export declare enum OCPITariffDimensionType {
3630
- /** Defined in kWh, step_size multiplier: 1 Wh */
3510
+ /** Defined in kWh, `step_size` multiplier: 1 Wh */
3631
3511
  ENERGY = "ENERGY",
3632
- /** Flat fee without unit for step_size */
3512
+ /** Flat fee without unit for `step_size` */
3633
3513
  FLAT = "FLAT",
3634
- /** Time not charging: defined in hours, step_size multiplier: 1 second */
3514
+ /** Time not charging: defined in hours, `step_size` multiplier: 1 second */
3635
3515
  PARKING_TIME = "PARKING_TIME",
3636
- /** 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. */
3637
3517
  TIME = "TIME"
3638
3518
  }
3639
3519
  export declare type OCPITariffElement = {
3640
- /** 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. */
3641
3521
  price_components?: Maybe<Array<Maybe<OCPIPriceComponent>>>;
3642
- /** Restrictions that describe the applicability of a tariff. */
3522
+ /** Restrictions that describe the applicability of a tariff. This property is OCPI-compliant. */
3643
3523
  restrictions?: Maybe<Array<Maybe<OCPITariffRestrictions>>>;
3644
3524
  };
3645
3525
  export declare type OCPITariffRestrictions = {
3646
- /** 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. */
3647
3527
  start_time?: Maybe<Scalars["String"]>;
3648
- /** 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. */
3649
3529
  end_time?: Maybe<Scalars["String"]>;
3650
- /** 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. */
3651
3531
  start_date?: Maybe<Scalars["String"]>;
3652
- /** 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. */
3653
3533
  end_date?: Maybe<Scalars["String"]>;
3654
- /** 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. */
3655
3535
  min_kwh?: Maybe<Scalars["Float"]>;
3656
- /** 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. */
3657
3537
  max_kwh?: Maybe<Scalars["Float"]>;
3658
- /** 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. */
3659
3539
  min_current?: Maybe<Scalars["Float"]>;
3660
- /** 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. */
3661
3541
  max_current?: Maybe<Scalars["Float"]>;
3662
- /** 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. */
3663
3543
  min_power?: Maybe<Scalars["Float"]>;
3664
- /** 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. */
3665
3545
  max_power?: Maybe<Scalars["Float"]>;
3666
- /** 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. */
3667
3547
  min_duration?: Maybe<Scalars["Float"]>;
3668
- /** 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. */
3669
3549
  max_duration?: Maybe<Scalars["Float"]>;
3670
- /** 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. */
3671
3551
  day_of_week?: Maybe<OCPIDayOfWeek>;
3672
- /** 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. */
3673
3553
  reservation?: Maybe<OCPIReservationRestrictionType>;
3674
3554
  };
3675
3555
  export declare enum OCPITariffType {
@@ -3772,7 +3652,7 @@ export declare type OdometerInput = {
3772
3652
  value: Scalars["Float"];
3773
3653
  /** Preferred unit for the vehicle's odometer. */
3774
3654
  type: DistanceUnit;
3775
- /** Source of inputted data, defaults to 'manual'. */
3655
+ /** Source of inputted data, defaults to `manual`. */
3776
3656
  source?: Maybe<TelemetryInputSource>;
3777
3657
  };
3778
3658
  /** Operator data which extends OCPI BusinessDetails. */
@@ -3781,11 +3661,11 @@ export declare type Operator = {
3781
3661
  id?: Maybe<Scalars["ID"]>;
3782
3662
  /** External ID of an operator provided by the operator data source. */
3783
3663
  external_id?: Maybe<Scalars["String"]>;
3784
- /** Name of an operator. */
3664
+ /** Name of an operator. This property is OCPI-compliant. */
3785
3665
  name?: Maybe<Scalars["String"]>;
3786
- /** Link to an operator’s website. */
3666
+ /** Link to an operator’s website. This property is OCPI-compliant. */
3787
3667
  website?: Maybe<Scalars["String"]>;
3788
- /** Image link to an operator’s logo. */
3668
+ /** Image link to an operator’s logo. This property is OCPI-compliant. */
3789
3669
  logo?: Maybe<OCPIImage>;
3790
3670
  /**
3791
3671
  * ISO-3166 alpha-2 country code an operator is active in.
@@ -3797,33 +3677,33 @@ export declare type Operator = {
3797
3677
  /** Contact information. */
3798
3678
  contact?: Maybe<Contact>;
3799
3679
  /**
3800
- * 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.
3801
3681
  * @deprecated In favor of `ranking_levels`.
3802
3682
  */
3803
3683
  ranking?: Maybe<Scalars["Int"]>;
3804
3684
  /**
3805
- * 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.
3806
3686
  * @deprecated In favor of `excluded_countries`.
3807
3687
  */
3808
3688
  excluded?: Maybe<Scalars["Boolean"]>;
3809
- /** 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. */
3810
3690
  ranking_levels?: Maybe<OperatorRankingLevels>;
3811
- /** 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. */
3812
3692
  excluded_countries?: Maybe<Array<CountryCodeAlpha2>>;
3813
- /** 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. */
3814
3694
  avoided_countries?: Maybe<Array<CountryCodeAlpha2>>;
3815
3695
  };
3816
3696
  /** Criteria to filter operators in the operator list query. */
3817
3697
  export declare type OperatorListFilter = {
3818
3698
  /** ISO-3166 alpha-2 country codes an operator is active in. */
3819
3699
  countries?: Maybe<Array<CountryCodeAlpha2>>;
3820
- /** 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. */
3821
3701
  ranking?: Maybe<Array<Scalars["Int"]>>;
3822
- /** 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. */
3823
3703
  excluded?: Maybe<Scalars["Boolean"]>;
3824
- /** 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. */
3825
3705
  ranking_levels?: Maybe<OperatorRankingLevelsFilter>;
3826
- /** 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. */
3827
3707
  excluded_countries?: Maybe<Array<CountryCodeAlpha2>>;
3828
3708
  };
3829
3709
  /** Query parameters to filter operators in the operator list query. */
@@ -3853,7 +3733,7 @@ export declare enum OperatorRankingLevel {
3853
3733
  MEDIUM = "medium",
3854
3734
  HIGH = "high"
3855
3735
  }
3856
- /** 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. */
3857
3737
  export declare type OperatorRankingLevels = {
3858
3738
  /** Low level for operators ranking. */
3859
3739
  low?: Maybe<Array<CountryCodeAlpha2>>;
@@ -3876,7 +3756,7 @@ export declare type OutsideTempInput = {
3876
3756
  value: Scalars["Float"];
3877
3757
  /** Preferred unit for the outside temperature. */
3878
3758
  type: TemperatureUnit;
3879
- /** Source of inputted data, defaults to 'manual'. */
3759
+ /** Source of inputted data, defaults to `manual`. */
3880
3760
  source?: Maybe<TelemetryInputSource>;
3881
3761
  };
3882
3762
  export declare type OutsideTemperature = {
@@ -3961,7 +3841,7 @@ export declare type PowerInput = {
3961
3841
  value: Scalars["Float"];
3962
3842
  /** Preferred unit for the power. */
3963
3843
  type: PowerUnit;
3964
- /** Source of inputted data, defaults to 'manual'. */
3844
+ /** Source of inputted data, defaults to `manual`. */
3965
3845
  source?: Maybe<TelemetryInputSource>;
3966
3846
  };
3967
3847
  export declare enum PowerSupported {
@@ -4031,7 +3911,7 @@ export declare type PricingListProduct = {
4031
3911
  export declare type Query = {
4032
3912
  /** Get a full list of amenities around a station. */
4033
3913
  amenityList?: Maybe<Array<Maybe<Amenity>>>;
4034
- /** [BETA] Get a connected vehicles by id */
3914
+ /** [BETA] Get a connected vehicle by ID. */
4035
3915
  connectedVehicle?: Maybe<ConnectedVehicle>;
4036
3916
  /** [BETA] Get the connected vehicles for the current user */
4037
3917
  connectedVehicleList?: Maybe<Array<Maybe<ConnectedVehicle>>>;
@@ -4073,9 +3953,9 @@ export declare type Query = {
4073
3953
  /** Get a route by ID. */
4074
3954
  getRoute: RouteResponse;
4075
3955
  /** [BETA] Search for stations with amenities within a specific time window and distance of a previously calculated route. */
4076
- getRouteStationsWithAmenities: RouteStationsWithAmenitiesConnection;
4077
- /** [ALPHA] Get a e-truck route by ID. */
4078
- getTruckRoute: TruckRouteResponse;
3956
+ getRouteStationsWithAmenities?: Maybe<RouteStationsWithAmenitiesConnection>;
3957
+ /** [ALPHA] Get an e-truck route by ID. */
3958
+ getTruckRoute?: Maybe<TruckRouteResponse>;
4079
3959
  /** [ALPHA] Get a route by request ID. */
4080
3960
  getMatchedRoute?: Maybe<MatchedRouteResponse>;
4081
3961
  /** Get information about a station by its ID. */
@@ -4298,7 +4178,7 @@ export declare type RequestEvBatteryValue = {
4298
4178
  };
4299
4179
  /** Vehicle cabin configuration. */
4300
4180
  export declare type RequestEvCabin = {
4301
- /** 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. */
4302
4182
  isPreconditioned?: Maybe<Scalars["Boolean"]>;
4303
4183
  /** Desired cabin temperature. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
4304
4184
  desiredTemperature?: Maybe<Scalars["Float"]>;
@@ -4309,7 +4189,7 @@ export declare type RequestEvCabindesiredTemperatureArgs = {
4309
4189
  };
4310
4190
  /** Vehicle cabin configuration. */
4311
4191
  export declare type RequestEvCabinInput = {
4312
- /** 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. */
4313
4193
  isPreconditioned?: Maybe<Scalars["Boolean"]>;
4314
4194
  /** Desired cabin temperature. Default is 20 degrees Celsius or 68 degrees Fahrenheit. */
4315
4195
  desiredTemperature?: Maybe<TemperatureInput>;
@@ -4431,7 +4311,7 @@ export declare type RequestRoute = {
4431
4311
  /** Radius in meters for alternative stations along a route (min 500 - max 5000). */
4432
4312
  stationsAlongRouteRadius?: Maybe<Scalars["Int"]>;
4433
4313
  /**
4434
- * 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.
4435
4315
  * @deprecated All routes will have turn-by-turn instructions prepared. Boolean will be ignored.
4436
4316
  */
4437
4317
  instructions?: Maybe<Scalars["Boolean"]>;
@@ -4518,19 +4398,6 @@ export declare type ReviewAdd = {
4518
4398
  /** Boolean tags for a station review. */
4519
4399
  tags?: Maybe<ReviewTagsInput>;
4520
4400
  };
4521
- /** Form input for edit an existing review. */
4522
- export declare type ReviewEdit = {
4523
- /** Rating of a review. */
4524
- rating: Scalars["Int"];
4525
- /** Review message. */
4526
- message?: Maybe<Scalars["String"]>;
4527
- /** Locale of a message. */
4528
- locale?: Maybe<Scalars["String"]>;
4529
- /** Optional object where you can store custom data you need in your application. This extends the current functionalities we offer. */
4530
- properties?: Maybe<Scalars["JSON"]>;
4531
- /** Boolean tags for a station review. */
4532
- tags?: Maybe<ReviewTagsInput>;
4533
- };
4534
4401
  /** Statistical information for reviews of a station. */
4535
4402
  export declare type ReviewStats = {
4536
4403
  /** Average of all reviews. */
@@ -4638,7 +4505,7 @@ export declare type RouteAlternative = {
4638
4505
  legs?: Maybe<Array<Maybe<RouteLeg>>>;
4639
4506
  /** List of raw turn-by-turn navigation instructions. */
4640
4507
  instructions?: Maybe<Array<Maybe<RouteInstruction>>>;
4641
- /** 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. */
4642
4509
  stationsAlongRoute?: Maybe<Array<Maybe<RouteStationsAlong>>>;
4643
4510
  /** Tags of a route alternative. Values: road, highway, toll, ferry, etc. */
4644
4511
  tags?: Maybe<Array<Maybe<RouteTagType>>>;
@@ -4983,7 +4850,7 @@ export declare type RouteDetailsLegSection = {
4983
4850
  duration: Scalars["Float"];
4984
4851
  /** Total energy used in a section in kilowatt-hours. The value will be 0 for walking sections. */
4985
4852
  consumption?: Maybe<Scalars["Float"]>;
4986
- /** [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. */
4987
4854
  traffic?: Maybe<RouteDetailsLegSectionTraffic>;
4988
4855
  };
4989
4856
  export declare type RouteDetailsLegSectionpolylineArgs = {
@@ -5059,29 +4926,31 @@ export declare type RouteDetailsLegWarning = {
5059
4926
  };
5060
4927
  /** Types of warnings that can be encountered in a route leg. */
5061
4928
  export declare enum RouteDetailsLegWarningCode {
5062
- /** The via location cannot be reached by vehicle. */
4929
+ /** Via location cannot be reached by vehicle. */
5063
4930
  VIA_NOT_VEHICLE_ACCESSIBLE = "via_not_vehicle_accessible",
5064
- /** The leg could not use stations from the preferred operator(s). */
4931
+ /** Leg could not use stations from the preferred operator(s). */
5065
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",
5066
4935
  /** Vehicle's load may exceed the maximum supported weight of the vehicle. */
5067
4936
  MAXIMUM_WEIGHT_EXCEEDED = "maximum_weight_exceeded",
5068
- /** The leg includes sections requested to be avoided. */
4937
+ /** Leg includes sections requested to be avoided. */
5069
4938
  SEGMENT_UNAVOIDABLE = "segment_unavoidable",
5070
- /** The charging station used in the leg has limited opening hours. */
4939
+ /** Leg's charging station has limited opening hours. */
5071
4940
  STATION_LIMITED_OPEN_HOURS = "station_limited_open_hours",
5072
- /** The leg's charging station has unknown open hours. */
4941
+ /** Leg's charging station has unknown open hours. */
5073
4942
  STATION_UNKNOWN_OPEN_HOURS = "station_unknown_open_hours",
5074
- /** 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. */
5075
4944
  STATION_CLOSED = "station_closed",
5076
- /** 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. */
5077
4946
  STATION_CLOSING_SOON = "station_closing_soon",
5078
- /** 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. */
5079
4948
  VIA_INSUFFICIENT_CHARGING_TIME = "via_insufficient_charging_time",
5080
- /** 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. */
5081
4950
  VIA_STATION_BELOW_MINIMUM_POWER = "via_station_below_minimum_power",
5082
- /** 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. */
5083
4952
  DESTINATION_CHARGER_INCOMPATIBLE = "destination_charger_incompatible",
5084
- /** The charging station at the destination is restricted to heavy-duty trucks. */
4953
+ /** Charging station at the destination is restricted to heavy-duty trucks. */
5085
4954
  DESTINATION_STATION_TRUCK_ONLY = "destination_station_truck_only",
5086
4955
  /** Expected arrival state of charge for the leg is below the safety risk margin. */
5087
4956
  RISK_MARGIN_SOC_NOT_POSSIBLE = "risk_margin_soc_not_possible",
@@ -5182,19 +5051,19 @@ export declare type RouteDetailsTraffic = {
5182
5051
  congestions: Array<Maybe<TrafficCongestionInterval>>;
5183
5052
  };
5184
5053
  export declare type RouteDrivingPreferences = {
5185
- /** [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`. */
5186
5055
  speed_factor?: Maybe<Scalars["Float"]>;
5187
- /** [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`. */
5188
5057
  maximum_speed?: Maybe<MaximumSpeed>;
5189
- /** [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`. */
5190
5059
  style?: Maybe<RouteDrivingStyle>;
5191
5060
  };
5192
5061
  export declare type RouteDrivingPreferencesInput = {
5193
- /** [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`. */
5194
5063
  speed_factor?: Maybe<Scalars["Float"]>;
5195
- /** [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`. */
5196
5065
  maximum_speed?: Maybe<MaximumSpeedInput>;
5197
- /** [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`. */
5198
5067
  style?: Maybe<RouteDrivingStyle>;
5199
5068
  };
5200
5069
  export declare enum RouteDrivingStyle {
@@ -5489,10 +5358,6 @@ export declare type RouteLeg = {
5489
5358
  export declare type RouteLegpolylineArgs = {
5490
5359
  decimals?: Maybe<Scalars["Int"]>;
5491
5360
  };
5492
- export declare type RouteLegMeta = {
5493
- /** Warnings that certain conditions specified in a route mutation are not respected. */
5494
- warnings: Array<RouteMetaWarning>;
5495
- };
5496
5361
  export declare type RouteLegOperationalElectricityEmissions = {
5497
5362
  /** Total electricity emissions. */
5498
5363
  total: Scalars["Float"];
@@ -5555,22 +5420,10 @@ export declare type RouteLegOperationalElectricityEmissionsIntensitytotalArgs =
5555
5420
  export declare type RouteLegOperationalElectricityEmissionsIntensityinfrastructureArgs = {
5556
5421
  unit?: Maybe<EmissionUnit>;
5557
5422
  };
5558
- export declare type RouteMeta = {
5559
- /** Warnings that certain conditions specified in a route mutation are not respected. */
5560
- warnings: Array<RouteMetaWarning>;
5561
- };
5562
- export declare type RouteMetaWarning = {
5563
- /** Static identifier, can be used for production purposes such as i18n. */
5564
- code: Scalars["String"];
5565
- /** Human readable explanation of the warning, for development purposes. */
5566
- message: Scalars["String"];
5567
- /** Optional JSON object containing data explaining the warning, for development purposes. */
5568
- data?: Maybe<Scalars["JSON"]>;
5569
- };
5570
5423
  export declare type RouteMetadata = {
5571
5424
  /** Refers to the x-app-id specified in the headers. */
5572
5425
  app_id: Scalars["ID"];
5573
- /** Date when a route was created by a createRoute mutation. */
5426
+ /** Date when a route was created by a `createRoute` mutation. */
5574
5427
  created_at: Scalars["DateTime"];
5575
5428
  /** Last updated date of a route. */
5576
5429
  updated_at: Scalars["DateTime"];
@@ -5918,7 +5771,7 @@ export declare type RouteOperatorPreferencesRanking = {
5918
5771
  levels?: Maybe<RouteOperatorPreferencesRankingLevels>;
5919
5772
  };
5920
5773
  export declare type RouteOperatorPreferencesRankingInput = {
5921
- /** 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. */
5922
5775
  type: RouteOperatorsType;
5923
5776
  /** Priority levels for operator ranking. If not specified, applies the specified enforcement type to the project-configured operator ranking. */
5924
5777
  levels?: Maybe<RouteOperatorPreferencesRankingLevelsInput>;
@@ -6103,7 +5956,7 @@ export declare type RoutePropertiesStationInput = {
6103
5956
  export declare type RoutePropertiesVehicle = {
6104
5957
  /** Number of occupants present in the vehicle. */
6105
5958
  occupants: Scalars["Int"];
6106
- /** 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`. */
6107
5960
  total_occupant_weight: TotalOccupantWeight;
6108
5961
  /** Weight of the cargo. */
6109
5962
  total_cargo_weight?: Maybe<TotalCargoWeight>;
@@ -6111,7 +5964,7 @@ export declare type RoutePropertiesVehicle = {
6111
5964
  export declare type RoutePropertiesVehicleInput = {
6112
5965
  /** Number of occupants present in the vehicle. */
6113
5966
  occupants?: Maybe<Scalars["Int"]>;
6114
- /** 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`. */
6115
5968
  total_occupant_weight?: Maybe<TotalOccupantWeightInput>;
6116
5969
  /** Weight of the cargo. */
6117
5970
  total_cargo_weight?: Maybe<TotalCargoWeightInput>;
@@ -6148,7 +6001,7 @@ export declare type RouteScheduledChargeStop = {
6148
6001
  types?: Maybe<Array<Maybe<AmenityType>>>;
6149
6002
  /** Duration at the amenity, in seconds. */
6150
6003
  duration?: Maybe<Scalars["Int"]>;
6151
- /** 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. */
6152
6005
  offset?: Maybe<Scalars["Int"]>;
6153
6006
  /** Desired drive time before a scheduled stop after leaving the previous stop, in seconds. */
6154
6007
  stop_after?: Maybe<Scalars["Int"]>;
@@ -6272,7 +6125,7 @@ export declare enum RouteTagType {
6272
6125
  export declare type RouteTimeWindow = {
6273
6126
  /** Center point of the search, expressed as the travel time, in seconds, from the journey's origin. */
6274
6127
  center: Scalars["Int"];
6275
- /** 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). */
6276
6129
  margin?: Maybe<Scalars["Int"]>;
6277
6130
  };
6278
6131
  /** Types of route features that can be avoided in truck routing. */
@@ -6313,11 +6166,11 @@ export declare type RouteTruckOriginPropertiesInput = {
6313
6166
  vehicle?: Maybe<RouteTruckPropertiesVehicleInput>;
6314
6167
  };
6315
6168
  export declare type RouteTruckPropertiesLocation = {
6316
- /** Name override for the choosen location. */
6169
+ /** Name override for the chosen location. */
6317
6170
  name?: Maybe<Scalars["String"]>;
6318
6171
  };
6319
6172
  export declare type RouteTruckPropertiesLocationInput = {
6320
- /** Name override for the choosen location. */
6173
+ /** Name override for the chosen location. */
6321
6174
  name?: Maybe<Scalars["String"]>;
6322
6175
  };
6323
6176
  export declare type RouteTruckPropertiesVehicle = {
@@ -6327,9 +6180,9 @@ export declare type RouteTruckPropertiesVehicle = {
6327
6180
  total_occupant_weight?: Maybe<TotalOccupantWeight>;
6328
6181
  /** Total weight of all cargo in the vehicle, including the cargo in any attached trailers. */
6329
6182
  total_cargo_weight?: Maybe<TotalCargoWeight>;
6330
- /** 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. */
6331
6184
  axles_in_use?: Maybe<Scalars["Int"]>;
6332
- /** 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. */
6333
6186
  trailer?: Maybe<RouteTruckVehicleTrailer>;
6334
6187
  };
6335
6188
  export declare type RouteTruckPropertiesVehicleInput = {
@@ -6339,9 +6192,9 @@ export declare type RouteTruckPropertiesVehicleInput = {
6339
6192
  total_occupant_weight?: Maybe<TotalOccupantWeightInput>;
6340
6193
  /** Total weight of all cargo in the vehicle, including the cargo in any attached trailers. */
6341
6194
  total_cargo_weight?: Maybe<TotalCargoWeightInput>;
6342
- /** 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. */
6343
6196
  axles_in_use?: Maybe<Scalars["Int"]>;
6344
- /** 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. */
6345
6198
  trailer?: Maybe<RouteTruckVehicleTrailerInput>;
6346
6199
  };
6347
6200
  export declare type RouteTruckVehicle = {
@@ -6695,7 +6548,7 @@ export declare type RouteWarning = {
6695
6548
  };
6696
6549
  /** Types of warnings that can be encountered in a route. */
6697
6550
  export declare enum RouteWarningCode {
6698
- /** 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. */
6699
6552
  EV_UNAVAILABLE_IN_REGION = "ev_unavailable_in_region",
6700
6553
  /** Route excludes charging stations as a hybrid vehicle does not require external charging. */
6701
6554
  HEV_NO_CHARGING_STATIONS = "hev_no_charging_stations",
@@ -6723,7 +6576,7 @@ export declare enum RouteWarningCode {
6723
6576
  export declare type RouteWeather = {
6724
6577
  /** Weather configuration applied to the route. */
6725
6578
  type: WeatherType;
6726
- /** [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`. */
6727
6580
  custom?: Maybe<RouteWeatherCustomConditions>;
6728
6581
  };
6729
6582
  export declare type RouteWeatherCustomConditions = {
@@ -6745,7 +6598,7 @@ export declare type RouteWeatherCustomConditionsInput = {
6745
6598
  export declare type RouteWeatherInput = {
6746
6599
  /** Weather configuration applied to the route. */
6747
6600
  type?: Maybe<WeatherType>;
6748
- /** [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. */
6749
6602
  custom?: Maybe<RouteWeatherCustomConditionsInput>;
6750
6603
  };
6751
6604
  /** Scheduled charge stop along a route. */
@@ -6754,7 +6607,7 @@ export declare type ScheduledChargeStopInput = {
6754
6607
  types: Array<AmenityType>;
6755
6608
  /** Duration at the amenity, in seconds. The value should be between 900 and 86400. */
6756
6609
  duration: Scalars["Int"];
6757
- /** Maximum allowed offset from the stop_after value in seconds. */
6610
+ /** Maximum allowed offset from the `stop_after` value in seconds. */
6758
6611
  offset?: Maybe<Scalars["Int"]>;
6759
6612
  /** Desired drive time for a scheduled stop after leaving the origin point, in seconds. */
6760
6613
  stop_after: Scalars["Int"];
@@ -6776,10 +6629,6 @@ export declare type SolarIrradianceInput = {
6776
6629
  export declare enum SolarIrradianceUnit {
6777
6630
  WATTS_PER_SQUARE_METER = "watts_per_square_meter"
6778
6631
  }
6779
- export declare enum SortDirection {
6780
- ASCENDING = "ascending",
6781
- DESCENDING = "descending"
6782
- }
6783
6632
  export declare enum SpeedUnit {
6784
6633
  /** Return the speed in kilometers per hour. */
6785
6634
  KILOMETERS_PER_HOUR = "kilometers_per_hour",
@@ -6799,7 +6648,7 @@ export declare type StateOfChargeInput = {
6799
6648
  value: Scalars["Float"];
6800
6649
  /** Preferred unit for the vehicle's state of charge. */
6801
6650
  type: StateOfChargeUnit;
6802
- /** Source of inputted data, defaults to 'manual'. */
6651
+ /** Source of inputted data, defaults to `manual`. */
6803
6652
  source?: Maybe<TelemetryInputSource>;
6804
6653
  };
6805
6654
  export declare enum StateOfChargeUnit {
@@ -6814,59 +6663,59 @@ export declare enum StateOfChargeUnit {
6814
6663
  }
6815
6664
  /** Station data which extends OCPI Location. */
6816
6665
  export declare type Station = {
6817
- /** Unique ID of a station. */
6666
+ /** Unique ID of a station. This property is OCPI-compliant. */
6818
6667
  id: Scalars["ID"];
6819
- /** ISO-3166 alpha-2 country code of a station. */
6668
+ /** ISO-3166 alpha-2 country code of a station. This property is OCPI-compliant. */
6820
6669
  country_code?: Maybe<Scalars["String"]>;
6821
- /** 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. */
6822
6671
  party_id?: Maybe<Scalars["String"]>;
6823
6672
  /**
6824
6673
  * Defines if a location may be published on a website or app etc.
6825
- * When this is set to false, only tokens identified in the field: publish_allowed_to are allowed to show this location.
6826
- * 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.
6827
6676
  */
6828
6677
  publish?: Maybe<Scalars["Boolean"]>;
6829
- /** Name of a charging station. */
6678
+ /** Name of a charging station. This property is OCPI-compliant. */
6830
6679
  name?: Maybe<Scalars["String"]>;
6831
- /** Street/block name and house number if available. */
6680
+ /** Street/block name and house number if available. This property is OCPI-compliant. */
6832
6681
  address?: Maybe<Scalars["String"]>;
6833
- /** City or town */
6682
+ /** City or town. This property is OCPI-compliant. */
6834
6683
  city?: Maybe<Scalars["String"]>;
6835
- /** 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. */
6836
6685
  postal_code?: Maybe<Scalars["String"]>;
6837
- /** 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. */
6838
6687
  state?: Maybe<Scalars["String"]>;
6839
- /** 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. */
6840
6689
  country?: Maybe<Scalars["String"]>;
6841
- /** Coordinates of a location. */
6690
+ /** Coordinates of a location. This property is OCPI-compliant. */
6842
6691
  coordinates?: Maybe<OCPIGeoLocation>;
6843
- /** Geographical location of related points relevant to a user. */
6692
+ /** Geographical location of related points relevant to a user. This property is OCPI-compliant. */
6844
6693
  related_locations?: Maybe<Array<Maybe<OCPIAdditionalGeoLocation>>>;
6845
- /** Type of parking at a charge point location. */
6694
+ /** Type of parking at a charge point location. This property is OCPI-compliant. */
6846
6695
  parking_type?: Maybe<OCPIParkingType>;
6847
- /** EVSEs that belong to a station. */
6696
+ /** EVSEs that belong to a station. This property is OCPI-compliant. */
6848
6697
  evses?: Maybe<Array<Maybe<EVSE>>>;
6849
- /** Human-readable directions on how to reach a station. */
6698
+ /** Human-readable directions on how to reach a station. This property is OCPI-compliant. */
6850
6699
  directions?: Maybe<Array<Maybe<OCPIDisplayText>>>;
6851
- /** Information about an operator. */
6700
+ /** Information about an operator. This property is OCPI-compliant. */
6852
6701
  operator?: Maybe<Operator>;
6853
- /** Information about a suboperator if applicable. */
6702
+ /** Information about a suboperator if applicable. This property is OCPI-compliant. */
6854
6703
  suboperator?: Maybe<Operator>;
6855
- /** Information about an owner if available. */
6704
+ /** Information about an owner if available. This property is OCPI-compliant. */
6856
6705
  owner?: Maybe<Operator>;
6857
- /** Facilities a charging station belongs to. */
6706
+ /** Facilities a charging station belongs to. This property is OCPI-compliant. */
6858
6707
  facilities?: Maybe<Array<Maybe<OCPIFacility>>>;
6859
- /** 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. */
6860
6709
  time_zone?: Maybe<Scalars["String"]>;
6861
- /** 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. */
6862
6711
  opening_times?: Maybe<OCPIHours>;
6863
- /** 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. */
6864
6713
  charging_when_closed?: Maybe<Scalars["Boolean"]>;
6865
- /** 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. */
6866
6715
  images?: Maybe<Array<Maybe<OCPIImage>>>;
6867
- /** Details of the energy supplied at a location. */
6716
+ /** Details of the energy supplied at a location. This property is OCPI-compliant. */
6868
6717
  energy_mix?: Maybe<OCPIEnergyMix>;
6869
- /** 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. */
6870
6719
  last_updated?: Maybe<Scalars["DateTime"]>;
6871
6720
  /** ID provided by a station data source. */
6872
6721
  external_id?: Maybe<Scalars["String"]>;
@@ -6886,9 +6735,9 @@ export declare type Station = {
6886
6735
  heavy_vehicles_restrictions?: Maybe<StationHeavyVehiclesRestrictions>;
6887
6736
  /** Describes the vehicle restrictions at the location. */
6888
6737
  vehicle_restrictions?: Maybe<StationVehicleRestrictions>;
6889
- /** 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". */
6890
6739
  location_category?: Maybe<Scalars["String"]>;
6891
- /** 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. */
6892
6741
  entrance_for_navigation?: Maybe<Array<OCPIAdditionalGeoLocation>>;
6893
6742
  /**
6894
6743
  * Optional object where you can store custom data you need in your application. This extends the current functionalities we offer.
@@ -6929,7 +6778,7 @@ export declare enum StationAdhocAuthorisationPaymentMethod {
6929
6778
  AUTH_BY_CAR_PLUG_AND_CHARGE = "AUTH_BY_CAR_PLUG_AND_CHARGE",
6930
6779
  /** Apple Pay. */
6931
6780
  ONLINE_APPLE_PAY = "ONLINE_APPLE_PAY",
6932
- /** Terminal in app. */
6781
+ /** Terminal in-app. */
6933
6782
  TERMINAL_IN_APP = "TERMINAL_IN_APP",
6934
6783
  /** PayPal. */
6935
6784
  ONLINE_PAYPAL = "ONLINE_PAYPAL",
@@ -7065,13 +6914,6 @@ export declare type StationListQuery = {
7065
6914
  /** Exact name. */
7066
6915
  name?: Maybe<Scalars["String"]>;
7067
6916
  };
7068
- /** Station availability for each weekday and hour. */
7069
- export declare type StationPredictedAvailability = {
7070
- /** Number of weekday from 1 (monday) to 7 (sunday). */
7071
- weekday?: Maybe<Scalars["Int"]>;
7072
- /** The prediction for each hour 0-23 from 1 to 5 (1 - very busy ... 5 very quiet (free)). */
7073
- prediction?: Maybe<Array<Maybe<Scalars["Int"]>>>;
7074
- };
7075
6917
  /** Station occupancy for each weekday and hour. */
7076
6918
  export declare type StationPredictedOccupancy = {
7077
6919
  /** Number of weekday from 1 (monday) to 7 (sunday). */
@@ -7165,7 +7007,7 @@ export declare type Subscription = {
7165
7007
  /** Subscribe to a specific route to receive system event updates. */
7166
7008
  route: RouteResponse;
7167
7009
  /** [ALPHA] Subscribe to e-truck route to receive system event updates. */
7168
- truckRoute: TruckRouteResponse;
7010
+ truckRoute?: Maybe<TruckRouteResponse>;
7169
7011
  /** [BETA] Subscribe to navigation session system event updates. We strongly recommend using this at all times to not miss any updates. */
7170
7012
  navigation?: Maybe<NavigationSubscription>;
7171
7013
  /** [BETA] Subscribe to a connected vehicle. */
@@ -7360,7 +7202,7 @@ export declare type TirePressureInput = {
7360
7202
  value: Array<Scalars["Float"]>;
7361
7203
  /** Preferred unit for the tire pressure. */
7362
7204
  type: PressureUnit;
7363
- /** Source of inputted data, defaults to 'manual'. */
7205
+ /** Source of inputted data, defaults to `manual`. */
7364
7206
  source?: Maybe<TelemetryInputSource>;
7365
7207
  };
7366
7208
  export declare enum TorqueUnit {
@@ -7382,7 +7224,7 @@ export declare type TotalCargoWeightInput = {
7382
7224
  value: Scalars["Float"];
7383
7225
  /** Preferred unit for the current weight of the cargo. */
7384
7226
  type: WeightUnit;
7385
- /** Source of inputted data, defaults to 'manual'. */
7227
+ /** Source of inputted data, defaults to `manual`. */
7386
7228
  source?: Maybe<TelemetryInputSource>;
7387
7229
  };
7388
7230
  export declare type TotalOccupantWeight = {
@@ -7398,7 +7240,7 @@ export declare type TotalOccupantWeightInput = {
7398
7240
  value: Scalars["Float"];
7399
7241
  /** Preferred unit for the current weight of the occupants. */
7400
7242
  type: WeightUnit;
7401
- /** Source of inputted data, defaults to 'manual'. */
7243
+ /** Source of inputted data, defaults to `manual`. */
7402
7244
  source?: Maybe<TelemetryInputSource>;
7403
7245
  };
7404
7246
  export declare type TrafficCongestionInterval = {
@@ -7432,7 +7274,7 @@ export declare type TruckRouteDetails = {
7432
7274
  savings?: Maybe<RouteDetailsSavings>;
7433
7275
  /** Legs of a route. */
7434
7276
  legs: Array<TruckRouteDetailsLeg>;
7435
- /** 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. */
7436
7278
  alternative_stations: Array<RouteDetailsAlternativeStation>;
7437
7279
  /** Aggregation of tags over the current RouteDetails. Tags are available on legs and further subdivided over individual sections and maneuvers. */
7438
7280
  tags: Array<RouteDetailsTag>;
@@ -7520,7 +7362,7 @@ export declare type TruckRouteDetailsLegFeatureProperties = {
7520
7362
  /** External ID of the station. */
7521
7363
  external_station_id?: Maybe<Scalars["ID"]>;
7522
7364
  /** Temperature at the location. */
7523
- temperature?: Maybe<Scalars["Int"]>;
7365
+ temperature?: Maybe<Scalars["Float"]>;
7524
7366
  /** Air pressure at the location. */
7525
7367
  air_pressure?: Maybe<Scalars["Float"]>;
7526
7368
  /** Solar irradiance at the location. */
@@ -7723,11 +7565,11 @@ export declare type VehicleBattery = {
7723
7565
  export declare enum VehicleBatteryFieldEstimations {
7724
7566
  /** Both of the battery kWh fields are estimations. */
7725
7567
  B = "B",
7726
- /** full_kwh field is estimated. */
7568
+ /** `full_kwh` field is estimated. */
7727
7569
  F = "F",
7728
7570
  /** None of the battery kWh fields are estimations. */
7729
7571
  N = "N",
7730
- /** usable_kwh field is estimated. */
7572
+ /** `usable_kwh` field is estimated. */
7731
7573
  U = "U"
7732
7574
  }
7733
7575
  export declare enum VehicleBatteryType {
@@ -7801,13 +7643,6 @@ export declare type VehicleConnectorspeedArgs = {
7801
7643
  export declare type VehicleConnectorcharge_speedArgs = {
7802
7644
  unit?: Maybe<ChargeSpeedUnit>;
7803
7645
  };
7804
- /** The consumption of the vehicle. */
7805
- export declare type VehicleConsumptionInput = {
7806
- /** Worst conditions are based on -10°C and use of heating. */
7807
- worst?: Maybe<Scalars["Float"]>;
7808
- /** Best conditions are based on 23°C and no use of A/C. */
7809
- best?: Maybe<Scalars["Float"]>;
7810
- };
7811
7646
  export declare type VehicleData = {
7812
7647
  /** Battery data */
7813
7648
  battery?: Maybe<ConnectBattery>;
@@ -7818,12 +7653,6 @@ export declare type VehicleData = {
7818
7653
  /** Odometer data */
7819
7654
  odometer?: Maybe<ConnectOdometer>;
7820
7655
  };
7821
- export declare enum VehicleDataProvider {
7822
- /** Internal data provider. */
7823
- CHARGETRIP = "chargetrip",
7824
- /** EV database data provider. */
7825
- EVDATABASE = "evdatabase"
7826
- }
7827
7656
  export declare type VehicleDrivetrain = {
7828
7657
  /** Type of drivetrain. */
7829
7658
  type: VehicleDrivetrainType;
@@ -7891,13 +7720,6 @@ export declare enum VehicleImageType {
7891
7720
  /** Placeholder image at 1536x864 px. */
7892
7721
  PLACEHOLDER = "placeholder"
7893
7722
  }
7894
- /** When uploading images to a vehicle, you can select one of this types. The rest of the types are automatically generated by the system. */
7895
- export declare enum VehicleImageTypeUploadable {
7896
- /** Freemium vehicle image. */
7897
- IMAGE = "image",
7898
- /** Premium vehicle image. */
7899
- IMAGE_PREMIUM = "image_premium"
7900
- }
7901
7723
  /** The output element of the vehicleList query. */
7902
7724
  export declare type VehicleList = {
7903
7725
  /** Vehicles unique ID. */
@@ -7987,7 +7809,7 @@ export declare type VehicleListNaming = {
7987
7809
  version?: Maybe<Scalars["String"]>;
7988
7810
  /** Another submodel level of the vehicle. */
7989
7811
  edition?: Maybe<Scalars["String"]>;
7990
- /** 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. */
7991
7813
  chargetrip_version: Scalars["String"];
7992
7814
  };
7993
7815
  export declare type VehicleListRange = {
@@ -8047,15 +7869,6 @@ export declare type VehicleMedia = {
8047
7869
  /** All videos of the vehicle. */
8048
7870
  video_list?: Maybe<Array<VehicleVideo>>;
8049
7871
  };
8050
- /** Mode (state) of the current production. */
8051
- export declare enum VehicleMode {
8052
- /** Old vehicle that is no longer manufactured. */
8053
- INDEX_ONLY = "index_only",
8054
- /** Vehicle is in production and has been released. */
8055
- PRODUCTION = "production",
8056
- /** Future releases of a vehicle, a concept of the vehicle, specs may change over time. */
8057
- CONCEPT = "concept"
8058
- }
8059
7872
  /** Vehicle model data. */
8060
7873
  export declare type VehicleModel = {
8061
7874
  /** Vehicle model name. */
@@ -8086,7 +7899,7 @@ export declare type VehicleNaming = {
8086
7899
  version?: Maybe<Scalars["String"]>;
8087
7900
  /** Another submodel level of the vehicle. */
8088
7901
  edition?: Maybe<Scalars["String"]>;
8089
- /** 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. */
8090
7903
  chargetrip_version: Scalars["String"];
8091
7904
  };
8092
7905
  export declare type VehiclePerformance = {
@@ -8133,7 +7946,7 @@ export declare type VehiclePremium = {
8133
7946
  body: VehiclePremiumBody;
8134
7947
  /** Availability of the vehicle. */
8135
7948
  availability: VehiclePremiumAvailability;
8136
- /** 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. */
8137
7950
  pricing: VehiclePremiumPriceValueWithGrant;
8138
7951
  /** Drivetrain of the vehicle. */
8139
7952
  drivetrain: VehiclePremiumDrivetrain;
@@ -8165,7 +7978,7 @@ export declare type VehiclePremiumAvailability = {
8165
7978
  status: VehicleAvailabilityStatus;
8166
7979
  /** Date of introduction, mm-yyyy. */
8167
7980
  date_from?: Maybe<Scalars["String"]>;
8168
- /** Indicates if date from field is estimated. */
7981
+ /** Indicates if `date_from` field is estimated. */
8169
7982
  date_from_is_estimated?: Maybe<Scalars["Boolean"]>;
8170
7983
  /** Date last available, mm-yyyy. */
8171
7984
  date_to?: Maybe<Scalars["String"]>;
@@ -8214,7 +8027,7 @@ export declare type VehiclePremiumBody = {
8214
8027
  size_is_estimated?: Maybe<Scalars["Boolean"]>;
8215
8028
  /** Wheelbase. */
8216
8029
  wheelbase?: Maybe<Scalars["Float"]>;
8217
- /** Indicates if wheelbase field is estimated. */
8030
+ /** Indicates if `wheelbase` field is estimated. */
8218
8031
  wheelbase_is_estimated?: Maybe<Scalars["Boolean"]>;
8219
8032
  /** Ground clearance of a vehicle as specified by the OEM. */
8220
8033
  ground_clearance?: Maybe<Scalars["Float"]>;
@@ -8226,7 +8039,7 @@ export declare type VehiclePremiumBody = {
8226
8039
  weight_gtw?: Maybe<VehicleBodyWeight>;
8227
8040
  /** Allowed payload weight. */
8228
8041
  weight_payload?: Maybe<VehicleBodyWeight>;
8229
- /** Indicates if weight field is estimated. */
8042
+ /** Indicates if `weight` field is estimated. */
8230
8043
  weight_is_estimated?: Maybe<Scalars["Boolean"]>;
8231
8044
  /** Maximum payload allowed for the vehicle. */
8232
8045
  weight_max_payload?: Maybe<Scalars["Float"]>;
@@ -8443,17 +8256,17 @@ export declare type VehiclePremiumDrivetrain = {
8443
8256
  fuel?: Maybe<VehicleFuel>;
8444
8257
  /** Propulsion type. */
8445
8258
  propulsion?: Maybe<VehiclePropulsion>;
8446
- /** Indicates if propulsion field is estimated. */
8259
+ /** Indicates if `propulsion` field is estimated. */
8447
8260
  propulsion_is_estimated?: Maybe<Scalars["Boolean"]>;
8448
8261
  /** Maximum (combined) power output. */
8449
8262
  power?: Maybe<Scalars["Float"]>;
8450
- /** Indicates if power field is estimated. */
8263
+ /** Indicates if `power` field is estimated. */
8451
8264
  power_is_estimated?: Maybe<Scalars["Boolean"]>;
8452
- /** Maximum (combine) power output. */
8265
+ /** Maximum (combined) power output. */
8453
8266
  power_hp?: Maybe<Scalars["Float"]>;
8454
- /** Maximum (combine) torque output. */
8267
+ /** Maximum (combined) torque output. */
8455
8268
  torque?: Maybe<Scalars["Float"]>;
8456
- /** Indicates if torque field is estimated. */
8269
+ /** Indicates if `torque` field is estimated. */
8457
8270
  torque_is_estimated?: Maybe<Scalars["Boolean"]>;
8458
8271
  };
8459
8272
  export declare type VehiclePremiumDrivetrainpowerArgs = {
@@ -8675,11 +8488,11 @@ export declare type VehiclePremiumNaming = {
8675
8488
  export declare type VehiclePremiumPerformance = {
8676
8489
  /** Acceleration 0-100 km/h. */
8677
8490
  acceleration?: Maybe<Scalars["Float"]>;
8678
- /** Indicates if acceleration field is estimated. */
8491
+ /** Indicates if `acceleration` field is estimated. */
8679
8492
  acceleration_is_estimated?: Maybe<Scalars["Boolean"]>;
8680
8493
  /** Top speed of the vehicle. */
8681
8494
  top_speed?: Maybe<Scalars["Float"]>;
8682
- /** Indicates if top_speed field is estimated. */
8495
+ /** Indicates if `top_speed` field is estimated. */
8683
8496
  top_speed_is_estimated?: Maybe<Scalars["Boolean"]>;
8684
8497
  };
8685
8498
  export declare type VehiclePremiumPerformanceaccelerationArgs = {
@@ -8688,14 +8501,6 @@ export declare type VehiclePremiumPerformanceaccelerationArgs = {
8688
8501
  export declare type VehiclePremiumPerformancetop_speedArgs = {
8689
8502
  unit?: Maybe<SpeedUnit>;
8690
8503
  };
8691
- export declare type VehiclePremiumPrice = {
8692
- /** Starting price for German market. */
8693
- DE?: Maybe<VehiclePremiumPriceValueWithGrant>;
8694
- /** Starting price for Dutch market. */
8695
- NL?: Maybe<VehiclePremiumPriceValueWithGrant>;
8696
- /** Starting price for British market. */
8697
- GB?: Maybe<VehiclePremiumPriceValueWithGrant>;
8698
- };
8699
8504
  export declare type VehiclePremiumPriceValueWithGrant = {
8700
8505
  /** Starting price for the local market. The value applies to the optional `country` field provided in the query input. If `country` is not specified, it defaults to the Dutch market price. If the unit argument is not provided, the value is returned in the local currency of the selected country. */
8701
8506
  value?: Maybe<Scalars["Float"]>;
@@ -8825,23 +8630,12 @@ export declare enum VehiclePropulsion {
8825
8630
  /** Rear-wheel drive vehicle. */
8826
8631
  REAR = "Rear"
8827
8632
  }
8828
- /** Status of a vehicle provider. */
8829
- export declare enum VehicleProviderStatus {
8830
- /** Is imported from any of the data providers. */
8831
- NEW = "new",
8832
- /** Has been attached to core vehicle. */
8833
- ATTACHED = "attached",
8834
- /** Has been detached from a core vehicle. */
8835
- DETACHED = "detached",
8836
- /** Has been archived by database maintainer. */
8837
- ARCHIVED = "archived"
8838
- }
8839
8633
  export declare enum VehiclePurpose {
8840
8634
  /** Vehicle intended for the transportation of passengers. */
8841
8635
  PASSENGER = "passenger",
8842
8636
  /** Vehicle intended for the transportation of cargo. */
8843
8637
  CARGO = "cargo",
8844
- /** 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. */
8845
8639
  UTILITY = "utility"
8846
8640
  }
8847
8641
  export declare type VehicleRange = {
@@ -8912,7 +8706,7 @@ export declare type VehicleSpeedInput = {
8912
8706
  value: Scalars["Float"];
8913
8707
  /** Preferred unit for the vehicle's speed. */
8914
8708
  type: SpeedUnit;
8915
- /** Source of inputted data, defaults to 'manual'. */
8709
+ /** Source of inputted data, defaults to `manual`. */
8916
8710
  source?: Maybe<TelemetryInputSource>;
8917
8711
  };
8918
8712
  export declare type VehicleToEverything = {
@@ -8989,13 +8783,13 @@ export declare enum VolumeUnit {
8989
8783
  }
8990
8784
  /** Type of weather conditions used in the route calculation. */
8991
8785
  export declare enum WeatherType {
8992
- /** 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`. */
8993
8787
  SUMMER = "summer",
8994
- /** 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`. */
8995
8789
  WINTER = "winter",
8996
- /** 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`. */
8997
8791
  ACTUAL = "actual",
8998
- /** Must be used in combination with weather.custom object. */
8792
+ /** Must be used in combination with `weather.custom` object. */
8999
8793
  CUSTOM = "custom"
9000
8794
  }
9001
8795
  export declare type WeightInput = {