@solvice/routing 0.19.3-beta.0 → 0.19.4-beta.0

package/dist/runs.d.ts

@@ -921,6 +921,8 @@ export interface components {
              * @example parts-9:delivery
              */
             id: string;
+            /** @description Pinned as on a job; pinning one leg pins both. */
+            pinned?: boolean;
             /**
              * @description Discriminator: always `delivery`. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -937,6 +939,19 @@ export interface components {
              * @example boiler-17
              */
             id: string;
+            /**
+             * @description On solve, pins the vehicle, not the position: the stop stays on the
+             *     vehicle of the route it sits in (any shift of that vehicle, unless it
+             *     belongs to a `same_day` or `same_route` group) and is never removed
+             *     from the plan, but the search may still reorder it within the route.
+             *     Works anywhere in a route, unlike the prefix `locked_count`. A stop
+             *     that cannot be driven is a 400 on synchronous solve and stream, as is
+             *     a pinned stop that shares a `same_vehicle`, `same_day` or `same_route`
+             *     group with another pinned or locked stop the relation forbids.
+             *     Accepted on evaluate and suggest, where it is inert. A result's `plan`
+             *     never carries it.
+             */
+            pinned?: boolean;
             /**
              * @description Discriminator: always `job`. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -953,6 +968,8 @@ export interface components {
              * @example parts-9:pickup
              */
             id: string;
+            /** @description Pinned as on a job; pinning one leg pins both. */
+            pinned?: boolean;
             /**
              * @description Discriminator: always `pickup`. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -1193,8 +1210,8 @@ export interface components {
          *     `synchronized` or `time_lag` relation that names its members. Hard.
          *     Overlapping `all_or_none` relations chain: one on A and B plus
          *     one on B and C serve all three together or none of them. A group with
-         *     a task in a vehicle's locked prefix (`plan.routes[].locked_count`) is
-         *     exempt. A member that could be served but is held back because
+         *     a task in a vehicle's locked prefix (`plan.routes[].locked_count`) or, on solve, a
+         *     `pinned` plan stop is exempt. A member that could be served but is held back because
          *     another cannot reports `all_or_none` in `unassigned[].reasons`.
          *
          *     A member may be a shipment id (both legs). Members are coupled by
@@ -2152,7 +2169,10 @@ export interface components {
              *     constraint (e.g. capacity, skills, eligibility, `limits.*`, or a time
              *     window with no `per_late_hour` set) is left unassigned and the
              *     search reinserts it wherever it legitimately fits, or it surfaces in
-             *     `unassigned[]` with a typed reason. An infeasible locked stop is a 400.
+             *     `unassigned[]` with a typed reason. On synchronous solve and stream, an
+             *     infeasible locked or pinned stop is a 400. `POST /v3/routing/runs` checks
+             *     the problem at submission, not the plan, so there the run ends `failed`
+             *     with `BAD_REQUEST` instead.
              */
             plan?: null | components["schemas"]["Plan"];
             /** @description The problem: tasks, fleet, depots, relations, objective, travel. */
@@ -3290,8 +3310,8 @@ export interface components {
              *     can be tens of percent off: the plan, `unassigned[].reasons` and
              *     `score.violation_count` hold only against it, and no `routes[].polyline`
              *     is returned. Solve again once Maps is back if the plan must hold on the
-             *     road; on a solve, `options.travel_fallback: "fail"` returns the error
-             *     instead. Absent when travel came from the requested engine,
+             *     road; on a solve or suggest, `options.travel_fallback: "fail"` returns
+             *     the error instead. Absent when travel came from the requested engine,
              *     `straight_line` included.
              */
             travel_estimated?: boolean;
@@ -3600,8 +3620,8 @@ export interface components {
             speed_kmh?: number | null;
         };
         /**
-         * @description `options.travel_fallback`: what a solve does when travel times cannot be
-         *     fetched. `/evaluate` and `/suggest` always estimate.
+         * @description `options.travel_fallback`: what a solve or suggest does when travel times
+         *     cannot be fetched. `/evaluate` always estimates.
          * @example estimate
          * @enum {string}
          */

package/dist/v3.d.ts

@@ -1163,6 +1163,8 @@ export interface components {
              * @example parts-9:delivery
              */
             id: string;
+            /** @description Pinned as on a job; pinning one leg pins both. */
+            pinned?: boolean;
             /**
              * @description Discriminator: always `delivery`. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -1179,6 +1181,19 @@ export interface components {
              * @example boiler-17
              */
             id: string;
+            /**
+             * @description On solve, pins the vehicle, not the position: the stop stays on the
+             *     vehicle of the route it sits in (any shift of that vehicle, unless it
+             *     belongs to a `same_day` or `same_route` group) and is never removed
+             *     from the plan, but the search may still reorder it within the route.
+             *     Works anywhere in a route, unlike the prefix `locked_count`. A stop
+             *     that cannot be driven is a 400 on synchronous solve and stream, as is
+             *     a pinned stop that shares a `same_vehicle`, `same_day` or `same_route`
+             *     group with another pinned or locked stop the relation forbids.
+             *     Accepted on evaluate and suggest, where it is inert. A result's `plan`
+             *     never carries it.
+             */
+            pinned?: boolean;
             /**
              * @description Discriminator: always `job`. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -1195,6 +1210,8 @@ export interface components {
              * @example parts-9:pickup
              */
             id: string;
+            /** @description Pinned as on a job; pinning one leg pins both. */
+            pinned?: boolean;
             /**
              * @description Discriminator: always `pickup`. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -1441,8 +1458,8 @@ export interface components {
          *     `synchronized` or `time_lag` relation that names its members. Hard.
          *     Overlapping `all_or_none` relations chain: one on A and B plus
          *     one on B and C serve all three together or none of them. A group with
-         *     a task in a vehicle's locked prefix (`plan.routes[].locked_count`) is
-         *     exempt. A member that could be served but is held back because
+         *     a task in a vehicle's locked prefix (`plan.routes[].locked_count`) or, on solve, a
+         *     `pinned` plan stop is exempt. A member that could be served but is held back because
          *     another cannot reports `all_or_none` in `unassigned[].reasons`.
          *
          *     A member may be a shipment id (both legs). Members are coupled by
@@ -3070,7 +3087,10 @@ export interface components {
              *     constraint (e.g. capacity, skills, eligibility, `limits.*`, or a time
              *     window with no `per_late_hour` set) is left unassigned and the
              *     search reinserts it wherever it legitimately fits, or it surfaces in
-             *     `unassigned[]` with a typed reason. An infeasible locked stop is a 400.
+             *     `unassigned[]` with a typed reason. On synchronous solve and stream, an
+             *     infeasible locked or pinned stop is a 400. `POST /v3/routing/runs` checks
+             *     the problem at submission, not the plan, so there the run ends `failed`
+             *     with `BAD_REQUEST` instead.
              */
             plan?: null | components["schemas"]["Plan"];
             /** @description The problem: tasks, fleet, depots, relations, objective, travel. */
@@ -3321,6 +3341,15 @@ export interface components {
              * @example 2.5
              */
             time_limit_s?: number | null;
+            /**
+             * @description What to do when travel times cannot be fetched from Solvice Maps, as on
+             *     a solve: `estimate` (the default) ranks insertions on estimated travel
+             *     and sets the response's `travel_estimated`; `fail` returns the 502/503
+             *     instead. Locations that Maps rejects for spanning more than one region
+             *     are a 400. No effect with `travel.engine: "straight_line"`.
+             * @default estimate
+             */
+            travel_fallback?: null | components["schemas"]["TravelFallback"];
         };
         /**
          * @description Why a unit came back with no insertions.
@@ -3508,6 +3537,16 @@ export interface components {
              *     suggest has no separate search figure.
              */
             timings: components["schemas"]["Timings"];
+            /**
+             * @description `true` when travel times could not be fetched and the insertions were
+             *     ranked on estimated travel, as `summary.travel_estimated` on a solve:
+             *     straight-line distance × a detour factor, at a typical speed for the
+             *     profile. Every `delta`, arrival and feasibility verdict holds only
+             *     against it. Send `options.travel_fallback: "fail"` to get the error
+             *     instead. Absent when travel came from the requested engine,
+             *     `straight_line` included.
+             */
+            travel_estimated?: boolean;
             /**
              * @description `true` when `options.time_limit_s` cut the search short, a
              *     multi-member unit came back empty after the search had discarded
@@ -3614,8 +3653,8 @@ export interface components {
              *     can be tens of percent off: the plan, `unassigned[].reasons` and
              *     `score.violation_count` hold only against it, and no `routes[].polyline`
              *     is returned. Solve again once Maps is back if the plan must hold on the
-             *     road; on a solve, `options.travel_fallback: "fail"` returns the error
-             *     instead. Absent when travel came from the requested engine,
+             *     road; on a solve or suggest, `options.travel_fallback: "fail"` returns
+             *     the error instead. Absent when travel came from the requested engine,
              *     `straight_line` included.
              */
             travel_estimated?: boolean;
@@ -3983,8 +4022,8 @@ export interface components {
             speed_kmh?: number | null;
         };
         /**
-         * @description `options.travel_fallback`: what a solve does when travel times cannot be
-         *     fetched. `/evaluate` and `/suggest` always estimate.
+         * @description `options.travel_fallback`: what a solve or suggest does when travel times
+         *     cannot be fetched. `/evaluate` always estimates.
          * @example estimate
          * @enum {string}
          */
@@ -4836,7 +4875,18 @@ export interface operations {
                     "application/json": components["schemas"]["ErrorBody"];
                 };
             };
-            /** @description No capacity right now (`code: overloaded`): every solver slot is busy, or the wait for one timed out. Retry after the number of seconds in the `Retry-After` header. */
+            /** @description Travel times and distances could not be fetched (`code: travel_provider_error`). The request can be retried. Only with `options.travel_fallback: "fail"`; by default the insertions are ranked on estimated travel and `travel_estimated` is set. */
+            502: {
+                headers: {
+                    /** @description The request's `X-Request-Id`, echoed, or a generated `req_…` id. */
+                    "x-request-id"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorBody"];
+                };
+            };
+            /** @description No capacity right now (`code: overloaded`): every solver slot is busy, or the wait for one timed out. With `options.travel_fallback: "fail"`, also returned while Solvice Maps is temporarily refused after repeated failures. Retry after the number of seconds in the `Retry-After` header. */
             503: {
                 headers: {
                     /** @description Seconds to wait before retrying. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solvice/routing",
-  "version": "0.19.3-beta.0",
+  "version": "0.19.4-beta.0",
   "description": "TypeScript client for the Solvice V3 routing API, generated from its OpenAPI spec.",
   "license": "Apache-2.0",
   "homepage": "https://docs.solvice.io/guides/platform/sdks/typescript",