import type * as Samsara from "../../../../index.js";
/**
 * @example
 *     {
 *         id: "id"
 *     }
 */
export interface RoutesPatchRouteRequestBody {
    /** ID of the route. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `payrollId:ABFS18600` */
    id: string;
    /** 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. Set to null to unassign the driver from the route. */
    driverId?: string | null;
    /** A map of external ids */
    externalIds?: Record<string, string>;
    /** 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. If a valid `id` of a stop is provided, that stop will be updated. If no `id` is provided for a passed in stop, that stop will be created. If `id` value are passed in for some stops and not for others, those with `id` value specified will be retained and updated in the original route, those without `id` value specified in the body will be created, and those without `id` value specified that already existed on the route will be deleted. For each new 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, if a new first job is being added. */
    stops?: Samsara.UpdateRoutesStopRequestObjectRequestBody[];
    /** 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. Set to null to unassign the vehicle from the route. */
    vehicleId?: string | null;
}