@chargetrip/types 1.30.1 → 1.32.2

package/dist/ts/graphql.d.ts

@@ -19,7 +19,7 @@ export declare type Scalars = {
     Float: number;
     /** The date and time scalar */
     DateTime: string;
-    /** Any JSON object or array */
+    /** Any JSON object */
     JSON: {
         [key: string]: number | string | boolean | null | Scalars["JSON"];
     };
@@ -30,7 +30,7 @@ export declare type Scalars = {
     PlainString: any;
     /** The File Upload scalar */
     Upload: any;
-    /** Void scalar. Returns null */
+    /** Returns null */
     Void: any;
 };
 export declare enum AccessType {
@@ -114,6 +114,16 @@ export declare type AmenityStats = {
     /** The total number of stations with the specified amenity */
     total?: Maybe<Scalars["Int"]>;
 };
+export declare type AuthorizeConnectedVehicleInput = {
+    /** Id from the connected vehicle */
+    id: Scalars["ID"];
+    /** Provider specific options. See the developer portal for more details */
+    options: AuthorizeConnectedVehicleOptions;
+};
+export declare type AuthorizeConnectedVehicleOptions = {
+    /** OAuth code returned as a query parameter on the OAuth callback */
+    code?: Maybe<Scalars["PlainString"]>;
+};
 /** The type of the batter value */
 export declare enum BatteryInputType {
     KWH = "kwh",
@@ -326,6 +336,9 @@ export declare type CarBody = {
     /** Number of seats */
     seats?: Maybe<Scalars["Int"]>;
 };
+export declare enum CarConnectivityProvider {
+    ENODE = "Enode"
+}
 /** Deprecated */
 export declare type CarConsumption = {
     /** Worst conditions are based on -10°C and use of heating */
@@ -1328,6 +1341,10 @@ export declare type Connect = {
     /** List of connectivity providers to which a vehicle can connect */
     providers?: Maybe<Array<Maybe<ConnectProvider>>>;
 };
+export declare type ConnectBattery = {
+    percentage?: Maybe<Scalars["Int"]>;
+    date?: Maybe<Scalars["String"]>;
+};
 export declare type ConnectFilter = {
     /** List of connectivity providers to which a vehicle can connect */
     providers?: Maybe<Array<Maybe<ConnectProvider>>>;
@@ -1335,6 +1352,40 @@ export declare type ConnectFilter = {
 export declare enum ConnectProvider {
     ENODE = "Enode"
 }
+export declare type ConnectedVehicle = {
+    /** Unique ID of the connected vehicle */
+    id: Scalars["ID"];
+    /** ID of the user */
+    user_id: Scalars["ID"];
+    /** Unique ID of the vehicle */
+    vehicle_id: Scalars["ID"];
+    /** Status of the connected vehicle */
+    status: ConnectedVehicleStatus;
+    /** URL to connect the vehicle to the connectivity provider */
+    authorization_url?: Maybe<Scalars["String"]>;
+    /** Connectivity provider */
+    provider: CarConnectivityProvider;
+    /** Permissions for data retrieval from the connected vehicle */
+    permissions?: Maybe<Array<Maybe<ConnectedVehiclePermission>>>;
+    /** Custom label for a connected vehicle that can be assigned by a user */
+    label?: Maybe<Scalars["String"]>;
+    /** Vehicle identification number, unique identifier for a vehicle */
+    vin?: Maybe<Scalars["String"]>;
+};
+export declare enum ConnectedVehiclePermission {
+    /** Permission to retrieve the location of the vehicle */
+    LOCATION = "location",
+    /** Permission to retrieve the state of the battery */
+    BATTERY = "battery"
+}
+export declare enum ConnectedVehicleStatus {
+    /** Vehicle was added to the Chargetrip platform but not yet authorized */
+    PENDING = "pending",
+    /** Vehicle was authorized. Chargetrip can retrieve data on behave of the user */
+    AUTHORIZED = "authorized",
+    /** User did revoke permissions to retrieve data from the vehicle */
+    DEAUTHORIZED = "deauthorized"
+}
 /** Connector data which extends OCPI Connector */
 export declare type Connector = {
     /** 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. */
@@ -1734,6 +1785,16 @@ export declare enum CountryCodeAlpha2 {
     ZM = "ZM",
     ZW = "ZW"
 }
+export declare type CreateConnectedVehicleInput = {
+    /** Id from the vehicle */
+    vehicle_id: Scalars["ID"];
+    /** Connectivity provider used to retrieve data from the vehicle */
+    provider: CarConnectivityProvider;
+    /** Label for a connected vehicle */
+    label?: Maybe<Scalars["PlainString"]>;
+    /** Provider specific options. See the developer portal for more details */
+    options: NewConnectedVehicleOptions;
+};
 /** EVSE data which extends OCPI EVSE */
 export declare type EVSE = {
     /**
@@ -1776,7 +1837,7 @@ export declare type FeaturePoint = {
     type: FeatureType;
     /** Geometry of the feature */
     geometry: Point;
-    /** Optional object where you can store custom data you need in your application. This extends the current functionalities we offer */
+    /** Additional data */
     properties?: Maybe<Scalars["JSON"]>;
 };
 /** A GeoJSON Feature<Point> input */
@@ -1831,6 +1892,11 @@ export declare type FeaturePolygonPoint = {
 export declare enum FeatureType {
     FEATURE = "Feature"
 }
+/** Geometry point with GPS coordinates */
+export declare type GeometryPoint = {
+    type: PointType;
+    coordinates: Array<Scalars["Float"]>;
+};
 /** Navigation service providers available */
 export declare enum InstructionsFormat {
     /** Chargetrip raw instructions */
@@ -1899,6 +1965,14 @@ export declare enum MappingProvider {
     MAPBOXV5 = "MapboxV5"
 }
 export declare type Mutation = {
+    /** [BETA] Create a connected vehicle for a given vehicle id and a connectivity provider */
+    createConnectedVehicle?: Maybe<ConnectedVehicle>;
+    /** [BETA] Authorize a vehicle by providing the callback url from the connectivity provider which will be exchanged for access tokens */
+    authorizeConnectedVehicle?: Maybe<ConnectedVehicle>;
+    /** [BETA] Update a connected vehicle */
+    updateConnectedVehicle?: Maybe<ConnectedVehicle>;
+    /** [BETA] Revoke access for a connected vehicle */
+    removeConnectedVehicle?: Maybe<Scalars["Void"]>;
     /** [BETA] Generate a set of consumption based Isolines */
     createIsoline?: Maybe<Scalars["ID"]>;
     /** [BETA] Start a new navigation session on top of an existing route */
@@ -1925,6 +1999,18 @@ export declare type Mutation = {
     /** Create a new route from the route input and its ID */
     newRoute?: Maybe<Scalars["ID"]>;
 };
+export declare type MutationcreateConnectedVehicleArgs = {
+    input?: Maybe<CreateConnectedVehicleInput>;
+};
+export declare type MutationauthorizeConnectedVehicleArgs = {
+    input?: Maybe<AuthorizeConnectedVehicleInput>;
+};
+export declare type MutationupdateConnectedVehicleArgs = {
+    input: UpdateConnectedVehicleInput;
+};
+export declare type MutationremoveConnectedVehicleArgs = {
+    input: RemoveConnectedVehicleInput;
+};
 export declare type MutationcreateIsolineArgs = {
     input: IsolineInput;
 };
@@ -2069,6 +2155,10 @@ export declare type NavigationUpdateLocationsInput = {
     /** Extra information about the location */
     properties: NavigationUpdateLocationPropertiesInput;
 };
+export declare type NewConnectedVehicleOptions = {
+    /** Redirect uri */
+    redirect_uri?: Maybe<Scalars["PlainString"]>;
+};
 /** This class defines an additional geo location that is relevant for the Charge Point. The geodetic system to be used is WGS 84. */
 export declare type OCPIAdditionalGeoLocation = {
     /** Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}\.[0-9]{5,7} */
@@ -2726,6 +2816,12 @@ export declare type Query = {
     carPremium?: Maybe<CarPremium>;
     /** Get a full list of cars */
     carList?: Maybe<Array<Maybe<CarList>>>;
+    /** [BETA] Get connected vehicles for the current user */
+    connectedVehicle?: Maybe<ConnectedVehicle>;
+    /** [BETA] Get a connected vehicle by id */
+    connectedVehicleList?: Maybe<Array<Maybe<ConnectedVehicle>>>;
+    /** [BETA] Retrieve live vehicle data by connected vehicle id */
+    connectedVehicleData?: Maybe<VehicleData>;
     /** [BETA] Get an isoline by ID */
     isoline?: Maybe<Isoline>;
     /** [BETA] Get a navigation session by ID */
@@ -2778,6 +2874,12 @@ export declare type QuerycarListArgs = {
     size?: Maybe<Scalars["Int"]>;
     page?: Maybe<Scalars["Int"]>;
 };
+export declare type QueryconnectedVehicleArgs = {
+    id: Scalars["ID"];
+};
+export declare type QueryconnectedVehicleDataArgs = {
+    id: Scalars["ID"];
+};
 export declare type QueryisolineArgs = {
     id: Scalars["ID"];
 };
@@ -2841,6 +2943,10 @@ export declare type QuerynavigationMappingArgs = {
     precision?: Maybe<Scalars["Int"]>;
     language?: Maybe<MappingLanguage>;
 };
+export declare type RemoveConnectedVehicleInput = {
+    /** Id from the connected vehicle */
+    id: Scalars["ID"];
+};
 /** EV specific data for a route request */
 export declare type RequestEv = {
     /** Internal ID of a Car */
@@ -3743,6 +3849,8 @@ export declare enum StepType {
     CROSSBORDER = "crossborder"
 }
 export declare type Subscription = {
+    /** [BETA] Subscribe to a connected vehicle. */
+    connectedVehicle?: Maybe<ConnectedVehicle>;
     /** [BETA] Subscribe to an isoline label in order to receive updates */
     isoline?: Maybe<Isoline>;
     /** [BETA] Subscribe to navigation session system event updates. We strongly recommend using this at all times to not miss any updates */
@@ -3750,6 +3858,9 @@ export declare type Subscription = {
     /** Subscription for a specific route was updated in the system event */
     routeUpdatedById?: Maybe<Route>;
 };
+export declare type SubscriptionconnectedVehicleArgs = {
+    id: Scalars["ID"];
+};
 export declare type SubscriptionisolineArgs = {
     id: Scalars["ID"];
 };
@@ -3759,3 +3870,23 @@ export declare type SubscriptionnavigationUpdatedByIdArgs = {
 export declare type SubscriptionrouteUpdatedByIdArgs = {
     id: Scalars["ID"];
 };
+export declare type UpdateConnectedVehicleInput = {
+    /** Id from the connected vehicle */
+    id: Scalars["ID"];
+    /** New label for a connected vehicle */
+    label?: Maybe<Scalars["PlainString"]>;
+};
+export declare type VehicleData = {
+    battery?: Maybe<ConnectBattery>;
+    location?: Maybe<VehicleLocation>;
+};
+/** Location of the vehicle */
+export declare type VehicleLocation = {
+    type: FeatureType;
+    geometry: GeometryPoint;
+    properties?: Maybe<VehicleLocationProperties>;
+};
+/** Properties of a vehicle location */
+export declare type VehicleLocationProperties = {
+    date: Scalars["String"];
+};