/** * An optional dictionary, only necessary to override the defaults for route start and end conditions. */ export interface RouteSettingsResponseBody { /** * Defaults to 'arriveLastStop' which ends the route upon arriving at the final stop. The condition 'departLastStop' * ends the route upon departing the last stop. If 'arriveLastStop' is set, then the departure time of the final stop should not be set. Valid values: `arriveLastStop`, `departLastStop` */ routeCompletionCondition?: RouteSettingsResponseBody.RouteCompletionCondition | undefined; /** * Defaults to 'departFirstStop' which starts the route upon departing the first stop in the route. * The condition 'arriveFirstStop' starts the route upon arriving at the first stop in the route. If 'departFirstStop' is set, * the arrival time of the first stop should not be set. Valid values: `departFirstStop`, `arriveFirstStop` */ routeStartingCondition?: RouteSettingsResponseBody.RouteStartingCondition | undefined; /** Determines how stops are sequenced on the route. 'scheduledArrivalTime' sequences stops by their scheduled arrival times (default). 'manual' allows custom sequencing via stop.sequenceNumber. 'unknown' indicates the method is not specified. Valid values: `unknown`, `scheduledArrivalTime`, `manual` */ sequencingMethod?: RouteSettingsResponseBody.SequencingMethod | undefined; } export declare namespace RouteSettingsResponseBody { /** * Defaults to 'arriveLastStop' which ends the route upon arriving at the final stop. The condition 'departLastStop' * ends the route upon departing the last stop. If 'arriveLastStop' is set, then the departure time of the final stop should not be set. Valid values: `arriveLastStop`, `departLastStop` */ const RouteCompletionCondition: { readonly ArriveLastStop: "arriveLastStop"; readonly DepartLastStop: "departLastStop"; }; type RouteCompletionCondition = (typeof RouteCompletionCondition)[keyof typeof RouteCompletionCondition]; /** * Defaults to 'departFirstStop' which starts the route upon departing the first stop in the route. * The condition 'arriveFirstStop' starts the route upon arriving at the first stop in the route. If 'departFirstStop' is set, * the arrival time of the first stop should not be set. Valid values: `departFirstStop`, `arriveFirstStop` */ const RouteStartingCondition: { readonly DepartFirstStop: "departFirstStop"; readonly ArriveFirstStop: "arriveFirstStop"; }; type RouteStartingCondition = (typeof RouteStartingCondition)[keyof typeof RouteStartingCondition]; /** Determines how stops are sequenced on the route. 'scheduledArrivalTime' sequences stops by their scheduled arrival times (default). 'manual' allows custom sequencing via stop.sequenceNumber. 'unknown' indicates the method is not specified. Valid values: `unknown`, `scheduledArrivalTime`, `manual` */ const SequencingMethod: { readonly Unknown: "unknown"; readonly ScheduledArrivalTime: "scheduledArrivalTime"; readonly Manual: "manual"; }; type SequencingMethod = (typeof SequencingMethod)[keyof typeof SequencingMethod]; }