@chargetrip/types 1.24.0 → 1.25.0

package/dist/ts/graphql.d.ts

@@ -25,6 +25,8 @@ export declare type Scalars = {
     };
     /** The File Upload scalar */
     Upload: any;
+    /** Void custom scalar */
+    Void: any;
 };
 /** Information about an address */
 export declare type Address = {
@@ -146,7 +148,7 @@ export declare type Car = {
      */
     chargetripRange?: Maybe<ChargetripRange>;
     /**
-     * Cars that support fast charging have a minimum charging speed of 43 Kwh. Cars without support for fast charging used in a newRoute mutation will return an error
+     * Cars that support fast charging have a minimum charging speed of 43 kWh
      * @deprecated In favor of routing.fast_charging_support
      */
     fastChargingSupport?: Maybe<Scalars["Boolean"]>;
@@ -438,7 +440,7 @@ export declare type CarList = {
      */
     chargetripRange?: Maybe<ChargetripRange>;
     /**
-     * Cars that support fast charging have a minimum charging speed of 43 Kwh. Cars without support for fast charging used in a newRoute mutation will return an error
+     * Cars that support fast charging have a minimum charging speed of 43 kWh
      * @deprecated In favor of routing.fast_charging_support
      */
     fastChargingSupport?: Maybe<Scalars["Boolean"]>;
@@ -597,10 +599,7 @@ export declare type CarListRange = {
     best?: Maybe<CarEstimationData>;
 };
 export declare type CarListRouting = {
-    /**
-     * EVs that support fast charging have a minimum charging speed of 43 Kwh.
-     * EVs without support for fast charging used in a newRoute mutation will return an error.
-     */
+    /** Cars that support fast charging have a minimum charging speed of 43 kWh */
     fast_charging_support?: Maybe<Scalars["Boolean"]>;
 };
 export declare type CarMedia = {
@@ -1117,10 +1116,7 @@ export declare type CarPremiumRangeValue = {
     combined?: Maybe<Scalars["Int"]>;
 };
 export declare type CarPremiumRouting = {
-    /**
-     * EVs that support fast charging have a minimum charging speed of 43 Kwh.
-     * EVs without support for fast charging used in a newRoute mutation will return an error.
-     */
+    /** Cars that support fast charging have a minimum charging speed of 43 kWh */
     fast_charging_support?: Maybe<Scalars["Boolean"]>;
     /** Drag coefficient */
     drag_coefficient?: Maybe<Scalars["Float"]>;
@@ -1197,10 +1193,7 @@ export declare type CarRangeValue = {
     combined?: Maybe<Scalars["Int"]>;
 };
 export declare type CarRouting = {
-    /**
-     * EVs that support fast charging have a minimum charging speed of 43 Kwh.
-     * EVs without support for fast charging used in a newRoute mutation will return an error.
-     */
+    /** Cars that support fast charging have a minimum charging speed of 43 kWh */
     fast_charging_support?: Maybe<Scalars["Boolean"]>;
 };
 /** Status of a car */
@@ -1701,6 +1694,13 @@ export declare type FeaturePointInput = {
 export declare enum FeatureType {
     FEATURE = "Feature"
 }
+/** Navigation service providers available */
+export declare enum InstructionsFormat {
+    /** Chargetrip raw instructions */
+    CHARGETRIP = "Chargetrip",
+    /** Mapbox instructions mapping */
+    MAPBOXV5 = "MapboxV5"
+}
 /** Types of a leg */
 export declare enum LegType {
     /** This leg ends at a charging station and the car must recharge */
@@ -1716,14 +1716,25 @@ export declare enum LegType {
 }
 /** Preferred language for the mapping */
 export declare enum MappingLanguage {
+    /** English(US) */
     EN = "en"
 }
 /** Navigation service providers available */
 export declare enum MappingProvider {
-    /** Mapbox Navigation */
+    /** Chargetrip raw instructions */
+    CHARGETRIP = "Chargetrip",
+    /** Mapbox instructions mapping */
     MAPBOXV5 = "MapboxV5"
 }
 export declare type Mutation = {
+    /** [BETA] Start a new navigation session on top of an existing route */
+    startNavigation?: Maybe<Scalars["ID"]>;
+    /** [BETA] Update the navigation session */
+    updateNavigation?: Maybe<Scalars["Void"]>;
+    /** [BETA] Recalculate the current navigation route */
+    recalculateNavigation?: Maybe<Scalars["Void"]>;
+    /** [BETA] End a navigation session */
+    finishNavigation?: Maybe<Scalars["Void"]>;
     /**
      * Add a new review.
      * 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
@@ -1740,6 +1751,18 @@ export declare type Mutation = {
     /** Create a new route from the route input and its ID */
     newRoute?: Maybe<Scalars["ID"]>;
 };
+export declare type MutationstartNavigationArgs = {
+    input: NavigationStartInput;
+};
+export declare type MutationupdateNavigationArgs = {
+    input: NavigationUpdateInput;
+};
+export declare type MutationrecalculateNavigationArgs = {
+    input: NavigationReacalculateInput;
+};
+export declare type MutationfinishNavigationArgs = {
+    input: NavigationFinishInput;
+};
 export declare type MutationaddReviewArgs = {
     review: ReviewAdd;
 };
@@ -1749,6 +1772,126 @@ export declare type MutationdeleteUserReviewArgs = {
 export declare type MutationnewRouteArgs = {
     input?: Maybe<RequestInput>;
 };
+/** The navigation session data */
+export declare type Navigation = {
+    /** ID of the navigation session */
+    id: Scalars["ID"];
+    /** The current route used for navigation */
+    route_id?: Maybe<Scalars["String"]>;
+    /** The current route alternative used for navigation */
+    route_alternative_id?: Maybe<Scalars["String"]>;
+    /** The state of a navigation session. The status can be driving, charging, finished, or error */
+    state?: Maybe<NavigationState>;
+    /** State of charge at the last known location */
+    state_of_charge?: Maybe<Scalars["Float"]>;
+    /** Last known location */
+    last_known_location?: Maybe<Point>;
+    /** Next charging station */
+    next_station?: Maybe<NavigationStation>;
+    /** A set of alternative charging stations to next station */
+    alternative_stations?: Maybe<Array<Maybe<NavigationStation>>>;
+    /** Navigation instructions */
+    instructions?: Maybe<Scalars["JSON"]>;
+};
+/** The navigation session data */
+export declare type NavigationinstructionsArgs = {
+    instructions_format: InstructionsFormat;
+    language?: Maybe<MappingLanguage>;
+    precision?: Maybe<Scalars["Int"]>;
+};
+/** Input for the navigation recalculate */
+export declare type NavigationFinishInput = {
+    /** ID of the navigation session */
+    id: Scalars["ID"];
+    /** Current coordinates */
+    current_location: PointInput;
+};
+/** Input for the navigation recalculate */
+export declare type NavigationReacalculateInput = {
+    /** ID of the navigation session */
+    id: Scalars["ID"];
+    /** State of charge at origin */
+    state_of_charge?: Maybe<Scalars["Float"]>;
+    /** Origin location of a new route */
+    current_location: PointInput;
+    /** Via points of a new route. If this field is not sent, the original via points will be used */
+    via?: Maybe<Array<Maybe<FeaturePointInput>>>;
+    /** Heading of a vehicle, in degrees */
+    heading?: Maybe<Scalars["Float"]>;
+};
+/** Input for the navigation start */
+export declare type NavigationStartInput = {
+    /** ID of the route of the navigation session */
+    route_id: Scalars["String"];
+    /** ID of the route alternative of the navigation session */
+    route_alternative_id?: Maybe<Scalars["String"]>;
+    /** Current coordinates */
+    current_location: PointInput;
+};
+/** State of navigation session */
+export declare enum NavigationState {
+    /** Vehicle is driving */
+    DRIVING = "Driving",
+    /** Vehicle is charging */
+    CHARGING = "Charging",
+    /** Navigation session is completed (either manually or automatically 48 hours after the last update) */
+    FINISHED = "Finished",
+    /** Failed to update navigation session due to route error or not found */
+    ERROR = "Error"
+}
+/** Navigation session station type */
+export declare type NavigationStation = {
+    /** The ID as string of the charging station */
+    station_id?: Maybe<Scalars["String"]>;
+    /** GPS location of the charging station */
+    station_location?: Maybe<Point>;
+    /** An array with all GPS locations of via points until the next charging station */
+    via?: Maybe<Array<Maybe<Point>>>;
+    /** Estimated state of charge, in kWh, at arrival on the next charging station */
+    estimated_state_of_charge?: Maybe<Scalars["Float"]>;
+    /** Estimated consumption, in kWh, from last the known location until the next charging station */
+    estimated_consumption?: Maybe<Scalars["Float"]>;
+    /** Estimated duration, in seconds, from the last known location until the next charging station */
+    estimated_duration?: Maybe<Scalars["Int"]>;
+};
+/** Input for the navigation session update telemetry data */
+export declare type NavigationTelemetryUpdateInput = {
+    /** State of charge at the last known location */
+    state_of_charge?: Maybe<Scalars["Float"]>;
+    /** Indicates if a vehicle is charging */
+    is_charging?: Maybe<Scalars["Boolean"]>;
+    /** Tire pressure. This information should come from telemetry */
+    tire_pressure?: Maybe<Scalars["Float"]>;
+};
+/** Input for the navigation update */
+export declare type NavigationUpdateInput = {
+    /** ID of the navigation session */
+    id: Scalars["ID"];
+    /** Heading of a vehicle, in degrees */
+    heading?: Maybe<Scalars["Float"]>;
+    /** A list of locations that were collected since the last update */
+    locations_data: Array<NavigationUpdateLocationsInput>;
+    /** Telemetry data input */
+    telemetry?: Maybe<NavigationTelemetryUpdateInput>;
+};
+/** Properties of the location */
+export declare type NavigationUpdateLocationPropertiesInput = {
+    /** Current route leg index corresponding to a location */
+    route_leg: Scalars["Int"];
+    /** Speed at a location */
+    speed: Scalars["Float"];
+    /** UNIX timestamp at location */
+    timestamp: Scalars["Int"];
+    /** Altitude information. This is optional */
+    altitude?: Maybe<Scalars["Int"]>;
+};
+/** Input for the navigation update locations */
+export declare type NavigationUpdateLocationsInput = {
+    /** GPS location */
+    geometry: PointInput;
+    /** Extra information about the location */
+    properties: NavigationUpdateLocationPropertiesInput;
+};
 /** 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} */
@@ -2388,6 +2531,8 @@ export declare type Query = {
     carPremium?: Maybe<CarPremium>;
     /** Get a full list of cars */
     carList?: Maybe<Array<Maybe<CarList>>>;
+    /** [BETA] Get a navigation session by ID */
+    navigation?: Maybe<Navigation>;
     /** Get a full list of operators */
     operatorList?: Maybe<Array<Maybe<Operator>>>;
     /** Get information about an operator by its ID */
@@ -2416,7 +2561,7 @@ export declare type Query = {
     tariff?: Maybe<OCPITariff>;
     /** Get the full list of tariffs */
     tariffList?: Maybe<Array<Maybe<OCPITariff>>>;
-    /** Convert a route to navigation instructions for a specified mapping provider */
+    /** Deprecated: This query will be removed in favor of navigation query and subscription. Mapping can be retrieved via the instructions field. */
     navigationMapping?: Maybe<Scalars["JSON"]>;
 };
 export declare type QueryamenityListArgs = {
@@ -2436,6 +2581,9 @@ export declare type QuerycarListArgs = {
     size?: Maybe<Scalars["Int"]>;
     page?: Maybe<Scalars["Int"]>;
 };
+export declare type QuerynavigationArgs = {
+    id: Scalars["ID"];
+};
 export declare type QueryoperatorListArgs = {
     query?: Maybe<OperatorListQuery>;
     search?: Maybe<Scalars["String"]>;
@@ -2665,7 +2813,7 @@ export declare type RequestRouteInput = {
     via?: Maybe<Array<Maybe<FeaturePointInput>>>;
     /** Alternative stations along a route within a specified radius in meters (minimum 500, maximum 5000) */
     stationsAlongRouteRadius?: Maybe<Scalars["Int"]>;
-    /** 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 */
+    /** Deprecated: all routes will have turn-by-turn instructions prepared. Boolean will be ignored */
     instructions?: Maybe<Scalars["Boolean"]>;
 };
 export declare type RequestUser = {
@@ -2783,6 +2931,8 @@ export declare type Route = {
     user?: Maybe<RequestUser>;
     /** Route request data */
     routeRequest?: Maybe<RequestRoute>;
+    /** Application who requested a route */
+    app?: Maybe<RouteApp>;
     /** Route status */
     status?: Maybe<RouteStatus>;
 };
@@ -2878,6 +3028,10 @@ export declare enum RouteAlternativeType {
     /** An alternative to the fastest route */
     ALTERNATIVE = "alternative"
 }
+export declare type RouteApp = {
+    /** ID of the app who requested a route */
+    id?: Maybe<Scalars["ID"]>;
+};
 export declare type RouteInstruction = {
     /** Information about the points on the polyline */
     points?: Maybe<RouteInstructionPoints>;
@@ -3304,6 +3458,8 @@ export declare enum StepType {
     FERRY = "ferry"
 }
 export declare type Subscription = {
+    /** [BETA] Subscribe to navigation session system event updates. We strongly recommend using this at all times to not miss any updates */
+    navigationUpdatedById?: Maybe<Navigation>;
     /**
      * Subscription for a new operator was added in the system event
      * @deprecated operatorAdded has been removed, no value will be sent.
@@ -3357,6 +3513,9 @@ export declare type Subscription = {
      */
     stationDeletedById?: Maybe<Station>;
 };
+export declare type SubscriptionnavigationUpdatedByIdArgs = {
+    id: Scalars["ID"];
+};
 export declare type SubscriptionoperatorUpdatedByIdArgs = {
     id: Scalars["ID"];
 };