import type * as Samsara from "../../../../index.js"; /** * @example * { * id: "id" * } */ export interface UpdateDriverRequest { /** ID of the driver. 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; attributes?: Samsara.UpdateDriverRequestAttributes[]; carrierSettings?: Samsara.DriverCarrierSettings; /** The ID Card Code on the back of the physical card assigned to the driver. Contact Samsara if you would like to enable this feature. */ currentIdCardCode?: string; dateOfBirth?: Samsara.DriverDateOfBirth; /** The date and time this driver is considered to be deactivated in RFC 3339 format. */ deactivatedAtTime?: string; /** A value indicating whether the driver is active or deactivated. Valid values: `active`, `deactivated`. */ driverActivationStatus?: UpdateDriverRequest.DriverActivationStatus; /** Flag indicating this driver may use Adverse Weather exemptions in ELD logs. */ eldAdverseWeatherExemptionEnabled?: boolean; /** Flag indicating this driver may use Big Day exemption in ELD logs. */ eldBigDayExemptionEnabled?: boolean; /** `0` indicating midnight-to-midnight ELD driving hours, `12` to indicate noon-to-noon driving hours. */ eldDayStartHour?: number; /** Flag indicating this driver is exempt from the Electronic Logging Mandate. */ eldExempt?: boolean; /** Reason that this driver is exempt from the Electronic Logging Mandate (see eldExempt). */ eldExemptReason?: string; /** Flag indicating this driver may select the Personal Conveyance duty status in ELD logs. */ eldPcEnabled?: boolean; /** Flag indicating this driver may select the Yard Move duty status in ELD logs. */ eldYmEnabled?: boolean; email?: Samsara.DriverEmail; /** The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object. */ externalIds?: Record; hasDrivingFeaturesHidden?: Samsara.DriverHasDrivingFeaturesHidden; hasVehicleUnpinningEnabled?: Samsara.DriverHasVehicleUnpinningEnabled; hosSetting?: Samsara.UpdateDriverRequestHosSetting; /** Driver's state issued license number. The combination of this number and `licenseState` must be unique. */ licenseNumber?: string; /** Abbreviation of US state, Canadian province, or US territory that issued driver's license. */ licenseState?: string; /** Locale override (uncommon). These are specified by ISO 3166-2 country codes for supported locales. Valid values: `us`, `at`, `be`, `ca`, `gb`, `fr`, `de`, `ie`, `it`, `lu`, `mx`, `nl`, `es`, `ch`, `pr`. */ locale?: UpdateDriverRequest.Locale; /** Driver's name. */ name?: string; /** Notes about the driver. */ notes?: string; /** Password that the driver can use to login to the Samsara driver app. */ password?: string; /** The peer group tag id this driver belong to, leave blank to be in group with everyone, used for gamification. */ peerGroupTagId?: string; /** Phone number of the driver. */ phone?: string; profileImageBase64?: Samsara.DriverProfileImageBase64; profileImageUrl?: Samsara.DriverProfileImageUrl; /** ID of vehicle that the driver is permanently assigned to. (uncommon). */ staticAssignedVehicleId?: string; /** Driver's assigned tachograph card number (Europe specific) */ tachographCardNumber?: string; /** IDs of tags the driver is associated with. If your access to the API is scoped by one or more tags, this field is required to pass in. */ tagIds?: string[]; /** Home terminal timezone, in order to indicate what time zone should be used to calculate the ELD logs. Driver timezones use [IANA timezone database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`, `America/New_York`, `Europe/London`, etc.). You can find a mapping of common timezone formats to IANA timezone keys [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html). */ timezone?: string; /** Tag ID which determines which trailers a driver will see when selecting trailers. */ trailerGroupTagId?: string; usDriverRulesetOverride?: Samsara.UsDriverRulesetOverride; /** Driver's login username into the driver app. The username may not contain spaces or the '@' symbol. The username must be unique. */ username?: string; /** Tag ID which determines which vehicles a driver will see when selecting vehicles. */ vehicleGroupTagId?: string; /** Flag indicating this driver may select waiting time duty status in ELD logs */ waitingTimeDutyStatusEnabled?: boolean; } export declare namespace UpdateDriverRequest { /** A value indicating whether the driver is active or deactivated. Valid values: `active`, `deactivated`. */ const DriverActivationStatus: { readonly Active: "active"; readonly Deactivated: "deactivated"; }; type DriverActivationStatus = (typeof DriverActivationStatus)[keyof typeof DriverActivationStatus]; /** Locale override (uncommon). These are specified by ISO 3166-2 country codes for supported locales. Valid values: `us`, `at`, `be`, `ca`, `gb`, `fr`, `de`, `ie`, `it`, `lu`, `mx`, `nl`, `es`, `ch`, `pr`. */ const Locale: { readonly Us: "us"; readonly At: "at"; readonly Be: "be"; readonly Ca: "ca"; readonly Gb: "gb"; readonly Fr: "fr"; readonly De: "de"; readonly Ie: "ie"; readonly It: "it"; readonly Lu: "lu"; readonly Mx: "mx"; readonly Nl: "nl"; readonly Es: "es"; readonly Ch: "ch"; readonly Pr: "pr"; }; type Locale = (typeof Locale)[keyof typeof Locale]; }