import type * as Samsara from "../../../../index.js"; /** * @example * { * name: "Bid 123", * stops: [{}] * } */ export interface RoutesCreateRouteRequestBody { /** ID of the driver. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the driver. */ driverId?: string; /** A map of external ids */ externalIds?: Record; /** Name for the route */ name: string; /** Notes about the route. */ notes?: string; /** This optional boolean parameter controls whether route schedule arrival and departure times are recalculated. When set to true, the system will automatically recompute the scheduledArrivalTime and scheduledDepartureTime for each stop along the route during route creation. This process overrides any manually provided values, with the exception of the first stop, which retains its user-defined schedule. */ recomputeScheduledTimes?: boolean; settings?: Samsara.RouteSettingsRequestBody; /** List of stops along the route. For each stop, exactly one of `addressId` and `singleUseLocation` are required. Depending on the `settings` on your route, either a `scheduledArrivalTime` or `scheduledDepartureTime` must be specified for the first job. */ stops: Samsara.CreateRouteStopWithOrdersRequestObjectRequestBody[]; /** An array of IDs of tags to associate with this route. */ tagIds?: string[]; /** ID of the vehicle. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the vehicle. */ vehicleId?: string; }