import type * as Samsara from "../../../../index.js"; /** * @example * { * id: "id" * } */ export interface AssetsUpdateAssetRequestBody { /** ID of the asset to update. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the asset. */ id: string; /** A list of attributes to assign to the asset. If provided, this replaces the asset's entire set of attribute associations with exactly this list; omit this field to leave existing attribute associations unchanged, or pass an empty array to clear them. */ attributes?: Samsara.GoaAttributeTinyRequestBody[]; /** A map of external ids */ externalIds?: Record; /** The license plate of the asset. */ licensePlate?: string; /** The OEM/manufacturer of the asset. Updates to this field are restricted. */ make?: string; /** The model of the asset. Updates to this field are restricted. */ model?: string; /** The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time. */ name?: string; /** These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time. */ notes?: string; /** Indicates whether the asset is expected to have data ingested using the Readings API. Do not set this to true for an asset that has, or is intended to have, a connected gateway. */ readingsIngestionEnabled?: boolean; /** Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated` */ regulationMode?: AssetsUpdateAssetRequestBody.RegulationMode; /** The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths. */ serialNumber?: string; /** An array of IDs of tags to associate with this asset. If provided, this replaces the asset's entire set of tag associations with exactly this list; omit this field to leave existing tag associations unchanged, or pass an empty array to clear them. If your access to the API is scoped by one or more tags, this field is required to pass in. */ tagIds?: string[]; /** The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle` */ type?: AssetsUpdateAssetRequestBody.Type; /** The unique 17-digit VIN (Vehicle Identification Number) or PIN (Product Identification Number) of the asset. */ vin?: string; /** The model year of the asset. Updates to this field are restricted. */ year?: number; } export declare namespace AssetsUpdateAssetRequestBody { /** Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated` */ const RegulationMode: { readonly Mixed: "mixed"; readonly Regulated: "regulated"; readonly Unregulated: "unregulated"; }; type RegulationMode = (typeof RegulationMode)[keyof typeof RegulationMode]; /** The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle` */ const Type: { readonly Uncategorized: "uncategorized"; readonly Trailer: "trailer"; readonly Equipment: "equipment"; readonly Unpowered: "unpowered"; readonly Vehicle: "vehicle"; }; type Type = (typeof Type)[keyof typeof Type]; }