@chargetrip/types 1.50.0 → 1.52.0

package/dist/ts/graphql.d.ts

@@ -1207,6 +1207,8 @@ export declare type CreateRoute = {
     season?: Maybe<RouteSeason>;
     /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
     alternative_station_radius?: Maybe<AlternativeStationRadius>;
+    /** [BETA] Number of alternative routes to request. */
+    alternative_routes?: Maybe<Scalars["Int"]>;
     /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
     departure_time: Scalars["DateTime"];
     /** [BETA] List of route features to avoid in a route. This is a best-effort preference; depending on the available routes, some features may not be fully avoidable. */
@@ -1236,6 +1238,8 @@ export declare type CreateRouteInput = {
     season?: Maybe<RouteSeason>;
     /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
     alternative_station_radius?: Maybe<AlternativeStationRadiusInput>;
+    /** [BETA] Additional alternative routes to calculate. Performed on a best-effort basis, it may return fewer than requested, or even none. Set to 0 to create only the recommended route. */
+    alternative_routes?: Maybe<Scalars["Int"]>;
     /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
     departure_time?: Maybe<Scalars["DateTime"]>;
     /** [BETA] Optional list of route features to avoid in a route. This is a best-effort preference; depending on the available routes, some features may not be fully avoidable. */
@@ -5176,6 +5180,8 @@ export declare type RouteResponse = {
     status: RouteStatus;
     /** Recommended route. */
     recommended?: Maybe<RouteDetails>;
+    /** [BETA] Alternative routes. */
+    alternatives?: Maybe<Array<RouteDetails>>;
     /** Meta data for a route. */
     meta: RouteMetadata;
     /** Route request. */
@@ -5216,11 +5222,11 @@ export declare type RouteStationOperator = {
     preference_type: OperatorPreferenceType;
 };
 export declare type RouteStationPreferences = {
-    /** [BETA] Flag to prioritise charging stations located directly on the highway, avoiding exiting highways to charge. This preference is considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. The preference's weight is configurable in project settings. */
+    /** [BETA] Prioritises charging stations located directly on the highway, avoiding exiting highways to charge. It's considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. */
     prefer_highway_charging?: Maybe<Scalars["Boolean"]>;
 };
 export declare type RouteStationPreferencesInput = {
-    /** [BETA] Flag to prioritise charging stations located directly on the highway, avoiding exiting highways to charge. This preference is considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. The preference's weight is configurable in project settings. */
+    /** [BETA] Prioritises charging stations located directly on the highway, avoiding exiting highways to charge. It's considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. This logic may require additional client-specific tuning. Please contact Chargetrip if the behavior seems suboptimal. */
     prefer_highway_charging?: Maybe<Scalars["Boolean"]>;
 };
 export declare type RouteStationWithAmenities = {
@@ -5581,7 +5587,9 @@ export declare enum RouteWarningCode {
     /** The set maximum speed is too low (below 50 km/h) and may result in an inefficient route. */
     LOW_SPEED = "low_speed",
     /** Operator preferences were ignored because they have not been configured for this project nor provided in the route create request. */
-    OPERATOR_PREFERENCES_NOT_FOUND = "operator_preferences_not_found"
+    OPERATOR_PREFERENCES_NOT_FOUND = "operator_preferences_not_found",
+    /** Traffic data for this route is not available. */
+    TRAFFIC_DATA_NOT_AVAILABLE = "traffic_data_not_available"
 }
 export declare type RouteWeather = {
     /** Weather configuration applied to the route. */

package/graphql.schema.json

@@ -6084,6 +6084,18 @@
             "isDeprecated": false,
             "deprecationReason": null
           },
+          {
+            "name": "alternative_routes",
+            "description": "[BETA] Number of alternative routes to request.",
+            "args": [],
+            "type": {
+              "kind": "SCALAR",
+              "name": "Int",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
           {
             "name": "departure_time",
             "description": "Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data.",
@@ -6284,6 +6296,18 @@
             "isDeprecated": false,
             "deprecationReason": null
           },
+          {
+            "name": "alternative_routes",
+            "description": "[BETA] Additional alternative routes to calculate. Performed on a best-effort basis, it may return fewer than requested, or even none. Set to 0 to create only the recommended route.",
+            "type": {
+              "kind": "SCALAR",
+              "name": "Int",
+              "ofType": null
+            },
+            "defaultValue": "0",
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
           {
             "name": "departure_time",
             "description": "Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data.",
@@ -28724,6 +28748,26 @@
             "isDeprecated": false,
             "deprecationReason": null
           },
+          {
+            "name": "alternatives",
+            "description": "[BETA] Alternative routes.",
+            "args": [],
+            "type": {
+              "kind": "LIST",
+              "name": null,
+              "ofType": {
+                "kind": "NON_NULL",
+                "name": null,
+                "ofType": {
+                  "kind": "OBJECT",
+                  "name": "RouteDetails",
+                  "ofType": null
+                }
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
           {
             "name": "meta",
             "description": "Meta data for a route.",
@@ -28955,7 +28999,7 @@
         "fields": [
           {
             "name": "prefer_highway_charging",
-            "description": "[BETA] Flag to prioritise charging stations located directly on the highway, avoiding exiting highways to charge. This preference is considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. The preference's weight is configurable in project settings.",
+            "description": "[BETA] Prioritises charging stations located directly on the highway, avoiding exiting highways to charge. It's considered alongside final SOC and operator preferences, and may reduce their influence if they conflict.",
             "args": [],
             "type": {
               "kind": "SCALAR",
@@ -28979,13 +29023,13 @@
         "inputFields": [
           {
             "name": "prefer_highway_charging",
-            "description": "[BETA] Flag to prioritise charging stations located directly on the highway, avoiding exiting highways to charge. This preference is considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. The preference's weight is configurable in project settings.",
+            "description": "[BETA] Prioritises charging stations located directly on the highway, avoiding exiting highways to charge. It's considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. This logic may require additional client-specific tuning. Please contact Chargetrip if the behavior seems suboptimal.",
             "type": {
               "kind": "SCALAR",
               "name": "Boolean",
               "ofType": null
             },
-            "defaultValue": "true",
+            "defaultValue": "false",
             "isDeprecated": false,
             "deprecationReason": null
           }
@@ -31240,6 +31284,12 @@
             "description": "Operator preferences were ignored because they have not been configured for this project nor provided in the route create request.",
             "isDeprecated": false,
             "deprecationReason": null
+          },
+          {
+            "name": "traffic_data_not_available",
+            "description": "Traffic data for this route is not available.",
+            "isDeprecated": false,
+            "deprecationReason": null
           }
         ],
         "possibleTypes": null

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chargetrip/types",
-  "version": "1.50.0",
+  "version": "1.52.0",
   "license": "MIT",
   "keywords": [
     "chargetrip",

package/src/graphql.ts

@@ -1281,6 +1281,8 @@ export type CreateRoute = {
   season?: Maybe<RouteSeason>;
   /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
   alternative_station_radius?: Maybe<AlternativeStationRadius>;
+  /** [BETA] Number of alternative routes to request. */
+  alternative_routes?: Maybe<Scalars["Int"]>;
   /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
   departure_time: Scalars["DateTime"];
   /** [BETA] List of route features to avoid in a route. This is a best-effort preference; depending on the available routes, some features may not be fully avoidable. */
@@ -1311,6 +1313,8 @@ export type CreateRouteInput = {
   season?: Maybe<RouteSeason>;
   /** Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit. */
   alternative_station_radius?: Maybe<AlternativeStationRadiusInput>;
+  /** [BETA] Additional alternative routes to calculate. Performed on a best-effort basis, it may return fewer than requested, or even none. Set to 0 to create only the recommended route. */
+  alternative_routes?: Maybe<Scalars["Int"]>;
   /** Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data. */
   departure_time?: Maybe<Scalars["DateTime"]>;
   /** [BETA] Optional list of route features to avoid in a route. This is a best-effort preference; depending on the available routes, some features may not be fully avoidable. */
@@ -5650,6 +5654,8 @@ export type RouteResponse = {
   status: RouteStatus;
   /** Recommended route. */
   recommended?: Maybe<RouteDetails>;
+  /** [BETA] Alternative routes. */
+  alternatives?: Maybe<Array<RouteDetails>>;
   /** Meta data for a route. */
   meta: RouteMetadata;
   /** Route request. */
@@ -5695,12 +5701,12 @@ export type RouteStationOperator = {
 };
 
 export type RouteStationPreferences = {
-  /** [BETA] Flag to prioritise charging stations located directly on the highway, avoiding exiting highways to charge. This preference is considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. The preference's weight is configurable in project settings. */
+  /** [BETA] Prioritises charging stations located directly on the highway, avoiding exiting highways to charge. It's considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. */
   prefer_highway_charging?: Maybe<Scalars["Boolean"]>;
 };
 
 export type RouteStationPreferencesInput = {
-  /** [BETA] Flag to prioritise charging stations located directly on the highway, avoiding exiting highways to charge. This preference is considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. The preference's weight is configurable in project settings. */
+  /** [BETA] Prioritises charging stations located directly on the highway, avoiding exiting highways to charge. It's considered alongside final SOC and operator preferences, and may reduce their influence if they conflict. This logic may require additional client-specific tuning. Please contact Chargetrip if the behavior seems suboptimal. */
   prefer_highway_charging?: Maybe<Scalars["Boolean"]>;
 };
 
@@ -6097,7 +6103,9 @@ export enum RouteWarningCode {
   /** The set maximum speed is too low (below 50 km/h) and may result in an inefficient route. */
   LOW_SPEED = "low_speed",
   /** Operator preferences were ignored because they have not been configured for this project nor provided in the route create request. */
-  OPERATOR_PREFERENCES_NOT_FOUND = "operator_preferences_not_found"
+  OPERATOR_PREFERENCES_NOT_FOUND = "operator_preferences_not_found",
+  /** Traffic data for this route is not available. */
+  TRAFFIC_DATA_NOT_AVAILABLE = "traffic_data_not_available"
 }
 
 export type RouteWeather = {