@chargetrip/types 1.32.2 → 1.33.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.
@@ -124,7 +124,7 @@ export declare type AuthorizeConnectedVehicleOptions = {
124
124
  /** OAuth code returned as a query parameter on the OAuth callback */
125
125
  code?: Maybe<Scalars["PlainString"]>;
126
126
  };
127
- /** The type of the batter value */
127
+ /** The type of the battery value */
128
128
  export declare enum BatteryInputType {
129
129
  KWH = "kwh",
130
130
  KM = "km",
@@ -1342,21 +1342,71 @@ export declare type Connect = {
1342
1342
  providers?: Maybe<Array<Maybe<ConnectProvider>>>;
1343
1343
  };
1344
1344
  export declare type ConnectBattery = {
1345
+ /** Estimated range by OEM */
1346
+ range?: Maybe<Scalars["Int"]>;
1347
+ /** Percentage of the battery remaining */
1345
1348
  percentage?: Maybe<Scalars["Int"]>;
1346
- date?: Maybe<Scalars["String"]>;
1349
+ /** Capacity of the battery, in kwh */
1350
+ capacity?: Maybe<Scalars["Int"]>;
1351
+ /** Date when the battery data was retrieved, as ISO-8601 date */
1352
+ date?: Maybe<Scalars["DateTime"]>;
1353
+ };
1354
+ export declare type ConnectCharge = {
1355
+ /** Vehicle is plugged in */
1356
+ is_plugged_in?: Maybe<Scalars["Boolean"]>;
1357
+ /** Vehicle is charging */
1358
+ is_charging?: Maybe<Scalars["Boolean"]>;
1359
+ /** Battery is fully charged */
1360
+ is_fully_charged?: Maybe<Scalars["Boolean"]>;
1361
+ /** Charge limit defined by vehicle owner */
1362
+ limit?: Maybe<Scalars["Int"]>;
1363
+ /** Charge speed, in kwh */
1364
+ charge_speed?: Maybe<Scalars["Float"]>;
1365
+ /** Estimation when charging is completed, as ISO-8601 date */
1366
+ fully_charged_at?: Maybe<Scalars["DateTime"]>;
1367
+ /** Estimated minutes till charged */
1368
+ minutes_till_charged?: Maybe<Scalars["Int"]>;
1369
+ /** Date when the charge data was retrieved, as ISO-8601 date */
1370
+ date?: Maybe<Scalars["DateTime"]>;
1347
1371
  };
1348
1372
  export declare type ConnectFilter = {
1349
1373
  /** List of connectivity providers to which a vehicle can connect */
1350
1374
  providers?: Maybe<Array<Maybe<ConnectProvider>>>;
1351
1375
  };
1376
+ /** Location of the vehicle */
1377
+ export declare type ConnectLocation = {
1378
+ /** Feature type */
1379
+ type: FeatureType;
1380
+ /** Geometry of the feature */
1381
+ geometry: GeometryPoint;
1382
+ /** Properties object containing meta data about the feature point */
1383
+ properties?: Maybe<ConnectLocationProperties>;
1384
+ };
1385
+ /** Properties of a vehicle location */
1386
+ export declare type ConnectLocationProperties = {
1387
+ /** Date when the location was retrieved, as ISO-8601 date */
1388
+ date: Scalars["DateTime"];
1389
+ };
1390
+ export declare type ConnectOdometer = {
1391
+ /** Odometer value, distance driven, default in km */
1392
+ distance?: Maybe<Scalars["Int"]>;
1393
+ /** Date when the odometer data was retrieved, as ISO-8601 date */
1394
+ date?: Maybe<Scalars["DateTime"]>;
1395
+ };
1352
1396
  export declare enum ConnectProvider {
1353
1397
  ENODE = "Enode"
1354
1398
  }
1399
+ export declare enum ConnectScope {
1400
+ /** Vehicle location, applicable for: Enode */
1401
+ LOCATION = "location",
1402
+ /** Charge state, applicable for: Enode */
1403
+ CHARGE_STATE = "charge_state",
1404
+ /** Odometer reading, applicable for: Enode */
1405
+ ODOMETER = "odometer"
1406
+ }
1355
1407
  export declare type ConnectedVehicle = {
1356
1408
  /** Unique ID of the connected vehicle */
1357
1409
  id: Scalars["ID"];
1358
- /** ID of the user */
1359
- user_id: Scalars["ID"];
1360
1410
  /** Unique ID of the vehicle */
1361
1411
  vehicle_id: Scalars["ID"];
1362
1412
  /** Status of the connected vehicle */
@@ -1365,19 +1415,13 @@ export declare type ConnectedVehicle = {
1365
1415
  authorization_url?: Maybe<Scalars["String"]>;
1366
1416
  /** Connectivity provider */
1367
1417
  provider: CarConnectivityProvider;
1368
- /** Permissions for data retrieval from the connected vehicle */
1369
- permissions?: Maybe<Array<Maybe<ConnectedVehiclePermission>>>;
1418
+ /** Scope for accessing the vehicle */
1419
+ scope?: Maybe<Array<Maybe<ConnectScope>>>;
1370
1420
  /** Custom label for a connected vehicle that can be assigned by a user */
1371
1421
  label?: Maybe<Scalars["String"]>;
1372
1422
  /** Vehicle identification number, unique identifier for a vehicle */
1373
1423
  vin?: Maybe<Scalars["String"]>;
1374
1424
  };
1375
- export declare enum ConnectedVehiclePermission {
1376
- /** Permission to retrieve the location of the vehicle */
1377
- LOCATION = "location",
1378
- /** Permission to retrieve the state of the battery */
1379
- BATTERY = "battery"
1380
- }
1381
1425
  export declare enum ConnectedVehicleStatus {
1382
1426
  /** Vehicle was added to the Chargetrip platform but not yet authorized */
1383
1427
  PENDING = "pending",
@@ -1795,6 +1839,16 @@ export declare type CreateConnectedVehicleInput = {
1795
1839
  /** Provider specific options. See the developer portal for more details */
1796
1840
  options: NewConnectedVehicleOptions;
1797
1841
  };
1842
+ export declare enum DistanceUnit {
1843
+ /** Return the distance in meters */
1844
+ METER = "meter",
1845
+ /** Return the distance in feet */
1846
+ FOOT = "foot",
1847
+ /** Return the distance in kilometers */
1848
+ KILOMETER = "kilometer",
1849
+ /** Return the distance in miles */
1850
+ MILE = "mile"
1851
+ }
1798
1852
  /** EVSE data which extends OCPI EVSE */
1799
1853
  export declare type EVSE = {
1800
1854
  /**
@@ -1837,7 +1891,7 @@ export declare type FeaturePoint = {
1837
1891
  type: FeatureType;
1838
1892
  /** Geometry of the feature */
1839
1893
  geometry: Point;
1840
- /** Additional data */
1894
+ /** Optional object where you can store custom data you need in your application. This extends the current functionalities we offer */
1841
1895
  properties?: Maybe<Scalars["JSON"]>;
1842
1896
  };
1843
1897
  /** A GeoJSON Feature<Point> input */
@@ -1967,7 +2021,7 @@ export declare enum MappingProvider {
1967
2021
  export declare type Mutation = {
1968
2022
  /** [BETA] Create a connected vehicle for a given vehicle id and a connectivity provider */
1969
2023
  createConnectedVehicle?: Maybe<ConnectedVehicle>;
1970
- /** [BETA] Authorize a vehicle by providing the callback url from the connectivity provider which will be exchanged for access tokens */
2024
+ /** [BETA] Authorize a connected vehicle */
1971
2025
  authorizeConnectedVehicle?: Maybe<ConnectedVehicle>;
1972
2026
  /** [BETA] Update a connected vehicle */
1973
2027
  updateConnectedVehicle?: Maybe<ConnectedVehicle>;
@@ -2158,6 +2212,8 @@ export declare type NavigationUpdateLocationsInput = {
2158
2212
  export declare type NewConnectedVehicleOptions = {
2159
2213
  /** Redirect uri */
2160
2214
  redirect_uri?: Maybe<Scalars["PlainString"]>;
2215
+ /** Scope */
2216
+ scope?: Maybe<Array<Maybe<ConnectScope>>>;
2161
2217
  };
2162
2218
  /** This class defines an additional geo location that is relevant for the Charge Point. The geodetic system to be used is WGS 84. */
2163
2219
  export declare type OCPIAdditionalGeoLocation = {
@@ -3064,6 +3120,8 @@ export declare type RequestInput = {
3064
3120
  ev: RequestEvInput;
3065
3121
  /** Route request data */
3066
3122
  routeRequest: RequestRouteInput;
3123
+ /** Telemetry data used to overwrite routing parameters */
3124
+ telemetry?: Maybe<Scalars["JSON"]>;
3067
3125
  };
3068
3126
  export declare type RequestRoute = {
3069
3127
  /** Desired amenities near the stations, within a 1 km radius */
@@ -3241,6 +3299,8 @@ export declare type Route = {
3241
3299
  alternatives?: Maybe<Array<Maybe<RouteAlternative>>>;
3242
3300
  /** EV specific data for a route request */
3243
3301
  ev?: Maybe<RequestEv>;
3302
+ /** Route telemetry data */
3303
+ telemetry?: Maybe<Scalars["JSON"]>;
3244
3304
  /** @deprecated You will receive null values */
3245
3305
  user?: Maybe<RequestUser>;
3246
3306
  /** Route request data */
@@ -3600,7 +3660,7 @@ export declare type RouteStep = {
3600
3660
  distance?: Maybe<Scalars["Int"]>;
3601
3661
  /** Total drive time from the start to the end of a step, in seconds */
3602
3662
  duration?: Maybe<Scalars["Int"]>;
3603
- /** Total enery used in a step in kWh */
3663
+ /** Total energy used in a step in kWh */
3604
3664
  consumption?: Maybe<Scalars["Float"]>;
3605
3665
  };
3606
3666
  export declare type RouteSteppolylineArgs = {
@@ -3877,16 +3937,12 @@ export declare type UpdateConnectedVehicleInput = {
3877
3937
  label?: Maybe<Scalars["PlainString"]>;
3878
3938
  };
3879
3939
  export declare type VehicleData = {
3940
+ /** Battery data */
3880
3941
  battery?: Maybe<ConnectBattery>;
3881
- location?: Maybe<VehicleLocation>;
3882
- };
3883
- /** Location of the vehicle */
3884
- export declare type VehicleLocation = {
3885
- type: FeatureType;
3886
- geometry: GeometryPoint;
3887
- properties?: Maybe<VehicleLocationProperties>;
3888
- };
3889
- /** Properties of a vehicle location */
3890
- export declare type VehicleLocationProperties = {
3891
- date: Scalars["String"];
3942
+ /** Charge data */
3943
+ charge?: Maybe<ConnectCharge>;
3944
+ /** Location data */
3945
+ location?: Maybe<ConnectLocation>;
3946
+ /** Odometer data */
3947
+ odometer?: Maybe<ConnectOdometer>;
3892
3948
  };